]>
git.proxmox.com Git - mirror_frr.git/blob - lib/stream.h
3 * Copyright (C) 1999 Kunihiro Ishiguro
5 * This file is part of GNU Zebra.
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
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.
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
22 #ifndef _ZEBRA_STREAM_H
23 #define _ZEBRA_STREAM_H
27 #include "frratomic.h"
32 * A stream is an arbitrary buffer, whose contents generally are assumed to
33 * be in network order.
35 * A stream has the following attributes associated with it:
37 * - size: the allocated, invariant size of the buffer.
39 * - getp: the get position marker, denoting the offset in the stream where
40 * the next read (or 'get') will be from. This getp marker is
41 * automatically adjusted when data is read from the stream, the
42 * user may also manipulate this offset as they wish, within limits
45 * - endp: the end position marker, denoting the offset in the stream where
46 * valid data ends, and if the user attempted to write (or
47 * 'put') data where that data would be written (or 'put') to.
49 * These attributes are all size_t values.
53 * 1. getp can never exceed endp
55 * - hence if getp is equal to endp, there is no more valid data that can be
56 * gotten from the stream (though, the user may reposition getp to earlier in
57 * the stream, if they wish).
59 * 2. endp can never exceed size
61 * - hence, if endp is equal to size, then the stream is full, and no more
62 * data can be written to the stream.
64 * In other words the following must always be true, and the stream
65 * abstraction is allowed internally to assert that the following property
66 * holds true for a stream, as and when it wishes:
68 * getp <= endp <= size
70 * It is the users responsibility to ensure this property is never violated.
72 * A stream therefore can be thought of like this:
74 * ---------------------------------------------------
75 * |XXXXXXXXXXXXXXXXXXXXXXXX |
76 * ---------------------------------------------------
80 * This shows a stream containing data (shown as 'X') up to the endp offset.
81 * The stream is empty from endp to size. Without adjusting getp, there are
82 * still endp-getp bytes of valid data to be read from the stream.
84 * Methods are provided to get and put to/from the stream, as well as
85 * retrieve the values of the 3 markers and manipulate the getp marker.
88 * At the moment, newly allocated streams are zero filled. Hence, one can
89 * use stream_forward_endp() to effectively create arbitrary zero-fill
90 * padding. However, note that stream_reset() does *not* zero-out the
91 * stream. This property should **not** be relied upon.
93 * Best practice is to use stream_put (<stream *>, NULL, <size>) to zero out
94 * any part of a stream which isn't otherwise written to.
101 /* Remainder is ***private*** to stream
102 * direct access is frowned upon!
103 * Use the appropriate functions/macros
105 size_t getp
; /* next get position */
106 size_t endp
; /* last valid data position */
107 size_t size
; /* size of data segment */
108 unsigned char *data
; /* data pointer */
111 /* First in first out queue structure. */
113 /* lock for mt-safe operations */
116 /* number of streams in this fifo */
117 _Atomic
size_t count
;
123 /* Utility macros. */
124 #define STREAM_SIZE(S) ((S)->size)
125 /* number of bytes which can still be written */
126 #define STREAM_WRITEABLE(S) ((S)->size - (S)->endp)
127 /* number of bytes still to be read */
128 #define STREAM_READABLE(S) ((S)->endp - (S)->getp)
130 #define STREAM_CONCAT_REMAIN(S1, S2, size) ((size) - (S1)->endp - (S2)->endp)
132 /* deprecated macros - do not use in new code */
133 #if defined(VERSION_TYPE_DEV) && CONFDATE > 20181128
134 CPP_NOTICE("lib: time to remove deprecated stream.h macros")
136 #define STREAM_PNT(S) stream_pnt((S))
137 #define STREAM_REMAIN(S) STREAM_WRITEABLE((S))
139 /* this macro is deprecated, but not slated for removal anytime soon */
140 #define STREAM_DATA(S) ((S)->data)
142 /* Stream prototypes.
143 * For stream_{put,get}S, the S suffix mean:
145 * c: character (unsigned byte)
146 * w: word (two bytes)
147 * l: long (two words)
148 * q: quad (four words)
150 extern struct stream
*stream_new(size_t);
151 extern void stream_free(struct stream
*);
152 extern struct stream
*stream_copy(struct stream
*, struct stream
*src
);
153 extern struct stream
*stream_dup(struct stream
*);
154 extern size_t stream_resize(struct stream
*, size_t);
155 extern size_t stream_get_getp(struct stream
*);
156 extern size_t stream_get_endp(struct stream
*);
157 extern size_t stream_get_size(struct stream
*);
158 extern uint8_t *stream_get_data(struct stream
*);
161 * Create a new stream structure; copy offset bytes from s1 to the new
162 * stream; copy s2 data to the new stream; copy rest of s1 data to the
165 extern struct stream
*stream_dupcat(struct stream
*s1
, struct stream
*s2
,
168 extern void stream_set_getp(struct stream
*, size_t);
169 extern void stream_set_endp(struct stream
*, size_t);
170 extern void stream_forward_getp(struct stream
*, size_t);
171 extern void stream_forward_endp(struct stream
*, size_t);
173 /* steam_put: NULL source zeroes out size_t bytes of stream */
174 extern void stream_put(struct stream
*, const void *, size_t);
175 extern int stream_putc(struct stream
*, uint8_t);
176 extern int stream_putc_at(struct stream
*, size_t, uint8_t);
177 extern int stream_putw(struct stream
*, uint16_t);
178 extern int stream_putw_at(struct stream
*, size_t, uint16_t);
179 extern int stream_put3(struct stream
*, uint32_t);
180 extern int stream_put3_at(struct stream
*, size_t, uint32_t);
181 extern int stream_putl(struct stream
*, uint32_t);
182 extern int stream_putl_at(struct stream
*, size_t, uint32_t);
183 extern int stream_putq(struct stream
*, uint64_t);
184 extern int stream_putq_at(struct stream
*, size_t, uint64_t);
185 extern int stream_put_ipv4(struct stream
*, uint32_t);
186 extern int stream_put_in_addr(struct stream
*, struct in_addr
*);
187 extern int stream_put_in_addr_at(struct stream
*, size_t, struct in_addr
*);
188 extern int stream_put_in6_addr_at(struct stream
*, size_t, struct in6_addr
*);
189 extern int stream_put_prefix_addpath(struct stream
*, struct prefix
*,
191 uint32_t addpath_tx_id
);
192 extern int stream_put_prefix(struct stream
*, struct prefix
*);
193 extern int stream_put_labeled_prefix(struct stream
*, struct prefix
*,
195 extern void stream_get(void *, struct stream
*, size_t);
196 extern bool stream_get2(void *data
, struct stream
*s
, size_t size
);
197 extern void stream_get_from(void *, struct stream
*, size_t, size_t);
198 extern uint8_t stream_getc(struct stream
*);
199 extern bool stream_getc2(struct stream
*s
, uint8_t *byte
);
200 extern uint8_t stream_getc_from(struct stream
*, size_t);
201 extern uint16_t stream_getw(struct stream
*);
202 extern bool stream_getw2(struct stream
*s
, uint16_t *word
);
203 extern uint16_t stream_getw_from(struct stream
*, size_t);
204 extern uint32_t stream_get3(struct stream
*);
205 extern uint32_t stream_get3_from(struct stream
*, size_t);
206 extern uint32_t stream_getl(struct stream
*);
207 extern bool stream_getl2(struct stream
*s
, uint32_t *l
);
208 extern uint32_t stream_getl_from(struct stream
*, size_t);
209 extern uint64_t stream_getq(struct stream
*);
210 extern uint64_t stream_getq_from(struct stream
*, size_t);
211 extern uint32_t stream_get_ipv4(struct stream
*);
213 /* IEEE-754 floats */
214 extern float stream_getf(struct stream
*);
215 extern double stream_getd(struct stream
*);
216 extern int stream_putf(struct stream
*, float);
217 extern int stream_putd(struct stream
*, double);
222 /* Deprecated: assumes blocking I/O. Will be removed.
223 Use stream_read_try instead. */
224 extern int stream_read(struct stream
*, int, size_t);
226 /* Read up to size bytes into the stream.
228 >0: number of bytes read
231 -2: transient error, should retry later (i.e. EAGAIN or EINTR)
232 This is suitable for use with non-blocking file descriptors.
234 extern ssize_t
stream_read_try(struct stream
*s
, int fd
, size_t size
);
236 extern ssize_t
stream_recvmsg(struct stream
*s
, int fd
, struct msghdr
*,
237 int flags
, size_t size
);
238 extern ssize_t
stream_recvfrom(struct stream
*s
, int fd
, size_t len
, int flags
,
239 struct sockaddr
*from
, socklen_t
*fromlen
);
240 extern size_t stream_write(struct stream
*, const void *, size_t);
242 /* reset the stream. See Note above */
243 extern void stream_reset(struct stream
*);
244 extern int stream_flush(struct stream
*, int);
245 extern int stream_empty(struct stream
*); /* is the stream empty? */
248 extern uint8_t *stream_pnt(struct stream
*);
251 * Operations on struct stream_fifo.
253 * Each function has a safe variant, which ensures that the operation performed
254 * is atomic with respect to the operations performed by all other safe
255 * variants. In other words, the safe variants lock the stream_fifo's mutex
256 * before performing their action. These are provided for convenience when
257 * using stream_fifo in a multithreaded context, to alleviate the need for the
258 * caller to implement their own synchronization around the stream_fifo.
260 * The following functions do not have safe variants. The caller must ensure
261 * that these operations are performed safely in a multithreaded context:
267 * Create a new stream_fifo.
270 * newly created stream_fifo
272 extern struct stream_fifo
*stream_fifo_new(void);
275 * Push a stream onto a stream_fifo.
278 * the stream_fifo to push onto
281 * the stream to push onto the stream_fifo
283 extern void stream_fifo_push(struct stream_fifo
*fifo
, struct stream
*s
);
284 extern void stream_fifo_push_safe(struct stream_fifo
*fifo
, struct stream
*s
);
287 * Pop a stream off a stream_fifo.
290 * the stream_fifo to pop from
293 * the next stream in the stream_fifo
295 extern struct stream
*stream_fifo_pop(struct stream_fifo
*fifo
);
296 extern struct stream
*stream_fifo_pop_safe(struct stream_fifo
*fifo
);
299 * Retrieve the next stream from a stream_fifo without popping it.
302 * the stream_fifo to operate on
305 * the next stream that would be returned from stream_fifo_pop
307 extern struct stream
*stream_fifo_head(struct stream_fifo
*fifo
);
308 extern struct stream
*stream_fifo_head_safe(struct stream_fifo
*fifo
);
311 * Remove all streams from a stream_fifo.
314 * the stream_fifo to clean
316 extern void stream_fifo_clean(struct stream_fifo
*fifo
);
317 extern void stream_fifo_clean_safe(struct stream_fifo
*fifo
);
320 * Retrieve number of streams on a stream_fifo.
323 * the stream_fifo to retrieve the count for
326 * the number of streams on the stream_fifo
328 extern size_t stream_fifo_count_safe(struct stream_fifo
*fifo
);
331 * Free a stream_fifo.
333 * Calls stream_fifo_clean, then deinitializes the stream_fifo and frees it.
336 * the stream_fifo to free
338 extern void stream_fifo_free(struct stream_fifo
*fifo
);
340 /* This is here because "<< 24" is particularly problematic in C.
341 * This is because the left operand of << is integer-promoted, which means
342 * an uint8_t gets converted into a *signed* int. Shifting into the sign
343 * bit of a signed int is theoretically undefined behaviour, so - the left
344 * operand needs to be cast to unsigned.
346 * This is not a problem for 16- or 8-bit values (they don't reach the sign
347 * bit), for 64-bit values (you need to cast them anyway), and neither for
348 * encoding (because it's downcasted.)
350 static inline uint8_t *ptr_get_be32(uint8_t *ptr
, uint32_t *out
)
353 memcpy(&tmp
, ptr
, sizeof(tmp
));
359 * so Normal stream_getX functions assert. Which is anathema
360 * to keeping a daemon up and running when something goes south
361 * Provide a stream_getX2 functions that do not assert.
362 * In addition provide these macro's that upon failure
363 * goto stream_failure. This is modeled upon some NL_XX
364 * macros in the linux kernel.
366 * This change allows for proper memory freeing
367 * after we've detected an error.
369 * In the future we will be removing the assert in
370 * the stream functions but we need a transition
373 #define STREAM_GETC(S, P) \
376 if (!stream_getc2((S), &_pval)) \
377 goto stream_failure; \
381 #define STREAM_GETW(S, P) \
384 if (!stream_getw2((S), &_pval)) \
385 goto stream_failure; \
389 #define STREAM_GETL(S, P) \
392 if (!stream_getl2((S), &_pval)) \
393 goto stream_failure; \
397 #define STREAM_GET(P, STR, SIZE) \
399 if (!stream_get2((P), (STR), (SIZE))) \
400 goto stream_failure; \
403 #endif /* _ZEBRA_STREAM_H */