libosmo-sigtran  2.1.0.94-dfcc.202506122026
Osmocom SIGTRAN library
xua_msg.h
Go to the documentation of this file.
1 /* Routines for generating and parsing messages */
2 /* (C) 2011 by Holger Hans Peter Freyther <zecke@selfish.org>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
16  *
17  */
18 #pragma once
19 
20 #include "xua_types.h"
21 
22 #include <osmocom/core/linuxlist.h>
24 
25 #define XUA_HDR(class, type) ((struct xua_common_hdr) { .spare = 0, .msg_class = (class), .msg_type = (type) })
26 
27 struct msgb;
28 struct osmo_sccp_addr;
29 struct osmo_sccp_gt;
30 
31 struct xua_msg {
32  struct llist_head entry; /* Allows queueing a xua_msg into a llist */
33  struct xua_common_hdr hdr;
35 
36  struct llist_head headers;
37 };
38 
39 struct xua_msg_part {
40  struct llist_head entry;
41 
42  uint16_t tag;
43  uint16_t len;
44  uint8_t *dat;
45 
46  /* TODO: keep small data in the struct for perf reasons */
47 };
48 
49 struct xua_msg_class {
50  const char *name;
51  const struct value_string *msgt_names;
52  const struct value_string *iei_names;
53  const uint16_t *mand_ies[256];
54 };
55 
56 struct xua_dialect {
57  const char *name;
58  uint16_t port;
59  uint16_t ppid;
61  const struct xua_msg_class *class[256];
62 };
63 
65  uint8_t msg_class;
66  uint8_t msg_type;
67  int event;
68 };
69 
70 extern const struct xua_dialect xua_dialect_sua;
71 extern const struct xua_dialect xua_dialect_m3ua;
72 
73 void osmo_xua_msg_tall_ctx_init(void *ctx);
74 
75 struct xua_msg *xua_msg_alloc(void);
76 void xua_msg_free(struct xua_msg *msg);
77 
78 int xua_msg_add_data(struct xua_msg *msg, uint16_t tag, uint16_t len, const uint8_t *dat);
79 int xua_msg_add_u32_data(struct xua_msg *msg, uint16_t tag, uint16_t len, const uint8_t *dat);
80 
81 struct xua_msg_part *xua_msg_find_tag(const struct xua_msg *msg, uint16_t tag);
82 int xua_msg_free_tag(struct xua_msg *xua, uint16_t tag);
83 int xua_msg_copy_part(struct xua_msg *xua_out, uint16_t tag_out,
84  const struct xua_msg *xua_in, uint16_t tag_in);
85 
86 struct xua_msg *xua_from_msg(const int version, uint16_t len, uint8_t *data);
87 struct msgb *xua_to_msg(const int version, struct xua_msg *msg);
88 
89 struct xua_msg *xua_from_nested(struct xua_msg_part *outer);
90 
91 int msgb_t16l16vp_put(struct msgb *msg, uint16_t tag, uint16_t len, const uint8_t *data);
92 int msgb_t16l16vp_put_u32(struct msgb *msg, uint16_t tag, uint32_t val);
93 int xua_msg_add_u32(struct xua_msg *xua, uint16_t iei, uint32_t val);
94 uint32_t xua_msg_part_get_u32(const struct xua_msg_part *part);
95 uint32_t xua_msg_get_u32(const struct xua_msg *xua, uint16_t iei);
96 const uint32_t *xua_msg_get_u32p(const struct xua_msg *xua, uint16_t iei, uint32_t *out);
97 const char *xua_msg_part_get_str(const struct xua_msg_part *part);
98 const char *xua_msg_get_str(const struct xua_msg *xua, uint16_t iei);
99 int xua_msg_get_len(const struct xua_msg *xua, uint16_t iei);
100 void xua_part_add_gt(struct msgb *msg, const struct osmo_sccp_gt *gt);
101 int xua_msg_add_sccp_addr(struct xua_msg *xua, uint16_t iei, const struct osmo_sccp_addr *addr);
102 
103 const char *xua_class_msg_name(const struct xua_msg_class *xmc, uint16_t msg_type);
104 const char *xua_class_iei_name(const struct xua_msg_class *xmc, uint16_t iei);
105 char *xua_hdr_dump(struct xua_msg *xua, const struct xua_dialect *dialect);
106 char *xua_msg_dump(struct xua_msg *xua, const struct xua_dialect *dialect);
107 int xua_dialect_check_all_mand_ies(const struct xua_dialect *dialect, struct xua_msg *xua);
108 
109 int xua_msg_event_map(const struct xua_msg *xua,
110  const struct xua_msg_event_map *maps,
111  unsigned int num_maps);
void osmo_xua_msg_tall_ctx_init(void *ctx)
Definition: xua_msg.c:39
uint8_t msg_type
Definition: sccp_scmg.h:0
struct xua_msg_part * xua_msg_find_tag(const struct xua_msg *msg, uint16_t tag)
Definition: xua_msg.c:118
void xua_msg_free(struct xua_msg *msg)
Definition: xua_msg.c:56
const struct xua_dialect xua_dialect_m3ua
Definition: m3ua.c:288
const uint32_t * xua_msg_get_u32p(const struct xua_msg *xua, uint16_t iei, uint32_t *out)
Definition: xua_msg.c:333
int xua_msg_free_tag(struct xua_msg *xua, uint16_t tag)
Definition: xua_msg.c:129
int xua_msg_get_len(const struct xua_msg *xua, uint16_t iei)
Definition: xua_msg.c:365
int xua_msg_add_data(struct xua_msg *msg, uint16_t tag, uint16_t len, const uint8_t *dat)
Definition: xua_msg.c:61
struct xua_msg * xua_msg_alloc(void)
Definition: xua_msg.c:44
void xua_part_add_gt(struct msgb *msg, const struct osmo_sccp_gt *gt)
Definition: xua_msg.c:373
char * xua_hdr_dump(struct xua_msg *xua, const struct xua_dialect *dialect)
Definition: xua_msg.c:507
int msgb_t16l16vp_put(struct msgb *msg, uint16_t tag, uint16_t len, const uint8_t *data)
Definition: xua_msg.c:279
char * xua_msg_dump(struct xua_msg *xua, const struct xua_dialect *dialect)
Definition: xua_msg.c:554
int msgb_t16l16vp_put_u32(struct msgb *msg, uint16_t tag, uint32_t val)
Definition: xua_msg.c:305
const char * xua_msg_get_str(const struct xua_msg *xua, uint16_t iei)
Definition: xua_msg.c:357
int xua_msg_add_u32(struct xua_msg *xua, uint16_t iei, uint32_t val)
Definition: xua_msg.c:312
int xua_msg_add_u32_data(struct xua_msg *msg, uint16_t tag, uint16_t len, const uint8_t *dat)
Definition: xua_msg.c:87
uint32_t xua_msg_part_get_u32(const struct xua_msg_part *part)
Definition: xua_msg.c:318
int xua_msg_copy_part(struct xua_msg *xua_out, uint16_t tag_out, const struct xua_msg *xua_in, uint16_t tag_in)
Definition: xua_msg.c:143
struct xua_msg * xua_from_msg(const int version, uint16_t len, uint8_t *data)
Definition: xua_msg.c:183
int xua_msg_add_sccp_addr(struct xua_msg *xua, uint16_t iei, const struct osmo_sccp_addr *addr)
Definition: xua_msg.c:411
const char * xua_msg_part_get_str(const struct xua_msg_part *part)
Definition: xua_msg.c:342
const struct xua_dialect xua_dialect_sua
Definition: sua.c:221
uint32_t xua_msg_get_u32(const struct xua_msg *xua, uint16_t iei)
Definition: xua_msg.c:324
struct xua_msg * xua_from_nested(struct xua_msg_part *outer)
Definition: xua_msg.c:218
struct msgb * xua_to_msg(const int version, struct xua_msg *msg)
Definition: xua_msg.c:235
const char * xua_class_msg_name(const struct xua_msg_class *xmc, uint16_t msg_type)
Definition: xua_msg.c:483
int xua_msg_event_map(const struct xua_msg *xua, const struct xua_msg_event_map *maps, unsigned int num_maps)
Map from a xua_msg (class+type) to an event.
Definition: xua_msg.c:467
const char * xua_class_iei_name(const struct xua_msg_class *xmc, uint16_t iei)
Definition: xua_msg.c:495
int xua_dialect_check_all_mand_ies(const struct xua_dialect *dialect, struct xua_msg *xua)
Definition: xua_msg.c:522
Definition: mtp_sap.h:36
Definition: sccp_sap.h:183
Definition: sccp_sap.h:175
Definition: xua_types.h:31
Definition: xua_msg.h:56
uint16_t port
Definition: xua_msg.h:58
uint16_t ppid
Definition: xua_msg.h:59
int log_subsys
Definition: xua_msg.h:60
const char * name
Definition: xua_msg.h:57
Definition: xua_msg.h:49
const uint16_t * mand_ies[256]
Definition: xua_msg.h:53
const char * name
Definition: xua_msg.h:50
const struct value_string * iei_names
Definition: xua_msg.h:52
const struct value_string * msgt_names
Definition: xua_msg.h:51
Definition: xua_msg.h:64
uint8_t msg_type
Definition: xua_msg.h:66
uint8_t msg_class
Definition: xua_msg.h:65
int event
Definition: xua_msg.h:67
Definition: xua_msg.h:39
struct llist_head entry
Definition: xua_msg.h:40
uint8_t * dat
Definition: xua_msg.h:44
uint16_t tag
Definition: xua_msg.h:42
uint16_t len
Definition: xua_msg.h:43
Definition: xua_msg.h:31
struct llist_head entry
Definition: xua_msg.h:32
struct osmo_mtp_transfer_param mtp
Definition: xua_msg.h:34
struct xua_common_hdr hdr
Definition: xua_msg.h:33
struct llist_head headers
Definition: xua_msg.h:36
uint16_t tag
Definition: xua_types.h:0
uint16_t len
Definition: xua_types.h:1
uint8_t data[0]
Definition: xua_types.h:5
uint8_t version
Definition: xua_types.h:0