libosmocore  0.12.1
Osmocom core library
msgb.h
Go to the documentation of this file.
1 #pragma once
2 
3 /* (C) 2008 by Harald Welte <laforge@gnumonks.org>
4  * All Rights Reserved
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with this program; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19  *
20  */
21 
22 #include <stdint.h>
23 #include <osmocom/core/linuxlist.h>
24 #include <osmocom/core/utils.h>
25 #include <osmocom/core/bits.h>
26 #include <osmocom/core/defs.h>
27 
32 #define MSGB_DEBUG
33 
35 struct msgb {
36  struct llist_head list;
39  /* Part of which TRX logical channel we were received / transmitted */
40  /* FIXME: move them into the control buffer */
41  union {
42  void *dst;
43  struct gsm_bts_trx *trx;
44  };
45  struct gsm_lchan *lchan;
47  unsigned char *l1h;
48  unsigned char *l2h;
49  unsigned char *l3h;
50  unsigned char *l4h;
52  unsigned long cb[5];
54  uint16_t data_len;
55  uint16_t len;
57  unsigned char *head;
58  unsigned char *tail;
59  unsigned char *data;
60  unsigned char _data[0];
61 };
62 
63 extern struct msgb *msgb_alloc(uint16_t size, const char *name);
64 extern void msgb_free(struct msgb *m);
65 extern void msgb_enqueue(struct llist_head *queue, struct msgb *msg);
66 extern struct msgb *msgb_dequeue(struct llist_head *queue);
67 extern void msgb_reset(struct msgb *m);
68 uint16_t msgb_length(const struct msgb *msg);
69 extern const char *msgb_hexdump(const struct msgb *msg);
70 extern int msgb_resize_area(struct msgb *msg, uint8_t *area,
71  int old_size, int new_size);
72 extern struct msgb *msgb_copy(const struct msgb *msg, const char *name);
73 static int msgb_test_invariant(const struct msgb *msg) __attribute__((pure));
74 
78 static inline void msgb_queue_free(struct llist_head *queue)
79 {
80  struct msgb *msg;
81  while ((msg = msgb_dequeue(queue))) msgb_free(msg);
82 }
83 
84 #ifdef MSGB_DEBUG
85 #include <osmocom/core/panic.h>
86 #define MSGB_ABORT(msg, fmt, args ...) do { \
87  osmo_panic("msgb(%p): " fmt, msg, ## args); \
88  } while(0)
89 #else
90 #define MSGB_ABORT(msg, fmt, args ...)
91 #endif
92 
94 #define msgb_l1(m) ((void *)(m->l1h))
95 
96 #define msgb_l2(m) ((void *)(m->l2h))
97 
98 #define msgb_l3(m) ((void *)(m->l3h))
99 
100 #define msgb_sms(m) ((void *)(m->l4h))
101 
109 static inline unsigned int msgb_l1len(const struct msgb *msgb)
110 {
111  return msgb->tail - (uint8_t *)msgb_l1(msgb);
112 }
113 
121 static inline unsigned int msgb_l2len(const struct msgb *msgb)
122 {
123  return msgb->tail - (uint8_t *)msgb_l2(msgb);
124 }
125 
133 static inline unsigned int msgb_l3len(const struct msgb *msgb)
134 {
135  return msgb->tail - (uint8_t *)msgb_l3(msgb);
136 }
137 
145 static inline unsigned int msgb_headlen(const struct msgb *msgb)
146 {
147  return msgb->len - msgb->data_len;
148 }
149 
157 static inline int msgb_tailroom(const struct msgb *msgb)
158 {
159  return (msgb->head + msgb->data_len) - msgb->tail;
160 }
161 
169 static inline int msgb_headroom(const struct msgb *msgb)
170 {
171  return (msgb->data - msgb->head);
172 }
173 
186 static inline unsigned char *msgb_put(struct msgb *msgb, unsigned int len)
187 {
188  unsigned char *tmp = msgb->tail;
189  if (msgb_tailroom(msgb) < (int) len)
190  MSGB_ABORT(msgb, "Not enough tailroom msgb_put (%u < %u)\n",
191  msgb_tailroom(msgb), len);
192  msgb->tail += len;
193  msgb->len += len;
194  return tmp;
195 }
196 
201 static inline void msgb_put_u8(struct msgb *msgb, uint8_t word)
202 {
203  uint8_t *space = msgb_put(msgb, 1);
204  space[0] = word & 0xFF;
205 }
206 
211 static inline void msgb_put_u16(struct msgb *msgb, uint16_t word)
212 {
213  uint8_t *space = msgb_put(msgb, 2);
214  osmo_store16be(word, space);
215 }
216 
221 static inline void msgb_put_u32(struct msgb *msgb, uint32_t word)
222 {
223  uint8_t *space = msgb_put(msgb, 4);
224  osmo_store32be(word, space);
225 }
226 
231 static inline unsigned char *msgb_get(struct msgb *msgb, unsigned int len)
232 {
233  if (msgb_length(msgb) < len)
234  MSGB_ABORT(msgb, "msgb too small to get %u (len %u)\n",
235  len, msgb_length(msgb));
236  msgb->tail -= len;
237  msgb->len -= len;
238  return msgb->tail;
239 }
240 
245 static inline uint8_t msgb_get_u8(struct msgb *msgb)
246 {
247  uint8_t *space = msgb_get(msgb, 1);
248  return space[0];
249 }
250 
255 static inline uint16_t msgb_get_u16(struct msgb *msgb)
256 {
257  uint8_t *space = msgb_get(msgb, 2);
258  return osmo_load16be(space);
259 }
260 
265 static inline uint32_t msgb_get_u32(struct msgb *msgb)
266 {
267  uint8_t *space = msgb_get(msgb, 4);
268  return osmo_load32be(space);
269 }
270 
283 static inline unsigned char *msgb_push(struct msgb *msgb, unsigned int len)
284 {
285  if (msgb_headroom(msgb) < (int) len)
286  MSGB_ABORT(msgb, "Not enough headroom msgb_push (%u < %u)\n",
287  msgb_headroom(msgb), len);
288  msgb->data -= len;
289  msgb->len += len;
290  return msgb->data;
291 }
292 
297 static inline void msgb_push_u8(struct msgb *msg, uint8_t word)
298 {
299  uint8_t *space = msgb_push(msg, 1);
300  space[0] = word;
301 }
302 
307 static inline void msgb_push_u16(struct msgb *msg, uint16_t word)
308 {
309  uint16_t *space = (uint16_t *) msgb_push(msg, 2);
310  osmo_store16be(word, space);
311 }
312 
317 static inline void msgb_push_u32(struct msgb *msg, uint32_t word)
318 {
319  uint32_t *space = (uint32_t *) msgb_push(msg, 4);
320  osmo_store32be(word, space);
321 }
322 
332 static inline unsigned char *msgb_pull(struct msgb *msgb, unsigned int len)
333 {
334  if (msgb_length(msgb) < len)
335  MSGB_ABORT(msgb, "msgb too small to pull %u (len %u)\n",
336  len, msgb_length(msgb));
337  msgb->len -= len;
338  return msgb->data += len;
339 }
340 
349 static inline unsigned char *msgb_pull_to_l3(struct msgb *msg)
350 {
351  unsigned char *ret = msgb_pull(msg, msg->l3h - msg->data);
352  msg->l1h = msg->l2h = NULL;
353  return ret;
354 }
355 
364 static inline unsigned char *msgb_pull_to_l2(struct msgb *msg)
365 {
366  unsigned char *ret = msgb_pull(msg, msg->l2h - msg->data);
367  msg->l1h = NULL;
368  return ret;
369 }
370 
375 static inline uint8_t msgb_pull_u8(struct msgb *msgb)
376 {
377  uint8_t *space = msgb_pull(msgb, 1) - 1;
378  return space[0];
379 }
380 
385 static inline uint16_t msgb_pull_u16(struct msgb *msgb)
386 {
387  uint8_t *space = msgb_pull(msgb, 2) - 2;
388  return osmo_load16be(space);
389 }
390 
395 static inline uint32_t msgb_pull_u32(struct msgb *msgb)
396 {
397  uint8_t *space = msgb_pull(msgb, 4) - 4;
398  return osmo_load32be(space);
399 }
400 
412 static inline void msgb_reserve(struct msgb *msg, int len)
413 {
414  msg->data += len;
415  msg->tail += len;
416 }
417 
423 static inline int msgb_trim(struct msgb *msg, int len)
424 {
425  if (len < 0)
426  MSGB_ABORT(msg, "Negative length is not allowed\n");
427  if (len > msg->data_len)
428  return -1;
429 
430  msg->len = len;
431  msg->tail = msg->data + len;
432 
433  return 0;
434 }
435 
441 static inline int msgb_l3trim(struct msgb *msg, int l3len)
442 {
443  return msgb_trim(msg, (msg->l3h - msg->data) + l3len);
444 }
445 
456 static inline struct msgb *msgb_alloc_headroom(int size, int headroom,
457  const char *name)
458 {
459  osmo_static_assert(size > headroom, headroom_bigger);
460 
461  struct msgb *msg = msgb_alloc(size, name);
462  if (msg)
463  msgb_reserve(msg, headroom);
464  return msg;
465 }
466 
471 static inline int msgb_test_invariant(const struct msgb *msg)
472 {
473  const unsigned char *lbound;
474  if (!msg || !msg->data || !msg->tail ||
475  (msg->data + msg->len != msg->tail) ||
476  (msg->data < msg->head) ||
477  (msg->tail > msg->head + msg->data_len))
478  return 0;
479 
480  lbound = msg->head;
481 
482  if (msg->l1h) {
483  if (msg->l1h < lbound)
484  return 0;
485  lbound = msg->l1h;
486  }
487  if (msg->l2h) {
488  if (msg->l2h < lbound)
489  return 0;
490  lbound = msg->l2h;
491  }
492  if (msg->l3h) {
493  if (msg->l3h < lbound)
494  return 0;
495  lbound = msg->l3h;
496  }
497  if (msg->l4h) {
498  if (msg->l4h < lbound)
499  return 0;
500  lbound = msg->l4h;
501  }
502 
503  return lbound <= msg->head + msg->data_len;
504 }
505 
506 /* non inline functions to ease binding */
507 
508 uint8_t *msgb_data(const struct msgb *msg);
509 
510 void *msgb_talloc_ctx_init(void *root_ctx, unsigned int pool_size);
511 void msgb_set_talloc_ctx(void *ctx) OSMO_DEPRECATED("Use msgb_talloc_ctx_init() instead");
512 int msgb_printf(struct msgb *msgb, const char *format, ...);
513 
514 static inline const char *msgb_hexdump_l2(const struct msgb *msg)
515 {
516  if (!msgb_l2(msg) || !(msgb_l2len(msg)))
517  return "[]";
518  return osmo_hexdump((const unsigned char *) msgb_l2(msg), msgb_l2len(msg));
519 }
520 
521 static inline const char *msgb_hexdump_l3(const struct msgb *msg)
522 {
523  if (!msgb_l3(msg) || !(msgb_l3len(msg)))
524  return "[]";
525  return osmo_hexdump((const unsigned char*) msgb_l3(msg), msgb_l3len(msg));
526 }
527 
static unsigned char * msgb_put(struct msgb *msgb, unsigned int len)
append data to end of message buffer
Definition: msgb.h:186
static uint16_t msgb_pull_u16(struct msgb *msgb)
remove uint16 from front of message
Definition: msgb.h:385
static unsigned int msgb_l3len(const struct msgb *msgb)
determine length of L3 message
Definition: msgb.h:133
unsigned long cb[5]
control buffer
Definition: msgb.h:52
#define OSMO_DEPRECATED(text)
Set the deprecated attribute with a message.
Definition: defs.h:41
unsigned char * l3h
pointer to Layer 3 header.
Definition: msgb.h:49
#define msgb_l3(m)
obtain L3 header of msgb
Definition: msgb.h:98
#define msgb_l1(m)
obtain L1 header of msgb
Definition: msgb.h:94
struct msgb * msgb_alloc(uint16_t size, const char *name)
Allocate a new message buffer.
Definition: msgb.c:78
unsigned char * data
start of message in buffer
Definition: msgb.h:59
static const char * msgb_hexdump_l2(const struct msgb *msg)
Definition: msgb.h:514
struct rb_root __attribute__
Definition: conv_acc_generic.c:140
Osmocom message buffer.
Definition: msgb.h:35
void msgb_set_talloc_ctx(void *ctx) OSMO_DEPRECATED("Use msgb_talloc_ctx_init() instead")
Set the talloc context for msgb_alloc Deprecated, use msgb_talloc_ctx_init() instead.
Definition: msgb.c:189
static const char * msgb_hexdump_l3(const struct msgb *msg)
Definition: msgb.h:521
static int msgb_l3trim(struct msgb *msg, int l3len)
Trim the msgb to a given layer3 length.
Definition: msgb.h:441
General definitions that are meant to be included from header files.
static int msgb_trim(struct msgb *msg, int len)
Trim the msgb to a given absolute length.
Definition: msgb.h:423
uint16_t len
length of bytes used in msgb
Definition: msgb.h:55
char name[32]
source file name
Definition: gsmtap.h:124
static unsigned char * msgb_pull_to_l3(struct msgb *msg)
remove (pull) all headers in front of l3h from the message buffer.
Definition: msgb.h:349
#define osmo_static_assert(exp, name)
Definition: utils.h:60
void msgb_free(struct msgb *m)
Release given message buffer.
Definition: msgb.c:104
static int msgb_tailroom(const struct msgb *msgb)
determine how much tail room is left in msgb
Definition: msgb.h:157
unsigned char * l4h
pointer to layer 4 header
Definition: msgb.h:50
static uint16_t osmo_load16be(const void *p)
load unaligned 16-bit integer (big-endian encoding)
Definition: bit16gen.h:89
static unsigned int msgb_l1len(const struct msgb *msgb)
determine length of L1 message
Definition: msgb.h:109
static unsigned char * msgb_get(struct msgb *msgb, unsigned int len)
remove data from end of message
Definition: msgb.h:231
const char * msgb_hexdump(const struct msgb *msg)
Return a (static) buffer containing a hexdump of the msg.
Definition: msgb.c:307
static void msgb_push_u8(struct msgb *msg, uint8_t word)
prepend a uint8 value to the head of the message
Definition: msgb.h:297
struct msgb * msgb_dequeue(struct llist_head *queue)
Dequeue message buffer from head of queue.
Definition: msgb.c:128
static void msgb_queue_free(struct llist_head *queue)
Free all msgbs from a queue built with msgb_enqueue().
Definition: msgb.h:78
void * msgb_talloc_ctx_init(void *root_ctx, unsigned int pool_size)
Initialize a msgb talloc context for msgb_alloc.
Definition: msgb.c:202
int msgb_resize_area(struct msgb *msg, uint8_t *area, int old_size, int new_size)
Resize an area within an msgb.
Definition: msgb.c:262
static uint32_t msgb_pull_u32(struct msgb *msgb)
remove uint32 from front of message
Definition: msgb.h:395
static unsigned int msgb_l2len(const struct msgb *msgb)
determine length of L2 message
Definition: msgb.h:121
static struct msgb * msgb_alloc_headroom(int size, int headroom, const char *name)
Allocate message buffer with specified headroom.
Definition: msgb.h:456
static unsigned char * msgb_push(struct msgb *msgb, unsigned int len)
prepend (push) some data to start of message
Definition: msgb.h:283
Simple doubly linked list implementation.
struct gsm_bts_trx * trx
Definition: msgb.h:43
(double) linked list header structure
Definition: linuxlist.h:46
unsigned char * l1h
pointer to Layer1 header (if any)
Definition: msgb.h:47
static uint8_t msgb_pull_u8(struct msgb *msgb)
remove uint8 from front of message
Definition: msgb.h:375
void msgb_enqueue(struct llist_head *queue, struct msgb *msg)
Enqueue message buffer to tail of a queue.
Definition: msgb.c:116
struct gsm_lchan * lchan
logical channel
Definition: msgb.h:45
void msgb_reset(struct msgb *m)
Re-set all message buffer pointers.
Definition: msgb.c:151
static void msgb_push_u32(struct msgb *msg, uint32_t word)
prepend a uint32 value to the head of the message
Definition: msgb.h:317
static void msgb_reserve(struct msgb *msg, int len)
Increase headroom of empty msgb, reducing the tailroom.
Definition: msgb.h:412
unsigned char * tail
end of message in buffer
Definition: msgb.h:58
int msgb_printf(struct msgb *msgb, const char *format,...)
Print a string to the end of message buffer.
Definition: msgb.c:402
static void msgb_put_u16(struct msgb *msgb, uint16_t word)
append a uint16 value to the end of the message
Definition: msgb.h:211
static uint8_t msgb_get_u8(struct msgb *msgb)
remove uint8 from end of message
Definition: msgb.h:245
unsigned char * l2h
pointer to A-bis layer 2 header: OML, RSL(RLL), NS
Definition: msgb.h:48
struct msgb * msgb_copy(const struct msgb *msg, const char *name)
Copy an msgb.
Definition: msgb.c:220
unsigned char * head
start of underlying memory buffer
Definition: msgb.h:57
static uint32_t msgb_get_u32(struct msgb *msgb)
remove uint32 from end of message
Definition: msgb.h:265
static int msgb_headroom(const struct msgb *msgb)
determine the amount of headroom in msgb
Definition: msgb.h:169
Osmocom bit level support code.
static uint32_t osmo_load32be(const void *p)
load unaligned 32-bit integer (big-endian encoding)
Definition: bit32gen.h:89
uint16_t data_len
length of underlying data array
Definition: msgb.h:54
static void osmo_store16be(uint16_t x, void *p)
store unaligned 16-bit integer (big-endian encoding)
Definition: bit16gen.h:102
#define MSGB_ABORT(msg, fmt, args...)
Definition: msgb.h:86
unsigned char _data[0]
optional immediate data array
Definition: msgb.h:60
struct llist_head list
linked list header
Definition: msgb.h:36
uint8_t * msgb_data(const struct msgb *msg)
get pointer to data section of message buffer
Definition: msgb.c:171
#define msgb_l2(m)
obtain L2 header of msgb
Definition: msgb.h:96
static uint16_t msgb_get_u16(struct msgb *msgb)
remove uint16 from end of message
Definition: msgb.h:255
char * osmo_hexdump(const unsigned char *buf, int len)
Convert binary sequence to hexadecimal ASCII string.
Definition: utils.c:252
void * dst
reference of origin/destination
Definition: msgb.h:42
static unsigned int msgb_headlen(const struct msgb *msgb)
determine the length of the header
Definition: msgb.h:145
uint16_t msgb_length(const struct msgb *msg)
get length of message buffer
Definition: msgb.c:180
static int msgb_test_invariant(const struct msgb *msg) __attribute__((pure))
Check a message buffer for consistency.
Definition: msgb.h:471
static void msgb_put_u32(struct msgb *msgb, uint32_t word)
append a uint32 value to the end of the message
Definition: msgb.h:221
static unsigned char * msgb_pull(struct msgb *msgb, unsigned int len)
remove (pull) a header from the front of the message buffer
Definition: msgb.h:332
static void osmo_store32be(uint32_t x, void *p)
store unaligned 32-bit integer (big-endian encoding)
Definition: bit32gen.h:102
static unsigned char * msgb_pull_to_l2(struct msgb *msg)
remove (pull) all headers in front of l2h from the message buffer.
Definition: msgb.h:364
static void msgb_push_u16(struct msgb *msg, uint16_t word)
prepend a uint16 value to the head of the message
Definition: msgb.h:307
static void msgb_put_u8(struct msgb *msgb, uint8_t word)
append a uint8 value to the end of the message
Definition: msgb.h:201