return NULL instead of return False in char *prs_mem_get();
[ira/wip.git] / source3 / rpc_parse / parse_prs.c
1 /* 
2    Unix SMB/Netbios implementation.
3    Version 1.9.
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.
8    
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.
13    
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.
18    
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.
22 */
23
24 extern int DEBUGLEVEL;
25
26 #include "includes.h"
27
28
29 /*******************************************************************
30 dump a prs to a file
31  ********************************************************************/
32 void prs_dump(char *name, int v, prs_struct *ps)
33 {
34         int fd, i;
35         pstring fname;
36         if (DEBUGLEVEL < 50) return;
37         for (i=1;i<100;i++) {
38                 if (v != -1) {
39                         slprintf(fname,sizeof(fname), "/tmp/%s_%d.%d.prs", name, v, i);
40                 } else {
41                         slprintf(fname,sizeof(fname), "/tmp/%s.%d.prs", name, i);
42                 }
43                 fd = open(fname, O_WRONLY|O_CREAT|O_EXCL, 0644);
44                 if (fd != -1 || errno != EEXIST) break;
45         }
46         if (fd != -1) {
47                 write(fd, ps->data_p + ps->data_offset, ps->buffer_size - ps->data_offset);
48                 close(fd);
49                 DEBUG(0,("created %s\n", fname));
50         }
51 }
52
53
54
55 /*******************************************************************
56  debug output for parsing info.
57
58  XXXX side-effect of this function is to increase the debug depth XXXX
59
60  ********************************************************************/
61 void prs_debug(prs_struct *ps, int depth, char *desc, char *fn_name)
62 {
63         DEBUG(5+depth, ("%s%06x %s %s\n", tab_depth(depth), ps->data_offset, fn_name, desc));
64 }
65
66
67 /*******************************************************************
68  Initialise a parse structure - malloc the data if requested.
69  ********************************************************************/
70 BOOL prs_init(prs_struct *ps, uint32 size, uint8 align, TALLOC_CTX *ctx, BOOL io)
71 {
72         ZERO_STRUCTP(ps);
73         ps->io = io;
74         ps->bigendian_data = False;
75         ps->align = align;
76         ps->is_dynamic = False;
77         ps->data_offset = 0;
78         ps->buffer_size = 0;
79         ps->data_p = NULL;
80         ps->mem_ctx = ctx;
81
82         if (size != 0) {
83                 ps->buffer_size = size;
84                 if((ps->data_p = (char *)malloc((size_t)size)) == NULL) {
85                         DEBUG(0,("prs_init: malloc fail for %u bytes.\n", (unsigned int)size));
86                         return False;
87                 }
88                 ps->is_dynamic = True; /* We own this memory. */
89         }
90
91         return True;
92 }
93
94 /*******************************************************************
95  read from a socket into memory.
96  ********************************************************************/
97 BOOL prs_read(prs_struct *ps, int fd, size_t len, int timeout)
98 {
99         BOOL ok;
100         size_t prev_size = ps->buffer_size;
101         if (!prs_grow(ps, len))
102                 return False;
103
104         if (timeout > 0) {
105                 ok = (read_with_timeout(fd, &ps->data_p[prev_size],
106                                             len, len,timeout) == len);
107         } else {
108                 ok = (read_data(fd, &ps->data_p[prev_size], len) == len);
109         }
110         return ok;
111 }
112
113 /*******************************************************************
114  Delete the memory in a parse structure - if we own it.
115  ********************************************************************/
116
117 void prs_mem_free(prs_struct *ps)
118 {
119         if(ps->is_dynamic && (ps->data_p != NULL))
120                 free(ps->data_p);
121         ps->is_dynamic = False;
122         ps->data_p = NULL;
123         ps->buffer_size = 0;
124         ps->data_offset = 0;
125 }
126
127 /*******************************************************************
128  Allocate memory when unmarshalling...
129  ********************************************************************/
130
131 char *prs_alloc_mem(prs_struct *ps, size_t size)
132 {
133         return talloc(ps->mem_ctx, size);
134 }
135
136 /*******************************************************************
137  Return the current talloc context we're using.
138  ********************************************************************/
139
140 TALLOC_CTX *prs_get_mem_context(prs_struct *ps)
141 {
142         return ps->mem_ctx;
143 }
144
145 /*******************************************************************
146  Hand some already allocated memory to a prs_struct.
147  ********************************************************************/
148
149 void prs_give_memory(prs_struct *ps, char *buf, uint32 size, BOOL is_dynamic)
150 {
151         ps->is_dynamic = is_dynamic;
152         ps->data_p = buf;
153         ps->buffer_size = size;
154 }
155
156 /*******************************************************************
157  Take some memory back from a prs_struct.
158  ********************************************************************/
159
160 char *prs_take_memory(prs_struct *ps, uint32 *psize)
161 {
162         char *ret = ps->data_p;
163         if(psize)
164                 *psize = ps->buffer_size;
165         ps->is_dynamic = False;
166         prs_mem_free(ps);
167         return ret;
168 }
169
170 /*******************************************************************
171  Set a prs_struct to exactly a given size. Will grow or tuncate if neccessary.
172  ********************************************************************/
173
174 BOOL prs_set_buffer_size(prs_struct *ps, uint32 newsize)
175 {
176         if (newsize > ps->buffer_size)
177                 return prs_force_grow(ps, newsize - ps->buffer_size);
178
179         if (newsize < ps->buffer_size) {
180                 char *new_data_p = Realloc(ps->data_p, newsize);
181                 /* if newsize is zero, Realloc acts like free() & returns NULL*/
182                 if (new_data_p == NULL && newsize != 0) {
183                         DEBUG(0,("prs_set_buffer_size: Realloc failure for size %u.\n",
184                                 (unsigned int)newsize));
185                         DEBUG(0,("prs_set_buffer_size: Reason %s\n",strerror(errno)));
186                         return False;
187                 }
188                 ps->data_p = new_data_p;
189                 ps->buffer_size = newsize;
190         }
191
192         return True;
193 }
194
195 /*******************************************************************
196  Attempt, if needed, to grow a data buffer.
197  Also depends on the data stream mode (io).
198  ********************************************************************/
199
200 BOOL prs_grow(prs_struct *ps, uint32 extra_space)
201 {
202         uint32 new_size;
203         char *new_data;
204
205         ps->grow_size = MAX(ps->grow_size, ps->data_offset + extra_space);
206
207         if(ps->data_offset + extra_space <= ps->buffer_size)
208                 return True;
209
210         /*
211          * We cannot grow the buffer if we're not reading
212          * into the prs_struct, or if we don't own the memory.
213          */
214
215         if(UNMARSHALLING(ps) || !ps->is_dynamic) {
216                 DEBUG(0,("prs_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
217                                 (unsigned int)extra_space));
218                 return False;
219         }
220         
221         /*
222          * Decide how much extra space we really need.
223          */
224
225         extra_space -= (ps->buffer_size - ps->data_offset);
226         if(ps->buffer_size == 0) {
227                 /*
228                  * Ensure we have at least a PDU's length, or extra_space, whichever
229                  * is greater.
230                  */
231
232                 new_size = MAX(MAX_PDU_FRAG_LEN,extra_space);
233
234                 if((new_data = malloc(new_size)) == NULL) {
235                         DEBUG(0,("prs_grow: Malloc failure for size %u.\n", (unsigned int)new_size));
236                         return False;
237                 }
238                 memset(new_data, '\0', new_size );
239         } else {
240                 /*
241                  * If the current buffer size is bigger than the space needed, just 
242                  * double it, else add extra_space.
243                  */
244                 new_size = MAX(ps->buffer_size*2, ps->buffer_size + extra_space);               
245
246                 if ((new_data = Realloc(ps->data_p, new_size)) == NULL) {
247                         DEBUG(0,("prs_grow: Realloc failure for size %u.\n",
248                                 (unsigned int)new_size));
249                         return False;
250                 }
251
252                 memset(&new_data[ps->buffer_size], '\0', new_size - ps->buffer_size);
253         }
254         ps->buffer_size = new_size;
255         ps->data_p = new_data;
256
257         return True;
258 }
259
260 /*******************************************************************
261  Attempt to force a data buffer to grow by len bytes.
262  This is only used when appending more data onto a prs_struct
263  when reading an rpc reply, before unmarshalling it.
264  ********************************************************************/
265
266 BOOL prs_force_grow(prs_struct *ps, uint32 extra_space)
267 {
268         uint32 new_size = ps->buffer_size + extra_space;
269         char *new_data;
270
271         if(!UNMARSHALLING(ps) || !ps->is_dynamic) {
272                 DEBUG(0,("prs_force_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
273                                 (unsigned int)extra_space));
274                 return False;
275         }
276
277         if((new_data = Realloc(ps->data_p, new_size)) == NULL) {
278                 DEBUG(0,("prs_force_grow: Realloc failure for size %u.\n",
279                         (unsigned int)new_size));
280                 return False;
281         }
282
283         memset(&new_data[ps->buffer_size], '\0', new_size - ps->buffer_size);
284
285         ps->buffer_size = new_size;
286         ps->data_p = new_data;
287
288         return True;
289 }
290
291 /*******************************************************************
292  Get the data pointer (external interface).
293  ********************************************************************/
294
295 char *prs_data_p(prs_struct *ps)
296 {
297         return ps->data_p;
298 }
299
300 /*******************************************************************
301  Get the current data size (external interface).
302  ********************************************************************/
303
304 uint32 prs_data_size(prs_struct *ps)
305 {
306         return ps->buffer_size;
307 }
308
309 /*******************************************************************
310  Fetch the current offset (external interface).
311  ********************************************************************/
312
313 uint32 prs_offset(prs_struct *ps)
314 {
315         return ps->data_offset;
316 }
317
318 /*******************************************************************
319  Set the current offset (external interface).
320  ********************************************************************/
321
322 BOOL prs_set_offset(prs_struct *ps, uint32 offset)
323 {
324         if(offset <= ps->data_offset) {
325                 ps->data_offset = offset;
326                 return True;
327         }
328
329         if(!prs_grow(ps, offset - ps->data_offset))
330                 return False;
331
332         ps->data_offset = offset;
333         return True;
334 }
335
336 /*******************************************************************
337  Append the data from one parse_struct into another.
338  ********************************************************************/
339
340 BOOL prs_append_prs_data(prs_struct *dst, prs_struct *src)
341 {
342         if(!prs_grow(dst, prs_offset(src)))
343                 return False;
344
345         memcpy(&dst->data_p[dst->data_offset], prs_data_p(src), (size_t)prs_offset(src));
346         dst->data_offset += prs_offset(src);
347
348         return True;
349 }
350
351 /*******************************************************************
352  Append some data from one parse_struct into another.
353  ********************************************************************/
354
355 BOOL prs_append_some_prs_data(prs_struct *dst, prs_struct *src, int32 start, uint32 len)
356 {       
357         if (len == 0)
358                 return True;
359
360         if(!prs_grow(dst, len))
361                 return False;
362         
363         memcpy(&dst->data_p[dst->data_offset], prs_data_p(src)+start, (size_t)len);
364         dst->data_offset += len;
365
366         return True;
367 }
368
369 /*******************************************************************
370  Append the data from a buffer into a parse_struct.
371  ********************************************************************/
372
373 BOOL prs_append_data(prs_struct *dst, char *src, uint32 len)
374 {
375         if(!prs_grow(dst, len))
376                 return False;
377
378         memcpy(&dst->data_p[dst->data_offset], src, (size_t)len);
379         dst->data_offset += len;
380
381         return True;
382 }
383
384 /*******************************************************************
385  Set the data as big-endian (external interface).
386  ********************************************************************/
387
388 void prs_set_bigendian_data(prs_struct *ps)
389 {
390         ps->bigendian_data = True;
391 }
392
393 /*******************************************************************
394  Align a the data_len to a multiple of align bytes - filling with
395  zeros.
396  ********************************************************************/
397
398 BOOL prs_align(prs_struct *ps)
399 {
400         uint32 mod = ps->data_offset & (ps->align-1);
401
402         if (ps->align != 0 && mod != 0) {
403                 uint32 extra_space = (ps->align - mod);
404                 if(!prs_grow(ps, extra_space))
405                         return False;
406                 memset(&ps->data_p[ps->data_offset], '\0', (size_t)extra_space);
407                 ps->data_offset += extra_space;
408         }
409
410         return True;
411 }
412
413 /*******************************************************************
414  Align only if required (for the unistr2 string mainly)
415  ********************************************************************/
416
417 BOOL prs_align_needed(prs_struct *ps, uint32 needed)
418 {
419         if (needed==0)
420                 return True;
421         else
422                 return prs_align(ps);
423 }
424
425 /*******************************************************************
426  Ensure we can read/write to a given offset.
427  ********************************************************************/
428
429 char *prs_mem_get(prs_struct *ps, uint32 extra_size)
430 {
431         if(UNMARSHALLING(ps)) {
432                 /*
433                  * If reading, ensure that we can read the requested size item.
434                  */
435                 if (ps->data_offset + extra_size > ps->buffer_size) {
436                         DEBUG(0,("prs_mem_get: reading data of size %u would overrun buffer.\n",
437                                         (unsigned int)extra_size ));
438                         return NULL;
439                 }
440         } else {
441                 /*
442                  * Writing - grow the buffer if needed.
443                  */
444                 if(!prs_grow(ps, extra_size))
445                         return NULL;
446         }
447         return &ps->data_p[ps->data_offset];
448 }
449
450 /*******************************************************************
451  Change the struct type.
452  ********************************************************************/
453
454 void prs_switch_type(prs_struct *ps, BOOL io)
455 {
456         if ((ps->io ^ io) == True)
457                 ps->io=io;
458 }
459
460 /*******************************************************************
461  Force a prs_struct to be dynamic even when it's size is 0.
462  ********************************************************************/
463
464 void prs_force_dynamic(prs_struct *ps)
465 {
466         ps->is_dynamic=True;
467 }
468
469 /*******************************************************************
470  Stream a uint8.
471  ********************************************************************/
472
473 BOOL prs_uint8(char *name, prs_struct *ps, int depth, uint8 *data8)
474 {
475         char *q = prs_mem_get(ps, sizeof(uint8));
476         if (q == NULL)
477                 return False;
478
479         DBG_RW_CVAL(name, depth, ps->data_offset, ps->io, q, *data8)
480         ps->data_offset += sizeof(uint8);
481
482         return True;
483 }
484
485 /*******************************************************************
486  Stream a uint16.
487  ********************************************************************/
488
489 BOOL prs_uint16(char *name, prs_struct *ps, int depth, uint16 *data16)
490 {
491         char *q = prs_mem_get(ps, sizeof(uint16));
492         if (q == NULL)
493                 return False;
494
495         DBG_RW_SVAL(name, depth, ps->data_offset, ps->io, ps->bigendian_data, q, *data16)
496         ps->data_offset += sizeof(uint16);
497
498         return True;
499 }
500
501 /*******************************************************************
502  Stream a uint32.
503  ********************************************************************/
504
505 BOOL prs_uint32(char *name, prs_struct *ps, int depth, uint32 *data32)
506 {
507         char *q = prs_mem_get(ps, sizeof(uint32));
508         if (q == NULL)
509                 return False;
510
511         DBG_RW_IVAL(name, depth, ps->data_offset, ps->io, ps->bigendian_data, q, *data32)
512         ps->data_offset += sizeof(uint32);
513
514         return True;
515 }
516
517 /******************************************************************
518  Stream an array of uint8s. Length is number of uint8s.
519  ********************************************************************/
520
521 BOOL prs_uint8s(BOOL charmode, char *name, prs_struct *ps, int depth, uint8 *data8s, int len)
522 {
523         char *q = prs_mem_get(ps, len * sizeof(uint8));
524         if (q == NULL)
525                 return False;
526
527         DBG_RW_PCVAL(charmode, name, depth, ps->data_offset, ps->io, q, data8s, len)
528         ps->data_offset += (len * sizeof(uint8));
529
530         return True;
531 }
532
533 /******************************************************************
534  Stream an array of uint16s. Length is number of uint16s.
535  ********************************************************************/
536
537 BOOL prs_uint16s(BOOL charmode, char *name, prs_struct *ps, int depth, uint16 *data16s, int len)
538 {
539         char *q = prs_mem_get(ps, len * sizeof(uint16));
540         if (q == NULL)
541                 return False;
542
543         DBG_RW_PSVAL(charmode, name, depth, ps->data_offset, ps->io, ps->bigendian_data, q, data16s, len)
544         ps->data_offset += (len * sizeof(uint16));
545
546         return True;
547 }
548
549 /******************************************************************
550  Stream an array of uint32s. Length is number of uint32s.
551  ********************************************************************/
552
553 BOOL prs_uint32s(BOOL charmode, char *name, prs_struct *ps, int depth, uint32 *data32s, int len)
554 {
555         char *q = prs_mem_get(ps, len * sizeof(uint32));
556         if (q == NULL)
557                 return False;
558
559         DBG_RW_PIVAL(charmode, name, depth, ps->data_offset, ps->io, ps->bigendian_data, q, data32s, len)
560         ps->data_offset += (len * sizeof(uint32));
561
562         return True;
563 }
564
565 /******************************************************************
566  Stream a "not" unicode string, length/buffer specified separately,
567  in byte chars. String is in little-endian format.
568  ********************************************************************/
569
570 BOOL prs_buffer2(BOOL charmode, char *name, prs_struct *ps, int depth, BUFFER2 *str)
571 {
572         char *p;
573         char *q = prs_mem_get(ps, str->buf_len);
574         if (q == NULL)
575                 return False;
576
577         if (UNMARSHALLING(ps)) {
578                 str->buffer = (uint16 *)prs_alloc_mem(ps,str->buf_len);
579                 if (str->buffer == NULL)
580                         return False;
581         }
582
583         p = (char *)str->buffer;
584
585         /* If we're using big-endian, reverse to get little-endian. */
586         if(ps->bigendian_data)
587                 DBG_RW_PSVAL(charmode, name, depth, ps->data_offset, ps->io, ps->bigendian_data, q, p, str->buf_len/2)
588         else
589                 DBG_RW_PCVAL(charmode, name, depth, ps->data_offset, ps->io, q, p, str->buf_len)
590         ps->data_offset += str->buf_len;
591
592         return True;
593 }
594
595 /******************************************************************
596  Stream a string, length/buffer specified separately,
597  in uint8 chars.
598  ********************************************************************/
599
600 BOOL prs_string2(BOOL charmode, char *name, prs_struct *ps, int depth, STRING2 *str)
601 {
602         char *q = prs_mem_get(ps, str->str_str_len * sizeof(uint8));
603         if (q == NULL)
604                 return False;
605
606         if (UNMARSHALLING(ps)) {
607                 str->buffer = (unsigned char *)prs_alloc_mem(ps,str->str_str_len);
608                 if (str->buffer == NULL)
609                         return False;
610         }
611
612         DBG_RW_PCVAL(charmode, name, depth, ps->data_offset, ps->io, q, str->buffer, str->str_max_len)
613         ps->data_offset += (str->str_str_len * sizeof(uint8));
614
615         return True;
616 }
617
618 /******************************************************************
619  Stream a unicode string, length/buffer specified separately,
620  in uint16 chars. We use DBG_RW_PCVAL, not DBG_RW_PSVAL here
621  as the unicode string is already in little-endian format.
622  ********************************************************************/
623
624 BOOL prs_unistr2(BOOL charmode, char *name, prs_struct *ps, int depth, UNISTR2 *str)
625 {
626         char *p;
627         char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
628         if (q == NULL)
629                 return False;
630
631         if (UNMARSHALLING(ps)) {
632                 str->buffer = (uint16 *)prs_alloc_mem(ps,str->uni_max_len * sizeof(uint16));
633                 if (str->buffer == NULL)
634                         return False;
635                 memset(str->buffer, '\0', str->uni_max_len * sizeof(uint16));
636         }
637
638         /* If the string is empty, we don't have anything to stream */
639         if (str->uni_str_len==0)
640                 return True;
641
642         p = (char *)str->buffer;
643
644         /* If we're using big-endian, reverse to get little-endian. */
645         if(ps->bigendian_data) {
646                 DBG_RW_PSVAL(charmode, name, depth, ps->data_offset, 
647                              ps->io, ps->bigendian_data, q, p, 
648                              str->uni_str_len)
649         } else {
650                 DBG_RW_PCVAL(charmode, name, depth, ps->data_offset, 
651                              ps->io, q, p, str->uni_str_len * sizeof(uint16))
652         }
653         
654         ps->data_offset += (str->uni_str_len * sizeof(uint16));
655
656         return True;
657 }
658
659
660
661 /******************************************************************
662  Stream a unicode string, length/buffer specified separately,
663  in uint16 chars. We use DBG_RW_PCVAL, not DBG_RW_PSVAL here
664  as the unicode string is already in little-endian format.
665  ********************************************************************/
666
667 BOOL prs_unistr3(BOOL charmode, char *name, UNISTR3 *str, prs_struct *ps, int depth)
668 {
669         char *p;
670         char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
671         if (q == NULL)
672                 return False;
673
674         if (UNMARSHALLING(ps)) {
675                 str->str.buffer = (uint16 *)prs_alloc_mem(ps,str->uni_str_len * sizeof(uint16));
676                 if (str->str.buffer == NULL)
677                         return False;
678         }
679
680         p = (char *)str->str.buffer;
681
682         /* If we're using big-endian, reverse to get little-endian. */
683         if(ps->bigendian_data)
684                 DBG_RW_PSVAL(charmode, name, depth, ps->data_offset, ps->io, ps->bigendian_data, q, p, str->uni_str_len)
685         else
686                 DBG_RW_PCVAL(charmode, name, depth, ps->data_offset, ps->io, q, p, str->uni_str_len * sizeof(uint16))
687         ps->data_offset += (str->uni_str_len * sizeof(uint16));
688
689         return True;
690 }
691
692 /*******************************************************************
693  Stream a unicode  null-terminated string. As the string is already
694  in little-endian format then do it as a stream of bytes.
695  ********************************************************************/
696
697 BOOL prs_unistr(char *name, prs_struct *ps, int depth, UNISTR *str)
698 {
699         int len = 0;
700         unsigned char *p = (unsigned char *)str->buffer;
701         uint8 *start;
702         char *q;
703         char zero=0;
704         uint32 max_len;
705         uint16* ptr;
706
707         if (MARSHALLING(ps)) {
708
709                 for(len = 0; str->buffer[len] != 0; len++)
710                         ;
711
712                 q = prs_mem_get(ps, (len+1)*2);
713                 if (q == NULL)
714                         return False;
715
716                 start = (uint8*)q;
717
718                 for(len = 0; str->buffer[len] != 0; len++) 
719                 {
720                         if(ps->bigendian_data) 
721                         {
722                                 RW_SVAL(ps->io, ps->bigendian_data, q, *p, 0);
723                                 p += 2;
724                                 q += 2;
725                         } 
726                         else 
727                         {
728                                 RW_CVAL(ps->io, q, *p, 0);
729                                 p++;
730                                 q++;
731                                 RW_CVAL(ps->io, q, *p, 0);
732                                 p++;
733                                 q++;
734                         }
735                 }
736
737                 /*
738                  * even if the string is 'empty' (only an \0 char)
739                  * at this point the leading \0 hasn't been parsed.
740                  * so parse it now
741                  */
742
743                 RW_CVAL(ps->io, q, zero, 0);
744                 q++;
745                 RW_CVAL(ps->io, q, zero, 0);
746                 q++;
747
748                 len++;
749
750                 dump_data(5+depth, (char *)start, len * 2);
751         }
752         else { /* unmarshalling */
753         
754                 uint32 alloc_len = 0;
755                 q = prs_data_p(ps) + prs_offset(ps);
756
757                 /*
758                  * Work out how much space we need and talloc it.
759                  */
760                 max_len = (ps->buffer_size - ps->data_offset)/sizeof(uint16);
761
762                 /* the test of the value of *ptr helps to catch the circumstance
763                    where we have an emtpty (non-existent) string in the buffer */
764                 for ( ptr = (uint16 *)q; *ptr && (alloc_len <= max_len); alloc_len++)
765                         /* do nothing */ 
766                         ;
767
768                 /* should we allocate anything at all? */
769                 str->buffer = (uint16 *)prs_alloc_mem(ps,alloc_len * sizeof(uint16));
770                 if ((str->buffer == NULL) && (alloc_len > 0))
771                         return False;
772
773                 p = (unsigned char *)str->buffer;
774
775                 len = 0;
776                 /* the (len < alloc_len) test is to prevent us from overwriting
777                    memory that is not ours...if we get that far, we have a non-null
778                    terminated string in the buffer and have messed up somewhere */
779                 while ((len < alloc_len) && (*q != '\0'))
780                 {
781                         if(ps->bigendian_data) 
782                         {
783                                 RW_SVAL(ps->io, ps->bigendian_data, q, *p, 0);
784                                 p += 2;
785                                 q += 2;
786                         } else {
787 #if WORDS_BIGENDIAN
788                                 RW_CVAL(ps->io, q+1, *p, 0);
789                                 p++;
790                                 RW_CVAL(ps->io, q, *p, 0);
791                                 p++;
792                                 q+=2;
793 #else
794                                 RW_CVAL(ps->io, q, *p, 0);
795                                 p++;
796                                 q++;
797                                 RW_CVAL(ps->io, q, *p, 0);
798                                 p++;
799                                 q++;
800 #endif  /* WORDS_BIGENDIAN */
801
802                         }
803
804                         len++;
805                 } 
806                 if (len < alloc_len)
807                 {
808                         /* NULL terminate the UNISTR */
809                         str->buffer[len++] = '\0';
810                 }
811         }
812
813         /* set the offset in the prs_struct; 'len' points to the
814            terminiating NULL in the UNISTR so we need to go one more
815            uint16 */
816         ps->data_offset += (len)*2;
817         
818         return True;
819 }
820
821
822 /*******************************************************************
823  Stream a null-terminated string.  len is strlen, and therefore does
824  not include the null-termination character.
825  ********************************************************************/
826
827 BOOL prs_string(char *name, prs_struct *ps, int depth, char *str, int len, int max_buf_size)
828 {
829         char *q;
830         uint8 *start;
831         int i;
832
833         len = MIN(len, (max_buf_size-1));
834
835         q = prs_mem_get(ps, len+1);
836         if (q == NULL)
837                 return False;
838
839         start = (uint8*)q;
840
841         for(i = 0; i < len; i++) {
842                 RW_CVAL(ps->io, q, str[i],0);
843                 q++;
844         }
845
846         /* The terminating null. */
847         str[i] = '\0';
848
849         if (MARSHALLING(ps)) {
850                 RW_CVAL(ps->io, q, str[i], 0);
851         }
852
853         ps->data_offset += len+1;
854
855         dump_data(5+depth, (char *)start, len);
856
857         return True;
858 }
859
860 /*******************************************************************
861  prs_uint16 wrapper. Call this and it sets up a pointer to where the
862  uint16 should be stored, or gets the size if reading.
863  ********************************************************************/
864
865 BOOL prs_uint16_pre(char *name, prs_struct *ps, int depth, uint16 *data16, uint32 *offset)
866 {
867         *offset = ps->data_offset;
868         if (UNMARSHALLING(ps)) {
869                 /* reading. */
870                 return prs_uint16(name, ps, depth, data16);
871         } else {
872                 char *q = prs_mem_get(ps, sizeof(uint16));
873                 if(q ==NULL)
874                         return False;
875                 ps->data_offset += sizeof(uint16);
876         }
877         return True;
878 }
879
880 /*******************************************************************
881  prs_uint16 wrapper.  call this and it retrospectively stores the size.
882  does nothing on reading, as that is already handled by ...._pre()
883  ********************************************************************/
884
885 BOOL prs_uint16_post(char *name, prs_struct *ps, int depth, uint16 *data16,
886                                 uint32 ptr_uint16, uint32 start_offset)
887 {
888         if (MARSHALLING(ps)) {
889                 /* 
890                  * Writing - temporarily move the offset pointer.
891                  */
892                 uint16 data_size = ps->data_offset - start_offset;
893                 uint32 old_offset = ps->data_offset;
894
895                 ps->data_offset = ptr_uint16;
896                 if(!prs_uint16(name, ps, depth, &data_size)) {
897                         ps->data_offset = old_offset;
898                         return False;
899                 }
900                 ps->data_offset = old_offset;
901         } else {
902                 ps->data_offset = start_offset + (uint32)(*data16);
903         }
904         return True;
905 }
906
907 /*******************************************************************
908  prs_uint32 wrapper. Call this and it sets up a pointer to where the
909  uint32 should be stored, or gets the size if reading.
910  ********************************************************************/
911
912 BOOL prs_uint32_pre(char *name, prs_struct *ps, int depth, uint32 *data32, uint32 *offset)
913 {
914         *offset = ps->data_offset;
915         if (UNMARSHALLING(ps) && (data32 != NULL)) {
916                 /* reading. */
917                 return prs_uint32(name, ps, depth, data32);
918         } else {
919                 ps->data_offset += sizeof(uint32);
920         }
921         return True;
922 }
923
924 /*******************************************************************
925  prs_uint32 wrapper.  call this and it retrospectively stores the size.
926  does nothing on reading, as that is already handled by ...._pre()
927  ********************************************************************/
928
929 BOOL prs_uint32_post(char *name, prs_struct *ps, int depth, uint32 *data32,
930                                 uint32 ptr_uint32, uint32 data_size)
931 {
932         if (MARSHALLING(ps)) {
933                 /* 
934                  * Writing - temporarily move the offset pointer.
935                  */
936                 uint32 old_offset = ps->data_offset;
937                 ps->data_offset = ptr_uint32;
938                 if(!prs_uint32(name, ps, depth, &data_size)) {
939                         ps->data_offset = old_offset;
940                         return False;
941                 }
942                 ps->data_offset = old_offset;
943         }
944         return True;
945 }
946
947 /* useful function to store a structure in rpc wire format */
948 int tdb_prs_store(TDB_CONTEXT *tdb, char *keystr, prs_struct *ps)
949 {
950     TDB_DATA kbuf, dbuf;
951     kbuf.dptr = keystr;
952     kbuf.dsize = strlen(keystr)+1;
953     dbuf.dptr = prs_data_p(ps);
954     dbuf.dsize = prs_offset(ps);
955     return tdb_store(tdb, kbuf, dbuf, TDB_REPLACE);
956 }
957
958 /* useful function to fetch a structure into rpc wire format */
959 int tdb_prs_fetch(TDB_CONTEXT *tdb, char *keystr, prs_struct *ps, TALLOC_CTX *mem_ctx)
960 {
961     TDB_DATA kbuf, dbuf;
962     kbuf.dptr = keystr;
963     kbuf.dsize = strlen(keystr)+1;
964
965     dbuf = tdb_fetch(tdb, kbuf);
966     if (!dbuf.dptr) return -1;
967
968     ZERO_STRUCTP(ps);
969     prs_init(ps, 0, 4, mem_ctx, UNMARSHALL);
970     prs_give_memory(ps, dbuf.dptr, dbuf.dsize, True);
971
972     return 0;
973