libosmogsm  0.9.6.311-c977
Osmocom GSM library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
tlv.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <stdint.h>
4 #include <string.h>
5 
6 #include <osmocom/core/msgb.h>
7 #include <osmocom/core/bit16gen.h>
8 #include <osmocom/core/bit32gen.h>
9 
14 /* Terminology / wording
15  tag length value (in bits)
16 
17  V - - 8
18  LV - 8 N * 8
19  TLV 8 8 N * 8
20  TL16V 8 16 N * 8
21  TLV16 8 8 N * 16
22  TvLV 8 8/16 N * 8
23  vTvLV 8/16 8/16 N * 8
24 
25 */
26 
28 #define LV_GROSS_LEN(x) (x+1)
29 
30 #define TLV_GROSS_LEN(x) (x+2)
31 
32 #define TLV16_GROSS_LEN(x) ((2*x)+2)
33 
34 #define TL16V_GROSS_LEN(x) (x+3)
35 
36 #define L16TV_GROSS_LEN(x) (x+3)
37 
39 #define TVLV_MAX_ONEBYTE 0x7f
40 
42 static inline uint16_t TVLV_GROSS_LEN(uint16_t len)
43 {
44  if (len <= TVLV_MAX_ONEBYTE)
45  return TLV_GROSS_LEN(len);
46  else
47  return TL16V_GROSS_LEN(len);
48 }
49 
51 static inline uint16_t VTVL_GAN_GROSS_LEN(uint16_t tag, uint16_t len)
52 {
53  uint16_t ret = 2;
54 
55  if (tag > TVLV_MAX_ONEBYTE)
56  ret++;
57 
58  if (len > TVLV_MAX_ONEBYTE)
59  ret++;
60 
61  return ret;
62 }
63 
65 static inline uint16_t VTVLV_GAN_GROSS_LEN(uint16_t tag, uint16_t len)
66 {
67  uint16_t ret;
68 
69  if (len <= TVLV_MAX_ONEBYTE)
70  ret = TLV_GROSS_LEN(len);
71  else
72  ret = TL16V_GROSS_LEN(len);
73 
74  if (tag > TVLV_MAX_ONEBYTE)
75  ret += 1;
76 
77  return ret;
78 }
79 
80 /* TLV generation */
81 
83 static inline uint8_t *lv_put(uint8_t *buf, uint8_t len,
84  const uint8_t *val)
85 {
86  *buf++ = len;
87  memcpy(buf, val, len);
88  return buf + len;
89 }
90 
92 static inline uint8_t *tlv_put(uint8_t *buf, uint8_t tag, uint8_t len,
93  const uint8_t *val)
94 {
95  *buf++ = tag;
96  *buf++ = len;
97  memcpy(buf, val, len);
98  return buf + len;
99 }
100 
102 static inline uint8_t *tlv16_put(uint8_t *buf, uint8_t tag, uint8_t len,
103  const uint16_t *val)
104 {
105  *buf++ = tag;
106  *buf++ = len;
107  memcpy(buf, val, len*2);
108  return buf + len*2;
109 }
110 
112 static inline uint8_t *tl16v_put(uint8_t *buf, uint8_t tag, uint16_t len,
113  const uint8_t *val)
114 {
115  *buf++ = tag;
116  *buf++ = len >> 8;
117  *buf++ = len & 0xff;
118  memcpy(buf, val, len);
119  return buf + len*2;
120 }
121 
123 static inline uint8_t *tvlv_put(uint8_t *buf, uint8_t tag, uint16_t len,
124  const uint8_t *val)
125 {
126  uint8_t *ret;
127 
128  if (len <= TVLV_MAX_ONEBYTE) {
129  ret = tlv_put(buf, tag, len, val);
130  buf[1] |= 0x80;
131  } else
132  ret = tl16v_put(buf, tag, len, val);
133 
134  return ret;
135 }
136 
138 static inline uint8_t *vt_gan_put(uint8_t *buf, uint16_t tag)
139 {
140  if (tag > TVLV_MAX_ONEBYTE) {
141  /* two-byte TAG */
142  *buf++ = 0x80 | (tag >> 8);
143  *buf++ = (tag & 0xff);
144  } else
145  *buf++ = tag;
146 
147  return buf;
148 }
149 
150 /* put (append) vTvL (GAN) field (tag + length)*/
151 static inline uint8_t *vtvl_gan_put(uint8_t *buf, uint16_t tag, uint16_t len)
152 {
153  uint8_t *ret;
154 
155  ret = vt_gan_put(buf, tag);
156  return vt_gan_put(ret, len);
157 }
158 
159 /* put (append) vTvLV (GAN) field (tag + length + val) */
160 static inline uint8_t *vtvlv_gan_put(uint8_t *buf, uint16_t tag, uint16_t len,
161  const uint8_t *val)
162 {
163  uint8_t *ret;
164 
165  ret = vtvl_gan_put(buf, tag, len );
166 
167  memcpy(ret, val, len);
168  ret = buf + len;
169 
170  return ret;
171 }
172 
174 static inline uint8_t *msgb_tlv16_put(struct msgb *msg, uint8_t tag, uint8_t len, const uint16_t *val)
175 {
176  uint8_t *buf = msgb_put(msg, TLV16_GROSS_LEN(len));
177  return tlv16_put(buf, tag, len, val);
178 }
179 
181 static inline uint8_t *msgb_tl16v_put(struct msgb *msg, uint8_t tag, uint16_t len,
182  const uint8_t *val)
183 {
184  uint8_t *buf = msgb_put(msg, TL16V_GROSS_LEN(len));
185  return tl16v_put(buf, tag, len, val);
186 }
187 
189 static inline uint8_t *msgb_tvlv_put(struct msgb *msg, uint8_t tag, uint16_t len,
190  const uint8_t *val)
191 {
192  uint8_t *buf = msgb_put(msg, TVLV_GROSS_LEN(len));
193  return tvlv_put(buf, tag, len, val);
194 }
195 
197 static inline uint8_t *msgb_vtvlv_gan_put(struct msgb *msg, uint16_t tag,
198  uint16_t len, const uint8_t *val)
199 {
200  uint8_t *buf = msgb_put(msg, VTVLV_GAN_GROSS_LEN(tag, len));
201  return vtvlv_gan_put(buf, tag, len, val);
202 }
203 
205 static inline uint8_t *msgb_l16tv_put(struct msgb *msg, uint16_t len, uint8_t tag,
206  const uint8_t *val)
207 {
208  uint8_t *buf = msgb_put(msg, L16TV_GROSS_LEN(len));
209 
210  *buf++ = len >> 8;
211  *buf++ = len & 0xff;
212  *buf++ = tag;
213  memcpy(buf, val, len);
214  return buf + len;
215 }
216 
218 static inline uint8_t *v_put(uint8_t *buf, uint8_t val)
219 {
220  *buf++ = val;
221  return buf;
222 }
223 
225 static inline uint8_t *tv_put(uint8_t *buf, uint8_t tag,
226  uint8_t val)
227 {
228  *buf++ = tag;
229  *buf++ = val;
230  return buf;
231 }
232 
234 static inline uint8_t *tv_fixed_put(uint8_t *buf, uint8_t tag,
235  unsigned int len, const uint8_t *val)
236 {
237  *buf++ = tag;
238  memcpy(buf, val, len);
239  return buf + len;
240 }
241 
247 static inline uint8_t *tv16_put(uint8_t *buf, uint8_t tag,
248  uint16_t val)
249 {
250  *buf++ = tag;
251  *buf++ = val >> 8;
252  *buf++ = val & 0xff;
253  return buf;
254 }
255 
258 static inline uint8_t *msgb_lv_put(struct msgb *msg, uint8_t len, const uint8_t *val)
259 {
260  uint8_t *buf = msgb_put(msg, LV_GROSS_LEN(len));
261  return lv_put(buf, len, val);
262 }
263 
266 static inline uint8_t *msgb_tlv_put(struct msgb *msg, uint8_t tag, uint8_t len, const uint8_t *val)
267 {
268  uint8_t *buf = msgb_put(msg, TLV_GROSS_LEN(len));
269  return tlv_put(buf, tag, len, val);
270 }
271 
274 static inline uint8_t *msgb_tv_put(struct msgb *msg, uint8_t tag, uint8_t val)
275 {
276  uint8_t *buf = msgb_put(msg, 2);
277  return tv_put(buf, tag, val);
278 }
279 
282 static inline uint8_t *msgb_tv_fixed_put(struct msgb *msg, uint8_t tag,
283  unsigned int len, const uint8_t *val)
284 {
285  uint8_t *buf = msgb_put(msg, 1+len);
286  return tv_fixed_put(buf, tag, len, val);
287 }
288 
291 static inline uint8_t *msgb_v_put(struct msgb *msg, uint8_t val)
292 {
293  uint8_t *buf = msgb_put(msg, 1);
294  return v_put(buf, val);
295 }
296 
299 static inline uint8_t *msgb_tv16_put(struct msgb *msg, uint8_t tag, uint16_t val)
300 {
301  uint8_t *buf = msgb_put(msg, 3);
302  return tv16_put(buf, tag, val);
303 }
304 
307 static inline uint8_t *msgb_tlv_push(struct msgb *msg, uint8_t tag, uint8_t len, const uint8_t *val)
308 {
309  uint8_t *buf = msgb_push(msg, TLV_GROSS_LEN(len));
310  tlv_put(buf, tag, len, val);
311  return buf;
312 }
313 
316 static inline uint8_t *msgb_tv_push(struct msgb *msg, uint8_t tag, uint8_t val)
317 {
318  uint8_t *buf = msgb_push(msg, 2);
319  tv_put(buf, tag, val);
320  return buf;
321 }
322 
325 static inline uint8_t *msgb_tv16_push(struct msgb *msg, uint8_t tag, uint16_t val)
326 {
327  uint8_t *buf = msgb_push(msg, 3);
328  tv16_put(buf, tag, val);
329  return buf;
330 }
331 
334 static inline uint8_t *msgb_tvlv_push(struct msgb *msg, uint8_t tag, uint16_t len,
335  const uint8_t *val)
336 {
337  uint8_t *buf = msgb_push(msg, TVLV_GROSS_LEN(len));
338  tvlv_put(buf, tag, len, val);
339  return buf;
340 }
341 
342 /* push (prepend) a vTvL header to a \ref msgb
343  */
344 static inline uint8_t *msgb_vtvl_gan_push(struct msgb *msg, uint16_t tag,
345  uint16_t len)
346 {
347  uint8_t *buf = msgb_push(msg, VTVL_GAN_GROSS_LEN(tag, len));
348  vtvl_gan_put(buf, tag, len);
349  return buf;
350 }
351 
352 
353 static inline uint8_t *msgb_vtvlv_gan_push(struct msgb *msg, uint16_t tag,
354  uint16_t len, const uint8_t *val)
355 {
356  uint8_t *buf = msgb_push(msg, VTVLV_GAN_GROSS_LEN(tag, len));
357  vtvlv_gan_put(buf, tag, len, val);
358  return buf;
359 }
360 
361 /* TLV parsing */
362 
364 struct tlv_p_entry {
365  uint16_t len;
366  const uint8_t *val;
367 };
368 
370 enum tlv_type {
380 };
381 
383 struct tlv_def {
384  enum tlv_type type;
385  uint8_t fixed_len;
386 };
387 
390  struct tlv_def def[256];
391 };
392 
394 struct tlv_parsed {
395  struct tlv_p_entry lv[256];
396 };
397 
398 extern struct tlv_definition tvlv_att_def;
399 extern struct tlv_definition vtvlv_gan_att_def;
400 
401 int tlv_parse_one(uint8_t *o_tag, uint16_t *o_len, const uint8_t **o_val,
402  const struct tlv_definition *def,
403  const uint8_t *buf, int buf_len);
404 int tlv_parse(struct tlv_parsed *dec, const struct tlv_definition *def,
405  const uint8_t *buf, int buf_len, uint8_t lv_tag, uint8_t lv_tag2);
406 /* take a master (src) tlv def and fill up all empty slots in 'dst' */
407 void tlv_def_patch(struct tlv_definition *dst, const struct tlv_definition *src);
408 
409 #define TLVP_PRESENT(x, y) ((x)->lv[y].val)
410 #define TLVP_LEN(x, y) (x)->lv[y].len
411 #define TLVP_VAL(x, y) (x)->lv[y].val
412 
413 #define TLVP_PRES_LEN(tp, tag, min_len) \
414  (TLVP_PRESENT(tp, tag) && TLVP_LEN(tp, tag) >= min_len)
415 
421 static inline uint16_t tlvp_val16_unal(const struct tlv_parsed *tp, int pos)
422 {
423  uint16_t res;
424  memcpy(&res, TLVP_VAL(tp, pos), sizeof(res));
425  return res;
426 }
427 
433 static inline uint32_t tlvp_val32_unal(const struct tlv_parsed *tp, int pos)
434 {
435  uint32_t res;
436  memcpy(&res, TLVP_VAL(tp, pos), sizeof(res));
437  return res;
438 }
439 
445 static inline uint16_t tlvp_val16be(const struct tlv_parsed *tp, int pos)
446 {
447  return osmo_load16be(TLVP_VAL(tp, pos));
448 }
449 
455 static inline uint32_t tlvp_val32be(const struct tlv_parsed *tp, int pos)
456 {
457  return osmo_load32be(TLVP_VAL(tp, pos));
458 }
459 
460 
461 struct tlv_parsed *osmo_tlvp_copy(const struct tlv_parsed *tp_orig, void *ctx);
462 int osmo_tlvp_merge(struct tlv_parsed *dst, const struct tlv_parsed *src);
463 int osmo_shift_v_fixed(uint8_t **data, size_t *data_len,
464  size_t len, uint8_t **value);
465 int osmo_match_shift_tv_fixed(uint8_t **data, size_t *data_len,
466  uint8_t tag, size_t len, uint8_t **value);
467 int osmo_shift_tlv(uint8_t **data, size_t *data_len,
468  uint8_t *tag, uint8_t **value, size_t *value_len);
469 int osmo_match_shift_tlv(uint8_t **data, size_t *data_len,
470  uint8_t tag, uint8_t **value, size_t *value_len);
471 int osmo_shift_lv(uint8_t **data, size_t *data_len,
472  uint8_t **value, size_t *value_len);
473 
static uint8_t * msgb_tv_push(struct msgb *msg, uint8_t tag, uint8_t val)
push (prepend) a TV field to a msgb
Definition: tlv.h:316
static uint16_t VTVLV_GAN_GROSS_LEN(uint16_t tag, uint16_t len)
gross length of vTvLV (tag+len+val)
Definition: tlv.h:65
static uint16_t tlvp_val16be(const struct tlv_parsed *tp, int pos)
Retrieve (possibly unaligned) TLV element and convert to host byte order.
Definition: tlv.h:445
static uint8_t * msgb_tv16_push(struct msgb *msg, uint8_t tag, uint16_t val)
push (prepend) a TV16 field to a msgb
Definition: tlv.h:325
static uint8_t * tv_put(uint8_t *buf, uint8_t tag, uint8_t val)
put (append) a TV field
Definition: tlv.h:225
static uint8_t * msgb_l16tv_put(struct msgb *msg, uint16_t len, uint8_t tag, const uint8_t *val)
put (append) a L16TV field to msgb
Definition: tlv.h:205
uint16_t len
length
Definition: tlv.h:365
int osmo_shift_v_fixed(uint8_t **data, size_t *data_len, size_t len, uint8_t **value)
Advance the data pointer, subtract length and assign value pointer.
Definition: tlv_parser.c:311
static uint8_t * msgb_tlv16_put(struct msgb *msg, uint8_t tag, uint8_t len, const uint16_t *val)
put (append) a TLV16 field to msgb
Definition: tlv.h:174
static uint8_t * msgb_tv_put(struct msgb *msg, uint8_t tag, uint8_t val)
put (append) a TV field to a msgb
Definition: tlv.h:274
int tlv_parse_one(uint8_t *o_tag, uint16_t *o_len, const uint8_t **o_val, const struct tlv_definition *def, const uint8_t *buf, int buf_len)
Parse a single TLV encoded IE.
Definition: tlv_parser.c:129
struct tlv_definition tvlv_att_def
Definition: tlv_parser.c:45
static uint8_t * msgb_tvlv_push(struct msgb *msg, uint8_t tag, uint16_t len, const uint8_t *val)
push (prepend) a TvLV field to a msgb
Definition: tlv.h:334
static uint32_t tlvp_val32be(const struct tlv_parsed *tp, int pos)
Retrieve (possibly unaligned) TLV element and convert to host byte order.
Definition: tlv.h:455
int osmo_match_shift_tv_fixed(uint8_t **data, size_t *data_len, uint8_t tag, size_t len, uint8_t **value)
Match tag, check length and assign value pointer.
Definition: tlv_parser.c:339
static uint16_t TVLV_GROSS_LEN(uint16_t len)
gross length of a TVLV type field
Definition: tlv.h:42
static uint8_t * vt_gan_put(uint8_t *buf, uint16_t tag)
put (append) a variable-length tag or variable-length length *
Definition: tlv.h:138
static uint8_t * tvlv_put(uint8_t *buf, uint8_t tag, uint16_t len, const uint8_t *val)
put (append) a TvLV field
Definition: tlv.h:123
static uint8_t * lv_put(uint8_t *buf, uint8_t len, const uint8_t *val)
put (append) a LV field
Definition: tlv.h:83
static uint8_t * msgb_vtvl_gan_push(struct msgb *msg, uint16_t tag, uint16_t len)
Definition: tlv.h:344
int osmo_shift_tlv(uint8_t **data, size_t *data_len, uint8_t *tag, uint8_t **value, size_t *value_len)
Extract TLV and advance data pointer + subtract length.
Definition: tlv_parser.c:405
Entry in a TLV parser array.
Definition: tlv.h:364
#define TLV_GROSS_LEN(x)
gross length of a TLV type field
Definition: tlv.h:30
struct tlv_p_entry lv[256]
Definition: tlv.h:395
tag-value (8bit)
Definition: tlv.h:374
static uint8_t * tv_fixed_put(uint8_t *buf, uint8_t tag, unsigned int len, const uint8_t *val)
put (append) a TVfixed field
Definition: tlv.h:234
#define TL16V_GROSS_LEN(x)
gross length of a TL16V type field
Definition: tlv.h:34
no type
Definition: tlv.h:371
#define TVLV_MAX_ONEBYTE
maximum length of TLV of one byte length
Definition: tlv.h:39
static uint8_t * msgb_vtvlv_gan_put(struct msgb *msg, uint16_t tag, uint16_t len, const uint8_t *val)
put (append) a vTvLV field to msgb
Definition: tlv.h:197
static uint16_t VTVL_GAN_GROSS_LEN(uint16_t tag, uint16_t len)
gross length of vTvL header (tag+len)
Definition: tlv.h:51
static uint8_t * msgb_tv16_put(struct msgb *msg, uint8_t tag, uint16_t val)
put (append) a TV16 field to a msgb
Definition: tlv.h:299
#define TLV16_GROSS_LEN(x)
gross length of a TLV16 type field
Definition: tlv.h:32
Definition of a single IE (Information Element)
Definition: tlv.h:383
#define L16TV_GROSS_LEN(x)
gross length of a L16TV type field
Definition: tlv.h:36
static uint8_t * tl16v_put(uint8_t *buf, uint8_t tag, uint16_t len, const uint8_t *val)
put (append) a TL16V field
Definition: tlv.h:112
struct tlv_def def[256]
Definition: tlv.h:390
static uint8_t * msgb_tlv_put(struct msgb *msg, uint8_t tag, uint8_t len, const uint8_t *val)
put (append) a TLV field to a msgb
Definition: tlv.h:266
enum tlv_type type
TLV type.
Definition: tlv.h:384
static uint8_t * tv16_put(uint8_t *buf, uint8_t tag, uint16_t val)
put (append) a TV16 field
Definition: tlv.h:247
static uint16_t tlvp_val16_unal(const struct tlv_parsed *tp, int pos)
Align given TLV element with 16 bit value to an even address.
Definition: tlv.h:421
static uint8_t * tlv16_put(uint8_t *buf, uint8_t tag, uint8_t len, const uint16_t *val)
put (append) a TLV16 field
Definition: tlv.h:102
int osmo_shift_lv(uint8_t **data, size_t *data_len, uint8_t **value, size_t *value_len)
Extract LV and advance data pointer + subtract length.
Definition: tlv_parser.c:445
tag-length-value
Definition: tlv.h:375
static uint8_t * msgb_tv_fixed_put(struct msgb *msg, uint8_t tag, unsigned int len, const uint8_t *val)
put (append) a TVfixed field to a msgb
Definition: tlv.h:282
int osmo_match_shift_tlv(uint8_t **data, size_t *data_len, uint8_t tag, uint8_t **value, size_t *value_len)
Verify TLV header and advance data / subtract length.
Definition: tlv_parser.c:377
static uint8_t * vtvl_gan_put(uint8_t *buf, uint16_t tag, uint16_t len)
Definition: tlv.h:151
tlv_type
TLV type.
Definition: tlv.h:370
static uint8_t * v_put(uint8_t *buf, uint8_t val)
put (append) a V field
Definition: tlv.h:218
static uint8_t * msgb_tl16v_put(struct msgb *msg, uint8_t tag, uint16_t len, const uint8_t *val)
put (append) a TL16V field to msgb
Definition: tlv.h:181
variable-length tag, variable-length length
Definition: tlv.h:379
tag, 16 bit length, value
Definition: tlv.h:376
struct tlv_parsed * osmo_tlvp_copy(const struct tlv_parsed *tp_orig, void *ctx)
Copy tlv_parsed using given talloc context.
Definition: tlv_parser.c:66
result of the TLV parser
Definition: tlv.h:394
static uint8_t * tlv_put(uint8_t *buf, uint8_t tag, uint8_t len, const uint8_t *val)
put (append) a TLV field
Definition: tlv.h:92
uint8_t fixed_len
length in case of TLV_TYPE_FIXED
Definition: tlv.h:385
fixed-length value-only
Definition: tlv.h:372
void tlv_def_patch(struct tlv_definition *dst, const struct tlv_definition *src)
take a master (src) tlvdev and fill up all empty slots in 'dst'
Definition: tlv_parser.c:282
static uint8_t * msgb_vtvlv_gan_push(struct msgb *msg, uint16_t tag, uint16_t len, const uint8_t *val)
Definition: tlv.h:353
static uint32_t tlvp_val32_unal(const struct tlv_parsed *tp, int pos)
Align given TLV element with 32 bit value to an address that is a multiple of 4.
Definition: tlv.h:433
Definition of All 256 IE / TLV.
Definition: tlv.h:389
int osmo_tlvp_merge(struct tlv_parsed *dst, const struct tlv_parsed *src)
Merge all tlv_parsed attributes of 'src' into 'dst'.
Definition: tlv_parser.c:101
static uint8_t * msgb_v_put(struct msgb *msg, uint8_t val)
put (append) a V field to a msgb
Definition: tlv.h:291
int tlv_parse(struct tlv_parsed *dec, const struct tlv_definition *def, const uint8_t *buf, int buf_len, uint8_t lv_tag, uint8_t lv_tag2)
Parse an entire buffer of TLV encoded Information Elements.
Definition: tlv_parser.c:229
#define LV_GROSS_LEN(x)
gross length of a LV type field
Definition: tlv.h:28
tag-only
Definition: tlv.h:373
tag, variable length, value
Definition: tlv.h:377
const uint8_t * val
pointer to value
Definition: tlv.h:366
#define TLVP_VAL(x, y)
Definition: tlv.h:411
static uint8_t * vtvlv_gan_put(uint8_t *buf, uint16_t tag, uint16_t len, const uint8_t *val)
Definition: tlv.h:160
static uint8_t * msgb_tlv_push(struct msgb *msg, uint8_t tag, uint8_t len, const uint8_t *val)
push (prepend) a TLV field to a msgb
Definition: tlv.h:307
struct tlv_definition vtvlv_gan_att_def
Definition: tlv_parser.c:46
static uint8_t * msgb_lv_put(struct msgb *msg, uint8_t len, const uint8_t *val)
put (append) a LV field to a msgb
Definition: tlv.h:258
static uint8_t * msgb_tvlv_put(struct msgb *msg, uint8_t tag, uint16_t len, const uint8_t *val)
put (append) a TvLV field to msgb
Definition: tlv.h:189
tag and value (both 4 bit) in 1 byte
Definition: tlv.h:378