2 Unix SMB/Netbios implementation.
4 Samba memory buffer functions
5 Copyright (C) Andrew Tridgell 1992-1997
6 Copyright (C) Luke Kenneth Casson Leighton 1996-1997
7 Copyright (C) Jeremy Allison 1999.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 extern int DEBUGLEVEL;
29 /*******************************************************************
31 ********************************************************************/
32 void prs_dump(char *name, int v, prs_struct *ps)
36 if (DEBUGLEVEL < 50) return;
39 slprintf(fname,sizeof(fname), "/tmp/%s_%d.%d.prs", name, v, i);
41 slprintf(fname,sizeof(fname), "/tmp/%s.%d.prs", name, i);
43 fd = open(fname, O_WRONLY|O_CREAT|O_EXCL, 0644);
44 if (fd != -1 || errno != EEXIST) break;
47 write(fd, ps->data_p + ps->data_offset, ps->grow_size - ps->data_offset);
49 DEBUG(0,("created %s\n", fname));
55 /*******************************************************************
56 debug output for parsing info.
58 XXXX side-effect of this function is to increase the debug depth XXXX
60 ********************************************************************/
61 void prs_debug(prs_struct *ps, int depth, char *desc, char *fn_name)
63 DEBUG(5+depth, ("%s%06x %s %s\n", tab_depth(depth), ps->data_offset, fn_name, desc));
66 /*******************************************************************
67 Initialise a parse structure - malloc the data if requested.
68 ********************************************************************/
70 BOOL prs_init(prs_struct *ps, uint32 size, uint8 align, BOOL io)
74 ps->bigendian_data = False;
76 ps->is_dynamic = False;
82 ps->buffer_size = size;
83 if((ps->data_p = (char *)malloc((size_t)size)) == NULL) {
84 DEBUG(0,("prs_init: malloc fail for %u bytes.\n", (unsigned int)size));
87 ps->is_dynamic = True; /* We own this memory. */
93 /*******************************************************************
94 read from a socket into memory.
95 ********************************************************************/
96 BOOL prs_read(prs_struct *ps, int fd, size_t len, int timeout)
99 size_t prev_size = ps->buffer_size;
100 if (!prs_grow(ps, len))
107 ok = (read_with_timeout(fd, &ps->data_p[prev_size],
108 len, len,timeout) == len);
112 ok = (read_data(fd, &ps->data_p[prev_size], len) == len);
117 /*******************************************************************
118 Delete the memory in a parse structure - if we own it.
119 ********************************************************************/
121 void prs_mem_free(prs_struct *ps)
123 if(ps->is_dynamic && (ps->data_p != NULL))
125 ps->is_dynamic = False;
131 /*******************************************************************
132 Hand some already allocated memory to a prs_struct.
133 ********************************************************************/
135 void prs_give_memory(prs_struct *ps, char *buf, uint32 size, BOOL is_dynamic)
137 ps->is_dynamic = is_dynamic;
139 ps->buffer_size = size;
142 /*******************************************************************
143 Take some memory back from a prs_struct.
144 ********************************************************************/
146 char *prs_take_memory(prs_struct *ps, uint32 *psize)
148 char *ret = ps->data_p;
150 *psize = ps->buffer_size;
151 ps->is_dynamic = False;
156 /*******************************************************************
157 Set a prs_struct to exactly a given size. Will grow or tuncate if neccessary.
158 ********************************************************************/
160 BOOL prs_set_buffer_size(prs_struct *ps, uint32 newsize)
162 if (newsize > ps->buffer_size)
163 return prs_force_grow(ps, newsize - ps->buffer_size);
165 if (newsize < ps->buffer_size) {
166 char *new_data_p = Realloc(ps->data_p, newsize);
167 /* if newsize is zero, Realloc acts like free() & returns NULL*/
168 if (new_data_p == NULL && newsize != 0) {
169 DEBUG(0,("prs_set_buffer_size: Realloc failure for size %u.\n",
170 (unsigned int)newsize));
171 DEBUG(0,("prs_set_buffer_size: Reason %s\n",strerror(errno)));
174 ps->data_p = new_data_p;
175 ps->buffer_size = newsize;
181 /*******************************************************************
182 Attempt, if needed, to grow a data buffer.
183 Also depends on the data stream mode (io).
184 ********************************************************************/
186 BOOL prs_grow(prs_struct *ps, uint32 extra_space)
191 ps->grow_size = MAX(ps->grow_size, ps->data_offset + extra_space);
193 if(ps->data_offset + extra_space <= ps->buffer_size)
197 * We cannot grow the buffer if we're not reading
198 * into the prs_struct, or if we don't own the memory.
201 if(UNMARSHALLING(ps) || !ps->is_dynamic) {
202 DEBUG(0,("prs_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
203 (unsigned int)extra_space));
208 * Decide how much extra space we really need.
211 extra_space -= (ps->buffer_size - ps->data_offset);
212 if(ps->buffer_size == 0) {
214 * Ensure we have at least a PDU's length, or extra_space, whichever
218 new_size = MAX(MAX_PDU_FRAG_LEN,extra_space);
220 if((new_data = malloc(new_size)) == NULL) {
221 DEBUG(0,("prs_grow: Malloc failure for size %u.\n", (unsigned int)new_size));
224 memset(new_data, '\0', new_size );
227 * If the current buffer size is bigger than the space needed, just
228 * double it, else add extra_space.
230 new_size = MAX(ps->buffer_size*2, ps->buffer_size + extra_space);
232 if ((new_data = Realloc(ps->data_p, new_size)) == NULL) {
233 DEBUG(0,("prs_grow: Realloc failure for size %u.\n",
234 (unsigned int)new_size));
238 memset(&new_data[ps->buffer_size], '\0', new_size - ps->buffer_size);
240 ps->buffer_size = new_size;
241 ps->data_p = new_data;
246 /*******************************************************************
247 Attempt to force a data buffer to grow by len bytes.
248 This is only used when appending more data onto a prs_struct
249 when reading an rpc reply, before unmarshalling it.
250 ********************************************************************/
252 BOOL prs_force_grow(prs_struct *ps, uint32 extra_space)
254 uint32 new_size = ps->buffer_size + extra_space;
257 if(!UNMARSHALLING(ps) || !ps->is_dynamic) {
258 DEBUG(0,("prs_force_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
259 (unsigned int)extra_space));
263 if((new_data = Realloc(ps->data_p, new_size)) == NULL) {
264 DEBUG(0,("prs_force_grow: Realloc failure for size %u.\n",
265 (unsigned int)new_size));
269 memset(&new_data[ps->buffer_size], '\0', new_size - ps->buffer_size);
271 ps->buffer_size = new_size;
272 ps->data_p = new_data;
277 /*******************************************************************
278 Get the data pointer (external interface).
279 ********************************************************************/
281 char *prs_data_p(prs_struct *ps)
286 /*******************************************************************
287 Get the current data size (external interface).
288 ********************************************************************/
290 uint32 prs_data_size(prs_struct *ps)
292 return ps->buffer_size;
295 /*******************************************************************
296 Fetch the current offset (external interface).
297 ********************************************************************/
299 uint32 prs_offset(prs_struct *ps)
301 return ps->data_offset;
304 /*******************************************************************
305 Set the current offset (external interface).
306 ********************************************************************/
308 BOOL prs_set_offset(prs_struct *ps, uint32 offset)
310 if(offset <= ps->data_offset) {
311 ps->data_offset = offset;
315 if(!prs_grow(ps, offset - ps->data_offset))
318 ps->data_offset = offset;
322 /*******************************************************************
323 Append the data from one parse_struct into another.
324 ********************************************************************/
326 BOOL prs_append_prs_data(prs_struct *dst, prs_struct *src)
328 if(!prs_grow(dst, prs_offset(src)))
331 memcpy(&dst->data_p[dst->data_offset], prs_data_p(src), (size_t)prs_offset(src));
332 dst->data_offset += prs_offset(src);
337 /*******************************************************************
338 Append some data from one parse_struct into another.
339 ********************************************************************/
341 BOOL prs_append_some_prs_data(prs_struct *dst, prs_struct *src, int32 start, uint32 len)
346 if(!prs_grow(dst, len))
349 memcpy(&dst->data_p[dst->data_offset], prs_data_p(src)+start, (size_t)len);
350 dst->data_offset += len;
355 /*******************************************************************
356 Append the data from a buffer into a parse_struct.
357 ********************************************************************/
359 BOOL prs_append_data(prs_struct *dst, char *src, uint32 len)
361 if(!prs_grow(dst, len))
364 memcpy(&dst->data_p[dst->data_offset], src, (size_t)len);
365 dst->data_offset += len;
370 /*******************************************************************
371 Set the data as big-endian (external interface).
372 ********************************************************************/
374 void prs_set_bigendian_data(prs_struct *ps)
376 ps->bigendian_data = True;
379 /*******************************************************************
380 Align a the data_len to a multiple of align bytes - filling with
382 ********************************************************************/
384 BOOL prs_align(prs_struct *ps)
386 uint32 mod = ps->data_offset & (ps->align-1);
388 if (ps->align != 0 && mod != 0) {
389 uint32 extra_space = (ps->align - mod);
390 if(!prs_grow(ps, extra_space))
392 memset(&ps->data_p[ps->data_offset], '\0', (size_t)extra_space);
393 ps->data_offset += extra_space;
399 /*******************************************************************
400 Ensure we can read/write to a given offset.
401 ********************************************************************/
403 char *prs_mem_get(prs_struct *ps, uint32 extra_size)
405 if(UNMARSHALLING(ps)) {
407 * If reading, ensure that we can read the requested size item.
409 if (ps->data_offset + extra_size > ps->buffer_size) {
410 DEBUG(0,("prs_mem_get: reading data of size %u would overrun buffer.\n",
411 (unsigned int)extra_size ));
416 * Writing - grow the buffer if needed.
418 if(!prs_grow(ps, extra_size))
421 return &ps->data_p[ps->data_offset];
424 /*******************************************************************
425 Change the struct type.
426 ********************************************************************/
428 void prs_switch_type(prs_struct *ps, BOOL io)
430 if ((ps->io ^ io) == True)
434 /*******************************************************************
435 Force a prs_struct to be dynamic even when it's size is 0.
436 ********************************************************************/
438 void prs_force_dynamic(prs_struct *ps)
443 /*******************************************************************
445 ********************************************************************/
447 BOOL prs_uint8(char *name, prs_struct *ps, int depth, uint8 *data8)
449 char *q = prs_mem_get(ps, sizeof(uint8));
453 DBG_RW_CVAL(name, depth, ps->data_offset, ps->io, q, *data8)
454 ps->data_offset += sizeof(uint8);
459 /*******************************************************************
461 ********************************************************************/
463 BOOL prs_uint16(char *name, prs_struct *ps, int depth, uint16 *data16)
465 char *q = prs_mem_get(ps, sizeof(uint16));
469 DBG_RW_SVAL(name, depth, ps->data_offset, ps->io, ps->bigendian_data, q, *data16)
470 ps->data_offset += sizeof(uint16);
475 /*******************************************************************
477 ********************************************************************/
479 BOOL prs_uint32(char *name, prs_struct *ps, int depth, uint32 *data32)
481 char *q = prs_mem_get(ps, sizeof(uint32));
485 DBG_RW_IVAL(name, depth, ps->data_offset, ps->io, ps->bigendian_data, q, *data32)
486 ps->data_offset += sizeof(uint32);
491 /******************************************************************
492 Stream an array of uint8s. Length is number of uint8s.
493 ********************************************************************/
495 BOOL prs_uint8s(BOOL charmode, char *name, prs_struct *ps, int depth, uint8 *data8s, int len)
497 char *q = prs_mem_get(ps, len * sizeof(uint8));
501 DBG_RW_PCVAL(charmode, name, depth, ps->data_offset, ps->io, q, data8s, len)
502 ps->data_offset += (len * sizeof(uint8));
507 /******************************************************************
508 Stream an array of uint16s. Length is number of uint16s.
509 ********************************************************************/
511 BOOL prs_uint16s(BOOL charmode, char *name, prs_struct *ps, int depth, uint16 *data16s, int len)
513 char *q = prs_mem_get(ps, len * sizeof(uint16));
517 DBG_RW_PSVAL(charmode, name, depth, ps->data_offset, ps->io, ps->bigendian_data, q, data16s, len)
518 ps->data_offset += (len * sizeof(uint16));
523 /******************************************************************
524 Stream an array of uint32s. Length is number of uint32s.
525 ********************************************************************/
527 BOOL prs_uint32s(BOOL charmode, char *name, prs_struct *ps, int depth, uint32 *data32s, int len)
529 char *q = prs_mem_get(ps, len * sizeof(uint32));
533 DBG_RW_PIVAL(charmode, name, depth, ps->data_offset, ps->io, ps->bigendian_data, q, data32s, len)
534 ps->data_offset += (len * sizeof(uint32));
539 /******************************************************************
540 Stream a "not" unicode string, length/buffer specified separately,
541 in byte chars. String is in little-endian format.
542 ********************************************************************/
544 BOOL prs_buffer2(BOOL charmode, char *name, prs_struct *ps, int depth, BUFFER2 *str)
546 char *p = (char *)str->buffer;
547 char *q = prs_mem_get(ps, str->buf_len);
551 /* If we're using big-endian, reverse to get little-endian. */
552 if(ps->bigendian_data)
553 DBG_RW_PSVAL(charmode, name, depth, ps->data_offset, ps->io, ps->bigendian_data, q, p, str->buf_len/2)
555 DBG_RW_PCVAL(charmode, name, depth, ps->data_offset, ps->io, q, p, str->buf_len)
556 ps->data_offset += str->buf_len;
561 /******************************************************************
562 Stream a string, length/buffer specified separately,
564 ********************************************************************/
566 BOOL prs_string2(BOOL charmode, char *name, prs_struct *ps, int depth, STRING2 *str)
568 char *q = prs_mem_get(ps, str->str_str_len * sizeof(uint8));
572 DBG_RW_PCVAL(charmode, name, depth, ps->data_offset, ps->io, q, str->buffer, str->str_max_len)
573 ps->data_offset += (str->str_str_len * sizeof(uint8));
578 /******************************************************************
579 Stream a unicode string, length/buffer specified separately,
580 in uint16 chars. We use DBG_RW_PCVAL, not DBG_RW_PSVAL here
581 as the unicode string is already in little-endian format.
582 ********************************************************************/
584 BOOL prs_unistr2(BOOL charmode, char *name, prs_struct *ps, int depth, UNISTR2 *str)
586 char *p = (char *)str->buffer;
587 char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
591 /* If we're using big-endian, reverse to get little-endian. */
592 if(ps->bigendian_data)
593 DBG_RW_PSVAL(charmode, name, depth, ps->data_offset, ps->io, ps->bigendian_data, q, p, str->uni_str_len)
595 DBG_RW_PCVAL(charmode, name, depth, ps->data_offset, ps->io, q, p, str->uni_str_len * 2)
596 ps->data_offset += (str->uni_str_len * sizeof(uint16));
601 /******************************************************************
602 Stream a unicode string, length/buffer specified separately,
603 in uint16 chars. We use DBG_RW_PCVAL, not DBG_RW_PSVAL here
604 as the unicode string is already in little-endian format.
605 ********************************************************************/
607 BOOL prs_unistr3(BOOL charmode, char *name, UNISTR3 *str, prs_struct *ps, int depth)
609 char *p = (char *)str->str.buffer;
610 char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
614 /* If we're using big-endian, reverse to get little-endian. */
615 if(ps->bigendian_data)
616 DBG_RW_PSVAL(charmode, name, depth, ps->data_offset, ps->io, ps->bigendian_data, q, p, str->uni_str_len)
618 DBG_RW_PCVAL(charmode, name, depth, ps->data_offset, ps->io, q, p, str->uni_str_len * 2)
619 ps->data_offset += (str->uni_str_len * sizeof(uint16));
624 /*******************************************************************
625 Stream a unicode null-terminated string. As the string is already
626 in little-endian format then do it as a stream of bytes.
627 ********************************************************************/
629 BOOL prs_unistr(char *name, prs_struct *ps, int depth, UNISTR *str)
632 unsigned char *p = (unsigned char *)str->buffer;
637 for(len = 0; len < (sizeof(str->buffer) / sizeof(str->buffer[0])) &&
638 str->buffer[len] != 0; len++)
641 q = prs_mem_get(ps, (len+1)*2);
647 for(len = 0; len < (sizeof(str->buffer) / sizeof(str->buffer[0])) &&
648 str->buffer[len] != 0; len++) {
649 if(ps->bigendian_data) {
650 RW_SVAL(ps->io, ps->bigendian_data, q, *p, 0);
654 RW_CVAL(ps->io, q, *p, 0);
657 RW_CVAL(ps->io, q, *p, 0);
664 * even if the string is 'empty' (only an \0 char)
665 * at this point the leading \0 hasn't been parsed.
669 RW_CVAL(ps->io, q, zero, 0);
671 RW_CVAL(ps->io, q, zero, 0);
676 ps->data_offset += len*2;
678 dump_data(5+depth, (char *)start, len * 2);
683 /*******************************************************************
684 Stream a null-terminated string. len is strlen, and therefore does
685 not include the null-termination character.
686 ********************************************************************/
688 BOOL prs_string(char *name, prs_struct *ps, int depth, char *str, int len, int max_buf_size)
694 len = MIN(len, (max_buf_size-1));
696 q = prs_mem_get(ps, len+1);
702 for(i = 0; i < len; i++) {
703 RW_CVAL(ps->io, q, str[i],0);
707 /* The terminating null. */
710 if (MARSHALLING(ps)) {
711 RW_CVAL(ps->io, q, str[i], 0);
714 ps->data_offset += len+1;
716 dump_data(5+depth, (char *)start, len);
721 /*******************************************************************
722 prs_uint16 wrapper. Call this and it sets up a pointer to where the
723 uint16 should be stored, or gets the size if reading.
724 ********************************************************************/
726 BOOL prs_uint16_pre(char *name, prs_struct *ps, int depth, uint16 *data16, uint32 *offset)
728 (*offset) = ps->data_offset;
729 if (UNMARSHALLING(ps)) {
731 return prs_uint16(name, ps, depth, data16);
733 char *q = prs_mem_get(ps, sizeof(uint16));
736 ps->data_offset += sizeof(uint16);
741 /*******************************************************************
742 prs_uint16 wrapper. call this and it retrospectively stores the size.
743 does nothing on reading, as that is already handled by ...._pre()
744 ********************************************************************/
746 BOOL prs_uint16_post(char *name, prs_struct *ps, int depth, uint16 *data16,
747 uint32 ptr_uint16, uint32 start_offset)
749 if (MARSHALLING(ps)) {
751 * Writing - temporarily move the offset pointer.
753 uint16 data_size = ps->data_offset - start_offset;
754 uint32 old_offset = ps->data_offset;
756 ps->data_offset = ptr_uint16;
757 if(!prs_uint16(name, ps, depth, &data_size)) {
758 ps->data_offset = old_offset;
761 ps->data_offset = old_offset;
763 ps->data_offset = start_offset + (uint32)(*data16);
768 /*******************************************************************
769 prs_uint32 wrapper. Call this and it sets up a pointer to where the
770 uint32 should be stored, or gets the size if reading.
771 ********************************************************************/
773 BOOL prs_uint32_pre(char *name, prs_struct *ps, int depth, uint32 *data32, uint32 *offset)
775 (*offset) = ps->data_offset;
776 if (UNMARSHALLING(ps)) {
778 return prs_uint32(name, ps, depth, data32);
780 ps->data_offset += sizeof(uint32);
785 /*******************************************************************
786 prs_uint32 wrapper. call this and it retrospectively stores the size.
787 does nothing on reading, as that is already handled by ...._pre()
788 ********************************************************************/
790 BOOL prs_uint32_post(char *name, prs_struct *ps, int depth, uint32 *data32,
791 uint32 ptr_uint32, uint32 data_size)
793 if (MARSHALLING(ps)) {
795 * Writing - temporarily move the offset pointer.
797 uint32 old_offset = ps->data_offset;
798 ps->data_offset = ptr_uint32;
799 if(!prs_uint32(name, ps, depth, &data_size)) {
800 ps->data_offset = old_offset;
803 ps->data_offset = old_offset;
808 /* useful function to store a structure in rpc wire format */
809 int tdb_prs_store(TDB_CONTEXT *tdb, char *keystr, prs_struct *ps)
813 kbuf.dsize = strlen(keystr)+1;
814 dbuf.dptr = prs_data_p(ps);
815 dbuf.dsize = prs_offset(ps);
816 return tdb_store(tdb, kbuf, dbuf, TDB_REPLACE);
819 /* useful function to fetch a structure into rpc wire format */
820 int tdb_prs_fetch(TDB_CONTEXT *tdb, char *keystr, prs_struct *ps)
824 kbuf.dsize = strlen(keystr)+1;
826 dbuf = tdb_fetch(tdb, kbuf);
827 if (!dbuf.dptr) return -1;
830 prs_init(ps, 0, 4, UNMARSHALL);
831 prs_give_memory(ps, dbuf.dptr, dbuf.dsize, True);