1 ###################################################
2 # client calls generator
3 # Copyright tridge@samba.org 2003
4 # Copyright jelmer@samba.org 2005-2006
5 # released under the GNU GPL
7 package Parse::Pidl::Samba4::NDR::Client;
11 @EXPORT_OK = qw(Parse);
13 use Parse::Pidl qw(fatal warning error);
14 use Parse::Pidl::Util qw(has_property ParseExpr genpad);
15 use Parse::Pidl::NDR qw(ContainsPipe);
16 use Parse::Pidl::Typelist qw(mapTypeName);
17 use Parse::Pidl::Samba4 qw(choose_header is_intree DeclLong);
18 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv GenerateFunctionOutEnv);
20 use vars qw($VERSION);
25 sub indent($) { my ($self) = @_; $self->{tabs}.="\t"; }
26 sub deindent($) { my ($self) = @_; $self->{tabs} = substr($self->{tabs}, 1); }
27 sub pidl($$) { my ($self,$txt) = @_; $self->{res} .= $txt ? "$self->{tabs}$txt\n" : "\n"; }
28 sub pidl_hdr($$) { my ($self, $txt) = @_; $self->{res_hdr} .= "$txt\n"; }
29 sub pidl_both($$) { my ($self, $txt) = @_; $self->{hdr} .= "$txt\n"; $self->{res_hdr} .= "$txt\n"; }
30 sub fn_declare($$) { my ($self,$n) = @_; $self->pidl($n); $self->pidl_hdr("$n;"); }
35 my $self = { res => "", res_hdr => "", tabs => "" };
39 sub ParseFunctionHasPipes($$)
43 foreach my $e (@{$fn->{ELEMENTS}}) {
44 return 1 if ContainsPipe($e, $e->{LEVELS}[0]);
50 sub ParseFunction_r_State($$$$)
52 my ($self, $if, $fn, $name) = @_;
56 foreach my $e (@{$fn->{ELEMENTS}}) {
57 next unless grep(/in/, @{$e->{DIRECTION}});
58 next unless ContainsPipe($e, $e->{LEVELS}[0]);
62 foreach my $e (@{$fn->{ELEMENTS}}) {
63 next unless grep(/out/, @{$e->{DIRECTION}});
64 next unless ContainsPipe($e, $e->{LEVELS}[0]);
68 $self->pidl("struct dcerpc_$name\_r_state {");
70 if ($in_pipes > 0 or $out_pipes > 0) {
71 $self->pidl("struct dcerpc_pipe_handle_connection *in_pipes[$in_pipes];") if ($in_pipes > 0);
72 $self->pidl("struct dcerpc_pipe_handle_connection *out_pipes[$out_pipes];") if ($out_pipes > 0);
73 $self->pidl("struct dcerpc_binding_handle_call_params params;");
75 $self->pidl("TALLOC_CTX *out_mem_ctx;");
79 $self->pidl("static void dcerpc_$name\_r_done(struct tevent_req *subreq);");
83 sub ParseFunction_r_Send($$$$)
85 my ($self, $if, $fn, $name) = @_;
88 my $proto = "struct tevent_req *dcerpc_$name\_r_send(TALLOC_CTX *mem_ctx,\n";
89 $proto .= "\tstruct tevent_context *ev,\n",
90 $proto .= "\tstruct dcerpc_binding_handle *h,\n",
91 $proto .= "\tstruct $name *r)";
93 $self->fn_declare($proto);
98 $self->pidl("struct tevent_req *req;");
99 $self->pidl("struct dcerpc_$name\_r_state *state;");
100 $self->pidl("struct tevent_req *subreq;");
103 $self->pidl("req = tevent_req_create(mem_ctx, &state,");
104 $self->pidl("\t\t\tstruct dcerpc_$name\_r_state);");
105 $self->pidl("if (req == NULL) {");
107 $self->pidl("return NULL;");
113 foreach my $e (@{$fn->{ELEMENTS}}) {
114 next unless grep(/out/, @{$e->{DIRECTION}});
115 next if ContainsPipe($e, $e->{LEVELS}[0]);
121 if ($out_params > 0) {
122 $self->pidl("state->out_mem_ctx = talloc_new(state);");
123 $self->pidl("if (tevent_req_nomem(state->out_mem_ctx, req)) {");
125 $self->pidl("return tevent_req_post(req, ev);");
128 $submem = "state->out_mem_ctx";
130 $self->pidl("state->out_mem_ctx = NULL;");
136 foreach my $e (@{$fn->{ELEMENTS}}) {
137 next unless grep(/in/, @{$e->{DIRECTION}});
138 next unless ContainsPipe($e, $e->{LEVELS}[0]);
139 $self->pidl("if (r->in.$e->{NAME} == NULL) {");
141 $self->pidl("tevent_req_nterror(req, NT_STATUS_INVALID_PARAMETER_MIX);");
142 $self->pidl("return tevent_req_post(req, ev);");
145 $self->pidl("state->in_pipes[$in_pipes] = r->in.".$e->{NAME}."->pc;");
149 foreach my $e (@{$fn->{ELEMENTS}}) {
150 next unless grep(/out/, @{$e->{DIRECTION}});
151 next unless ContainsPipe($e, $e->{LEVELS}[0]);
152 $self->pidl("if (r->out.$e->{NAME} == NULL) {");
154 $self->pidl("tevent_req_nterror(req, NT_STATUS_INVALID_PARAMETER_MIX);");
155 $self->pidl("return tevent_req_post(req, ev);");
158 $self->pidl("state->out_pipes[$out_pipes] = r->out.".$e->{NAME}."->pc;");
162 if ($in_pipes > 0 or $out_pipes > 0) {
163 $self->pidl("state->params.r_mem = $submem;");
164 $self->pidl("state->params.r_ptr = r;");
165 $self->pidl("state->params.in.num_pipes = $in_pipes;");
167 $self->pidl("state->params.in.pipes = state->in_pipes;");
169 $self->pidl("state->params.in.pipes = NULL;");
171 $self->pidl("state->params.out.num_pipes = $out_pipes;");
172 if ($out_pipes > 0) {
173 $self->pidl("state->params.out.pipes = state->out_pipes;");
175 $self->pidl("state->params.out.pipes = NULL;");
179 $self->pidl("subreq = dcerpc_binding_handle_call_params_send(state, ev, h,");
180 $self->pidl("\t\tNULL, &ndr_table_$if->{NAME},");
181 $self->pidl("\t\tNDR_$uname, &state->params);");
183 $self->pidl("subreq = dcerpc_binding_handle_call_send(state, ev, h,");
184 $self->pidl("\t\tNULL, &ndr_table_$if->{NAME},");
185 $self->pidl("\t\tNDR_$uname, $submem, r);");
187 $self->pidl("if (tevent_req_nomem(subreq, req)) {");
189 $self->pidl("return tevent_req_post(req, ev);");
192 $self->pidl("tevent_req_set_callback(subreq, dcerpc_$name\_r_done, req);");
195 $self->pidl("return req;");
201 sub ParseFunction_r_Done($$$$)
203 my ($self, $if, $fn, $name) = @_;
204 my $uname = uc $name;
206 my $proto = "static void dcerpc_$name\_r_done(struct tevent_req *subreq)";
209 foreach my $e (@{$fn->{ELEMENTS}}) {
210 next unless grep(/in/, @{$e->{DIRECTION}});
211 next unless ContainsPipe($e, $e->{LEVELS}[0]);
215 foreach my $e (@{$fn->{ELEMENTS}}) {
216 next unless grep(/out/, @{$e->{DIRECTION}});
217 next unless ContainsPipe($e, $e->{LEVELS}[0]);
221 $self->pidl("$proto");
225 $self->pidl("struct tevent_req *req =");
226 $self->pidl("\ttevent_req_callback_data(subreq,");
227 $self->pidl("\tstruct tevent_req);");
228 $self->pidl("NTSTATUS status;");
231 if ($in_pipes > 0 or $out_pipes > 0) {
232 $self->pidl("status = dcerpc_binding_handle_call_params_recv(subreq);");
234 $self->pidl("status = dcerpc_binding_handle_call_recv(subreq);");
236 $self->pidl("TALLOC_FREE(subreq);");
237 $self->pidl("if (tevent_req_nterror(req, status)) {");
239 $self->pidl("return;");
244 $self->pidl("tevent_req_done(req);");
250 sub ParseFunction_r_Recv($$$$)
252 my ($self, $if, $fn, $name) = @_;
253 my $uname = uc $name;
255 my $proto = "NTSTATUS dcerpc_$name\_r_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx)";
257 $self->fn_declare($proto);
262 $self->pidl("struct dcerpc_$name\_r_state *state =");
263 $self->pidl("\ttevent_req_data(req,");
264 $self->pidl("\tstruct dcerpc_$name\_r_state);");
265 $self->pidl("NTSTATUS status;");
268 $self->pidl("if (tevent_req_is_nterror(req, &status)) {");
270 $self->pidl("tevent_req_received(req);");
271 $self->pidl("return status;");
276 $self->pidl("talloc_steal(mem_ctx, state->out_mem_ctx);");
279 $self->pidl("tevent_req_received(req);");
280 $self->pidl("return NT_STATUS_OK;");
286 sub ParseFunction_r_Sync($$$$)
288 my ($self, $if, $fn, $name) = @_;
289 my $uname = uc $name;
291 if ($self->ParseFunctionHasPipes($fn)) {
292 $self->pidl_both("/*");
293 $self->pidl_both(" * The following function is skipped because");
294 $self->pidl_both(" * it uses pipes:");
295 $self->pidl_both(" *");
296 $self->pidl_both(" * dcerpc_$name\_r()");
297 $self->pidl_both(" */");
298 $self->pidl_both("");
302 my $proto = "NTSTATUS dcerpc_$name\_r(struct dcerpc_binding_handle *h, TALLOC_CTX *mem_ctx, struct $name *r)";
304 $self->fn_declare($proto);
308 $self->pidl("NTSTATUS status;");
311 $self->pidl("status = dcerpc_binding_handle_call(h,");
312 $self->pidl("\t\tNULL, &ndr_table_$if->{NAME},");
313 $self->pidl("\t\tNDR_$uname, mem_ctx, r);");
315 $self->pidl("return status;");
322 sub ElementDirection($)
326 return "[in,out]" if (has_property($e, "in") and has_property($e, "out"));
327 return "[in]" if (has_property($e, "in"));
328 return "[out]" if (has_property($e, "out"));
332 sub HeaderProperties($$)
334 my($props,$ignores) = @_;
337 foreach my $d (sort(keys %{$props})) {
338 next if (grep(/^$d$/, @$ignores));
339 if($props->{$d} ne "1") {
340 $ret.= "$d($props->{$d}),";
347 return "[" . substr($ret, 0, -1) . "]";
351 sub ParseCopyArgument($$$$$)
353 my ($self, $fn, $e, $r, $i) = @_;
354 my $l = $e->{LEVELS}[0];
356 if ($l->{TYPE} eq "ARRAY" and $l->{IS_FIXED} == 1) {
357 $self->pidl("memcpy(${r}$e->{NAME}, ${i}$e->{NAME}, sizeof(${r}$e->{NAME}));");
359 $self->pidl("${r}$e->{NAME} = ${i}$e->{NAME};");
363 sub ParseInvalidResponse($$)
365 my ($self, $type) = @_;
367 if ($type eq "sync") {
368 $self->pidl("return NT_STATUS_INVALID_NETWORK_RESPONSE;");
369 } elsif ($type eq "async") {
370 $self->pidl("tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);");
371 $self->pidl("return;");
373 die("ParseInvalidResponse($type)");
377 sub ParseOutputArgument($$$$$$)
379 my ($self, $fn, $e, $r, $o, $invalid_response_type) = @_;
382 if ($e->{LEVELS}[0]->{TYPE} ne "POINTER" and $e->{LEVELS}[0]->{TYPE} ne "ARRAY") {
383 fatal($e->{ORIGINAL}, "[out] argument is not a pointer or array");
387 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
389 if ($e->{LEVELS}[0]->{POINTER_TYPE} ne "ref") {
390 $self->pidl("if ($o$e->{NAME} && ${r}out.$e->{NAME}) {");
395 if ($e->{LEVELS}[$level]->{TYPE} eq "ARRAY") {
396 # This is a call to GenerateFunctionInEnv intentionally.
397 # Since the data is being copied into a user-provided data
398 # structure, the user should be able to know the size beforehand
399 # to allocate a structure of the right size.
400 my $in_env = GenerateFunctionInEnv($fn, $r);
401 my $out_env = GenerateFunctionOutEnv($fn, $r);
402 my $l = $e->{LEVELS}[$level];
405 if (grep(/in/, @{$e->{DIRECTION}})) {
406 $in_var = ParseExpr($e->{NAME}, $in_env, $e->{ORIGINAL});
408 my $out_var = ParseExpr($e->{NAME}, $out_env, $e->{ORIGINAL});
410 my $in_size_is = undef;
411 my $out_size_is = undef;
412 my $out_length_is = undef;
414 my $avail_len = undef;
415 my $needed_len = undef;
419 my $copy_len_var = "_copy_len_$e->{NAME}";
420 $self->pidl("size_t $copy_len_var;");
422 if (not defined($l->{SIZE_IS})) {
423 if (not $l->{IS_ZERO_TERMINATED}) {
424 fatal($e->{ORIGINAL}, "no size known for [out] array `$e->{NAME}'");
426 if (has_property($e, "charset")) {
427 $avail_len = "ndr_charset_length($in_var, CH_UNIX)";
428 $needed_len = "ndr_charset_length($out_var, CH_UNIX)";
430 $avail_len = "ndr_string_length($in_var, sizeof(*$in_var))";
431 $needed_len = "ndr_string_length($out_var, sizeof(*$out_var))";
437 $in_size_is = ParseExpr($l->{SIZE_IS}, $in_env, $e->{ORIGINAL});
438 $out_size_is = ParseExpr($l->{SIZE_IS}, $out_env, $e->{ORIGINAL});
439 $out_length_is = $out_size_is;
440 if (defined($l->{LENGTH_IS})) {
441 $out_length_is = ParseExpr($l->{LENGTH_IS}, $out_env, $e->{ORIGINAL});
443 if (has_property($e, "charset")) {
444 if (defined($in_var)) {
445 $avail_len = "ndr_charset_length($in_var, CH_UNIX)";
447 $avail_len = $out_length_is;
449 $needed_len = "ndr_charset_length($out_var, CH_UNIX)";
453 if ($out_size_is ne $in_size_is) {
454 $self->pidl("if (($out_size_is) > ($in_size_is)) {");
456 $self->ParseInvalidResponse($invalid_response_type);
460 if ($out_length_is ne $out_size_is) {
461 $self->pidl("if (($out_length_is) > ($out_size_is)) {");
463 $self->ParseInvalidResponse($invalid_response_type);
467 if (defined($needed_len)) {
468 $self->pidl("$copy_len_var = $needed_len;");
469 $self->pidl("if ($copy_len_var > $avail_len) {");
471 $self->ParseInvalidResponse($invalid_response_type);
475 $self->pidl("$copy_len_var = $out_length_is;");
478 my $dest_ptr = "$o$e->{NAME}";
479 my $elem_size = "sizeof(*$dest_ptr)";
480 $self->pidl("if ($dest_ptr != $out_var) {");
482 if (has_property($e, "charset")) {
483 $dest_ptr = "discard_const_p(uint8_t *, $dest_ptr)";
485 $self->pidl("memcpy($dest_ptr, $out_var, $copy_len_var * $elem_size);");
492 $self->pidl("*$o$e->{NAME} = *${r}out.$e->{NAME};");
495 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
496 if ($e->{LEVELS}[0]->{POINTER_TYPE} ne "ref") {
503 sub ParseFunction_State($$$$)
505 my ($self, $if, $fn, $name) = @_;
507 my $state_str = "struct dcerpc_$name\_state";
508 my $done_fn = "dcerpc_$name\_done";
510 $self->pidl("$state_str {");
512 $self->pidl("struct $name orig;");
513 $self->pidl("struct $name tmp;");
514 $self->pidl("TALLOC_CTX *out_mem_ctx;");
518 $self->pidl("static void $done_fn(struct tevent_req *subreq);");
522 sub ParseFunction_Send($$$$)
524 my ($self, $if, $fn, $name) = @_;
527 my $state_str = "struct dcerpc_$name\_state";
528 my $done_fn = "dcerpc_$name\_done";
529 my $out_mem_ctx = "dcerpc_$name\_out_memory";
530 my $fn_str = "struct tevent_req *dcerpc_$name\_send";
531 my $pad = genpad($fn_str);
533 $fn_args .= "TALLOC_CTX *mem_ctx";
534 $fn_args .= ",\n" . $pad . "struct tevent_context *ev";
535 $fn_args .= ",\n" . $pad . "struct dcerpc_binding_handle *h";
537 foreach (@{$fn->{ELEMENTS}}) {
538 my $dir = ElementDirection($_);
539 my $prop = HeaderProperties($_->{PROPERTIES}, ["in", "out"]);
540 $fn_args .= ",\n" . $pad . DeclLong($_, "_") . " /* $dir $prop */";
543 $self->fn_declare("$fn_str($fn_args)");
546 $self->pidl("struct tevent_req *req;");
547 $self->pidl("$state_str *state;");
548 $self->pidl("struct tevent_req *subreq;");
550 $self->pidl("req = tevent_req_create(mem_ctx, &state,");
551 $self->pidl("\t\t\t$state_str);");
552 $self->pidl("if (req == NULL) {");
554 $self->pidl("return NULL;");
557 $self->pidl("state->out_mem_ctx = NULL;");
560 $self->pidl("/* In parameters */");
561 foreach my $e (@{$fn->{ELEMENTS}}) {
562 next unless (grep(/in/, @{$e->{DIRECTION}}));
564 $self->ParseCopyArgument($fn, $e, "state->orig.in.", "_");
569 $self->pidl("/* Out parameters */");
570 foreach my $e (@{$fn->{ELEMENTS}}) {
571 next unless grep(/out/, @{$e->{DIRECTION}});
573 $self->ParseCopyArgument($fn, $e, "state->orig.out.", "_");
575 next if ContainsPipe($e, $e->{LEVELS}[0]);
581 if (defined($fn->{RETURN_TYPE})) {
582 $self->pidl("/* Result */");
583 $self->pidl("NDR_ZERO_STRUCT(state->orig.out.result);");
587 if ($out_params > 0) {
588 $self->pidl("state->out_mem_ctx = talloc_named_const(state, 0,");
589 $self->pidl("\t\t \"$out_mem_ctx\");");
590 $self->pidl("if (tevent_req_nomem(state->out_mem_ctx, req)) {");
592 $self->pidl("return tevent_req_post(req, ev);");
598 $self->pidl("/* make a temporary copy, that we pass to the dispatch function */");
599 $self->pidl("state->tmp = state->orig;");
602 $self->pidl("subreq = dcerpc_$name\_r_send(state, ev, h, &state->tmp);");
603 $self->pidl("if (tevent_req_nomem(subreq, req)) {");
605 $self->pidl("return tevent_req_post(req, ev);");
608 $self->pidl("tevent_req_set_callback(subreq, $done_fn, req);");
609 $self->pidl("return req;");
615 sub ParseFunction_Done($$$$)
617 my ($self, $if, $fn, $name) = @_;
619 my $state_str = "struct dcerpc_$name\_state";
620 my $done_fn = "dcerpc_$name\_done";
622 $self->pidl("static void $done_fn(struct tevent_req *subreq)");
625 $self->pidl("struct tevent_req *req = tevent_req_callback_data(");
626 $self->pidl("\tsubreq, struct tevent_req);");
627 $self->pidl("$state_str *state = tevent_req_data(");
628 $self->pidl("\treq, $state_str);");
629 $self->pidl("NTSTATUS status;");
630 $self->pidl("TALLOC_CTX *mem_ctx;");
633 $self->pidl("if (state->out_mem_ctx) {");
635 $self->pidl("mem_ctx = state->out_mem_ctx;");
637 $self->pidl("} else {");
639 $self->pidl("mem_ctx = state;");
644 $self->pidl("status = dcerpc_$name\_r_recv(subreq, mem_ctx);");
645 $self->pidl("TALLOC_FREE(subreq);");
646 $self->pidl("if (tevent_req_nterror(req, status)) {");
648 $self->pidl("return;");
653 $self->pidl("/* Copy out parameters */");
654 foreach my $e (@{$fn->{ELEMENTS}}) {
655 next if ContainsPipe($e, $e->{LEVELS}[0]);
656 next unless (grep(/out/, @{$e->{DIRECTION}}));
658 $self->ParseOutputArgument($fn, $e,
665 if (defined($fn->{RETURN_TYPE})) {
666 $self->pidl("/* Copy result */");
667 $self->pidl("state->orig.out.result = state->tmp.out.result;");
671 $self->pidl("/* Reset temporary structure */");
672 $self->pidl("NDR_ZERO_STRUCT(state->tmp);");
675 $self->pidl("tevent_req_done(req);");
681 sub ParseFunction_Recv($$$$)
683 my ($self, $if, $fn, $name) = @_;
686 my $state_str = "struct dcerpc_$name\_state";
687 my $fn_str = "NTSTATUS dcerpc_$name\_recv";
688 my $pad = genpad($fn_str);
690 $fn_args .= "struct tevent_req *req,\n" . $pad . "TALLOC_CTX *mem_ctx";
692 if (defined($fn->{RETURN_TYPE})) {
693 $fn_args .= ",\n" . $pad . mapTypeName($fn->{RETURN_TYPE}). " *result";
696 $self->fn_declare("$fn_str($fn_args)");
699 $self->pidl("$state_str *state = tevent_req_data(");
700 $self->pidl("\treq, $state_str);");
701 $self->pidl("NTSTATUS status;");
703 $self->pidl("if (tevent_req_is_nterror(req, &status)) {");
705 $self->pidl("tevent_req_received(req);");
706 $self->pidl("return status;");
711 $self->pidl("/* Steal possible out parameters to the callers context */");
712 $self->pidl("talloc_steal(mem_ctx, state->out_mem_ctx);");
715 if (defined($fn->{RETURN_TYPE})) {
716 $self->pidl("/* Return result */");
717 $self->pidl("*result = state->orig.out.result;");
721 $self->pidl("tevent_req_received(req);");
722 $self->pidl("return NT_STATUS_OK;");
728 sub ParseFunction_Sync($$$$)
730 my ($self, $if, $fn, $name) = @_;
732 if ($self->ParseFunctionHasPipes($fn)) {
733 $self->pidl_both("/*");
734 $self->pidl_both(" * The following function is skipped because");
735 $self->pidl_both(" * it uses pipes:");
736 $self->pidl_both(" *");
737 $self->pidl_both(" * dcerpc_$name()");
738 $self->pidl_both(" */");
739 $self->pidl_both("");
743 my $uname = uc $name;
745 my $fn_str = "NTSTATUS dcerpc_$name";
746 my $pad = genpad($fn_str);
748 $fn_args .= "struct dcerpc_binding_handle *h,\n" . $pad . "TALLOC_CTX *mem_ctx";
750 foreach (@{$fn->{ELEMENTS}}) {
751 my $dir = ElementDirection($_);
752 my $prop = HeaderProperties($_->{PROPERTIES}, ["in", "out"]);
753 $fn_args .= ",\n" . $pad . DeclLong($_, "_") . " /* $dir $prop */";
756 if (defined($fn->{RETURN_TYPE})) {
757 $fn_args .= ",\n" . $pad . mapTypeName($fn->{RETURN_TYPE}). " *result";
760 $self->fn_declare("$fn_str($fn_args)");
763 $self->pidl("struct $name r;");
764 $self->pidl("NTSTATUS status;");
767 $self->pidl("/* In parameters */");
768 foreach my $e (@{$fn->{ELEMENTS}}) {
769 next unless (grep(/in/, @{$e->{DIRECTION}}));
771 $self->ParseCopyArgument($fn, $e, "r.in.", "_");
775 $self->pidl("/* Out parameters */");
776 foreach my $e (@{$fn->{ELEMENTS}}) {
777 next unless grep(/out/, @{$e->{DIRECTION}});
779 $self->ParseCopyArgument($fn, $e, "r.out.", "_");
783 if (defined($fn->{RETURN_TYPE})) {
784 $self->pidl("/* Result */");
785 $self->pidl("NDR_ZERO_STRUCT(r.out.result);");
789 $self->pidl("status = dcerpc_$name\_r(h, mem_ctx, &r);");
790 $self->pidl("if (!NT_STATUS_IS_OK(status)) {");
792 $self->pidl("return status;");
797 $self->pidl("/* Return variables */");
798 foreach my $e (@{$fn->{ELEMENTS}}) {
799 next if ContainsPipe($e, $e->{LEVELS}[0]);
800 next unless (grep(/out/, @{$e->{DIRECTION}}));
802 $self->ParseOutputArgument($fn, $e, "r.", "_", "sync");
806 $self->pidl("/* Return result */");
807 if ($fn->{RETURN_TYPE}) {
808 $self->pidl("*result = r.out.result;");
812 $self->pidl("return NT_STATUS_OK;");
819 #####################################################################
821 sub ParseFunction($$$)
823 my ($self, $if, $fn) = @_;
825 $self->ParseFunction_r_State($if, $fn, $fn->{NAME});
826 $self->ParseFunction_r_Send($if, $fn, $fn->{NAME});
827 $self->ParseFunction_r_Done($if, $fn, $fn->{NAME});
828 $self->ParseFunction_r_Recv($if, $fn, $fn->{NAME});
829 $self->ParseFunction_r_Sync($if, $fn, $fn->{NAME});
831 foreach my $e (@{$fn->{ELEMENTS}}) {
832 next unless (grep(/out/, @{$e->{DIRECTION}}));
834 my $reason = "is not a pointer or array";
836 # TODO: make this fatal at NDR level
837 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
838 if ($e->{LEVELS}[1]->{TYPE} eq "DATA" and
839 $e->{LEVELS}[1]->{DATA_TYPE} eq "string") {
840 $reason = "is a pointer to type 'string'";
841 } elsif ($e->{LEVELS}[1]->{TYPE} eq "ARRAY" and
842 $e->{LEVELS}[1]->{IS_ZERO_TERMINATED}) {
844 } elsif ($e->{LEVELS}[1]->{TYPE} eq "ARRAY" and
845 not defined($e->{LEVELS}[1]->{SIZE_IS})) {
846 $reason = "is a pointer to an unsized array";
851 if ($e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
852 if (not defined($e->{LEVELS}[0]->{SIZE_IS})) {
853 $reason = "is an unsized array";
859 $self->pidl_both("/*");
860 $self->pidl_both(" * The following functions are skipped because");
861 $self->pidl_both(" * an [out] argument $e->{NAME} $reason:");
862 $self->pidl_both(" *");
863 $self->pidl_both(" * dcerpc_$fn->{NAME}_send()");
864 $self->pidl_both(" * dcerpc_$fn->{NAME}_recv()");
865 $self->pidl_both(" * dcerpc_$fn->{NAME}()");
866 $self->pidl_both(" */");
867 $self->pidl_both("");
869 error($e->{ORIGINAL}, "$fn->{NAME}: [out] argument '$e->{NAME}' $reason, skip client functions");
873 $self->ParseFunction_State($if, $fn, $fn->{NAME});
874 $self->ParseFunction_Send($if, $fn, $fn->{NAME});
875 $self->ParseFunction_Done($if, $fn, $fn->{NAME});
876 $self->ParseFunction_Recv($if, $fn, $fn->{NAME});
877 $self->ParseFunction_Sync($if, $fn, $fn->{NAME});
882 sub ParsePipeCreate($$$)
884 my ($self, $t, $cname) = @_;
886 $self->pidl_both("/* $t->{NAME} */");
888 $self->pidl_hdr("struct $t->{NAME};");
889 $self->pidl("struct $t->{NAME} {");
891 $self->pidl("struct dcerpc_pipe_handle_connection *pc;");
896 my $proto = "struct $t->{NAME} *dcerpc_$t->{NAME}\_create(TALLOC_CTX *mem_ctx)";
898 $self->pidl_hdr("$proto;");
899 $self->pidl("$proto");
903 $self->pidl("struct $t->{NAME} *p;");
906 $self->pidl("p = talloc_zero(mem_ctx, struct $t->{NAME});");
907 $self->pidl("if (p == NULL) {");
909 $self->pidl("return NULL;");
914 my $cname = "$t->{NAME}_chunk";
916 $self->pidl("/* the pipe is disconnected by default */");
917 $self->pidl("p->pc = dcerpc_pipe_handle_connection_create(p,");
918 $self->pidl("\t\t\t\"$cname\",");
919 $self->pidl("\t\t\tsizeof(struct $cname));");
920 $self->pidl("if (p->pc == NULL) {");
922 $self->pidl("TALLOC_FREE(p);");
923 $self->pidl("return NULL;");
928 $self->pidl("return p;");
934 sub ParsePipeChunkPush_State($$$)
936 my ($self, $t, $cname) = @_;
938 my $state_str = "struct dcerpc_$cname\_push_state";
939 my $done_fn = "dcerpc_$cname\_push_done";
941 $self->pidl("$state_str {");
943 $self->pidl("uint8_t dummy;");
948 $self->pidl("static void $done_fn(struct tevent_req *subreq);");
952 sub ParsePipeChunkPush_Send($$$)
954 my ($self, $t, $cname) = @_;
957 my $state_str = "struct dcerpc_$cname\_push_state";
958 my $done_fn = "dcerpc_$cname\_push_done";
959 my $fn_str = "struct tevent_req *dcerpc_$cname\_push_send";
960 my $pad = genpad($fn_str);
962 $fn_args .= "TALLOC_CTX *mem_ctx";
963 $fn_args .= ",\n" . $pad . "struct tevent_context *ev";
964 $fn_args .= ",\n" . $pad . "struct $t->{NAME} *p";
965 $fn_args .= ",\n" . $pad . "const struct $cname *chunk";
967 $self->fn_declare("$fn_str($fn_args)");
970 $self->pidl("struct tevent_req *req;");
971 $self->pidl("$state_str *state;");
972 $self->pidl("struct tevent_req *subreq;");
975 $self->pidl("req = tevent_req_create(mem_ctx, &state,");
976 $self->pidl("\t\t\t$state_str);");
977 $self->pidl("if (req == NULL) {");
979 $self->pidl("return NULL;");
984 $self->pidl("subreq = dcerpc_pipe_handle_push_send(state, ev,");
985 $self->pidl("\t\t\tp->pc, chunk);");
986 $self->pidl("if (tevent_req_nomem(subreq, req)) {");
988 $self->pidl("return tevent_req_post(req, ev);");
991 $self->pidl("tevent_req_set_callback(subreq, $done_fn, req);");
994 $self->pidl("return req;");
1000 sub ParsePipeChunkPush_Done($$$)
1002 my ($self, $t, $cname) = @_;
1005 my $state_str = "struct dcerpc_$cname\_push_state";
1006 my $fn_str = "static void dcerpc_$cname\_push_done";
1007 my $pad = genpad($fn_str);
1009 $fn_args .= "struct tevent_req *subreq";
1011 $self->pidl("$fn_str($fn_args)");
1014 $self->pidl("struct tevent_req *req =");
1015 $self->pidl("\ttevent_req_callback_data(subreq,");
1016 $self->pidl("\tstruct tevent_req);");
1018 #$self->pidl("$state_str *state =");
1019 #$self->pidl("\ttevent_req_data(req,");
1020 #$self->pidl("\t$state_str);");
1021 $self->pidl("NTSTATUS status;");
1024 $self->pidl("status = dcerpc_pipe_handle_push_recv(subreq);");
1025 $self->pidl("TALLOC_FREE(subreq);");
1026 $self->pidl("if (tevent_req_nterror(req, status)) {");
1028 $self->pidl("return;");
1033 $self->pidl("tevent_req_done(req);");
1039 sub ParsePipeChunkPush_Recv($$$)
1041 my ($self, $t, $cname) = @_;
1044 my $state_str = "struct dcerpc_$cname\_push_state";
1045 my $fn_str = "NTSTATUS dcerpc_$cname\_push_recv";
1046 my $pad = genpad($fn_str);
1048 $fn_args .= "struct tevent_req *req";
1050 $self->fn_declare("$fn_str($fn_args)");
1053 $self->pidl("$state_str *state =");
1054 $self->pidl("\ttevent_req_data(req,");
1055 $self->pidl("\t$state_str);");
1056 $self->pidl("NTSTATUS status;");
1059 $self->pidl("if (tevent_req_is_nterror(req, &status)) {");
1062 $self->pidl(" * We want the tevent_req_data() protection,");
1063 $self->pidl(" * but don't need 'state', so just pretend we use it");
1064 $self->pidl(" * in order to avoid compiler warnings.");
1066 $self->pidl("state->dummy = 0;");
1067 $self->pidl("tevent_req_received(req);");
1068 $self->pidl("return status;");
1073 $self->pidl("tevent_req_received(req);");
1074 $self->pidl("return NT_STATUS_OK;");
1080 sub ParsePipeChunkPull_State($$$)
1082 my ($self, $t, $cname) = @_;
1084 my $state_str = "struct dcerpc_$cname\_pull_state";
1085 my $done_fn = "dcerpc_$cname\_pull_done";
1087 $self->pidl("$state_str {");
1089 $self->pidl("struct $cname *chunk;");
1094 $self->pidl("static void $done_fn(struct tevent_req *subreq);");
1098 sub ParsePipeChunkPull_Send($$$)
1100 my ($self, $t, $cname) = @_;
1103 my $state_str = "struct dcerpc_$cname\_pull_state";
1104 my $done_fn = "dcerpc_$cname\_pull_done";
1105 my $fn_str = "struct tevent_req *dcerpc_$cname\_pull_send";
1106 my $pad = genpad($fn_str);
1108 $fn_args .= "TALLOC_CTX *mem_ctx";
1109 $fn_args .= ",\n" . $pad . "struct tevent_context *ev";
1110 $fn_args .= ",\n" . $pad . "struct $t->{NAME} *p";
1112 $self->fn_declare("$fn_str($fn_args)");
1115 $self->pidl("struct tevent_req *req;");
1116 $self->pidl("$state_str *state;");
1117 $self->pidl("struct tevent_req *subreq;");
1120 $self->pidl("req = tevent_req_create(mem_ctx, &state,");
1121 $self->pidl("\t\t\t$state_str);");
1122 $self->pidl("if (req == NULL) {");
1124 $self->pidl("return NULL;");
1128 $self->pidl("state->chunk = talloc_zero(state, struct $cname);");
1129 $self->pidl("if (tevent_req_nomem(state->chunk, req)) {");
1131 $self->pidl("return tevent_req_post(req, ev);");
1136 $self->pidl("subreq = dcerpc_pipe_handle_pull_send(state, ev,");
1137 $self->pidl("\t\t\tp->pc, state->chunk, state->chunk);");
1138 $self->pidl("if (tevent_req_nomem(subreq, req)) {");
1140 $self->pidl("return tevent_req_post(req, ev);");
1143 $self->pidl("tevent_req_set_callback(subreq, $done_fn, req);");
1146 $self->pidl("return req;");
1152 sub ParsePipeChunkPull_Done($$$)
1154 my ($self, $t, $cname) = @_;
1157 my $state_str = "struct dcerpc_$cname\_pull_state";
1158 my $fn_str = "static void dcerpc_$cname\_pull_done";
1159 my $pad = genpad($fn_str);
1161 $fn_args .= "struct tevent_req *subreq";
1163 $self->pidl("$fn_str($fn_args)");
1166 $self->pidl("struct tevent_req *req =");
1167 $self->pidl("\ttevent_req_callback_data(subreq,");
1168 $self->pidl("\tstruct tevent_req);");
1170 #$self->pidl("$state_str *state =");
1171 #$self->pidl("\ttevent_req_data(req,");
1172 #$self->pidl("\t$state_str);");
1173 $self->pidl("NTSTATUS status;");
1176 $self->pidl("status = dcerpc_pipe_handle_pull_recv(subreq);");
1177 $self->pidl("TALLOC_FREE(subreq);");
1178 $self->pidl("if (tevent_req_nterror(req, status)) {");
1180 $self->pidl("return;");
1185 $self->pidl("tevent_req_done(req);");
1191 sub ParsePipeChunkPull_Recv($$$)
1193 my ($self, $t, $cname) = @_;
1196 my $state_str = "struct dcerpc_$cname\_pull_state";
1197 my $fn_str = "NTSTATUS dcerpc_$cname\_pull_recv";
1198 my $pad = genpad($fn_str);
1200 $fn_args .= "struct tevent_req *req";
1201 $fn_args .= ",\n" . $pad . "TALLOC_CTX *mem_ctx";
1202 $fn_args .= ",\n" . $pad . "struct $cname **chunk";
1204 $self->fn_declare("$fn_str($fn_args)");
1207 $self->pidl("$state_str *state =");
1208 $self->pidl("\ttevent_req_data(req,");
1209 $self->pidl("\t$state_str);");
1210 $self->pidl("NTSTATUS status;");
1213 $self->pidl("if (tevent_req_is_nterror(req, &status)) {");
1215 $self->pidl("tevent_req_received(req);");
1216 $self->pidl("return status;");
1221 $self->pidl("*chunk = talloc_move(mem_ctx, &state->chunk);");
1224 $self->pidl("tevent_req_received(req);");
1225 $self->pidl("return NT_STATUS_OK;");
1233 my ($self, $t) = @_;
1236 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
1237 my $struct = $pipe->{DATA};
1239 my $name = "$struct->{NAME}";
1241 $self->ParsePipeCreate($t, $name);
1243 $self->ParsePipeChunkPush_State($t, $name);
1244 $self->ParsePipeChunkPush_Send($t, $name);
1245 $self->ParsePipeChunkPush_Done($t, $name);
1246 $self->ParsePipeChunkPush_Recv($t, $name);
1248 $self->ParsePipeChunkPull_State($t, $name);
1249 $self->ParsePipeChunkPull_Send($t, $name);
1250 $self->ParsePipeChunkPull_Done($t, $name);
1251 $self->ParsePipeChunkPull_Recv($t, $name);
1252 $self->pidl_both("");
1257 #####################################################################
1258 # parse the interface definitions
1259 sub ParseInterface($$)
1261 my ($self, $if) = @_;
1262 my $ifu = uc($if->{NAME});
1264 $self->pidl_hdr("#ifndef _HEADER_RPC_$if->{NAME}");
1265 $self->pidl_hdr("#define _HEADER_RPC_$if->{NAME}");
1266 $self->pidl_hdr("");
1268 if (defined $if->{PROPERTIES}->{uuid}) {
1269 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$if->{NAME};");
1270 $self->pidl_hdr("");
1273 $self->pidl("/* $if->{NAME} - client functions generated by pidl */");
1276 foreach my $t (reverse @{$if->{TYPES}}) {
1277 next unless Parse::Pidl::Typelist::typeIs($t, "PIPE");
1279 $self->ParsePipe($t);
1280 $done{$t->{NAME}} = 1;
1283 foreach my $fn (@{$if->{FUNCTIONS}}) {
1284 next if defined($done{$fn->{NAME}});
1285 next if has_property($fn, "noopnum");
1286 next if has_property($fn, "todo");
1287 $self->ParseFunction($if, $fn);
1288 $done{$fn->{NAME}} = 1;
1291 $self->pidl_hdr("#endif /* _HEADER_RPC_$if->{NAME} */");
1296 my($self,$ndr,$header,$ndr_header,$client_header) = @_;
1298 $self->pidl("/* client functions auto-generated by pidl */");
1301 $self->pidl("#include \"includes.h\"");
1303 $self->pidl("#ifndef _GNU_SOURCE");
1304 $self->pidl("#define _GNU_SOURCE");
1305 $self->pidl("#endif");
1306 $self->pidl("#include <stdio.h>");
1307 $self->pidl("#include <stdbool.h>");
1308 $self->pidl("#include <stdlib.h>");
1309 $self->pidl("#include <stdint.h>");
1310 $self->pidl("#include <stdarg.h>");
1311 $self->pidl("#include <string.h>");
1312 $self->pidl("#include <core/ntstatus.h>");
1314 $self->pidl("#include <tevent.h>");
1315 $self->pidl(choose_header("lib/util/tevent_ntstatus.h", "util/tevent_ntstatus.h")."");
1316 $self->pidl("#include \"$ndr_header\"");
1317 $self->pidl("#include \"$client_header\"");
1320 $self->pidl_hdr(choose_header("librpc/rpc/dcerpc.h", "dcerpc.h")."");
1321 $self->pidl_hdr("#include \"$header\"");
1323 foreach my $x (@{$ndr}) {
1324 ($x->{TYPE} eq "INTERFACE") && $self->ParseInterface($x);
1327 return ($self->{res},$self->{res_hdr});