src/shared/libosmocore/include/osmocore/msgb.h

   1 #ifndef _MSGB_H
   2 #define _MSGB_H
   3
   4 /* (C) 2008 by Harald Welte <laforge@gnumonks.org>
   5  * All Rights Reserved
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  */
  22
  23 #include <stdint.h>
  24 #include "linuxlist.h"
  25
  26 struct bts_link;
  27
  28 struct msgb {
  29         struct llist_head list;
  30
  31         /* ptr to the physical E1 link to the BTS(s) */
  32         struct gsm_bts_link *bts_link;
  33
  34         /* Part of which TRX logical channel we were received / transmitted */
  35         struct gsm_bts_trx *trx;
  36         struct gsm_lchan *lchan;
  37
  38         /* the Layer1 header (if any) */
  39         unsigned char *l1h;
  40         /* the A-bis layer 2 header: OML, RSL(RLL), NS */
  41         unsigned char *l2h;
  42         /* the layer 3 header. For OML: FOM; RSL: 04.08; GPRS: BSSGP */
  43         unsigned char *l3h;
  44
  45         /* the layer 4 header */
  46         union {
  47                 unsigned char *smsh;
  48                 unsigned char *llch;
  49         };
  50
  51         /* the layer 5 header, GPRS: GMM header */
  52         unsigned char *gmmh;
  53         uint32_t tlli;
  54
  55         uint16_t data_len;
  56         uint16_t len;
  57
  58         unsigned char *head;
  59         unsigned char *tail;
  60         unsigned char *data;
  61         unsigned char _data[0];
  62 };
  63
  64 extern struct msgb *msgb_alloc(uint16_t size, const char *name);
  65 extern void msgb_free(struct msgb *m);
  66 extern void msgb_enqueue(struct llist_head *queue, struct msgb *msg);
  67 extern struct msgb *msgb_dequeue(struct llist_head *queue);
  68 extern void msgb_reset(struct msgb *m);
  69
  70 #define msgb_l2(m)      ((void *)(m->l2h))
  71 #define msgb_l3(m)      ((void *)(m->l3h))
  72 #define msgb_sms(m)     ((void *)(m->smsh))
  73
  74 static inline unsigned int msgb_l2len(const struct msgb *msgb)
  75 {
  76         return msgb->tail - (uint8_t *)msgb_l2(msgb);
  77 }
  78
  79 static inline unsigned int msgb_l3len(const struct msgb *msgb)
  80 {
  81         return msgb->tail - (uint8_t *)msgb_l3(msgb);
  82 }
  83
  84 static inline unsigned int msgb_headlen(const struct msgb *msgb)
  85 {
  86         return msgb->len - msgb->data_len;
  87 }
  88 static inline unsigned char *msgb_put(struct msgb *msgb, unsigned int len)
  89 {
  90         unsigned char *tmp = msgb->tail;
  91         msgb->tail += len;
  92         msgb->len += len;
  93         return tmp;
  94 }
  95 static inline unsigned char *msgb_push(struct msgb *msgb, unsigned int len)
  96 {
  97         msgb->data -= len;
  98         msgb->len += len;
  99         return msgb->data;
 100 }
 101 static inline unsigned char *msgb_pull(struct msgb *msgb, unsigned int len)
 102 {
 103         msgb->len -= len;
 104         return msgb->data += len;
 105 }
 106 static inline int msgb_tailroom(const struct msgb *msgb)
 107 {
 108         return (msgb->head + msgb->data_len) - msgb->tail;
 109 }
 110
 111 /* increase the headroom of an empty msgb, reducing the tailroom */
 112 static inline void msgb_reserve(struct msgb *msg, int len)
 113 {
 114         msg->data += len;
 115         msg->tail += len;
 116 }
 117
 118 static inline struct msgb *msgb_alloc_headroom(int size, int headroom,
 119                                                 const char *name)
 120 {
 121         struct msgb *msg = msgb_alloc(size, name);
 122         if (msg)
 123                 msgb_reserve(msg, headroom);
 124         return msg;
 125 }
 126
 127 #endif /* _MSGB_H */