pidl/lib/Parse/Pidl/Samba4/NDR/Server.pm

   1 ###################################################
   2 # server boilerplate generator
   3 # Copyright tridge@samba.org 2003
   4 # Copyright metze@samba.org 2004
   5 # released under the GNU GPL
   6
   7 package Parse::Pidl::Samba4::NDR::Server;
   8
   9 use strict;
  10 use Parse::Pidl::Util;
  11
  12 use vars qw($VERSION);
  13 $VERSION = '0.01';
  14
  15 my($res);
  16
  17 sub pidl($)
  18 {
  19         $res .= shift;
  20 }
  21
  22
  23 #####################################################
  24 # generate the switch statement for function dispatch
  25 sub gen_dispatch_switch($)
  26 {
  27         my $interface = shift;
  28
  29         foreach my $fn (@{$interface->{FUNCTIONS}}) {
  30                 next if not defined($fn->{OPNUM});
  31
  32                 pidl "\tcase $fn->{OPNUM}: {\n";
  33                 pidl "\t\tstruct $fn->{NAME} *r2 = (struct $fn->{NAME} *)r;\n";
  34                 pidl "\t\tif (DEBUGLEVEL >= 10) {\n";
  35                 pidl "\t\t\tNDR_PRINT_FUNCTION_DEBUG($fn->{NAME}, NDR_IN, r2);\n";
  36                 pidl "\t\t}\n";
  37                 if ($fn->{RETURN_TYPE} && $fn->{RETURN_TYPE} ne "void") {
  38                         pidl "\t\tr2->out.result = dcesrv_$fn->{NAME}(dce_call, mem_ctx, r2);\n";
  39                 } else {
  40                         pidl "\t\tdcesrv_$fn->{NAME}(dce_call, mem_ctx, r2);\n";
  41                 }
  42                 pidl "\t\tif (dce_call->state_flags & DCESRV_CALL_STATE_FLAG_ASYNC) {\n";
  43                 pidl "\t\t\tDEBUG(5,(\"function $fn->{NAME} will reply async\\n\"));\n";
  44                 pidl "\t\t}\n";
  45                 pidl "\t\tbreak;\n\t}\n";
  46         }
  47 }
  48
  49 #####################################################
  50 # generate the switch statement for function reply
  51 sub gen_reply_switch($)
  52 {
  53         my $interface = shift;
  54
  55         foreach my $fn (@{$interface->{FUNCTIONS}}) {
  56                 next if not defined($fn->{OPNUM});
  57
  58                 pidl "\tcase $fn->{OPNUM}: {\n";
  59                 pidl "\t\tstruct $fn->{NAME} *r2 = (struct $fn->{NAME} *)r;\n";
  60                 pidl "\t\tif (dce_call->state_flags & DCESRV_CALL_STATE_FLAG_ASYNC) {\n";
  61                 pidl "\t\t\tDEBUG(5,(\"function $fn->{NAME} replied async\\n\"));\n";
  62                 pidl "\t\t}\n";
  63                 pidl "\t\tif (DEBUGLEVEL >= 10 && dce_call->fault_code == 0) {\n";
  64                 pidl "\t\t\tNDR_PRINT_FUNCTION_DEBUG($fn->{NAME}, NDR_OUT | NDR_SET_VALUES, r2);\n";
  65                 pidl "\t\t}\n";
  66                 pidl "\t\tif (dce_call->fault_code != 0) {\n";
  67                 pidl "\t\t\tDEBUG(2,(\"dcerpc_fault %s in $fn->{NAME}\\n\", dcerpc_errstr(mem_ctx, dce_call->fault_code)));\n";
  68                 pidl "\t\t}\n";
  69                 pidl "\t\tbreak;\n\t}\n";
  70         }
  71 }
  72
  73 #####################################################################
  74 # produce boilerplate code for a interface
  75 sub Boilerplate_Iface($)
  76 {
  77         my($interface) = shift;
  78         my $name = $interface->{NAME};
  79         my $uname = uc $name;
  80         my $uuid = lc($interface->{UUID});
  81         my $if_version = $interface->{VERSION};
  82
  83         pidl "
  84 static NTSTATUS $name\__op_bind(struct dcesrv_connection_context *context, const struct dcesrv_interface *iface)
  85 {
  86 #ifdef DCESRV_INTERFACE_$uname\_BIND
  87         return DCESRV_INTERFACE_$uname\_BIND(context,iface);
  88 #else
  89         return NT_STATUS_OK;
  90 #endif
  91 }
  92
  93 static void $name\__op_unbind(struct dcesrv_connection_context *context, const struct dcesrv_interface *iface)
  94 {
  95 #ifdef DCESRV_INTERFACE_$uname\_UNBIND
  96         DCESRV_INTERFACE_$uname\_UNBIND(context, iface);
  97 #else
  98         return;
  99 #endif
 100 }
 101
 102 static NTSTATUS $name\__op_ndr_pull(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, struct ndr_pull *pull, void **r)
 103 {
 104         enum ndr_err_code ndr_err;
 105         uint16_t opnum = dce_call->pkt.u.request.opnum;
 106
 107         dce_call->fault_code = 0;
 108
 109         if (opnum >= ndr_table_$name.num_calls) {
 110                 dce_call->fault_code = DCERPC_FAULT_OP_RNG_ERROR;
 111                 return NT_STATUS_NET_WRITE_FAULT;
 112         }
 113
 114         *r = talloc_named(mem_ctx,
 115                           ndr_table_$name.calls[opnum].struct_size,
 116                           \"struct %s\",
 117                           ndr_table_$name.calls[opnum].name);
 118         NT_STATUS_HAVE_NO_MEMORY(*r);
 119
 120         /* unravel the NDR for the packet */
 121         ndr_err = ndr_table_$name.calls[opnum].ndr_pull(pull, NDR_IN, *r);
 122         if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 123                 dce_call->fault_code = DCERPC_FAULT_NDR;
 124                 return NT_STATUS_NET_WRITE_FAULT;
 125         }
 126
 127         return NT_STATUS_OK;
 128 }
 129
 130 static NTSTATUS $name\__op_dispatch(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, void *r)
 131 {
 132         uint16_t opnum = dce_call->pkt.u.request.opnum;
 133
 134         switch (opnum) {
 135 ";
 136         gen_dispatch_switch($interface);
 137
 138 pidl "
 139         default:
 140                 dce_call->fault_code = DCERPC_FAULT_OP_RNG_ERROR;
 141                 break;
 142         }
 143
 144         if (dce_call->fault_code != 0) {
 145                 return NT_STATUS_NET_WRITE_FAULT;
 146         }
 147
 148         return NT_STATUS_OK;
 149 }
 150
 151 static NTSTATUS $name\__op_reply(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, void *r)
 152 {
 153         uint16_t opnum = dce_call->pkt.u.request.opnum;
 154
 155         switch (opnum) {
 156 ";
 157         gen_reply_switch($interface);
 158
 159 pidl "
 160         default:
 161                 dce_call->fault_code = DCERPC_FAULT_OP_RNG_ERROR;
 162                 break;
 163         }
 164
 165         if (dce_call->fault_code != 0) {
 166                 return NT_STATUS_NET_WRITE_FAULT;
 167         }
 168
 169         return NT_STATUS_OK;
 170 }
 171
 172 static NTSTATUS $name\__op_ndr_push(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, struct ndr_push *push, const void *r)
 173 {
 174         enum ndr_err_code ndr_err;
 175         uint16_t opnum = dce_call->pkt.u.request.opnum;
 176
 177         ndr_err = ndr_table_$name.calls[opnum].ndr_push(push, NDR_OUT, r);
 178         if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 179                 dce_call->fault_code = DCERPC_FAULT_NDR;
 180                 return NT_STATUS_NET_WRITE_FAULT;
 181         }
 182
 183         return NT_STATUS_OK;
 184 }
 185
 186 static const struct dcesrv_interface dcesrv\_$name\_interface = {
 187         .name               = \"$name\",
 188         .syntax_id          = {".print_uuid($uuid).",$if_version},
 189         .bind               = $name\__op_bind,
 190         .unbind             = $name\__op_unbind,
 191         .ndr_pull           = $name\__op_ndr_pull,
 192         .dispatch           = $name\__op_dispatch,
 193         .reply              = $name\__op_reply,
 194         .ndr_push           = $name\__op_ndr_push,
 195 #ifdef DCESRV_INTERFACE_$uname\_FLAGS
 196         .flags              = DCESRV_INTERFACE_$uname\_FLAGS
 197 #else
 198         .flags              = 0
 199 #endif
 200 };
 201
 202 ";
 203 }
 204
 205 #####################################################################
 206 # produce boilerplate code for an endpoint server
 207 sub Boilerplate_Ep_Server($)
 208 {
 209         my($interface) = shift;
 210         my $name = $interface->{NAME};
 211         my $uname = uc $name;
 212
 213         pidl "
 214 static NTSTATUS $name\__op_init_server(struct dcesrv_context *dce_ctx, const struct dcesrv_endpoint_server *ep_server)
 215 {
 216         int i;
 217 #ifdef DCESRV_INTERFACE_$uname\_NCACN_NP_SECONDARY_ENDPOINT
 218         const char *ncacn_np_secondary_endpoint =
 219                 DCESRV_INTERFACE_$uname\_NCACN_NP_SECONDARY_ENDPOINT;
 220 #else
 221         const char *ncacn_np_secondary_endpoint = NULL;
 222 #endif
 223
 224         for (i=0;i<ndr_table_$name.endpoints->count;i++) {
 225                 NTSTATUS ret;
 226                 const char *name = ndr_table_$name.endpoints->names[i];
 227
 228                 ret = dcesrv_interface_register(dce_ctx,
 229                                                 name,
 230                                                 ncacn_np_secondary_endpoint,
 231                                                 &dcesrv_$name\_interface,
 232                                                 NULL);
 233                 if (!NT_STATUS_IS_OK(ret)) {
 234                         DEBUG(1,(\"$name\_op_init_server: failed to register endpoint \'%s\'\\n\",name));
 235                         return ret;
 236                 }
 237         }
 238
 239         return NT_STATUS_OK;
 240 }
 241
 242 static bool $name\__op_interface_by_uuid(struct dcesrv_interface *iface, const struct GUID *uuid, uint32_t if_version)
 243 {
 244         if (dcesrv_$name\_interface.syntax_id.if_version == if_version &&
 245                 GUID_equal(\&dcesrv\_$name\_interface.syntax_id.uuid, uuid)) {
 246                 memcpy(iface,&dcesrv\_$name\_interface, sizeof(*iface));
 247                 return true;
 248         }
 249
 250         return false;
 251 }
 252
 253 static bool $name\__op_interface_by_name(struct dcesrv_interface *iface, const char *name)
 254 {
 255         if (strcmp(dcesrv_$name\_interface.name, name)==0) {
 256                 memcpy(iface, &dcesrv_$name\_interface, sizeof(*iface));
 257                 return true;
 258         }
 259
 260         return false;
 261 }
 262
 263 NTSTATUS dcerpc_server_$name\_init(TALLOC_CTX *ctx)
 264 {
 265         NTSTATUS ret;
 266         static const struct dcesrv_endpoint_server ep_server = {
 267             /* fill in our name */
 268             .name = \"$name\",
 269
 270             /* fill in all the operations */
 271 #ifdef DCESRV_INTERFACE_$uname\_INIT_SERVER
 272             .init_server = DCESRV_INTERFACE_$uname\_INIT_SERVER,
 273 #else
 274             .init_server = $name\__op_init_server,
 275 #endif
 276             .interface_by_uuid = $name\__op_interface_by_uuid,
 277             .interface_by_name = $name\__op_interface_by_name
 278         };
 279         /* register ourselves with the DCERPC subsystem. */
 280         ret = dcerpc_register_ep_server(&ep_server);
 281
 282         if (!NT_STATUS_IS_OK(ret)) {
 283                 DEBUG(0,(\"Failed to register \'$name\' endpoint server!\\n\"));
 284                 return ret;
 285         }
 286
 287         return ret;
 288 }
 289
 290 ";
 291 }
 292
 293 #####################################################################
 294 # dcerpc server boilerplate from a parsed IDL structure
 295 sub ParseInterface($)
 296 {
 297         my($interface) = shift;
 298         my $count = 0;
 299
 300         $res .= "NTSTATUS dcerpc_server_$interface->{NAME}\_init(TALLOC_CTX *);\n";
 301         $res .= "\n";
 302
 303         if (!defined $interface->{PROPERTIES}->{uuid}) {
 304                 return $res;
 305         }
 306
 307         if (!defined $interface->{PROPERTIES}->{version}) {
 308                 $interface->{PROPERTIES}->{version} = "0.0";
 309         }
 310
 311         foreach my $fn (@{$interface->{FUNCTIONS}}) {
 312                 if (defined($fn->{OPNUM})) { $count++; }
 313         }
 314
 315         if ($count == 0) {
 316                 return $res;
 317         }
 318
 319         $res .= "/* $interface->{NAME} - dcerpc server boilerplate generated by pidl */\n\n";
 320         Boilerplate_Iface($interface);
 321         Boilerplate_Ep_Server($interface);
 322
 323         return $res;
 324 }
 325
 326 sub Parse($$)
 327 {
 328         my($ndr,$header) = @_;
 329
 330         $res =  "";
 331         $res .= "/* server functions auto-generated by pidl */\n";
 332         $res .= "#include \"$header\"\n";
 333         $res .= "#include <util/debug.h>\n";
 334         $res .= "\n";
 335
 336         foreach my $x (@{$ndr}) {
 337                 ParseInterface($x) if ($x->{TYPE} eq "INTERFACE" and not defined($x->{PROPERTIES}{object}));
 338         }
 339
 340         return $res;
 341 }
 342
 343 1;