1 ###################################################
2 # server boilerplate generator
3 # Copyright tridge@samba.org 2003
4 # Copyright metze@samba.org 2004
5 # released under the GNU GPL
7 package Parse::Pidl::Samba4::NDR::Server;
10 use Parse::Pidl::Util;
12 use vars qw($VERSION);
23 #####################################################
24 # generate the switch statement for function dispatch
25 sub gen_dispatch_switch($)
27 my $interface = shift;
29 foreach my $fn (@{$interface->{FUNCTIONS}}) {
30 next if not defined($fn->{OPNUM});
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";
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";
40 pidl "\t\tdcesrv_$fn->{NAME}(dce_call, mem_ctx, r2);\n";
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";
45 pidl "\t\tbreak;\n\t}\n";
49 #####################################################
50 # generate the switch statement for function reply
51 sub gen_reply_switch($)
53 my $interface = shift;
55 foreach my $fn (@{$interface->{FUNCTIONS}}) {
56 next if not defined($fn->{OPNUM});
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";
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";
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";
69 pidl "\t\tbreak;\n\t}\n";
73 #####################################################################
74 # produce boilerplate code for a interface
75 sub Boilerplate_Iface($)
77 my($interface) = shift;
78 my $name = $interface->{NAME};
80 my $uuid = lc($interface->{PROPERTIES}->{uuid});
81 my $if_version = $interface->{PROPERTIES}->{version};
84 static NTSTATUS $name\__op_bind(struct dcesrv_call_state *dce_call, const struct dcesrv_interface *iface)
86 #ifdef DCESRV_INTERFACE_$uname\_BIND
87 return DCESRV_INTERFACE_$uname\_BIND(dce_call,iface);
93 static void $name\__op_unbind(struct dcesrv_connection_context *context, const struct dcesrv_interface *iface)
95 #ifdef DCESRV_INTERFACE_$uname\_UNBIND
96 DCESRV_INTERFACE_$uname\_UNBIND(context, iface);
102 static NTSTATUS $name\__op_ndr_pull(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, struct ndr_pull *pull, void **r)
104 enum ndr_err_code ndr_err;
105 uint16_t opnum = dce_call->pkt.u.request.opnum;
107 dce_call->fault_code = 0;
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;
114 *r = talloc_named(mem_ctx,
115 ndr_table_$name.calls[opnum].struct_size,
117 ndr_table_$name.calls[opnum].name);
118 NT_STATUS_HAVE_NO_MEMORY(*r);
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;
132 static NTSTATUS $name\__op_dispatch(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, void *r)
134 uint16_t opnum = dce_call->pkt.u.request.opnum;
138 gen_dispatch_switch($interface);
142 dce_call->fault_code = DCERPC_FAULT_OP_RNG_ERROR;
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;
155 static NTSTATUS $name\__op_reply(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, void *r)
157 uint16_t opnum = dce_call->pkt.u.request.opnum;
161 gen_reply_switch($interface);
165 dce_call->fault_code = DCERPC_FAULT_OP_RNG_ERROR;
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;
178 static NTSTATUS $name\__op_ndr_push(struct dcesrv_call_state *dce_call, TALLOC_CTX *mem_ctx, struct ndr_push *push, const void *r)
180 enum ndr_err_code ndr_err;
181 uint16_t opnum = dce_call->pkt.u.request.opnum;
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;
192 const struct dcesrv_interface dcesrv\_$name\_interface = {
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
206 #####################################################################
207 # produce boilerplate code for an endpoint server
208 sub Boilerplate_Ep_Server($)
210 my($interface) = shift;
211 my $name = $interface->{NAME};
212 my $uname = uc $name;
215 static NTSTATUS $name\__op_init_server(struct dcesrv_context *dce_ctx, const struct dcesrv_endpoint_server *ep_server)
219 for (i=0;i<ndr_table_$name.endpoints->count;i++) {
221 const char *name = ndr_table_$name.endpoints->names[i];
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));
233 static bool $name\__op_interface_by_uuid(struct dcesrv_interface *iface, const struct GUID *uuid, uint32_t if_version)
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));
244 static bool $name\__op_interface_by_name(struct dcesrv_interface *iface, const char *name)
246 if (strcmp(dcesrv_$name\_interface.name, name)==0) {
247 memcpy(iface, &dcesrv_$name\_interface, sizeof(*iface));
254 NTSTATUS dcerpc_server_$name\_init(void)
257 struct dcesrv_endpoint_server ep_server;
259 /* fill in our name */
260 ep_server.name = \"$name\";
262 /* fill in all the operations */
263 ep_server.init_server = $name\__op_init_server;
265 ep_server.interface_by_uuid = $name\__op_interface_by_uuid;
266 ep_server.interface_by_name = $name\__op_interface_by_name;
268 /* register ourselves with the DCERPC subsystem. */
269 ret = dcerpc_register_ep_server(&ep_server);
271 if (!NT_STATUS_IS_OK(ret)) {
272 DEBUG(0,(\"Failed to register \'$name\' endpoint server!\\n\"));
282 #####################################################################
283 # dcerpc server boilerplate from a parsed IDL structure
284 sub ParseInterface($)
286 my($interface) = shift;
289 if (!defined $interface->{PROPERTIES}->{uuid}) {
293 if (!defined $interface->{PROPERTIES}->{version}) {
294 $interface->{PROPERTIES}->{version} = "0.0";
297 foreach my $fn (@{$interface->{FUNCTIONS}}) {
298 if (defined($fn->{OPNUM})) { $count++; }
305 $res .= "/* $interface->{NAME} - dcerpc server boilerplate generated by pidl */\n\n";
306 Boilerplate_Iface($interface);
307 Boilerplate_Ep_Server($interface);
314 my($ndr,$header) = @_;
317 $res .= "/* server functions auto-generated by pidl */\n";
318 $res .= "#include \"$header\"\n";
321 foreach my $x (@{$ndr}) {
322 ParseInterface($x) if ($x->{TYPE} eq "INTERFACE" and not defined($x->{PROPERTIES}{object}));