source4/build/pidl/stub.pm

   1 ###################################################
   2 # stub boilerplate generator
   3 # Copyright jelmer@samba.org 2004
   4 # Copyright tridge@samba.org 2003
   5 # released under the GNU GPL
   6
   7 package IdlStub;
   8
   9 use strict;
  10
  11 my($res);
  12
  13 sub pidl($)
  14 {
  15         $res .= shift;
  16 }
  17
  18
  19 #####################################################
  20 # generate the switch statement for function dispatch
  21 sub gen_dispatch_switch($)
  22 {
  23         my $data = shift;
  24
  25         my $count = 0;
  26         foreach my $d (@{$data}) {
  27                 next if ($d->{TYPE} ne "FUNCTION");
  28
  29                 pidl "\tcase $count: {\n";
  30                 if ($d->{RETURN_TYPE} && $d->{RETURN_TYPE} ne "void") {
  31                         pidl "\t\tNTSTATUS result;\n";
  32                 }
  33                 pidl "\t\tstruct $d->{NAME} *r2 = r;\n";
  34                 pidl "\t\tif (DEBUGLEVEL > 10) {\n";
  35                 pidl "\t\t\tNDR_PRINT_FUNCTION_DEBUG($d->{NAME}, NDR_IN, r2);\n";
  36                 pidl "\t\t}\n";
  37                 if ($d->{RETURN_TYPE} && $d->{RETURN_TYPE} ne "void") {
  38                         pidl "\t\tresult = vtable->$d->{NAME}(iface, mem_ctx, r2);\n";
  39                 } else {
  40                         pidl "\t\tvtable->$d->{NAME}(iface, mem_ctx, r2);\n";
  41                 }
  42                 pidl "\t\tif (DEBUGLEVEL > 10 && dce_call->fault_code == 0) {\n";
  43                 pidl "\t\t\tNDR_PRINT_FUNCTION_DEBUG($d->{NAME}, NDR_OUT | NDR_SET_VALUES, r2);\n";
  44                 pidl "\t\t}\n";
  45                 pidl "\t\tif (dce_call->fault_code != 0) {\n";
  46                 pidl "\t\t\tDEBUG(2,(\"dcerpc_fault 0x%x in $d->{NAME}\\n\", dce_call->fault_code));\n";
  47                 pidl "\t\t}\n";
  48                 pidl "\t\tbreak;\n\t}\n";
  49                 $count++;
  50         }
  51 }
  52
  53
  54 #####################################################################
  55 # produce boilerplate code for a interface
  56 sub Boilerplate_Iface($)
  57 {
  58         my($interface) = shift;
  59         my($data) = $interface->{DATA};
  60         my $count = 0;
  61         my $name = $interface->{NAME};
  62         my $uname = uc $name;
  63         my $uuid = util::make_str($interface->{PROPERTIES}->{uuid});
  64         my $if_version = $interface->{PROPERTIES}->{version};
  65
  66         pidl "
  67 static NTSTATUS $name\__op_bind(struct dcesrv_call_state *dce_call, const struct dcesrv_interface *iface)
  68 {
  69 #ifdef DCESRV_INTERFACE_$uname\_BIND
  70         return DCESRV_INTERFACE_$uname\_BIND(dce_call,iface);
  71 #else
  72         return NT_STATUS_OK;
  73 #endif
  74 }
  75
  76 static void $name\__op_unbind(struct dcesrv_connection_context *context, const struct dcesrv_interface *iface)
  77 {
  78 #ifdef DCESRV_INTERFACE_$uname\_UNBIND
  79         DCESRV_INTERFACE_$uname\_UNBIND(context,iface);
  80 #else
  81         return;
  82 #endif
  83 }
  84
  85 static NTSTATUS $name\__op_ndr_pull(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, struct ndr_pull *pull, void **r)
  86 {
  87         NTSTATUS status;
  88         uint16 opnum = dce_call->pkt.u.request.opnum;
  89
  90         dce_call->fault_code = 0;
  91
  92         if (opnum >= dcerpc_table_$name.num_calls) {
  93                 dce_call->fault_code = DCERPC_FAULT_OP_RNG_ERROR;
  94                 return NT_STATUS_NET_WRITE_FAULT;
  95         }
  96
  97         *r = talloc_size(mem_ctx, dcerpc_table_$name.calls[opnum].struct_size);
  98         if (!*r) {
  99                 return NT_STATUS_NO_MEMORY;
 100         }
 101
 102         /* unravel the NDR for the packet */
 103         status = dcerpc_table_$name.calls[opnum].ndr_pull(pull, NDR_IN, *r);
 104         if (!NT_STATUS_IS_OK(status)) {
 105                 dcerpc_log_packet(&dcerpc_table_$name, opnum, NDR_IN,
 106                                   &dce_call->pkt.u.request.stub_and_verifier);
 107                 dce_call->fault_code = DCERPC_FAULT_NDR;
 108                 return NT_STATUS_NET_WRITE_FAULT;
 109         }
 110
 111         return NT_STATUS_OK;
 112 }
 113
 114 static NTSTATUS $name\__op_dispatch(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, void *r)
 115 {
 116         uint16 opnum = dce_call->pkt.u.request.opnum;
 117         struct GUID ipid = dce_call->pkt.u.request.object.object;
 118         struct dcom_interface_p *iface = dcom_get_local_iface_p(&ipid);
 119         const struct dcom_$name\_vtable *vtable = iface->vtable;
 120
 121         dce_call->fault_code = 0;
 122
 123         switch (opnum) {
 124 ";
 125         gen_dispatch_switch($data);
 126
 127 pidl "
 128         default:
 129                 dce_call->fault_code = DCERPC_FAULT_OP_RNG_ERROR;
 130                 break;
 131         }
 132
 133         if (dce_call->fault_code != 0) {
 134                 dcerpc_log_packet(&dcerpc_table_$name, opnum, NDR_IN,
 135                                   &dce_call->pkt.u.request.stub_and_verifier);
 136                 return NT_STATUS_NET_WRITE_FAULT;
 137         }
 138
 139         return NT_STATUS_OK;
 140 }
 141
 142 static NTSTATUS $name\__op_ndr_push(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, struct ndr_push *push, void *r)
 143 {
 144         NTSTATUS status;
 145         uint16 opnum = dce_call->pkt.u.request.opnum;
 146
 147         status = dcerpc_table_$name.calls[opnum].ndr_push(push, NDR_OUT, r);
 148         if (!NT_STATUS_IS_OK(status)) {
 149                 dce_call->fault_code = DCERPC_FAULT_NDR;
 150                 return NT_STATUS_NET_WRITE_FAULT;
 151         }
 152
 153         return NT_STATUS_OK;
 154 }
 155
 156 static const struct dcesrv_interface $name\_interface = {
 157         \"$name\",
 158         $uuid,
 159         $if_version,
 160         $name\__op_bind,
 161         $name\__op_unbind,
 162         $name\__op_ndr_pull,
 163         $name\__op_dispatch,
 164         $name\__op_ndr_push
 165 };
 166
 167 ";
 168 }
 169
 170 #####################################################################
 171 # produce boilerplate code for an endpoint server
 172 sub Boilerplate_Ep_Server($)
 173 {
 174         my($interface) = shift;
 175         my $name = $interface->{NAME};
 176         my $uname = uc $name;
 177
 178         pidl "
 179 static NTSTATUS $name\__op_init_server(struct dcesrv_context *dce_ctx, const struct dcesrv_endpoint_server *ep_server)
 180 {
 181         int i;
 182
 183         for (i=0;i<dcerpc_table_$name.endpoints->count;i++) {
 184                 NTSTATUS ret;
 185                 const char *name = dcerpc_table_$name.endpoints->names[i];
 186
 187                 ret = dcesrv_interface_register(dce_ctx, name, &$name\_interface, NULL);
 188                 if (!NT_STATUS_IS_OK(ret)) {
 189                         DEBUG(1,(\"$name\_op_init_server: failed to register endpoint \'%s\'\\n\",name));
 190                         return ret;
 191                 }
 192         }
 193
 194         return NT_STATUS_OK;
 195 }
 196
 197 static BOOL $name\__op_interface_by_uuid(struct dcesrv_interface *iface, const char *uuid, uint32 if_version)
 198 {
 199         if (dcerpc_table_$name.if_version == if_version &&
 200                 strcmp(dcerpc_table_$name.uuid, uuid)==0) {
 201                 memcpy(iface,&dcerpc_table_$name, sizeof(*iface));
 202                 return True;
 203         }
 204
 205         return False;
 206 }
 207
 208 static BOOL $name\__op_interface_by_name(struct dcesrv_interface *iface, const char *name)
 209 {
 210         if (strcmp(dcerpc_table_$name.name, name)==0) {
 211                 memcpy(iface,&dcerpc_table_$name, sizeof(*iface));
 212                 return True;
 213         }
 214
 215         return False;
 216 }
 217
 218 NTSTATUS dcerpc_server_$name\_init(void)
 219 {
 220         NTSTATUS ret;
 221         struct dcesrv_endpoint_server ep_server;
 222
 223         /* fill in our name */
 224         ep_server.name = \"$name\";
 225
 226         /* fill in all the operations */
 227         ep_server.init_server = $name\__op_init_server;
 228
 229         ep_server.interface_by_uuid = $name\__op_interface_by_uuid;
 230         ep_server.interface_by_name = $name\__op_interface_by_name;
 231
 232         /* register ourselves with the DCERPC subsystem. */
 233         ret = dcerpc_register_ep_server(&ep_server);
 234
 235         if (!NT_STATUS_IS_OK(ret)) {
 236                 DEBUG(0,(\"Failed to register \'$name\' endpoint server!\\n\"));
 237                 return ret;
 238         }
 239
 240         return ret;
 241 }
 242
 243 ";
 244 }
 245
 246 sub ParseInterface($)
 247 {
 248         my($interface) = shift;
 249                 my($data) = $interface->{DATA};
 250         my $count = 0;
 251
 252         $res = "";
 253
 254         if (!defined $interface->{PROPERTIES}->{uuid}) {
 255                 return $res;
 256         }
 257
 258         if (!defined $interface->{PROPERTIES}->{version}) {
 259                 $interface->{PROPERTIES}->{version} = "0.0";
 260         }
 261
 262         foreach my $d (@{$data}) {
 263                 if ($d->{TYPE} eq "FUNCTION") { $count++; }
 264         }
 265
 266         if ($count == 0) {
 267                 return $res;
 268         }
 269
 270         $res = "/* dcom interface stub generated by pidl */\n\n";
 271         Boilerplate_Iface($interface);
 272         Boilerplate_Ep_Server($interface);
 273
 274         return $res;
 275 }
 276
 277 1;