lib/stream.h

   1 /*
   2  * Packet interface
   3  * Copyright (C) 1999 Kunihiro Ishiguro
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   7  * GNU Zebra is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2, or (at your option) any
  10  * later version.
  11  *
  12  * GNU Zebra is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * 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; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef _ZEBRA_STREAM_H
  23 #define _ZEBRA_STREAM_H
  24
  25 #include <pthread.h>
  26
  27 #include "frratomic.h"
  28 #include "mpls.h"
  29 #include "prefix.h"
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 /*
  36  * A stream is an arbitrary buffer, whose contents generally are assumed to
  37  * be in network order.
  38  *
  39  * A stream has the following attributes associated with it:
  40  *
  41  * - size: the allocated, invariant size of the buffer.
  42  *
  43  * - getp: the get position marker, denoting the offset in the stream where
  44  *         the next read (or 'get') will be from. This getp marker is
  45  *         automatically adjusted when data is read from the stream, the
  46  *         user may also manipulate this offset as they wish, within limits
  47  *         (see below)
  48  *
  49  * - endp: the end position marker, denoting the offset in the stream where
  50  *         valid data ends, and if the user attempted to write (or
  51  *         'put') data where that data would be written (or 'put') to.
  52  *
  53  * These attributes are all size_t values.
  54  *
  55  * Constraints:
  56  *
  57  * 1. getp can never exceed endp
  58  *
  59  * - hence if getp is equal to endp, there is no more valid data that can be
  60  *   gotten from the stream (though, the user may reposition getp to earlier in
  61  *   the stream, if they wish).
  62  *
  63  * 2. endp can never exceed size
  64  *
  65  * - hence, if endp is equal to size, then the stream is full, and no more
  66  *   data can be written to the stream.
  67  *
  68  * In other words the following must always be true, and the stream
  69  * abstraction is allowed internally to assert that the following property
  70  * holds true for a stream, as and when it wishes:
  71  *
  72  *        getp <= endp <= size
  73  *
  74  * It is the users responsibility to ensure this property is never violated.
  75  *
  76  * A stream therefore can be thought of like this:
  77  *
  78  *      ---------------------------------------------------
  79  *      |XXXXXXXXXXXXXXXXXXXXXXXX                         |
  80  *      ---------------------------------------------------
  81  *               ^               ^                        ^
  82  *               getp            endp                     size
  83  *
  84  * This shows a stream containing data (shown as 'X') up to the endp offset.
  85  * The stream is empty from endp to size. Without adjusting getp, there are
  86  * still endp-getp bytes of valid data to be read from the stream.
  87  *
  88  * Methods are provided to get and put to/from the stream, as well as
  89  * retrieve the values of the 3 markers and manipulate the getp marker.
  90  *
  91  * Note:
  92  * At the moment, newly allocated streams are zero filled. Hence, one can
  93  * use stream_forward_endp() to effectively create arbitrary zero-fill
  94  * padding. However, note that stream_reset() does *not* zero-out the
  95  * stream. This property should **not** be relied upon.
  96  *
  97  * Best practice is to use stream_put (<stream *>, NULL, <size>) to zero out
  98  * any part of a stream which isn't otherwise written to.
  99  */
 100
 101 /* Stream buffer. */
 102 struct stream {
 103         struct stream *next;
 104
 105         /*
 106          * Remainder is ***private*** to stream
 107          * direct access is frowned upon!
 108          * Use the appropriate functions/macros
 109          */
 110         size_t getp;           /* next get position */
 111         size_t endp;           /* last valid data position */
 112         size_t size;           /* size of data segment */
 113         unsigned char data[];  /* data pointer */
 114 };
 115
 116 /* First in first out queue structure. */
 117 struct stream_fifo {
 118         /* lock for mt-safe operations */
 119         pthread_mutex_t mtx;
 120
 121         /* number of streams in this fifo */
 122         atomic_size_t count;
 123 #if defined DEV_BUILD
 124         atomic_size_t max_count;
 125 #endif
 126
 127         struct stream *head;
 128         struct stream *tail;
 129 };
 130
 131 /* Utility macros. */
 132 #define STREAM_SIZE(S)  ((S)->size)
 133 /* number of bytes which can still be written */
 134 #define STREAM_WRITEABLE(S) ((S)->size - (S)->endp)
 135 /* number of bytes still to be read */
 136 #define STREAM_READABLE(S) ((S)->endp - (S)->getp)
 137
 138 #define STREAM_CONCAT_REMAIN(S1, S2, size) ((size) - (S1)->endp - (S2)->endp)
 139
 140 /* this macro is deprecated, but not slated for removal anytime soon */
 141 #define STREAM_DATA(S)  ((S)->data)
 142
 143 /* Stream prototypes.
 144  * For stream_{put,get}S, the S suffix mean:
 145  *
 146  * c: character (unsigned byte)
 147  * w: word (two bytes)
 148  * l: long (two words)
 149  * q: quad (four words)
 150  */
 151 extern struct stream *stream_new(size_t);
 152 extern void stream_free(struct stream *);
 153 /* Copy 'src' into 'dest', returns 'dest' */
 154 extern struct stream *stream_copy(struct stream *dest,
 155                                   const struct stream *src);
 156 extern struct stream *stream_dup(const struct stream *s);
 157
 158 extern size_t stream_resize_inplace(struct stream **sptr, size_t newsize);
 159
 160 extern size_t stream_get_getp(const struct stream *s);
 161 extern size_t stream_get_endp(const struct stream *s);
 162 extern size_t stream_get_size(const struct stream *s);
 163 extern uint8_t *stream_get_data(struct stream *s);
 164
 165 /**
 166  * Create a new stream structure; copy offset bytes from s1 to the new
 167  * stream; copy s2 data to the new stream; copy rest of s1 data to the
 168  * new stream.
 169  */
 170 extern struct stream *stream_dupcat(const struct stream *s1,
 171                                     const struct stream *s2, size_t offset);
 172
 173 extern void stream_set_getp(struct stream *, size_t);
 174 extern void stream_set_endp(struct stream *, size_t);
 175 extern void stream_forward_getp(struct stream *, size_t);
 176 extern void stream_forward_endp(struct stream *, size_t);
 177
 178 /* steam_put: NULL source zeroes out size_t bytes of stream */
 179 extern void stream_put(struct stream *, const void *, size_t);
 180 extern int stream_putc(struct stream *, uint8_t);
 181 extern int stream_putc_at(struct stream *, size_t, uint8_t);
 182 extern int stream_putw(struct stream *, uint16_t);
 183 extern int stream_putw_at(struct stream *, size_t, uint16_t);
 184 extern int stream_put3(struct stream *, uint32_t);
 185 extern int stream_put3_at(struct stream *, size_t, uint32_t);
 186 extern int stream_putl(struct stream *, uint32_t);
 187 extern int stream_putl_at(struct stream *, size_t, uint32_t);
 188 extern int stream_putq(struct stream *, uint64_t);
 189 extern int stream_putq_at(struct stream *, size_t, uint64_t);
 190 extern int stream_put_ipv4(struct stream *, uint32_t);
 191 extern int stream_put_in_addr(struct stream *s, const struct in_addr *addr);
 192 extern int stream_put_in_addr_at(struct stream *s, size_t putp,
 193                                  const struct in_addr *addr);
 194 extern int stream_put_in6_addr_at(struct stream *s, size_t putp,
 195                                   const struct in6_addr *addr);
 196 extern int stream_put_prefix_addpath(struct stream *s,
 197                                      const struct prefix *p,
 198                                      int addpath_encode,
 199                                      uint32_t addpath_tx_id);
 200 extern int stream_put_prefix(struct stream *s, const struct prefix *p);
 201 extern int stream_put_labeled_prefix(struct stream *, const struct prefix *,
 202                                      mpls_label_t *, int addpath_encode,
 203                                      uint32_t addpath_tx_id);
 204 extern void stream_get(void *, struct stream *, size_t);
 205 extern bool stream_get2(void *data, struct stream *s, size_t size);
 206 extern void stream_get_from(void *, struct stream *, size_t, size_t);
 207 extern uint8_t stream_getc(struct stream *);
 208 extern bool stream_getc2(struct stream *s, uint8_t *byte);
 209 extern uint8_t stream_getc_from(struct stream *, size_t);
 210 extern uint16_t stream_getw(struct stream *);
 211 extern bool stream_getw2(struct stream *s, uint16_t *word);
 212 extern uint16_t stream_getw_from(struct stream *, size_t);
 213 extern uint32_t stream_get3(struct stream *);
 214 extern uint32_t stream_get3_from(struct stream *, size_t);
 215 extern uint32_t stream_getl(struct stream *);
 216 extern bool stream_getl2(struct stream *s, uint32_t *l);
 217 extern uint32_t stream_getl_from(struct stream *, size_t);
 218 extern uint64_t stream_getq(struct stream *);
 219 extern uint64_t stream_getq_from(struct stream *, size_t);
 220 bool stream_getq2(struct stream *s, uint64_t *q);
 221 extern uint32_t stream_get_ipv4(struct stream *);
 222
 223 /* IEEE-754 floats */
 224 extern float stream_getf(struct stream *);
 225 extern double stream_getd(struct stream *);
 226 extern int stream_putf(struct stream *, float);
 227 extern int stream_putd(struct stream *, double);
 228
 229 #undef stream_read
 230 #undef stream_write
 231
 232 /* Deprecated: assumes blocking I/O.  Will be removed.
 233    Use stream_read_try instead.  */
 234 extern int stream_read(struct stream *, int, size_t);
 235
 236 /* Read up to size bytes into the stream.
 237    Return code:
 238      >0: number of bytes read
 239      0: end-of-file
 240      -1: fatal error
 241      -2: transient error, should retry later (i.e. EAGAIN or EINTR)
 242    This is suitable for use with non-blocking file descriptors.
 243  */
 244 extern ssize_t stream_read_try(struct stream *s, int fd, size_t size);
 245
 246 extern ssize_t stream_recvmsg(struct stream *s, int fd, struct msghdr *,
 247                               int flags, size_t size);
 248 extern ssize_t stream_recvfrom(struct stream *s, int fd, size_t len, int flags,
 249                                struct sockaddr *from, socklen_t *fromlen);
 250 extern size_t stream_write(struct stream *, const void *, size_t);
 251
 252 /* reset the stream. See Note above */
 253 extern void stream_reset(struct stream *);
 254 extern int stream_flush(struct stream *, int);
 255 extern int stream_empty(struct stream *); /* is the stream empty? */
 256
 257 /* debugging */
 258 extern void stream_hexdump(const struct stream *s);
 259
 260 /* deprecated */
 261 extern uint8_t *stream_pnt(struct stream *);
 262
 263 /*
 264  * Operations on struct stream_fifo.
 265  *
 266  * Each function has a safe variant, which ensures that the operation performed
 267  * is atomic with respect to the operations performed by all other safe
 268  * variants. In other words, the safe variants lock the stream_fifo's mutex
 269  * before performing their action. These are provided for convenience when
 270  * using stream_fifo in a multithreaded context, to alleviate the need for the
 271  * caller to implement their own synchronization around the stream_fifo.
 272  *
 273  * The following functions do not have safe variants. The caller must ensure
 274  * that these operations are performed safely in a multithreaded context:
 275  * - stream_fifo_new
 276  * - stream_fifo_free
 277  */
 278
 279 /*
 280  * Create a new stream_fifo.
 281  *
 282  * Returns:
 283  *    newly created stream_fifo
 284  */
 285 extern struct stream_fifo *stream_fifo_new(void);
 286
 287 /*
 288  * Init or re-init an on-stack fifo. This allows use of a fifo struct without
 289  * requiring a malloc/free cycle.
 290  * Note well that the fifo must be de-inited with the 'fifo_deinit' api.
 291  */
 292 void stream_fifo_init(struct stream_fifo *fifo);
 293
 294 /*
 295  * Deinit an on-stack fifo.
 296  */
 297 void stream_fifo_deinit(struct stream_fifo *fifo);
 298
 299 /*
 300  * Push a stream onto a stream_fifo.
 301  *
 302  * fifo
 303  *    the stream_fifo to push onto
 304  *
 305  * s
 306  *    the stream to push onto the stream_fifo
 307  */
 308 extern void stream_fifo_push(struct stream_fifo *fifo, struct stream *s);
 309 extern void stream_fifo_push_safe(struct stream_fifo *fifo, struct stream *s);
 310
 311 /*
 312  * Pop a stream off a stream_fifo.
 313  *
 314  * fifo
 315  *    the stream_fifo to pop from
 316  *
 317  * Returns:
 318  *    the next stream in the stream_fifo
 319  */
 320 extern struct stream *stream_fifo_pop(struct stream_fifo *fifo);
 321 extern struct stream *stream_fifo_pop_safe(struct stream_fifo *fifo);
 322
 323 /*
 324  * Retrieve the next stream from a stream_fifo without popping it.
 325  *
 326  * fifo
 327  *    the stream_fifo to operate on
 328  *
 329  * Returns:
 330  *    the next stream that would be returned from stream_fifo_pop
 331  */
 332 extern struct stream *stream_fifo_head(struct stream_fifo *fifo);
 333 extern struct stream *stream_fifo_head_safe(struct stream_fifo *fifo);
 334
 335 /*
 336  * Remove all streams from a stream_fifo.
 337  *
 338  * fifo
 339  *    the stream_fifo to clean
 340  */
 341 extern void stream_fifo_clean(struct stream_fifo *fifo);
 342 extern void stream_fifo_clean_safe(struct stream_fifo *fifo);
 343
 344 /*
 345  * Retrieve number of streams on a stream_fifo.
 346  *
 347  * fifo
 348  *    the stream_fifo to retrieve the count for
 349  *
 350  * Returns:
 351  *    the number of streams on the stream_fifo
 352  */
 353 extern size_t stream_fifo_count_safe(struct stream_fifo *fifo);
 354
 355 /*
 356  * Free a stream_fifo.
 357  *
 358  * Calls stream_fifo_clean, then deinitializes the stream_fifo and frees it.
 359  *
 360  * fifo
 361  *    the stream_fifo to free
 362  */
 363 extern void stream_fifo_free(struct stream_fifo *fifo);
 364
 365 /* This is here because "<< 24" is particularly problematic in C.
 366  * This is because the left operand of << is integer-promoted, which means
 367  * an uint8_t gets converted into a *signed* int.  Shifting into the sign
 368  * bit of a signed int is theoretically undefined behaviour, so - the left
 369  * operand needs to be cast to unsigned.
 370  *
 371  * This is not a problem for 16- or 8-bit values (they don't reach the sign
 372  * bit), for 64-bit values (you need to cast them anyway), and neither for
 373  * encoding (because it's downcasted.)
 374  */
 375 static inline const uint8_t *ptr_get_be32(const uint8_t *ptr, uint32_t *out)
 376 {
 377         uint32_t tmp;
 378
 379         memcpy(&tmp, ptr, sizeof(tmp));
 380         *out = ntohl(tmp);
 381         return ptr + 4;
 382 }
 383
 384 /*
 385  * so Normal stream_getX functions assert.  Which is anathema
 386  * to keeping a daemon up and running when something goes south
 387  * Provide a stream_getX2 functions that do not assert.
 388  * In addition provide these macro's that upon failure
 389  * goto stream_failure.  This is modeled upon some NL_XX
 390  * macros in the linux kernel.
 391  *
 392  * This change allows for proper memory freeing
 393  * after we've detected an error.
 394  *
 395  * In the future we will be removing the assert in
 396  * the stream functions but we need a transition
 397  * plan.
 398  */
 399 #define STREAM_GETC(S, P)                                                      \
 400         do {                                                                   \
 401                 uint8_t _pval;                                                 \
 402                 if (!stream_getc2((S), &_pval))                                \
 403                         goto stream_failure;                                   \
 404                 (P) = _pval;                                                   \
 405         } while (0)
 406
 407 #define STREAM_GETW(S, P)                                                      \
 408         do {                                                                   \
 409                 uint16_t _pval;                                                \
 410                 if (!stream_getw2((S), &_pval))                                \
 411                         goto stream_failure;                                   \
 412                 (P) = _pval;                                                   \
 413         } while (0)
 414
 415 #define STREAM_GETL(S, P)                                                      \
 416         do {                                                                   \
 417                 uint32_t _pval;                                                \
 418                 if (!stream_getl2((S), &_pval))                                \
 419                         goto stream_failure;                                   \
 420                 (P) = _pval;                                                   \
 421         } while (0)
 422
 423 #define STREAM_GETF(S, P)                                                      \
 424         do {                                                                   \
 425                 union {                                                        \
 426                         float r;                                               \
 427                         uint32_t d;                                            \
 428                 } _pval;                                                       \
 429                 if (stream_getl2((S), &_pval.d))                               \
 430                         goto stream_failure;                                   \
 431                 (P) = _pval.r;                                                 \
 432         } while (0)
 433
 434 #define STREAM_GETQ(S, P)                                                      \
 435         do {                                                                   \
 436                 uint64_t _pval;                                                \
 437                 if (!stream_getq2((S), &_pval))                                \
 438                         goto stream_failure;                                   \
 439                 (P) = _pval;                                                   \
 440         } while (0)
 441
 442 #define STREAM_GET(P, STR, SIZE)                                               \
 443         do {                                                                   \
 444                 if (!stream_get2((P), (STR), (SIZE)))                          \
 445                         goto stream_failure;                                   \
 446         } while (0)
 447
 448 #ifdef __cplusplus
 449 }
 450 #endif
 451
 452 #endif /* _ZEBRA_STREAM_H */