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_OK = qw(check_null_pointer GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv NeededFunction NeededElement NeededType $res NeededInterface TypeFunctionName ParseElementPrint);
15 use Parse::Pidl::Typelist qw(hasType getType mapTypeName);
16 use Parse::Pidl::Util qw(has_property ParseExpr ParseExprExt print_uuid);
17 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred);
18 use Parse::Pidl::Samba4 qw(is_intree choose_header);
19 use Parse::Pidl qw(warning);
21 use vars qw($VERSION);
29 my $self = { res => "", res_hdr => "", deferred => [], tabs => "", defer_tabs => "" };
36 return $typefamily{$n};
41 my ($e, $var_name) = @_;
44 foreach my $l (@{$e->{LEVELS}}) {
45 if ($l->{TYPE} eq "POINTER") {
47 } elsif ($l->{TYPE} eq "ARRAY") {
48 if (($pointers == 0) and
49 (not $l->{IS_FIXED}) and
50 (not $l->{IS_INLINE})) {
51 return get_value_of($var_name);
53 } elsif ($l->{TYPE} eq "DATA") {
54 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
55 return get_value_of($var_name) unless ($pointers);
63 sub has_fast_array($$)
67 return 0 if ($l->{TYPE} ne "ARRAY");
69 my $nl = GetNextLevel($e,$l);
70 return 0 unless ($nl->{TYPE} eq "DATA");
71 return 0 unless (hasType($nl->{DATA_TYPE}));
73 my $t = getType($nl->{DATA_TYPE});
75 # Only uint8 and string have fast array functions at the moment
76 return ($t->{NAME} eq "uint8") or ($t->{NAME} eq "string");
79 sub is_charset_array($$)
83 return 0 if ($l->{TYPE} ne "ARRAY");
85 my $nl = GetNextLevel($e,$l);
87 return 0 unless ($nl->{TYPE} eq "DATA");
89 return has_property($e, "charset");
96 if ($var_name =~ /^\*(.*)$/) {
98 } elsif ($var_name =~ /^\&(.*)$/) {
99 return "&($var_name)";
107 my $var_name = shift;
109 if ($var_name =~ /^\&(.*)$/) {
116 ####################################
117 # pidl() is our basic output routine
122 $self->{res} .= $self->{tabs};
128 sub pidl_hdr($$) { my ($self, $d) = @_; $self->{res_hdr} .= "$d\n"; }
130 ####################################
131 # defer() is like pidl(), but adds to
132 # a deferred buffer which is then added to the
133 # output buffer at the end of the structure/union/function
134 # This is needed to cope with code that must be pushed back
135 # to the end of a block of elements
136 sub defer_indent($) { my ($self) = @_; $self->{defer_tabs}.="\t"; }
137 sub defer_deindent($) { my ($self) = @_; $self->{defer_tabs}=substr($self->{defer_tabs}, 0, -1); }
143 push(@{$self->{deferred}}, $self->{defer_tabs}.$d);
147 ########################################
148 # add the deferred content to the current
153 $self->pidl($_) foreach (@{$self->{deferred}});
154 $self->{deferred} = [];
155 $self->{defer_tabs} = "";
161 $self->{tabs} .= "\t";
167 $self->{tabs} = substr($self->{tabs}, 0, -1);
170 #####################################################################
171 # declare a function public or static, depending on its attributes
174 my ($self,$type,$fn,$decl) = @_;
176 if (has_property($fn, "no$type")) {
177 $self->pidl_hdr("$decl;");
181 if (has_property($fn, "public")) {
182 $self->pidl_hdr("$decl;");
183 $self->pidl("_PUBLIC_ $decl");
185 $self->pidl("static $decl");
191 ###################################################################
192 # setup any special flags for an element or structure
196 my $flags = has_property($e, "flag");
197 if (defined $flags) {
200 $self->pidl("uint32_t _flags_save_$e->{TYPE} = ndr->flags;");
201 $self->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 $self->pidl("ndr->flags = _flags_save_$e->{TYPE};");
218 sub GenerateStructEnv($$)
223 foreach my $e (@{$x->{ELEMENTS}}) {
224 $env{$e->{NAME}} = "$v->$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($;$)
248 my ($fn, $base) = @_;
251 $base = "r->" unless defined($base);
253 foreach my $e (@{$fn->{ELEMENTS}}) {
254 if (grep (/in/, @{$e->{DIRECTION}})) {
255 $env{$e->{NAME}} = $base."in.$e->{NAME}";
262 sub GenerateFunctionOutEnv($;$)
264 my ($fn, $base) = @_;
267 $base = "r->" unless defined($base);
269 foreach my $e (@{$fn->{ELEMENTS}}) {
270 if (grep (/out/, @{$e->{DIRECTION}})) {
271 $env{$e->{NAME}} = $base."out.$e->{NAME}";
272 } elsif (grep (/in/, @{$e->{DIRECTION}})) {
273 $env{$e->{NAME}} = $base."in.$e->{NAME}";
280 #####################################################################
281 # parse the data of an array - push side
282 sub ParseArrayPushHeader($$$$$$)
284 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
289 if ($l->{IS_ZERO_TERMINATED}) {
290 if (has_property($e, "charset")) {
291 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
293 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
296 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
297 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
300 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
301 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $size));");
304 if ($l->{IS_VARYING}) {
305 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, 0));"); # array offset
306 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $length));");
312 sub check_fully_dereferenced($$)
314 my ($element, $env) = @_;
320 # Figure out the number of pointers in $ptr
321 my $expandedvar = $origvar;
322 $expandedvar =~ s/^(\**)//;
326 foreach (keys %$env) {
327 if ($env->{$_} eq $expandedvar) {
333 return($origvar) unless (defined($var));
335 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
336 if ($_->{NAME} eq $var) {
342 $e or die("Environment doesn't match siblings");
344 # See if pointer at pointer level $level
345 # needs to be checked.
347 foreach (@{$e->{LEVELS}}) {
348 if ($_->{TYPE} eq "POINTER") {
349 $nump = $_->{POINTER_INDEX}+1;
352 warning($element->{ORIGINAL}, "Got pointer for `$e->{NAME}', expected fully derefenced variable") if ($nump > length($ptr));
357 sub check_null_pointer($$$$)
359 my ($element, $env, $print_fn, $return) = @_;
362 my $expandedvar = shift;
365 # Figure out the number of pointers in $ptr
366 $expandedvar =~ s/^(\**)//;
370 foreach (keys %$env) {
371 if ($env->{$_} eq $expandedvar) {
380 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
381 if ($_->{NAME} eq $var) {
387 $e or die("Environment doesn't match siblings");
389 # See if pointer at pointer level $level
390 # needs to be checked.
391 foreach my $l (@{$e->{LEVELS}}) {
392 if ($l->{TYPE} eq "POINTER" and
393 $l->{POINTER_INDEX} == length($ptr)) {
394 # No need to check ref pointers
395 $check = ($l->{POINTER_TYPE} ne "ref");
399 if ($l->{TYPE} eq "DATA") {
400 warning($element, "too much dereferences for `$var'");
404 warning($element, "unknown dereferenced expression `$expandedvar'");
408 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
412 #####################################################################
413 # parse an array - pull side
414 sub ParseArrayPullHeader($$$$$$)
416 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
421 if ($l->{IS_CONFORMANT}) {
422 $length = $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
423 } elsif ($l->{IS_ZERO_TERMINATED}) { # Noheader arrays
424 $length = $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
426 $length = $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
427 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return NT_STATUS_INVALID_PARAMETER_MIX;"), check_fully_dereferenced($e, $env));
430 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
431 $self->pidl("NDR_CHECK(ndr_pull_array_size(ndr, " . get_pointer_to($var_name) . "));");
434 if ($l->{IS_VARYING}) {
435 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
436 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
439 if ($length ne $size) {
440 $self->pidl("if ($length > $size) {");
442 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $size, $length);");
447 if ($l->{IS_CONFORMANT} and not $l->{IS_ZERO_TERMINATED}) {
448 $self->defer("if ($var_name) {");
450 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL}, check_null_pointer($e, $env, sub { $self->defer(shift); }, "return NT_STATUS_INVALID_PARAMETER_MIX;"), check_fully_dereferenced($e, $env));
451 $self->defer("NDR_CHECK(ndr_check_array_size(ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
452 $self->defer_deindent;
456 if ($l->{IS_VARYING} and not $l->{IS_ZERO_TERMINATED}) {
457 $self->defer("if ($var_name) {");
459 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
460 check_null_pointer($e, $env, sub { $self->defer(shift); }, "return NT_STATUS_INVALID_PARAMETER_MIX;"),
461 check_fully_dereferenced($e, $env));
462 $self->defer("NDR_CHECK(ndr_check_array_length(ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
463 $self->defer_deindent;
467 if (not $l->{IS_FIXED} and not is_charset_array($e, $l)) {
468 $self->AllocateArrayLevel($e,$l,$ndr,$env,$size);
474 sub compression_alg($$)
477 my ($alg, $clen, $dlen) = split(/ /, $l->{COMPRESSION});
482 sub compression_clen($$$)
484 my ($e, $l, $env) = @_;
485 my ($alg, $clen, $dlen) = split(/ /, $l->{COMPRESSION});
487 return ParseExpr($clen, $env, $e->{ORIGINAL});
490 sub compression_dlen($$$)
492 my ($e,$l,$env) = @_;
493 my ($alg, $clen, $dlen) = split(/ /, $l->{COMPRESSION});
495 return ParseExpr($dlen, $env, $e->{ORIGINAL});
498 sub ParseCompressionPushStart($$$$$)
500 my ($self,$e,$l,$ndr,$env) = @_;
501 my $comndr = "$ndr\_compressed";
502 my $alg = compression_alg($e, $l);
503 my $dlen = compression_dlen($e, $l, $env);
507 $self->pidl("struct ndr_push *$comndr;");
508 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));");
513 sub ParseCompressionPushEnd($$$$$)
515 my ($self,$e,$l,$ndr,$env) = @_;
516 my $comndr = "$ndr\_compressed";
517 my $alg = compression_alg($e, $l);
518 my $dlen = compression_dlen($e, $l, $env);
520 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));");
525 sub ParseCompressionPullStart($$$$$)
527 my ($self,$e,$l,$ndr,$env) = @_;
528 my $comndr = "$ndr\_compressed";
529 my $alg = compression_alg($e, $l);
530 my $dlen = compression_dlen($e, $l, $env);
534 $self->pidl("struct ndr_pull *$comndr;");
535 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));");
540 sub ParseCompressionPullEnd($$$$$)
542 my ($self,$e,$l,$ndr,$env) = @_;
543 my $comndr = "$ndr\_compressed";
544 my $alg = compression_alg($e, $l);
545 my $dlen = compression_dlen($e, $l, $env);
547 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
552 sub ParseSubcontextPushStart($$$$$)
554 my ($self,$e,$l,$ndr,$env) = @_;
555 my $subndr = "_ndr_$e->{NAME}";
556 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
560 $self->pidl("struct ndr_push *$subndr;");
561 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
563 if (defined $l->{COMPRESSION}) {
564 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
570 sub ParseSubcontextPushEnd($$$$$)
572 my ($self,$e,$l,$ndr,$env) = @_;
573 my $subndr = "_ndr_$e->{NAME}";
574 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
576 if (defined $l->{COMPRESSION}) {
577 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
580 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
585 sub ParseSubcontextPullStart($$$$$)
587 my ($self,$e,$l,$ndr,$env) = @_;
588 my $subndr = "_ndr_$e->{NAME}";
589 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
593 $self->pidl("struct ndr_pull *$subndr;");
594 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
596 if (defined $l->{COMPRESSION}) {
597 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
603 sub ParseSubcontextPullEnd($$$$$)
605 my ($self,$e,$l,$ndr,$env) = @_;
606 my $subndr = "_ndr_$e->{NAME}";
607 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
609 if (defined $l->{COMPRESSION}) {
610 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
613 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
618 sub ParseElementPushLevel
620 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
622 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
624 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
625 $var_name = get_pointer_to($var_name);
628 if (defined($ndr_flags)) {
629 if ($l->{TYPE} eq "SUBCONTEXT") {
630 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
631 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
632 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
633 } elsif ($l->{TYPE} eq "POINTER") {
634 $self->ParsePtrPush($e, $l, $var_name);
635 } elsif ($l->{TYPE} eq "ARRAY") {
636 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
638 my $nl = GetNextLevel($e, $l);
640 # Allow speedups for arrays of scalar types
641 if (is_charset_array($e,$l)) {
642 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
644 } elsif (has_fast_array($e,$l)) {
645 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
648 } elsif ($l->{TYPE} eq "SWITCH") {
649 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
650 } elsif ($l->{TYPE} eq "DATA") {
651 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
655 if ($l->{TYPE} eq "POINTER" and $deferred) {
656 if ($l->{POINTER_TYPE} ne "ref") {
657 $self->pidl("if ($var_name) {");
659 if ($l->{POINTER_TYPE} eq "relative") {
660 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2(ndr, $var_name));");
663 $var_name = get_value_of($var_name);
664 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
666 if ($l->{POINTER_TYPE} ne "ref") {
670 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
671 not is_charset_array($e, $l)) {
672 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
673 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
675 $var_name = $var_name . "[$counter]";
677 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
678 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
680 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
685 if ($deferred and ContainsDeferred($e, $l)) {
686 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
688 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
692 } elsif ($l->{TYPE} eq "SWITCH") {
693 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
697 #####################################################################
698 # parse scalars in a structure element
699 sub ParseElementPush($$$$$$)
701 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
704 my $var_name = $env->{$e->{NAME}};
706 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
708 # Representation type is different from transmit_as
709 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
712 my $transmit_name = "_transmit_$e->{NAME}";
713 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
714 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
715 $var_name = $transmit_name;
718 $var_name = append_prefix($e, $var_name);
720 $self->start_flags($e);
722 if (defined(my $value = has_property($e, "value"))) {
723 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
726 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
728 $self->end_flags($e);
730 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
736 #####################################################################
737 # parse a pointer in a struct element or function
738 sub ParsePtrPush($$$$)
740 my ($self,$e,$l,$var_name) = @_;
742 if ($l->{POINTER_TYPE} eq "ref") {
743 $self->pidl("if ($var_name == NULL) return NT_STATUS_INVALID_PARAMETER_MIX;");
744 if ($l->{LEVEL} eq "EMBEDDED") {
745 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
747 } elsif ($l->{POINTER_TYPE} eq "relative") {
748 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1(ndr, $var_name));");
749 } elsif ($l->{POINTER_TYPE} eq "unique") {
750 $self->pidl("NDR_CHECK(ndr_push_unique_ptr(ndr, $var_name));");
751 } elsif ($l->{POINTER_TYPE} eq "full") {
752 $self->pidl("NDR_CHECK(ndr_push_full_ptr(ndr, $var_name));");
754 die("Unhandled pointer type $l->{POINTER_TYPE}");
758 sub ParseDataPrint($$$$)
760 my ($self, $e, $l, $var_name) = @_;
762 if (not ref($l->{DATA_TYPE}) or
763 defined($l->{DATA_TYPE}->{NAME})) {
765 if (ref($l->{DATA_TYPE})) {
766 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
768 $t = $l->{DATA_TYPE};
770 if (not Parse::Pidl::Typelist::is_scalar($t) or
771 Parse::Pidl::Typelist::scalar_is_reference($t)) {
772 $var_name = get_pointer_to($var_name);
774 $self->pidl("ndr_print_$t(ndr, \"$e->{NAME}\", $var_name);");
776 $self->ParseTypePrint($l->{DATA_TYPE}, $var_name);
780 #####################################################################
781 # print scalars in a structure element
782 sub ParseElementPrint($$$$)
784 my($self, $e, $var_name, $env) = @_;
786 return if (has_property($e, "noprint"));
788 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
789 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}(ndr, \"$e->{NAME}\", $var_name);");
793 $var_name = append_prefix($e, $var_name);
795 if (defined(my $value = has_property($e, "value"))) {
796 $var_name = "(ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
799 foreach my $l (@{$e->{LEVELS}}) {
800 if ($l->{TYPE} eq "POINTER") {
801 $self->pidl("ndr_print_ptr(ndr, \"$e->{NAME}\", $var_name);");
802 $self->pidl("ndr->depth++;");
803 if ($l->{POINTER_TYPE} ne "ref") {
804 $self->pidl("if ($var_name) {");
807 $var_name = get_value_of($var_name);
808 } elsif ($l->{TYPE} eq "ARRAY") {
811 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
812 $var_name = get_pointer_to($var_name);
815 if ($l->{IS_ZERO_TERMINATED}) {
816 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
818 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
819 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
822 if (is_charset_array($e,$l)) {
823 $self->pidl("ndr_print_string(ndr, \"$e->{NAME}\", $var_name);");
825 } elsif (has_fast_array($e, $l)) {
826 my $nl = GetNextLevel($e, $l);
827 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}(ndr, \"$e->{NAME}\", $var_name, $length);");
830 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
832 $self->pidl("ndr->print(ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", $length);");
833 $self->pidl("ndr->depth++;");
834 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
836 $self->pidl("char *idx_$l->{LEVEL_INDEX}=NULL;");
837 $self->pidl("asprintf(&idx_$l->{LEVEL_INDEX}, \"[\%d]\", $counter);");
838 $self->pidl("if (idx_$l->{LEVEL_INDEX}) {");
841 $var_name = $var_name . "[$counter]";
843 } elsif ($l->{TYPE} eq "DATA") {
844 $self->ParseDataPrint($e, $l, $var_name);
845 } elsif ($l->{TYPE} eq "SWITCH") {
846 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
847 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
848 $self->pidl("ndr_print_set_switch_value(ndr, " . get_pointer_to($var_name) . ", $switch_var);");
852 foreach my $l (reverse @{$e->{LEVELS}}) {
853 if ($l->{TYPE} eq "POINTER") {
854 if ($l->{POINTER_TYPE} ne "ref") {
858 $self->pidl("ndr->depth--;");
859 } elsif (($l->{TYPE} eq "ARRAY")
860 and not is_charset_array($e,$l)
861 and not has_fast_array($e,$l)) {
862 $self->pidl("free(idx_$l->{LEVEL_INDEX});");
867 $self->pidl("ndr->depth--;");
872 #####################################################################
873 # parse scalars in a structure element - pull size
874 sub ParseSwitchPull($$$$$$)
876 my($self,$e,$l,$ndr,$var_name,$env) = @_;
877 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
878 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return NT_STATUS_INVALID_PARAMETER_MIX;"), check_fully_dereferenced($e, $env));
880 $var_name = get_pointer_to($var_name);
881 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
884 #####################################################################
885 # push switch element
886 sub ParseSwitchPush($$$$$$)
888 my($self,$e,$l,$ndr,$var_name,$env) = @_;
889 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
890 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return NT_STATUS_INVALID_PARAMETER_MIX;"), check_fully_dereferenced($e, $env));
892 $var_name = get_pointer_to($var_name);
893 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
896 sub ParseDataPull($$$$$$$)
898 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
900 if (not ref($l->{DATA_TYPE}) or
901 defined($l->{DATA_TYPE}->{NAME})) {
903 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
905 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
906 $var_name = get_pointer_to($var_name);
909 $var_name = get_pointer_to($var_name);
911 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
913 if (my $range = has_property($e, "range")) {
914 $var_name = get_value_of($var_name);
915 my ($low, $high) = split(/ /, $range, 2);
916 $self->pidl("if ($var_name < $low || $var_name > $high) {");
917 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
921 $self->ParseTypePull($l->{DATA_TYPE}, $var_name, $primitives, $deferred);
925 sub ParseDataPush($$$$$$$)
927 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
929 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
931 if (ref($l->{DATA_TYPE}) eq "HASH") {
932 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
934 $t = $l->{DATA_TYPE};
937 # strings are passed by value rather than reference
938 if (not Parse::Pidl::Typelist::is_scalar($t) or
939 Parse::Pidl::Typelist::scalar_is_reference($t)) {
940 $var_name = get_pointer_to($var_name);
943 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
944 $self->pidl("NDR_CHECK(ndr_push_$t($ndr, $ndr_flags, $var_name));");
946 $self->ParseTypePush($l->{DATA_TYPE}, $var_name, $primitives, $deferred);
950 sub CalcNdrFlags($$$)
952 my ($l,$primitives,$deferred) = @_;
957 # Add NDR_SCALARS if this one is deferred
958 # and deferreds may be pushed
959 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
961 # Add NDR_SCALARS if this one is not deferred and
962 # primitives may be pushed
963 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
965 # Add NDR_BUFFERS if this one contains deferred stuff
966 # and deferreds may be pushed
967 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
969 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
970 return "NDR_SCALARS" if ($scalars);
971 return "NDR_BUFFERS" if ($buffers);
975 sub ParseMemCtxPullStart($$$$)
977 my ($self, $e, $l, $ptr_name) = @_;
979 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
980 my $mem_c_ctx = $ptr_name;
981 my $mem_c_flags = "0";
983 return if ($l->{TYPE} eq "ARRAY" and $l->{IS_FIXED});
985 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
986 my $nl = GetNextLevel($e, $l);
987 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
988 my $next_is_string = (($nl->{TYPE} eq "DATA") and
989 ($nl->{DATA_TYPE} eq "string"));
990 if ($next_is_array or $next_is_string) {
993 $mem_c_flags = "LIBNDR_FLAG_REF_ALLOC";
997 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX(ndr);");
998 $self->pidl("NDR_PULL_SET_MEM_CTX(ndr, $mem_c_ctx, $mem_c_flags);");
1001 sub ParseMemCtxPullEnd($$$)
1003 my ($self, $e, $l) = @_;
1005 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1006 my $mem_r_flags = "0";
1008 return if ($l->{TYPE} eq "ARRAY" and $l->{IS_FIXED});
1010 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
1011 my $nl = GetNextLevel($e, $l);
1012 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1013 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1014 ($nl->{DATA_TYPE} eq "string"));
1015 if ($next_is_array or $next_is_string) {
1018 $mem_r_flags = "LIBNDR_FLAG_REF_ALLOC";
1022 $self->pidl("NDR_PULL_SET_MEM_CTX(ndr, $mem_r_ctx, $mem_r_flags);");
1025 sub CheckStringTerminator($$$$$)
1027 my ($self,$ndr,$e,$l,$length) = @_;
1028 my $nl = GetNextLevel($e, $l);
1030 # Make sure last element is zero!
1031 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
1034 sub ParseElementPullLevel
1036 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1038 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1040 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1041 $var_name = get_pointer_to($var_name);
1044 # Only pull something if there's actually something to be pulled
1045 if (defined($ndr_flags)) {
1046 if ($l->{TYPE} eq "SUBCONTEXT") {
1047 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1048 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1049 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1050 } elsif ($l->{TYPE} eq "ARRAY") {
1051 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1053 my $nl = GetNextLevel($e, $l);
1055 if (is_charset_array($e,$l)) {
1056 if ($l->{IS_ZERO_TERMINATED}) {
1057 $self->CheckStringTerminator($ndr, $e, $l, $length);
1059 $self->pidl("NDR_CHECK(ndr_pull_charset($ndr, $ndr_flags, ".get_pointer_to($var_name).", $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
1061 } elsif (has_fast_array($e, $l)) {
1062 if ($l->{IS_ZERO_TERMINATED}) {
1063 $self->CheckStringTerminator($ndr,$e,$l,$length);
1065 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1068 } elsif ($l->{TYPE} eq "POINTER") {
1069 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1070 } elsif ($l->{TYPE} eq "SWITCH") {
1071 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1072 } elsif ($l->{TYPE} eq "DATA") {
1073 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1077 # add additional constructions
1078 if ($l->{TYPE} eq "POINTER" and $deferred) {
1079 if ($l->{POINTER_TYPE} ne "ref") {
1080 $self->pidl("if ($var_name) {");
1083 if ($l->{POINTER_TYPE} eq "relative") {
1084 $self->pidl("struct ndr_pull_save _relative_save;");
1085 $self->pidl("ndr_pull_save(ndr, &_relative_save);");
1086 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2(ndr, $var_name));");
1090 $self->ParseMemCtxPullStart($e, $l, $var_name);
1092 $var_name = get_value_of($var_name);
1093 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1095 $self->ParseMemCtxPullEnd($e,$l);
1097 if ($l->{POINTER_TYPE} ne "ref") {
1098 if ($l->{POINTER_TYPE} eq "relative") {
1099 $self->pidl("ndr_pull_restore(ndr, &_relative_save);");
1104 } elsif ($l->{TYPE} eq "ARRAY" and
1105 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1106 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1107 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1108 my $array_name = $var_name;
1110 $var_name = $var_name . "[$counter]";
1112 $self->ParseMemCtxPullStart($e, $l, $array_name);
1114 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1115 my $nl = GetNextLevel($e,$l);
1117 if ($l->{IS_ZERO_TERMINATED}) {
1118 $self->CheckStringTerminator($ndr,$e,$l,$length);
1121 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1123 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1128 if ($deferred and ContainsDeferred($e, $l)) {
1129 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1131 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1136 $self->ParseMemCtxPullEnd($e, $l);
1138 } elsif ($l->{TYPE} eq "SWITCH") {
1139 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1143 #####################################################################
1144 # parse scalars in a structure element - pull size
1145 sub ParseElementPull($$$$$$)
1147 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1149 my $var_name = $env->{$e->{NAME}};
1153 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1155 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1158 $represent_name = $var_name;
1159 $transmit_name = "_transmit_$e->{NAME}";
1160 $var_name = $transmit_name;
1161 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1164 $var_name = append_prefix($e, $var_name);
1166 $self->start_flags($e);
1168 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1170 $self->end_flags($e);
1172 # Representation type is different from transmit_as
1173 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1174 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1180 #####################################################################
1181 # parse a pointer in a struct element or function
1182 sub ParsePtrPull($$$$$)
1184 my($self, $e,$l,$ndr,$var_name) = @_;
1186 my $nl = GetNextLevel($e, $l);
1187 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1188 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1189 ($nl->{DATA_TYPE} eq "string"));
1191 if ($l->{POINTER_TYPE} eq "ref") {
1192 if ($l->{LEVEL} eq "EMBEDDED") {
1193 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1196 if (!$next_is_array and !$next_is_string) {
1197 $self->pidl("if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1198 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1203 } elsif (($l->{POINTER_TYPE} eq "unique") or
1204 ($l->{POINTER_TYPE} eq "relative") or
1205 ($l->{POINTER_TYPE} eq "full")) {
1206 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1207 $self->pidl("if (_ptr_$e->{NAME}) {");
1210 die("Unhandled pointer type $l->{POINTER_TYPE}");
1213 # Don't do this for arrays, they're allocated at the actual level
1215 unless ($next_is_array or $next_is_string) {
1216 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1218 # FIXME: Yes, this is nasty.
1219 # We allocate an array twice
1220 # - once just to indicate that it's there,
1221 # - then the real allocation...
1222 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1225 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1226 if ($l->{POINTER_TYPE} eq "relative") {
1227 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1230 $self->pidl("} else {");
1231 $self->pidl("\t$var_name = NULL;");
1235 sub ParseStructPushPrimitives($$$$)
1237 my ($self, $struct, $varname, $env) = @_;
1239 # see if the structure contains a conformant array. If it
1240 # does, then it must be the last element of the structure, and
1241 # we need to push the conformant length early, as it fits on
1242 # the wire before the structure (and even before the structure
1244 if (defined($struct->{SURROUNDING_ELEMENT})) {
1245 my $e = $struct->{SURROUNDING_ELEMENT};
1247 if (defined($e->{LEVELS}[0]) and
1248 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1251 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1252 if (has_property($e, "charset")) {
1253 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1255 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1258 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1261 $self->pidl("NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, $size));");
1263 $self->pidl("NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, ndr_string_array_size(ndr, $varname->$e->{NAME})));");
1267 $self->pidl("NDR_CHECK(ndr_push_align(ndr, $struct->{ALIGN}));");
1269 if (defined($struct->{PROPERTIES}{relative_base})) {
1270 # set the current offset as base for relative pointers
1271 # and store it based on the toplevel struct/union
1272 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1(ndr, $varname, ndr->offset));");
1275 $self->ParseElementPush($_, "ndr", $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1278 sub ParseStructPushDeferred($$$)
1280 my ($self, $struct, $varname, $env) = @_;
1281 if (defined($struct->{PROPERTIES}{relative_base})) {
1282 # retrieve the current offset as base for relative pointers
1283 # based on the toplevel struct/union
1284 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2(ndr, $varname));");
1286 $self->ParseElementPush($_, "ndr", $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1289 #####################################################################
1291 sub ParseStructPush($$$)
1293 my ($self, $struct, $varname) = @_;
1295 return unless defined($struct->{ELEMENTS});
1297 my $env = GenerateStructEnv($struct, $varname);
1299 EnvSubstituteValue($env, $struct);
1301 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1303 $self->start_flags($struct);
1305 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1307 $self->ParseStructPushPrimitives($struct, $varname, $env);
1311 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1313 $self->ParseStructPushDeferred($struct, $varname, $env);
1317 $self->end_flags($struct);
1320 #####################################################################
1321 # generate a push function for an enum
1322 sub ParseEnumPush($$$)
1324 my($self,$enum,$varname) = @_;
1325 my($type_fn) = $enum->{BASE_TYPE};
1327 $self->start_flags($enum);
1328 $self->pidl("NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, $varname));");
1329 $self->end_flags($enum);
1332 #####################################################################
1333 # generate a pull function for an enum
1334 sub ParseEnumPull($$$)
1336 my($self,$enum,$varname) = @_;
1337 my($type_fn) = $enum->{BASE_TYPE};
1338 my($type_v_decl) = mapTypeName($type_fn);
1340 $self->pidl("$type_v_decl v;");
1341 $self->start_flags($enum);
1342 $self->pidl("NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));");
1343 $self->pidl("*$varname = v;");
1345 $self->end_flags($enum);
1348 #####################################################################
1349 # generate a print function for an enum
1350 sub ParseEnumPrint($$$$)
1352 my($self,$enum,$name,$varname) = @_;
1354 $self->pidl("const char *val = NULL;");
1357 $self->start_flags($enum);
1359 $self->pidl("switch ($varname) {");
1361 my $els = \@{$enum->{ELEMENTS}};
1362 foreach my $i (0 .. $#{$els}) {
1363 my $e = ${$els}[$i];
1365 if ($e =~ /^(.*)=/) {
1368 $self->pidl("case $e: val = \"$e\"; break;");
1374 $self->pidl("ndr_print_enum(ndr, name, \"$enum->{TYPE}\", val, $varname);");
1376 $self->end_flags($enum);
1381 my ($e,$t,$name,$varname) = @_;
1382 return "enum $name " .
1383 ($t eq "pull"?"*":"") . $varname;
1386 $typefamily{ENUM} = {
1388 PUSH_FN_BODY => \&ParseEnumPush,
1389 PULL_FN_BODY => \&ParseEnumPull,
1390 PRINT_FN_BODY => \&ParseEnumPrint,
1393 #####################################################################
1394 # generate a push function for a bitmap
1395 sub ParseBitmapPush($$$)
1397 my($self,$bitmap,$varname) = @_;
1398 my($type_fn) = $bitmap->{BASE_TYPE};
1400 $self->start_flags($bitmap);
1402 $self->pidl("NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, $varname));");
1404 $self->end_flags($bitmap);
1407 #####################################################################
1408 # generate a pull function for an bitmap
1409 sub ParseBitmapPull($$$)
1411 my($self,$bitmap,$varname) = @_;
1412 my $type_fn = $bitmap->{BASE_TYPE};
1413 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1415 $self->pidl("$type_decl v;");
1416 $self->start_flags($bitmap);
1417 $self->pidl("NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));");
1418 $self->pidl("*$varname = v;");
1420 $self->end_flags($bitmap);
1423 #####################################################################
1424 # generate a print function for an bitmap
1425 sub ParseBitmapPrintElement($$$$$)
1427 my($self,$e,$bitmap,$name,$varname) = @_;
1428 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1429 my($type_fn) = $bitmap->{BASE_TYPE};
1432 if ($e =~ /^(\w+) .*$/) {
1435 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1438 $self->pidl("ndr_print_bitmap_flag(ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1441 #####################################################################
1442 # generate a print function for an bitmap
1443 sub ParseBitmapPrint($$$$)
1445 my($self,$bitmap,$name,$varname) = @_;
1446 my($type_decl) = mapTypeName($bitmap->{TYPE});
1447 my($type_fn) = $bitmap->{BASE_TYPE};
1449 $self->start_flags($bitmap);
1451 $self->pidl("ndr_print_$type_fn(ndr, name, $varname);");
1453 $self->pidl("ndr->depth++;");
1454 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1455 $self->ParseBitmapPrintElement($e, $bitmap, $name, $varname);
1457 $self->pidl("ndr->depth--;");
1459 $self->end_flags($bitmap);
1462 sub DeclBitmap($$$$)
1464 my ($e,$t,$name,$varname) = @_;
1465 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1466 ($t eq "pull"?" *":" ") . $varname;
1469 $typefamily{BITMAP} = {
1470 DECL => \&DeclBitmap,
1471 PUSH_FN_BODY => \&ParseBitmapPush,
1472 PULL_FN_BODY => \&ParseBitmapPull,
1473 PRINT_FN_BODY => \&ParseBitmapPrint,
1476 #####################################################################
1477 # generate a struct print function
1478 sub ParseStructPrint($$$$)
1480 my($self,$struct,$name,$varname) = @_;
1482 return unless defined $struct->{ELEMENTS};
1484 my $env = GenerateStructEnv($struct, $varname);
1486 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1488 $self->pidl("ndr_print_struct(ndr, name, \"$name\");");
1490 $self->start_flags($struct);
1492 $self->pidl("ndr->depth++;");
1494 $self->ParseElementPrint($_, $env->{$_->{NAME}}, $env)
1495 foreach (@{$struct->{ELEMENTS}});
1496 $self->pidl("ndr->depth--;");
1498 $self->end_flags($struct);
1501 sub DeclarePtrVariables($$)
1504 foreach my $l (@{$e->{LEVELS}}) {
1505 if ($l->{TYPE} eq "POINTER" and
1506 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1507 $self->pidl("uint32_t _ptr_$e->{NAME};");
1513 sub DeclareArrayVariables($$)
1517 foreach my $l (@{$e->{LEVELS}}) {
1518 next if has_fast_array($e,$l);
1519 next if is_charset_array($e,$l);
1520 if ($l->{TYPE} eq "ARRAY") {
1521 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1526 sub need_decl_mem_ctx($$)
1530 return 0 if has_fast_array($e,$l);
1531 return 0 if is_charset_array($e,$l);
1532 return 1 if (($l->{TYPE} eq "ARRAY") and not $l->{IS_FIXED});
1534 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
1535 my $nl = GetNextLevel($e, $l);
1536 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1537 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1538 ($nl->{DATA_TYPE} eq "string"));
1539 return 0 if ($next_is_array or $next_is_string);
1541 return 1 if ($l->{TYPE} eq "POINTER");
1546 sub DeclareMemCtxVariables($$)
1549 foreach my $l (@{$e->{LEVELS}}) {
1550 if (need_decl_mem_ctx($e, $l)) {
1551 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1556 sub ParseStructPullPrimitives($$$$)
1558 my($self,$struct,$varname,$env) = @_;
1560 if (defined $struct->{SURROUNDING_ELEMENT}) {
1561 $self->pidl("NDR_CHECK(ndr_pull_array_size(ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1564 $self->pidl("NDR_CHECK(ndr_pull_align(ndr, $struct->{ALIGN}));");
1566 if (defined($struct->{PROPERTIES}{relative_base})) {
1567 # set the current offset as base for relative pointers
1568 # and store it based on the toplevel struct/union
1569 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1(ndr, $varname, ndr->offset));");
1572 $self->ParseElementPull($_, "ndr", $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1574 $self->add_deferred();
1577 sub ParseStructPullDeferred($$$$)
1579 my ($self,$struct,$varname,$env) = @_;
1581 if (defined($struct->{PROPERTIES}{relative_base})) {
1582 # retrieve the current offset as base for relative pointers
1583 # based on the toplevel struct/union
1584 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2(ndr, $varname));");
1586 foreach my $e (@{$struct->{ELEMENTS}}) {
1587 $self->ParseElementPull($e, "ndr", $env, 0, 1);
1590 $self->add_deferred();
1593 #####################################################################
1594 # parse a struct - pull side
1595 sub ParseStructPull($$$)
1597 my($self,$struct,$varname) = @_;
1599 return unless defined $struct->{ELEMENTS};
1601 # declare any internal pointers we need
1602 foreach my $e (@{$struct->{ELEMENTS}}) {
1603 $self->DeclarePtrVariables($e);
1604 $self->DeclareArrayVariables($e);
1605 $self->DeclareMemCtxVariables($e);
1608 $self->start_flags($struct);
1610 my $env = GenerateStructEnv($struct, $varname);
1612 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1614 $self->ParseStructPullPrimitives($struct,$varname,$env);
1617 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1619 $self->ParseStructPullDeferred($struct,$varname,$env);
1623 $self->end_flags($struct);
1626 #####################################################################
1627 # calculate size of ndr struct
1628 sub ParseStructNdrSize($$$$)
1630 my ($self,$t, $name, $varname) = @_;
1633 if (my $flags = has_property($t, "flag")) {
1634 $self->pidl("flags |= $flags;");
1636 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1639 sub DeclStruct($$$$)
1641 my ($e,$t,$name,$varname) = @_;
1642 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1645 sub ArgsStructNdrSize($$$)
1647 my ($d, $name, $varname) = @_;
1648 return "const struct $name *$varname, int flags";
1651 $typefamily{STRUCT} = {
1652 PUSH_FN_BODY => \&ParseStructPush,
1653 DECL => \&DeclStruct,
1654 PULL_FN_BODY => \&ParseStructPull,
1655 PRINT_FN_BODY => \&ParseStructPrint,
1656 SIZE_FN_BODY => \&ParseStructNdrSize,
1657 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1660 #####################################################################
1661 # calculate size of ndr struct
1662 sub ParseUnionNdrSize($$$)
1664 my ($self, $t, $name, $varname) = @_;
1667 if (my $flags = has_property($t, "flag")) {
1668 $self->pidl("flags |= $flags;");
1671 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1674 sub ParseUnionPushPrimitives($$$)
1676 my ($self, $e, $varname) = @_;
1678 my $have_default = 0;
1680 $self->pidl("int level = ndr_push_get_switch_value(ndr, $varname);");
1682 if (defined($e->{SWITCH_TYPE})) {
1683 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}(ndr, NDR_SCALARS, level));");
1686 $self->pidl("switch (level) {");
1688 foreach my $el (@{$e->{ELEMENTS}}) {
1689 if ($el->{CASE} eq "default") {
1692 $self->pidl("$el->{CASE}:");
1694 if ($el->{TYPE} ne "EMPTY") {
1696 if (defined($e->{PROPERTIES}{relative_base})) {
1697 $self->pidl("NDR_CHECK(ndr_push_align(ndr, $el->{ALIGN}));");
1698 # set the current offset as base for relative pointers
1699 # and store it based on the toplevel struct/union
1700 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1(ndr, $varname, ndr->offset));");
1702 $self->DeclareArrayVariables($el);
1703 $self->ParseElementPush($el, "ndr", {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1706 $self->pidl("break;");
1709 if (! $have_default) {
1710 $self->pidl("default:");
1711 $self->pidl("\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1717 sub ParseUnionPushDeferred($$$)
1719 my ($self,$e,$varname) = @_;
1721 my $have_default = 0;
1723 $self->pidl("int level = ndr_push_get_switch_value(ndr, $varname);");
1724 if (defined($e->{PROPERTIES}{relative_base})) {
1725 # retrieve the current offset as base for relative pointers
1726 # based on the toplevel struct/union
1727 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2(ndr, $varname));");
1729 $self->pidl("switch (level) {");
1731 foreach my $el (@{$e->{ELEMENTS}}) {
1732 if ($el->{CASE} eq "default") {
1736 $self->pidl("$el->{CASE}:");
1737 if ($el->{TYPE} ne "EMPTY") {
1739 $self->ParseElementPush($el, "ndr", {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1742 $self->pidl("break;");
1745 if (! $have_default) {
1746 $self->pidl("default:");
1747 $self->pidl("\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1753 #####################################################################
1754 # parse a union - push side
1755 sub ParseUnionPush($$$)
1757 my ($self,$e,$varname) = @_;
1758 my $have_default = 0;
1760 $self->start_flags($e);
1762 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1764 $self->ParseUnionPushPrimitives($e, $varname);
1767 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1769 $self->ParseUnionPushDeferred($e, $varname);
1772 $self->end_flags($e);
1775 #####################################################################
1777 sub ParseUnionPrint($$$$)
1779 my ($self,$e,$name,$varname) = @_;
1780 my $have_default = 0;
1782 $self->pidl("int level;");
1783 foreach my $el (@{$e->{ELEMENTS}}) {
1784 $self->DeclareArrayVariables($el);
1787 $self->start_flags($e);
1789 $self->pidl("level = ndr_print_get_switch_value(ndr, $varname);");
1791 $self->pidl("ndr_print_union(ndr, name, level, \"$name\");");
1793 $self->pidl("switch (level) {");
1795 foreach my $el (@{$e->{ELEMENTS}}) {
1796 if ($el->{CASE} eq "default") {
1799 $self->pidl("$el->{CASE}:");
1800 if ($el->{TYPE} ne "EMPTY") {
1802 $self->ParseElementPrint($el, "$varname->$el->{NAME}", {});
1805 $self->pidl("break;");
1808 if (! $have_default) {
1809 $self->pidl("default:");
1810 $self->pidl("\tndr_print_bad_level(ndr, name, level);");
1815 $self->end_flags($e);
1818 sub ParseUnionPullPrimitives($$$$)
1820 my ($self,$e,$varname,$switch_type) = @_;
1821 my $have_default = 0;
1823 if (defined($switch_type)) {
1824 $self->pidl("NDR_CHECK(ndr_pull_$switch_type(ndr, NDR_SCALARS, &_level));");
1825 $self->pidl("if (_level != level) {");
1826 $self->pidl("\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname\", _level);");
1830 $self->pidl("switch (level) {");
1832 foreach my $el (@{$e->{ELEMENTS}}) {
1833 if ($el->{CASE} eq "default") {
1836 $self->pidl("$el->{CASE}: {");
1838 if ($el->{TYPE} ne "EMPTY") {
1840 $self->DeclarePtrVariables($el);
1841 $self->DeclareArrayVariables($el);
1842 if (defined($e->{PROPERTIES}{relative_base})) {
1843 $self->pidl("NDR_CHECK(ndr_pull_align(ndr, $el->{ALIGN}));");
1844 # set the current offset as base for relative pointers
1845 # and store it based on the toplevel struct/union
1846 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1(ndr, $varname, ndr->offset));");
1848 $self->ParseElementPull($el, "ndr", {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1851 $self->pidl("break; }");
1854 if (! $have_default) {
1855 $self->pidl("default:");
1856 $self->pidl("\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1862 sub ParseUnionPullDeferred($$$)
1864 my ($self,$e,$varname) = @_;
1865 my $have_default = 0;
1867 if (defined($e->{PROPERTIES}{relative_base})) {
1868 # retrieve the current offset as base for relative pointers
1869 # based on the toplevel struct/union
1870 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2(ndr, $varname));");
1872 $self->pidl("switch (level) {");
1874 foreach my $el (@{$e->{ELEMENTS}}) {
1875 if ($el->{CASE} eq "default") {
1879 $self->pidl("$el->{CASE}:");
1880 if ($el->{TYPE} ne "EMPTY") {
1882 $self->ParseElementPull($el, "ndr", {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1885 $self->pidl("break;");
1888 if (! $have_default) {
1889 $self->pidl("default:");
1890 $self->pidl("\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1898 #####################################################################
1899 # parse a union - pull side
1900 sub ParseUnionPull($$$)
1902 my ($self,$e,$varname) = @_;
1903 my $switch_type = $e->{SWITCH_TYPE};
1905 $self->pidl("int level;");
1906 if (defined($switch_type)) {
1907 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1908 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1910 $self->pidl(mapTypeName($switch_type) . " _level;");
1913 my %double_cases = ();
1914 foreach my $el (@{$e->{ELEMENTS}}) {
1915 next if ($el->{TYPE} eq "EMPTY");
1916 next if ($double_cases{"$el->{NAME}"});
1917 $self->DeclareMemCtxVariables($el);
1918 $double_cases{"$el->{NAME}"} = 1;
1921 $self->start_flags($e);
1923 $self->pidl("level = ndr_pull_get_switch_value(ndr, $varname);");
1925 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1927 $self->ParseUnionPullPrimitives($e,$varname,$switch_type);
1931 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1933 $self->ParseUnionPullDeferred($e,$varname);
1937 $self->add_deferred();
1939 $self->end_flags($e);
1944 my ($e,$t,$name,$varname) = @_;
1945 return ($t ne "pull"?"const ":"") . "union $name *$varname";
1948 sub ArgsUnionNdrSize($$)
1951 return "const union $name *r, uint32_t level, int flags";
1954 $typefamily{UNION} = {
1955 PUSH_FN_BODY => \&ParseUnionPush,
1956 DECL => \&DeclUnion,
1957 PULL_FN_BODY => \&ParseUnionPull,
1958 PRINT_FN_BODY => \&ParseUnionPrint,
1959 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
1960 SIZE_FN_BODY => \&ParseUnionNdrSize,
1963 #####################################################################
1964 # parse a typedef - push side
1965 sub ParseTypedefPush($$$)
1967 my($self,$e,$varname) = @_;
1969 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $varname);
1972 #####################################################################
1973 # parse a typedef - pull side
1974 sub ParseTypedefPull($$$)
1976 my($self,$e,$varname) = @_;
1978 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $varname);
1981 #####################################################################
1982 # parse a typedef - print side
1983 sub ParseTypedefPrint($$$$)
1985 my($self,$e,$name,$varname) = @_;
1987 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $name, $varname);
1990 #####################################################################
1991 ## calculate the size of a structure
1992 sub ParseTypedefNdrSize($$$$)
1994 my($self,$t,$name,$varname) = @_;
1996 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
1999 sub DeclTypedef($$$$)
2001 my ($e, $t, $name, $varname) = @_;
2003 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2006 sub ArgsTypedefNdrSize($$$)
2008 my ($d, $name, $varname) = @_;
2009 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2012 $typefamily{TYPEDEF} = {
2013 PUSH_FN_BODY => \&ParseTypedefPush,
2014 DECL => \&DeclTypedef,
2015 PULL_FN_BODY => \&ParseTypedefPull,
2016 PRINT_FN_BODY => \&ParseTypedefPrint,
2017 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2018 SIZE_FN_BODY => \&ParseTypedefNdrSize,
2021 #####################################################################
2022 # parse a function - print side
2023 sub ParseFunctionPrint($$)
2025 my($self, $fn) = @_;
2027 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2029 return if has_property($fn, "noprint");
2031 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2035 foreach my $e (@{$fn->{ELEMENTS}}) {
2036 $self->DeclareArrayVariables($e);
2039 $self->pidl("ndr_print_struct(ndr, name, \"$fn->{NAME}\");");
2040 $self->pidl("ndr->depth++;");
2042 $self->pidl("if (flags & NDR_SET_VALUES) {");
2043 $self->pidl("\tndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2046 $self->pidl("if (flags & NDR_IN) {");
2048 $self->pidl("ndr_print_struct(ndr, \"in\", \"$fn->{NAME}\");");
2049 $self->pidl("ndr->depth++;");
2051 my $env = GenerateFunctionInEnv($fn);
2053 foreach my $e (@{$fn->{ELEMENTS}}) {
2054 if (grep(/in/,@{$e->{DIRECTION}})) {
2055 $self->ParseElementPrint($e, $env->{$e->{NAME}}, $env);
2058 $self->pidl("ndr->depth--;");
2062 $self->pidl("if (flags & NDR_OUT) {");
2064 $self->pidl("ndr_print_struct(ndr, \"out\", \"$fn->{NAME}\");");
2065 $self->pidl("ndr->depth++;");
2067 $env = GenerateFunctionOutEnv($fn);
2068 foreach my $e (@{$fn->{ELEMENTS}}) {
2069 if (grep(/out/,@{$e->{DIRECTION}})) {
2070 $self->ParseElementPrint($e, $env->{$e->{NAME}}, $env);
2073 if ($fn->{RETURN_TYPE}) {
2074 $self->pidl("ndr_print_$fn->{RETURN_TYPE}(ndr, \"result\", r->out.result);");
2076 $self->pidl("ndr->depth--;");
2080 $self->pidl("ndr->depth--;");
2086 #####################################################################
2088 sub ParseFunctionPush($$)
2090 my($self, $fn) = @_;
2092 $self->fn_declare("push", $fn, "NTSTATUS ndr_push_$fn->{NAME}(struct ndr_push *ndr, int flags, const struct $fn->{NAME} *r)") or return;
2094 return if has_property($fn, "nopush");
2099 foreach my $e (@{$fn->{ELEMENTS}}) {
2100 $self->DeclareArrayVariables($e);
2103 $self->pidl("if (flags & NDR_IN) {");
2106 my $env = GenerateFunctionInEnv($fn);
2108 EnvSubstituteValue($env, $fn);
2110 foreach my $e (@{$fn->{ELEMENTS}}) {
2111 if (grep(/in/,@{$e->{DIRECTION}})) {
2112 $self->ParseElementPush($e, "ndr", $env, 1, 1);
2119 $self->pidl("if (flags & NDR_OUT) {");
2122 $env = GenerateFunctionOutEnv($fn);
2123 foreach my $e (@{$fn->{ELEMENTS}}) {
2124 if (grep(/out/,@{$e->{DIRECTION}})) {
2125 $self->ParseElementPush($e, "ndr", $env, 1, 1);
2129 if ($fn->{RETURN_TYPE}) {
2130 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, r->out.result));");
2135 $self->pidl("return NT_STATUS_OK;");
2141 sub AllocateArrayLevel($$$$$$)
2143 my ($self,$e,$l,$ndr,$env,$size) = @_;
2145 my $var = ParseExpr($e->{NAME}, $env, $e->{ORIGINAL});
2147 my $pl = GetPrevLevel($e, $l);
2148 if (defined($pl) and
2149 $pl->{TYPE} eq "POINTER" and
2150 $pl->{POINTER_TYPE} eq "ref"
2151 and not $l->{IS_ZERO_TERMINATED}) {
2152 $self->pidl("if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2153 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2155 if (grep(/in/,@{$e->{DIRECTION}}) and
2156 grep(/out/,@{$e->{DIRECTION}})) {
2157 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, $size * sizeof(*r->in.$e->{NAME}));");
2162 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2165 #####################################################################
2167 sub ParseFunctionPull($$)
2171 # pull function args
2172 $self->fn_declare("pull", $fn, "NTSTATUS ndr_pull_$fn->{NAME}(struct ndr_pull *ndr, int flags, struct $fn->{NAME} *r)") or return;
2177 # declare any internal pointers we need
2178 foreach my $e (@{$fn->{ELEMENTS}}) {
2179 $self->DeclarePtrVariables($e);
2180 $self->DeclareArrayVariables($e);
2183 my %double_cases = ();
2184 foreach my $e (@{$fn->{ELEMENTS}}) {
2185 next if ($e->{TYPE} eq "EMPTY");
2186 next if ($double_cases{"$e->{NAME}"});
2187 $self->DeclareMemCtxVariables($e);
2188 $double_cases{"$e->{NAME}"} = 1;
2191 $self->pidl("if (flags & NDR_IN) {");
2194 # auto-init the out section of a structure. I originally argued that
2195 # this was a bad idea as it hides bugs, but coping correctly
2196 # with initialisation and not wiping ref vars is turning
2197 # out to be too tricky (tridge)
2198 foreach my $e (@{$fn->{ELEMENTS}}) {
2199 next unless grep(/out/, @{$e->{DIRECTION}});
2200 $self->pidl("ZERO_STRUCT(r->out);");
2205 my $env = GenerateFunctionInEnv($fn);
2207 foreach my $e (@{$fn->{ELEMENTS}}) {
2208 next unless (grep(/in/, @{$e->{DIRECTION}}));
2209 $self->ParseElementPull($e, "ndr", $env, 1, 1);
2212 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2213 # own flag rather than be in NDR_IN ?
2215 foreach my $e (@{$fn->{ELEMENTS}}) {
2216 next unless (grep(/out/, @{$e->{DIRECTION}}));
2217 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2218 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2219 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2220 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2221 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2222 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2224 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2225 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL}, check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return NT_STATUS_INVALID_PARAMETER_MIX;"),
2226 check_fully_dereferenced($e, $env));
2228 $self->pidl("NDR_PULL_ALLOC_N(ndr, r->out.$e->{NAME}, $size);");
2230 if (grep(/in/, @{$e->{DIRECTION}})) {
2231 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, $size * sizeof(*r->in.$e->{NAME}));");
2233 $self->pidl("memset(r->out.$e->{NAME}, 0, $size * sizeof(*r->out.$e->{NAME}));");
2236 $self->pidl("NDR_PULL_ALLOC(ndr, r->out.$e->{NAME});");
2238 if (grep(/in/, @{$e->{DIRECTION}})) {
2239 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2241 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2246 $self->add_deferred();
2250 $self->pidl("if (flags & NDR_OUT) {");
2253 $env = GenerateFunctionOutEnv($fn);
2254 foreach my $e (@{$fn->{ELEMENTS}}) {
2255 next unless grep(/out/, @{$e->{DIRECTION}});
2256 $self->ParseElementPull($e, "ndr", $env, 1, 1);
2259 if ($fn->{RETURN_TYPE}) {
2260 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, &r->out.result));");
2263 $self->add_deferred();
2267 $self->pidl("return NT_STATUS_OK;");
2273 #####################################################################
2274 # produce a function call table
2275 sub FunctionTable($$)
2277 my($self,$interface) = @_;
2279 my $uname = uc $interface->{NAME};
2281 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2282 return unless defined ($interface->{PROPERTIES}->{uuid});
2284 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2285 foreach my $d (@{$interface->{FUNCTIONS}}) {
2286 next if not defined($d->{OPNUM});
2288 $self->pidl("\t\t\"$d->{NAME}\",");
2289 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2290 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2291 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2292 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2293 $self->pidl("\t\t".($d->{ASYNC}?"True":"False").",");
2294 $self->pidl("\t},");
2297 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL, False }");
2301 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2302 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2303 $self->pidl("\t$ep, ");
2305 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2310 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2311 $self->pidl("\t.count\t= $endpoint_count,");
2312 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2316 if (! defined $interface->{PROPERTIES}->{authservice}) {
2317 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2320 my @a = split / /, $interface->{PROPERTIES}->{authservice};
2321 my $authservice_count = $#a + 1;
2323 $self->pidl("static const char * const $interface->{NAME}\_authservice_strings[] = {");
2324 foreach my $ap (@a) {
2325 $self->pidl("\t$ap, ");
2330 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_authservices = {");
2331 $self->pidl("\t.count\t= $endpoint_count,");
2332 $self->pidl("\t.names\t= $interface->{NAME}\_authservice_strings");
2336 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2337 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2338 $self->pidl("\t.syntax_id\t= {");
2339 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2340 $self->pidl("\t\tDCERPC_$uname\_VERSION");
2341 $self->pidl("\t},");
2342 $self->pidl("\t.helpstring\t= DCERPC_$uname\_HELPSTRING,");
2343 $self->pidl("\t.num_calls\t= $count,");
2344 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2345 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2346 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2352 #####################################################################
2353 # generate include statements for imported idl files
2358 foreach (@imports) {
2361 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2365 #####################################################################
2366 # generate include statements for included header files
2371 foreach (@includes) {
2372 $self->pidl_hdr("#include $_");
2376 #####################################################################
2377 # generate prototypes and defines for the interface definitions
2378 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2379 # NDR parser and so do not belong here, technically speaking
2380 sub HeaderInterface($$)
2382 my($self,$interface) = @_;
2386 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2388 if (has_property($interface, "object")) {
2389 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2392 if (defined $interface->{PROPERTIES}->{helper}) {
2393 $self->HeaderInclude(split / /, $interface->{PROPERTIES}->{helper});
2396 if (defined $interface->{PROPERTIES}->{uuid}) {
2397 my $name = uc $interface->{NAME};
2398 $self->pidl_hdr("#define DCERPC_$name\_UUID " .
2399 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid})));
2401 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2402 $self->pidl_hdr("#define DCERPC_$name\_VERSION $interface->{PROPERTIES}->{version}");
2404 $self->pidl_hdr("#define DCERPC_$name\_NAME \"$interface->{NAME}\"");
2406 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2407 $self->pidl_hdr("#define DCERPC_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2409 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2410 $self->pidl_hdr("NTSTATUS dcerpc_server_$interface->{NAME}_init(void);");
2413 foreach (@{$interface->{FUNCTIONS}}) {
2414 next if has_property($_, "noopnum");
2415 next if grep(/$_->{NAME}/,@{$interface->{INHERITED_FUNCTIONS}});
2416 my $u_name = uc $_->{NAME};
2418 my $val = sprintf("0x%02x", $count);
2419 if (defined($interface->{BASE})) {
2420 $val .= " + DCERPC_" . uc $interface->{BASE} . "_CALL_COUNT";
2423 $self->pidl_hdr("#define DCERPC_$u_name ($val)");
2425 $self->pidl_hdr("");
2431 if (defined($interface->{BASE})) {
2432 $val .= " + DCERPC_" . uc $interface->{BASE} . "_CALL_COUNT";
2435 $self->pidl_hdr("#define DCERPC_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2439 sub ParseTypePush($$$$$)
2441 my ($self,$e,$varname, $primitives, $deferred) = @_;
2443 # save the old relative_base_offset
2444 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset(ndr);") if defined(has_property($e, "relative_base"));
2445 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $varname);
2446 # restore the old relative_base_offset
2447 $self->pidl("ndr_push_restore_relative_base_offset(ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2450 sub ParseTypePushFunction($$$)
2452 my ($self, $e, $varname) = @_;
2454 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2455 $self->fn_declare("push", $e, "NTSTATUS ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *ndr, int ndr_flags, $args)") or return;
2459 $self->ParseTypePush($e, $varname, 1, 1);
2460 $self->pidl("return NT_STATUS_OK;");
2466 sub ParseTypePull($$$$$)
2468 my ($self, $e, $varname, $primitives, $deferred) = @_;
2470 # save the old relative_base_offset
2471 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset(ndr);") if defined(has_property($e, "relative_base"));
2472 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $varname);
2473 # restore the old relative_base_offset
2474 $self->pidl("ndr_pull_restore_relative_base_offset(ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2477 sub ParseTypePullFunction($$)
2479 my ($self, $e, $varname) = @_;
2481 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2483 $self->fn_declare("pull", $e, "NTSTATUS ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *ndr, int ndr_flags, $args)") or return;
2487 $self->ParseTypePull($e, $varname, 1, 1);
2488 $self->pidl("return NT_STATUS_OK;");
2494 sub ParseTypePrint($$$)
2496 my ($self, $e, $varname) = @_;
2498 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $e->{NAME}, $varname);
2501 sub ParseTypePrintFunction($$$)
2503 my ($self, $e, $varname) = @_;
2504 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2506 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2508 return if (has_property($e, "noprint"));
2510 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args)");
2513 $self->ParseTypePrint($e, $varname);
2519 sub ParseTypeNdrSize($$)
2524 my $tf = $typefamily{$t->{TYPE}};
2525 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2527 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2531 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2537 #####################################################################
2538 # parse the interface definitions
2539 sub ParseInterface($$$)
2541 my($self,$interface,$needed) = @_;
2543 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2544 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2546 $self->pidl_hdr("");
2548 if ($needed->{"compression"}) {
2549 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2552 $self->HeaderInterface($interface);
2555 foreach my $d (@{$interface->{TYPES}}) {
2556 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2557 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2558 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2560 # Make sure we don't generate a function twice...
2561 $needed->{TypeFunctionName("ndr_push", $d)} =
2562 $needed->{TypeFunctionName("ndr_pull", $d)} =
2563 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2565 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2569 foreach my $d (@{$interface->{FUNCTIONS}}) {
2570 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2571 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2572 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2574 # Make sure we don't generate a function twice...
2575 $needed->{"ndr_push_$d->{NAME}"} = $needed->{"ndr_pull_$d->{NAME}"} =
2576 $needed->{"ndr_print_$d->{NAME}"} = 0;
2579 $self->FunctionTable($interface);
2581 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2584 sub GenerateIncludes($)
2588 $self->pidl("#include \"includes.h\"");
2590 $self->pidl("#define _GNU_SOURCE");
2591 $self->pidl("#include <stdint.h>");
2592 $self->pidl("#include <stdlib.h>");
2593 $self->pidl("#include <stdio.h>");
2594 $self->pidl("#include <stdbool.h>");
2595 $self->pidl("#include <stdarg.h>");
2596 $self->pidl("#include <string.h>");
2599 # Samba3 has everything in include/includes.h
2600 if (is_intree() != 3) {
2601 $self->pidl(choose_header("libcli/util/nterr.h", "core/nterr.h"));
2602 $self->pidl(choose_header("librpc/gen_ndr/ndr_misc.h", "gen_ndr/ndr_misc.h"));
2603 $self->pidl(choose_header("librpc/gen_ndr/ndr_dcerpc.h", "gen_ndr/ndr_dcerpc.h"));
2604 $self->pidl(choose_header("librpc/rpc/dcerpc.h", "dcerpc.h")); #FIXME: This shouldn't be here!
2608 #####################################################################
2609 # parse a parsed IDL structure back into an IDL file
2612 my($self, $ndr,$gen_header,$ndr_header) = @_;
2614 $self->pidl_hdr("/* header auto-generated by pidl */");
2615 $self->pidl_hdr("");
2616 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2617 $self->pidl_hdr("");
2619 $self->pidl("/* parser auto-generated by pidl */");
2621 $self->GenerateIncludes();
2622 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2628 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2632 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2633 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2634 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2637 return ($self->{res_hdr}, $self->{res});
2640 sub NeededElement($$$)
2642 my ($e, $dir, $needed) = @_;
2644 return if ($e->{TYPE} eq "EMPTY");
2646 return if (ref($e->{TYPE}) eq "HASH" and
2647 not defined($e->{TYPE}->{NAME}));
2650 if (ref($e->{TYPE}) eq "HASH") {
2651 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2656 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2657 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2659 $rt = $e->{REPRESENTATION_TYPE};
2662 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2665 if ($dir eq "print") {
2666 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2667 } elsif ($dir eq "pull") {
2668 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2669 push (@fn, "ndr_$t\_to_$rt")
2671 } elsif ($dir eq "push") {
2672 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2673 push (@fn, "ndr_$rt\_to_$t")
2676 die("invalid direction `$dir'");
2680 unless (defined($needed->{$_})) {
2686 sub NeededFunction($$)
2688 my ($fn,$needed) = @_;
2689 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
2690 $needed->{"ndr_push_$fn->{NAME}"} = 1;
2691 $needed->{"ndr_print_$fn->{NAME}"} = 1;
2692 foreach my $e (@{$fn->{ELEMENTS}}) {
2694 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
2700 sub NeededType($$$);
2701 my ($t,$needed,$req) = @_;
2703 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
2705 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
2706 for my $e (@{$t->{ELEMENTS}}) {
2708 if (has_property($e, "compression")) {
2709 $needed->{"compression"} = 1;
2711 NeededElement($e, $req, $needed);
2712 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
2717 #####################################################################
2718 # work out what parse functions are needed
2719 sub NeededInterface($$)
2721 my ($interface,$needed) = @_;
2722 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
2723 foreach (reverse @{$interface->{TYPES}}) {
2724 if (has_property($_, "public")) {
2725 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
2726 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
2729 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
2730 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
2731 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
2732 if (has_property($_, "gensize")) {
2733 $needed->{"ndr_size_$_->{NAME}"} = 1;
2738 sub TypeFunctionName($$)
2740 my ($prefix, $t) = @_;
2742 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
2743 ($t->{TYPE} eq "TYPEDEF" or $t->{TYPE} eq "DECLARE"));
2744 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
2745 return "$prefix\_$t";