r25624: Remove ipv4_addr hack. Only causes 4 extra includes of system/network.h becau...
[bbaumbach/samba-autobuild/.git] / source4 / librpc / ndr / libndr.h
index 4df3e7f248a37fc603ad481de582a0b6f7a66dae..64d5da44f9e9cbd57c5074e5837585112422161e 100644 (file)
@@ -5,7 +5,7 @@
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+#ifndef __LIBNDR_H__
+#define __LIBNDR_H__
+
+#include <talloc.h>
+#include "lib/util/util.h" /* for discard_const */
+#include "lib/charset/charset.h"
+#include "libcli/util/ntstatus.h"
+
 /*
   this provides definitions for the libcli/rpc/ MSRPC library
 */
@@ -46,11 +53,16 @@ struct ndr_pull {
        uint32_t data_size;
        uint32_t offset;
 
+       uint32_t relative_base_offset;
+       struct ndr_token_list *relative_base_list;
+
        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;
 
+       TALLOC_CTX *current_mem_ctx;
+
        /* this is used to ensure we generate unique reference IDs
           between request and reply */
        uint32_t ptr_count;
@@ -69,8 +81,13 @@ struct ndr_push {
        uint32_t alloc_size;
        uint32_t offset;
 
+       uint32_t relative_base_offset;
+       struct ndr_token_list *relative_base_list;
+
        struct ndr_token_list *switch_list;
        struct ndr_token_list *relative_list;
+       struct ndr_token_list *nbt_string_list;
+       struct ndr_token_list *full_ptr_list;
 
        /* this is used to ensure we generate unique reference IDs */
        uint32_t ptr_count;
@@ -86,8 +103,9 @@ struct ndr_push_save {
 struct ndr_print {
        uint32_t flags; /* LIBNDR_FLAG_* */
        uint32_t depth;
-       void (*print)(struct ndr_print *, const char *, ...);
-       void *private;
+       struct ndr_token_list *switch_list;
+       void (*print)(struct ndr_print *, const char *, ...) PRINTF_ATTRIBUTE(2,3);
+       void *private_data;
 };
 
 #define LIBNDR_FLAG_BIGENDIAN  (1<<0)
@@ -105,7 +123,7 @@ struct ndr_print {
 #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_STRING_FLAGS            (0x7FFC)
 
 
 #define LIBNDR_FLAG_REF_ALLOC    (1<<20)
@@ -125,10 +143,6 @@ struct ndr_print {
 /* 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)
 
@@ -137,14 +151,15 @@ struct ndr_print {
 
 /* 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_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,
        NDR_ERR_ARRAY_SIZE,
        NDR_ERR_BAD_SWITCH,
        NDR_ERR_OFFSET,
@@ -152,12 +167,19 @@ 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_RANGE,
-       NDR_ERR_TOKEN
+       NDR_ERR_TOKEN,
+       NDR_ERR_IPV4ADDRESS
+};
+
+enum ndr_compression_alg {
+       NDR_COMPRESSION_MSZIP   = 2,
+       NDR_COMPRESSION_XPRESS  = 3
 };
 
 /*
@@ -176,12 +198,14 @@ enum ndr_err_code {
 
 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
        if ((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size) { \
-               return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u", n); \
+               return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u", (unsigned)n); \
        } \
 } while(0)
 
 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
 
+#define NDR_ROUND(size, n) (((size)+((n)-1)) & ~((n)-1))
+
 #define NDR_PULL_ALIGN(ndr, n) do { \
        if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
                if (ndr->flags & LIBNDR_FLAG_PAD_CHECK) { \
@@ -190,11 +214,11 @@ enum ndr_err_code {
                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); \
+               return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", (unsigned)n); \
        } \
 } while(0)
 
-#define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, ndr->offset+(n)))
+#define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, n))
 
 #define NDR_PUSH_ALIGN(ndr, n) do { \
        if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
@@ -211,37 +235,101 @@ enum ndr_err_code {
                                 return _status; \
                         } while (0)
 
+#define NDR_PULL_GET_MEM_CTX(ndr) (ndr->current_mem_ctx)
 
-#define NDR_ALLOC_SIZE(ndr, s, size) do { \
-                              (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_PULL_SET_MEM_CTX(ndr, mem_ctx, flgs) do {\
+       if ( !(flgs) || (ndr->flags & flgs) ) {\
+               if (!(mem_ctx)) {\
+                       return ndr_pull_error(ndr, NDR_ERR_ALLOC, "NDR_PULL_SET_MEM_CTX(NULL): %s\n", __location__); \
+               }\
+               ndr->current_mem_ctx = discard_const(mem_ctx);\
+       }\
+} while(0)
 
+#define _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr) do {\
+       if (!ndr->current_mem_ctx) {\
+               ndr->current_mem_ctx = talloc_new(ndr);\
+               if (!ndr->current_mem_ctx) {\
+                       return ndr_pull_error(ndr, NDR_ERR_ALLOC, "_NDR_PULL_FIX_CURRENT_MEM_CTX() failed: %s\n", __location__); \
+               }\
+       }\
+} while(0)
 
-#define NDR_ALLOC_N_SIZE(ndr, s, n, elsize) do { \
-       (s) = talloc_array_size(ndr, elsize, n); \
-       if (!(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %u failed\n", n, elsize); \
+#define NDR_PULL_ALLOC(ndr, s) do { \
+       _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
+       (s) = talloc_ptrtype(ndr->current_mem_ctx, (s)); \
+       if (!(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %s failed: %s\n", # s, __location__); \
 } while (0)
 
-#define NDR_ALLOC_N(ndr, s, n) NDR_ALLOC_N_SIZE(ndr, s, n, sizeof(*(s)))
+#define NDR_PULL_ALLOC_N(ndr, s, n) do { \
+       _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
+       (s) = talloc_array_ptrtype(ndr->current_mem_ctx, (s), n); \
+       if (!(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %s failed: %s\n", (unsigned)n, # s, __location__); \
+} while (0)
 
 
 #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); \
+       (s) = talloc_array(ndr, uint8_t, size); \
+       if (!(s)) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed: %s\n", (unsigned)size, __location__); \
 } while (0)
 
-#define NDR_PUSH_ALLOC(ndr, s) NDR_PUSH_ALLOC_SIZE(ndr, s, sizeof(*(s)))
+#define NDR_PUSH_ALLOC(ndr, s) do { \
+       (s) = talloc_ptrtype(ndr, (s)); \
+       if (!(s)) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %s failed: %s\n", # s, __location__); \
+} while (0)
 
 /* 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_push_flags_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 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_t, void *);
+typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, const void *);
+typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, const void *);
+
+#include "librpc/gen_ndr/misc.h"
+#include "libcli/util/werror.h"
+#include "librpc/ndr/libndr_proto.h"
+
+extern const struct ndr_syntax_id ndr_transfer_syntax;
+extern const struct ndr_syntax_id ndr64_transfer_syntax;
+
+struct ndr_interface_call {
+       const char *name;
+       size_t struct_size;
+       ndr_push_flags_fn_t ndr_push;
+       ndr_pull_flags_fn_t ndr_pull;
+       ndr_print_function_t ndr_print;
+       bool async;
+};
+
+struct ndr_interface_string_array {
+       uint32_t count;
+       const char * const *names;
+};
+
+struct ndr_interface_table {
+       const char *name;
+       struct ndr_syntax_id syntax_id;
+       const char *helpstring;
+       uint32_t num_calls;
+       const struct ndr_interface_call *calls;
+       const struct ndr_interface_string_array *endpoints;
+       const struct ndr_interface_string_array *authservices;
+};
+
+struct ndr_interface_list {
+       struct ndr_interface_list *prev, *next;
+       const struct ndr_interface_table *table;
+};
 
+/* FIXME: Use represent_as instead */
+struct dom_sid;
+NTSTATUS ndr_push_dom_sid2(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
+NTSTATUS ndr_pull_dom_sid2(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
+void ndr_print_dom_sid2(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
+NTSTATUS ndr_push_dom_sid28(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
+NTSTATUS ndr_pull_dom_sid28(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
+void ndr_print_dom_sid28(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
+size_t ndr_size_dom_sid28(const struct dom_sid *sid, int flags);
+void ndr_print_ipv4_addr(struct ndr_print *ndr, const char *name, const struct in_addr *_ip);
+void ndr_print_GUID(struct ndr_print *ndr, const char *name, const struct GUID *guid);
+
+#endif /* __LIBNDR_H__ */