r5775: Remove some unused functions (unions are no longer as special as they used...
[samba.git] / source4 / librpc / ndr / ndr.c
index 71019030ac3f72c2b4181ade25b5bb222f367e0b..b96a231a90889a49870ef2b2bab4bf283492a94a 100644 (file)
@@ -48,15 +48,11 @@ struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx)
 {
        struct ndr_pull *ndr;
 
-       ndr = talloc_p(mem_ctx, struct ndr_pull);
+       ndr = talloc_zero(mem_ctx, struct ndr_pull);
        if (!ndr) return NULL;
 
-       ndr->flags = 0;
        ndr->data = blob->data;
        ndr->data_size = blob->length;
-       ndr->offset = 0;
-       ndr->ptr_count = 0;
-       ndr->relative_list = NULL;
 
        return ndr;
 }
@@ -125,20 +121,17 @@ struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx)
 {
        struct ndr_push *ndr;
 
-       ndr = talloc(mem_ctx, sizeof(*ndr));
+       ndr = talloc_zero(mem_ctx, struct ndr_push);
        if (!ndr) {
                return NULL;
        }
 
        ndr->flags = 0;
        ndr->alloc_size = NDR_BASE_MARSHALL_SIZE;
-       ndr->data = talloc(ndr, ndr->alloc_size);
+       ndr->data = talloc_array(ndr, uint8_t, ndr->alloc_size);
        if (!ndr->data) {
                return NULL;
        }
-       ndr->offset = 0;
-       ndr->ptr_count = 0;
-       ndr->relative_list = NULL;
 
        return ndr;
 }
@@ -180,7 +173,7 @@ NTSTATUS ndr_push_expand(struct ndr_push *ndr, uint32_t size)
        if (size > ndr->alloc_size) {
                ndr->alloc_size = size;
        }
-       ndr->data = talloc_realloc(ndr, ndr->data, ndr->alloc_size);
+       ndr->data = talloc_realloc(ndr, ndr->data, uint8_t, ndr->alloc_size);
        if (!ndr->data) {
                return ndr_push_error(ndr, NDR_ERR_ALLOC, "Failed to push_expand to %u",
                                      ndr->alloc_size);
@@ -322,7 +315,7 @@ void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr)
 {
        struct ndr_print *ndr;
 
-       ndr = talloc_p(NULL, struct ndr_print);
+       ndr = talloc(NULL, struct ndr_print);
        if (!ndr) return;
        ndr->print = ndr_print_debug_helper;
        ndr->depth = 1;
@@ -339,7 +332,7 @@ void ndr_print_union_debug(ndr_print_union_fn_t fn, const char *name, uint32_t l
 {
        struct ndr_print *ndr;
 
-       ndr = talloc_p(NULL, struct ndr_print);
+       ndr = talloc(NULL, struct ndr_print);
        if (!ndr) return;
        ndr->print = ndr_print_debug_helper;
        ndr->depth = 1;
@@ -355,7 +348,7 @@ void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int fla
 {
        struct ndr_print *ndr;
 
-       ndr = talloc_p(NULL, struct ndr_print);
+       ndr = talloc(NULL, struct ndr_print);
        if (!ndr) return;
        ndr->print = ndr_print_debug_helper;
        ndr->depth = 1;
@@ -381,8 +374,12 @@ static NTSTATUS ndr_map_error(enum ndr_err_code err)
        switch (err) {
        case NDR_ERR_BUFSIZE:
                return NT_STATUS_BUFFER_TOO_SMALL;
+       case NDR_ERR_TOKEN:
+               return NT_STATUS_INTERNAL_ERROR;
        case NDR_ERR_ALLOC:
                return NT_STATUS_NO_MEMORY;
+       case NDR_ERR_ARRAY_SIZE:
+               return NT_STATUS_ARRAY_BOUNDS_EXCEEDED;
        default:
                break;
        }
@@ -435,30 +432,29 @@ NTSTATUS ndr_push_error(struct ndr_push *ndr, enum ndr_err_code err, const char
   handle subcontext buffers, which in midl land are user-marshalled, but
   we use magic in pidl to make them easier to cope with
 */
-static NTSTATUS ndr_pull_subcontext_header(struct ndr_pull *ndr, 
+NTSTATUS ndr_pull_subcontext_header(struct ndr_pull *ndr, 
                                           size_t sub_size,
                                           struct ndr_pull *ndr2)
 {
+       ndr2->flags = ndr->flags;
+
        switch (sub_size) {
        case 0: {
                uint32_t size = ndr->data_size - ndr->offset;
-               if (size == 0) return NT_STATUS_OK;
                NDR_CHECK(ndr_pull_subcontext(ndr, ndr2, size));
                break;
        }
 
        case 2: {
                uint16_t size;
-               NDR_CHECK(ndr_pull_uint16(ndr, &size));
-               if (size == 0) return NT_STATUS_OK;
+               NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &size));
                NDR_CHECK(ndr_pull_subcontext(ndr, ndr2, size));
                break;
        }
 
        case 4: {
                uint32_t size;
-               NDR_CHECK(ndr_pull_uint32(ndr, &size));
-               if (size == 0) return NT_STATUS_OK;
+               NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &size));
                NDR_CHECK(ndr_pull_subcontext(ndr, ndr2, size));
                break;
        }
@@ -469,62 +465,10 @@ static NTSTATUS ndr_pull_subcontext_header(struct ndr_pull *ndr,
        return NT_STATUS_OK;
 }
 
-/*
-  handle subcontext buffers, which in midl land are user-marshalled, but
-  we use magic in pidl to make them easier to cope with
-*/
-NTSTATUS ndr_pull_subcontext_fn(struct ndr_pull *ndr, size_t sub_size, 
-                               void *base, ndr_pull_fn_t fn)
-{
-       struct ndr_pull *ndr2;
-       NDR_ALLOC(ndr, ndr2);
-       NDR_CHECK(ndr_pull_subcontext_header(ndr, sub_size, ndr2));
-       NDR_CHECK(fn(ndr2, base));
-       if (sub_size) {
-               NDR_CHECK(ndr_pull_advance(ndr, ndr2->data_size));
-       } else {
-               NDR_CHECK(ndr_pull_advance(ndr, ndr2->offset));
-       }
-       return NT_STATUS_OK;
-}
-
-
-NTSTATUS ndr_pull_subcontext_flags_fn(struct ndr_pull *ndr, size_t sub_size,
-                                     void *base, ndr_pull_flags_fn_t fn)
-{
-       struct ndr_pull *ndr2;
-       NDR_ALLOC(ndr, ndr2);
-       NDR_CHECK(ndr_pull_subcontext_header(ndr, sub_size, ndr2));
-       NDR_CHECK(fn(ndr2, NDR_SCALARS|NDR_BUFFERS, base));
-       if (sub_size) {
-               NDR_CHECK(ndr_pull_advance(ndr, ndr2->data_size));
-       } else {
-               NDR_CHECK(ndr_pull_advance(ndr, ndr2->offset));
-       }
-       return NT_STATUS_OK;
-}
-
-NTSTATUS ndr_pull_subcontext_union_fn(struct ndr_pull *ndr, size_t sub_size,
-                                     uint32_t level, void *base, ndr_pull_union_fn_t fn)
-{
-       struct ndr_pull *ndr2;
-
-       NDR_ALLOC(ndr, ndr2);
-       NDR_CHECK(ndr_pull_subcontext_header(ndr, sub_size, ndr2));
-       NDR_CHECK(fn(ndr2, NDR_SCALARS|NDR_BUFFERS, level, base));
-       if (sub_size) {
-               NDR_CHECK(ndr_pull_advance(ndr, ndr2->data_size));
-       } else {
-               NDR_CHECK(ndr_pull_advance(ndr, ndr2->offset));
-       }
-       return NT_STATUS_OK;
-}
-
-
 /*
   push a subcontext header 
 */
-static NTSTATUS ndr_push_subcontext_header(struct ndr_push *ndr, 
+NTSTATUS ndr_push_subcontext_header(struct ndr_push *ndr, 
                                           size_t sub_size,
                                           struct ndr_push *ndr2)
 {
@@ -533,11 +477,11 @@ static NTSTATUS ndr_push_subcontext_header(struct ndr_push *ndr,
                break;
 
        case 2: 
-               NDR_CHECK(ndr_push_uint16(ndr, ndr2->offset));
+               NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, ndr2->offset));
                break;
 
        case 4: 
-               NDR_CHECK(ndr_push_uint32(ndr, ndr2->offset));
+               NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, ndr2->offset));
                break;
 
        default:
@@ -547,62 +491,6 @@ static NTSTATUS ndr_push_subcontext_header(struct ndr_push *ndr,
        return NT_STATUS_OK;
 }
 
-/*
-  handle subcontext buffers, which in midl land are user-marshalled, but
-  we use magic in pidl to make them easier to cope with
-*/
-NTSTATUS ndr_push_subcontext_fn(struct ndr_push *ndr, size_t sub_size, 
-                               void *base, ndr_push_fn_t fn)
-{
-       struct ndr_push *ndr2;
-
-       ndr2 = ndr_push_init_ctx(ndr);
-       if (!ndr2) return NT_STATUS_NO_MEMORY;
-
-       ndr2->flags = ndr->flags;
-       NDR_CHECK(fn(ndr2, base));
-       NDR_CHECK(ndr_push_subcontext_header(ndr, sub_size, ndr2));
-       NDR_CHECK(ndr_push_bytes(ndr, ndr2->data, ndr2->offset));
-       return NT_STATUS_OK;
-}
-
-/*
-  handle subcontext buffers for function that take a flags arg
-*/
-NTSTATUS ndr_push_subcontext_flags_fn(struct ndr_push *ndr, size_t sub_size,
-                                     void *base, ndr_push_flags_fn_t fn)
-{
-       struct ndr_push *ndr2;
-
-       ndr2 = ndr_push_init_ctx(ndr);
-       if (!ndr2) return NT_STATUS_NO_MEMORY;
-
-       ndr2->flags = ndr->flags;
-       NDR_CHECK(fn(ndr2, NDR_SCALARS|NDR_BUFFERS, base));
-       NDR_CHECK(ndr_push_subcontext_header(ndr, sub_size, ndr2));
-       NDR_CHECK(ndr_push_bytes(ndr, ndr2->data, ndr2->offset));
-       return NT_STATUS_OK;
-}
-
-/*
-  handle subcontext buffers for function that take a union
-*/
-NTSTATUS ndr_push_subcontext_union_fn(struct ndr_push *ndr, size_t sub_size,
-                                     uint32_t level, void *base, ndr_push_union_fn_t fn)
-{
-       struct ndr_push *ndr2;
-
-       ndr2 = ndr_push_init_ctx(ndr);
-       if (!ndr2) return NT_STATUS_NO_MEMORY;
-
-       ndr2->flags = ndr->flags;
-       NDR_CHECK(fn(ndr2, NDR_SCALARS|NDR_BUFFERS, level, base));
-       NDR_CHECK(ndr_push_subcontext_header(ndr, sub_size, ndr2));
-       NDR_CHECK(ndr_push_bytes(ndr, ndr2->data, ndr2->offset));
-       return NT_STATUS_OK;
-}
-
-
 /*
   mark the start of a structure
 */
@@ -642,7 +530,7 @@ static NTSTATUS ndr_token_store(TALLOC_CTX *mem_ctx,
                                uint32_t value)
 {
        struct ndr_token_list *tok;
-       tok = talloc_p(mem_ctx, struct ndr_token_list);
+       tok = talloc(mem_ctx, struct ndr_token_list);
        if (tok == NULL) {
                return NT_STATUS_NO_MEMORY;
        }
@@ -655,24 +543,135 @@ static NTSTATUS ndr_token_store(TALLOC_CTX *mem_ctx,
 /*
   retrieve a token from a ndr context
 */
-static uint32_t ndr_token_retrieve(struct ndr_token_list **list, const void *key)
+static NTSTATUS ndr_token_retrieve(struct ndr_token_list **list, const void *key, uint32_t *v)
 {
        struct ndr_token_list *tok;
        for (tok=*list;tok;tok=tok->next) {
                if (tok->key == key) {
                        DLIST_REMOVE((*list), tok);
+                       *v = tok->value;
+                       return NT_STATUS_OK;
+               }
+       }
+       return ndr_map_error(NDR_ERR_TOKEN);
+}
+
+/*
+  peek at but don't removed a token from a ndr context
+*/
+static uint32_t ndr_token_peek(struct ndr_token_list **list, const void *key)
+{
+       struct ndr_token_list *tok;
+       for (tok=*list;tok;tok=tok->next) {
+               if (tok->key == key) {
                        return tok->value;
                }
        }
        return 0;
 }
 
+/*
+  pull an array size field and add it to the array_size_list token list
+*/
+NTSTATUS ndr_pull_array_size(struct ndr_pull *ndr, const void *p)
+{
+       uint32_t size;
+       NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &size));
+       return ndr_token_store(ndr, &ndr->array_size_list, p, size);
+}
+
+/*
+  get the stored array size field
+*/
+uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p)
+{
+       return ndr_token_peek(&ndr->array_size_list, p);
+}
+
+/*
+  check the stored array size field
+*/
+NTSTATUS ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size)
+{
+       uint32_t stored;
+       NDR_CHECK(ndr_token_retrieve(&ndr->array_size_list, p, &stored));
+       if (stored != size) {
+               return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE, 
+                                     "Bad array size - got %u expected %u\n",
+                                     stored, size);
+       }
+       return NT_STATUS_OK;
+}
+
+/*
+  pull an array length field and add it to the array_length_list token list
+*/
+NTSTATUS ndr_pull_array_length(struct ndr_pull *ndr, const void *p)
+{
+       uint32_t length, offset;
+       NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &offset));
+       if (offset != 0) {
+               return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE, 
+                                     "non-zero array offset %u\n", offset);
+       }
+       NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &length));
+       return ndr_token_store(ndr, &ndr->array_length_list, p, length);
+}
+
+/*
+  get the stored array length field
+*/
+uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p)
+{
+       return ndr_token_peek(&ndr->array_length_list, p);
+}
+
+/*
+  check the stored array length field
+*/
+NTSTATUS ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length)
+{
+       uint32_t stored;
+       NDR_CHECK(ndr_token_retrieve(&ndr->array_length_list, p, &stored));
+       if (stored != length) {
+               return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE, 
+                                     "Bad array length - got %u expected %u\n",
+                                     stored, length);
+       }
+       return NT_STATUS_OK;
+}
+
+/*
+  store a switch value
+ */
+NTSTATUS ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val)
+{
+       return ndr_token_store(ndr, &ndr->switch_list, p, val);
+}
+
+NTSTATUS ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val)
+{
+       return ndr_token_store(ndr, &ndr->switch_list, p, val);
+}
+
+/*
+  retrieve a switch value
+ */
+uint32_t ndr_push_get_switch_value(struct ndr_push *ndr, const void *p)
+{
+       return ndr_token_peek(&ndr->switch_list, p);
+}
+
+uint32_t ndr_pull_get_switch_value(struct ndr_pull *ndr, const void *p)
+{
+       return ndr_token_peek(&ndr->switch_list, p);
+}
 
 /*
   pull a relative object - stage1
   called during SCALARS processing
 */
-NTSTATUS ndr_pull_relative1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset)
+NTSTATUS ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset)
 {
        if (ndr->flags & LIBNDR_FLAG_RELATIVE_CURRENT) {
                return ndr_token_store(ndr, &ndr->relative_list, p, 
@@ -686,13 +685,10 @@ NTSTATUS ndr_pull_relative1(struct ndr_pull *ndr, const void *p, uint32_t rel_of
   pull a relative object - stage2
   called during BUFFERS processing
 */
-NTSTATUS ndr_pull_relative2(struct ndr_pull *ndr, const void *p)
+NTSTATUS ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p)
 {
        uint32_t rel_offset;
-       rel_offset = ndr_token_retrieve(&ndr->relative_list, p);
-       if (rel_offset == 0) {
-               return NT_STATUS_INTERNAL_ERROR;
-       }
+       NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &rel_offset));
        return ndr_pull_set_offset(ndr, rel_offset);
 }
 
@@ -700,22 +696,22 @@ NTSTATUS ndr_pull_relative2(struct ndr_pull *ndr, const void *p)
   push a relative object - stage1
   this is called during SCALARS processing
 */
-NTSTATUS ndr_push_relative1(struct ndr_push *ndr, const void *p)
+NTSTATUS ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p)
 {
        if (p == NULL) {
-               NDR_CHECK(ndr_push_uint32(ndr, 0));
+               NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
                return NT_STATUS_OK;
        }
        NDR_CHECK(ndr_push_align(ndr, 4));
        NDR_CHECK(ndr_token_store(ndr, &ndr->relative_list, p, ndr->offset));
-       return ndr_push_uint32(ndr, 0xFFFFFFFF);
+       return ndr_push_uint32(ndr, NDR_SCALARS, 0xFFFFFFFF);
 }
 
 /*
   push a relative object - stage2
   this is called during buffers processing
 */
-NTSTATUS ndr_push_relative2(struct ndr_push *ndr, const void *p)
+NTSTATUS ndr_push_relative_ptr2(struct ndr_push *ndr, const void *p)
 {
        struct ndr_push_save save;
        if (p == NULL) {
@@ -723,34 +719,16 @@ NTSTATUS ndr_push_relative2(struct ndr_push *ndr, const void *p)
        }
        NDR_CHECK(ndr_push_align(ndr, 4));
        ndr_push_save(ndr, &save);
-       ndr->offset = ndr_token_retrieve(&ndr->relative_list, p);
-       if (ndr->offset == 0) {
-               return NT_STATUS_INTERNAL_ERROR;
-       }
+       NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &ndr->offset));
        if (ndr->flags & LIBNDR_FLAG_RELATIVE_CURRENT) {
-               NDR_CHECK(ndr_push_uint32(ndr, save.offset - ndr->offset));
+               NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, save.offset - ndr->offset));
        } else {
-               NDR_CHECK(ndr_push_uint32(ndr, save.offset));
+               NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, save.offset));
        }
        ndr_push_restore(ndr, &save);
        return NT_STATUS_OK;
 }
 
-
-/*
-  pull a union from a blob using NDR
-*/
-NTSTATUS ndr_pull_union_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, uint32_t level, void *p,
-                            ndr_pull_union_fn_t fn)
-{
-       struct ndr_pull *ndr;
-       ndr = ndr_pull_init_blob(blob, mem_ctx);
-       if (!ndr) {
-               return NT_STATUS_NO_MEMORY;
-       }
-       return fn(ndr, NDR_SCALARS|NDR_BUFFERS, level, p);
-}
-
 /*
   pull a struct from a blob using NDR
 */
@@ -786,3 +764,52 @@ NTSTATUS ndr_push_struct_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p,
 
        return NT_STATUS_OK;
 }
+
+/*
+  generic ndr_size_*() handler for structures
+*/
+size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push)
+{
+       struct ndr_push *ndr;
+       NTSTATUS status;
+       size_t ret;
+
+       /* avoid recursion */
+       if (flags & LIBNDR_FLAG_NO_NDR_SIZE) return 0;
+
+       ndr = ndr_push_init_ctx(NULL);
+       if (!ndr) return 0;
+       ndr->flags |= flags | LIBNDR_FLAG_NO_NDR_SIZE;
+       status = push(ndr, NDR_SCALARS|NDR_BUFFERS, discard_const(p));
+       if (!NT_STATUS_IS_OK(status)) {
+               return 0;
+       }
+       ret = ndr->offset;
+       talloc_free(ndr);
+       return ret;
+}
+
+/*
+  generic ndr_size_*() handler for unions
+*/
+size_t ndr_size_union(const void *p, int flags, uint32_t level, ndr_push_flags_fn_t push)
+{
+       struct ndr_push *ndr;
+       NTSTATUS status;
+       size_t ret;
+
+       /* avoid recursion */
+       if (flags & LIBNDR_FLAG_NO_NDR_SIZE) return 0;
+
+       ndr = ndr_push_init_ctx(NULL);
+       if (!ndr) return 0;
+       ndr->flags |= flags | LIBNDR_FLAG_NO_NDR_SIZE;
+       ndr_push_set_switch_value(ndr, p, level);
+       status = push(ndr, NDR_SCALARS|NDR_BUFFERS, discard_const(p));
+       if (!NT_STATUS_IS_OK(status)) {
+               return 0;
+       }
+       ret = ndr->offset;
+       talloc_free(ndr);
+       return ret;
+}