lib/tdr/tdr.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    TDR definitions
   4    Copyright (C) Jelmer Vernooij 2005
   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 3 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, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef __TDR_H__
  21 #define __TDR_H__
  22
  23 #include <talloc.h>
  24 #include "../lib/util/charset/charset.h"
  25
  26 #define TDR_BIG_ENDIAN                  0x01
  27 #define TDR_ALIGN2                      0x02
  28 #define TDR_ALIGN4                      0x04
  29 #define TDR_ALIGN8                      0x08
  30 #define TDR_REMAINING                   0x10
  31
  32 struct tdr_pull {
  33         DATA_BLOB data;
  34         uint32_t offset;
  35         int flags;
  36 };
  37
  38 struct tdr_push {
  39         DATA_BLOB data;
  40         int flags;
  41 };
  42
  43 struct tdr_print {
  44         int level;
  45         void (*print)(struct tdr_print *, const char *, ...);
  46         int flags;
  47 };
  48
  49 #define TDR_CHECK(call) do { NTSTATUS _status; \
  50                              _status = call; \
  51                              if (!NT_STATUS_IS_OK(_status)) \
  52                                 return _status; \
  53                         } while (0)
  54
  55 #define TDR_ALLOC(ctx, s, n) do { \
  56                                (s) = talloc_array_ptrtype(ctx, (s), n); \
  57                            if ((n) && !(s)) return NT_STATUS_NO_MEMORY; \
  58                            } while (0)
  59
  60 typedef NTSTATUS (*tdr_push_fn_t) (struct tdr_push *, const void *);
  61 typedef NTSTATUS (*tdr_pull_fn_t) (struct tdr_pull *, TALLOC_CTX *, void *);
  62
  63 NTSTATUS tdr_push_expand(struct tdr_push *tdr, uint32_t size);
  64 NTSTATUS tdr_pull_uint8(struct tdr_pull *tdr, TALLOC_CTX *ctx, uint8_t *v);
  65 NTSTATUS tdr_push_uint8(struct tdr_push *tdr, const uint8_t *v);
  66 NTSTATUS tdr_print_uint8(struct tdr_print *tdr, const char *name, uint8_t *v);
  67 NTSTATUS tdr_pull_uint16(struct tdr_pull *tdr, TALLOC_CTX *ctx, uint16_t *v);
  68 NTSTATUS tdr_pull_uint1632(struct tdr_pull *tdr, TALLOC_CTX *ctx, uint16_t *v);
  69 NTSTATUS tdr_push_uint16(struct tdr_push *tdr, const uint16_t *v);
  70 NTSTATUS tdr_push_uint1632(struct tdr_push *tdr, const uint16_t *v);
  71 NTSTATUS tdr_print_uint16(struct tdr_print *tdr, const char *name, uint16_t *v);
  72 NTSTATUS tdr_pull_uint32(struct tdr_pull *tdr, TALLOC_CTX *ctx, uint32_t *v);
  73 NTSTATUS tdr_push_uint32(struct tdr_push *tdr, const uint32_t *v);
  74 NTSTATUS tdr_print_uint32(struct tdr_print *tdr, const char *name, uint32_t *v);
  75 NTSTATUS tdr_pull_charset(struct tdr_pull *tdr, TALLOC_CTX *ctx, const char **v, uint32_t length, uint32_t el_size, charset_t chset);
  76 NTSTATUS tdr_push_charset(struct tdr_push *tdr, const char **v, uint32_t length, uint32_t el_size, charset_t chset);
  77 NTSTATUS tdr_print_charset(struct tdr_print *tdr, const char *name, const char **v, uint32_t length, uint32_t el_size, charset_t chset);
  78
  79 NTSTATUS tdr_pull_hyper(struct tdr_pull *tdr, TALLOC_CTX *ctx, uint64_t *v);
  80 NTSTATUS tdr_push_hyper(struct tdr_push *tdr, uint64_t *v);
  81
  82 NTSTATUS tdr_push_NTTIME(struct tdr_push *tdr, NTTIME *t);
  83 NTSTATUS tdr_pull_NTTIME(struct tdr_pull *tdr, TALLOC_CTX *ctx, NTTIME *t);
  84 NTSTATUS tdr_print_NTTIME(struct tdr_print *tdr, const char *name, NTTIME *t);
  85
  86 NTSTATUS tdr_push_time_t(struct tdr_push *tdr, time_t *t);
  87 NTSTATUS tdr_pull_time_t(struct tdr_pull *tdr, TALLOC_CTX *ctx, time_t *t);
  88 NTSTATUS tdr_print_time_t(struct tdr_print *tdr, const char *name, time_t *t);
  89
  90 NTSTATUS tdr_print_DATA_BLOB(struct tdr_print *tdr, const char *name, DATA_BLOB *r);
  91 NTSTATUS tdr_push_DATA_BLOB(struct tdr_push *tdr, DATA_BLOB *blob);
  92 NTSTATUS tdr_pull_DATA_BLOB(struct tdr_pull *tdr, TALLOC_CTX *ctx, DATA_BLOB *blob);
  93
  94 struct tdr_push *tdr_push_init(TALLOC_CTX *mem_ctx);
  95 struct tdr_pull *tdr_pull_init(TALLOC_CTX *mem_ctx);
  96
  97 NTSTATUS tdr_push_to_fd(int fd, tdr_push_fn_t push_fn, const void *p);
  98 void tdr_print_debug_helper(struct tdr_print *tdr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
  99
 100 #endif /* __TDR_H__ */