source4/librpc/ndr/libndr.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    rpc interface definitions
   4    Copyright (C) Andrew Tridgell 2003
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 /*
  22   this provides definitions for the libcli/rpc/ MSRPC library
  23 */
  24
  25
  26 /* offset lists are used to allow a push/pull function to find the
  27    start of an encapsulating structure */
  28 struct ndr_ofs_list {
  29         uint32 offset;
  30         struct ndr_ofs_list *next;
  31 };
  32
  33
  34 /* this is the base structure passed to routines that
  35    parse MSRPC formatted data
  36
  37    note that in Samba4 we use separate routines and structures for
  38    MSRPC marshalling and unmarshalling. Also note that these routines
  39    are being kept deliberately very simple, and are not tied to a
  40    particular transport
  41 */
  42 struct ndr_pull {
  43         uint32 flags; /* LIBNDR_FLAG_* */
  44         char *data;
  45         uint32 data_size;
  46         uint32 offset;
  47         TALLOC_CTX *mem_ctx;
  48
  49         /* this points at a list of offsets to the structures being processed.
  50            The first element in the list is the current structure */
  51         struct ndr_ofs_list *ofs_list;
  52 };
  53
  54 struct ndr_pull_save {
  55         uint32 data_size;
  56         uint32 offset;
  57         struct ndr_pull_save *next;
  58 };
  59
  60 /* structure passed to functions that generate NDR formatted data */
  61 struct ndr_push {
  62         uint32 flags; /* LIBNDR_FLAG_* */
  63         char *data;
  64         uint32 alloc_size;
  65         uint32 offset;
  66         TALLOC_CTX *mem_ctx;
  67
  68         /* this points at a list of offsets to the structures being processed.
  69            The first element in the list is the current structure */
  70         struct ndr_ofs_list *ofs_list;
  71
  72         /* this list is used by the [relative] code to find the offsets */
  73         struct ndr_ofs_list *relative_list;
  74 };
  75
  76 struct ndr_push_save {
  77         uint32 offset;
  78         struct ndr_push_save *next;
  79 };
  80
  81
  82 /* structure passed to functions that print IDL structures */
  83 struct ndr_print {
  84         uint32 flags; /* LIBNDR_FLAG_* */
  85         TALLOC_CTX *mem_ctx;
  86         uint32 depth;
  87         void (*print)(struct ndr_print *, const char *, ...);
  88         void *private;
  89 };
  90
  91 #define LIBNDR_FLAG_BIGENDIAN 1
  92
  93
  94 /* useful macro for debugging */
  95 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
  96 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_union_fn_t)ndr_print_ ##type, #p, level, p)
  97
  98
  99 enum ndr_err_code {
 100         NDR_ERR_CONFORMANT_SIZE,
 101         NDR_ERR_ARRAY_SIZE,
 102         NDR_ERR_BAD_SWITCH,
 103         NDR_ERR_OFFSET,
 104         NDR_ERR_RELATIVE,
 105         NDR_ERR_CHARCNV,
 106         NDR_ERR_LENGTH
 107 };
 108
 109 /*
 110   flags passed to control parse flow
 111 */
 112 #define NDR_SCALARS 1
 113 #define NDR_BUFFERS 2
 114
 115 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
 116         if ((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size) { \
 117                 return NT_STATUS_BUFFER_TOO_SMALL; \
 118         } \
 119 } while(0)
 120
 121 #define NDR_PULL_ALIGN(ndr, n) do { \
 122         ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
 123         if (ndr->offset >= ndr->data_size) { \
 124                 return NT_STATUS_BUFFER_TOO_SMALL; \
 125         } \
 126 } while(0)
 127
 128 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, ndr->offset+(n)))
 129
 130 #define NDR_PUSH_ALIGN(ndr, n) do { \
 131         uint32 _pad = (ndr->offset & (n-1)); \
 132         while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, 0)); \
 133 } while(0)
 134
 135
 136 /* these are used to make the error checking on each element in libndr
 137    less tedious, hopefully making the code more readable */
 138 #define NDR_CHECK(call) do { NTSTATUS _status; \
 139                              _status = call; \
 140                              if (!NT_STATUS_IS_OK(_status)) \
 141                                 return _status; \
 142                         } while (0)
 143
 144
 145 #define NDR_ALLOC_SIZE(ndr, s, size) do { \
 146                                (s) = talloc(ndr->mem_ctx, size); \
 147                                if (!(s)) return NT_STATUS_NO_MEMORY; \
 148                            } while (0)
 149
 150 #define NDR_ALLOC(ndr, s) NDR_ALLOC_SIZE(ndr, s, sizeof(*(s)))
 151
 152
 153 #define NDR_ALLOC_N_SIZE(ndr, s, n, elsize) do { \
 154                                 if ((n) == 0) { \
 155                                         (s) = NULL; \
 156                                 } else { \
 157                                         (s) = talloc(ndr->mem_ctx, (n) * elsize); \
 158                                         if (!(s)) return NT_STATUS_NO_MEMORY; \
 159                                 } \
 160                            } while (0)
 161
 162 #define NDR_ALLOC_N(ndr, s, n) NDR_ALLOC_N_SIZE(ndr, s, n, sizeof(*(s)))
 163
 164 /* these are used when generic fn pointers are needed for ndr push/pull fns */
 165 typedef NTSTATUS (*ndr_push_fn_t)(struct ndr_push *, void *);
 166 typedef NTSTATUS (*ndr_pull_fn_t)(struct ndr_pull *, void *);
 167
 168 typedef NTSTATUS (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, void *);
 169 typedef NTSTATUS (*ndr_push_const_fn_t)(struct ndr_push *, int ndr_flags, const void *);
 170 typedef NTSTATUS (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
 171 typedef NTSTATUS (*ndr_push_union_fn_t)(struct ndr_push *, int ndr_flags, uint16, void *);
 172 typedef NTSTATUS (*ndr_pull_union_fn_t)(struct ndr_pull *, int ndr_flags, uint16 *, void *);
 173 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, void *);
 174 typedef void (*ndr_print_union_fn_t)(struct ndr_print *, const char *, uint16, void *);
 175
 176 /* now pull in the individual parsers */
 177 #include "librpc/ndr/ndr_sec.h"
 178 #include "librpc/ndr/ndr_misc.h"
 179 #include "librpc/ndr/ndr_echo.h"
 180 #include "librpc/ndr/ndr_lsa.h"
 181 #include "librpc/ndr/ndr_dfs.h"
 182 #include "librpc/ndr/ndr_spoolss.h"
 183 #include "librpc/ndr/ndr_spoolss_buf.h"
 184 #include "librpc/ndr/ndr_samr.h"