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);
17 use Parse
::Pidl
::Typelist
qw(hasType getType mapType);
18 use Parse
::Pidl
::Util
qw(has_property ParseExpr ParseExprExt print_uuid);
19 use Parse
::Pidl
::NDR
qw(GetPrevLevel GetNextLevel ContainsDeferred);
20 use Parse
::Pidl
::Samba4
qw(is_intree choose_header);
21 use Parse
::Pidl
qw(warning);
23 use vars
qw($VERSION);
32 return $typefamily{$n};
37 my ($e, $var_name) = @_;
40 foreach my $l (@{$e->{LEVELS}}) {
41 if ($l->{TYPE} eq "POINTER") {
43 } elsif ($l->{TYPE} eq "ARRAY") {
44 if (($pointers == 0) and
45 (not $l->{IS_FIXED}) and
46 (not $l->{IS_INLINE})) {
47 return get_value_of($var_name);
49 } elsif ($l->{TYPE} eq "DATA") {
50 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
51 return get_value_of($var_name) unless ($pointers);
59 sub has_fast_array($$)
63 return 0 if ($l->{TYPE} ne "ARRAY");
65 my $nl = GetNextLevel($e,$l);
66 return 0 unless ($nl->{TYPE} eq "DATA");
67 return 0 unless (hasType($nl->{DATA_TYPE}));
69 my $t = getType($nl->{DATA_TYPE});
71 # Only uint8 and string have fast array functions at the moment
72 return ($t->{NAME} eq "uint8") or ($t->{NAME} eq "string");
75 sub is_charset_array($$)
79 return 0 if ($l->{TYPE} ne "ARRAY");
81 my $nl = GetNextLevel($e,$l);
83 return 0 unless ($nl->{TYPE} eq "DATA");
85 return has_property($e, "charset");
92 if ($var_name =~ /^\*(.*)$/) {
94 } elsif ($var_name =~ /^\&(.*)$/) {
95 return "&($var_name)";
103 my $var_name = shift;
105 if ($var_name =~ /^\&(.*)$/) {
116 ####################################
117 # pidl() is our basic output routine
130 sub pidl_hdr ($) { my $d = shift; $res_hdr .= "$d\n"; }
132 ####################################
133 # defer() is like pidl(), but adds to
134 # a deferred buffer which is then added to the
135 # output buffer at the end of the structure/union/function
136 # This is needed to cope with code that must be pushed back
137 # to the end of a block of elements
139 sub defer_indent() { $defer_tabs.="\t"; }
140 sub defer_deindent() { $defer_tabs=substr($defer_tabs, 0, -1); }
146 push(@$deferred, $defer_tabs.$d);
150 ########################################
151 # add the deferred content to the current
155 pidl $_ foreach (@$deferred);
167 $tabs = substr($tabs, 0, -1);
170 #####################################################################
171 # declare a function public or static, depending on its attributes
174 my ($type,$fn,$decl) = @_;
176 if (has_property($fn, "no$type")) {
181 if (has_property($fn, "public")) {
183 pidl "_PUBLIC_ $decl";
191 ###################################################################
192 # setup any special flags for an element or structure
196 my $flags = has_property($e, "flag");
197 if (defined $flags) {
200 pidl "uint32_t _flags_save_$e->{TYPE} = ndr->flags;";
201 pidl "ndr_set_flags(&ndr->flags, $flags);";
205 ###################################################################
206 # end any special flags for an element or structure
210 my $flags = has_property($e, "flag");
211 if (defined $flags) {
212 pidl "ndr->flags = _flags_save_$e->{TYPE};";
218 sub GenerateStructEnv($)
223 foreach my $e (@{$x->{ELEMENTS}}) {
224 $env{$e->{NAME}} = "r->$e->{NAME}";
232 sub EnvSubstituteValue($$)
236 # Substitute the value() values in the env
237 foreach my $e (@{$s->{ELEMENTS}}) {
238 next unless (defined(my $v = has_property($e, "value")));
240 $env->{$e->{NAME}} = ParseExpr($v, $env, $e);
246 sub GenerateFunctionInEnv($)
251 foreach my $e (@{$fn->{ELEMENTS}}) {
252 if (grep (/in/, @{$e->{DIRECTION}})) {
253 $env{$e->{NAME}} = "r->in.$e->{NAME}";
260 sub GenerateFunctionOutEnv($)
265 foreach my $e (@{$fn->{ELEMENTS}}) {
266 if (grep (/out/, @{$e->{DIRECTION}})) {
267 $env{$e->{NAME}} = "r->out.$e->{NAME}";
268 } elsif (grep (/in/, @{$e->{DIRECTION}})) {
269 $env{$e->{NAME}} = "r->in.$e->{NAME}";
276 #####################################################################
277 # parse the data of an array - push side
278 sub ParseArrayPushHeader($$$$$)
280 my ($e,$l,$ndr,$var_name,$env) = @_;
285 if ($l->{IS_ZERO_TERMINATED}) {
286 if (has_property($e, "charset")) {
287 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
289 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
292 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
293 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
296 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
297 pidl "NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $size));";
300 if ($l->{IS_VARYING}) {
301 pidl "NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, 0));"; # array offset
302 pidl "NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $length));";
308 sub check_fully_dereferenced($$)
310 my ($element, $env) = @_;
316 # Figure out the number of pointers in $ptr
317 my $expandedvar = $origvar;
318 $expandedvar =~ s/^(\**)//;
322 foreach (keys %$env) {
323 if ($env->{$_} eq $expandedvar) {
329 return($origvar) unless (defined($var));
331 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
332 if ($_->{NAME} eq $var) {
338 $e or die("Environment doesn't match siblings");
340 # See if pointer at pointer level $level
341 # needs to be checked.
343 foreach (@{$e->{LEVELS}}) {
344 if ($_->{TYPE} eq "POINTER") {
345 $nump = $_->{POINTER_INDEX}+1;
348 warning($element->{ORIGINAL}, "Got pointer for `$e->{NAME}', expected fully derefenced variable") if ($nump > length($ptr));
353 sub check_null_pointer($$$$)
355 my ($element, $env, $print_fn, $return) = @_;
358 my $expandedvar = shift;
361 # Figure out the number of pointers in $ptr
362 $expandedvar =~ s/^(\**)//;
366 foreach (keys %$env) {
367 if ($env->{$_} eq $expandedvar) {
376 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
377 if ($_->{NAME} eq $var) {
383 $e or die("Environment doesn't match siblings");
385 # See if pointer at pointer level $level
386 # needs to be checked.
387 foreach my $l (@{$e->{LEVELS}}) {
388 if ($l->{TYPE} eq "POINTER" and
389 $l->{POINTER_INDEX} == length($ptr)) {
390 # No need to check ref pointers
391 $check = ($l->{POINTER_TYPE} ne "ref");
395 if ($l->{TYPE} eq "DATA") {
396 warning($element, "too much dereferences for `$var'");
400 warning($element, "unknown dereferenced expression `$expandedvar'");
404 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
408 #####################################################################
409 # parse an array - pull side
410 sub ParseArrayPullHeader($$$$$)
412 my ($e,$l,$ndr,$var_name,$env) = @_;
417 if ($l->{IS_CONFORMANT}) {
418 $length = $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
419 } elsif ($l->{IS_ZERO_TERMINATED}) { # Noheader arrays
420 $length = $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
422 $length = $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
423 check_null_pointer($e, $env, \&pidl, "return NT_STATUS_INVALID_PARAMETER_MIX;"), check_fully_dereferenced($e, $env));
426 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
427 pidl "NDR_CHECK(ndr_pull_array_size(ndr, " . get_pointer_to($var_name) . "));";
430 if ($l->{IS_VARYING}) {
431 pidl "NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));";
432 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
435 if ($length ne $size) {
436 pidl "if ($length > $size) {";
438 pidl "return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $size, $length);";
443 if ($l->{IS_CONFORMANT} and not $l->{IS_ZERO_TERMINATED}) {
444 defer "if ($var_name) {";
446 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));
447 defer "NDR_CHECK(ndr_check_array_size(ndr, (void*)" . get_pointer_to($var_name) . ", $size));";
452 if ($l->{IS_VARYING} and not $l->{IS_ZERO_TERMINATED}) {
453 defer "if ($var_name) {";
455 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
456 check_null_pointer($e, $env, \&defer, "return NT_STATUS_INVALID_PARAMETER_MIX;"),
457 check_fully_dereferenced($e, $env));
458 defer "NDR_CHECK(ndr_check_array_length(ndr, (void*)" . get_pointer_to($var_name) . ", $length));";
463 if (not $l->{IS_FIXED} and not is_charset_array($e, $l)) {
464 AllocateArrayLevel($e,$l,$ndr,$env,$size);
470 sub compression_alg($$)
473 my ($alg, $clen, $dlen) = split(/ /, $l->{COMPRESSION});
478 sub compression_clen($$$)
480 my ($e, $l, $env) = @_;
481 my ($alg, $clen, $dlen) = split(/ /, $l->{COMPRESSION});
483 return ParseExpr($clen, $env, $e->{ORIGINAL});
486 sub compression_dlen($$$)
488 my ($e,$l,$env) = @_;
489 my ($alg, $clen, $dlen) = split(/ /, $l->{COMPRESSION});
491 return ParseExpr($dlen, $env, $e->{ORIGINAL});
494 sub ParseCompressionPushStart($$$$)
496 my ($e,$l,$ndr,$env) = @_;
497 my $comndr = "$ndr\_compressed";
498 my $alg = compression_alg($e, $l);
499 my $dlen = compression_dlen($e, $l, $env);
503 pidl "struct ndr_push *$comndr;";
504 pidl "NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));";
509 sub ParseCompressionPushEnd($$$$)
511 my ($e,$l,$ndr,$env) = @_;
512 my $comndr = "$ndr\_compressed";
513 my $alg = compression_alg($e, $l);
514 my $dlen = compression_dlen($e, $l, $env);
516 pidl "NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));";
521 sub ParseCompressionPullStart($$$$)
523 my ($e,$l,$ndr,$env) = @_;
524 my $comndr = "$ndr\_compressed";
525 my $alg = compression_alg($e, $l);
526 my $dlen = compression_dlen($e, $l, $env);
530 pidl "struct ndr_pull *$comndr;";
531 pidl "NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));";
536 sub ParseCompressionPullEnd($$$$)
538 my ($e,$l,$ndr,$env) = @_;
539 my $comndr = "$ndr\_compressed";
540 my $alg = compression_alg($e, $l);
541 my $dlen = compression_dlen($e, $l, $env);
543 pidl "NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));";
548 sub ParseSubcontextPushStart($$$$)
550 my ($e,$l,$ndr,$env) = @_;
551 my $subndr = "_ndr_$e->{NAME}";
552 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
556 pidl "struct ndr_push *$subndr;";
557 pidl "NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));";
559 if (defined $l->{COMPRESSION}) {
560 $subndr = ParseCompressionPushStart($e, $l, $subndr, $env);
566 sub ParseSubcontextPushEnd($$$$)
568 my ($e,$l,$ndr,$env) = @_;
569 my $subndr = "_ndr_$e->{NAME}";
570 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
572 if (defined $l->{COMPRESSION}) {
573 ParseCompressionPushEnd($e, $l, $subndr, $env);
576 pidl "NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));";
581 sub ParseSubcontextPullStart($$$$)
583 my ($e,$l,$ndr,$env) = @_;
584 my $subndr = "_ndr_$e->{NAME}";
585 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
589 pidl "struct ndr_pull *$subndr;";
590 pidl "NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));";
592 if (defined $l->{COMPRESSION}) {
593 $subndr = ParseCompressionPullStart($e, $l, $subndr, $env);
599 sub ParseSubcontextPullEnd($$$$)
601 my ($e,$l,$ndr,$env) = @_;
602 my $subndr = "_ndr_$e->{NAME}";
603 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
605 if (defined $l->{COMPRESSION}) {
606 ParseCompressionPullEnd($e, $l, $subndr, $env);
609 pidl "NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));";
614 sub ParseElementPushLevel
616 my ($e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
618 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
620 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
621 $var_name = get_pointer_to($var_name);
624 if (defined($ndr_flags)) {
625 if ($l->{TYPE} eq "SUBCONTEXT") {
626 my $subndr = ParseSubcontextPushStart($e, $l, $ndr, $env);
627 ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
628 ParseSubcontextPushEnd($e, $l, $ndr, $env);
629 } elsif ($l->{TYPE} eq "POINTER") {
630 ParsePtrPush($e, $l, $var_name);
631 } elsif ($l->{TYPE} eq "ARRAY") {
632 my $length = ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
634 my $nl = GetNextLevel($e, $l);
636 # Allow speedups for arrays of scalar types
637 if (is_charset_array($e,$l)) {
638 pidl "NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapType($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));";
640 } elsif (has_fast_array($e,$l)) {
641 pidl "NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));";
644 } elsif ($l->{TYPE} eq "SWITCH") {
645 ParseSwitchPush($e, $l, $ndr, $var_name, $ndr_flags, $env);
646 } elsif ($l->{TYPE} eq "DATA") {
647 ParseDataPush($e, $l, $ndr, $var_name, $ndr_flags);
651 if ($l->{TYPE} eq "POINTER" and $deferred) {
652 if ($l->{POINTER_TYPE} ne "ref") {
653 pidl "if ($var_name) {";
655 if ($l->{POINTER_TYPE} eq "relative") {
656 pidl "NDR_CHECK(ndr_push_relative_ptr2(ndr, $var_name));";
659 $var_name = get_value_of($var_name);
660 ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
662 if ($l->{POINTER_TYPE} ne "ref") {
666 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
667 not is_charset_array($e, $l)) {
668 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
669 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
671 $var_name = $var_name . "[$counter]";
673 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
674 pidl "for ($counter = 0; $counter < $length; $counter++) {";
676 ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
681 if ($deferred and ContainsDeferred($e, $l)) {
682 pidl "for ($counter = 0; $counter < $length; $counter++) {";
684 ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
688 } elsif ($l->{TYPE} eq "SWITCH") {
689 ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
693 #####################################################################
694 # parse scalars in a structure element
695 sub ParseElementPush($$$$$)
697 my ($e,$ndr,$env,$primitives,$deferred) = @_;
700 my $var_name = $env->{$e->{NAME}};
702 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
704 # Representation type is different from transmit_as
705 if ($e->{REPRESENTATION_TYPE}) {
708 my $transmit_name = "_transmit_$e->{NAME}";
709 pidl mapType($e->{TYPE}) ." $transmit_name;";
710 pidl "NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));";
711 $var_name = $transmit_name;
714 $var_name = append_prefix($e, $var_name);
718 if (defined(my $value = has_property($e, "value"))) {
719 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
722 ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
726 if ($e->{REPRESENTATION_TYPE}) {
732 #####################################################################
733 # parse a pointer in a struct element or function
734 sub ParsePtrPush($$$)
736 my ($e,$l,$var_name) = @_;
738 if ($l->{POINTER_TYPE} eq "ref") {
739 pidl "if ($var_name == NULL) return NT_STATUS_INVALID_PARAMETER_MIX;";
740 if ($l->{LEVEL} eq "EMBEDDED") {
741 pidl "NDR_CHECK(ndr_push_ref_ptr(ndr));";
743 } elsif ($l->{POINTER_TYPE} eq "relative") {
744 pidl "NDR_CHECK(ndr_push_relative_ptr1(ndr, $var_name));";
745 } elsif ($l->{POINTER_TYPE} eq "unique") {
746 pidl "NDR_CHECK(ndr_push_unique_ptr(ndr, $var_name));";
747 } elsif ($l->{POINTER_TYPE} eq "full") {
748 pidl "NDR_CHECK(ndr_push_full_ptr(ndr, $var_name));";
750 die("Unhandled pointer type $l->{POINTER_TYPE}");
754 #####################################################################
755 # print scalars in a structure element
756 sub ParseElementPrint($$$)
758 my($e, $var_name, $env) = @_;
760 return if (has_property($e, "noprint"));
762 if ($e->{REPRESENTATION_TYPE}) {
763 pidl "ndr_print_$e->{REPRESENTATION_TYPE}(ndr, \"$e->{NAME}\", $var_name);";
767 $var_name = append_prefix($e, $var_name);
769 if (defined(my $value = has_property($e, "value"))) {
770 $var_name = "(ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
773 foreach my $l (@{$e->{LEVELS}}) {
774 if ($l->{TYPE} eq "POINTER") {
775 pidl "ndr_print_ptr(ndr, \"$e->{NAME}\", $var_name);";
776 pidl "ndr->depth++;";
777 if ($l->{POINTER_TYPE} ne "ref") {
778 pidl "if ($var_name) {";
781 $var_name = get_value_of($var_name);
782 } elsif ($l->{TYPE} eq "ARRAY") {
785 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
786 $var_name = get_pointer_to($var_name);
789 if ($l->{IS_ZERO_TERMINATED}) {
790 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
792 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
793 check_null_pointer($e, $env, \&pidl, "return;"), check_fully_dereferenced($e, $env));
796 if (is_charset_array($e,$l)) {
797 pidl "ndr_print_string(ndr, \"$e->{NAME}\", $var_name);";
799 } elsif (has_fast_array($e, $l)) {
800 my $nl = GetNextLevel($e, $l);
801 pidl "ndr_print_array_$nl->{DATA_TYPE}(ndr, \"$e->{NAME}\", $var_name, $length);";
804 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
806 pidl "ndr->print(ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", $length);";
807 pidl 'ndr->depth++;';
808 pidl "for ($counter=0;$counter<$length;$counter++) {";
810 pidl "char *idx_$l->{LEVEL_INDEX}=NULL;";
811 pidl "asprintf(&idx_$l->{LEVEL_INDEX}, \"[\%d]\", $counter);";
812 pidl "if (idx_$l->{LEVEL_INDEX}) {";
815 $var_name = $var_name . "[$counter]";
817 } elsif ($l->{TYPE} eq "DATA") {
818 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE}) or Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
819 $var_name = get_pointer_to($var_name);
821 pidl "ndr_print_$l->{DATA_TYPE}(ndr, \"$e->{NAME}\", $var_name);";
822 } elsif ($l->{TYPE} eq "SWITCH") {
823 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
824 check_null_pointer($e, $env, \&pidl, "return;"), check_fully_dereferenced($e, $env));
825 pidl "ndr_print_set_switch_value(ndr, " . get_pointer_to($var_name) . ", $switch_var);";
829 foreach my $l (reverse @{$e->{LEVELS}}) {
830 if ($l->{TYPE} eq "POINTER") {
831 if ($l->{POINTER_TYPE} ne "ref") {
835 pidl "ndr->depth--;";
836 } elsif (($l->{TYPE} eq "ARRAY")
837 and not is_charset_array($e,$l)
838 and not has_fast_array($e,$l)) {
839 pidl "free(idx_$l->{LEVEL_INDEX});";
844 pidl "ndr->depth--;";
849 #####################################################################
850 # parse scalars in a structure element - pull size
851 sub ParseSwitchPull($$$$$$)
853 my($e,$l,$ndr,$var_name,$ndr_flags,$env) = @_;
854 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
855 check_null_pointer($e, $env, \&pidl, "return NT_STATUS_INVALID_PARAMETER_MIX;"), check_fully_dereferenced($e, $env));
857 $var_name = get_pointer_to($var_name);
858 pidl "NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));";
861 #####################################################################
862 # push switch element
863 sub ParseSwitchPush($$$$$$)
865 my($e,$l,$ndr,$var_name,$ndr_flags,$env) = @_;
866 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
867 check_null_pointer($e, $env, \&pidl, "return NT_STATUS_INVALID_PARAMETER_MIX;"), check_fully_dereferenced($e, $env));
869 $var_name = get_pointer_to($var_name);
870 pidl "NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));";
873 sub ParseDataPull($$$$$)
875 my ($e,$l,$ndr,$var_name,$ndr_flags) = @_;
877 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
878 $var_name = get_pointer_to($var_name);
881 $var_name = get_pointer_to($var_name);
883 pidl "NDR_CHECK(ndr_pull_$l->{DATA_TYPE}($ndr, $ndr_flags, $var_name));";
885 if (my $range = has_property($e, "range")) {
886 $var_name = get_value_of($var_name);
887 my ($low, $high) = split(/ /, $range, 2);
888 pidl "if ($var_name < $low || $var_name > $high) {";
889 pidl "\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");";
894 sub ParseDataPush($$$$$)
896 my ($e,$l,$ndr,$var_name,$ndr_flags) = @_;
898 # strings are passed by value rather than reference
899 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE}) or Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
900 $var_name = get_pointer_to($var_name);
903 pidl "NDR_CHECK(ndr_push_$l->{DATA_TYPE}($ndr, $ndr_flags, $var_name));";
906 sub CalcNdrFlags($$$)
908 my ($l,$primitives,$deferred) = @_;
913 # Add NDR_SCALARS if this one is deferred
914 # and deferreds may be pushed
915 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
917 # Add NDR_SCALARS if this one is not deferred and
918 # primitives may be pushed
919 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
921 # Add NDR_BUFFERS if this one contains deferred stuff
922 # and deferreds may be pushed
923 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
925 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
926 return "NDR_SCALARS" if ($scalars);
927 return "NDR_BUFFERS" if ($buffers);
931 sub ParseMemCtxPullStart($$$)
933 my ($e, $l, $ptr_name) = @_;
935 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
936 my $mem_c_ctx = $ptr_name;
937 my $mem_c_flags = "0";
939 return if ($l->{TYPE} eq "ARRAY" and $l->{IS_FIXED});
941 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
942 my $nl = GetNextLevel($e, $l);
943 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
944 my $next_is_string = (($nl->{TYPE} eq "DATA") and
945 ($nl->{DATA_TYPE} eq "string"));
946 if ($next_is_array or $next_is_string) {
949 $mem_c_flags = "LIBNDR_FLAG_REF_ALLOC";
953 pidl "$mem_r_ctx = NDR_PULL_GET_MEM_CTX(ndr);";
954 pidl "NDR_PULL_SET_MEM_CTX(ndr, $mem_c_ctx, $mem_c_flags);";
957 sub ParseMemCtxPullEnd($$)
962 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
963 my $mem_r_flags = "0";
965 return if ($l->{TYPE} eq "ARRAY" and $l->{IS_FIXED});
967 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
968 my $nl = GetNextLevel($e, $l);
969 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
970 my $next_is_string = (($nl->{TYPE} eq "DATA") and
971 ($nl->{DATA_TYPE} eq "string"));
972 if ($next_is_array or $next_is_string) {
975 $mem_r_flags = "LIBNDR_FLAG_REF_ALLOC";
979 pidl "NDR_PULL_SET_MEM_CTX(ndr, $mem_r_ctx, $mem_r_flags);";
982 sub CheckStringTerminator($$$$)
984 my ($ndr,$e,$l,$length) = @_;
985 my $nl = GetNextLevel($e, $l);
987 # Make sure last element is zero!
988 pidl "NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));";
991 sub ParseElementPullLevel
993 my($e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
995 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
997 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
998 $var_name = get_pointer_to($var_name);
1001 # Only pull something if there's actually something to be pulled
1002 if (defined($ndr_flags)) {
1003 if ($l->{TYPE} eq "SUBCONTEXT") {
1004 my $subndr = ParseSubcontextPullStart($e, $l, $ndr, $env);
1005 ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1006 ParseSubcontextPullEnd($e, $l, $ndr, $env);
1007 } elsif ($l->{TYPE} eq "ARRAY") {
1008 my $length = ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1010 my $nl = GetNextLevel($e, $l);
1012 if (is_charset_array($e,$l)) {
1013 if ($l->{IS_ZERO_TERMINATED}) {
1014 CheckStringTerminator($ndr, $e, $l, $length);
1016 pidl "NDR_CHECK(ndr_pull_charset($ndr, $ndr_flags, ".get_pointer_to($var_name).", $length, sizeof(" . mapType($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));";
1018 } elsif (has_fast_array($e, $l)) {
1019 if ($l->{IS_ZERO_TERMINATED}) {
1020 CheckStringTerminator($ndr,$e,$l,$length);
1022 pidl "NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));";
1025 } elsif ($l->{TYPE} eq "POINTER") {
1026 ParsePtrPull($e, $l, $ndr, $var_name);
1027 } elsif ($l->{TYPE} eq "SWITCH") {
1028 ParseSwitchPull($e, $l, $ndr, $var_name, $ndr_flags, $env);
1029 } elsif ($l->{TYPE} eq "DATA") {
1030 ParseDataPull($e, $l, $ndr, $var_name, $ndr_flags);
1034 # add additional constructions
1035 if ($l->{TYPE} eq "POINTER" and $deferred) {
1036 if ($l->{POINTER_TYPE} ne "ref") {
1037 pidl "if ($var_name) {";
1040 if ($l->{POINTER_TYPE} eq "relative") {
1041 pidl "struct ndr_pull_save _relative_save;";
1042 pidl "ndr_pull_save(ndr, &_relative_save);";
1043 pidl "NDR_CHECK(ndr_pull_relative_ptr2(ndr, $var_name));";
1047 ParseMemCtxPullStart($e, $l, $var_name);
1049 $var_name = get_value_of($var_name);
1050 ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1052 ParseMemCtxPullEnd($e,$l);
1054 if ($l->{POINTER_TYPE} ne "ref") {
1055 if ($l->{POINTER_TYPE} eq "relative") {
1056 pidl "ndr_pull_restore(ndr, &_relative_save);";
1061 } elsif ($l->{TYPE} eq "ARRAY" and
1062 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1063 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1064 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1065 my $array_name = $var_name;
1067 $var_name = $var_name . "[$counter]";
1069 ParseMemCtxPullStart($e, $l, $array_name);
1071 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1072 my $nl = GetNextLevel($e,$l);
1074 if ($l->{IS_ZERO_TERMINATED}) {
1075 CheckStringTerminator($ndr,$e,$l,$length);
1078 pidl "for ($counter = 0; $counter < $length; $counter++) {";
1080 ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1085 if ($deferred and ContainsDeferred($e, $l)) {
1086 pidl "for ($counter = 0; $counter < $length; $counter++) {";
1088 ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1093 ParseMemCtxPullEnd($e, $l);
1095 } elsif ($l->{TYPE} eq "SWITCH") {
1096 ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1100 #####################################################################
1101 # parse scalars in a structure element - pull size
1102 sub ParseElementPull($$$$$)
1104 my($e,$ndr,$env,$primitives,$deferred) = @_;
1106 my $var_name = $env->{$e->{NAME}};
1110 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1112 if ($e->{REPRESENTATION_TYPE}) {
1115 $represent_name = $var_name;
1116 $transmit_name = "_transmit_$e->{NAME}";
1117 $var_name = $transmit_name;
1118 pidl mapType($e->{TYPE})." $var_name;";
1121 $var_name = append_prefix($e, $var_name);
1125 ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1129 # Representation type is different from transmit_as
1130 if ($e->{REPRESENTATION_TYPE}) {
1131 pidl "NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));";
1137 #####################################################################
1138 # parse a pointer in a struct element or function
1139 sub ParsePtrPull($$$$)
1141 my($e,$l,$ndr,$var_name) = @_;
1143 my $nl = GetNextLevel($e, $l);
1144 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1145 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1146 ($nl->{DATA_TYPE} eq "string"));
1148 if ($l->{POINTER_TYPE} eq "ref") {
1149 if ($l->{LEVEL} eq "EMBEDDED") {
1150 pidl "NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));";
1153 if (!$next_is_array and !$next_is_string) {
1154 pidl "if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {";
1155 pidl "\tNDR_PULL_ALLOC($ndr, $var_name);";
1160 } elsif (($l->{POINTER_TYPE} eq "unique") or
1161 ($l->{POINTER_TYPE} eq "relative") or
1162 ($l->{POINTER_TYPE} eq "full")) {
1163 pidl "NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));";
1164 pidl "if (_ptr_$e->{NAME}) {";
1167 die("Unhandled pointer type $l->{POINTER_TYPE}");
1170 # Don't do this for arrays, they're allocated at the actual level
1172 unless ($next_is_array or $next_is_string) {
1173 pidl "NDR_PULL_ALLOC($ndr, $var_name);";
1175 # FIXME: Yes, this is nasty.
1176 # We allocate an array twice
1177 # - once just to indicate that it's there,
1178 # - then the real allocation...
1179 pidl "NDR_PULL_ALLOC($ndr, $var_name);";
1182 #pidl "memset($var_name, 0, sizeof($var_name));";
1183 if ($l->{POINTER_TYPE} eq "relative") {
1184 pidl "NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));";
1188 pidl "\t$var_name = NULL;";
1192 #####################################################################
1194 sub ParseStructPush($$)
1196 my($struct,$name) = @_;
1198 return unless defined($struct->{ELEMENTS});
1200 my $env = GenerateStructEnv($struct);
1202 EnvSubstituteValue($env, $struct);
1204 # save the old relative_base_offset
1205 pidl "uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset(ndr);" if defined($struct->{PROPERTIES}{relative_base});
1207 foreach my $e (@{$struct->{ELEMENTS}}) {
1208 DeclareArrayVariables($e);
1211 start_flags($struct);
1213 # see if the structure contains a conformant array. If it
1214 # does, then it must be the last element of the structure, and
1215 # we need to push the conformant length early, as it fits on
1216 # the wire before the structure (and even before the structure
1218 if (defined($struct->{SURROUNDING_ELEMENT})) {
1219 my $e = $struct->{SURROUNDING_ELEMENT};
1221 if (defined($e->{LEVELS}[0]) and
1222 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1225 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1226 if (has_property($e, "charset")) {
1227 $size = "ndr_charset_length(r->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1229 $size = "ndr_string_length(r->$e->{NAME}, sizeof(*r->$e->{NAME}))";
1232 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1235 pidl "NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, $size));";
1237 pidl "NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, ndr_string_array_size(ndr, r->$e->{NAME})));";
1241 pidl "if (ndr_flags & NDR_SCALARS) {";
1244 pidl "NDR_CHECK(ndr_push_align(ndr, $struct->{ALIGN}));";
1246 if (defined($struct->{PROPERTIES}{relative_base})) {
1247 # set the current offset as base for relative pointers
1248 # and store it based on the toplevel struct/union
1249 pidl "NDR_CHECK(ndr_push_setup_relative_base_offset1(ndr, r, ndr->offset));";
1252 foreach my $e (@{$struct->{ELEMENTS}}) {
1253 ParseElementPush($e, "ndr", $env, 1, 0);
1259 pidl "if (ndr_flags & NDR_BUFFERS) {";
1261 if (defined($struct->{PROPERTIES}{relative_base})) {
1262 # retrieve the current offset as base for relative pointers
1263 # based on the toplevel struct/union
1264 pidl "NDR_CHECK(ndr_push_setup_relative_base_offset2(ndr, r));";
1266 foreach my $e (@{$struct->{ELEMENTS}}) {
1267 ParseElementPush($e, "ndr", $env, 0, 1);
1274 # restore the old relative_base_offset
1275 pidl "ndr_push_restore_relative_base_offset(ndr, _save_relative_base_offset);" if defined($struct->{PROPERTIES}{relative_base});
1278 #####################################################################
1279 # generate a push function for an enum
1280 sub ParseEnumPush($$)
1282 my($enum,$name) = @_;
1283 my($type_fn) = $enum->{BASE_TYPE};
1286 pidl "NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, r));";
1290 #####################################################################
1291 # generate a pull function for an enum
1292 sub ParseEnumPull($$)
1294 my($enum,$name) = @_;
1295 my($type_fn) = $enum->{BASE_TYPE};
1296 my($type_v_decl) = mapType($type_fn);
1298 pidl "$type_v_decl v;";
1300 pidl "NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));";
1306 #####################################################################
1307 # generate a print function for an enum
1308 sub ParseEnumPrint($$)
1310 my($enum,$name) = @_;
1312 pidl "const char *val = NULL;";
1317 pidl "switch (r) {";
1319 my $els = \@{$enum->{ELEMENTS}};
1320 foreach my $i (0 .. $#{$els}) {
1321 my $e = ${$els}[$i];
1323 if ($e =~ /^(.*)=/) {
1326 pidl "case $e: val = \"$e\"; break;";
1332 pidl "ndr_print_enum(ndr, name, \"$enum->{TYPE}\", val, r);";
1340 return "enum $e->{NAME} " .
1341 ($t eq "pull"?"*":"") . "r";
1344 $typefamily{ENUM} = {
1346 PUSH_FN_BODY => \&ParseEnumPush,
1347 PULL_FN_BODY => \&ParseEnumPull,
1348 PRINT_FN_BODY => \&ParseEnumPrint,
1351 #####################################################################
1352 # generate a push function for a bitmap
1353 sub ParseBitmapPush($$)
1355 my($bitmap,$name) = @_;
1356 my($type_fn) = $bitmap->{BASE_TYPE};
1358 start_flags($bitmap);
1360 pidl "NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, r));";
1365 #####################################################################
1366 # generate a pull function for an bitmap
1367 sub ParseBitmapPull($$)
1369 my($bitmap,$name) = @_;
1370 my $type_fn = $bitmap->{BASE_TYPE};
1371 my($type_decl) = mapType($bitmap->{BASE_TYPE});
1373 pidl "$type_decl v;";
1374 start_flags($bitmap);
1375 pidl "NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));";
1381 #####################################################################
1382 # generate a print function for an bitmap
1383 sub ParseBitmapPrintElement($$$)
1385 my($e,$bitmap,$name) = @_;
1386 my($type_decl) = mapType($bitmap->{BASE_TYPE});
1387 my($type_fn) = $bitmap->{BASE_TYPE};
1390 if ($e =~ /^(\w+) .*$/) {
1393 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1396 pidl "ndr_print_bitmap_flag(ndr, sizeof($type_decl), \"$flag\", $flag, r);";
1399 #####################################################################
1400 # generate a print function for an bitmap
1401 sub ParseBitmapPrint($$)
1403 my($bitmap,$name) = @_;
1404 my($type_decl) = mapType($bitmap->{TYPE});
1405 my($type_fn) = $bitmap->{BASE_TYPE};
1407 start_flags($bitmap);
1409 pidl "ndr_print_$type_fn(ndr, name, r);";
1411 pidl "ndr->depth++;";
1412 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1413 ParseBitmapPrintElement($e, $bitmap, $name);
1415 pidl "ndr->depth--;";
1423 return mapType(Parse::Pidl::Typelist::bitmap_type_fn($e->{DATA})) .
1424 ($t eq "pull"?" *":" ") . "r";
1427 $typefamily{BITMAP} = {
1428 DECL => \&DeclBitmap,
1429 PUSH_FN_BODY => \&ParseBitmapPush,
1430 PULL_FN_BODY => \&ParseBitmapPull,
1431 PRINT_FN_BODY => \&ParseBitmapPrint,
1434 #####################################################################
1435 # generate a struct print function
1436 sub ParseStructPrint($$)
1438 my($struct,$name) = @_;
1440 return unless defined $struct->{ELEMENTS};
1442 my $env = GenerateStructEnv($struct);
1444 EnvSubstituteValue($env, $struct);
1446 DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1448 pidl "ndr_print_struct(ndr, name, \"$name\");";
1450 start_flags($struct);
1452 pidl "ndr->depth++;";
1454 ParseElementPrint($_, "r->$_->{NAME}", $env) foreach (@{$struct->{ELEMENTS}});
1455 pidl "ndr->depth--;";
1460 sub DeclarePtrVariables($)
1463 foreach my $l (@{$e->{LEVELS}}) {
1464 if ($l->{TYPE} eq "POINTER" and
1465 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1466 pidl "uint32_t _ptr_$e->{NAME};";
1472 sub DeclareArrayVariables($)
1476 foreach my $l (@{$e->{LEVELS}}) {
1477 next if has_fast_array($e,$l);
1478 next if is_charset_array($e,$l);
1479 if ($l->{TYPE} eq "ARRAY") {
1480 pidl "uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};";
1485 sub need_decl_mem_ctx($$)
1489 return 0 if has_fast_array($e,$l);
1490 return 0 if is_charset_array($e,$l);
1491 return 1 if (($l->{TYPE} eq "ARRAY") and not $l->{IS_FIXED});
1493 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
1494 my $nl = GetNextLevel($e, $l);
1495 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1496 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1497 ($nl->{DATA_TYPE} eq "string"));
1498 return 0 if ($next_is_array or $next_is_string);
1500 return 1 if ($l->{TYPE} eq "POINTER");
1505 sub DeclareMemCtxVariables($)
1508 foreach my $l (@{$e->{LEVELS}}) {
1509 if (need_decl_mem_ctx($e, $l)) {
1510 pidl "TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};";
1515 #####################################################################
1516 # parse a struct - pull side
1517 sub ParseStructPull($$)
1519 my($struct,$name) = @_;
1521 return unless defined $struct->{ELEMENTS};
1523 my $env = GenerateStructEnv($struct);
1525 # declare any internal pointers we need
1526 foreach my $e (@{$struct->{ELEMENTS}}) {
1527 DeclarePtrVariables($e);
1528 DeclareArrayVariables($e);
1529 DeclareMemCtxVariables($e);
1532 # save the old relative_base_offset
1533 pidl "uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset(ndr);" if defined($struct->{PROPERTIES}{relative_base});
1535 start_flags($struct);
1537 pidl "if (ndr_flags & NDR_SCALARS) {";
1540 if (defined $struct->{SURROUNDING_ELEMENT}) {
1541 pidl "NDR_CHECK(ndr_pull_array_size(ndr, &r->$struct->{SURROUNDING_ELEMENT}->{NAME}));";
1544 pidl "NDR_CHECK(ndr_pull_align(ndr, $struct->{ALIGN}));";
1546 if (defined($struct->{PROPERTIES}{relative_base})) {
1547 # set the current offset as base for relative pointers
1548 # and store it based on the toplevel struct/union
1549 pidl "NDR_CHECK(ndr_pull_setup_relative_base_offset1(ndr, r, ndr->offset));";
1552 foreach my $e (@{$struct->{ELEMENTS}}) {
1553 ParseElementPull($e, "ndr", $env, 1, 0);
1560 pidl "if (ndr_flags & NDR_BUFFERS) {";
1562 if (defined($struct->{PROPERTIES}{relative_base})) {
1563 # retrieve the current offset as base for relative pointers
1564 # based on the toplevel struct/union
1565 pidl "NDR_CHECK(ndr_pull_setup_relative_base_offset2(ndr, r));";
1567 foreach my $e (@{$struct->{ELEMENTS}}) {
1568 ParseElementPull($e, "ndr", $env, 0, 1);
1577 # restore the old relative_base_offset
1578 pidl "ndr_pull_restore_relative_base_offset(ndr, _save_relative_base_offset);" if defined($struct->{PROPERTIES}{relative_base});
1581 #####################################################################
1582 # calculate size of ndr struct
1583 sub ParseStructNdrSize($)
1588 if (my $flags = has_property($t, "flag")) {
1589 pidl "flags |= $flags;";
1591 pidl "return ndr_size_struct(r, flags, (ndr_push_flags_fn_t)ndr_push_$t->{NAME});";
1597 return ($t ne "pull"?"const ":"") . "struct $e->{NAME} *r";
1600 sub ArgsStructNdrSize($)
1603 return "const struct $d->{NAME} *r, int flags";
1606 $typefamily{STRUCT} = {
1607 PUSH_FN_BODY => \&ParseStructPush,
1608 DECL => \&DeclStruct,
1609 PULL_FN_BODY => \&ParseStructPull,
1610 PRINT_FN_BODY => \&ParseStructPrint,
1611 SIZE_FN_BODY => \&ParseStructNdrSize,
1612 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1615 #####################################################################
1616 # calculate size of ndr struct
1617 sub ParseUnionNdrSize($)
1622 if (my $flags = has_property($t, "flag")) {
1623 pidl "flags |= $flags;";
1626 pidl "return ndr_size_union(r, flags, level, (ndr_push_flags_fn_t)ndr_push_$t->{NAME});";
1629 #####################################################################
1630 # parse a union - push side
1631 sub ParseUnionPush($$)
1634 my $have_default = 0;
1636 # save the old relative_base_offset
1637 pidl "uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset(ndr);" if defined($e->{PROPERTIES}{relative_base});
1642 pidl "level = ndr_push_get_switch_value(ndr, r);";
1644 pidl "if (ndr_flags & NDR_SCALARS) {";
1647 if (defined($e->{SWITCH_TYPE})) {
1648 pidl "NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}(ndr, NDR_SCALARS, level));";
1651 pidl "switch (level) {";
1653 foreach my $el (@{$e->{ELEMENTS}}) {
1654 if ($el->{CASE} eq "default") {
1657 pidl "$el->{CASE}:";
1659 if ($el->{TYPE} ne "EMPTY") {
1661 if (defined($e->{PROPERTIES}{relative_base})) {
1662 pidl "NDR_CHECK(ndr_push_align(ndr, $el->{ALIGN}));";
1663 # set the current offset as base for relative pointers
1664 # and store it based on the toplevel struct/union
1665 pidl "NDR_CHECK(ndr_push_setup_relative_base_offset1(ndr, r, ndr->offset));";
1667 DeclareArrayVariables($el);
1668 ParseElementPush($el, "ndr", {$el->{NAME} => "r->$el->{NAME}"}, 1, 0);
1674 if (! $have_default) {
1676 pidl "\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1682 pidl "if (ndr_flags & NDR_BUFFERS) {";
1684 if (defined($e->{PROPERTIES}{relative_base})) {
1685 # retrieve the current offset as base for relative pointers
1686 # based on the toplevel struct/union
1687 pidl "NDR_CHECK(ndr_push_setup_relative_base_offset2(ndr, r));";
1689 pidl "switch (level) {";
1691 foreach my $el (@{$e->{ELEMENTS}}) {
1692 pidl "$el->{CASE}:";
1693 if ($el->{TYPE} ne "EMPTY") {
1695 ParseElementPush($el, "ndr", {$el->{NAME} => "r->$el->{NAME}"}, 0, 1);
1701 if (! $have_default) {
1703 pidl "\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1711 # restore the old relative_base_offset
1712 pidl "ndr_push_restore_relative_base_offset(ndr, _save_relative_base_offset);" if defined($e->{PROPERTIES}{relative_base});
1715 #####################################################################
1717 sub ParseUnionPrint($$)
1720 my $have_default = 0;
1723 foreach my $el (@{$e->{ELEMENTS}}) {
1724 DeclareArrayVariables($el);
1729 pidl "level = ndr_print_get_switch_value(ndr, r);";
1731 pidl "ndr_print_union(ndr, name, level, \"$name\");";
1733 pidl "switch (level) {";
1735 foreach my $el (@{$e->{ELEMENTS}}) {
1736 if ($el->{CASE} eq "default") {
1739 pidl "$el->{CASE}:";
1740 if ($el->{TYPE} ne "EMPTY") {
1742 ParseElementPrint($el, "r->$el->{NAME}", {});
1748 if (! $have_default) {
1750 pidl "\tndr_print_bad_level(ndr, name, level);";
1758 #####################################################################
1759 # parse a union - pull side
1760 sub ParseUnionPull($$)
1763 my $have_default = 0;
1764 my $switch_type = $e->{SWITCH_TYPE};
1766 # save the old relative_base_offset
1767 pidl "uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset(ndr);" if defined($e->{PROPERTIES}{relative_base});
1769 if (defined($switch_type)) {
1770 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1771 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1773 pidl mapType($switch_type) . " _level;";
1776 my %double_cases = ();
1777 foreach my $el (@{$e->{ELEMENTS}}) {
1778 next if ($el->{TYPE} eq "EMPTY");
1779 next if ($double_cases{"$el->{NAME}"});
1780 DeclareMemCtxVariables($el);
1781 $double_cases{"$el->{NAME}"} = 1;
1786 pidl "level = ndr_pull_get_switch_value(ndr, r);";
1788 pidl "if (ndr_flags & NDR_SCALARS) {";
1791 if (defined($switch_type)) {
1792 pidl "NDR_CHECK(ndr_pull_$switch_type(ndr, NDR_SCALARS, &_level));";
1793 pidl "if (_level != level) {";
1794 pidl "\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $name\", _level);";
1798 pidl "switch (level) {";
1800 foreach my $el (@{$e->{ELEMENTS}}) {
1801 if ($el->{CASE} eq "default") {
1804 pidl "$el->{CASE}: {";
1806 if ($el->{TYPE} ne "EMPTY") {
1808 DeclarePtrVariables($el);
1809 DeclareArrayVariables($el);
1810 if (defined($e->{PROPERTIES}{relative_base})) {
1811 pidl "NDR_CHECK(ndr_pull_align(ndr, $el->{ALIGN}));";
1812 # set the current offset as base for relative pointers
1813 # and store it based on the toplevel struct/union
1814 pidl "NDR_CHECK(ndr_pull_setup_relative_base_offset1(ndr, r, ndr->offset));";
1816 ParseElementPull($el, "ndr", {$el->{NAME} => "r->$el->{NAME}"}, 1, 0);
1822 if (! $have_default) {
1824 pidl "\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1830 pidl "if (ndr_flags & NDR_BUFFERS) {";
1832 if (defined($e->{PROPERTIES}{relative_base})) {
1833 # retrieve the current offset as base for relative pointers
1834 # based on the toplevel struct/union
1835 pidl "NDR_CHECK(ndr_pull_setup_relative_base_offset2(ndr, r));";
1837 pidl "switch (level) {";
1839 foreach my $el (@{$e->{ELEMENTS}}) {
1840 pidl "$el->{CASE}:";
1841 if ($el->{TYPE} ne "EMPTY") {
1843 ParseElementPull($el, "ndr", {$el->{NAME} => "r->$el->{NAME}"}, 0, 1);
1849 if (! $have_default) {
1851 pidl "\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1862 # restore the old relative_base_offset
1863 pidl "ndr_pull_restore_relative_base_offset(ndr, _save_relative_base_offset);" if defined($e->{PROPERTIES}{relative_base});
1869 return ($t ne "pull"?"const ":"") . "union $e->{NAME} *r";
1872 sub ArgsUnionNdrSize($)
1875 return "const union $d->{NAME} *r, uint32_t level, int flags";
1878 $typefamily{UNION} = {
1879 PUSH_FN_BODY => \&ParseUnionPush,
1880 DECL => \&DeclUnion,
1881 PULL_FN_BODY => \&ParseUnionPull,
1882 PRINT_FN_BODY => \&ParseUnionPrint,
1883 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
1884 SIZE_FN_BODY => \&ParseUnionNdrSize,
1887 #####################################################################
1888 # parse a typedef - push side
1889 sub ParseTypedefPush($)
1893 my $args = $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e,"push");
1894 fn_declare("push", $e, "NTSTATUS ndr_push_$e->{NAME}(struct ndr_push *ndr, int ndr_flags, $args)") or return;
1898 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($e->{DATA}, $e->{NAME});
1899 pidl "return NT_STATUS_OK;";
1905 #####################################################################
1906 # parse a typedef - pull side
1907 sub ParseTypedefPull($)
1911 my $args = $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e,"pull");
1913 fn_declare("pull", $e, "NTSTATUS ndr_pull_$e->{NAME}(struct ndr_pull *ndr, int ndr_flags, $args)") or return;
1917 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($e->{DATA}, $e->{NAME});
1918 pidl "return NT_STATUS_OK;";
1924 #####################################################################
1925 # parse a typedef - print side
1926 sub ParseTypedefPrint($)
1930 my $args = $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e,"print");
1932 pidl_hdr "void ndr_print_$e->{NAME}(struct ndr_print *ndr, const char *name, $args);";
1934 return if (has_property($e, "noprint"));
1936 pidl "_PUBLIC_ void ndr_print_$e->{NAME}(struct ndr_print *ndr, const char *name, $args)";
1939 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($e->{DATA}, $e->{NAME});
1945 #####################################################################
1946 ## calculate the size of a structure
1947 sub ParseTypedefNdrSize($)
1951 my $tf = $typefamily{$t->{DATA}->{TYPE}};
1952 my $args = $tf->{SIZE_FN_ARGS}->($t);
1954 fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
1958 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($t);
1964 #####################################################################
1965 # parse a function - print side
1966 sub ParseFunctionPrint($)
1970 pidl_hdr "void ndr_print_$fn->{NAME}(struct ndr_print *ndr, const char *name, int flags, const struct $fn->{NAME} *r);";
1972 return if has_property($fn, "noprint");
1974 pidl "_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *ndr, const char *name, int flags, const struct $fn->{NAME} *r)";
1978 foreach my $e (@{$fn->{ELEMENTS}}) {
1979 DeclareArrayVariables($e);
1982 pidl "ndr_print_struct(ndr, name, \"$fn->{NAME}\");";
1983 pidl "ndr->depth++;";
1985 pidl "if (flags & NDR_SET_VALUES) {";
1986 pidl "\tndr->flags |= LIBNDR_PRINT_SET_VALUES;";
1989 pidl "if (flags & NDR_IN) {";
1991 pidl "ndr_print_struct(ndr, \"in\", \"$fn->{NAME}\");";
1992 pidl "ndr->depth++;";
1994 my $env = GenerateFunctionInEnv($fn);
1995 EnvSubstituteValue($env, $fn);
1997 foreach my $e (@{$fn->{ELEMENTS}}) {
1998 if (grep(/in/,@{$e->{DIRECTION}})) {
1999 ParseElementPrint($e, $env->{$e->{NAME}}, $env);
2002 pidl "ndr->depth--;";
2006 pidl "if (flags & NDR_OUT) {";
2008 pidl "ndr_print_struct(ndr, \"out\", \"$fn->{NAME}\");";
2009 pidl "ndr->depth++;";
2011 $env = GenerateFunctionOutEnv($fn);
2012 foreach my $e (@{$fn->{ELEMENTS}}) {
2013 if (grep(/out/,@{$e->{DIRECTION}})) {
2014 ParseElementPrint($e, $env->{$e->{NAME}}, $env);
2017 if ($fn->{RETURN_TYPE}) {
2018 pidl "ndr_print_$fn->{RETURN_TYPE}(ndr, \"result\", r->out.result);";
2020 pidl "ndr->depth--;";
2024 pidl "ndr->depth--;";
2030 #####################################################################
2032 sub ParseFunctionPush($)
2036 fn_declare("push", $fn, "NTSTATUS ndr_push_$fn->{NAME}(struct ndr_push *ndr, int flags, const struct $fn->{NAME} *r)") or return;
2038 return if has_property($fn, "nopush");
2043 foreach my $e (@{$fn->{ELEMENTS}}) {
2044 DeclareArrayVariables($e);
2047 pidl "if (flags & NDR_IN) {";
2050 my $env = GenerateFunctionInEnv($fn);
2052 EnvSubstituteValue($env, $fn);
2054 foreach my $e (@{$fn->{ELEMENTS}}) {
2055 if (grep(/in/,@{$e->{DIRECTION}})) {
2056 ParseElementPush($e, "ndr", $env, 1, 1);
2063 pidl "if (flags & NDR_OUT) {";
2066 $env = GenerateFunctionOutEnv($fn);
2067 foreach my $e (@{$fn->{ELEMENTS}}) {
2068 if (grep(/out/,@{$e->{DIRECTION}})) {
2069 ParseElementPush($e, "ndr", $env, 1, 1);
2073 if ($fn->{RETURN_TYPE}) {
2074 pidl "NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, r->out.result));";
2079 pidl "return NT_STATUS_OK;";
2085 sub AllocateArrayLevel($$$$$)
2087 my ($e,$l,$ndr,$env,$size) = @_;
2089 my $var = ParseExpr($e->{NAME}, $env, $e->{ORIGINAL});
2091 my $pl = GetPrevLevel($e, $l);
2092 if (defined($pl) and
2093 $pl->{TYPE} eq "POINTER" and
2094 $pl->{POINTER_TYPE} eq "ref"
2095 and not $l->{IS_ZERO_TERMINATED}) {
2096 pidl "if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {";
2097 pidl "\tNDR_PULL_ALLOC_N($ndr, $var, $size);";
2099 if (grep(/in/,@{$e->{DIRECTION}}) and
2100 grep(/out/,@{$e->{DIRECTION}})) {
2101 pidl "memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, $size * sizeof(*r->in.$e->{NAME}));";
2106 pidl "NDR_PULL_ALLOC_N($ndr, $var, $size);";
2109 #####################################################################
2111 sub ParseFunctionPull($)
2115 # pull function args
2116 fn_declare("pull", $fn, "NTSTATUS ndr_pull_$fn->{NAME}(struct ndr_pull *ndr, int flags, struct $fn->{NAME} *r)") or return;
2121 # declare any internal pointers we need
2122 foreach my $e (@{$fn->{ELEMENTS}}) {
2123 DeclarePtrVariables($e);
2124 DeclareArrayVariables($e);
2127 my %double_cases = ();
2128 foreach my $e (@{$fn->{ELEMENTS}}) {
2129 next if ($e->{TYPE} eq "EMPTY");
2130 next if ($double_cases{"$e->{NAME}"});
2131 DeclareMemCtxVariables($e);
2132 $double_cases{"$e->{NAME}"} = 1;
2135 pidl "if (flags & NDR_IN) {";
2138 # auto-init the out section of a structure. I originally argued that
2139 # this was a bad idea as it hides bugs, but coping correctly
2140 # with initialisation and not wiping ref vars is turning
2141 # out to be too tricky (tridge)
2142 foreach my $e (@{$fn->{ELEMENTS}}) {
2143 next unless grep(/out/, @{$e->{DIRECTION}});
2144 pidl "ZERO_STRUCT(r->out);";
2149 my $env = GenerateFunctionInEnv($fn);
2151 foreach my $e (@{$fn->{ELEMENTS}}) {
2152 next unless (grep(/in/, @{$e->{DIRECTION}}));
2153 ParseElementPull($e, "ndr", $env, 1, 1);
2156 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2157 # own flag rather than be in NDR_IN ?
2159 foreach my $e (@{$fn->{ELEMENTS}}) {
2160 next unless (grep(/out/, @{$e->{DIRECTION}}));
2161 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2162 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2163 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2164 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2165 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2166 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2168 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2169 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL}, check_null_pointer($e, $env, \&pidl, "return NT_STATUS_INVALID_PARAMETER_MIX;"),
2170 check_fully_dereferenced($e, $env));
2172 pidl "NDR_PULL_ALLOC_N(ndr, r->out.$e->{NAME}, $size);";
2174 if (grep(/in/, @{$e->{DIRECTION}})) {
2175 pidl "memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, $size * sizeof(*r->in.$e->{NAME}));";
2177 pidl "memset(r->out.$e->{NAME}, 0, $size * sizeof(*r->out.$e->{NAME}));";
2180 pidl "NDR_PULL_ALLOC(ndr, r->out.$e->{NAME});";
2182 if (grep(/in/, @{$e->{DIRECTION}})) {
2183 pidl "*r->out.$e->{NAME} = *r->in.$e->{NAME};";
2185 pidl "ZERO_STRUCTP(r->out.$e->{NAME});";
2194 pidl "if (flags & NDR_OUT) {";
2197 $env = GenerateFunctionOutEnv($fn);
2198 foreach my $e (@{$fn->{ELEMENTS}}) {
2199 next unless grep(/out/, @{$e->{DIRECTION}});
2200 ParseElementPull($e, "ndr", $env, 1, 1);
2203 if ($fn->{RETURN_TYPE}) {
2204 pidl "NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, &r->out.result));";
2211 pidl "return NT_STATUS_OK;";
2217 #####################################################################
2218 # produce a function call table
2219 sub FunctionTable($)
2221 my($interface) = shift;
2223 my $uname = uc $interface->{NAME};
2225 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2226 return unless defined ($interface->{PROPERTIES}->{uuid});
2228 pidl "static const struct dcerpc_interface_call $interface->{NAME}\_calls[] = {";
2229 foreach my $d (@{$interface->{FUNCTIONS}}) {
2230 next if not defined($d->{OPNUM});
2232 pidl "\t\t\"$d->{NAME}\",";
2233 pidl "\t\tsizeof(struct $d->{NAME}),";
2234 pidl "\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},";
2235 pidl "\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},";
2236 pidl "\t\t(ndr_print_function_t) ndr_print_$d->{NAME},";
2237 pidl "\t\t".($d->{ASYNC}?"True":"False").",";
2241 pidl "\t{ NULL, 0, NULL, NULL, NULL, False }";
2245 pidl "static const char * const $interface->{NAME}\_endpoint_strings[] = {";
2246 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2249 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2254 pidl "static const struct dcerpc_endpoint_list $interface->{NAME}\_endpoints = {";
2255 pidl "\t.count\t= $endpoint_count,";
2256 pidl "\t.names\t= $interface->{NAME}\_endpoint_strings";
2260 if (! defined $interface->{PROPERTIES}->{authservice}) {
2261 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2264 my @a = split / /, $interface->{PROPERTIES}->{authservice};
2265 my $authservice_count = $#a + 1;
2267 pidl "static const char * const $interface->{NAME}\_authservice_strings[] = {";
2268 foreach my $ap (@a) {
2274 pidl "static const struct dcerpc_authservice_list $interface->{NAME}\_authservices = {";
2275 pidl "\t.count\t= $endpoint_count,";
2276 pidl "\t.names\t= $interface->{NAME}\_authservice_strings";
2280 pidl "\nconst struct dcerpc_interface_table dcerpc_table_$interface->{NAME} = {";
2281 pidl "\t.name\t\t= \"$interface->{NAME}\",";
2282 pidl "\t.syntax_id\t= {";
2283 pidl "\t\t" . print_uuid($interface->{UUID}) .",";
2284 pidl "\t\tDCERPC_$uname\_VERSION";
2286 pidl "\t.helpstring\t= DCERPC_$uname\_HELPSTRING,";
2287 pidl "\t.num_calls\t= $count,";
2288 pidl "\t.calls\t\t= $interface->{NAME}\_calls,";
2289 pidl "\t.endpoints\t= &$interface->{NAME}\_endpoints,";
2290 pidl "\t.authservices\t= &$interface->{NAME}\_authservices";
2296 #####################################################################
2297 # generate include statements for imported idl files
2301 foreach (@imports) {
2304 pidl choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h");
2308 #####################################################################
2309 # generate include statements for included header files
2313 foreach (@includes) {
2314 pidl_hdr "#include $_";
2318 #####################################################################
2319 # generate prototypes and defines for the interface definitions
2320 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2321 # NDR parser and so do not belong here, technically speaking
2322 sub HeaderInterface($)
2324 my($interface) = shift;
2328 pidl_hdr choose_header("librpc/ndr/libndr.h", "ndr.h");
2330 if (has_property($interface, "object")) {
2331 pidl choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h");
2334 if (defined $interface->{PROPERTIES}->{helper}) {
2335 HeaderInclude(split / /, $interface->{PROPERTIES}->{helper});
2338 if (defined $interface->{PROPERTIES}->{uuid}) {
2339 my $name = uc $interface->{NAME};
2340 pidl_hdr "#define DCERPC_$name\_UUID " .
2341 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid}));
2343 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2344 pidl_hdr "#define DCERPC_$name\_VERSION $interface->{PROPERTIES}->{version}";
2346 pidl_hdr "#define DCERPC_$name\_NAME \"$interface->{NAME}\"";
2348 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2349 pidl_hdr "#define DCERPC_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}";
2351 pidl_hdr "extern const struct dcerpc_interface_table dcerpc_table_$interface->{NAME};";
2352 pidl_hdr "NTSTATUS dcerpc_server_$interface->{NAME}_init(void);";
2355 foreach (@{$interface->{FUNCTIONS}}) {
2356 next if has_property($_, "noopnum");
2357 next if grep(/$_->{NAME}/,@{$interface->{INHERITED_FUNCTIONS}});
2358 my $u_name = uc $_->{NAME};
2360 my $val = sprintf("0x%02x", $count);
2361 if (defined($interface->{BASE})) {
2362 $val .= " + DCERPC_" . uc $interface->{BASE} . "_CALL_COUNT";
2365 pidl_hdr "#define DCERPC_$u_name ($val)";
2373 if (defined($interface->{BASE})) {
2374 $val .= " + DCERPC_" . uc $interface->{BASE} . "_CALL_COUNT";
2377 pidl_hdr "#define DCERPC_" . uc $interface->{NAME} . "_CALL_COUNT ($val)";
2381 #####################################################################
2382 # parse the interface definitions
2383 sub ParseInterface($$)
2385 my($interface,$needed) = @_;
2387 pidl_hdr "#ifndef _HEADER_NDR_$interface->{NAME}";
2388 pidl_hdr "#define _HEADER_NDR_$interface->{NAME}";
2392 if ($needed->{"compression"}) {
2393 pidl choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h");
2396 HeaderInterface($interface);
2399 foreach my $d (@{$interface->{TYPES}}) {
2400 ($needed->{"push_$d->{NAME}"}) && ParseTypedefPush($d);
2401 ($needed->{"pull_$d->{NAME}"}) && ParseTypedefPull($d);
2402 ($needed->{"print_$d->{NAME}"}) && ParseTypedefPrint($d);
2404 # Make sure we don't generate a function twice...
2405 $needed->{"push_$d->{NAME}"} = $needed->{"pull_$d->{NAME}"} =
2406 $needed->{"print_$d->{NAME}"} = 0;
2408 ($needed->{"ndr_size_$d->{NAME}"}) && ParseTypedefNdrSize($d);
2412 foreach my $d (@{$interface->{FUNCTIONS}}) {
2413 ($needed->{"push_$d->{NAME}"}) && ParseFunctionPush($d);
2414 ($needed->{"pull_$d->{NAME}"}) && ParseFunctionPull($d);
2415 ($needed->{"print_$d->{NAME}"}) && ParseFunctionPrint($d);
2417 # Make sure we don't generate a function twice...
2418 $needed->{"push_$d->{NAME}"} = $needed->{"pull_$d->{NAME}"} =
2419 $needed->{"print_$d->{NAME}"} = 0;
2422 FunctionTable($interface);
2424 pidl_hdr "#endif /* _HEADER_NDR_$interface->{NAME} */";
2427 sub GenerateIncludes()
2430 pidl "#include \"includes.h\"";
2432 pidl "#define _GNU_SOURCE";
2433 pidl "#include <stdint.h>";
2434 pidl "#include <stdlib.h>";
2435 pidl "#include <stdio.h>";
2436 pidl "#include <stdbool.h>";
2437 pidl "#include <stdarg.h>";
2438 pidl "#include <string.h>";
2441 # Samba3 has everything in include/includes.h
2442 if (is_intree() != 3) {
2443 pidl choose_header("libcli/util/nterr.h", "core/nterr.h");
2444 pidl choose_header("librpc/gen_ndr/ndr_misc.h", "gen_ndr/ndr_misc.h");
2445 pidl choose_header("librpc/gen_ndr/ndr_dcerpc.h", "gen_ndr/ndr_dcerpc.h");
2446 pidl choose_header("librpc/rpc/dcerpc.h", "dcerpc.h"); #FIXME: This shouldn't be here!
2450 #####################################################################
2451 # parse a parsed IDL structure back into an IDL file
2454 my($ndr,$gen_header,$ndr_header) = @_;
2460 pidl_hdr "/* header auto-generated by pidl */";
2462 pidl_hdr "#include \"$gen_header\"" if ($gen_header);
2465 pidl "/* parser auto-generated by pidl */";
2468 pidl "#include \"$ndr_header\"" if ($ndr_header);
2474 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2478 ($_->{TYPE} eq "INTERFACE") && ParseInterface($_, \%needed);
2479 ($_->{TYPE} eq "IMPORT") && HeaderImport(@{$_->{PATHS}});
2480 ($_->{TYPE} eq "INCLUDE") && HeaderInclude(@{$_->{PATHS}});
2483 return ($res_hdr, $res);
2486 sub NeededFunction($$)
2488 my ($fn,$needed) = @_;
2489 $needed->{"pull_$fn->{NAME}"} = 1;
2490 $needed->{"push_$fn->{NAME}"} = 1;
2491 $needed->{"print_$fn->{NAME}"} = 1;
2492 foreach my $e (@{$fn->{ELEMENTS}}) {
2494 unless(defined($needed->{"pull_$e->{TYPE}"})) {
2495 $needed->{"pull_$e->{TYPE}"} = 1;
2497 unless(defined($needed->{"push_$e->{TYPE}"})) {
2498 $needed->{"push_$e->{TYPE}"} = 1;
2500 unless(defined($needed->{"print_$e->{TYPE}"})) {
2501 $needed->{"print_$e->{TYPE}"} = 1;
2506 sub NeededTypedef($$)
2508 my ($t,$needed) = @_;
2509 if (has_property($t, "public")) {
2510 $needed->{"pull_$t->{NAME}"} = 1;
2511 $needed->{"push_$t->{NAME}"} = 1;
2512 $needed->{"print_$t->{NAME}"} = 1;
2515 if ($t->{DATA}->{TYPE} eq "STRUCT" or $t->{DATA}->{TYPE} eq "UNION") {
2516 if (has_property($t, "gensize")) {
2517 $needed->{"ndr_size_$t->{NAME}"} = 1;
2520 for my $e (@{$t->{DATA}->{ELEMENTS}}) {
2521 $e->{PARENT} = $t->{DATA};
2522 if (has_property($e, "compression")) {
2523 $needed->{"compression"} = 1;
2525 if ($needed->{"pull_$t->{NAME}"} and
2526 not defined($needed->{"pull_$e->{TYPE}"})) {
2527 $needed->{"pull_$e->{TYPE}"} = 1;
2529 if ($needed->{"push_$t->{NAME}"} and
2530 not defined($needed->{"push_$e->{TYPE}"})) {
2531 $needed->{"push_$e->{TYPE}"} = 1;
2533 if ($needed->{"print_$t->{NAME}"} and
2534 not defined($needed->{"print_$e->{TYPE}"})) {
2535 $needed->{"print_$e->{TYPE}"} = 1;
2541 #####################################################################
2542 # work out what parse functions are needed
2543 sub NeededInterface($$)
2545 my ($interface,$needed) = @_;
2546 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
2547 NeededTypedef($_, $needed) foreach (reverse @{$interface->{TYPES}});