1 ###################################################
2 # Samba4 NDR parser generator for IDL structures
3 # Copyright tridge@samba.org 2000-2003
4 # Copyright tpot@samba.org 2001
5 # Copyright jelmer@samba.org 2004-2006
6 # released under the GNU GPL
8 package Parse::Pidl::Samba4::NDR::Parser;
12 @EXPORT = qw(is_charset_array);
13 @EXPORT_OK = qw(check_null_pointer GenerateFunctionInEnv
14 GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv NeededFunction
15 NeededElement NeededType);
18 use Parse::Pidl::Typelist qw(hasType getType mapType);
19 use Parse::Pidl::Util qw(has_property ParseExpr ParseExprExt print_uuid);
20 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred);
21 use Parse::Pidl::Samba4 qw(is_intree choose_header);
22 use Parse::Pidl qw(warning);
24 use vars qw($VERSION);
33 return $typefamily{$n};
38 my ($e, $var_name) = @_;
41 foreach my $l (@{$e->{LEVELS}}) {
42 if ($l->{TYPE} eq "POINTER") {
44 } elsif ($l->{TYPE} eq "ARRAY") {
45 if (($pointers == 0) and
46 (not $l->{IS_FIXED}) and
47 (not $l->{IS_INLINE})) {
48 return get_value_of($var_name);
50 } elsif ($l->{TYPE} eq "DATA") {
51 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
52 return get_value_of($var_name) unless ($pointers);
60 sub has_fast_array($$)
64 return 0 if ($l->{TYPE} ne "ARRAY");
66 my $nl = GetNextLevel($e,$l);
67 return 0 unless ($nl->{TYPE} eq "DATA");
68 return 0 unless (hasType($nl->{DATA_TYPE}));
70 my $t = getType($nl->{DATA_TYPE});
72 # Only uint8 and string have fast array functions at the moment
73 return ($t->{NAME} eq "uint8") or ($t->{NAME} eq "string");
76 sub is_charset_array($$)
80 return 0 if ($l->{TYPE} ne "ARRAY");
82 my $nl = GetNextLevel($e,$l);
84 return 0 unless ($nl->{TYPE} eq "DATA");
86 return has_property($e, "charset");
93 if ($var_name =~ /^\*(.*)$/) {
95 } elsif ($var_name =~ /^\&(.*)$/) {
96 return "&($var_name)";
104 my $var_name = shift;
106 if ($var_name =~ /^\&(.*)$/) {
117 ####################################
118 # pidl() is our basic output routine
131 sub pidl_hdr ($) { my $d = shift; $res_hdr .= "$d\n"; }
133 ####################################
134 # defer() is like pidl(), but adds to
135 # a deferred buffer which is then added to the
136 # output buffer at the end of the structure/union/function
137 # This is needed to cope with code that must be pushed back
138 # to the end of a block of elements
140 sub defer_indent() { $defer_tabs.="\t"; }
141 sub defer_deindent() { $defer_tabs=substr($defer_tabs, 0, -1); }
147 push(@$deferred, $defer_tabs.$d);
151 ########################################
152 # add the deferred content to the current
156 pidl $_ foreach (@$deferred);
168 $tabs = substr($tabs, 0, -1);
171 #####################################################################
172 # declare a function public or static, depending on its attributes
175 my ($type,$fn,$decl) = @_;
177 if (has_property($fn, "no$type")) {
182 if (has_property($fn, "public")) {
184 pidl "_PUBLIC_ $decl";
192 ###################################################################
193 # setup any special flags for an element or structure
197 my $flags = has_property($e, "flag");
198 if (defined $flags) {
201 pidl "uint32_t _flags_save_$e->{TYPE} = ndr->flags;";
202 pidl "ndr_set_flags(&ndr->flags, $flags);";
206 ###################################################################
207 # end any special flags for an element or structure
211 my $flags = has_property($e, "flag");
212 if (defined $flags) {
213 pidl "ndr->flags = _flags_save_$e->{TYPE};";
219 sub GenerateStructEnv($)
224 foreach my $e (@{$x->{ELEMENTS}}) {
225 $env{$e->{NAME}} = "r->$e->{NAME}";
233 sub EnvSubstituteValue($$)
237 # Substitute the value() values in the env
238 foreach my $e (@{$s->{ELEMENTS}}) {
239 next unless (defined(my $v = has_property($e, "value")));
241 $env->{$e->{NAME}} = ParseExpr($v, $env, $e);
247 sub GenerateFunctionInEnv($)
252 foreach my $e (@{$fn->{ELEMENTS}}) {
253 if (grep (/in/, @{$e->{DIRECTION}})) {
254 $env{$e->{NAME}} = "r->in.$e->{NAME}";
261 sub GenerateFunctionOutEnv($)
266 foreach my $e (@{$fn->{ELEMENTS}}) {
267 if (grep (/out/, @{$e->{DIRECTION}})) {
268 $env{$e->{NAME}} = "r->out.$e->{NAME}";
269 } elsif (grep (/in/, @{$e->{DIRECTION}})) {
270 $env{$e->{NAME}} = "r->in.$e->{NAME}";
277 #####################################################################
278 # parse the data of an array - push side
279 sub ParseArrayPushHeader($$$$$)
281 my ($e,$l,$ndr,$var_name,$env) = @_;
286 if ($l->{IS_ZERO_TERMINATED}) {
287 if (has_property($e, "charset")) {
288 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
290 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
293 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
294 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
297 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
298 pidl "NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $size));";
301 if ($l->{IS_VARYING}) {
302 pidl "NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, 0));"; # array offset
303 pidl "NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $length));";
309 sub check_fully_dereferenced($$)
311 my ($element, $env) = @_;
317 # Figure out the number of pointers in $ptr
318 my $expandedvar = $origvar;
319 $expandedvar =~ s/^(\**)//;
323 foreach (keys %$env) {
324 if ($env->{$_} eq $expandedvar) {
330 return($origvar) unless (defined($var));
332 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
333 if ($_->{NAME} eq $var) {
339 $e or die("Environment doesn't match siblings");
341 # See if pointer at pointer level $level
342 # needs to be checked.
344 foreach (@{$e->{LEVELS}}) {
345 if ($_->{TYPE} eq "POINTER") {
346 $nump = $_->{POINTER_INDEX}+1;
349 warning($element->{ORIGINAL}, "Got pointer for `$e->{NAME}', expected fully derefenced variable") if ($nump > length($ptr));
354 sub check_null_pointer($$$$)
356 my ($element, $env, $print_fn, $return) = @_;
359 my $expandedvar = shift;
362 # Figure out the number of pointers in $ptr
363 $expandedvar =~ s/^(\**)//;
367 foreach (keys %$env) {
368 if ($env->{$_} eq $expandedvar) {
377 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
378 if ($_->{NAME} eq $var) {
384 $e or die("Environment doesn't match siblings");
386 # See if pointer at pointer level $level
387 # needs to be checked.
388 foreach my $l (@{$e->{LEVELS}}) {
389 if ($l->{TYPE} eq "POINTER" and
390 $l->{POINTER_INDEX} == length($ptr)) {
391 # No need to check ref pointers
392 $check = ($l->{POINTER_TYPE} ne "ref");
396 if ($l->{TYPE} eq "DATA") {
397 warning($element, "too much dereferences for `$var'");
401 warning($element, "unknown dereferenced expression `$expandedvar'");
405 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
409 #####################################################################
410 # parse an array - pull side
411 sub ParseArrayPullHeader($$$$$)
413 my ($e,$l,$ndr,$var_name,$env) = @_;
418 if ($l->{IS_CONFORMANT}) {
419 $length = $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
420 } elsif ($l->{IS_ZERO_TERMINATED}) { # Noheader arrays
421 $length = $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
423 $length = $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
424 check_null_pointer($e, $env, \&pidl, "return NT_STATUS_INVALID_PARAMETER_MIX;"), check_fully_dereferenced($e, $env));
427 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
428 pidl "NDR_CHECK(ndr_pull_array_size(ndr, " . get_pointer_to($var_name) . "));";
431 if ($l->{IS_VARYING}) {
432 pidl "NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));";
433 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
436 if ($length ne $size) {
437 pidl "if ($length > $size) {";
439 pidl "return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $size, $length);";
444 if ($l->{IS_CONFORMANT} and not $l->{IS_ZERO_TERMINATED}) {
445 defer "if ($var_name) {";
447 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL}, check_null_pointer($e, $env, \&defer, "return NT_STATUS_INVALID_PARAMETER_MIX;"), check_fully_dereferenced($e, $env));
448 defer "NDR_CHECK(ndr_check_array_size(ndr, (void*)" . get_pointer_to($var_name) . ", $size));";
453 if ($l->{IS_VARYING} and not $l->{IS_ZERO_TERMINATED}) {
454 defer "if ($var_name) {";
456 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
457 check_null_pointer($e, $env, \&defer, "return NT_STATUS_INVALID_PARAMETER_MIX;"),
458 check_fully_dereferenced($e, $env));
459 defer "NDR_CHECK(ndr_check_array_length(ndr, (void*)" . get_pointer_to($var_name) . ", $length));";
464 if (not $l->{IS_FIXED} and not is_charset_array($e, $l)) {
465 AllocateArrayLevel($e,$l,$ndr,$env,$size);
471 sub compression_alg($$)
474 my ($alg, $clen, $dlen) = split(/ /, $l->{COMPRESSION});
479 sub compression_clen($$$)
481 my ($e, $l, $env) = @_;
482 my ($alg, $clen, $dlen) = split(/ /, $l->{COMPRESSION});
484 return ParseExpr($clen, $env, $e->{ORIGINAL});
487 sub compression_dlen($$$)
489 my ($e,$l,$env) = @_;
490 my ($alg, $clen, $dlen) = split(/ /, $l->{COMPRESSION});
492 return ParseExpr($dlen, $env, $e->{ORIGINAL});
495 sub ParseCompressionPushStart($$$$)
497 my ($e,$l,$ndr,$env) = @_;
498 my $comndr = "$ndr\_compressed";
499 my $alg = compression_alg($e, $l);
500 my $dlen = compression_dlen($e, $l, $env);
504 pidl "struct ndr_push *$comndr;";
505 pidl "NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));";
510 sub ParseCompressionPushEnd($$$$)
512 my ($e,$l,$ndr,$env) = @_;
513 my $comndr = "$ndr\_compressed";
514 my $alg = compression_alg($e, $l);
515 my $dlen = compression_dlen($e, $l, $env);
517 pidl "NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));";
522 sub ParseCompressionPullStart($$$$)
524 my ($e,$l,$ndr,$env) = @_;
525 my $comndr = "$ndr\_compressed";
526 my $alg = compression_alg($e, $l);
527 my $dlen = compression_dlen($e, $l, $env);
531 pidl "struct ndr_pull *$comndr;";
532 pidl "NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));";
537 sub ParseCompressionPullEnd($$$$)
539 my ($e,$l,$ndr,$env) = @_;
540 my $comndr = "$ndr\_compressed";
541 my $alg = compression_alg($e, $l);
542 my $dlen = compression_dlen($e, $l, $env);
544 pidl "NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));";
549 sub ParseSubcontextPushStart($$$$)
551 my ($e,$l,$ndr,$env) = @_;
552 my $subndr = "_ndr_$e->{NAME}";
553 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
557 pidl "struct ndr_push *$subndr;";
558 pidl "NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));";
560 if (defined $l->{COMPRESSION}) {
561 $subndr = ParseCompressionPushStart($e, $l, $subndr, $env);
567 sub ParseSubcontextPushEnd($$$$)
569 my ($e,$l,$ndr,$env) = @_;
570 my $subndr = "_ndr_$e->{NAME}";
571 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
573 if (defined $l->{COMPRESSION}) {
574 ParseCompressionPushEnd($e, $l, $subndr, $env);
577 pidl "NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));";
582 sub ParseSubcontextPullStart($$$$)
584 my ($e,$l,$ndr,$env) = @_;
585 my $subndr = "_ndr_$e->{NAME}";
586 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
590 pidl "struct ndr_pull *$subndr;";
591 pidl "NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));";
593 if (defined $l->{COMPRESSION}) {
594 $subndr = ParseCompressionPullStart($e, $l, $subndr, $env);
600 sub ParseSubcontextPullEnd($$$$)
602 my ($e,$l,$ndr,$env) = @_;
603 my $subndr = "_ndr_$e->{NAME}";
604 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
606 if (defined $l->{COMPRESSION}) {
607 ParseCompressionPullEnd($e, $l, $subndr, $env);
610 pidl "NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));";
615 sub ParseElementPushLevel
617 my ($e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
619 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
621 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
622 $var_name = get_pointer_to($var_name);
625 if (defined($ndr_flags)) {
626 if ($l->{TYPE} eq "SUBCONTEXT") {
627 my $subndr = ParseSubcontextPushStart($e, $l, $ndr, $env);
628 ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
629 ParseSubcontextPushEnd($e, $l, $ndr, $env);
630 } elsif ($l->{TYPE} eq "POINTER") {
631 ParsePtrPush($e, $l, $var_name);
632 } elsif ($l->{TYPE} eq "ARRAY") {
633 my $length = ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
635 my $nl = GetNextLevel($e, $l);
637 # Allow speedups for arrays of scalar types
638 if (is_charset_array($e,$l)) {
639 pidl "NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapType($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));";
641 } elsif (has_fast_array($e,$l)) {
642 pidl "NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));";
645 } elsif ($l->{TYPE} eq "SWITCH") {
646 ParseSwitchPush($e, $l, $ndr, $var_name, $ndr_flags, $env);
647 } elsif ($l->{TYPE} eq "DATA") {
648 ParseDataPush($e, $l, $ndr, $var_name, $ndr_flags);
652 if ($l->{TYPE} eq "POINTER" and $deferred) {
653 if ($l->{POINTER_TYPE} ne "ref") {
654 pidl "if ($var_name) {";
656 if ($l->{POINTER_TYPE} eq "relative") {
657 pidl "NDR_CHECK(ndr_push_relative_ptr2(ndr, $var_name));";
660 $var_name = get_value_of($var_name);
661 ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
663 if ($l->{POINTER_TYPE} ne "ref") {
667 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
668 not is_charset_array($e, $l)) {
669 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
670 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
672 $var_name = $var_name . "[$counter]";
674 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
675 pidl "for ($counter = 0; $counter < $length; $counter++) {";
677 ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
682 if ($deferred and ContainsDeferred($e, $l)) {
683 pidl "for ($counter = 0; $counter < $length; $counter++) {";
685 ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
689 } elsif ($l->{TYPE} eq "SWITCH") {
690 ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
694 #####################################################################
695 # parse scalars in a structure element
696 sub ParseElementPush($$$$$)
698 my ($e,$ndr,$env,$primitives,$deferred) = @_;
701 my $var_name = $env->{$e->{NAME}};
703 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
705 # Representation type is different from transmit_as
706 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
709 my $transmit_name = "_transmit_$e->{NAME}";
710 pidl mapType($e->{TYPE}) ." $transmit_name;";
711 pidl "NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));";
712 $var_name = $transmit_name;
715 $var_name = append_prefix($e, $var_name);
719 if (defined(my $value = has_property($e, "value"))) {
720 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
723 ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
727 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
733 #####################################################################
734 # parse a pointer in a struct element or function
735 sub ParsePtrPush($$$)
737 my ($e,$l,$var_name) = @_;
739 if ($l->{POINTER_TYPE} eq "ref") {
740 pidl "if ($var_name == NULL) return NT_STATUS_INVALID_PARAMETER_MIX;";
741 if ($l->{LEVEL} eq "EMBEDDED") {
742 pidl "NDR_CHECK(ndr_push_ref_ptr(ndr));";
744 } elsif ($l->{POINTER_TYPE} eq "relative") {
745 pidl "NDR_CHECK(ndr_push_relative_ptr1(ndr, $var_name));";
746 } elsif ($l->{POINTER_TYPE} eq "unique") {
747 pidl "NDR_CHECK(ndr_push_unique_ptr(ndr, $var_name));";
748 } elsif ($l->{POINTER_TYPE} eq "full") {
749 pidl "NDR_CHECK(ndr_push_full_ptr(ndr, $var_name));";
751 die("Unhandled pointer type $l->{POINTER_TYPE}");
755 #####################################################################
756 # print scalars in a structure element
757 sub ParseElementPrint($$$)
759 my($e, $var_name, $env) = @_;
761 return if (has_property($e, "noprint"));
763 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
764 pidl "ndr_print_$e->{REPRESENTATION_TYPE}(ndr, \"$e->{NAME}\", $var_name);";
768 $var_name = append_prefix($e, $var_name);
770 if (defined(my $value = has_property($e, "value"))) {
771 $var_name = "(ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
774 foreach my $l (@{$e->{LEVELS}}) {
775 if ($l->{TYPE} eq "POINTER") {
776 pidl "ndr_print_ptr(ndr, \"$e->{NAME}\", $var_name);";
777 pidl "ndr->depth++;";
778 if ($l->{POINTER_TYPE} ne "ref") {
779 pidl "if ($var_name) {";
782 $var_name = get_value_of($var_name);
783 } elsif ($l->{TYPE} eq "ARRAY") {
786 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
787 $var_name = get_pointer_to($var_name);
790 if ($l->{IS_ZERO_TERMINATED}) {
791 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
793 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
794 check_null_pointer($e, $env, \&pidl, "return;"), check_fully_dereferenced($e, $env));
797 if (is_charset_array($e,$l)) {
798 pidl "ndr_print_string(ndr, \"$e->{NAME}\", $var_name);";
800 } elsif (has_fast_array($e, $l)) {
801 my $nl = GetNextLevel($e, $l);
802 pidl "ndr_print_array_$nl->{DATA_TYPE}(ndr, \"$e->{NAME}\", $var_name, $length);";
805 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
807 pidl "ndr->print(ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", $length);";
808 pidl 'ndr->depth++;';
809 pidl "for ($counter=0;$counter<$length;$counter++) {";
811 pidl "char *idx_$l->{LEVEL_INDEX}=NULL;";
812 pidl "asprintf(&idx_$l->{LEVEL_INDEX}, \"[\%d]\", $counter);";
813 pidl "if (idx_$l->{LEVEL_INDEX}) {";
816 $var_name = $var_name . "[$counter]";
818 } elsif ($l->{TYPE} eq "DATA") {
819 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE}) or Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
820 $var_name = get_pointer_to($var_name);
822 pidl "ndr_print_$l->{DATA_TYPE}(ndr, \"$e->{NAME}\", $var_name);";
823 } elsif ($l->{TYPE} eq "SWITCH") {
824 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
825 check_null_pointer($e, $env, \&pidl, "return;"), check_fully_dereferenced($e, $env));
826 pidl "ndr_print_set_switch_value(ndr, " . get_pointer_to($var_name) . ", $switch_var);";
830 foreach my $l (reverse @{$e->{LEVELS}}) {
831 if ($l->{TYPE} eq "POINTER") {
832 if ($l->{POINTER_TYPE} ne "ref") {
836 pidl "ndr->depth--;";
837 } elsif (($l->{TYPE} eq "ARRAY")
838 and not is_charset_array($e,$l)
839 and not has_fast_array($e,$l)) {
840 pidl "free(idx_$l->{LEVEL_INDEX});";
845 pidl "ndr->depth--;";
850 #####################################################################
851 # parse scalars in a structure element - pull size
852 sub ParseSwitchPull($$$$$$)
854 my($e,$l,$ndr,$var_name,$ndr_flags,$env) = @_;
855 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
856 check_null_pointer($e, $env, \&pidl, "return NT_STATUS_INVALID_PARAMETER_MIX;"), check_fully_dereferenced($e, $env));
858 $var_name = get_pointer_to($var_name);
859 pidl "NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));";
862 #####################################################################
863 # push switch element
864 sub ParseSwitchPush($$$$$$)
866 my($e,$l,$ndr,$var_name,$ndr_flags,$env) = @_;
867 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
868 check_null_pointer($e, $env, \&pidl, "return NT_STATUS_INVALID_PARAMETER_MIX;"), check_fully_dereferenced($e, $env));
870 $var_name = get_pointer_to($var_name);
871 pidl "NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));";
874 sub ParseDataPull($$$$$)
876 my ($e,$l,$ndr,$var_name,$ndr_flags) = @_;
878 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
879 $var_name = get_pointer_to($var_name);
882 $var_name = get_pointer_to($var_name);
884 pidl "NDR_CHECK(ndr_pull_$l->{DATA_TYPE}($ndr, $ndr_flags, $var_name));";
886 if (my $range = has_property($e, "range")) {
887 $var_name = get_value_of($var_name);
888 my ($low, $high) = split(/ /, $range, 2);
889 pidl "if ($var_name < $low || $var_name > $high) {";
890 pidl "\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");";
895 sub ParseDataPush($$$$$)
897 my ($e,$l,$ndr,$var_name,$ndr_flags) = @_;
899 # strings are passed by value rather than reference
900 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE}) or Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
901 $var_name = get_pointer_to($var_name);
904 pidl "NDR_CHECK(ndr_push_$l->{DATA_TYPE}($ndr, $ndr_flags, $var_name));";
907 sub CalcNdrFlags($$$)
909 my ($l,$primitives,$deferred) = @_;
914 # Add NDR_SCALARS if this one is deferred
915 # and deferreds may be pushed
916 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
918 # Add NDR_SCALARS if this one is not deferred and
919 # primitives may be pushed
920 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
922 # Add NDR_BUFFERS if this one contains deferred stuff
923 # and deferreds may be pushed
924 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
926 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
927 return "NDR_SCALARS" if ($scalars);
928 return "NDR_BUFFERS" if ($buffers);
932 sub ParseMemCtxPullStart($$$)
934 my ($e, $l, $ptr_name) = @_;
936 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
937 my $mem_c_ctx = $ptr_name;
938 my $mem_c_flags = "0";
940 return if ($l->{TYPE} eq "ARRAY" and $l->{IS_FIXED});
942 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
943 my $nl = GetNextLevel($e, $l);
944 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
945 my $next_is_string = (($nl->{TYPE} eq "DATA") and
946 ($nl->{DATA_TYPE} eq "string"));
947 if ($next_is_array or $next_is_string) {
950 $mem_c_flags = "LIBNDR_FLAG_REF_ALLOC";
954 pidl "$mem_r_ctx = NDR_PULL_GET_MEM_CTX(ndr);";
955 pidl "NDR_PULL_SET_MEM_CTX(ndr, $mem_c_ctx, $mem_c_flags);";
958 sub ParseMemCtxPullEnd($$)
963 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
964 my $mem_r_flags = "0";
966 return if ($l->{TYPE} eq "ARRAY" and $l->{IS_FIXED});
968 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
969 my $nl = GetNextLevel($e, $l);
970 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
971 my $next_is_string = (($nl->{TYPE} eq "DATA") and
972 ($nl->{DATA_TYPE} eq "string"));
973 if ($next_is_array or $next_is_string) {
976 $mem_r_flags = "LIBNDR_FLAG_REF_ALLOC";
980 pidl "NDR_PULL_SET_MEM_CTX(ndr, $mem_r_ctx, $mem_r_flags);";
983 sub CheckStringTerminator($$$$)
985 my ($ndr,$e,$l,$length) = @_;
986 my $nl = GetNextLevel($e, $l);
988 # Make sure last element is zero!
989 pidl "NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));";
992 sub ParseElementPullLevel
994 my($e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
996 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
998 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
999 $var_name = get_pointer_to($var_name);
1002 # Only pull something if there's actually something to be pulled
1003 if (defined($ndr_flags)) {
1004 if ($l->{TYPE} eq "SUBCONTEXT") {
1005 my $subndr = ParseSubcontextPullStart($e, $l, $ndr, $env);
1006 ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1007 ParseSubcontextPullEnd($e, $l, $ndr, $env);
1008 } elsif ($l->{TYPE} eq "ARRAY") {
1009 my $length = ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1011 my $nl = GetNextLevel($e, $l);
1013 if (is_charset_array($e,$l)) {
1014 if ($l->{IS_ZERO_TERMINATED}) {
1015 CheckStringTerminator($ndr, $e, $l, $length);
1017 pidl "NDR_CHECK(ndr_pull_charset($ndr, $ndr_flags, ".get_pointer_to($var_name).", $length, sizeof(" . mapType($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));";
1019 } elsif (has_fast_array($e, $l)) {
1020 if ($l->{IS_ZERO_TERMINATED}) {
1021 CheckStringTerminator($ndr,$e,$l,$length);
1023 pidl "NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));";
1026 } elsif ($l->{TYPE} eq "POINTER") {
1027 ParsePtrPull($e, $l, $ndr, $var_name);
1028 } elsif ($l->{TYPE} eq "SWITCH") {
1029 ParseSwitchPull($e, $l, $ndr, $var_name, $ndr_flags, $env);
1030 } elsif ($l->{TYPE} eq "DATA") {
1031 ParseDataPull($e, $l, $ndr, $var_name, $ndr_flags);
1035 # add additional constructions
1036 if ($l->{TYPE} eq "POINTER" and $deferred) {
1037 if ($l->{POINTER_TYPE} ne "ref") {
1038 pidl "if ($var_name) {";
1041 if ($l->{POINTER_TYPE} eq "relative") {
1042 pidl "struct ndr_pull_save _relative_save;";
1043 pidl "ndr_pull_save(ndr, &_relative_save);";
1044 pidl "NDR_CHECK(ndr_pull_relative_ptr2(ndr, $var_name));";
1048 ParseMemCtxPullStart($e, $l, $var_name);
1050 $var_name = get_value_of($var_name);
1051 ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1053 ParseMemCtxPullEnd($e,$l);
1055 if ($l->{POINTER_TYPE} ne "ref") {
1056 if ($l->{POINTER_TYPE} eq "relative") {
1057 pidl "ndr_pull_restore(ndr, &_relative_save);";
1062 } elsif ($l->{TYPE} eq "ARRAY" and
1063 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1064 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1065 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1066 my $array_name = $var_name;
1068 $var_name = $var_name . "[$counter]";
1070 ParseMemCtxPullStart($e, $l, $array_name);
1072 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1073 my $nl = GetNextLevel($e,$l);
1075 if ($l->{IS_ZERO_TERMINATED}) {
1076 CheckStringTerminator($ndr,$e,$l,$length);
1079 pidl "for ($counter = 0; $counter < $length; $counter++) {";
1081 ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1086 if ($deferred and ContainsDeferred($e, $l)) {
1087 pidl "for ($counter = 0; $counter < $length; $counter++) {";
1089 ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1094 ParseMemCtxPullEnd($e, $l);
1096 } elsif ($l->{TYPE} eq "SWITCH") {
1097 ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1101 #####################################################################
1102 # parse scalars in a structure element - pull size
1103 sub ParseElementPull($$$$$)
1105 my($e,$ndr,$env,$primitives,$deferred) = @_;
1107 my $var_name = $env->{$e->{NAME}};
1111 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1113 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1116 $represent_name = $var_name;
1117 $transmit_name = "_transmit_$e->{NAME}";
1118 $var_name = $transmit_name;
1119 pidl mapType($e->{TYPE})." $var_name;";
1122 $var_name = append_prefix($e, $var_name);
1126 ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1130 # Representation type is different from transmit_as
1131 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1132 pidl "NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));";
1138 #####################################################################
1139 # parse a pointer in a struct element or function
1140 sub ParsePtrPull($$$$)
1142 my($e,$l,$ndr,$var_name) = @_;
1144 my $nl = GetNextLevel($e, $l);
1145 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1146 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1147 ($nl->{DATA_TYPE} eq "string"));
1149 if ($l->{POINTER_TYPE} eq "ref") {
1150 if ($l->{LEVEL} eq "EMBEDDED") {
1151 pidl "NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));";
1154 if (!$next_is_array and !$next_is_string) {
1155 pidl "if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {";
1156 pidl "\tNDR_PULL_ALLOC($ndr, $var_name);";
1161 } elsif (($l->{POINTER_TYPE} eq "unique") or
1162 ($l->{POINTER_TYPE} eq "relative") or
1163 ($l->{POINTER_TYPE} eq "full")) {
1164 pidl "NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));";
1165 pidl "if (_ptr_$e->{NAME}) {";
1168 die("Unhandled pointer type $l->{POINTER_TYPE}");
1171 # Don't do this for arrays, they're allocated at the actual level
1173 unless ($next_is_array or $next_is_string) {
1174 pidl "NDR_PULL_ALLOC($ndr, $var_name);";
1176 # FIXME: Yes, this is nasty.
1177 # We allocate an array twice
1178 # - once just to indicate that it's there,
1179 # - then the real allocation...
1180 pidl "NDR_PULL_ALLOC($ndr, $var_name);";
1183 #pidl "memset($var_name, 0, sizeof($var_name));";
1184 if ($l->{POINTER_TYPE} eq "relative") {
1185 pidl "NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));";
1189 pidl "\t$var_name = NULL;";
1193 #####################################################################
1195 sub ParseStructPush($$)
1197 my($struct,$name) = @_;
1199 return unless defined($struct->{ELEMENTS});
1201 my $env = GenerateStructEnv($struct);
1203 EnvSubstituteValue($env, $struct);
1205 # save the old relative_base_offset
1206 pidl "uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset(ndr);" if defined($struct->{PROPERTIES}{relative_base});
1208 foreach my $e (@{$struct->{ELEMENTS}}) {
1209 DeclareArrayVariables($e);
1212 start_flags($struct);
1214 # see if the structure contains a conformant array. If it
1215 # does, then it must be the last element of the structure, and
1216 # we need to push the conformant length early, as it fits on
1217 # the wire before the structure (and even before the structure
1219 if (defined($struct->{SURROUNDING_ELEMENT})) {
1220 my $e = $struct->{SURROUNDING_ELEMENT};
1222 if (defined($e->{LEVELS}[0]) and
1223 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1226 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1227 if (has_property($e, "charset")) {
1228 $size = "ndr_charset_length(r->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1230 $size = "ndr_string_length(r->$e->{NAME}, sizeof(*r->$e->{NAME}))";
1233 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1236 pidl "NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, $size));";
1238 pidl "NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, ndr_string_array_size(ndr, r->$e->{NAME})));";
1242 pidl "if (ndr_flags & NDR_SCALARS) {";
1245 pidl "NDR_CHECK(ndr_push_align(ndr, $struct->{ALIGN}));";
1247 if (defined($struct->{PROPERTIES}{relative_base})) {
1248 # set the current offset as base for relative pointers
1249 # and store it based on the toplevel struct/union
1250 pidl "NDR_CHECK(ndr_push_setup_relative_base_offset1(ndr, r, ndr->offset));";
1253 foreach my $e (@{$struct->{ELEMENTS}}) {
1254 ParseElementPush($e, "ndr", $env, 1, 0);
1260 pidl "if (ndr_flags & NDR_BUFFERS) {";
1262 if (defined($struct->{PROPERTIES}{relative_base})) {
1263 # retrieve the current offset as base for relative pointers
1264 # based on the toplevel struct/union
1265 pidl "NDR_CHECK(ndr_push_setup_relative_base_offset2(ndr, r));";
1267 foreach my $e (@{$struct->{ELEMENTS}}) {
1268 ParseElementPush($e, "ndr", $env, 0, 1);
1275 # restore the old relative_base_offset
1276 pidl "ndr_push_restore_relative_base_offset(ndr, _save_relative_base_offset);" if defined($struct->{PROPERTIES}{relative_base});
1279 #####################################################################
1280 # generate a push function for an enum
1281 sub ParseEnumPush($$)
1283 my($enum,$name) = @_;
1284 my($type_fn) = $enum->{BASE_TYPE};
1287 pidl "NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, r));";
1291 #####################################################################
1292 # generate a pull function for an enum
1293 sub ParseEnumPull($$)
1295 my($enum,$name) = @_;
1296 my($type_fn) = $enum->{BASE_TYPE};
1297 my($type_v_decl) = mapType($type_fn);
1299 pidl "$type_v_decl v;";
1301 pidl "NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));";
1307 #####################################################################
1308 # generate a print function for an enum
1309 sub ParseEnumPrint($$)
1311 my($enum,$name) = @_;
1313 pidl "const char *val = NULL;";
1318 pidl "switch (r) {";
1320 my $els = \@{$enum->{ELEMENTS}};
1321 foreach my $i (0 .. $#{$els}) {
1322 my $e = ${$els}[$i];
1324 if ($e =~ /^(.*)=/) {
1327 pidl "case $e: val = \"$e\"; break;";
1333 pidl "ndr_print_enum(ndr, name, \"$enum->{TYPE}\", val, r);";
1340 my ($e,$t,$name) = @_;
1341 return "enum $name " .
1342 ($t eq "pull"?"*":"") . "r";
1345 $typefamily{ENUM} = {
1347 PUSH_FN_BODY => \&ParseEnumPush,
1348 PULL_FN_BODY => \&ParseEnumPull,
1349 PRINT_FN_BODY => \&ParseEnumPrint,
1352 #####################################################################
1353 # generate a push function for a bitmap
1354 sub ParseBitmapPush($$)
1356 my($bitmap,$name) = @_;
1357 my($type_fn) = $bitmap->{BASE_TYPE};
1359 start_flags($bitmap);
1361 pidl "NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, r));";
1366 #####################################################################
1367 # generate a pull function for an bitmap
1368 sub ParseBitmapPull($$)
1370 my($bitmap,$name) = @_;
1371 my $type_fn = $bitmap->{BASE_TYPE};
1372 my($type_decl) = mapType($bitmap->{BASE_TYPE});
1374 pidl "$type_decl v;";
1375 start_flags($bitmap);
1376 pidl "NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));";
1382 #####################################################################
1383 # generate a print function for an bitmap
1384 sub ParseBitmapPrintElement($$$)
1386 my($e,$bitmap,$name) = @_;
1387 my($type_decl) = mapType($bitmap->{BASE_TYPE});
1388 my($type_fn) = $bitmap->{BASE_TYPE};
1391 if ($e =~ /^(\w+) .*$/) {
1394 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1397 pidl "ndr_print_bitmap_flag(ndr, sizeof($type_decl), \"$flag\", $flag, r);";
1400 #####################################################################
1401 # generate a print function for an bitmap
1402 sub ParseBitmapPrint($$)
1404 my($bitmap,$name) = @_;
1405 my($type_decl) = mapType($bitmap->{TYPE});
1406 my($type_fn) = $bitmap->{BASE_TYPE};
1408 start_flags($bitmap);
1410 pidl "ndr_print_$type_fn(ndr, name, r);";
1412 pidl "ndr->depth++;";
1413 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1414 ParseBitmapPrintElement($e, $bitmap, $name);
1416 pidl "ndr->depth--;";
1423 my ($e,$t,$name) = @_;
1424 return mapType(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1425 ($t eq "pull"?" *":" ") . "r";
1428 $typefamily{BITMAP} = {
1429 DECL => \&DeclBitmap,
1430 PUSH_FN_BODY => \&ParseBitmapPush,
1431 PULL_FN_BODY => \&ParseBitmapPull,
1432 PRINT_FN_BODY => \&ParseBitmapPrint,
1435 #####################################################################
1436 # generate a struct print function
1437 sub ParseStructPrint($$)
1439 my($struct,$name) = @_;
1441 return unless defined $struct->{ELEMENTS};
1443 my $env = GenerateStructEnv($struct);
1445 EnvSubstituteValue($env, $struct);
1447 DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1449 pidl "ndr_print_struct(ndr, name, \"$name\");";
1451 start_flags($struct);
1453 pidl "ndr->depth++;";
1455 ParseElementPrint($_, "r->$_->{NAME}", $env) foreach (@{$struct->{ELEMENTS}});
1456 pidl "ndr->depth--;";
1461 sub DeclarePtrVariables($)
1464 foreach my $l (@{$e->{LEVELS}}) {
1465 if ($l->{TYPE} eq "POINTER" and
1466 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1467 pidl "uint32_t _ptr_$e->{NAME};";
1473 sub DeclareArrayVariables($)
1477 foreach my $l (@{$e->{LEVELS}}) {
1478 next if has_fast_array($e,$l);
1479 next if is_charset_array($e,$l);
1480 if ($l->{TYPE} eq "ARRAY") {
1481 pidl "uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};";
1486 sub need_decl_mem_ctx($$)
1490 return 0 if has_fast_array($e,$l);
1491 return 0 if is_charset_array($e,$l);
1492 return 1 if (($l->{TYPE} eq "ARRAY") and not $l->{IS_FIXED});
1494 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
1495 my $nl = GetNextLevel($e, $l);
1496 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1497 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1498 ($nl->{DATA_TYPE} eq "string"));
1499 return 0 if ($next_is_array or $next_is_string);
1501 return 1 if ($l->{TYPE} eq "POINTER");
1506 sub DeclareMemCtxVariables($)
1509 foreach my $l (@{$e->{LEVELS}}) {
1510 if (need_decl_mem_ctx($e, $l)) {
1511 pidl "TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};";
1516 #####################################################################
1517 # parse a struct - pull side
1518 sub ParseStructPull($$)
1520 my($struct,$name) = @_;
1522 return unless defined $struct->{ELEMENTS};
1524 my $env = GenerateStructEnv($struct);
1526 # declare any internal pointers we need
1527 foreach my $e (@{$struct->{ELEMENTS}}) {
1528 DeclarePtrVariables($e);
1529 DeclareArrayVariables($e);
1530 DeclareMemCtxVariables($e);
1533 # save the old relative_base_offset
1534 pidl "uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset(ndr);" if defined($struct->{PROPERTIES}{relative_base});
1536 start_flags($struct);
1538 pidl "if (ndr_flags & NDR_SCALARS) {";
1541 if (defined $struct->{SURROUNDING_ELEMENT}) {
1542 pidl "NDR_CHECK(ndr_pull_array_size(ndr, &r->$struct->{SURROUNDING_ELEMENT}->{NAME}));";
1545 pidl "NDR_CHECK(ndr_pull_align(ndr, $struct->{ALIGN}));";
1547 if (defined($struct->{PROPERTIES}{relative_base})) {
1548 # set the current offset as base for relative pointers
1549 # and store it based on the toplevel struct/union
1550 pidl "NDR_CHECK(ndr_pull_setup_relative_base_offset1(ndr, r, ndr->offset));";
1553 foreach my $e (@{$struct->{ELEMENTS}}) {
1554 ParseElementPull($e, "ndr", $env, 1, 0);
1561 pidl "if (ndr_flags & NDR_BUFFERS) {";
1563 if (defined($struct->{PROPERTIES}{relative_base})) {
1564 # retrieve the current offset as base for relative pointers
1565 # based on the toplevel struct/union
1566 pidl "NDR_CHECK(ndr_pull_setup_relative_base_offset2(ndr, r));";
1568 foreach my $e (@{$struct->{ELEMENTS}}) {
1569 ParseElementPull($e, "ndr", $env, 0, 1);
1578 # restore the old relative_base_offset
1579 pidl "ndr_pull_restore_relative_base_offset(ndr, _save_relative_base_offset);" if defined($struct->{PROPERTIES}{relative_base});
1582 #####################################################################
1583 # calculate size of ndr struct
1584 sub ParseStructNdrSize($$)
1586 my ($t, $name) = @_;
1589 if (my $flags = has_property($t, "flag")) {
1590 pidl "flags |= $flags;";
1592 pidl "return ndr_size_struct(r, flags, (ndr_push_flags_fn_t)ndr_push_$name);";
1597 my ($e,$t,$name) = @_;
1598 return ($t ne "pull"?"const ":"") . "struct $name *r";
1601 sub ArgsStructNdrSize($$)
1603 my ($d, $name) = @_;
1604 return "const struct $name *r, int flags";
1607 $typefamily{STRUCT} = {
1608 PUSH_FN_BODY => \&ParseStructPush,
1609 DECL => \&DeclStruct,
1610 PULL_FN_BODY => \&ParseStructPull,
1611 PRINT_FN_BODY => \&ParseStructPrint,
1612 SIZE_FN_BODY => \&ParseStructNdrSize,
1613 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1616 #####################################################################
1617 # calculate size of ndr struct
1618 sub ParseUnionNdrSize($$)
1620 my ($t, $name) = @_;
1623 if (my $flags = has_property($t, "flag")) {
1624 pidl "flags |= $flags;";
1627 pidl "return ndr_size_union(r, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);";
1630 #####################################################################
1631 # parse a union - push side
1632 sub ParseUnionPush($$)
1635 my $have_default = 0;
1637 # save the old relative_base_offset
1638 pidl "uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset(ndr);" if defined($e->{PROPERTIES}{relative_base});
1643 pidl "level = ndr_push_get_switch_value(ndr, r);";
1645 pidl "if (ndr_flags & NDR_SCALARS) {";
1648 if (defined($e->{SWITCH_TYPE})) {
1649 pidl "NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}(ndr, NDR_SCALARS, level));";
1652 pidl "switch (level) {";
1654 foreach my $el (@{$e->{ELEMENTS}}) {
1655 if ($el->{CASE} eq "default") {
1658 pidl "$el->{CASE}:";
1660 if ($el->{TYPE} ne "EMPTY") {
1662 if (defined($e->{PROPERTIES}{relative_base})) {
1663 pidl "NDR_CHECK(ndr_push_align(ndr, $el->{ALIGN}));";
1664 # set the current offset as base for relative pointers
1665 # and store it based on the toplevel struct/union
1666 pidl "NDR_CHECK(ndr_push_setup_relative_base_offset1(ndr, r, ndr->offset));";
1668 DeclareArrayVariables($el);
1669 ParseElementPush($el, "ndr", {$el->{NAME} => "r->$el->{NAME}"}, 1, 0);
1675 if (! $have_default) {
1677 pidl "\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1683 pidl "if (ndr_flags & NDR_BUFFERS) {";
1685 if (defined($e->{PROPERTIES}{relative_base})) {
1686 # retrieve the current offset as base for relative pointers
1687 # based on the toplevel struct/union
1688 pidl "NDR_CHECK(ndr_push_setup_relative_base_offset2(ndr, r));";
1690 pidl "switch (level) {";
1692 foreach my $el (@{$e->{ELEMENTS}}) {
1693 pidl "$el->{CASE}:";
1694 if ($el->{TYPE} ne "EMPTY") {
1696 ParseElementPush($el, "ndr", {$el->{NAME} => "r->$el->{NAME}"}, 0, 1);
1702 if (! $have_default) {
1704 pidl "\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1712 # restore the old relative_base_offset
1713 pidl "ndr_push_restore_relative_base_offset(ndr, _save_relative_base_offset);" if defined($e->{PROPERTIES}{relative_base});
1716 #####################################################################
1718 sub ParseUnionPrint($$)
1721 my $have_default = 0;
1724 foreach my $el (@{$e->{ELEMENTS}}) {
1725 DeclareArrayVariables($el);
1730 pidl "level = ndr_print_get_switch_value(ndr, r);";
1732 pidl "ndr_print_union(ndr, name, level, \"$name\");";
1734 pidl "switch (level) {";
1736 foreach my $el (@{$e->{ELEMENTS}}) {
1737 if ($el->{CASE} eq "default") {
1740 pidl "$el->{CASE}:";
1741 if ($el->{TYPE} ne "EMPTY") {
1743 ParseElementPrint($el, "r->$el->{NAME}", {});
1749 if (! $have_default) {
1751 pidl "\tndr_print_bad_level(ndr, name, level);";
1759 #####################################################################
1760 # parse a union - pull side
1761 sub ParseUnionPull($$)
1764 my $have_default = 0;
1765 my $switch_type = $e->{SWITCH_TYPE};
1767 # save the old relative_base_offset
1768 pidl "uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset(ndr);" if defined($e->{PROPERTIES}{relative_base});
1770 if (defined($switch_type)) {
1771 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1772 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1774 pidl mapType($switch_type) . " _level;";
1777 my %double_cases = ();
1778 foreach my $el (@{$e->{ELEMENTS}}) {
1779 next if ($el->{TYPE} eq "EMPTY");
1780 next if ($double_cases{"$el->{NAME}"});
1781 DeclareMemCtxVariables($el);
1782 $double_cases{"$el->{NAME}"} = 1;
1787 pidl "level = ndr_pull_get_switch_value(ndr, r);";
1789 pidl "if (ndr_flags & NDR_SCALARS) {";
1792 if (defined($switch_type)) {
1793 pidl "NDR_CHECK(ndr_pull_$switch_type(ndr, NDR_SCALARS, &_level));";
1794 pidl "if (_level != level) {";
1795 pidl "\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $name\", _level);";
1799 pidl "switch (level) {";
1801 foreach my $el (@{$e->{ELEMENTS}}) {
1802 if ($el->{CASE} eq "default") {
1805 pidl "$el->{CASE}: {";
1807 if ($el->{TYPE} ne "EMPTY") {
1809 DeclarePtrVariables($el);
1810 DeclareArrayVariables($el);
1811 if (defined($e->{PROPERTIES}{relative_base})) {
1812 pidl "NDR_CHECK(ndr_pull_align(ndr, $el->{ALIGN}));";
1813 # set the current offset as base for relative pointers
1814 # and store it based on the toplevel struct/union
1815 pidl "NDR_CHECK(ndr_pull_setup_relative_base_offset1(ndr, r, ndr->offset));";
1817 ParseElementPull($el, "ndr", {$el->{NAME} => "r->$el->{NAME}"}, 1, 0);
1823 if (! $have_default) {
1825 pidl "\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1831 pidl "if (ndr_flags & NDR_BUFFERS) {";
1833 if (defined($e->{PROPERTIES}{relative_base})) {
1834 # retrieve the current offset as base for relative pointers
1835 # based on the toplevel struct/union
1836 pidl "NDR_CHECK(ndr_pull_setup_relative_base_offset2(ndr, r));";
1838 pidl "switch (level) {";
1840 foreach my $el (@{$e->{ELEMENTS}}) {
1841 pidl "$el->{CASE}:";
1842 if ($el->{TYPE} ne "EMPTY") {
1844 ParseElementPull($el, "ndr", {$el->{NAME} => "r->$el->{NAME}"}, 0, 1);
1850 if (! $have_default) {
1852 pidl "\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1863 # restore the old relative_base_offset
1864 pidl "ndr_pull_restore_relative_base_offset(ndr, _save_relative_base_offset);" if defined($e->{PROPERTIES}{relative_base});
1869 my ($e,$t,$name) = @_;
1870 return ($t ne "pull"?"const ":"") . "union $name *r";
1873 sub ArgsUnionNdrSize($$)
1876 return "const union $name *r, uint32_t level, int flags";
1879 $typefamily{UNION} = {
1880 PUSH_FN_BODY => \&ParseUnionPush,
1881 DECL => \&DeclUnion,
1882 PULL_FN_BODY => \&ParseUnionPull,
1883 PRINT_FN_BODY => \&ParseUnionPrint,
1884 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
1885 SIZE_FN_BODY => \&ParseUnionNdrSize,
1888 #####################################################################
1889 # parse a typedef - push side
1890 sub ParseTypedefPush($$)
1894 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($e->{DATA}, $name);
1897 #####################################################################
1898 # parse a typedef - pull side
1899 sub ParseTypedefPull($$)
1903 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($e->{DATA}, $name);
1906 #####################################################################
1907 # parse a typedef - print side
1908 sub ParseTypedefPrint($$)
1912 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($e->{DATA}, $name);
1915 #####################################################################
1916 ## calculate the size of a structure
1917 sub ParseTypedefNdrSize($$)
1921 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($t->{DATA}, $name);
1924 sub DeclTypedef($$$)
1926 my ($e, $t, $name) = @_;
1928 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name);
1931 sub ArgsTypedefNdrSize($$)
1933 my ($d, $name) = @_;
1934 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name);
1937 $typefamily{TYPEDEF} = {
1938 PUSH_FN_BODY => \&ParseTypedefPush,
1939 DECL => \&DeclTypedef,
1940 PULL_FN_BODY => \&ParseTypedefPull,
1941 PRINT_FN_BODY => \&ParseTypedefPrint,
1942 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
1943 SIZE_FN_BODY => \&ParseTypedefNdrSize,
1946 #####################################################################
1947 # parse a function - print side
1948 sub ParseFunctionPrint($)
1952 pidl_hdr "void ndr_print_$fn->{NAME}(struct ndr_print *ndr, const char *name, int flags, const struct $fn->{NAME} *r);";
1954 return if has_property($fn, "noprint");
1956 pidl "_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *ndr, const char *name, int flags, const struct $fn->{NAME} *r)";
1960 foreach my $e (@{$fn->{ELEMENTS}}) {
1961 DeclareArrayVariables($e);
1964 pidl "ndr_print_struct(ndr, name, \"$fn->{NAME}\");";
1965 pidl "ndr->depth++;";
1967 pidl "if (flags & NDR_SET_VALUES) {";
1968 pidl "\tndr->flags |= LIBNDR_PRINT_SET_VALUES;";
1971 pidl "if (flags & NDR_IN) {";
1973 pidl "ndr_print_struct(ndr, \"in\", \"$fn->{NAME}\");";
1974 pidl "ndr->depth++;";
1976 my $env = GenerateFunctionInEnv($fn);
1977 EnvSubstituteValue($env, $fn);
1979 foreach my $e (@{$fn->{ELEMENTS}}) {
1980 if (grep(/in/,@{$e->{DIRECTION}})) {
1981 ParseElementPrint($e, $env->{$e->{NAME}}, $env);
1984 pidl "ndr->depth--;";
1988 pidl "if (flags & NDR_OUT) {";
1990 pidl "ndr_print_struct(ndr, \"out\", \"$fn->{NAME}\");";
1991 pidl "ndr->depth++;";
1993 $env = GenerateFunctionOutEnv($fn);
1994 foreach my $e (@{$fn->{ELEMENTS}}) {
1995 if (grep(/out/,@{$e->{DIRECTION}})) {
1996 ParseElementPrint($e, $env->{$e->{NAME}}, $env);
1999 if ($fn->{RETURN_TYPE}) {
2000 pidl "ndr_print_$fn->{RETURN_TYPE}(ndr, \"result\", r->out.result);";
2002 pidl "ndr->depth--;";
2006 pidl "ndr->depth--;";
2012 #####################################################################
2014 sub ParseFunctionPush($)
2018 fn_declare("push", $fn, "NTSTATUS ndr_push_$fn->{NAME}(struct ndr_push *ndr, int flags, const struct $fn->{NAME} *r)") or return;
2020 return if has_property($fn, "nopush");
2025 foreach my $e (@{$fn->{ELEMENTS}}) {
2026 DeclareArrayVariables($e);
2029 pidl "if (flags & NDR_IN) {";
2032 my $env = GenerateFunctionInEnv($fn);
2034 EnvSubstituteValue($env, $fn);
2036 foreach my $e (@{$fn->{ELEMENTS}}) {
2037 if (grep(/in/,@{$e->{DIRECTION}})) {
2038 ParseElementPush($e, "ndr", $env, 1, 1);
2045 pidl "if (flags & NDR_OUT) {";
2048 $env = GenerateFunctionOutEnv($fn);
2049 foreach my $e (@{$fn->{ELEMENTS}}) {
2050 if (grep(/out/,@{$e->{DIRECTION}})) {
2051 ParseElementPush($e, "ndr", $env, 1, 1);
2055 if ($fn->{RETURN_TYPE}) {
2056 pidl "NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, r->out.result));";
2061 pidl "return NT_STATUS_OK;";
2067 sub AllocateArrayLevel($$$$$)
2069 my ($e,$l,$ndr,$env,$size) = @_;
2071 my $var = ParseExpr($e->{NAME}, $env, $e->{ORIGINAL});
2073 my $pl = GetPrevLevel($e, $l);
2074 if (defined($pl) and
2075 $pl->{TYPE} eq "POINTER" and
2076 $pl->{POINTER_TYPE} eq "ref"
2077 and not $l->{IS_ZERO_TERMINATED}) {
2078 pidl "if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {";
2079 pidl "\tNDR_PULL_ALLOC_N($ndr, $var, $size);";
2081 if (grep(/in/,@{$e->{DIRECTION}}) and
2082 grep(/out/,@{$e->{DIRECTION}})) {
2083 pidl "memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, $size * sizeof(*r->in.$e->{NAME}));";
2088 pidl "NDR_PULL_ALLOC_N($ndr, $var, $size);";
2091 #####################################################################
2093 sub ParseFunctionPull($)
2097 # pull function args
2098 fn_declare("pull", $fn, "NTSTATUS ndr_pull_$fn->{NAME}(struct ndr_pull *ndr, int flags, struct $fn->{NAME} *r)") or return;
2103 # declare any internal pointers we need
2104 foreach my $e (@{$fn->{ELEMENTS}}) {
2105 DeclarePtrVariables($e);
2106 DeclareArrayVariables($e);
2109 my %double_cases = ();
2110 foreach my $e (@{$fn->{ELEMENTS}}) {
2111 next if ($e->{TYPE} eq "EMPTY");
2112 next if ($double_cases{"$e->{NAME}"});
2113 DeclareMemCtxVariables($e);
2114 $double_cases{"$e->{NAME}"} = 1;
2117 pidl "if (flags & NDR_IN) {";
2120 # auto-init the out section of a structure. I originally argued that
2121 # this was a bad idea as it hides bugs, but coping correctly
2122 # with initialisation and not wiping ref vars is turning
2123 # out to be too tricky (tridge)
2124 foreach my $e (@{$fn->{ELEMENTS}}) {
2125 next unless grep(/out/, @{$e->{DIRECTION}});
2126 pidl "ZERO_STRUCT(r->out);";
2131 my $env = GenerateFunctionInEnv($fn);
2133 foreach my $e (@{$fn->{ELEMENTS}}) {
2134 next unless (grep(/in/, @{$e->{DIRECTION}}));
2135 ParseElementPull($e, "ndr", $env, 1, 1);
2138 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2139 # own flag rather than be in NDR_IN ?
2141 foreach my $e (@{$fn->{ELEMENTS}}) {
2142 next unless (grep(/out/, @{$e->{DIRECTION}}));
2143 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2144 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2145 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2146 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2147 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2148 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2150 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2151 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL}, check_null_pointer($e, $env, \&pidl, "return NT_STATUS_INVALID_PARAMETER_MIX;"),
2152 check_fully_dereferenced($e, $env));
2154 pidl "NDR_PULL_ALLOC_N(ndr, r->out.$e->{NAME}, $size);";
2156 if (grep(/in/, @{$e->{DIRECTION}})) {
2157 pidl "memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, $size * sizeof(*r->in.$e->{NAME}));";
2159 pidl "memset(r->out.$e->{NAME}, 0, $size * sizeof(*r->out.$e->{NAME}));";
2162 pidl "NDR_PULL_ALLOC(ndr, r->out.$e->{NAME});";
2164 if (grep(/in/, @{$e->{DIRECTION}})) {
2165 pidl "*r->out.$e->{NAME} = *r->in.$e->{NAME};";
2167 pidl "ZERO_STRUCTP(r->out.$e->{NAME});";
2176 pidl "if (flags & NDR_OUT) {";
2179 $env = GenerateFunctionOutEnv($fn);
2180 foreach my $e (@{$fn->{ELEMENTS}}) {
2181 next unless grep(/out/, @{$e->{DIRECTION}});
2182 ParseElementPull($e, "ndr", $env, 1, 1);
2185 if ($fn->{RETURN_TYPE}) {
2186 pidl "NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, &r->out.result));";
2193 pidl "return NT_STATUS_OK;";
2199 #####################################################################
2200 # produce a function call table
2201 sub FunctionTable($)
2203 my($interface) = shift;
2205 my $uname = uc $interface->{NAME};
2207 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2208 return unless defined ($interface->{PROPERTIES}->{uuid});
2210 pidl "static const struct dcerpc_interface_call $interface->{NAME}\_calls[] = {";
2211 foreach my $d (@{$interface->{FUNCTIONS}}) {
2212 next if not defined($d->{OPNUM});
2214 pidl "\t\t\"$d->{NAME}\",";
2215 pidl "\t\tsizeof(struct $d->{NAME}),";
2216 pidl "\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},";
2217 pidl "\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},";
2218 pidl "\t\t(ndr_print_function_t) ndr_print_$d->{NAME},";
2219 pidl "\t\t".($d->{ASYNC}?"True":"False").",";
2223 pidl "\t{ NULL, 0, NULL, NULL, NULL, False }";
2227 pidl "static const char * const $interface->{NAME}\_endpoint_strings[] = {";
2228 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2231 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2236 pidl "static const struct dcerpc_endpoint_list $interface->{NAME}\_endpoints = {";
2237 pidl "\t.count\t= $endpoint_count,";
2238 pidl "\t.names\t= $interface->{NAME}\_endpoint_strings";
2242 if (! defined $interface->{PROPERTIES}->{authservice}) {
2243 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2246 my @a = split / /, $interface->{PROPERTIES}->{authservice};
2247 my $authservice_count = $#a + 1;
2249 pidl "static const char * const $interface->{NAME}\_authservice_strings[] = {";
2250 foreach my $ap (@a) {
2256 pidl "static const struct dcerpc_authservice_list $interface->{NAME}\_authservices = {";
2257 pidl "\t.count\t= $endpoint_count,";
2258 pidl "\t.names\t= $interface->{NAME}\_authservice_strings";
2262 pidl "\nconst struct dcerpc_interface_table dcerpc_table_$interface->{NAME} = {";
2263 pidl "\t.name\t\t= \"$interface->{NAME}\",";
2264 pidl "\t.syntax_id\t= {";
2265 pidl "\t\t" . print_uuid($interface->{UUID}) .",";
2266 pidl "\t\tDCERPC_$uname\_VERSION";
2268 pidl "\t.helpstring\t= DCERPC_$uname\_HELPSTRING,";
2269 pidl "\t.num_calls\t= $count,";
2270 pidl "\t.calls\t\t= $interface->{NAME}\_calls,";
2271 pidl "\t.endpoints\t= &$interface->{NAME}\_endpoints,";
2272 pidl "\t.authservices\t= &$interface->{NAME}\_authservices";
2278 #####################################################################
2279 # generate include statements for imported idl files
2283 foreach (@imports) {
2286 pidl choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h");
2290 #####################################################################
2291 # generate include statements for included header files
2295 foreach (@includes) {
2296 pidl_hdr "#include $_";
2300 #####################################################################
2301 # generate prototypes and defines for the interface definitions
2302 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2303 # NDR parser and so do not belong here, technically speaking
2304 sub HeaderInterface($)
2306 my($interface) = shift;
2310 pidl_hdr choose_header("librpc/ndr/libndr.h", "ndr.h");
2312 if (has_property($interface, "object")) {
2313 pidl choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h");
2316 if (defined $interface->{PROPERTIES}->{helper}) {
2317 HeaderInclude(split / /, $interface->{PROPERTIES}->{helper});
2320 if (defined $interface->{PROPERTIES}->{uuid}) {
2321 my $name = uc $interface->{NAME};
2322 pidl_hdr "#define DCERPC_$name\_UUID " .
2323 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid}));
2325 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2326 pidl_hdr "#define DCERPC_$name\_VERSION $interface->{PROPERTIES}->{version}";
2328 pidl_hdr "#define DCERPC_$name\_NAME \"$interface->{NAME}\"";
2330 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2331 pidl_hdr "#define DCERPC_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}";
2333 pidl_hdr "extern const struct dcerpc_interface_table dcerpc_table_$interface->{NAME};";
2334 pidl_hdr "NTSTATUS dcerpc_server_$interface->{NAME}_init(void);";
2337 foreach (@{$interface->{FUNCTIONS}}) {
2338 next if has_property($_, "noopnum");
2339 next if grep(/$_->{NAME}/,@{$interface->{INHERITED_FUNCTIONS}});
2340 my $u_name = uc $_->{NAME};
2342 my $val = sprintf("0x%02x", $count);
2343 if (defined($interface->{BASE})) {
2344 $val .= " + DCERPC_" . uc $interface->{BASE} . "_CALL_COUNT";
2347 pidl_hdr "#define DCERPC_$u_name ($val)";
2355 if (defined($interface->{BASE})) {
2356 $val .= " + DCERPC_" . uc $interface->{BASE} . "_CALL_COUNT";
2359 pidl_hdr "#define DCERPC_" . uc $interface->{NAME} . "_CALL_COUNT ($val)";
2363 sub ParseTypePush($)
2367 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME});
2368 fn_declare("push", $e, "NTSTATUS ndr_push_$e->{NAME}(struct ndr_push *ndr, int ndr_flags, $args)") or return;
2372 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($e, $e->{NAME});
2373 pidl "return NT_STATUS_OK;";
2379 sub ParseTypePull($)
2383 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME});
2385 fn_declare("pull", $e, "NTSTATUS ndr_pull_$e->{NAME}(struct ndr_pull *ndr, int ndr_flags, $args)") or return;
2389 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($e, $e->{NAME});
2390 pidl "return NT_STATUS_OK;";
2396 sub ParseTypePrint($)
2399 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME});
2401 pidl_hdr "void ndr_print_$e->{NAME}(struct ndr_print *ndr, const char *name, $args);";
2403 return if (has_property($e, "noprint"));
2405 pidl "_PUBLIC_ void ndr_print_$e->{NAME}(struct ndr_print *ndr, const char *name, $args)";
2408 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($e, $e->{NAME});
2414 sub ParseTypeNdrSize($)
2418 my $tf = $typefamily{$t->{TYPE}};
2419 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME});
2421 fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2425 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($t, $t->{NAME});
2431 #####################################################################
2432 # parse the interface definitions
2433 sub ParseInterface($$)
2435 my($interface,$needed) = @_;
2437 pidl_hdr "#ifndef _HEADER_NDR_$interface->{NAME}";
2438 pidl_hdr "#define _HEADER_NDR_$interface->{NAME}";
2442 if ($needed->{"compression"}) {
2443 pidl choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h");
2446 HeaderInterface($interface);
2449 foreach my $d (@{$interface->{TYPES}}) {
2450 ($needed->{"push_$d->{NAME}"}) && ParseTypePush($d);
2451 ($needed->{"pull_$d->{NAME}"}) && ParseTypePull($d);
2452 ($needed->{"print_$d->{NAME}"}) && ParseTypePrint($d);
2454 # Make sure we don't generate a function twice...
2455 $needed->{"push_$d->{NAME}"} = $needed->{"pull_$d->{NAME}"} =
2456 $needed->{"print_$d->{NAME}"} = 0;
2458 ($needed->{"ndr_size_$d->{NAME}"}) && ParseTypeNdrSize($d);
2462 foreach my $d (@{$interface->{FUNCTIONS}}) {
2463 ($needed->{"push_$d->{NAME}"}) && ParseFunctionPush($d);
2464 ($needed->{"pull_$d->{NAME}"}) && ParseFunctionPull($d);
2465 ($needed->{"print_$d->{NAME}"}) && ParseFunctionPrint($d);
2467 # Make sure we don't generate a function twice...
2468 $needed->{"push_$d->{NAME}"} = $needed->{"pull_$d->{NAME}"} =
2469 $needed->{"print_$d->{NAME}"} = 0;
2472 FunctionTable($interface);
2474 pidl_hdr "#endif /* _HEADER_NDR_$interface->{NAME} */";
2477 sub GenerateIncludes()
2480 pidl "#include \"includes.h\"";
2482 pidl "#define _GNU_SOURCE";
2483 pidl "#include <stdint.h>";
2484 pidl "#include <stdlib.h>";
2485 pidl "#include <stdio.h>";
2486 pidl "#include <stdbool.h>";
2487 pidl "#include <stdarg.h>";
2488 pidl "#include <string.h>";
2491 # Samba3 has everything in include/includes.h
2492 if (is_intree() != 3) {
2493 pidl choose_header("libcli/util/nterr.h", "core/nterr.h");
2494 pidl choose_header("librpc/gen_ndr/ndr_misc.h", "gen_ndr/ndr_misc.h");
2495 pidl choose_header("librpc/gen_ndr/ndr_dcerpc.h", "gen_ndr/ndr_dcerpc.h");
2496 pidl choose_header("librpc/rpc/dcerpc.h", "dcerpc.h"); #FIXME: This shouldn't be here!
2500 #####################################################################
2501 # parse a parsed IDL structure back into an IDL file
2504 my($ndr,$gen_header,$ndr_header) = @_;
2510 pidl_hdr "/* header auto-generated by pidl */";
2512 pidl_hdr "#include \"$gen_header\"" if ($gen_header);
2515 pidl "/* parser auto-generated by pidl */";
2518 pidl "#include \"$ndr_header\"" if ($ndr_header);
2524 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2528 ($_->{TYPE} eq "INTERFACE") && ParseInterface($_, \%needed);
2529 ($_->{TYPE} eq "IMPORT") && HeaderImport(@{$_->{PATHS}});
2530 ($_->{TYPE} eq "INCLUDE") && HeaderInclude(@{$_->{PATHS}});
2533 return ($res_hdr, $res);
2536 sub NeededElement($$$)
2538 my ($e, $dir, $needed) = @_;
2540 return if ($e->{TYPE} eq "EMPTY");
2543 if ($dir eq "print") {
2544 push(@fn, "print_$e->{REPRESENTATION_TYPE}");
2545 } elsif ($dir eq "pull") {
2546 push (@fn, "pull_$e->{TYPE}");
2547 push (@fn, "ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}")
2548 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE});
2549 } elsif ($dir eq "push") {
2550 push (@fn, "push_$e->{TYPE}");
2551 push (@fn, "ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}")
2552 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE});
2554 die("invalid direction `$dir'");
2558 unless (defined($needed->{$_})) {
2564 sub NeededFunction($$)
2566 my ($fn,$needed) = @_;
2567 $needed->{"pull_$fn->{NAME}"} = 1;
2568 $needed->{"push_$fn->{NAME}"} = 1;
2569 $needed->{"print_$fn->{NAME}"} = 1;
2570 foreach my $e (@{$fn->{ELEMENTS}}) {
2572 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
2578 my ($t,$needed) = @_;
2579 if (has_property($t, "public")) {
2580 $needed->{"pull_$t->{NAME}"} = 1;
2581 $needed->{"push_$t->{NAME}"} = 1;
2582 $needed->{"print_$t->{NAME}"} = 1;
2585 if ($t->{DATA}->{TYPE} eq "STRUCT" or $t->{DATA}->{TYPE} eq "UNION") {
2586 if (has_property($t, "gensize")) {
2587 $needed->{"ndr_size_$t->{NAME}"} = 1;
2590 for my $e (@{$t->{DATA}->{ELEMENTS}}) {
2591 $e->{PARENT} = $t->{DATA};
2592 if (has_property($e, "compression")) {
2593 $needed->{"compression"} = 1;
2595 NeededElement($e, "pull", $needed) if ($needed->{"pull_$t->{NAME}"});
2596 NeededElement($e, "push", $needed) if ($needed->{"push_$t->{NAME}"});
2597 NeededElement($e, "print", $needed) if ($needed->{"print_$t->{NAME}"});
2602 #####################################################################
2603 # work out what parse functions are needed
2604 sub NeededInterface($$)
2606 my ($interface,$needed) = @_;
2607 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
2608 NeededType($_, $needed) foreach (reverse @{$interface->{TYPES}});