buffer.h 19.5 KB
Newer Older
Bob Halley's avatar
Bob Halley committed
1
/*
David Lawrence's avatar
David Lawrence committed
2
 * Copyright (C) 1998-2000  Internet Software Consortium.
3
 *
Bob Halley's avatar
Bob Halley committed
4
5
6
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
7
 *
8
9
10
11
12
13
14
15
 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
 * DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
 * INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Bob Halley's avatar
Bob Halley committed
16
 */
Bob Halley's avatar
add  
Bob Halley committed
17

18
/* $Id: buffer.h,v 1.36 2000/08/17 02:09:12 bwelling Exp $ */
David Lawrence's avatar
David Lawrence committed
19

Bob Halley's avatar
add  
Bob Halley committed
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
#ifndef ISC_BUFFER_H
#define ISC_BUFFER_H 1

/*****
 ***** Module Info
 *****/

/*
 * Buffers
 *
 * A buffer is a region of memory, together with a set of related subregions.
 * Buffers are used for parsing and I/O operations.
 *
 * The 'used region' and the 'available' region are disjoint, and their
 * union is the buffer's region.  The used region extends from the beginning
 * of the buffer region to the last used byte.  The available region
 * extends from one byte greater than the last used byte to the end of the
 * buffer's region.  The size of the used region can be changed using various
 * buffer commands.  Initially, the used region is empty.
 *
 * The used region is further subdivided into two disjoint regions: the
 * 'consumed region' and the 'remaining region'.  The union of these two
 * regions is the used region.  The consumed region extends from the beginning
43
44
 * of the used region to the byte before the 'current' offset (if any).  The
 * 'remaining' region the current pointer to the end of the used
Bob Halley's avatar
add  
Bob Halley committed
45
46
47
 * region.  The size of the consumed region can be changed using various
 * buffer commands.  Initially, the consumed region is empty.
 *
Bob Halley's avatar
Bob Halley committed
48
49
50
51
52
53
 * The 'active region' is an (optional) subregion of the remaining region.
 * It extends from the current offset to an offset in the remaining region
 * that is selected with isc_buffer_setactive().  Initially, the active region
 * is empty.  If the current offset advances beyond the chosen offset, the
 * active region will also be empty.
 *
54
 *  /------------entire length---------------\
55
56
57
58
59
60
61
62
63
64
65
66
 *  /----- used region -----\/-- available --\
 *  +----------------------------------------+
 *  | consumed  | remaining |                |
 *  +----------------------------------------+
 *  a           b     c     d                e
 *
 * a == base of buffer.
 * b == current pointer.  Can be anywhere between a and d.
 * c == active pointer.  Meaningful between b and d.
 * d == used pointer.
 * e == length of buffer.
 *
David Lawrence's avatar
David Lawrence committed
67
 * a-e == entire length of buffer.
68
69
70
71
72
 * a-d == used region.
 * a-b == consumed region.
 * b-d == remaining region.
 * b-c == optional active region.
 *
Bob Halley's avatar
add  
Bob Halley committed
73
74
75
76
77
78
79
80
 * The following invariants are maintained by all routines:
 *
 *	length > 0
 *
 *	base is a valid pointer to length bytes of memory
 *
 *	0 <= used <= length
 *
81
 *	0 <= current <= used
Bob Halley's avatar
add  
Bob Halley committed
82
 *
Bob Halley's avatar
Bob Halley committed
83
 *	0 <= active <= used
84
 *	(although active < current implies empty active region)
Bob Halley's avatar
Bob Halley committed
85
 *
Bob Halley's avatar
add  
Bob Halley committed
86
87
88
89
90
91
92
93
 * MP:
 *	Buffers have no synchronization.  Clients must ensure exclusive
 *	access.
 *
 * Reliability:
 *	No anticipated impact.
 *
 * Resources:
94
 *	Memory: 1 pointer + 6 unsigned integers per buffer.
Bob Halley's avatar
add  
Bob Halley committed
95
96
97
98
99
100
101
102
103
104
105
106
 *
 * Security:
 *	No anticipated impact.
 *
 * Standards:
 *	None.
 */

/***
 *** Imports
 ***/

Bob Halley's avatar
Bob Halley committed
107
#include <isc/lang.h>
108
#include <isc/magic.h>
109
#include <isc/types.h>
Bob Halley's avatar
add  
Bob Halley committed
110

111
112
113
114
115
116
117
118
/*
 * To make many functions be inline macros (via #define) define this.
 * If it is undefined, a function will be used.
 */
#if 0
#define ISC_BUFFER_USEINLINE
#endif

Bob Halley's avatar
Bob Halley committed
119
120
ISC_LANG_BEGINDECLS

121
122
123
124
/***
 *** Magic numbers
 ***/
#define ISC_BUFFER_MAGIC		0x42756621U	/* Buf!. */
125
#define ISC_BUFFER_VALID(b)		ISC_MAGIC_VALID(b, ISC_BUFFER_MAGIC)
126

127
128
129
130
131
132
133
134
/*
 * The following macros MUST be used only on valid buffers.  It is the
 * caller's responsibility to ensure this by using the ISC_BUFFER_VALID
 * check above, or by calling another isc_buffer_*() function (rather than
 * another macro.)
 */

/*
135
 * Fundamental buffer elements.  (A through E in the introductory comment.)
136
 */
David Lawrence's avatar
David Lawrence committed
137
138
139
140
141
142
143
144
#define isc_buffer_base(b)    ((void *)(b)->base)			  /*a*/
#define isc_buffer_current(b) \
		((void *)((unsigned char *)(b)->base + (b)->current))     /*b*/
#define isc_buffer_active(b)  \
		((void *)((unsigned char *)(b)->base + (b)->active))      /*c*/
#define isc_buffer_used(b)    \
		((void *)((unsigned char *)(b)->base + (b)->used))        /*d*/
#define isc_buffer_length(b)  ((b)->length)				  /*e*/
145
146

/*
147
 * Derived lengths.  (Described in the introductory comment.)
148
 */
149
150
151
152
153
#define isc_buffer_usedlength(b)	((b)->used)		      /* d-a */
#define isc_buffer_consumedlength(b)	((b)->current)		      /* b-a */
#define isc_buffer_remaininglength(b)	((b)->used - (b)->current)    /* d-b */
#define isc_buffer_activelength(b)	((b)->active - (b)->current)  /* c-b */
#define isc_buffer_availablelength(b)	((b)->length - (b)->used)     /* e-d */
154

Bob Halley's avatar
add  
Bob Halley committed
155
156
157
158
159
160
/*
 * Note that the buffer structure is public.  This is principally so buffer
 * operations can be implemented using macros.  Applications are strongly
 * discouraged from directly manipulating the structure.
 */

161
162
163
struct isc_buffer {
	unsigned int		magic;
	void		       *base;
164
	/* The following integers are byte offsets from 'base'. */
165
166
167
168
169
170
171
172
173
174
	unsigned int		length;
	unsigned int		used;
	unsigned int 		current;
	unsigned int 		active;
	/* linkable */
	ISC_LINK(isc_buffer_t)	link;
	/* private internal elements */
	isc_mem_t	       *mctx;
};

Bob Halley's avatar
add  
Bob Halley committed
175
176
177
178
/***
 *** Functions
 ***/

179
isc_result_t
180
isc_buffer_allocate(isc_mem_t *mctx, isc_buffer_t **dynbuffer,
181
		    unsigned int length);
182
183
184
185
186
187
188
189
190
191
192
193
/*
 * Allocate a dynamic linkable buffer which has "length" bytes in the
 * data region.
 *
 * Requires:
 *	"mctx" is valid.
 *
 *	"dynbuffer" is non-NULL, and "*dynbuffer" is NULL.
 *
 * Returns:
 *	ISC_R_SUCCESS		- success
 *	ISC_R_NOMEMORY		- no memory available
194
195
196
 *
 * Note:
 *	Changing the buffer's length field is not permitted.
197
198
 */

199
void
200
isc_buffer_free(isc_buffer_t **dynbuffer);
201
202
203
204
205
206
207
208
209
210
/*
 * Release resources allocated for a dynamic buffer.
 *
 * Requires:
 *	"dynbuffer" is not NULL.
 *
 *	"*dynbuffer" is a valid dynamic buffer.
 *
 * Ensures:
 *	"*dynbuffer" will be NULL on return, and all memory associated with
211
212
 *	the dynamic buffer is returned to the memory context used in
 *	isc_buffer_allocate().
213
 */
Bob Halley's avatar
add  
Bob Halley committed
214
215

void
David Lawrence's avatar
David Lawrence committed
216
isc__buffer_init(isc_buffer_t *b, const void *base, unsigned int length);
Bob Halley's avatar
add  
Bob Halley committed
217
218
219
220
221
222
223
224
225
226
/*
 * Make 'b' refer to the 'length'-byte region starting at base.
 *
 * Requires:
 *
 *	'length' > 0
 *
 *	'base' is a pointer to a sequence of 'length' bytes.
 *
 */
227
228

void
229
isc__buffer_invalidate(isc_buffer_t *b);
230
231
232
233
234
235
236
237
238
239
/*
 * Make 'b' an invalid buffer.
 *
 * Requires:
 *	'b' is a valid buffer.
 *
 * Ensures:
 *	If assertion checking is enabled, future attempts to use 'b' without
 *	calling isc_buffer_init() on it will cause an assertion failure.
 */
240

Bob Halley's avatar
add  
Bob Halley committed
241
void
242
isc__buffer_region(isc_buffer_t *b, isc_region_t *r);
Bob Halley's avatar
add  
Bob Halley committed
243
244
245
246
247
248
249
250
251
252
253
/*
 * Make 'r' refer to the region of 'b'.
 *
 * Requires:
 *
 *	'b' is a valid buffer.
 *
 *	'r' points to a region structure.
 */

void
254
isc__buffer_usedregion(isc_buffer_t *b, isc_region_t *r);
Bob Halley's avatar
add  
Bob Halley committed
255
256
257
258
259
260
261
262
263
264
265
/*
 * Make 'r' refer to the used region of 'b'.
 *
 * Requires:
 *
 *	'b' is a valid buffer.
 *
 *	'r' points to a region structure.
 */

void
266
isc__buffer_availableregion(isc_buffer_t *b, isc_region_t *r);
Bob Halley's avatar
add  
Bob Halley committed
267
268
269
270
271
272
273
274
275
276
277
/*
 * Make 'r' refer to the available region of 'b'.
 *
 * Requires:
 *
 *	'b' is a valid buffer.
 *
 *	'r' points to a region structure.
 */

void
278
isc__buffer_add(isc_buffer_t *b, unsigned int n);
Bob Halley's avatar
add  
Bob Halley committed
279
280
281
282
283
284
285
286
287
288
289
290
/*
 * Increase the 'used' region of 'b' by 'n' bytes.
 *
 * Requires:
 *
 *	'b' is a valid buffer
 *
 *	used + n <= length
 *
 */

void
291
isc__buffer_subtract(isc_buffer_t *b, unsigned int n);
Bob Halley's avatar
add  
Bob Halley committed
292
293
294
295
296
297
298
299
300
301
302
303
/*
 * Decrease the 'used' region of 'b' by 'n' bytes.
 *
 * Requires:
 *
 *	'b' is a valid buffer
 *
 *	used >= n
 *
 */

void
304
isc__buffer_clear(isc_buffer_t *b);
Bob Halley's avatar
add  
Bob Halley committed
305
306
307
308
309
310
311
312
313
314
315
316
317
318
/*
 * Make the used region empty.
 *
 * Requires:
 *
 *	'b' is a valid buffer
 *
 * Ensures:
 *
 *	used = 0
 *
 */

void
319
isc__buffer_consumedregion(isc_buffer_t *b, isc_region_t *r);
Bob Halley's avatar
add  
Bob Halley committed
320
321
322
323
324
325
326
327
328
329
330
/*
 * Make 'r' refer to the consumed region of 'b'.
 *
 * Requires:
 *
 *	'b' is a valid buffer.
 *
 *	'r' points to a region structure.
 */

void
331
isc__buffer_remainingregion(isc_buffer_t *b, isc_region_t *r);
Bob Halley's avatar
add  
Bob Halley committed
332
333
334
335
336
337
338
339
340
341
/*
 * Make 'r' refer to the remaining region of 'b'.
 *
 * Requires:
 *
 *	'b' is a valid buffer.
 *
 *	'r' points to a region structure.
 */

Bob Halley's avatar
Bob Halley committed
342
void
343
isc__buffer_activeregion(isc_buffer_t *b, isc_region_t *r);
Bob Halley's avatar
Bob Halley committed
344
345
346
347
348
349
350
351
352
353
354
/*
 * Make 'r' refer to the active region of 'b'.
 *
 * Requires:
 *
 *	'b' is a valid buffer.
 *
 *	'r' points to a region structure.
 */

void
355
isc__buffer_setactive(isc_buffer_t *b, unsigned int n);
Bob Halley's avatar
Bob Halley committed
356
357
358
359
360
361
362
363
364
365
/*
 * Sets the end of the active region 'n' bytes after current.
 *
 * Requires:
 *
 *	'b' is a valid buffer.
 *
 *	current + n <= used
 */

Bob Halley's avatar
add  
Bob Halley committed
366
void
367
isc__buffer_first(isc_buffer_t *b);
Bob Halley's avatar
add  
Bob Halley committed
368
369
370
371
372
373
374
375
376
/*
 * Make the consumed region empty.
 *
 * Requires:
 *
 *	'b' is a valid buffer
 *
 * Ensures:
 *
377
 *	current == 0
Bob Halley's avatar
add  
Bob Halley committed
378
379
380
381
 *
 */

void
382
isc__buffer_forward(isc_buffer_t *b, unsigned int n);
Bob Halley's avatar
add  
Bob Halley committed
383
/*
384
 * Increase the 'consumed' region of 'b' by 'n' bytes.
Bob Halley's avatar
add  
Bob Halley committed
385
386
387
388
389
 *
 * Requires:
 *
 *	'b' is a valid buffer
 *
390
 *	current + n <= used
Bob Halley's avatar
add  
Bob Halley committed
391
392
393
394
 *
 */

void
395
isc__buffer_back(isc_buffer_t *b, unsigned int n);
Bob Halley's avatar
add  
Bob Halley committed
396
397
398
399
400
401
402
/*
 * Decrease the 'consumed' region of 'b' by 'n' bytes.
 *
 * Requires:
 *
 *	'b' is a valid buffer
 *
403
 *	n <= current
Bob Halley's avatar
add  
Bob Halley committed
404
405
406
407
 *
 */

void
Bob Halley's avatar
Bob Halley committed
408
isc_buffer_compact(isc_buffer_t *b);
Bob Halley's avatar
add  
Bob Halley committed
409
410
411
412
413
414
415
416
417
418
419
/*
 * Compact the used region by moving the remaining region so it occurs
 * at the start of the buffer.  The used region is shrunk by the size of
 * the consumed region, and the consumed region is then made empty.
 *
 * Requires:
 *
 *	'b' is a valid buffer
 *
 * Ensures:
 *
420
 *	current == 0
Bob Halley's avatar
add  
Bob Halley committed
421
422
423
424
425
426
 *
 *	The size of the used region is now equal to the size of the remaining
 *	region (as it was before the call).  The contents of the used region
 *	are those of the remaining region (as it was before the call).
 */

427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
isc_uint8_t
isc_buffer_getuint8(isc_buffer_t *b);
/*
 * Read an unsigned 8-bit integer from 'b' and return it.
 *
 * Requires:
 *
 *	'b' is a valid buffer.
 *
 *	The length of the available region of 'b' is at least 1.
 *
 * Ensures:
 *
 *	The current pointer in 'b' is advanced by 1.
 *
 * Returns:
 *
 *	A 8-bit unsigned integer.
 */

void
448
isc__buffer_putuint8(isc_buffer_t *b, isc_uint8_t val);
449
450
451
452
453
454
455
456
457
458
459
460
/*
 * Store an unsigned 8-bit integer from 'val' into 'b'.
 *
 * Requires:
 *	'b' is a valid buffer.
 *
 *	The length of the unused region of 'b' is at least 1.
 *
 * Ensures:
 *	The used pointer in 'b' is advanced by 1.
 */

Bob Halley's avatar
Bob Halley committed
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
isc_uint16_t
isc_buffer_getuint16(isc_buffer_t *b);
/*
 * Read an unsigned 16-bit integer in network byte order from 'b', convert
 * it to host byte order, and return it.
 *
 * Requires:
 *
 *	'b' is a valid buffer.
 *
 *	The length of the available region of 'b' is at least 2.
 *
 * Ensures:
 *
 *	The current pointer in 'b' is advanced by 2.
 *
 * Returns:
 *
 *	A 16-bit unsigned integer.
 */

482
void
483
isc__buffer_putuint16(isc_buffer_t *b, isc_uint16_t val);
484
485
486
487
488
489
490
491
492
493
494
495
496
/*
 * Store an unsigned 16-bit integer in host byte order from 'val'
 * into 'b' in network byte order.
 *
 * Requires:
 *	'b' is a valid buffer.
 *
 *	The length of the unused region of 'b' is at least 2.
 *
 * Ensures:
 *	The used pointer in 'b' is advanced by 2.
 */

Bob Halley's avatar
Bob Halley committed
497
498
499
500
501
502
503
504
505
506
isc_uint32_t
isc_buffer_getuint32(isc_buffer_t *b);
/*
 * Read an unsigned 32-bit integer in network byte order from 'b', convert
 * it to host byte order, and return it.
 *
 * Requires:
 *
 *	'b' is a valid buffer.
 *
Michael Graff's avatar
Michael Graff committed
507
 *	The length of the available region of 'b' is at least 4.
Bob Halley's avatar
Bob Halley committed
508
509
510
 *
 * Ensures:
 *
Michael Graff's avatar
Michael Graff committed
511
 *	The current pointer in 'b' is advanced by 4.
Bob Halley's avatar
Bob Halley committed
512
513
514
515
516
517
 *
 * Returns:
 *
 *	A 32-bit unsigned integer.
 */

518
void
519
isc__buffer_putuint32(isc_buffer_t *b, isc_uint32_t val);
520
521
522
523
524
525
526
527
528
529
530
531
532
/*
 * Store an unsigned 32-bit integer in host byte order from 'val'
 * into 'b' in network byte order.
 *
 * Requires:
 *	'b' is a valid buffer.
 *
 *	The length of the unused region of 'b' is at least 4.
 *
 * Ensures:
 *	The used pointer in 'b' is advanced by 4.
 */

Andreas Gustafsson's avatar
Andreas Gustafsson committed
533
void
David Lawrence's avatar
David Lawrence committed
534
535
isc__buffer_putmem(isc_buffer_t *b, const unsigned char *base,
		   unsigned int length);
Andreas Gustafsson's avatar
Andreas Gustafsson committed
536
537
538
539
540
541
542
543
/*
 * Copy 'length' bytes of memory at 'base' into 'b'.
 *
 * Requires:
 *	'b' is a valid buffer.
 *
 *	'base' points to 'length' bytes of valid memory.
 *
Mark Andrews's avatar
Mark Andrews committed
544
545
 */

546
void
David Lawrence's avatar
David Lawrence committed
547
isc__buffer_putstr(isc_buffer_t *b, const char *source);
Mark Andrews's avatar
Mark Andrews committed
548
/*
549
 * Copy 'source' into 'b', not including terminating NUL.
Mark Andrews's avatar
Mark Andrews committed
550
551
552
553
554
555
 *
 * Requires:
 *	'b' is a valid buffer.
 *
 *	'source' to be a valid NULL terminated string.
 *
556
 *	strlen(source) <= isc_buffer_available(b)
Andreas Gustafsson's avatar
Andreas Gustafsson committed
557
558
 */

Bob Halley's avatar
Bob Halley committed
559
isc_result_t
560
isc_buffer_copyregion(isc_buffer_t *b, const isc_region_t *r);
Bob Halley's avatar
Bob Halley committed
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
/*
 * Copy the contents of 'r' into 'b'.
 *
 * Requires:
 *	'b' is a valid buffer.
 *
 *	'r' is a valid region.
 *
 * Returns:
 *
 *	ISC_R_SUCCESS
 *	ISC_R_NOSPACE			The available region of 'b' is not
 *					big enough.
 */

David Lawrence's avatar
David Lawrence committed
576
577
ISC_LANG_ENDDECLS

578
579
580
581
582
583
584
/*
 * Inline macro versions of the functions.  These should never be called
 * directly by an application, but will be used by the functions within
 * buffer.c.  The callers should always use "isc_buffer_*()" names, never
 * ones beginning with "isc__"
 */

David Lawrence's avatar
David Lawrence committed
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
/*
 * XXXDCL Something more could be done with initializing buffers that
 * point to const data.  For example, a new function, isc_buffer_initconst,
 * could be used, and a new boolean flag in the buffer structure could
 * indicate whether the buffer was initialized with that function.
 * (isc_bufer_init itself would be reprototyped to *not* have its "base"
 * parameter be const.)  Then if the boolean were true, the isc_buffer_put*
 * functions could assert a contractual requirement for a non-const buffer.
 * One drawback is that the isc_buffer_* functions (macros) that return
 * pointers would still need to return non-const pointers to avoid compiler
 * warnings, so it would be up to code that uses them to have to deal
 * with the possibility that the buffer was initialized as const --
 * a problem that they *already* have to deal with but have absolutely
 * no ability to.  With a new isc_buffer_isconst() function returning
 * true/false, they could at least assert a contractual requirement for
 * non-const buffers when needed.
 */
602
#define ISC__BUFFER_INIT(_b, _base, _length) \
603
	do { \
David Lawrence's avatar
David Lawrence committed
604
605
606
607
608
609
		union { \
			const void *	konst; \
			void *		var; \
		} _u; \
		_u.konst = (_base); \
		(_b)->base = _u.var; \
610
611
612
613
614
		(_b)->length = (_length); \
		(_b)->used = 0; \
		(_b)->current = 0; \
		(_b)->active = 0; \
		(_b)->mctx = NULL; \
615
		ISC_LINK_INIT(b, link); \
David Lawrence's avatar
David Lawrence committed
616
		(_b)->magic = ISC_BUFFER_MAGIC; \
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
	} while (0)

#define ISC__BUFFER_INVALIDATE(_b) \
	do { \
		(_b)->magic = 0; \
		(_b)->base = NULL; \
		(_b)->length = 0; \
		(_b)->used = 0; \
		(_b)->current = 0; \
		(_b)->active = 0; \
	} while (0)

#define ISC__BUFFER_REGION(_b, _r) \
	do { \
		(_r)->base = (_b)->base; \
		(_r)->length = (_b)->length; \
	} while (0)

#define ISC__BUFFER_USEDREGION(_b, _r) \
	do { \
		(_r)->base = (_b)->base; \
		(_r)->length = (_b)->used; \
	} while (0)

#define ISC__BUFFER_AVAILABLEREGION(_b, _r) \
	do { \
David Lawrence's avatar
David Lawrence committed
643
644
		(_r)->base = isc_buffer_used(_b); \
		(_r)->length = isc_buffer_availablelength(_b); \
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
	} while (0)

#define ISC__BUFFER_ADD(_b, _n) \
	do { \
		(_b)->used += (_n); \
	} while (0)

#define ISC__BUFFER_SUBTRACT(_b, _n) \
	do { \
		(_b)->used -= (_n); \
		if ((_b)->current > (_b)->used) \
			(_b)->current = (_b)->used; \
		if ((_b)->active > (_b)->used) \
			(_b)->active = (_b)->used; \
	} while (0)

#define ISC__BUFFER_CLEAR(_b) \
	do { \
		(_b)->used = 0; \
		(_b)->current = 0; \
		(_b)->active = 0; \
	} while (0)

#define ISC__BUFFER_CONSUMEDREGION(_b, _r) \
	do { \
670
		(_r)->base = (_b)->base; \
671
672
673
674
675
		(_r)->length = (_b)->current; \
	} while (0)

#define ISC__BUFFER_REMAININGREGION(_b, _r) \
	do { \
David Lawrence's avatar
David Lawrence committed
676
677
		(_r)->base = isc_buffer_current(_b); \
		(_r)->length = isc_buffer_remaininglength(_b); \
678
679
680
681
682
	} while (0)

#define ISC__BUFFER_ACTIVEREGION(_b, _r) \
	do { \
		if ((_b)->current < (_b)->active) { \
David Lawrence's avatar
David Lawrence committed
683
684
			(_r)->base = isc_buffer_current(_b); \
			(_r)->length = isc_buffer_activelength(_b); \
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
		} else { \
			(_r)->base = NULL; \
			(_r)->length = 0; \
		} \
	} while (0)

#define ISC__BUFFER_SETACTIVE(_b, _n) \
	do { \
		(_b)->active = (_b)->current + (_n); \
	} while (0)

#define ISC__BUFFER_FIRST(_b) \
	do { \
		(_b)->current = 0; \
	} while (0)

#define ISC__BUFFER_FORWARD(_b, _n) \
	do { \
		(_b)->current += (_n); \
	} while (0)

#define ISC__BUFFER_BACK(_b, _n) \
	do { \
		(_b)->current -= (_n); \
	} while (0)

David Lawrence's avatar
David Lawrence committed
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
#define ISC__BUFFER_PUTMEM(_b, _base, _length) \
	do { \
		memcpy(isc_buffer_used(_b), (_base), (_length)); \
		(_b)->used += (_length); \
	} while (0)

#define ISC__BUFFER_PUTSTR(_b, _source) \
	do { \
		unsigned int _length; \
		unsigned char *_cp; \
		_length = strlen(_source); \
		_cp = isc_buffer_used(_b); \
		memcpy(_cp, (_source), _length); \
		(_b)->used += (_length); \
	} while (0)

727
728
729
#define ISC__BUFFER_PUTUINT8(_b, _val) \
	do { \
		unsigned char *_cp; \
730
		isc_uint8_t _val2 = (_val); \
David Lawrence's avatar
David Lawrence committed
731
		_cp = isc_buffer_used(_b); \
732
		(_b)->used++; \
733
		_cp[0] = (_val2 & 0x00ff); \
734
735
736
737
738
	} while (0)

#define ISC__BUFFER_PUTUINT16(_b, _val) \
	do { \
		unsigned char *_cp; \
739
		isc_uint16_t _val2 = (_val); \
David Lawrence's avatar
David Lawrence committed
740
		_cp = isc_buffer_used(_b); \
741
		(_b)->used += 2; \
742
743
		_cp[0] = (_val2 & 0xff00U) >> 8; \
		_cp[1] = (_val2 & 0x00ffU); \
744
745
746
747
748
	} while (0)

#define ISC__BUFFER_PUTUINT32(_b, _val) \
	do { \
		unsigned char *_cp; \
749
		isc_uint32_t _val2 = (_val); \
David Lawrence's avatar
David Lawrence committed
750
		_cp = isc_buffer_used(_b); \
751
		(_b)->used += 4; \
752
753
754
755
		_cp[0] = (_val2 & 0xff000000) >> 24; \
		_cp[1] = (_val2 & 0x00ff0000) >> 16; \
		_cp[2] = (_val2 & 0x0000ff00) >> 8; \
		_cp[3] = (_val2 & 0x000000ff); \
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
	} while (0)

#if defined(ISC_BUFFER_USEINLINE)
#define isc_buffer_init			ISC__BUFFER_INIT
#define isc_buffer_invalidate		ISC__BUFFER_INVALIDATE
#define isc_buffer_region		ISC__BUFFER_REGION
#define isc_buffer_usedregion		ISC__BUFFER_USEDREGION
#define isc_buffer_availableregion	ISC__BUFFER_AVAILABLEREGION
#define isc_buffer_add			ISC__BUFFER_ADD
#define isc_buffer_subtract		ISC__BUFFER_SUBTRACT
#define isc_buffer_clear		ISC__BUFFER_CLEAR
#define isc_buffer_consumedregion	ISC__BUFFER_CONSUMEDREGION
#define isc_buffer_remainingregion	ISC__BUFFER_REMAININGREGION
#define isc_buffer_activeregion		ISC__BUFFER_ACTIVEREGION
#define isc_buffer_setactive		ISC__BUFFER_SETACTIVE
#define isc_buffer_first		ISC__BUFFER_FIRST
#define isc_buffer_forward		ISC__BUFFER_FORWARD
#define isc_buffer_back			ISC__BUFFER_BACK
David Lawrence's avatar
David Lawrence committed
774
775
#define isc_buffer_putmem		ISC__BUFFER_PUTMEM
#define isc_buffer_putstr		ISC__BUFFER_PUTSTR
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
#define isc_buffer_putuint8		ISC__BUFFER_PUTUINT8
#define isc_buffer_putuint16		ISC__BUFFER_PUTUINT16
#define isc_buffer_putuint32		ISC__BUFFER_PUTUINT32
#else
#define isc_buffer_init			isc__buffer_init
#define isc_buffer_invalidate		isc__buffer_invalidate
#define isc_buffer_region		isc__buffer_region
#define isc_buffer_usedregion		isc__buffer_usedregion
#define isc_buffer_availableregion	isc__buffer_availableregion
#define isc_buffer_add			isc__buffer_add
#define isc_buffer_subtract		isc__buffer_subtract
#define isc_buffer_clear		isc__buffer_clear
#define isc_buffer_consumedregion	isc__buffer_consumedregion
#define isc_buffer_remainingregion	isc__buffer_remainingregion
#define isc_buffer_activeregion		isc__buffer_activeregion
#define isc_buffer_setactive		isc__buffer_setactive
#define isc_buffer_first		isc__buffer_first
#define isc_buffer_forward		isc__buffer_forward
#define isc_buffer_back			isc__buffer_back
David Lawrence's avatar
David Lawrence committed
795
796
#define isc_buffer_putmem		isc__buffer_putmem
#define isc_buffer_putstr		isc__buffer_putstr
797
798
799
800
#define isc_buffer_putuint8		isc__buffer_putuint8
#define isc_buffer_putuint16		isc__buffer_putuint16
#define isc_buffer_putuint32		isc__buffer_putuint32
#endif
Andreas Gustafsson's avatar
Andreas Gustafsson committed
801

Bob Halley's avatar
add  
Bob Halley committed
802
#endif /* ISC_BUFFER_H */