r5663: Revert some changes I didn't mean to commit...
[samba.git] / source4 / librpc / ndr / libndr.h
index 8c224d9a016f5c358c42edc78d7971d3a8aa55a2..4880df43bdfc9a94b944f03e28474b35e5ac70b2 100644 (file)
 */
 
 
-/* offset lists are used to allow a push/pull function to find the
-   start of an encapsulating structure */
-struct ndr_ofs_list {
-       uint32 offset;
-       struct ndr_ofs_list *next;
+/*
+  this is used by the token store/retrieve code
+*/
+struct ndr_token_list {
+       struct ndr_token_list *next, *prev;
+       const void *key;
+       uint32_t value;
 };
 
-
 /* this is the base structure passed to routines that 
    parse MSRPC formatted data 
 
@@ -40,60 +41,102 @@ struct ndr_ofs_list {
    particular transport
 */
 struct ndr_pull {
-       uint32 flags; /* LIBNDR_FLAG_* */
-       char *data;
-       uint32 data_size;
-       uint32 offset;
-       TALLOC_CTX *mem_ctx;
-
-       /* this points at a list of offsets to the structures being processed.
-          The first element in the list is the current structure */
-       struct ndr_ofs_list *ofs_list;
+       uint32_t flags; /* LIBNDR_FLAG_* */
+       uint8_t *data;
+       uint32_t data_size;
+       uint32_t offset;
+
+       struct ndr_token_list *relative_list;
+       struct ndr_token_list *array_size_list;
+       struct ndr_token_list *array_length_list;
+
+       /* this is used to ensure we generate unique reference IDs
+          between request and reply */
+       uint32_t ptr_count;
 };
 
 struct ndr_pull_save {
-       uint32 data_size;
-       uint32 offset;
+       uint32_t data_size;
+       uint32_t offset;
        struct ndr_pull_save *next;
 };
 
 /* structure passed to functions that generate NDR formatted data */
 struct ndr_push {
-       uint32 flags; /* LIBNDR_FLAG_* */
-       char *data;
-       uint32 alloc_size;
-       uint32 offset;
-       TALLOC_CTX *mem_ctx;
-
-       /* this points at a list of offsets to the structures being processed.
-          The first element in the list is the current structure */
-       struct ndr_ofs_list *ofs_list;
-
-       /* this list is used by the [relative] code to find the offsets */
-       struct ndr_ofs_list *relative_list;
+       uint32_t flags; /* LIBNDR_FLAG_* */
+       uint8_t *data;
+       uint32_t alloc_size;
+       uint32_t offset;
+
+       struct ndr_token_list *relative_list;
+
+       /* this is used to ensure we generate unique reference IDs */
+       uint32_t ptr_count;
 };
 
 struct ndr_push_save {
-       uint32 offset;
+       uint32_t offset;
        struct ndr_push_save *next;
 };
 
 
 /* structure passed to functions that print IDL structures */
 struct ndr_print {
-       uint32 flags; /* LIBNDR_FLAG_* */
-       TALLOC_CTX *mem_ctx;
-       uint32 depth;
+       uint32_t flags; /* LIBNDR_FLAG_* */
+       uint32_t depth;
        void (*print)(struct ndr_print *, const char *, ...);
        void *private;
 };
 
-#define LIBNDR_FLAG_BIGENDIAN 1
+#define LIBNDR_FLAG_BIGENDIAN  (1<<0)
+#define LIBNDR_FLAG_NOALIGN    (1<<1)
+
+#define LIBNDR_FLAG_STR_ASCII          (1<<2)
+#define LIBNDR_FLAG_STR_LEN4           (1<<3)
+#define LIBNDR_FLAG_STR_SIZE4          (1<<4)
+#define LIBNDR_FLAG_STR_NOTERM         (1<<5)
+#define LIBNDR_FLAG_STR_NULLTERM       (1<<6)
+#define LIBNDR_FLAG_STR_SIZE2          (1<<7)
+#define LIBNDR_FLAG_STR_BYTESIZE       (1<<8)
+#define LIBNDR_FLAG_STR_FIXLEN32       (1<<9)
+#define LIBNDR_FLAG_STR_CONFORMANT     (1<<10)
+#define LIBNDR_FLAG_STR_CHARLEN                (1<<11)
+#define LIBNDR_FLAG_STR_UTF8           (1<<12)
+#define LIBNDR_FLAG_STR_FIXLEN15       (1<<13)
+#define LIBNDR_STRING_FLAGS            (0x3FFC)
+
+
+#define LIBNDR_FLAG_REF_ALLOC    (1<<20)
+#define LIBNDR_FLAG_REMAINING    (1<<21)
+#define LIBNDR_FLAG_ALIGN2       (1<<22)
+#define LIBNDR_FLAG_ALIGN4       (1<<23)
+#define LIBNDR_FLAG_ALIGN8       (1<<24)
+
+#define LIBNDR_ALIGN_FLAGS (LIBNDR_FLAG_ALIGN2|LIBNDR_FLAG_ALIGN4|LIBNDR_FLAG_ALIGN8)
+
+#define LIBNDR_PRINT_ARRAY_HEX   (1<<25)
+#define LIBNDR_PRINT_SET_VALUES  (1<<26)
+
+/* used to force a section of IDL to be little-endian */
+#define LIBNDR_FLAG_LITTLE_ENDIAN (1<<27)
+
+/* used to check if alignment padding is zero */
+#define LIBNDR_FLAG_PAD_CHECK     (1<<28)
+
+/* used to indicate spoolss style relative pointers (relative to current
+   offset, not base) */
+#define LIBNDR_FLAG_RELATIVE_CURRENT  (1<<29)
 
+/* set if an object uuid will be present */
+#define LIBNDR_FLAG_OBJECT_PRESENT    (1<<30)
 
 /* useful macro for debugging */
 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_union_fn_t)ndr_print_ ##type, #p, level, p)
+#define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
+#define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
+#define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
+#define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
 
 
 enum ndr_err_code {
@@ -103,7 +146,14 @@ enum ndr_err_code {
        NDR_ERR_OFFSET,
        NDR_ERR_RELATIVE,
        NDR_ERR_CHARCNV,
-       NDR_ERR_LENGTH
+       NDR_ERR_LENGTH,
+       NDR_ERR_SUBCONTEXT,
+       NDR_ERR_STRING,
+       NDR_ERR_VALIDATE,
+       NDR_ERR_BUFSIZE,
+       NDR_ERR_ALLOC,
+       NDR_ERR_RANGE,
+       NDR_ERR_TOKEN
 };
 
 /*
@@ -112,27 +162,43 @@ enum ndr_err_code {
 #define NDR_SCALARS 1
 #define NDR_BUFFERS 2
 
+/*
+  flags passed to ndr_print_*()
+*/
+#define NDR_IN 1
+#define NDR_OUT 2
+#define NDR_BOTH 3
+#define NDR_SET_VALUES 4
+
 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
        if ((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size) { \
-               return NT_STATUS_BUFFER_TOO_SMALL; \
+               return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u", n); \
        } \
 } while(0)
 
+#define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
+
 #define NDR_PULL_ALIGN(ndr, n) do { \
-       ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
-       if (ndr->offset >= ndr->data_size) { \
-               return NT_STATUS_BUFFER_TOO_SMALL; \
+       if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
+               if (ndr->flags & LIBNDR_FLAG_PAD_CHECK) { \
+                       ndr_check_padding(ndr, n); \
+               } \
+               ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
+       } \
+       if (ndr->offset > ndr->data_size) { \
+               return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", n); \
        } \
 } while(0)
 
 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, ndr->offset+(n)))
 
 #define NDR_PUSH_ALIGN(ndr, n) do { \
-       uint32 _pad = (ndr->offset & (n-1)); \
-       while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, 0)); \
+       if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
+               uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
+               while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 0)); \
+       } \
 } while(0)
 
-
 /* these are used to make the error checking on each element in libndr
    less tedious, hopefully making the code more readable */
 #define NDR_CHECK(call) do { NTSTATUS _status; \
@@ -143,43 +209,37 @@ enum ndr_err_code {
 
 
 #define NDR_ALLOC_SIZE(ndr, s, size) do { \
-                              (s) = talloc(ndr->mem_ctx, size); \
-                               if (!(s)) return NT_STATUS_NO_MEMORY; \
+                              (s) = talloc_size(ndr, size); \
+                               if ((size) && !(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, \
+                                                              "Alloc %u failed\n", \
+                                                              size); \
                            } while (0)
 
 #define NDR_ALLOC(ndr, s) NDR_ALLOC_SIZE(ndr, s, sizeof(*(s)))
 
 
 #define NDR_ALLOC_N_SIZE(ndr, s, n, elsize) do { \
-                               if ((n) == 0) { \
-                                       (s) = NULL; \
-                               } else { \
-                                       (s) = talloc(ndr->mem_ctx, (n) * elsize); \
-                                       if (!(s)) return NT_STATUS_NO_MEMORY; \
-                               } \
-                           } while (0)
+       (s) = talloc_array_size(ndr, elsize, n); \
+       if (!(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %u failed\n", n, elsize); \
+} while (0)
 
 #define NDR_ALLOC_N(ndr, s, n) NDR_ALLOC_N_SIZE(ndr, s, n, sizeof(*(s)))
 
-/* these are used when generic fn pointers are needed for ndr push/pull fns */
-typedef NTSTATUS (*ndr_push_fn_t)(struct ndr_push *, void *);
-typedef NTSTATUS (*ndr_pull_fn_t)(struct ndr_pull *, void *);
 
+#define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
+       (s) = talloc_size(ndr, size); \
+       if (!(s)) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed\n", size); \
+} while (0)
+
+#define NDR_PUSH_ALLOC(ndr, s) NDR_PUSH_ALLOC_SIZE(ndr, s, sizeof(*(s)))
+
+/* these are used when generic fn pointers are needed for ndr push/pull fns */
 typedef NTSTATUS (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, void *);
 typedef NTSTATUS (*ndr_push_const_fn_t)(struct ndr_push *, int ndr_flags, const void *);
 typedef NTSTATUS (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
-typedef NTSTATUS (*ndr_push_union_fn_t)(struct ndr_push *, int ndr_flags, uint16, void *);
-typedef NTSTATUS (*ndr_pull_union_fn_t)(struct ndr_pull *, int ndr_flags, uint16 *, void *);
+typedef NTSTATUS (*ndr_push_union_fn_t)(struct ndr_push *, int ndr_flags, uint32_t, void *);
+typedef NTSTATUS (*ndr_pull_union_fn_t)(struct ndr_pull *, int ndr_flags, uint32_t, void *);
 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, void *);
-typedef void (*ndr_print_union_fn_t)(struct ndr_print *, const char *, uint16, void *);
-
-/* now pull in the individual parsers */
-#include "librpc/ndr/ndr_basic.h"
-#include "librpc/ndr/ndr_sec.h"
-#include "librpc/ndr/ndr_misc.h"
-#include "librpc/ndr/ndr_echo.h"
-#include "librpc/ndr/ndr_lsa.h"
-#include "librpc/ndr/ndr_dfs.h"
-#include "librpc/ndr/ndr_spoolss.h"
-#include "librpc/ndr/ndr_spoolss_buf.h"
-#include "librpc/ndr/ndr_samr.h"
+typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, void *);
+typedef void (*ndr_print_union_fn_t)(struct ndr_print *, const char *, uint32_t, void *);
+