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->{PROPERTIES}->{uuid});
  81         my $if_version = $interface->{PROPERTIES}->{version};
  82
  83         pidl "
  84 static NTSTATUS $name\__op_bind(struct dcesrv_call_state *dce_call, const struct dcesrv_interface *iface)
  85 {
  86 #ifdef DCESRV_INTERFACE_$uname\_BIND
  87         return DCESRV_INTERFACE_$uname\_BIND(dce_call,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                 dcerpc_log_packet(&ndr_table_$name, opnum, NDR_IN,
 124                                   &dce_call->pkt.u.request.stub_and_verifier);
 125                 dce_call->fault_code = DCERPC_FAULT_NDR;
 126                 return NT_STATUS_NET_WRITE_FAULT;
 127         }
 128
 129         return NT_STATUS_OK;
 130 }
 131
 132 static NTSTATUS $name\__op_dispatch(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, void *r)
 133 {
 134         uint16_t opnum = dce_call->pkt.u.request.opnum;
 135
 136         switch (opnum) {
 137 ";
 138         gen_dispatch_switch($interface);
 139
 140 pidl "
 141         default:
 142                 dce_call->fault_code = DCERPC_FAULT_OP_RNG_ERROR;
 143                 break;
 144         }
 145
 146         if (dce_call->fault_code != 0) {
 147                 dcerpc_log_packet(&ndr_table_$name, opnum, NDR_IN,
 148                                   &dce_call->pkt.u.request.stub_and_verifier);
 149                 return NT_STATUS_NET_WRITE_FAULT;
 150         }
 151
 152         return NT_STATUS_OK;
 153 }
 154
 155 static NTSTATUS $name\__op_reply(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, void *r)
 156 {
 157         uint16_t opnum = dce_call->pkt.u.request.opnum;
 158
 159         switch (opnum) {
 160 ";
 161         gen_reply_switch($interface);
 162
 163 pidl "
 164         default:
 165                 dce_call->fault_code = DCERPC_FAULT_OP_RNG_ERROR;
 166                 break;
 167         }
 168
 169         if (dce_call->fault_code != 0) {
 170                 dcerpc_log_packet(&ndr_table_$name, opnum, NDR_IN,
 171                                   &dce_call->pkt.u.request.stub_and_verifier);
 172                 return NT_STATUS_NET_WRITE_FAULT;
 173         }
 174
 175         return NT_STATUS_OK;
 176 }
 177
 178 static NTSTATUS $name\__op_ndr_push(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, struct ndr_push *push, const void *r)
 179 {
 180         enum ndr_err_code ndr_err;
 181         uint16_t opnum = dce_call->pkt.u.request.opnum;
 182
 183         ndr_err = ndr_table_$name.calls[opnum].ndr_push(push, NDR_OUT, r);
 184         if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 185                 dce_call->fault_code = DCERPC_FAULT_NDR;
 186                 return NT_STATUS_NET_WRITE_FAULT;
 187         }
 188
 189         return NT_STATUS_OK;
 190 }
 191
 192 const struct dcesrv_interface dcesrv\_$name\_interface = {
 193         .name           = \"$name\",
 194         .syntax_id  = {".print_uuid($uuid).",$if_version},
 195         .bind           = $name\__op_bind,
 196         .unbind         = $name\__op_unbind,
 197         .ndr_pull       = $name\__op_ndr_pull,
 198         .dispatch       = $name\__op_dispatch,
 199         .reply          = $name\__op_reply,
 200         .ndr_push       = $name\__op_ndr_push
 201 };
 202
 203 ";
 204 }
 205
 206 #####################################################################
 207 # produce boilerplate code for an endpoint server
 208 sub Boilerplate_Ep_Server($)
 209 {
 210         my($interface) = shift;
 211         my $name = $interface->{NAME};
 212         my $uname = uc $name;
 213
 214         pidl "
 215 static NTSTATUS $name\__op_init_server(struct dcesrv_context *dce_ctx, const struct dcesrv_endpoint_server *ep_server)
 216 {
 217         int i;
 218
 219         for (i=0;i<ndr_table_$name.endpoints->count;i++) {
 220                 NTSTATUS ret;
 221                 const char *name = ndr_table_$name.endpoints->names[i];
 222
 223                 ret = dcesrv_interface_register(dce_ctx, name, &dcesrv_$name\_interface, NULL);
 224                 if (!NT_STATUS_IS_OK(ret)) {
 225                         DEBUG(1,(\"$name\_op_init_server: failed to register endpoint \'%s\'\\n\",name));
 226                         return ret;
 227                 }
 228         }
 229
 230         return NT_STATUS_OK;
 231 }
 232
 233 static bool $name\__op_interface_by_uuid(struct dcesrv_interface *iface, const struct GUID *uuid, uint32_t if_version)
 234 {
 235         if (dcesrv_$name\_interface.syntax_id.if_version == if_version &&
 236                 GUID_equal(\&dcesrv\_$name\_interface.syntax_id.uuid, uuid)) {
 237                 memcpy(iface,&dcesrv\_$name\_interface, sizeof(*iface));
 238                 return true;
 239         }
 240
 241         return false;
 242 }
 243
 244 static bool $name\__op_interface_by_name(struct dcesrv_interface *iface, const char *name)
 245 {
 246         if (strcmp(dcesrv_$name\_interface.name, name)==0) {
 247                 memcpy(iface, &dcesrv_$name\_interface, sizeof(*iface));
 248                 return true;
 249         }
 250
 251         return false;
 252 }
 253
 254 NTSTATUS dcerpc_server_$name\_init(void)
 255 {
 256         NTSTATUS ret;
 257         struct dcesrv_endpoint_server ep_server;
 258
 259         /* fill in our name */
 260         ep_server.name = \"$name\";
 261
 262         /* fill in all the operations */
 263         ep_server.init_server = $name\__op_init_server;
 264
 265         ep_server.interface_by_uuid = $name\__op_interface_by_uuid;
 266         ep_server.interface_by_name = $name\__op_interface_by_name;
 267
 268         /* register ourselves with the DCERPC subsystem. */
 269         ret = dcerpc_register_ep_server(&ep_server);
 270
 271         if (!NT_STATUS_IS_OK(ret)) {
 272                 DEBUG(0,(\"Failed to register \'$name\' endpoint server!\\n\"));
 273                 return ret;
 274         }
 275
 276         return ret;
 277 }
 278
 279 ";
 280 }
 281
 282 #####################################################################
 283 # dcerpc server boilerplate from a parsed IDL structure
 284 sub ParseInterface($)
 285 {
 286         my($interface) = shift;
 287         my $count = 0;
 288
 289         if (!defined $interface->{PROPERTIES}->{uuid}) {
 290                 return $res;
 291         }
 292
 293         if (!defined $interface->{PROPERTIES}->{version}) {
 294                 $interface->{PROPERTIES}->{version} = "0.0";
 295         }
 296
 297         foreach my $fn (@{$interface->{FUNCTIONS}}) {
 298                 if (defined($fn->{OPNUM})) { $count++; }
 299         }
 300
 301         if ($count == 0) {
 302                 return $res;
 303         }
 304
 305         $res .= "/* $interface->{NAME} - dcerpc server boilerplate generated by pidl */\n\n";
 306         Boilerplate_Iface($interface);
 307         Boilerplate_Ep_Server($interface);
 308
 309         return $res;
 310 }
 311
 312 sub Parse($$)
 313 {
 314         my($ndr,$header) = @_;
 315
 316         $res =  "";
 317         $res .= "/* server functions auto-generated by pidl */\n";
 318         $res .= "#include \"$header\"\n";
 319         $res .= "\n";
 320
 321         foreach my $x (@{$ndr}) {
 322                 ParseInterface($x) if ($x->{TYPE} eq "INTERFACE" and not defined($x->{PROPERTIES}{object}));
 323         }
 324
 325         return $res;
 326 }
 327
 328 1;