source3/registry/reg_parse_prs.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB parameters and setup
   4    Copyright (C) Andrew Tridgell 1992-1997
   5    Copyright (C) Luke Kenneth Casson Leighton 1996-1997
   6    Copyright (C) Paul Ashton 1997
   7    Copyright (C) Jeremy Allison 2000-2004
   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 3 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, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #ifndef _REG_PARSE_PRS_H_
  24 #define _REG_PARSE_PRS_H_
  25
  26
  27 #define prs_init_empty( _ps_, _ctx_, _io_ ) (void) prs_init((_ps_), 0, (_ctx_), (_io_))
  28
  29 typedef struct _prs_struct {
  30         bool io; /* parsing in or out of data stream */
  31         /*
  32          * If the (incoming) data is big-endian. On output we are
  33          * always little-endian.
  34          */
  35         bool bigendian_data;
  36         uint8 align; /* data alignment */
  37         bool is_dynamic; /* Do we own this memory or not ? */
  38         uint32 data_offset; /* Current working offset into data. */
  39         uint32 buffer_size; /* Current allocated size of the buffer. */
  40         uint32 grow_size; /* size requested via prs_grow() calls */
  41         /* The buffer itself. If "is_dynamic" is true this
  42          * MUST BE TALLOC'ed off mem_ctx. */
  43         char *data_p;
  44         TALLOC_CTX *mem_ctx; /* When unmarshalling, use this.... */
  45 } prs_struct;
  46
  47 /*
  48  * Defines for io member of prs_struct.
  49  */
  50
  51 #define MARSHALL 0
  52 #define UNMARSHALL 1
  53
  54 #define MARSHALLING(ps) (!(ps)->io)
  55 #define UNMARSHALLING(ps) ((ps)->io)
  56
  57 #define RPC_PARSE_ALIGN 4
  58
  59 void prs_debug(prs_struct *ps, int depth, const char *desc, const char *fn_name);
  60 bool prs_init(prs_struct *ps, uint32 size, TALLOC_CTX *ctx, bool io);
  61 void prs_mem_free(prs_struct *ps);
  62 void prs_mem_clear(prs_struct *ps);
  63 char *prs_alloc_mem_(prs_struct *ps, size_t size, unsigned int count);
  64 char *prs_alloc_mem(prs_struct *ps, size_t size, unsigned int count);
  65 TALLOC_CTX *prs_get_mem_context(prs_struct *ps);
  66 void prs_give_memory(prs_struct *ps, char *buf, uint32 size, bool is_dynamic);
  67 bool prs_set_buffer_size(prs_struct *ps, uint32 newsize);
  68 bool prs_grow(prs_struct *ps, uint32 extra_space);
  69 bool prs_force_grow(prs_struct *ps, uint32 extra_space);
  70 char *prs_data_p(prs_struct *ps);
  71 uint32 prs_data_size(prs_struct *ps);
  72 uint32 prs_offset(prs_struct *ps);
  73 bool prs_set_offset(prs_struct *ps, uint32 offset);
  74 bool prs_append_prs_data(prs_struct *dst, prs_struct *src);
  75 bool prs_append_some_data(prs_struct *dst, void *src_base, uint32_t start,
  76                           uint32_t len);
  77 bool prs_append_some_prs_data(prs_struct *dst, prs_struct *src, int32 start, uint32 len);
  78 bool prs_copy_data_in(prs_struct *dst, const char *src, uint32 len);
  79 bool prs_copy_data_out(char *dst, prs_struct *src, uint32 len);
  80 bool prs_copy_all_data_out(char *dst, prs_struct *src);
  81 void prs_set_endian_data(prs_struct *ps, bool endian);
  82 bool prs_align(prs_struct *ps);
  83 bool prs_align_uint16(prs_struct *ps);
  84 bool prs_align_uint64(prs_struct *ps);
  85 bool prs_align_custom(prs_struct *ps, uint8 boundary);
  86 bool prs_align_needed(prs_struct *ps, uint32 needed);
  87 char *prs_mem_get(prs_struct *ps, uint32 extra_size);
  88 void prs_switch_type(prs_struct *ps, bool io);
  89 bool prs_uint8(const char *name, prs_struct *ps, int depth, uint8 *data8);
  90 bool prs_uint16(const char *name, prs_struct *ps, int depth, uint16 *data16);
  91 bool prs_uint32(const char *name, prs_struct *ps, int depth, uint32 *data32);
  92 bool prs_int32(const char *name, prs_struct *ps, int depth, int32 *data32);
  93 bool prs_uint64(const char *name, prs_struct *ps, int depth, uint64 *data64);
  94 bool prs_dcerpc_status(const char *name, prs_struct *ps, int depth, NTSTATUS *status);
  95 bool prs_uint8s(bool charmode, const char *name, prs_struct *ps, int depth, uint8 *data8s, int len);
  96 bool prs_uint16s(bool charmode, const char *name, prs_struct *ps, int depth, uint16 *data16s, int len);
  97 bool prs_uint32s(bool charmode, const char *name, prs_struct *ps, int depth, uint32 *data32s, int len);
  98 bool prs_init_data_blob(prs_struct *prs, DATA_BLOB *blob, TALLOC_CTX *mem_ctx);
  99 bool prs_data_blob(prs_struct *prs, DATA_BLOB *blob, TALLOC_CTX *mem_ctx);
 100
 101 #endif