add WITH_SENDFILE profiling data (from Pierre Belanger)
[Samba.git] / source / rpc_parse / parse_prs.c
blobc983903f767f65d12a2aba7e37590773157c21fb
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.
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 #include "includes.h"
26 /*******************************************************************
27 dump a prs to a file
28 ********************************************************************/
29 void prs_dump(char *name, int v, prs_struct *ps)
31 int fd, i;
32 pstring fname;
33 if (DEBUGLEVEL < 50) return;
34 for (i=1;i<100;i++) {
35 if (v != -1) {
36 slprintf(fname,sizeof(fname)-1, "/tmp/%s_%d.%d.prs", name, v, i);
37 } else {
38 slprintf(fname,sizeof(fname)-1, "/tmp/%s.%d.prs", name, i);
40 fd = open(fname, O_WRONLY|O_CREAT|O_EXCL, 0644);
41 if (fd != -1 || errno != EEXIST) break;
43 if (fd != -1) {
44 write(fd, ps->data_p + ps->data_offset, ps->buffer_size - ps->data_offset);
45 close(fd);
46 DEBUG(0,("created %s\n", fname));
52 /*******************************************************************
53 debug output for parsing info.
55 XXXX side-effect of this function is to increase the debug depth XXXX
57 ********************************************************************/
58 void prs_debug(prs_struct *ps, int depth, char *desc, char *fn_name)
60 DEBUG(5+depth, ("%s%06x %s %s\n", tab_depth(depth), ps->data_offset, fn_name, desc));
64 /**
65 * Initialise an expandable parse structure.
67 * @param size Initial buffer size. If >0, a new buffer will be
68 * created with malloc().
70 * @return False if allocation fails, otherwise True.
71 **/
72 BOOL prs_init(prs_struct *ps, uint32 size, TALLOC_CTX *ctx, BOOL io)
74 ZERO_STRUCTP(ps);
75 ps->io = io;
76 ps->bigendian_data = RPC_LITTLE_ENDIAN;
77 ps->align = RPC_PARSE_ALIGN;
78 ps->is_dynamic = False;
79 ps->data_offset = 0;
80 ps->buffer_size = 0;
81 ps->data_p = NULL;
82 ps->mem_ctx = ctx;
84 if (size != 0) {
85 ps->buffer_size = size;
86 if((ps->data_p = (char *)malloc((size_t)size)) == NULL) {
87 DEBUG(0,("prs_init: malloc fail for %u bytes.\n", (unsigned int)size));
88 return False;
90 memset(ps->data_p, '\0', (size_t)size);
91 ps->is_dynamic = True; /* We own this memory. */
94 return True;
97 /*******************************************************************
98 read from a socket into memory.
99 ********************************************************************/
100 BOOL prs_read(prs_struct *ps, int fd, size_t len, int timeout)
102 BOOL ok;
103 size_t prev_size = ps->buffer_size;
104 if (!prs_grow(ps, len))
105 return False;
107 if (timeout > 0) {
108 ok = (read_with_timeout(fd, &ps->data_p[prev_size],
109 len, len,timeout) == len);
110 } else {
111 ok = (read_data(fd, &ps->data_p[prev_size], len) == len);
113 return ok;
116 /*******************************************************************
117 Delete the memory in a parse structure - if we own it.
118 ********************************************************************/
120 void prs_mem_free(prs_struct *ps)
122 if(ps->is_dynamic)
123 SAFE_FREE(ps->data_p);
124 ps->is_dynamic = False;
125 ps->buffer_size = 0;
126 ps->data_offset = 0;
129 /*******************************************************************
130 Clear the memory in a parse structure.
131 ********************************************************************/
133 void prs_mem_clear(prs_struct *ps)
135 memset(ps->data_p, '\0', (size_t)ps->buffer_size);
138 /*******************************************************************
139 Allocate memory when unmarshalling... Always zero clears.
140 ********************************************************************/
142 char *prs_alloc_mem(prs_struct *ps, size_t size)
144 char *ret = talloc(ps->mem_ctx, size);
146 if (ret)
147 memset(ret, '\0', size);
149 return ret;
152 /*******************************************************************
153 Return the current talloc context we're using.
154 ********************************************************************/
156 TALLOC_CTX *prs_get_mem_context(prs_struct *ps)
158 return ps->mem_ctx;
161 /*******************************************************************
162 Hand some already allocated memory to a prs_struct.
163 ********************************************************************/
165 void prs_give_memory(prs_struct *ps, char *buf, uint32 size, BOOL is_dynamic)
167 ps->is_dynamic = is_dynamic;
168 ps->data_p = buf;
169 ps->buffer_size = size;
172 /*******************************************************************
173 Take some memory back from a prs_struct.
174 ********************************************************************/
176 char *prs_take_memory(prs_struct *ps, uint32 *psize)
178 char *ret = ps->data_p;
179 if(psize)
180 *psize = ps->buffer_size;
181 ps->is_dynamic = False;
182 prs_mem_free(ps);
183 return ret;
186 /*******************************************************************
187 Set a prs_struct to exactly a given size. Will grow or tuncate if neccessary.
188 ********************************************************************/
190 BOOL prs_set_buffer_size(prs_struct *ps, uint32 newsize)
192 if (newsize > ps->buffer_size)
193 return prs_force_grow(ps, newsize - ps->buffer_size);
195 if (newsize < ps->buffer_size) {
196 char *new_data_p = Realloc(ps->data_p, newsize);
197 /* if newsize is zero, Realloc acts like free() & returns NULL*/
198 if (new_data_p == NULL && newsize != 0) {
199 DEBUG(0,("prs_set_buffer_size: Realloc failure for size %u.\n",
200 (unsigned int)newsize));
201 DEBUG(0,("prs_set_buffer_size: Reason %s\n",strerror(errno)));
202 return False;
204 ps->data_p = new_data_p;
205 ps->buffer_size = newsize;
208 return True;
211 /*******************************************************************
212 Attempt, if needed, to grow a data buffer.
213 Also depends on the data stream mode (io).
214 ********************************************************************/
216 BOOL prs_grow(prs_struct *ps, uint32 extra_space)
218 uint32 new_size;
219 char *new_data;
221 ps->grow_size = MAX(ps->grow_size, ps->data_offset + extra_space);
223 if(ps->data_offset + extra_space <= ps->buffer_size)
224 return True;
227 * We cannot grow the buffer if we're not reading
228 * into the prs_struct, or if we don't own the memory.
231 if(UNMARSHALLING(ps) || !ps->is_dynamic) {
232 DEBUG(0,("prs_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
233 (unsigned int)extra_space));
234 return False;
238 * Decide how much extra space we really need.
241 extra_space -= (ps->buffer_size - ps->data_offset);
242 if(ps->buffer_size == 0) {
244 * Ensure we have at least a PDU's length, or extra_space, whichever
245 * is greater.
248 new_size = MAX(MAX_PDU_FRAG_LEN,extra_space);
250 if((new_data = malloc(new_size)) == NULL) {
251 DEBUG(0,("prs_grow: Malloc failure for size %u.\n", (unsigned int)new_size));
252 return False;
254 memset(new_data, '\0', (size_t)new_size );
255 } else {
257 * If the current buffer size is bigger than the space needed, just
258 * double it, else add extra_space.
260 new_size = MAX(ps->buffer_size*2, ps->buffer_size + extra_space);
262 if ((new_data = Realloc(ps->data_p, new_size)) == NULL) {
263 DEBUG(0,("prs_grow: Realloc failure for size %u.\n",
264 (unsigned int)new_size));
265 return False;
268 memset(&new_data[ps->buffer_size], '\0', (size_t)(new_size - ps->buffer_size));
270 ps->buffer_size = new_size;
271 ps->data_p = new_data;
273 return True;
276 /*******************************************************************
277 Attempt to force a data buffer to grow by len bytes.
278 This is only used when appending more data onto a prs_struct
279 when reading an rpc reply, before unmarshalling it.
280 ********************************************************************/
282 BOOL prs_force_grow(prs_struct *ps, uint32 extra_space)
284 uint32 new_size = ps->buffer_size + extra_space;
285 char *new_data;
287 if(!UNMARSHALLING(ps) || !ps->is_dynamic) {
288 DEBUG(0,("prs_force_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
289 (unsigned int)extra_space));
290 return False;
293 if((new_data = Realloc(ps->data_p, new_size)) == NULL) {
294 DEBUG(0,("prs_force_grow: Realloc failure for size %u.\n",
295 (unsigned int)new_size));
296 return False;
299 memset(&new_data[ps->buffer_size], '\0', (size_t)(new_size - ps->buffer_size));
301 ps->buffer_size = new_size;
302 ps->data_p = new_data;
304 return True;
307 /*******************************************************************
308 Get the data pointer (external interface).
309 ********************************************************************/
311 char *prs_data_p(prs_struct *ps)
313 return ps->data_p;
316 /*******************************************************************
317 Get the current data size (external interface).
318 ********************************************************************/
320 uint32 prs_data_size(prs_struct *ps)
322 return ps->buffer_size;
325 /*******************************************************************
326 Fetch the current offset (external interface).
327 ********************************************************************/
329 uint32 prs_offset(prs_struct *ps)
331 return ps->data_offset;
334 /*******************************************************************
335 Set the current offset (external interface).
336 ********************************************************************/
338 BOOL prs_set_offset(prs_struct *ps, uint32 offset)
340 if(offset <= ps->data_offset) {
341 ps->data_offset = offset;
342 return True;
345 if(!prs_grow(ps, offset - ps->data_offset))
346 return False;
348 ps->data_offset = offset;
349 return True;
352 /*******************************************************************
353 Append the data from one parse_struct into another.
354 ********************************************************************/
356 BOOL prs_append_prs_data(prs_struct *dst, prs_struct *src)
358 if(!prs_grow(dst, prs_offset(src)))
359 return False;
361 memcpy(&dst->data_p[dst->data_offset], prs_data_p(src), (size_t)prs_offset(src));
362 dst->data_offset += prs_offset(src);
364 return True;
367 /*******************************************************************
368 Append some data from one parse_struct into another.
369 ********************************************************************/
371 BOOL prs_append_some_prs_data(prs_struct *dst, prs_struct *src, int32 start, uint32 len)
373 if (len == 0)
374 return True;
376 if(!prs_grow(dst, len))
377 return False;
379 memcpy(&dst->data_p[dst->data_offset], prs_data_p(src)+start, (size_t)len);
380 dst->data_offset += len;
382 return True;
385 /*******************************************************************
386 Append the data from a buffer into a parse_struct.
387 ********************************************************************/
389 BOOL prs_append_data(prs_struct *dst, char *src, uint32 len)
391 if(!prs_grow(dst, len))
392 return False;
394 memcpy(&dst->data_p[dst->data_offset], src, (size_t)len);
395 dst->data_offset += len;
397 return True;
400 /*******************************************************************
401 Set the data as X-endian (external interface).
402 ********************************************************************/
404 void prs_set_endian_data(prs_struct *ps, BOOL endian)
406 ps->bigendian_data = endian;
409 /*******************************************************************
410 Align a the data_len to a multiple of align bytes - filling with
411 zeros.
412 ********************************************************************/
414 BOOL prs_align(prs_struct *ps)
416 uint32 mod = ps->data_offset & (ps->align-1);
418 if (ps->align != 0 && mod != 0) {
419 uint32 extra_space = (ps->align - mod);
420 if(!prs_grow(ps, extra_space))
421 return False;
422 memset(&ps->data_p[ps->data_offset], '\0', (size_t)extra_space);
423 ps->data_offset += extra_space;
426 return True;
429 /******************************************************************
430 Align on a 2 byte boundary
431 *****************************************************************/
433 BOOL prs_align_uint16(prs_struct *ps)
435 BOOL ret;
436 uint8 old_align = ps->align;
438 ps->align = 2;
439 ret = prs_align(ps);
440 ps->align = old_align;
441 return ret;
444 /******************************************************************
445 Align on a 8 byte boundary
446 *****************************************************************/
448 BOOL prs_align_uint64(prs_struct *ps)
450 BOOL ret;
451 uint8 old_align = ps->align;
453 ps->align = 8;
454 ret = prs_align(ps);
455 ps->align = old_align;
456 return ret;
459 /*******************************************************************
460 Align only if required (for the unistr2 string mainly)
461 ********************************************************************/
463 BOOL prs_align_needed(prs_struct *ps, uint32 needed)
465 if (needed==0)
466 return True;
467 else
468 return prs_align(ps);
471 /*******************************************************************
472 Ensure we can read/write to a given offset.
473 ********************************************************************/
475 char *prs_mem_get(prs_struct *ps, uint32 extra_size)
477 if(UNMARSHALLING(ps)) {
479 * If reading, ensure that we can read the requested size item.
481 if (ps->data_offset + extra_size > ps->buffer_size) {
482 DEBUG(0,("prs_mem_get: reading data of size %u would overrun buffer.\n",
483 (unsigned int)extra_size ));
484 return NULL;
486 } else {
488 * Writing - grow the buffer if needed.
490 if(!prs_grow(ps, extra_size))
491 return NULL;
493 return &ps->data_p[ps->data_offset];
496 /*******************************************************************
497 Change the struct type.
498 ********************************************************************/
500 void prs_switch_type(prs_struct *ps, BOOL io)
502 if ((ps->io ^ io) == True)
503 ps->io=io;
506 /*******************************************************************
507 Force a prs_struct to be dynamic even when it's size is 0.
508 ********************************************************************/
510 void prs_force_dynamic(prs_struct *ps)
512 ps->is_dynamic=True;
515 /*******************************************************************
516 Stream a uint8.
517 ********************************************************************/
519 BOOL prs_uint8(char *name, prs_struct *ps, int depth, uint8 *data8)
521 char *q = prs_mem_get(ps, 1);
522 if (q == NULL)
523 return False;
525 if (UNMARSHALLING(ps))
526 *data8 = CVAL(q,0);
527 else
528 SCVAL(q,0,*data8);
530 DEBUG(5,("%s%04x %s: %02x\n", tab_depth(depth), ps->data_offset, name, *data8));
532 ps->data_offset += 1;
534 return True;
537 /*******************************************************************
538 Stream a uint16.
539 ********************************************************************/
541 BOOL prs_uint16(char *name, prs_struct *ps, int depth, uint16 *data16)
543 char *q = prs_mem_get(ps, sizeof(uint16));
544 if (q == NULL)
545 return False;
547 if (UNMARSHALLING(ps)) {
548 if (ps->bigendian_data)
549 *data16 = RSVAL(q,0);
550 else
551 *data16 = SVAL(q,0);
552 } else {
553 if (ps->bigendian_data)
554 RSSVAL(q,0,*data16);
555 else
556 SSVAL(q,0,*data16);
559 DEBUG(5,("%s%04x %s: %04x\n", tab_depth(depth), ps->data_offset, name, *data16));
561 ps->data_offset += sizeof(uint16);
563 return True;
566 /*******************************************************************
567 Stream a uint32.
568 ********************************************************************/
570 BOOL prs_uint32(char *name, prs_struct *ps, int depth, uint32 *data32)
572 char *q = prs_mem_get(ps, sizeof(uint32));
573 if (q == NULL)
574 return False;
576 if (UNMARSHALLING(ps)) {
577 if (ps->bigendian_data)
578 *data32 = RIVAL(q,0);
579 else
580 *data32 = IVAL(q,0);
581 } else {
582 if (ps->bigendian_data)
583 RSIVAL(q,0,*data32);
584 else
585 SIVAL(q,0,*data32);
588 DEBUG(5,("%s%04x %s: %08x\n", tab_depth(depth), ps->data_offset, name, *data32));
590 ps->data_offset += sizeof(uint32);
592 return True;
595 /*******************************************************************
596 Stream a NTSTATUS
597 ********************************************************************/
599 BOOL prs_ntstatus(char *name, prs_struct *ps, int depth, NTSTATUS *status)
601 char *q = prs_mem_get(ps, sizeof(uint32));
602 if (q == NULL)
603 return False;
605 if (UNMARSHALLING(ps)) {
606 if (ps->bigendian_data)
607 *status = NT_STATUS(RIVAL(q,0));
608 else
609 *status = NT_STATUS(IVAL(q,0));
610 } else {
611 if (ps->bigendian_data)
612 RSIVAL(q,0,NT_STATUS_V(*status));
613 else
614 SIVAL(q,0,NT_STATUS_V(*status));
617 DEBUG(5,("%s%04x %s: %s\n", tab_depth(depth), ps->data_offset, name,
618 get_nt_error_msg(*status)));
620 ps->data_offset += sizeof(uint32);
622 return True;
625 /*******************************************************************
626 Stream a WERROR
627 ********************************************************************/
629 BOOL prs_werror(char *name, prs_struct *ps, int depth, WERROR *status)
631 char *q = prs_mem_get(ps, sizeof(uint32));
632 if (q == NULL)
633 return False;
635 if (UNMARSHALLING(ps)) {
636 if (ps->bigendian_data)
637 *status = W_ERROR(RIVAL(q,0));
638 else
639 *status = W_ERROR(IVAL(q,0));
640 } else {
641 if (ps->bigendian_data)
642 RSIVAL(q,0,W_ERROR_V(*status));
643 else
644 SIVAL(q,0,W_ERROR_V(*status));
647 DEBUG(5,("%s%04x %s: %s\n", tab_depth(depth), ps->data_offset, name,
648 dos_errstr(*status)));
650 ps->data_offset += sizeof(uint32);
652 return True;
656 /******************************************************************
657 Stream an array of uint8s. Length is number of uint8s.
658 ********************************************************************/
660 BOOL prs_uint8s(BOOL charmode, char *name, prs_struct *ps, int depth, uint8 *data8s, int len)
662 int i;
663 char *q = prs_mem_get(ps, len);
664 if (q == NULL)
665 return False;
667 if (UNMARSHALLING(ps)) {
668 for (i = 0; i < len; i++)
669 data8s[i] = CVAL(q,i);
670 } else {
671 for (i = 0; i < len; i++)
672 SCVAL(q, i, data8s[i]);
675 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset ,name));
676 if (charmode)
677 print_asc(5, (unsigned char*)data8s, len);
678 else {
679 for (i = 0; i < len; i++)
680 DEBUG(5,("%02x ", data8s[i]));
682 DEBUG(5,("\n"));
684 ps->data_offset += len;
686 return True;
689 /******************************************************************
690 Stream an array of uint16s. Length is number of uint16s.
691 ********************************************************************/
693 BOOL prs_uint16s(BOOL charmode, char *name, prs_struct *ps, int depth, uint16 *data16s, int len)
695 int i;
696 char *q = prs_mem_get(ps, len * sizeof(uint16));
697 if (q == NULL)
698 return False;
700 if (UNMARSHALLING(ps)) {
701 if (ps->bigendian_data) {
702 for (i = 0; i < len; i++)
703 data16s[i] = RSVAL(q, 2*i);
704 } else {
705 for (i = 0; i < len; i++)
706 data16s[i] = SVAL(q, 2*i);
708 } else {
709 if (ps->bigendian_data) {
710 for (i = 0; i < len; i++)
711 RSSVAL(q, 2*i, data16s[i]);
712 } else {
713 for (i = 0; i < len; i++)
714 SSVAL(q, 2*i, data16s[i]);
718 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
719 if (charmode)
720 print_asc(5, (unsigned char*)data16s, 2*len);
721 else {
722 for (i = 0; i < len; i++)
723 DEBUG(5,("%04x ", data16s[i]));
725 DEBUG(5,("\n"));
727 ps->data_offset += (len * sizeof(uint16));
729 return True;
732 /******************************************************************
733 Start using a function for streaming unicode chars. If unmarshalling,
734 output must be little-endian, if marshalling, input must be little-endian.
735 ********************************************************************/
737 static void dbg_rw_punival(BOOL charmode, char *name, int depth, prs_struct *ps,
738 char *in_buf, char *out_buf, int len)
740 int i;
742 if (UNMARSHALLING(ps)) {
743 if (ps->bigendian_data) {
744 for (i = 0; i < len; i++)
745 SSVAL(out_buf,2*i,RSVAL(in_buf, 2*i));
746 } else {
747 for (i = 0; i < len; i++)
748 SSVAL(out_buf, 2*i, SVAL(in_buf, 2*i));
750 } else {
751 if (ps->bigendian_data) {
752 for (i = 0; i < len; i++)
753 RSSVAL(in_buf, 2*i, SVAL(out_buf,2*i));
754 } else {
755 for (i = 0; i < len; i++)
756 SSVAL(in_buf, 2*i, SVAL(out_buf,2*i));
760 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
761 if (charmode)
762 print_asc(5, (unsigned char*)out_buf, 2*len);
763 else {
764 for (i = 0; i < len; i++)
765 DEBUG(5,("%04x ", out_buf[i]));
767 DEBUG(5,("\n"));
770 /******************************************************************
771 Stream a unistr. Always little endian.
772 ********************************************************************/
774 BOOL prs_uint16uni(BOOL charmode, char *name, prs_struct *ps, int depth, uint16 *data16s, int len)
776 char *q = prs_mem_get(ps, len * sizeof(uint16));
777 if (q == NULL)
778 return False;
780 dbg_rw_punival(charmode, name, depth, ps, q, (char *)data16s, len);
781 ps->data_offset += (len * sizeof(uint16));
783 return True;
786 /******************************************************************
787 Stream an array of uint32s. Length is number of uint32s.
788 ********************************************************************/
790 BOOL prs_uint32s(BOOL charmode, char *name, prs_struct *ps, int depth, uint32 *data32s, int len)
792 int i;
793 char *q = prs_mem_get(ps, len * sizeof(uint32));
794 if (q == NULL)
795 return False;
797 if (UNMARSHALLING(ps)) {
798 if (ps->bigendian_data) {
799 for (i = 0; i < len; i++)
800 data32s[i] = RIVAL(q, 4*i);
801 } else {
802 for (i = 0; i < len; i++)
803 data32s[i] = IVAL(q, 4*i);
805 } else {
806 if (ps->bigendian_data) {
807 for (i = 0; i < len; i++)
808 RSIVAL(q, 4*i, data32s[i]);
809 } else {
810 for (i = 0; i < len; i++)
811 SIVAL(q, 4*i, data32s[i]);
815 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
816 if (charmode)
817 print_asc(5, (unsigned char*)data32s, 4*len);
818 else {
819 for (i = 0; i < len; i++)
820 DEBUG(5,("%08x ", data32s[i]));
822 DEBUG(5,("\n"));
824 ps->data_offset += (len * sizeof(uint32));
826 return True;
829 /******************************************************************
830 Stream an array of unicode string, length/buffer specified separately,
831 in uint16 chars. The unicode string is already in little-endian format.
832 ********************************************************************/
834 BOOL prs_buffer5(BOOL charmode, char *name, prs_struct *ps, int depth, BUFFER5 *str)
836 char *p;
837 char *q = prs_mem_get(ps, str->buf_len * sizeof(uint16));
838 if (q == NULL)
839 return False;
841 if (UNMARSHALLING(ps)) {
842 str->buffer = (uint16 *)prs_alloc_mem(ps,str->buf_len * sizeof(uint16));
843 if (str->buffer == NULL)
844 return False;
847 /* If the string is empty, we don't have anything to stream */
848 if (str->buf_len==0)
849 return True;
851 p = (char *)str->buffer;
853 dbg_rw_punival(charmode, name, depth, ps, q, p, str->buf_len);
855 ps->data_offset += (str->buf_len * sizeof(uint16));
857 return True;
860 /******************************************************************
861 Stream a "not" unicode string, length/buffer specified separately,
862 in byte chars. String is in little-endian format.
863 ********************************************************************/
865 BOOL prs_buffer2(BOOL charmode, char *name, prs_struct *ps, int depth, BUFFER2 *str)
867 char *p;
868 char *q = prs_mem_get(ps, str->buf_len);
869 if (q == NULL)
870 return False;
872 if (UNMARSHALLING(ps)) {
873 str->buffer = (uint16 *)prs_alloc_mem(ps,str->buf_len);
874 if (str->buffer == NULL)
875 return False;
878 p = (char *)str->buffer;
880 dbg_rw_punival(charmode, name, depth, ps, q, p, str->buf_len/2);
881 ps->data_offset += str->buf_len;
883 return True;
886 /******************************************************************
887 Stream a string, length/buffer specified separately,
888 in uint8 chars.
889 ********************************************************************/
891 BOOL prs_string2(BOOL charmode, char *name, prs_struct *ps, int depth, STRING2 *str)
893 int i;
894 char *q = prs_mem_get(ps, str->str_max_len);
895 if (q == NULL)
896 return False;
898 if (UNMARSHALLING(ps)) {
899 str->buffer = (unsigned char *)prs_alloc_mem(ps,str->str_max_len);
900 if (str->buffer == NULL)
901 return False;
904 if (UNMARSHALLING(ps)) {
905 for (i = 0; i < str->str_str_len; i++)
906 str->buffer[i] = CVAL(q,i);
907 } else {
908 for (i = 0; i < str->str_str_len; i++)
909 SCVAL(q, i, str->buffer[i]);
912 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
913 if (charmode)
914 print_asc(5, (unsigned char*)str->buffer, str->str_str_len);
915 else {
916 for (i = 0; i < str->str_str_len; i++)
917 DEBUG(5,("%02x ", str->buffer[i]));
919 DEBUG(5,("\n"));
921 ps->data_offset += str->str_str_len;
923 return True;
926 /******************************************************************
927 Stream a unicode string, length/buffer specified separately,
928 in uint16 chars. The unicode string is already in little-endian format.
929 ********************************************************************/
931 BOOL prs_unistr2(BOOL charmode, char *name, prs_struct *ps, int depth, UNISTR2 *str)
933 char *p;
934 char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
935 if (q == NULL)
936 return False;
938 /* If the string is empty, we don't have anything to stream */
939 if (str->uni_str_len==0)
940 return True;
942 if (UNMARSHALLING(ps)) {
943 str->buffer = (uint16 *)prs_alloc_mem(ps,str->uni_max_len * sizeof(uint16));
944 if (str->buffer == NULL)
945 return False;
948 p = (char *)str->buffer;
950 dbg_rw_punival(charmode, name, depth, ps, q, p, str->uni_str_len);
952 ps->data_offset += (str->uni_str_len * sizeof(uint16));
954 return True;
957 /******************************************************************
958 Stream a unicode string, length/buffer specified separately,
959 in uint16 chars. The unicode string is already in little-endian format.
960 ********************************************************************/
962 BOOL prs_unistr3(BOOL charmode, char *name, UNISTR3 *str, prs_struct *ps, int depth)
964 char *p;
965 char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
966 if (q == NULL)
967 return False;
969 if (UNMARSHALLING(ps)) {
970 str->str.buffer = (uint16 *)prs_alloc_mem(ps,str->uni_str_len * sizeof(uint16));
971 if (str->str.buffer == NULL)
972 return False;
975 p = (char *)str->str.buffer;
977 dbg_rw_punival(charmode, name, depth, ps, q, p, str->uni_str_len);
978 ps->data_offset += (str->uni_str_len * sizeof(uint16));
980 return True;
983 /*******************************************************************
984 Stream a unicode null-terminated string. As the string is already
985 in little-endian format then do it as a stream of bytes.
986 ********************************************************************/
988 BOOL prs_unistr(char *name, prs_struct *ps, int depth, UNISTR *str)
990 int len = 0;
991 unsigned char *p = (unsigned char *)str->buffer;
992 uint8 *start;
993 char *q;
994 uint32 max_len;
995 uint16* ptr;
997 if (MARSHALLING(ps)) {
999 for(len = 0; str->buffer[len] != 0; len++)
1002 q = prs_mem_get(ps, (len+1)*2);
1003 if (q == NULL)
1004 return False;
1006 start = (uint8*)q;
1008 for(len = 0; str->buffer[len] != 0; len++)
1010 if(ps->bigendian_data)
1012 /* swap bytes - p is little endian, q is big endian. */
1013 q[0] = (char)p[1];
1014 q[1] = (char)p[0];
1015 p += 2;
1016 q += 2;
1018 else
1020 q[0] = (char)p[0];
1021 q[1] = (char)p[1];
1022 p += 2;
1023 q += 2;
1028 * even if the string is 'empty' (only an \0 char)
1029 * at this point the leading \0 hasn't been parsed.
1030 * so parse it now
1033 q[0] = 0;
1034 q[1] = 0;
1035 q += 2;
1037 len++;
1039 dump_data(5+depth, (char *)start, len * 2);
1041 else { /* unmarshalling */
1043 uint32 alloc_len = 0;
1044 q = prs_data_p(ps) + prs_offset(ps);
1047 * Work out how much space we need and talloc it.
1049 max_len = (ps->buffer_size - ps->data_offset)/sizeof(uint16);
1051 /* the test of the value of *ptr helps to catch the circumstance
1052 where we have an emtpty (non-existent) string in the buffer */
1053 for ( ptr = (uint16 *)q; *ptr && (alloc_len <= max_len); alloc_len++)
1054 /* do nothing */
1057 /* should we allocate anything at all? */
1058 str->buffer = (uint16 *)prs_alloc_mem(ps,alloc_len * sizeof(uint16));
1059 if ((str->buffer == NULL) && (alloc_len > 0))
1060 return False;
1062 p = (unsigned char *)str->buffer;
1064 len = 0;
1065 /* the (len < alloc_len) test is to prevent us from overwriting
1066 memory that is not ours...if we get that far, we have a non-null
1067 terminated string in the buffer and have messed up somewhere */
1068 while ((len < alloc_len) && (*(uint16 *)q != 0))
1070 if(ps->bigendian_data)
1072 /* swap bytes - q is big endian, p is little endian. */
1073 p[0] = (unsigned char)q[1];
1074 p[1] = (unsigned char)q[0];
1075 p += 2;
1076 q += 2;
1077 } else {
1079 p[0] = (unsigned char)q[0];
1080 p[1] = (unsigned char)q[1];
1081 p += 2;
1082 q += 2;
1085 len++;
1087 if (len < alloc_len)
1089 /* NULL terminate the UNISTR */
1090 str->buffer[len++] = '\0';
1094 /* set the offset in the prs_struct; 'len' points to the
1095 terminiating NULL in the UNISTR so we need to go one more
1096 uint16 */
1097 ps->data_offset += (len)*2;
1099 return True;
1103 /*******************************************************************
1104 Stream a null-terminated string. len is strlen, and therefore does
1105 not include the null-termination character.
1106 ********************************************************************/
1108 BOOL prs_string(char *name, prs_struct *ps, int depth, char *str, int len, int max_buf_size)
1110 char *q;
1111 int i;
1113 len = MIN(len, (max_buf_size-1));
1115 q = prs_mem_get(ps, len+1);
1116 if (q == NULL)
1117 return False;
1119 for(i = 0; i < len; i++) {
1120 if (UNMARSHALLING(ps))
1121 str[i] = q[i];
1122 else
1123 q[i] = str[i];
1126 /* The terminating null. */
1127 str[i] = '\0';
1129 if (MARSHALLING(ps)) {
1130 q[i] = '\0';
1133 ps->data_offset += len+1;
1135 dump_data(5+depth, q, len);
1137 return True;
1140 /*******************************************************************
1141 prs_uint16 wrapper. Call this and it sets up a pointer to where the
1142 uint16 should be stored, or gets the size if reading.
1143 ********************************************************************/
1145 BOOL prs_uint16_pre(char *name, prs_struct *ps, int depth, uint16 *data16, uint32 *offset)
1147 *offset = ps->data_offset;
1148 if (UNMARSHALLING(ps)) {
1149 /* reading. */
1150 return prs_uint16(name, ps, depth, data16);
1151 } else {
1152 char *q = prs_mem_get(ps, sizeof(uint16));
1153 if(q ==NULL)
1154 return False;
1155 ps->data_offset += sizeof(uint16);
1157 return True;
1160 /*******************************************************************
1161 prs_uint16 wrapper. call this and it retrospectively stores the size.
1162 does nothing on reading, as that is already handled by ...._pre()
1163 ********************************************************************/
1165 BOOL prs_uint16_post(char *name, prs_struct *ps, int depth, uint16 *data16,
1166 uint32 ptr_uint16, uint32 start_offset)
1168 if (MARSHALLING(ps)) {
1170 * Writing - temporarily move the offset pointer.
1172 uint16 data_size = ps->data_offset - start_offset;
1173 uint32 old_offset = ps->data_offset;
1175 ps->data_offset = ptr_uint16;
1176 if(!prs_uint16(name, ps, depth, &data_size)) {
1177 ps->data_offset = old_offset;
1178 return False;
1180 ps->data_offset = old_offset;
1181 } else {
1182 ps->data_offset = start_offset + (uint32)(*data16);
1184 return True;
1187 /*******************************************************************
1188 prs_uint32 wrapper. Call this and it sets up a pointer to where the
1189 uint32 should be stored, or gets the size if reading.
1190 ********************************************************************/
1192 BOOL prs_uint32_pre(char *name, prs_struct *ps, int depth, uint32 *data32, uint32 *offset)
1194 *offset = ps->data_offset;
1195 if (UNMARSHALLING(ps) && (data32 != NULL)) {
1196 /* reading. */
1197 return prs_uint32(name, ps, depth, data32);
1198 } else {
1199 ps->data_offset += sizeof(uint32);
1201 return True;
1204 /*******************************************************************
1205 prs_uint32 wrapper. call this and it retrospectively stores the size.
1206 does nothing on reading, as that is already handled by ...._pre()
1207 ********************************************************************/
1209 BOOL prs_uint32_post(char *name, prs_struct *ps, int depth, uint32 *data32,
1210 uint32 ptr_uint32, uint32 data_size)
1212 if (MARSHALLING(ps)) {
1214 * Writing - temporarily move the offset pointer.
1216 uint32 old_offset = ps->data_offset;
1217 ps->data_offset = ptr_uint32;
1218 if(!prs_uint32(name, ps, depth, &data_size)) {
1219 ps->data_offset = old_offset;
1220 return False;
1222 ps->data_offset = old_offset;
1224 return True;
1227 /* useful function to store a structure in rpc wire format */
1228 int tdb_prs_store(TDB_CONTEXT *tdb, char *keystr, prs_struct *ps)
1230 TDB_DATA kbuf, dbuf;
1231 kbuf.dptr = keystr;
1232 kbuf.dsize = strlen(keystr)+1;
1233 dbuf.dptr = prs_data_p(ps);
1234 dbuf.dsize = prs_offset(ps);
1235 return tdb_store(tdb, kbuf, dbuf, TDB_REPLACE);
1238 /* useful function to fetch a structure into rpc wire format */
1239 int tdb_prs_fetch(TDB_CONTEXT *tdb, char *keystr, prs_struct *ps, TALLOC_CTX *mem_ctx)
1241 TDB_DATA kbuf, dbuf;
1242 kbuf.dptr = keystr;
1243 kbuf.dsize = strlen(keystr)+1;
1245 dbuf = tdb_fetch(tdb, kbuf);
1246 if (!dbuf.dptr) return -1;
1248 ZERO_STRUCTP(ps);
1249 prs_init(ps, 0, mem_ctx, UNMARSHALL);
1250 prs_give_memory(ps, dbuf.dptr, dbuf.dsize, True);
1252 return 0;
1255 /*******************************************************************
1256 hash a stream.
1257 ********************************************************************/
1258 BOOL prs_hash1(prs_struct *ps, uint32 offset, uint8 sess_key[16])
1260 char *q;
1262 q = prs_data_p(ps);
1263 q = &q[offset];
1265 #ifdef DEBUG_PASSWORD
1266 DEBUG(100, ("prs_hash1\n"));
1267 dump_data(100, sess_key, 16);
1268 dump_data(100, q, 68);
1269 #endif
1270 SamOEMhash((uchar *) q, sess_key, 68);
1272 #ifdef DEBUG_PASSWORD
1273 dump_data(100, q, 68);
1274 #endif
1276 return True;