3 * $Id: buf.c,v 1.1 2003/10/11 21:02:33 mdw Exp $
7 * (c) 2001 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
14 * Catacomb is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * Catacomb is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with Catacomb; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.1 2003/10/11 21:02:33 mdw
34 * Import buf stuff from tripe.
36 * Revision 1.4 2001/06/19 22:09:54 mdw
37 * Expose interface, for use in the proxy.
39 * Revision 1.3 2001/03/03 12:06:48 mdw
40 * Use 16-bit lengths on MPs, since there's a packet limit of 64K anyway.
42 * Revision 1.2 2001/02/16 21:23:20 mdw
43 * Various minor changes. Check that MPs are in canonical form when
46 * Revision 1.1 2001/02/03 20:26:37 mdw
51 /*----- Header files ------------------------------------------------------*/
55 #include <catacomb/mp.h>
59 /*----- Main code ---------------------------------------------------------*/
61 /* --- @buf_init@ --- *
63 * Arguments: @buf *b@ = pointer to a buffer block
64 * @void *p@ = pointer to a buffer
65 * @size_t sz@ = size of the buffer
69 * Use: Initializes the buffer block appropriately.
72 void buf_init(buf
*b
, void *p
, size_t sz
)
79 /* --- @buf_break@ --- *
81 * Arguments: @buf *b@ = pointer to a buffer block
83 * Returns: Some negative value.
85 * Use: Marks a buffer as broken.
88 int buf_break(buf
*b
) { b
->f
|= BF_BROKEN
; return (-1); }
90 /* --- @buf_flip@ --- *
92 * Arguments: @buf *b@ = pointer to a buffer block
96 * Use: Flips a buffer so that if you've just been writing to it,
97 * you can now read from the bit you've written.
100 void buf_flip(buf
*b
)
106 /* --- @buf_ensure@ --- *
108 * Arguments: @buf *b@ = pointer to a buffer block
109 * @size_t sz@ = size of data wanted
111 * Returns: Zero if it worked, nonzero if there wasn't enough space.
113 * Use: Ensures that there are @sz@ bytes still in the buffer.
116 int buf_ensure(buf
*b
, size_t sz
) { return (BENSURE(b
, sz
)); }
118 /* --- @buf_get@ --- *
120 * Arguments: @buf *b@ = pointer to a buffer block
121 * @size_t sz@ = size of the buffer
123 * Returns: Pointer to the place in the buffer.
125 * Use: Reserves a space in the buffer of the requested size, and
126 * returns its start address.
129 void *buf_get(buf
*b
, size_t sz
)
139 /* --- @buf_put@ --- *
141 * Arguments: @buf *b@ = pointer to a buffer block
142 * @const void *p@ = pointer to a buffer
143 * @size_t sz@ = size of the buffer
145 * Returns: Zero if it worked, nonzero if there wasn't enough space.
147 * Use: Fetches data from some place and puts it in the buffer
150 int buf_put(buf
*b
, const void *p
, size_t sz
)
154 memcpy(BCUR(b
), p
, sz
);
159 /* --- @buf_getbyte@ --- *
161 * Arguments: @buf *b@ = pointer to a buffer block
163 * Returns: A byte, or less than zero if there wasn't a byte there.
165 * Use: Gets a single byte from a buffer.
168 int buf_getbyte(buf
*b
)
175 /* --- @buf_putbyte@ --- *
177 * Arguments: @buf *b@ = pointer to a buffer block
178 * @int ch@ = byte to write
180 * Returns: Zero if OK, nonzero if there wasn't enough space.
182 * Use: Puts a single byte in a buffer.
185 int buf_putbyte(buf
*b
, int ch
)
193 /* --- @buf_getu16@ --- *
195 * Arguments: @buf *b@ = pointer to a buffer block
196 * @uint16 *w@ = where to put the word
198 * Returns: Zero if OK, or nonzero if there wasn't a word there.
200 * Use: Gets a 16-bit word from a buffer.
203 int buf_getu16(buf
*b
, uint16
*w
)
212 /* --- @buf_putu16@ --- *
214 * Arguments: @buf *b@ = pointer to a buffer block
215 * @uint16 w@ = word to write
217 * Returns: Zero if OK, nonzero if there wasn't enough space.
219 * Use: Puts a 16-but word in a buffer.
222 int buf_putu16(buf
*b
, uint16 w
)
231 /* --- @buf_getu32@ --- *
233 * Arguments: @buf *b@ = pointer to a buffer block
234 * @uint32 *w@ = where to put the word
236 * Returns: Zero if OK, or nonzero if there wasn't a word there.
238 * Use: Gets a 32-bit word from a buffer.
241 int buf_getu32(buf
*b
, uint32
*w
)
250 /* --- @buf_putu32@ --- *
252 * Arguments: @buf *b@ = pointer to a buffer block
253 * @uint32 w@ = word to write
255 * Returns: Zero if OK, nonzero if there wasn't enough space.
257 * Use: Puts a 32-but word in a buffer.
260 int buf_putu32(buf
*b
, uint32 w
)
269 /* --- @buf_getmp@ --- *
271 * Arguments: @buf *b@ = pointer to a buffer block
273 * Returns: A multiprecision integer, or null if there wasn't one there.
275 * Use: Gets a multiprecision integer from a buffer.
278 mp
*buf_getmp(buf
*b
)
282 if (buf_getu16(b
, &sz
) || buf_ensure(b
, sz
))
284 m
= mp_loadb(MP_NEW
, BCUR(b
), sz
);
285 if (mp_octets(m
) != sz
) {
293 /* --- @buf_putmp@ --- *
295 * Arguments: @buf *b@ = pointer to a buffer block
296 * @mp *m@ = a multiprecision integer
298 * Returns: Zero if it worked, nonzero if there wasn't enough space.
300 * Use: Puts a multiprecision integer to a buffer.
303 int buf_putmp(buf
*b
, mp
*m
)
305 size_t sz
= mp_octets(m
);
307 if (buf_putu16(b
, sz
) || buf_ensure(b
, sz
))
309 mp_storeb(m
, BCUR(b
), sz
);
314 /*----- That's all, folks -------------------------------------------------*/