source4/scripting/ejs/ejsrpc.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    ejs <-> rpc interface definitions
   5
   6    Copyright (C) Andrew Tridgell 2005
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 */
  22
  23 struct ejs_rpc {
  24         int eid;
  25         const char *callname;
  26         /* as ejs does only one pass, we can use a single var for switch
  27            handling */
  28         uint32_t switch_var;
  29 };
  30
  31 typedef NTSTATUS (*ejs_pull_t)(struct ejs_rpc *, struct MprVar *, const char *, void *);
  32 typedef NTSTATUS (*ejs_push_t)(struct ejs_rpc *, struct MprVar *, const char *, const void *);
  33 typedef NTSTATUS (*ejs_pull_function_t)(struct ejs_rpc *, struct MprVar *, void *);
  34 typedef NTSTATUS (*ejs_push_function_t)(struct ejs_rpc *, struct MprVar *, const void *);
  35
  36 NTSTATUS ejs_panic(struct ejs_rpc *ejs, const char *why);
  37 void ejs_set_switch(struct ejs_rpc *ejs, uint32_t switch_var);
  38
  39 NTSTATUS smbcalls_register_ejs(const char *name, MprCFunction fn);
  40
  41
  42 int ejs_rpc_call(int eid, int argc, struct MprVar **argv,
  43                  const struct dcerpc_interface_table *iface, int callnum,
  44                  ejs_pull_function_t ejs_pull, ejs_push_function_t ejs_push);
  45
  46 NTSTATUS ejs_pull_struct_start(struct ejs_rpc *ejs, struct MprVar **v, const char *name);
  47 NTSTATUS ejs_push_struct_start(struct ejs_rpc *ejs, struct MprVar **v, const char *name);
  48
  49 NTSTATUS ejs_pull_uint8(struct ejs_rpc *ejs,
  50                         struct MprVar *v, const char *name, uint8_t *r);
  51 NTSTATUS ejs_push_uint8(struct ejs_rpc *ejs,
  52                         struct MprVar *v, const char *name, const uint8_t *r);
  53 NTSTATUS ejs_pull_uint16(struct ejs_rpc *ejs,
  54                          struct MprVar *v, const char *name, uint16_t *r);
  55 NTSTATUS ejs_push_uint16(struct ejs_rpc *ejs,
  56                          struct MprVar *v, const char *name, const uint16_t *r);
  57 NTSTATUS ejs_pull_uint32(struct ejs_rpc *ejs,
  58                          struct MprVar *v, const char *name, uint32_t *r);
  59 NTSTATUS ejs_push_int32(struct ejs_rpc *ejs,
  60                          struct MprVar *v, const char *name, const int32_t *r);
  61 NTSTATUS ejs_pull_int32(struct ejs_rpc *ejs,
  62                          struct MprVar *v, const char *name, int32_t *r);
  63 NTSTATUS ejs_push_uint32(struct ejs_rpc *ejs,
  64                          struct MprVar *v, const char *name, const uint32_t *r);
  65 NTSTATUS ejs_pull_hyper(struct ejs_rpc *ejs,
  66                         struct MprVar *v, const char *name, uint64_t *r);
  67 NTSTATUS ejs_push_hyper(struct ejs_rpc *ejs,
  68                         struct MprVar *v, const char *name, const uint64_t *r);
  69 NTSTATUS ejs_pull_dlong(struct ejs_rpc *ejs,
  70                         struct MprVar *v, const char *name, uint64_t *r);
  71 NTSTATUS ejs_push_dlong(struct ejs_rpc *ejs,
  72                         struct MprVar *v, const char *name, const uint64_t *r);
  73 NTSTATUS ejs_pull_udlong(struct ejs_rpc *ejs,
  74                         struct MprVar *v, const char *name, uint64_t *r);
  75 NTSTATUS ejs_push_udlong(struct ejs_rpc *ejs,
  76                         struct MprVar *v, const char *name, const uint64_t *r);
  77 NTSTATUS ejs_pull_NTTIME(struct ejs_rpc *ejs,
  78                         struct MprVar *v, const char *name, uint64_t *r);
  79 NTSTATUS ejs_push_NTTIME(struct ejs_rpc *ejs,
  80                         struct MprVar *v, const char *name, const uint64_t *r);
  81 NTSTATUS ejs_pull_enum(struct ejs_rpc *ejs,
  82                        struct MprVar *v, const char *name, unsigned *r);
  83 NTSTATUS ejs_push_enum(struct ejs_rpc *ejs,
  84                        struct MprVar *v, const char *name, const unsigned *r);
  85 NTSTATUS ejs_pull_string(struct ejs_rpc *ejs,
  86                          struct MprVar *v, const char *name, const char **s);
  87 NTSTATUS ejs_push_string(struct ejs_rpc *ejs,
  88                          struct MprVar *v, const char *name, const char *s);
  89 void ejs_set_constant_int(int eid, const char *name, int value);
  90 void ejs_set_constant_string(int eid, const char *name, const char *value);
  91
  92 NTSTATUS ejs_pull_dom_sid(struct ejs_rpc *ejs,
  93                           struct MprVar *v, const char *name, struct dom_sid *r);
  94 NTSTATUS ejs_push_dom_sid(struct ejs_rpc *ejs,
  95                           struct MprVar *v, const char *name, const struct dom_sid *r);
  96 NTSTATUS ejs_push_null(struct ejs_rpc *ejs, struct MprVar *v, const char *name);
  97 BOOL ejs_pull_null(struct ejs_rpc *ejs, struct MprVar *v, const char *name);
  98 NTSTATUS ejs_push_WERROR(struct ejs_rpc *ejs,
  99                          struct MprVar *v, const char *name, const WERROR *r);
 100 NTSTATUS ejs_push_NTSTATUS(struct ejs_rpc *ejs,
 101                          struct MprVar *v, const char *name, const NTSTATUS *r);
 102 NTSTATUS ejs_pull_DATA_BLOB(struct ejs_rpc *ejs,
 103                             struct MprVar *v, const char *name, DATA_BLOB *r);
 104 NTSTATUS ejs_push_DATA_BLOB(struct ejs_rpc *ejs,
 105                             struct MprVar *v, const char *name, const DATA_BLOB *r);
 106 NTSTATUS ejs_pull_BOOL(struct ejs_rpc *ejs,
 107                        struct MprVar *v, const char *name, BOOL *r);
 108 NTSTATUS ejs_push_BOOL(struct ejs_rpc *ejs,
 109                        struct MprVar *v, const char *name, const BOOL *r);
 110
 111 NTSTATUS ejs_pull_array_uint8(struct ejs_rpc *ejs,
 112                               struct MprVar *v, const char *name,
 113                               uint8_t *r, uint32_t length);
 114 NTSTATUS ejs_push_array_uint8(struct ejs_rpc *ejs,
 115                               struct MprVar *v, const char *name,
 116                               const uint8_t *r, uint32_t length);
 117
 118 #define EJS_ALLOC_SIZE(ejs, s, size) do { \
 119   (s) = talloc_size(ejs, size); \
 120   if (!(s)) return ejs_panic(ejs, "out of memory"); \
 121 } while (0)
 122
 123 #define EJS_ALLOC(ejs, s) EJS_ALLOC_SIZE(ejs, s, sizeof(*(s)))
 124
 125 #define EJS_ALLOC_N_SIZE(ejs, s, n, elsize) do { \
 126         (s) = talloc_array_size(ejs, elsize, n); \
 127         if (!(s)) return ejs_panic(ejs, "out of memory"); \
 128 } while (0)
 129
 130 #define EJS_ALLOC_N(ejs, s, n) EJS_ALLOC_N_SIZE(ejs, s, n, sizeof(*(s)))
 131
 132 /* some types are equivalent for ejs */
 133 #define ejs_pull_dom_sid2 ejs_pull_dom_sid
 134 #define ejs_push_dom_sid2 ejs_push_dom_sid
 135 #define ejs_pull_NTTIME_hyper ejs_pull_NTTIME
 136 #define ejs_push_NTTIME_hyper ejs_push_NTTIME
 137