source/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 is used to ensure we generate unique reference IDs */
  69         uint32 ptr_count;
  70
  71         /* this points at a list of offsets to the structures being processed.
  72            The first element in the list is the current structure */
  73         struct ndr_ofs_list *ofs_list;
  74
  75         /* this list is used by the [relative] code to find the offsets */
  76         struct ndr_ofs_list *relative_list, *relative_list_end;
  77 };
  78
  79 struct ndr_push_save {
  80         uint32 offset;
  81         struct ndr_push_save *next;
  82 };
  83
  84
  85 /* structure passed to functions that print IDL structures */
  86 struct ndr_print {
  87         uint32 flags; /* LIBNDR_FLAG_* */
  88         TALLOC_CTX *mem_ctx;
  89         uint32 depth;
  90         void (*print)(struct ndr_print *, const char *, ...);
  91         void *private;
  92 };
  93
  94 #define LIBNDR_FLAG_BIGENDIAN  (1<<0)
  95 #define LIBNDR_FLAG_NOALIGN    (1<<1)
  96
  97 #define LIBNDR_FLAG_STR_ASCII    (1<<2)
  98 #define LIBNDR_FLAG_STR_LEN4     (1<<3)
  99 #define LIBNDR_FLAG_STR_SIZE4    (1<<4)
 100 #define LIBNDR_FLAG_STR_NOTERM   (1<<5)
 101 #define LIBNDR_FLAG_STR_NULLTERM (1<<6)
 102 #define LIBNDR_FLAG_STR_SIZE2    (1<<7)
 103 #define LIBNDR_STRING_FLAGS      (0xFC)
 104
 105 #define LIBNDR_FLAG_REF_ALLOC    (1<<10)
 106 #define LIBNDR_FLAG_REMAINING    (1<<11)
 107 #define LIBNDR_FLAG_ALIGN2       (1<<12)
 108 #define LIBNDR_FLAG_ALIGN4       (1<<13)
 109 #define LIBNDR_FLAG_ALIGN8       (1<<14)
 110
 111 #define LIBNDR_ALIGN_FLAGS (LIBNDR_FLAG_ALIGN2|LIBNDR_FLAG_ALIGN4|LIBNDR_FLAG_ALIGN8)
 112
 113 #define LIBNDR_PRINT_ARRAY_HEX   (1<<15)
 114 #define LIBNDR_PRINT_SET_VALUES  (1<<16)
 115
 116 /* used to force a section of IDL to be little-endian */
 117 #define LIBNDR_FLAG_LITTLE_ENDIAN (1<<17)
 118
 119
 120 /* useful macro for debugging */
 121 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
 122 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_union_fn_t)ndr_print_ ##type, #p, level, p)
 123 #define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
 124 #define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
 125 #define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
 126 #define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
 127
 128
 129 enum ndr_err_code {
 130         NDR_ERR_CONFORMANT_SIZE,
 131         NDR_ERR_ARRAY_SIZE,
 132         NDR_ERR_BAD_SWITCH,
 133         NDR_ERR_OFFSET,
 134         NDR_ERR_RELATIVE,
 135         NDR_ERR_CHARCNV,
 136         NDR_ERR_LENGTH,
 137         NDR_ERR_SUBCONTEXT,
 138         NDR_ERR_STRING,
 139         NDR_ERR_VALIDATE,
 140         NDR_ERR_BUFSIZE,
 141         NDR_ERR_ALLOC
 142 };
 143
 144 /*
 145   flags passed to control parse flow
 146 */
 147 #define NDR_SCALARS 1
 148 #define NDR_BUFFERS 2
 149
 150 /*
 151   flags passed to ndr_print_*()
 152 */
 153 #define NDR_IN 1
 154 #define NDR_OUT 2
 155 #define NDR_BOTH 3
 156 #define NDR_SET_VALUES 4
 157
 158 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
 159         if ((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size) { \
 160                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u", n); \
 161         } \
 162 } while(0)
 163
 164 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
 165
 166 #define NDR_PULL_ALIGN(ndr, n) do { \
 167         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
 168                 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
 169         } \
 170         if (ndr->offset >= ndr->data_size) { \
 171                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", n); \
 172         } \
 173 } while(0)
 174
 175 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, ndr->offset+(n)))
 176
 177 #define NDR_PUSH_ALIGN(ndr, n) do { \
 178         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
 179                 uint32 _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
 180                 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, 0)); \
 181         } \
 182 } while(0)
 183
 184
 185 /* these are used to make the error checking on each element in libndr
 186    less tedious, hopefully making the code more readable */
 187 #define NDR_CHECK(call) do { NTSTATUS _status; \
 188                              _status = call; \
 189                              if (!NT_STATUS_IS_OK(_status)) \
 190                                 return _status; \
 191                         } while (0)
 192
 193
 194 #define NDR_ALLOC_SIZE(ndr, s, size) do { \
 195                                (s) = talloc(ndr->mem_ctx, size); \
 196                                if ((size) && !(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, \
 197                                                                "Alloc %u failed\n", \
 198                                                                size); \
 199                            } while (0)
 200
 201 #define NDR_ALLOC(ndr, s) NDR_ALLOC_SIZE(ndr, s, sizeof(*(s)))
 202
 203
 204 #define NDR_ALLOC_N_SIZE(ndr, s, n, elsize) do { \
 205                                 if ((n) == 0) { \
 206                                         (s) = NULL; \
 207                                 } else { \
 208                                         (s) = talloc(ndr->mem_ctx, (n) * elsize); \
 209                                         if (!(s)) return ndr_pull_error(ndr, \
 210                                                                         NDR_ERR_ALLOC, \
 211                                                                         "Alloc %u * %u failed\n", \
 212                                                                         n, elsize); \
 213                                 } \
 214                            } while (0)
 215
 216 #define NDR_ALLOC_N(ndr, s, n) NDR_ALLOC_N_SIZE(ndr, s, n, sizeof(*(s)))
 217
 218
 219 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
 220                                (s) = talloc(ndr->mem_ctx, size); \
 221                                if ((size) && !(s)) return ndr_push_error(ndr, NDR_ERR_ALLOC, \
 222                                                                "push alloc %u failed\n",\
 223                                                                size); \
 224                            } while (0)
 225
 226 #define NDR_PUSH_ALLOC(ndr, s) NDR_PUSH_ALLOC_SIZE(ndr, s, sizeof(*(s)))
 227
 228
 229 /* these are used when generic fn pointers are needed for ndr push/pull fns */
 230 typedef NTSTATUS (*ndr_push_fn_t)(struct ndr_push *, void *);
 231 typedef NTSTATUS (*ndr_pull_fn_t)(struct ndr_pull *, void *);
 232
 233 typedef NTSTATUS (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, void *);
 234 typedef NTSTATUS (*ndr_push_const_fn_t)(struct ndr_push *, int ndr_flags, const void *);
 235 typedef NTSTATUS (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
 236 typedef NTSTATUS (*ndr_push_union_fn_t)(struct ndr_push *, int ndr_flags, uint32, void *);
 237 typedef NTSTATUS (*ndr_pull_union_fn_t)(struct ndr_pull *, int ndr_flags, uint32, void *);
 238 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, void *);
 239 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, void *);
 240 typedef void (*ndr_print_union_fn_t)(struct ndr_print *, const char *, uint32, void *);
 241
 242 #include "librpc/ndr/ndr_basic.h"
 243 #include "librpc/ndr/ndr_sec.h"
 244
 245 /* now pull in the individual parsers */
 246 #include "librpc/gen_ndr/tables.h"