r6519: move string handling functions to a seperate file
[samba.git] / source / librpc / ndr / libndr.h
index 97f36b78d0c47a4814aa8fec0e331a5f8fa054d8..738e5d61c99bf5dacc7649c4511089ba689edefd 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,53 +41,52 @@ 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;
+       struct ndr_token_list *switch_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 is used to ensure we generate unique reference IDs */
-       uint32 ptr_count;
+       uint32_t flags; /* LIBNDR_FLAG_* */
+       uint8_t *data;
+       uint32_t alloc_size;
+       uint32_t offset;
 
-       /* 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;
+       struct ndr_token_list *switch_list;
+       struct ndr_token_list *relative_list;
 
-       /* this list is used by the [relative] code to find the offsets */
-       struct ndr_ofs_list *relative_list, *relative_list_end;
+       /* 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;
+       struct ndr_token_list *switch_list;
        void (*print)(struct ndr_print *, const char *, ...);
        void *private;
 };
@@ -94,37 +94,56 @@ struct ndr_print {
 #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_STRING_FLAGS      (0xFC)
-
-#define LIBNDR_FLAG_REF_ALLOC    (1<<10)
-#define LIBNDR_FLAG_REMAINING    (1<<11)
-#define LIBNDR_FLAG_ALIGN2       (1<<12)
-#define LIBNDR_FLAG_ALIGN4       (1<<13)
-#define LIBNDR_FLAG_ALIGN8       (1<<14)
+#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<<15)
-#define LIBNDR_PRINT_SET_VALUES  (1<<16)
+#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<<17)
+#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)
 
+/* set to avoid recursion in ndr_size_*() calculation */
+#define LIBNDR_FLAG_NO_NDR_SIZE                (1<<31)
 
 /* 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)
 
+#define NDR_BE(ndr) (((ndr)->flags & (LIBNDR_FLAG_BIGENDIAN|LIBNDR_FLAG_LITTLE_ENDIAN)) == LIBNDR_FLAG_BIGENDIAN)
 
 enum ndr_err_code {
        NDR_ERR_CONFORMANT_SIZE,
@@ -135,10 +154,17 @@ enum ndr_err_code {
        NDR_ERR_CHARCNV,
        NDR_ERR_LENGTH,
        NDR_ERR_SUBCONTEXT,
+       NDR_ERR_COMPRESSION,
        NDR_ERR_STRING,
        NDR_ERR_VALIDATE,
        NDR_ERR_BUFSIZE,
-       NDR_ERR_ALLOC
+       NDR_ERR_ALLOC,
+       NDR_ERR_RANGE,
+       NDR_ERR_TOKEN
+};
+
+enum ndr_compression_alg {
+       NDR_COMPRESSION_MSZIP
 };
 
 /*
@@ -165,9 +191,12 @@ enum ndr_err_code {
 
 #define NDR_PULL_ALIGN(ndr, n) do { \
        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) { \
+       if (ndr->offset > ndr->data_size) { \
                return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", n); \
        } \
 } while(0)
@@ -176,12 +205,11 @@ enum ndr_err_code {
 
 #define NDR_PUSH_ALIGN(ndr, n) do { \
        if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
-               uint32 _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
-               while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, 0)); \
+               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; \
@@ -192,7 +220,7 @@ enum ndr_err_code {
 
 
 #define NDR_ALLOC_SIZE(ndr, s, size) do { \
-                              (s) = talloc(ndr->mem_ctx, size); \
+                              (s) = talloc_size(ndr, size); \
                                if ((size) && !(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, \
                                                               "Alloc %u failed\n", \
                                                               size); \
@@ -202,45 +230,24 @@ enum ndr_err_code {
 
 
 #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 ndr_pull_error(ndr, \
-                                                                       NDR_ERR_ALLOC, \
-                                                                       "Alloc %u * %u failed\n", \
-                                                                       n, elsize); \
-                               } \
-                           } 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)))
 
 
 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
-                              (s) = talloc(ndr->mem_ctx, size); \
-                               if ((size) && !(s)) return ndr_push_error(ndr, NDR_ERR_ALLOC, \
-                                                              "push alloc %u failed\n",\
-                                                              size); \
-                           } while (0)
+       (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_fn_t)(struct ndr_push *, void *);
-typedef NTSTATUS (*ndr_pull_fn_t)(struct ndr_pull *, void *);
-
 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, uint32, void *);
-typedef NTSTATUS (*ndr_pull_union_fn_t)(struct ndr_pull *, int ndr_flags, uint32, void *);
 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, void *);
 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, void *);
-
-#include "librpc/ndr/ndr_basic.h"
-#include "librpc/ndr/ndr_sec.h"
 
-/* now pull in the individual parsers */
-#include "librpc/gen_ndr/tables.h"