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;
9 use parent Parse::Pidl::Base;
12 push @ISA, qw(Exporter);
13 @EXPORT_OK = qw(check_null_pointer NeededFunction NeededElement NeededType $res NeededInterface TypeFunctionName ParseElementPrint);
17 use Parse::Pidl::Typelist qw(hasType getType mapTypeName mapTypeSpecifier typeHasBody);
18 use Parse::Pidl::Util qw(has_property
25 use Parse::Pidl::CUtil qw(get_pointer_to get_value_of get_array_element);
26 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred ContainsPipe is_charset_array);
27 use Parse::Pidl::Samba4 qw(is_intree choose_header ArrayDynamicallyAllocated);
28 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv);
29 use Parse::Pidl qw(warning);
31 use vars qw($VERSION);
39 my $self = { res => "", res_hdr => "", deferred => [], tabs => "", defer_tabs => "" };
46 return $typefamily{$n};
51 my ($e, $var_name) = @_;
55 foreach my $l (@{$e->{LEVELS}}) {
56 if ($l->{TYPE} eq "POINTER") {
58 } elsif ($l->{TYPE} eq "ARRAY") {
60 if (($pointers == 0) and
61 (not $l->{IS_FIXED}) and
62 (not $l->{IS_INLINE})) {
63 return get_value_of($var_name);
65 } elsif ($l->{TYPE} eq "DATA") {
66 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
67 return get_value_of($var_name) unless ($pointers or $arrays);
75 sub has_fast_array($$)
79 return 0 if ($l->{TYPE} ne "ARRAY");
81 my $nl = GetNextLevel($e,$l);
82 return 0 unless ($nl->{TYPE} eq "DATA");
83 return 0 unless (hasType($nl->{DATA_TYPE}));
85 my $t = getType($nl->{DATA_TYPE});
87 # Only uint8 has a fast array function at the moment
88 return ($t->{NAME} eq "uint8");
94 if (!has_property($d, "public")) {
98 if ($d->{TYPE} eq "TYPEDEF") {
101 return $t->{TYPE} eq "STRUCT";
104 ####################################
105 # defer() is like pidl(), but adds to
106 # a deferred buffer which is then added to the
107 # output buffer at the end of the structure/union/function
108 # This is needed to cope with code that must be pushed back
109 # to the end of a block of elements
110 sub defer_indent($) { my ($self) = @_; $self->{defer_tabs}.="\t"; }
111 sub defer_deindent($) { my ($self) = @_; $self->{defer_tabs}=substr($self->{defer_tabs}, 0, -1); }
117 push(@{$self->{deferred}}, $self->{defer_tabs}.$d);
121 ########################################
122 # add the deferred content to the current
127 $self->pidl($_) foreach (@{$self->{deferred}});
128 $self->{deferred} = [];
129 $self->{defer_tabs} = "";
132 #####################################################################
133 # declare a function public or static, depending on its attributes
136 my ($self,$type,$fn,$decl) = @_;
138 if (has_property($fn, "no$type")) {
139 $self->pidl_hdr("$decl;");
143 if (has_property($fn, "public")) {
144 $self->pidl_hdr("$decl;");
145 $self->pidl("_PUBLIC_ $decl");
147 $self->pidl("static $decl");
153 ###################################################################
154 # setup any special flags for an element or structure
157 my ($self, $e, $ndr) = @_;
158 my $flags = has_property($e, "flag");
159 if (defined $flags) {
162 $self->pidl("libndr_flags _flags_save_$e->{TYPE} = $ndr->flags;");
163 $self->pidl("ndr_set_flags(&$ndr->flags, $flags);");
167 ###################################################################
168 # end any special flags for an element or structure
171 my ($self, $e, $ndr) = @_;
172 my $flags = has_property($e, "flag");
173 if (defined $flags) {
174 $self->pidl("$ndr->flags = _flags_save_$e->{TYPE};");
180 #####################################################################
181 # parse the data of an array - push side
182 sub ParseArrayPushHeader($$$$$$)
184 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
189 if ($l->{IS_ZERO_TERMINATED}) {
190 if (has_property($e, "charset")) {
191 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
193 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
195 if (defined($l->{SIZE_IS})) {
196 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
198 if (defined($l->{LENGTH_IS})) {
199 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
202 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
203 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
206 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
207 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
210 if ($l->{IS_VARYING}) {
211 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, 0));"); # array offset
212 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $length));");
218 sub check_fully_dereferenced($$)
220 my ($element, $env) = @_;
226 # Figure out the number of pointers in $ptr
227 my $expandedvar = $origvar;
228 $expandedvar =~ s/^(\**)//;
232 foreach (keys %$env) {
233 if ($env->{$_} eq $expandedvar) {
239 return($origvar) unless (defined($var));
241 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
242 if ($_->{NAME} eq $var) {
248 $e or die("Environment doesn't match siblings");
250 # See if pointer at pointer level $level
251 # needs to be checked.
253 foreach (@{$e->{LEVELS}}) {
254 if ($_->{TYPE} eq "POINTER") {
255 $nump = $_->{POINTER_INDEX}+1;
258 warning($element->{ORIGINAL}, "Got pointer for `$e->{NAME}', expected fully dereferenced variable") if ($nump > length($ptr));
263 sub check_null_pointer($$$$)
265 my ($element, $env, $print_fn, $return) = @_;
268 my $expandedvar = shift;
271 # Figure out the number of pointers in $ptr
272 $expandedvar =~ s/^(\**)//;
276 foreach (keys %$env) {
277 if ($env->{$_} eq $expandedvar) {
286 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
287 if ($_->{NAME} eq $var) {
293 $e or die("Environment doesn't match siblings");
295 # See if pointer at pointer level $level
296 # needs to be checked.
297 foreach my $l (@{$e->{LEVELS}}) {
298 if ($l->{TYPE} eq "POINTER" and
299 $l->{POINTER_INDEX} == length($ptr)) {
300 # No need to check ref pointers
301 $check = ($l->{POINTER_TYPE} ne "ref");
305 if ($l->{TYPE} eq "DATA") {
306 warning($element, "too much dereferences for `$var'");
310 warning($element, "unknown dereferenced expression `$expandedvar'");
314 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
318 sub is_deferred_switch_non_empty($)
320 # 1 if there needs to be a deferred branch in an ndr_pull/push,
323 my $have_default = 0;
324 foreach my $el (@{$e->{ELEMENTS}}) {
325 if ($el->{CASE} eq "default") {
328 if ($el->{TYPE} ne "EMPTY") {
329 if (ContainsDeferred($el, $el->{LEVELS}[0])) {
334 return ! $have_default;
337 sub ParseArrayPullGetSize($$$$$$)
339 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
343 my $array_size = "size_$e->{NAME}_$l->{LEVEL_INDEX}";
345 if ($l->{IS_CONFORMANT} and (defined($l->{SIZE_IS}) or not $l->{IS_ZERO_TERMINATED})) {
346 $self->pidl("NDR_CHECK(ndr_get_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", &$array_size));");
348 } elsif ($l->{IS_CONFORMANT}) {
349 # This will be the last use of the array_size token
350 $self->pidl("NDR_CHECK(ndr_steal_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", &$array_size));");
352 } elsif ($l->{IS_ZERO_TERMINATED} and $l->{SIZE_IS} == 0 and $l->{LENGTH_IS} == 0) { # Noheader arrays
353 $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
354 $self->pidl("$array_size = $size;");
357 $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
358 check_null_pointer($e, $env, sub { $self->pidl(shift); },
359 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
360 check_fully_dereferenced($e, $env));
361 $self->pidl("$array_size = $size;");
364 if (my $range = has_property($e, "range")) {
365 my ($low, $high) = parse_range($range);
367 warning(0, "$low is invalid for the range of an array size");
370 $self->pidl("if ($array_size > $high) {");
372 $self->pidl("if ($array_size < $low || $array_size > $high) {");
374 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value (%\"PRIu32\") out of range (%\"PRIu32\" - %\"PRIu32\")\", $array_size, (uint32_t)($low), (uint32_t)($high));");
382 #####################################################################
383 # parse an array - pull side
384 sub ParseArrayPullGetLength($$$$$$;$)
386 my ($self,$e,$l,$ndr,$var_name,$env,$array_size) = @_;
388 if (not defined($array_size)) {
389 $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
392 if (not $l->{IS_VARYING}) {
396 my $array_length = "length_$e->{NAME}_$l->{LEVEL_INDEX}";
397 if ($l->{IS_VARYING} and (defined($l->{LENGTH_IS}) or not $l->{IS_ZERO_TERMINATED})) {
398 $self->pidl("NDR_CHECK(ndr_get_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", &$array_length));");
400 # This will be the last use of the array_length token
401 $self->pidl("NDR_CHECK(ndr_steal_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", &$array_length));");
404 if (my $range = has_property($e, "range")) {
405 my ($low, $high) = parse_range($range);
407 warning(0, "$low is invalid for the range of an array size");
410 $self->pidl("if ($array_length > $high) {");
412 $self->pidl("if ($array_length < $low || $array_length > $high) {");
414 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value (%\"PRIu32\") out of range (%\"PRIu32\" - %\"PRIu32\")\", $array_length, (uint32_t)($low), (uint32_t)($high));");
418 return $array_length;
421 #####################################################################
422 # parse an array - pull side
423 sub ParseArrayPullHeader($$$$$$)
425 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
427 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
428 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, " . get_pointer_to($var_name) . "));");
431 if ($l->{IS_VARYING}) {
432 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
435 my $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
436 my $array_length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env, $array_size);
438 if ($array_length ne $array_size) {
439 $self->pidl("if ($array_length > $array_size) {");
441 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %\"PRIu32\": should exceed array length %\"PRIu32\"\", $array_size, $array_length);");
446 if ($l->{IS_CONFORMANT} and (defined($l->{SIZE_IS}) or not $l->{IS_ZERO_TERMINATED})) {
447 $self->defer("if ($var_name) {");
449 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
450 check_null_pointer($e, $env, sub { $self->defer(shift); },
451 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
452 check_fully_dereferenced($e, $env));
453 if (ContainsDeferred($e, $l)) {
454 # We will be needing the array_size token in
455 # the NDR_BUFFERS call, so don't steal it now
456 $self->defer("NDR_CHECK(ndr_check_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
458 # This will be deferred until after the last ndr_get_array_size()
459 $self->defer("NDR_CHECK(ndr_check_steal_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
461 $self->defer_deindent;
465 if ($l->{IS_VARYING} and (defined($l->{LENGTH_IS}) or not $l->{IS_ZERO_TERMINATED})) {
466 $self->defer("if ($var_name) {");
468 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
469 check_null_pointer($e, $env, sub { $self->defer(shift); },
470 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
471 check_fully_dereferenced($e, $env));
472 # This will be deferred until after the last ndr_get_array_length()
473 $self->defer("NDR_CHECK(ndr_check_steal_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
474 $self->defer_deindent;
478 if (ArrayDynamicallyAllocated($e,$l) and not is_charset_array($e,$l)) {
479 $self->AllocateArrayLevel($e,$l,$ndr,$var_name,$array_size);
482 return $array_length;
485 sub compression_alg($$$)
487 my ($e, $l, $env) = @_;
488 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
490 return ParseExpr($alg, $env, $e->{ORIGINAL});
493 sub compression_clen($$$)
495 my ($e, $l, $env) = @_;
496 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
498 return ParseExpr($clen, $env, $e->{ORIGINAL});
501 sub compression_dlen($$$)
503 my ($e,$l,$env) = @_;
504 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
506 return ParseExpr($dlen, $env, $e->{ORIGINAL});
509 sub ParseCompressionPushStart($$$$$)
511 my ($self,$e,$l,$ndr,$env) = @_;
512 my $comndr = "$ndr\_compressed";
513 my $alg = compression_alg($e, $l, $env);
517 $self->pidl("struct ndr_push *$comndr;");
518 $self->pidl("NDR_CHECK(ndr_push_compression_state_init($ndr, $alg));");
519 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr));");
524 sub ParseCompressionPushEnd($$$$$)
526 my ($self,$e,$l,$ndr,$env) = @_;
527 my $comndr = "$ndr\_compressed";
528 my $alg = compression_alg($e, $l, $env);
530 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr));");
531 $self->pidl("TALLOC_FREE($ndr->cstate);");
536 sub ParseCompressionPullStart($$$$$)
538 my ($self,$e,$l,$ndr,$env) = @_;
539 my $comndr = "$ndr\_compressed";
540 my $alg = compression_alg($e, $l, $env);
541 my $dlen = compression_dlen($e, $l, $env);
542 my $clen = compression_clen($e, $l, $env);
546 $self->pidl("struct ndr_pull *$comndr;");
547 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen, $clen));");
552 sub ParseCompressionPullEnd($$$$$)
554 my ($self,$e,$l,$ndr,$env) = @_;
555 my $comndr = "$ndr\_compressed";
556 my $alg = compression_alg($e, $l, $env);
557 my $dlen = compression_dlen($e, $l, $env);
559 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
564 sub ParseSubcontextPushStart($$$$$)
566 my ($self,$e,$l,$ndr,$env) = @_;
567 my $subndr = "_ndr_$e->{NAME}";
568 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
572 $self->pidl("struct ndr_push *$subndr;");
573 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
575 if (defined $l->{COMPRESSION}) {
576 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
582 sub ParseSubcontextPushEnd($$$$$)
584 my ($self,$e,$l,$ndr,$env) = @_;
585 my $subndr = "_ndr_$e->{NAME}";
586 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
588 if (defined $l->{COMPRESSION}) {
589 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
592 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
597 sub ParseSubcontextPullStart($$$$$)
599 my ($self,$e,$l,$ndr,$env) = @_;
600 my $subndr = "_ndr_$e->{NAME}";
601 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
605 $self->pidl("struct ndr_pull *$subndr;");
606 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
608 if (defined $l->{COMPRESSION}) {
609 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
615 sub ParseSubcontextPullEnd($$$$$)
617 my ($self,$e,$l,$ndr,$env) = @_;
618 my $subndr = "_ndr_$e->{NAME}";
619 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
621 if (defined $l->{COMPRESSION}) {
622 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
625 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
630 sub ParseElementPushLevel
632 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
634 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
636 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
637 $var_name = get_pointer_to($var_name);
640 if (defined($ndr_flags)) {
641 if ($l->{TYPE} eq "SUBCONTEXT") {
642 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
643 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
644 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
645 } elsif ($l->{TYPE} eq "POINTER") {
646 $self->ParsePtrPush($e, $l, $ndr, $var_name);
647 } elsif ($l->{TYPE} eq "ARRAY") {
648 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
650 my $nl = GetNextLevel($e, $l);
652 # Allow speedups for arrays of scalar types
653 if (is_charset_array($e,$l)) {
654 if ($l->{IS_TO_NULL}) {
655 $self->pidl("NDR_CHECK(ndr_push_charset_to_null($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
657 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
660 } elsif (has_fast_array($e,$l)) {
661 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
664 } elsif ($l->{TYPE} eq "DATA") {
665 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
666 } elsif ($l->{TYPE} eq "TYPEDEF") {
667 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
671 if ($l->{TYPE} eq "POINTER" and $l->{POINTER_TYPE} eq "ignore") {
672 $self->pidl("/* [ignore] '$e->{NAME}' */");
673 } elsif ($l->{TYPE} eq "POINTER" and $deferred) {
674 my $rel_var_name = $var_name;
675 if ($l->{POINTER_TYPE} ne "ref") {
676 $self->pidl("if ($var_name) {");
678 if ($l->{POINTER_TYPE} eq "relative") {
679 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_start($ndr, $rel_var_name));");
681 if ($l->{POINTER_TYPE} eq "relative_short") {
682 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr2($ndr, $var_name));");
685 $var_name = get_value_of($var_name);
686 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
688 if ($l->{POINTER_TYPE} ne "ref") {
689 if ($l->{POINTER_TYPE} eq "relative") {
690 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_end($ndr, $rel_var_name));");
695 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
696 not is_charset_array($e, $l)) {
697 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
698 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
700 my $array_pointless = ($length eq "0");
702 if ($array_pointless) {
703 warning($e->{ORIGINAL}, "pointless array `$e->{NAME}' will always have size 0");
706 $var_name = get_array_element($var_name, $counter);
708 if ((($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) and not $array_pointless) {
709 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
711 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
716 if ($deferred and ContainsDeferred($e, $l) and not $array_pointless) {
717 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
719 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
723 } elsif ($l->{TYPE} eq "SWITCH") {
724 my $nl = GetNextLevel($e,$l);
725 my $needs_deferred_switch = is_deferred_switch_non_empty($nl);
727 # Avoid setting a switch value if it will not be
728 # consumed again in the NDR_BUFFERS pull
729 if ($needs_deferred_switch or !$deferred) {
730 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
732 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
736 #####################################################################
737 # parse scalars in a structure element
738 sub ParseElementPush($$$$$$)
740 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
743 my $var_name = $env->{$e->{NAME}};
745 if (has_property($e, "skip") or has_property($e, "skip_noinit")) {
746 $self->pidl("/* [skip] '$var_name' */");
750 return if ContainsPipe($e, $e->{LEVELS}[0]);
752 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
754 # Representation type is different from transmit_as
755 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
758 my $transmit_name = "_transmit_$e->{NAME}";
759 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
760 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
761 $var_name = $transmit_name;
764 $var_name = append_prefix($e, $var_name);
766 $self->start_flags($e, $ndr);
768 if (defined(my $value = has_property($e, "value"))) {
769 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
772 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
774 $self->end_flags($e, $ndr);
776 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
782 #####################################################################
783 # parse a pointer in a struct element or function
784 sub ParsePtrPush($$$$$)
786 my ($self,$e,$l,$ndr,$var_name) = @_;
788 if ($l->{POINTER_TYPE} eq "ref") {
789 if ($l->{LEVEL_INDEX} > 0) {
790 $self->pidl("if ($var_name == NULL) {");
792 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
796 if ($l->{LEVEL} eq "EMBEDDED") {
797 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr)); /* $var_name */");
799 } elsif ($l->{POINTER_TYPE} eq "relative") {
800 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
801 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
802 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr1($ndr, $var_name));");
803 } elsif ($l->{POINTER_TYPE} eq "unique") {
804 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
805 } elsif ($l->{POINTER_TYPE} eq "full") {
806 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
807 } elsif ($l->{POINTER_TYPE} eq "ignore") {
808 # We don't want this pointer to appear on the wire at all
809 $self->pidl("NDR_CHECK(ndr_push_uint3264(ndr, NDR_SCALARS, 0));");
811 die("Unhandled pointer type $l->{POINTER_TYPE}");
815 sub need_pointer_to($$$)
817 my ($e, $l, $scalar_only) = @_;
820 if (ref($l->{DATA_TYPE})) {
821 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
823 $t = $l->{DATA_TYPE};
826 if (not Parse::Pidl::Typelist::is_scalar($t)) {
827 return 1 if $scalar_only;
832 foreach my $tl (@{$e->{LEVELS}}) {
834 if ($tl->{TYPE} eq "ARRAY") {
839 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
840 return 1 unless $arrays;
846 sub ParseDataPrint($$$$$)
848 my ($self, $e, $l, $ndr, $var_name) = @_;
850 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
852 if (need_pointer_to($e, $l, 1)) {
853 $var_name = get_pointer_to($var_name);
856 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
858 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
862 #####################################################################
863 # print scalars in a structure element
864 sub ParseElementPrint($$$$$)
866 my($self, $e, $ndr, $var_name, $env) = @_;
868 return if (has_property($e, "noprint"));
870 my $ignore_depth = 0xFFFF;
872 $self->start_flags($e, $ndr);
873 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
874 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
875 $self->end_flags($e, $ndr);
879 $var_name = append_prefix($e, $var_name);
881 if (defined(my $value = has_property($e, "value"))) {
882 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
885 foreach my $l (@{$e->{LEVELS}}) {
888 if ($cur_depth > $ignore_depth) {
892 if ($l->{TYPE} eq "POINTER") {
893 $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
894 if ($l->{POINTER_TYPE} eq "ignore") {
895 $self->pidl("/* [ignore] '$e->{NAME}' */");
896 $ignore_depth = $cur_depth;
899 $self->pidl("$ndr->depth++;");
900 if ($l->{POINTER_TYPE} ne "ref") {
901 $self->pidl("if ($var_name) {");
904 $var_name = get_value_of($var_name);
905 } elsif ($l->{TYPE} eq "ARRAY") {
908 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
909 $var_name = get_pointer_to($var_name);
912 if ($l->{IS_ZERO_TERMINATED} and not defined($l->{LENGTH_IS})) {
913 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
915 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
916 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
919 if (is_charset_array($e,$l)) {
920 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
922 } elsif (has_fast_array($e, $l)) {
923 my $nl = GetNextLevel($e, $l);
924 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
927 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
929 $self->pidl("$ndr->print($ndr, \"%s: ARRAY(%\"PRIu32\")\", \"$e->{NAME}\", (uint32_t)($length));");
930 $self->pidl("$ndr->depth++;");
931 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
934 $var_name = get_array_element($var_name, $counter);
936 } elsif ($l->{TYPE} eq "DATA") {
937 $self->ParseDataPrint($e, $l, $ndr, $var_name);
938 } elsif ($l->{TYPE} eq "SWITCH") {
939 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
940 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
941 $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
945 foreach my $l (reverse @{$e->{LEVELS}}) {
948 if ($cur_depth > $ignore_depth) {
952 if ($l->{TYPE} eq "POINTER") {
953 if ($l->{POINTER_TYPE} eq "ignore") {
957 if ($l->{POINTER_TYPE} ne "ref") {
961 $self->pidl("$ndr->depth--;");
962 } elsif (($l->{TYPE} eq "ARRAY")
963 and not is_charset_array($e,$l)
964 and not has_fast_array($e,$l)) {
967 $self->pidl("$ndr->depth--;");
971 $self->end_flags($e, $ndr);
974 #####################################################################
975 # parse scalars in a structure element - pull size
976 sub ParseSwitchPull($$$$$$)
978 my($self,$e,$l,$ndr,$var_name,$env) = @_;
979 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
980 check_null_pointer($e, $env, sub { $self->pidl(shift); },
981 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
982 check_fully_dereferenced($e, $env));
984 $var_name = get_pointer_to($var_name);
985 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
988 #####################################################################
989 # push switch element
990 sub ParseSwitchPush($$$$$$)
992 my($self,$e,$l,$ndr,$var_name,$env) = @_;
993 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
994 check_null_pointer($e, $env, sub { $self->pidl(shift); },
995 "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
996 check_fully_dereferenced($e, $env));
998 $var_name = get_pointer_to($var_name);
999 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
1002 sub ParseDataPull($$$$$$$)
1004 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
1006 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
1008 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1010 if (need_pointer_to($e, $l, 0)) {
1011 $var_name = get_pointer_to($var_name);
1014 $var_name = get_pointer_to($var_name);
1016 if (my $depth = has_property($e, "max_recursion")) {
1017 my $d = parse_int($depth);
1018 $self->pidl("NDR_RECURSION_CHECK($ndr, $d);");
1020 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
1021 if (has_property($e, "max_recursion")) {
1022 $self->pidl("NDR_RECURSION_UNWIND($ndr);");
1025 my $pl = GetPrevLevel($e, $l);
1027 my $range = has_property($e, "range");
1028 if ($range and (not $pl or $pl->{TYPE} ne "ARRAY")) {
1029 $var_name = get_value_of($var_name);
1030 my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
1031 my ($low, $high) = parse_range($range);
1032 if ($low < 0 and not $signed) {
1033 warning(0, "$low is invalid for the range of an unsigned type");
1035 if ($low == 0 and not $signed) {
1036 $self->pidl("if ($var_name > $high) {");
1038 $self->pidl("if ($var_name < $low || $var_name > $high) {");
1041 my $data_type = mapTypeName($l->{DATA_TYPE});
1042 my $fmt = mapTypeSpecifier($data_type);
1044 if (!defined($fmt)) {
1045 if (getType($l->{DATA_TYPE})->{DATA}->{TYPE} eq "ENUM") {
1049 die("Format ($data_type) not supported");
1053 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value (%$fmt) out of range (%$fmt - %$fmt)\", ($data_type)($var_name), ($data_type)($low), ($data_type)($high));");
1057 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
1061 sub ParseDataPush($$$$$$$)
1063 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
1065 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
1067 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1069 # strings are passed by value rather than reference
1070 if (need_pointer_to($e, $l, 1)) {
1071 $var_name = get_pointer_to($var_name);
1074 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
1076 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
1080 sub CalcNdrFlags($$$)
1082 my ($l,$primitives,$deferred) = @_;
1087 # Add NDR_SCALARS if this one is deferred
1088 # and deferreds may be pushed
1089 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
1091 # Add NDR_SCALARS if this one is not deferred and
1092 # primitives may be pushed
1093 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
1095 # Add NDR_BUFFERS if this one contains deferred stuff
1096 # and deferreds may be pushed
1097 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
1099 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
1100 return "NDR_SCALARS" if ($scalars);
1101 return "NDR_BUFFERS" if ($buffers);
1105 sub ParseMemCtxPullFlags($$$$)
1107 my ($self, $e, $l) = @_;
1109 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
1110 return undef if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ignore"));
1112 return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
1113 return undef if has_fast_array($e, $l);
1114 return undef if is_charset_array($e, $l);
1116 my $mem_flags = "0";
1118 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
1119 my $nl = GetNextLevel($e, $l);
1120 return undef if ($nl->{TYPE} eq "PIPE");
1121 return undef if ($nl->{TYPE} eq "ARRAY");
1122 return undef if (($nl->{TYPE} eq "DATA") and ($nl->{DATA_TYPE} eq "string"));
1124 if ($l->{LEVEL} eq "TOP") {
1125 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
1132 sub ParseMemCtxPullStart($$$$$)
1134 my ($self, $e, $l, $ndr, $ptr_name) = @_;
1136 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1137 my $mem_c_ctx = $ptr_name;
1138 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
1140 return unless defined($mem_c_flags);
1142 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
1143 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
1146 sub ParseMemCtxPullEnd($$$$)
1148 my ($self, $e, $l, $ndr) = @_;
1150 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1151 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
1153 return unless defined($mem_r_flags);
1155 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
1158 sub CheckStringTerminator($$$$$)
1160 my ($self,$ndr,$e,$l,$length) = @_;
1161 my $nl = GetNextLevel($e, $l);
1163 # Make sure last element is zero!
1164 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
1167 sub ParseElementPullLevel
1169 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1171 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1172 my $array_length = undef;
1174 if (has_property($e, "skip") or has_property($e, "skip_noinit")) {
1175 $self->pidl("/* [skip] '$var_name' */");
1176 if (not has_property($e, "skip_noinit")) {
1177 $self->pidl("NDR_ZERO_STRUCT($var_name);");
1182 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1183 $var_name = get_pointer_to($var_name);
1186 # Only pull something if there's actually something to be pulled
1187 if (defined($ndr_flags)) {
1188 if ($l->{TYPE} eq "SUBCONTEXT") {
1189 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1190 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1191 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1192 } elsif ($l->{TYPE} eq "ARRAY") {
1193 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1194 $array_length = $length;
1196 my $nl = GetNextLevel($e, $l);
1198 if (is_charset_array($e,$l)) {
1199 if ($l->{IS_ZERO_TERMINATED}) {
1200 $self->CheckStringTerminator($ndr, $e, $l, $length);
1202 if ($l->{IS_TO_NULL}) {
1203 $self->pidl("NDR_CHECK(ndr_pull_charset_to_null($ndr, $ndr_flags, ".get_pointer_to($var_name).", $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
1205 $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}));");
1208 } elsif (has_fast_array($e, $l)) {
1209 if ($l->{IS_ZERO_TERMINATED}) {
1210 $self->CheckStringTerminator($ndr,$e,$l,$length);
1212 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1215 } elsif ($l->{TYPE} eq "POINTER") {
1216 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1217 } elsif ($l->{TYPE} eq "DATA") {
1218 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1219 } elsif ($l->{TYPE} eq "TYPEDEF") {
1220 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1224 # add additional constructions
1225 if ($l->{TYPE} eq "POINTER" and $l->{POINTER_TYPE} eq "ignore") {
1226 $self->pidl("/* [ignore] '$e->{NAME}' */");
1227 } elsif ($l->{TYPE} eq "POINTER" and $deferred) {
1228 if ($l->{POINTER_TYPE} ne "ref") {
1229 $self->pidl("if ($var_name) {");
1232 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1233 $self->pidl("uint32_t _relative_save_offset;");
1234 $self->pidl("_relative_save_offset = $ndr->offset;");
1235 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1239 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1241 $var_name = get_value_of($var_name);
1242 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1244 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1246 if ($l->{POINTER_TYPE} ne "ref") {
1247 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1248 $self->pidl("if ($ndr->offset > $ndr->relative_highest_offset) {");
1250 $self->pidl("$ndr->relative_highest_offset = $ndr->offset;");
1253 $self->pidl("$ndr->offset = _relative_save_offset;");
1258 } elsif ($l->{TYPE} eq "ARRAY" and
1259 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1260 my $length = $array_length;
1261 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1262 my $array_name = $var_name;
1264 if (not defined($length)) {
1265 $length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env);
1268 $var_name = get_array_element($var_name, $counter);
1270 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1272 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1273 my $nl = GetNextLevel($e,$l);
1275 if ($l->{IS_ZERO_TERMINATED}) {
1276 $self->CheckStringTerminator($ndr,$e,$l,$length);
1279 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
1281 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1286 if ($deferred and ContainsDeferred($e, $l)) {
1287 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
1288 $self->defer("for ($counter = 0; $counter < ($length); $counter++) {");
1289 $self->defer_indent;
1291 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1293 $self->defer_deindent;
1298 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1300 } elsif ($l->{TYPE} eq "SWITCH") {
1301 my $nl = GetNextLevel($e,$l);
1302 my $needs_deferred_switch = is_deferred_switch_non_empty($nl);
1304 # Avoid setting a switch value if it will not be
1305 # consumed again in the NDR_BUFFERS pull
1306 if ($needs_deferred_switch or !$deferred) {
1307 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1309 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, $primitives, $deferred);
1313 #####################################################################
1314 # parse scalars in a structure element - pull size
1315 sub ParseElementPull($$$$$$)
1317 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1319 my $var_name = $env->{$e->{NAME}};
1323 return if ContainsPipe($e, $e->{LEVELS}[0]);
1325 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1327 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1330 $represent_name = $var_name;
1331 $transmit_name = "_transmit_$e->{NAME}";
1332 $var_name = $transmit_name;
1333 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1336 $var_name = append_prefix($e, $var_name);
1338 $self->start_flags($e, $ndr);
1340 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1342 $self->end_flags($e, $ndr);
1344 # Representation type is different from transmit_as
1345 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1346 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1352 #####################################################################
1353 # parse a pointer in a struct element or function
1354 sub ParsePtrPull($$$$$)
1356 my($self, $e,$l,$ndr,$var_name) = @_;
1358 my $nl = GetNextLevel($e, $l);
1359 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1360 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1361 ($nl->{DATA_TYPE} eq "string"));
1363 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1365 if (!$next_is_array and !$next_is_string) {
1366 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1367 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1372 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1373 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1374 } elsif (($l->{POINTER_TYPE} eq "unique") or
1375 ($l->{POINTER_TYPE} eq "relative") or
1376 ($l->{POINTER_TYPE} eq "full")) {
1377 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1378 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
1379 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr_short($ndr, &_ptr_$e->{NAME}));");
1380 } elsif ($l->{POINTER_TYPE} eq "ignore") {
1381 #We want to consume the pointer bytes, but ignore the pointer value
1382 $self->pidl("NDR_CHECK(ndr_pull_uint3264(ndr, NDR_SCALARS, &_ptr_$e->{NAME}));");
1383 $self->pidl("_ptr_$e->{NAME} = 0;");
1385 die("Unhandled pointer type $l->{POINTER_TYPE}");
1388 $self->pidl("if (_ptr_$e->{NAME}) {");
1391 if ($l->{POINTER_TYPE} eq "ignore") {
1392 # Don't do anything, we don't want to do the
1393 # allocation, as we forced it to NULL just above, and
1394 # we may not know the declared type anyway.
1396 # Don't do this for arrays, they're allocated at the actual level
1398 unless ($next_is_array or $next_is_string) {
1399 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1401 # FIXME: Yes, this is nasty.
1402 # We allocate an array twice
1403 # - once just to indicate that it's there,
1404 # - then the real allocation...
1405 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1409 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1410 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1411 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1414 $self->pidl("} else {");
1415 $self->pidl("\t$var_name = NULL;");
1419 sub CheckRefPtrs($$$$)
1421 my ($self,$e,$ndr,$env) = @_;
1423 return if ContainsPipe($e, $e->{LEVELS}[0]);
1424 return if ($e->{LEVELS}[0]->{TYPE} ne "POINTER");
1425 return if ($e->{LEVELS}[0]->{POINTER_TYPE} ne "ref");
1427 my $var_name = $env->{$e->{NAME}};
1428 $var_name = append_prefix($e, $var_name);
1430 $self->pidl("if ($var_name == NULL) {");
1432 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
1437 sub ParseStructPushPrimitives($$$$$)
1439 my ($self, $struct, $ndr, $varname, $env) = @_;
1441 $self->CheckRefPtrs($_, $ndr, $env) foreach (@{$struct->{ELEMENTS}});
1443 # see if the structure contains a conformant array. If it
1444 # does, then it must be the last element of the structure, and
1445 # we need to push the conformant length early, as it fits on
1446 # the wire before the structure (and even before the structure
1448 if (defined($struct->{SURROUNDING_ELEMENT})) {
1449 my $e = $struct->{SURROUNDING_ELEMENT};
1451 if (defined($e->{LEVELS}[0]) and
1452 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1455 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1456 if (has_property($e, "charset")) {
1457 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1459 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1461 if (defined($e->{LEVELS}[0]->{SIZE_IS})) {
1462 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1465 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1468 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
1470 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1474 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1476 if (defined($struct->{PROPERTIES}{relative_base})) {
1477 # set the current offset as base for relative pointers
1478 # and store it based on the toplevel struct/union
1479 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1482 $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1484 $self->pidl("NDR_CHECK(ndr_push_trailer_align($ndr, $struct->{ALIGN}));");
1487 sub ParseStructPushDeferred($$$$)
1489 my ($self, $struct, $ndr, $varname, $env) = @_;
1490 if (defined($struct->{PROPERTIES}{relative_base})) {
1491 # retrieve the current offset as base for relative pointers
1492 # based on the toplevel struct/union
1493 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1495 $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1498 #####################################################################
1500 sub ParseStructPush($$$$)
1502 my ($self, $struct, $ndr, $varname) = @_;
1504 return unless defined($struct->{ELEMENTS});
1506 my $env = GenerateStructEnv($struct, $varname);
1508 EnvSubstituteValue($env, $struct);
1510 $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1512 $self->start_flags($struct, $ndr);
1514 $self->pidl("NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);");
1515 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1517 $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1521 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1523 $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1527 $self->end_flags($struct, $ndr);
1530 #####################################################################
1531 # generate a push function for an enum
1532 sub ParseEnumPush($$$$)
1534 my($self,$enum,$ndr,$varname) = @_;
1535 my($type_fn) = $enum->{BASE_TYPE};
1537 $self->start_flags($enum, $ndr);
1538 $self->pidl("NDR_CHECK(ndr_push_enum_$type_fn($ndr, NDR_SCALARS, $varname));");
1539 $self->end_flags($enum, $ndr);
1542 #####################################################################
1543 # generate a pull function for an enum
1544 sub ParseEnumPull($$$$)
1546 my($self,$enum,$ndr,$varname) = @_;
1547 my($type_fn) = $enum->{BASE_TYPE};
1548 my($type_v_decl) = mapTypeName($type_fn);
1550 $self->pidl("$type_v_decl v;");
1551 $self->start_flags($enum, $ndr);
1552 $self->pidl("NDR_CHECK(ndr_pull_enum_$type_fn($ndr, NDR_SCALARS, &v));");
1553 $self->pidl("*$varname = v;");
1555 $self->end_flags($enum, $ndr);
1558 #####################################################################
1559 # generate a print function for an enum
1560 sub ParseEnumPrint($$$$$)
1562 my($self,$enum,$ndr,$name,$varname) = @_;
1564 $self->pidl("const char *val = NULL;");
1567 $self->start_flags($enum, $ndr);
1569 $self->pidl("switch ($varname) {");
1571 my $els = \@{$enum->{ELEMENTS}};
1572 foreach my $i (0 .. $#{$els}) {
1573 my $e = ${$els}[$i];
1575 if ($e =~ /^(.*)=/) {
1578 $self->pidl("case $e: val = \"$e\"; break;");
1584 $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1586 $self->end_flags($enum, $ndr);
1591 my ($e,$t,$name,$varname) = @_;
1592 return "enum $name " .
1593 ($t eq "pull"?"*":"") . $varname;
1596 $typefamily{ENUM} = {
1598 PUSH_FN_BODY => \&ParseEnumPush,
1599 PULL_FN_BODY => \&ParseEnumPull,
1600 PRINT_FN_BODY => \&ParseEnumPrint,
1603 #####################################################################
1604 # generate a push function for a bitmap
1605 sub ParseBitmapPush($$$$)
1607 my($self,$bitmap,$ndr,$varname) = @_;
1608 my($type_fn) = $bitmap->{BASE_TYPE};
1610 $self->start_flags($bitmap, $ndr);
1612 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1614 $self->end_flags($bitmap, $ndr);
1617 #####################################################################
1618 # generate a pull function for an bitmap
1619 sub ParseBitmapPull($$$$)
1621 my($self,$bitmap,$ndr,$varname) = @_;
1622 my $type_fn = $bitmap->{BASE_TYPE};
1623 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1625 $self->pidl("$type_decl v;");
1626 $self->start_flags($bitmap, $ndr);
1627 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1628 $self->pidl("*$varname = v;");
1630 $self->end_flags($bitmap, $ndr);
1633 #####################################################################
1634 # generate a print function for an bitmap
1635 sub ParseBitmapPrintElement($$$$$$)
1637 my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1638 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1639 my($type_fn) = $bitmap->{BASE_TYPE};
1642 if ($e =~ /^(\w+) .*$/) {
1645 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1648 $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1651 #####################################################################
1652 # generate a print function for an bitmap
1653 sub ParseBitmapPrint($$$$$)
1655 my($self,$bitmap,$ndr,$name,$varname) = @_;
1656 my($type_decl) = mapTypeName($bitmap->{TYPE});
1657 my($type_fn) = $bitmap->{BASE_TYPE};
1659 $self->start_flags($bitmap, $ndr);
1661 $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1663 $self->pidl("$ndr->depth++;");
1664 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1665 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1667 $self->pidl("$ndr->depth--;");
1669 $self->end_flags($bitmap, $ndr);
1672 sub DeclBitmap($$$$)
1674 my ($e,$t,$name,$varname) = @_;
1675 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1676 ($t eq "pull"?" *":" ") . $varname;
1679 $typefamily{BITMAP} = {
1680 DECL => \&DeclBitmap,
1681 PUSH_FN_BODY => \&ParseBitmapPush,
1682 PULL_FN_BODY => \&ParseBitmapPull,
1683 PRINT_FN_BODY => \&ParseBitmapPrint,
1686 #####################################################################
1687 # generate a struct print function
1688 sub ParseStructPrint($$$$$)
1690 my($self,$struct,$ndr,$name,$varname) = @_;
1692 return unless defined $struct->{ELEMENTS};
1694 my $env = GenerateStructEnv($struct, $varname);
1696 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1698 $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1699 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
1701 $self->start_flags($struct, $ndr);
1703 $self->pidl("$ndr->depth++;");
1705 $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1706 foreach (@{$struct->{ELEMENTS}});
1707 $self->pidl("$ndr->depth--;");
1709 $self->end_flags($struct, $ndr);
1712 sub DeclarePtrVariables($$)
1716 if (has_property($e, "skip") or has_property($e, "skip_noinit")) {
1720 foreach my $l (@{$e->{LEVELS}}) {
1722 if ($l->{TYPE} eq "POINTER" and
1723 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1724 if ($l->{POINTER_TYPE} eq "relative_short") {
1727 $self->pidl("uint${size}_t _ptr_$e->{NAME};");
1733 sub DeclareArrayVariables($$;$)
1735 my ($self,$e,$pull) = @_;
1737 if (has_property($e, "skip") or has_property($e, "skip_noinit")) {
1741 foreach my $l (@{$e->{LEVELS}}) {
1742 next if ($l->{TYPE} ne "ARRAY");
1743 if (defined($pull)) {
1744 $self->pidl("uint32_t size_$e->{NAME}_$l->{LEVEL_INDEX} = 0;");
1745 if ($l->{IS_VARYING}) {
1746 $self->pidl("uint32_t length_$e->{NAME}_$l->{LEVEL_INDEX} = 0;");
1749 next if has_fast_array($e,$l);
1750 next if is_charset_array($e,$l);
1751 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1755 sub DeclareArrayVariablesNoZero($$$)
1757 my ($self,$e,$env) = @_;
1759 if (has_property($e, "skip") or has_property($e, "skip_noinit")) {
1763 foreach my $l (@{$e->{LEVELS}}) {
1764 next if ($l->{TYPE} ne "ARRAY");
1765 next if has_fast_array($e,$l);
1766 next if is_charset_array($e,$l);
1767 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1768 if ($length eq "0") {
1769 warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1771 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1776 sub DeclareMemCtxVariables($$)
1780 if (has_property($e, "skip") or has_property($e, "skip_noinit")) {
1784 foreach my $l (@{$e->{LEVELS}}) {
1785 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1787 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ignore")) {
1791 if (defined($mem_flags)) {
1792 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX} = NULL;");
1797 sub ParseStructPullPrimitives($$$$$)
1799 my($self,$struct,$ndr,$varname,$env) = @_;
1801 if (defined $struct->{SURROUNDING_ELEMENT}) {
1802 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1805 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1807 if (defined($struct->{PROPERTIES}{relative_base})) {
1808 # set the current offset as base for relative pointers
1809 # and store it based on the toplevel struct/union
1810 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1813 $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1815 $self->add_deferred();
1817 $self->pidl("NDR_CHECK(ndr_pull_trailer_align($ndr, $struct->{ALIGN}));");
1820 sub ParseStructPullDeferred($$$$$)
1822 my ($self,$struct,$ndr,$varname,$env) = @_;
1824 if (defined($struct->{PROPERTIES}{relative_base})) {
1825 # retrieve the current offset as base for relative pointers
1826 # based on the toplevel struct/union
1827 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1829 foreach my $e (@{$struct->{ELEMENTS}}) {
1830 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1833 $self->add_deferred();
1836 #####################################################################
1837 # parse a struct - pull side
1838 sub ParseStructPull($$$$)
1840 my($self,$struct,$ndr,$varname) = @_;
1842 return unless defined $struct->{ELEMENTS};
1844 # declare any internal pointers we need
1845 foreach my $e (@{$struct->{ELEMENTS}}) {
1846 $self->DeclarePtrVariables($e);
1847 $self->DeclareArrayVariables($e, "pull");
1848 $self->DeclareMemCtxVariables($e);
1851 $self->start_flags($struct, $ndr);
1853 my $env = GenerateStructEnv($struct, $varname);
1855 $self->pidl("NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);");
1856 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1858 $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1861 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1863 $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1867 $self->end_flags($struct, $ndr);
1870 #####################################################################
1871 # calculate size of ndr struct
1872 sub ParseStructNdrSize($$$$)
1874 my ($self,$t, $name, $varname) = @_;
1877 if (my $flags = has_property($t, "flag")) {
1878 $self->pidl("flags |= $flags;");
1880 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1883 sub DeclStruct($$$$)
1885 my ($e,$t,$name,$varname) = @_;
1887 return "struct $name $varname";
1889 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1892 sub ArgsStructNdrSize($$$)
1894 my ($d, $name, $varname) = @_;
1895 return "const struct $name *$varname, libndr_flags flags";
1898 $typefamily{STRUCT} = {
1899 PUSH_FN_BODY => \&ParseStructPush,
1900 DECL => \&DeclStruct,
1901 PULL_FN_BODY => \&ParseStructPull,
1902 PRINT_FN_BODY => \&ParseStructPrint,
1903 SIZE_FN_BODY => \&ParseStructNdrSize,
1904 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1907 #####################################################################
1908 # calculate size of ndr struct
1909 sub ParseUnionNdrSize($$$)
1911 my ($self, $t, $name, $varname) = @_;
1914 if (my $flags = has_property($t, "flag")) {
1915 $self->pidl("flags |= $flags;");
1918 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1921 sub ParseUnionPushPrimitives($$$$)
1923 my ($self, $e, $ndr ,$varname) = @_;
1925 my $have_default = 0;
1927 if (defined($e->{SWITCH_TYPE})) {
1928 if (defined($e->{ALIGN})) {
1929 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1932 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1935 if (defined($e->{ALIGN})) {
1936 if ($e->{IS_MS_UNION}) {
1937 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1938 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $e->{ALIGN}));");
1940 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1944 $self->pidl("switch (level) {");
1946 foreach my $el (@{$e->{ELEMENTS}}) {
1947 if ($el->{CASE} eq "default") {
1950 $self->pidl("$el->{CASE}: {");
1952 if ($el->{TYPE} ne "EMPTY") {
1954 if (defined($e->{PROPERTIES}{relative_base})) {
1955 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1956 # set the current offset as base for relative pointers
1957 # and store it based on the toplevel struct/union
1958 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1960 $self->DeclareArrayVariables($el);
1961 my $el_env = {$el->{NAME} => "$varname->$el->{NAME}"};
1962 $self->CheckRefPtrs($el, $ndr, $el_env);
1963 $self->ParseElementPush($el, $ndr, $el_env, 1, 0);
1966 $self->pidl("break; }");
1969 if (! $have_default) {
1970 $self->pidl("default:");
1971 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %\"PRIu32, level);");
1977 sub ParseUnionPushDeferred($$$$)
1979 my ($self,$e,$ndr,$varname) = @_;
1981 my $have_default = 0;
1983 if (defined($e->{PROPERTIES}{relative_base})) {
1984 # retrieve the current offset as base for relative pointers
1985 # based on the toplevel struct/union
1986 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1988 $self->pidl("switch (level) {");
1990 foreach my $el (@{$e->{ELEMENTS}}) {
1991 if ($el->{CASE} eq "default") {
1995 $self->pidl("$el->{CASE}:");
1996 if ($el->{TYPE} ne "EMPTY") {
1998 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
2001 $self->pidl("break;");
2004 if (! $have_default) {
2005 $self->pidl("default:");
2006 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %\"PRIu32, level);");
2012 #####################################################################
2013 # parse a union - push side
2014 sub ParseUnionPush($$$$)
2016 my ($self,$e,$ndr,$varname) = @_;
2017 my $have_default = 0;
2019 $self->pidl("uint32_t level;");
2020 $self->start_flags($e, $ndr);
2022 $self->pidl("NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);");
2023 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
2025 $self->pidl("/* This token is not used again (except perhaps below in the NDR_BUFFERS case) */");
2026 $self->pidl("NDR_CHECK(ndr_push_steal_switch_value($ndr, $varname, &level));");
2028 $self->ParseUnionPushPrimitives($e, $ndr, $varname);
2031 if (is_deferred_switch_non_empty($e)) {
2032 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
2034 # In case we had ndr_flags of NDR_SCALERS|NDR_BUFFERS
2035 $self->pidl("if (!(ndr_flags & NDR_SCALARS)) {");
2037 $self->pidl("/* We didn't get it above, and the token is not needed after this. */");
2038 $self->pidl("NDR_CHECK(ndr_push_steal_switch_value($ndr, $varname, &level));");
2041 $self->ParseUnionPushDeferred($e, $ndr, $varname);
2045 $self->end_flags($e, $ndr);
2048 #####################################################################
2050 sub ParseUnionPrint($$$$$)
2052 my ($self,$e,$ndr,$name,$varname) = @_;
2053 my $have_default = 0;
2055 $self->pidl("uint32_t level;");
2056 foreach my $el (@{$e->{ELEMENTS}}) {
2057 $self->DeclareArrayVariables($el);
2060 $self->start_flags($e, $ndr);
2062 $self->pidl("level = ndr_print_steal_switch_value($ndr, $varname);");
2064 $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
2066 $self->pidl("switch (level) {");
2068 foreach my $el (@{$e->{ELEMENTS}}) {
2069 if ($el->{CASE} eq "default") {
2072 $self->pidl("$el->{CASE}:");
2073 if ($el->{TYPE} ne "EMPTY") {
2075 $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
2078 $self->pidl("break;");
2081 if (! $have_default) {
2082 $self->pidl("default:");
2083 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
2088 $self->end_flags($e, $ndr);
2091 sub ParseUnionPullPrimitives($$$$$)
2093 my ($self,$e,$ndr,$varname,$switch_type) = @_;
2094 my $have_default = 0;
2097 if (defined($switch_type)) {
2098 if (defined($e->{ALIGN})) {
2099 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
2102 my $data_type = mapTypeName($switch_type);
2103 my $fmt = mapTypeSpecifier($data_type);
2105 if (!defined($fmt)) {
2110 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
2111 $self->pidl("if (_level != level) {");
2112 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %$fmt for $varname at \%s\", ($data_type)_level, __location__);");
2116 if (defined($e->{ALIGN})) {
2117 if ($e->{IS_MS_UNION}) {
2118 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
2119 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $e->{ALIGN}));");
2121 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
2125 $self->pidl("switch (level) {");
2127 foreach my $el (@{$e->{ELEMENTS}}) {
2128 if ($el->{CASE} eq "default") {
2131 $self->pidl("$el->{CASE}: {");
2133 if ($el->{TYPE} ne "EMPTY") {
2135 if (defined($e->{PROPERTIES}{relative_base})) {
2136 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
2137 # set the current offset as base for relative pointers
2138 # and store it based on the toplevel struct/union
2139 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
2141 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
2144 $self->pidl("break; }");
2147 if (! $have_default) {
2148 $self->pidl("default:");
2149 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %\"PRIu32\" at %s\", level, __location__);");
2155 sub ParseUnionPullDeferred($$$$)
2157 my ($self,$e,$ndr,$varname) = @_;
2158 my $have_default = 0;
2160 $self->pidl("switch (level) {");
2162 foreach my $el (@{$e->{ELEMENTS}}) {
2163 if ($el->{CASE} eq "default") {
2167 $self->pidl("$el->{CASE}:");
2168 if ($el->{TYPE} ne "EMPTY") {
2170 if (defined($e->{PROPERTIES}{relative_base})) {
2171 # retrieve the current offset as base for relative pointers
2172 # based on the toplevel struct/union
2173 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
2175 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
2178 $self->pidl("break;");
2181 if (! $have_default) {
2182 $self->pidl("default:");
2183 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %\"PRIu32\" at %s\", level, __location__);");
2191 #####################################################################
2192 # parse a union - pull side
2193 sub ParseUnionPull($$$$)
2195 my ($self,$e,$ndr,$varname) = @_;
2196 my $switch_type = $e->{SWITCH_TYPE};
2197 my $needs_deferred_switch = is_deferred_switch_non_empty($e);
2198 $self->pidl("uint32_t level;");
2199 if (defined($switch_type)) {
2200 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
2201 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
2203 $self->pidl(mapTypeName($switch_type) . " _level;");
2206 my %double_cases = ();
2207 foreach my $el (@{$e->{ELEMENTS}}) {
2208 next if ($el->{TYPE} eq "EMPTY");
2209 next if ($double_cases{"$el->{NAME}"});
2210 $self->DeclareMemCtxVariables($el);
2211 $self->DeclarePtrVariables($el);
2212 $self->DeclareArrayVariables($el, "pull");
2213 $double_cases{"$el->{NAME}"} = 1;
2216 $self->start_flags($e, $ndr);
2218 $self->pidl("NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);");
2219 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
2221 $self->pidl("/* This token is not used again (except perhaps below in the NDR_BUFFERS case) */");
2222 $self->pidl("NDR_CHECK(ndr_pull_steal_switch_value($ndr, $varname, &level));");
2223 $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
2226 if ($needs_deferred_switch) {
2227 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
2229 # In case we had ndr_flags of NDR_SCALERS|NDR_BUFFERS
2230 $self->pidl("if (!(ndr_flags & NDR_SCALARS)) {");
2232 $self->pidl("/* We didn't get it above, and the token is not needed after this. */");
2233 $self->pidl("NDR_CHECK(ndr_pull_steal_switch_value($ndr, $varname, &level));");
2236 $self->ParseUnionPullDeferred($e,$ndr,$varname);
2240 $self->add_deferred();
2242 $self->end_flags($e, $ndr);
2247 my ($e,$t,$name,$varname) = @_;
2249 return "union $name $varname";
2251 return ($t ne "pull"?"const ":"") . "union $name *$varname";
2254 sub ArgsUnionNdrSize($$)
2257 return "const union $name *r, uint32_t level, libndr_flags flags";
2260 $typefamily{UNION} = {
2261 PUSH_FN_BODY => \&ParseUnionPush,
2262 DECL => \&DeclUnion,
2263 PULL_FN_BODY => \&ParseUnionPull,
2264 PRINT_FN_BODY => \&ParseUnionPrint,
2265 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
2266 SIZE_FN_BODY => \&ParseUnionNdrSize,
2269 #####################################################################
2270 # parse a typedef - push side
2271 sub ParseTypedefPush($$$$)
2273 my($self,$e,$ndr,$varname) = @_;
2277 $env->{$e->{NAME}} = $varname;
2279 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2282 #####################################################################
2283 # parse a typedef - pull side
2284 sub ParseTypedefPull($$$$)
2286 my($self,$e,$ndr,$varname) = @_;
2290 $env->{$e->{NAME}} = $varname;
2292 $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2295 #####################################################################
2296 # parse a typedef - print side
2297 sub ParseTypedefPrint($$$$$)
2299 my($self,$e,$ndr,$name,$varname) = @_;
2301 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
2304 #####################################################################
2305 ## calculate the size of a structure
2306 sub ParseTypedefNdrSize($$$$)
2308 my($self,$t,$name,$varname) = @_;
2310 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
2313 sub DeclTypedef($$$$)
2315 my ($e, $t, $name, $varname) = @_;
2317 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2320 sub ArgsTypedefNdrSize($$$)
2322 my ($d, $name, $varname) = @_;
2323 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2326 $typefamily{TYPEDEF} = {
2327 PUSH_FN_BODY => \&ParseTypedefPush,
2328 DECL => \&DeclTypedef,
2329 PULL_FN_BODY => \&ParseTypedefPull,
2330 PRINT_FN_BODY => \&ParseTypedefPrint,
2331 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2332 SIZE_FN_BODY => \&ParseTypedefNdrSize,
2335 sub ParsePipePushChunk($$)
2337 my ($self, $t) = @_;
2340 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2341 my $struct = $pipe->{DATA};
2343 my $name = "$struct->{NAME}";
2347 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "push", $name, $varname);
2349 $self->fn_declare("push", $struct, "enum ndr_err_code ndr_push_$name(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2351 return if has_property($t, "nopush");
2356 $self->ParseStructPush($struct, $ndr, $varname);
2359 $self->pidl("NDR_CHECK(ndr_push_pipe_chunk_trailer(ndr, ndr_flags, $varname->count));");
2362 $self->pidl("return NDR_ERR_SUCCESS;");
2368 sub ParsePipePullChunk($$)
2370 my ($self, $t) = @_;
2373 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2374 my $struct = $pipe->{DATA};
2376 my $name = "$struct->{NAME}";
2380 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "pull", $name, $varname);
2382 $self->fn_declare("pull", $struct, "enum ndr_err_code ndr_pull_$name(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2384 return if has_property($struct, "nopull");
2389 $self->ParseStructPull($struct, $ndr, $varname);
2392 $self->pidl("NDR_CHECK(ndr_check_pipe_chunk_trailer($ndr, ndr_flags, $varname->count));");
2395 $self->pidl("return NDR_ERR_SUCCESS;");
2401 sub ParsePipePrintChunk($$)
2403 my ($self, $t) = @_;
2406 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2407 my $struct = $pipe->{DATA};
2409 my $name = "$struct->{NAME}";
2413 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "print", $name, $varname);
2415 $self->pidl_hdr("void ndr_print_$name(struct ndr_print *ndr, const char *name, $args);");
2417 return if (has_property($t, "noprint"));
2419 $self->pidl("_PUBLIC_ void ndr_print_$name(struct ndr_print *$ndr, const char *name, $args)");
2422 $self->ParseTypePrint($struct, $ndr, $varname);
2428 #####################################################################
2429 # parse a function - print side
2430 sub ParseFunctionPrint($$)
2432 my($self, $fn) = @_;
2435 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2437 return if has_property($fn, "noprint");
2439 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2443 foreach my $e (@{$fn->{ELEMENTS}}) {
2444 $self->DeclareArrayVariables($e);
2447 $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2448 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
2449 $self->pidl("$ndr->depth++;");
2451 $self->pidl("if (flags & NDR_SET_VALUES) {");
2452 $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2455 $self->pidl("if (flags & NDR_IN) {");
2457 $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2458 $self->pidl("$ndr->depth++;");
2460 my $env = GenerateFunctionInEnv($fn);
2462 foreach my $e (@{$fn->{ELEMENTS}}) {
2463 if (grep(/in/,@{$e->{DIRECTION}})) {
2464 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2467 $self->pidl("$ndr->depth--;");
2471 $self->pidl("if (flags & NDR_OUT) {");
2473 $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2474 $self->pidl("$ndr->depth++;");
2476 $env = GenerateFunctionOutEnv($fn);
2477 foreach my $e (@{$fn->{ELEMENTS}}) {
2478 if (grep(/out/,@{$e->{DIRECTION}})) {
2479 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2482 if ($fn->{RETURN_TYPE}) {
2483 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2485 $self->pidl("$ndr->depth--;");
2489 $self->pidl("$ndr->depth--;");
2495 #####################################################################
2497 sub ParseFunctionPush($$)
2499 my($self, $fn) = @_;
2502 $self->fn_declare("push", $fn, "enum ndr_err_code ndr_push_$fn->{NAME}(struct ndr_push *$ndr, int flags, const struct $fn->{NAME} *r)") or return;
2504 return if has_property($fn, "nopush");
2509 foreach my $e (@{$fn->{ELEMENTS}}) {
2510 $self->DeclareArrayVariables($e);
2513 $self->pidl("NDR_PUSH_CHECK_FN_FLAGS(ndr, flags);");
2515 $self->pidl("if (flags & NDR_IN) {");
2518 my $env = GenerateFunctionInEnv($fn);
2520 EnvSubstituteValue($env, $fn);
2522 foreach my $e (@{$fn->{ELEMENTS}}) {
2523 if (grep(/in/,@{$e->{DIRECTION}})) {
2524 $self->CheckRefPtrs($e, $ndr, $env);
2528 foreach my $e (@{$fn->{ELEMENTS}}) {
2529 if (grep(/in/,@{$e->{DIRECTION}})) {
2530 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2537 $self->pidl("if (flags & NDR_OUT) {");
2540 $env = GenerateFunctionOutEnv($fn);
2541 EnvSubstituteValue($env, $fn);
2543 foreach my $e (@{$fn->{ELEMENTS}}) {
2544 if (grep(/out/,@{$e->{DIRECTION}})) {
2545 $self->CheckRefPtrs($e, $ndr, $env);
2549 foreach my $e (@{$fn->{ELEMENTS}}) {
2550 if (grep(/out/,@{$e->{DIRECTION}})) {
2551 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2555 if ($fn->{RETURN_TYPE}) {
2556 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2561 $self->pidl("return NDR_ERR_SUCCESS;");
2567 sub AllocateArrayLevel($$$$$$)
2569 my ($self,$e,$l,$ndr,$var,$size) = @_;
2571 my $pl = GetPrevLevel($e, $l);
2572 if (defined($pl) and
2573 $pl->{TYPE} eq "POINTER" and
2574 $pl->{POINTER_TYPE} eq "ref"
2575 and not $l->{IS_ZERO_TERMINATED}) {
2576 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2577 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2579 if (grep(/in/,@{$e->{DIRECTION}}) and
2580 grep(/out/,@{$e->{DIRECTION}})) {
2581 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2586 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2589 #####################################################################
2591 sub ParseFunctionPull($$)
2596 # pull function args
2597 $self->fn_declare("pull", $fn, "enum ndr_err_code ndr_pull_$fn->{NAME}(struct ndr_pull *$ndr, int flags, struct $fn->{NAME} *r)") or return;
2602 # declare any internal pointers we need
2603 foreach my $e (@{$fn->{ELEMENTS}}) {
2604 $self->DeclarePtrVariables($e);
2605 $self->DeclareArrayVariables($e, "pull");
2608 my %double_cases = ();
2609 foreach my $e (@{$fn->{ELEMENTS}}) {
2610 next if ($e->{TYPE} eq "EMPTY");
2611 next if ($double_cases{"$e->{NAME}"});
2612 $self->DeclareMemCtxVariables($e);
2613 $double_cases{"$e->{NAME}"} = 1;
2616 $self->pidl("NDR_PULL_CHECK_FN_FLAGS(ndr, flags);");
2618 $self->pidl("if (flags & NDR_IN) {");
2621 # auto-init the out section of a structure. I originally argued that
2622 # this was a bad idea as it hides bugs, but coping correctly
2623 # with initialisation and not wiping ref vars is turning
2624 # out to be too tricky (tridge)
2625 foreach my $e (@{$fn->{ELEMENTS}}) {
2626 next unless grep(/out/, @{$e->{DIRECTION}});
2627 $self->pidl("NDR_ZERO_STRUCT(r->out);");
2632 my $env = GenerateFunctionInEnv($fn);
2634 foreach my $e (@{$fn->{ELEMENTS}}) {
2635 next unless (grep(/in/, @{$e->{DIRECTION}}));
2636 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2639 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2640 # own flag rather than be in NDR_IN ?
2642 foreach my $e (@{$fn->{ELEMENTS}}) {
2643 next unless (grep(/out/, @{$e->{DIRECTION}}));
2644 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2645 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2646 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2647 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2648 next if ($e->{LEVELS}[1]->{TYPE} eq "PIPE");
2649 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2650 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2652 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2653 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2654 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2655 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2656 check_fully_dereferenced($e, $env));
2657 $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2659 if (grep(/in/, @{$e->{DIRECTION}})) {
2660 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2662 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2664 } elsif ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2665 if (grep(/in/, @{$e->{DIRECTION}})) {
2666 $self->pidl("r->out.$e->{NAME} = r->in.$e->{NAME};");
2668 $self->pidl("r->out.$e->{NAME} = NULL;");
2671 $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2673 if (grep(/in/, @{$e->{DIRECTION}})) {
2674 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2676 $self->pidl("NDR_ZERO_STRUCTP(r->out.$e->{NAME});");
2681 $self->add_deferred();
2685 $self->pidl("if (flags & NDR_OUT) {");
2688 $self->pidl("#ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION");
2690 # This is for fuzzers of ndr_pull where the out elements refer to
2691 # in elements in size_is or length_is.
2693 # Not actually very harmful but also not useful outside a fuzzer
2694 foreach my $e (@{$fn->{ELEMENTS}}) {
2695 next unless (grep(/in/, @{$e->{DIRECTION}}));
2696 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2697 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2698 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2699 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2700 next if ($e->{LEVELS}[1]->{TYPE} eq "PIPE");
2701 next if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY");
2703 $self->pidl("if (r->in.$e->{NAME} == NULL) {");
2705 $self->pidl("NDR_PULL_ALLOC($ndr, r->in.$e->{NAME});");
2706 $self->pidl("NDR_ZERO_STRUCTP(r->in.$e->{NAME});");
2711 $self->pidl("#endif /* FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION */");
2713 $env = GenerateFunctionOutEnv($fn);
2714 foreach my $e (@{$fn->{ELEMENTS}}) {
2715 next unless grep(/out/, @{$e->{DIRECTION}});
2716 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2719 if ($fn->{RETURN_TYPE}) {
2720 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2723 $self->add_deferred();
2727 $self->pidl("return NDR_ERR_SUCCESS;");
2733 sub AuthServiceStruct($$$)
2735 my ($self, $ifacename, $authservice) = @_;
2736 my @a = split /,/, $authservice;
2737 my $authservice_count = $#a + 1;
2739 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2740 foreach my $ap (@a) {
2741 $self->pidl("\t$ap, ");
2746 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2747 $self->pidl("\t.count\t= $authservice_count,");
2748 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2753 sub ParseGeneratePipeArray($$$)
2755 my ($self, $fn, $direction) = @_;
2757 $self->pidl("static const struct ndr_interface_call_pipe $fn->{NAME}\_$direction\_pipes[] = {");
2760 foreach my $e (@{$fn->{ELEMENTS}}) {
2761 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2762 next unless (grep(/$direction/, @{$e->{DIRECTION}}));
2764 my $cname = "$e->{TYPE}_chunk";
2768 $self->pidl("\"$direction.$e->{NAME}\",");
2769 $self->pidl("\"$cname\",");
2770 $self->pidl("sizeof(struct $cname),");
2771 $self->pidl("(ndr_push_flags_fn_t) ndr_push_$cname,");
2772 $self->pidl("(ndr_pull_flags_fn_t) ndr_pull_$cname,");
2773 $self->pidl("(ndr_print_fn_t) ndr_print_$cname,");
2777 $self->pidl("{ .name = NULL }");
2783 sub FunctionCallPipes($$)
2785 my ($self, $d) = @_;
2786 return if not defined($d->{OPNUM});
2791 foreach my $e (@{$d->{ELEMENTS}}) {
2792 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2794 if (grep(/in/, @{$e->{DIRECTION}})) {
2797 if (grep(/out/, @{$e->{DIRECTION}})) {
2803 $self->ParseGeneratePipeArray($d, "in");
2807 $self->ParseGeneratePipeArray($d, "out");
2811 sub FunctionCallEntry($$)
2813 my ($self, $d) = @_;
2814 return 0 if not defined($d->{OPNUM});
2819 foreach my $e (@{$d->{ELEMENTS}}) {
2820 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2822 if (grep(/in/, @{$e->{DIRECTION}})) {
2825 if (grep(/out/, @{$e->{DIRECTION}})) {
2830 my $in_pipes_ptr = "NULL";
2831 my $out_pipes_ptr = "NULL";
2834 $in_pipes_ptr = "$d->{NAME}_in_pipes";
2838 $out_pipes_ptr = "$d->{NAME}_out_pipes";
2842 $self->pidl("\t\t\"$d->{NAME}\",");
2843 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2844 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2845 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2846 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2847 $self->pidl("\t\t{ $in_pipes, $in_pipes_ptr },");
2848 $self->pidl("\t\t{ $out_pipes, $out_pipes_ptr },");
2849 $self->pidl("\t},");
2855 my ($self, $d) = @_;
2856 my $type_decl = $typefamily{$d->{TYPE}}->{DECL}->($d, "base", $d->{NAME}, "");
2859 $self->pidl("\t\t.name = \"$d->{NAME}\",");
2860 $self->pidl("\t\t.struct_size = sizeof($type_decl),");
2861 $self->pidl("\t\t.ndr_push = (ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2862 $self->pidl("\t\t.ndr_pull = (ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2863 $self->pidl("\t\t.ndr_print = (ndr_print_function_t) ndr_print_flags_$d->{NAME},");
2864 $self->pidl("\t},");
2868 #####################################################################
2869 # produce a function call table
2870 sub FunctionTable($$)
2872 my($self,$interface) = @_;
2874 my $count_public_structs = 0;
2875 my $uname = uc $interface->{NAME};
2877 foreach my $d (@{$interface->{TYPES}}) {
2878 next unless (is_public_struct($d));
2879 $count_public_structs += 1;
2881 return if ($#{$interface->{FUNCTIONS}}+1 == 0 and
2882 $count_public_structs == 0);
2884 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2885 $self->FunctionCallPipes($d);
2888 $self->pidl("static const struct ndr_interface_public_struct $interface->{NAME}\_public_structs[] = {");
2890 foreach my $d (@{$interface->{TYPES}}) {
2891 next unless (is_public_struct($d));
2892 $self->StructEntry($d);
2894 $self->pidl("\t{ .name = NULL }");
2898 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2900 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2901 $count += $self->FunctionCallEntry($d);
2903 $self->pidl("\t{ .name = NULL }");
2907 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2908 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2909 $self->pidl("\t$ep, ");
2911 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2916 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2917 $self->pidl("\t.count\t= $endpoint_count,");
2918 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2922 if (! defined $interface->{PROPERTIES}->{authservice}) {
2923 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2926 $self->AuthServiceStruct($interface->{NAME},
2927 $interface->{PROPERTIES}->{authservice});
2929 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2930 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2931 if (defined $interface->{PROPERTIES}->{uuid}) {
2932 $self->pidl("\t.syntax_id\t= {");
2933 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2934 $self->pidl("\t\tNDR_$uname\_VERSION");
2935 $self->pidl("\t},");
2936 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2938 $self->pidl("\t.num_calls\t= $count,");
2939 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2940 $self->pidl("\t.num_public_structs\t= $count_public_structs,");
2941 $self->pidl("\t.public_structs\t\t= $interface->{NAME}\_public_structs,");
2942 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2943 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2949 #####################################################################
2950 # generate include statements for imported idl files
2955 foreach (@imports) {
2956 $_ = unmake_str($_);
2958 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2962 #####################################################################
2963 # generate include statements for included header files
2968 foreach (@includes) {
2969 $self->pidl_hdr("#include $_");
2973 #####################################################################
2974 # generate prototypes and defines for the interface definitions
2975 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2976 # NDR parser and so do not belong here, technically speaking
2977 sub HeaderInterface($$$)
2979 my($self,$interface,$needed) = @_;
2983 if ($needed->{"compression"}) {
2984 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2987 if (has_property($interface, "object")) {
2988 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2991 if (defined $interface->{PROPERTIES}->{helper}) {
2992 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2995 if (defined $interface->{PROPERTIES}->{uuid}) {
2996 my $name = uc $interface->{NAME};
2997 $self->pidl_hdr("#define NDR_$name\_UUID " .
2998 Parse::Pidl::Util::make_str(lc($interface->{UUID})));
3000 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{VERSION}");
3002 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
3004 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
3005 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
3008 my $count_public_structs = 0;
3009 foreach my $d (@{$interface->{TYPES}}) {
3010 next unless (has_property($d, "public"));
3011 $count_public_structs += 1;
3013 if ($#{$interface->{FUNCTIONS}}+1 > 0 or
3014 $count_public_structs > 0) {
3015 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
3018 foreach (@{$interface->{FUNCTIONS}}) {
3019 next if has_property($_, "noopnum");
3020 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
3021 my $u_name = uc $_->{NAME};
3023 my $val = sprintf("0x%02x", $count);
3024 if (defined($interface->{BASE})) {
3025 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
3028 $self->pidl_hdr("#define NDR_$u_name ($val)");
3030 $self->pidl_hdr("");
3036 if (defined($interface->{BASE})) {
3037 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
3040 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
3044 sub ParseTypePush($$$$$$)
3046 my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
3048 # save the old relative_base_offset
3049 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
3050 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
3051 # restore the old relative_base_offset
3052 $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
3055 sub ParseTypePushFunction($$$)
3057 my ($self, $e, $varname) = @_;
3060 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
3062 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
3066 $self->ParseTypePush($e, $ndr, $varname, 1, 1);
3067 $self->pidl("return NDR_ERR_SUCCESS;");
3073 sub ParseTypePull($$$$$$)
3075 my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
3077 # save the old relative_base_offset
3078 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
3079 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
3080 # restore the old relative_base_offset
3081 $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
3084 sub ParseTypePullFunction($$)
3086 my ($self, $e, $varname) = @_;
3089 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
3091 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
3095 $self->ParseTypePull($e, $ndr, $varname, 1, 1);
3096 $self->pidl("return NDR_ERR_SUCCESS;");
3102 sub ParseTypePrint($$$$)
3104 my ($self, $e, $ndr, $varname) = @_;
3106 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
3109 sub ParseTypePrintFunction($$$)
3111 my ($self, $e, $varname) = @_;
3114 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
3116 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
3118 if (is_public_struct($e)) {
3119 $self->pidl("static void ".TypeFunctionName("ndr_print_flags", $e).
3120 "(struct ndr_print *$ndr, const char *name, int unused, $args)"
3124 $self->pidl(TypeFunctionName("ndr_print", $e)."($ndr, name, $varname);");
3130 return if (has_property($e, "noprint"));
3132 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
3135 $self->ParseTypePrint($e, $ndr, $varname);
3141 sub ParseTypeNdrSize($$)
3146 my $tf = $typefamily{$t->{TYPE}};
3147 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
3149 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
3153 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
3159 #####################################################################
3160 # parse the interface definitions
3161 sub ParseInterface($$$)
3163 my($self,$interface,$needed) = @_;
3165 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
3166 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
3168 $self->pidl_hdr("");
3170 $self->HeaderInterface($interface, $needed);
3173 foreach my $d (@{$interface->{TYPES}}) {
3174 if (Parse::Pidl::Typelist::typeIs($d, "PIPE")) {
3175 ($needed->{TypeFunctionName("ndr_push", $d)}) &&
3176 $self->ParsePipePushChunk($d);
3177 ($needed->{TypeFunctionName("ndr_pull", $d)}) &&
3178 $self->ParsePipePullChunk($d);
3179 ($needed->{TypeFunctionName("ndr_print", $d)}) &&
3180 $self->ParsePipePrintChunk($d);
3182 $needed->{TypeFunctionName("ndr_pull", $d)} = 0;
3183 $needed->{TypeFunctionName("ndr_push", $d)} = 0;
3184 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
3188 next unless(typeHasBody($d));
3190 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
3191 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
3192 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
3194 # Make sure we don't generate a function twice...
3195 $needed->{TypeFunctionName("ndr_push", $d)} =
3196 $needed->{TypeFunctionName("ndr_pull", $d)} =
3197 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
3199 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
3203 foreach my $d (@{$interface->{FUNCTIONS}}) {
3204 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
3205 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
3206 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
3209 # Allow compilation of generated files where replacement functions
3210 # for structures declared nopull/nopush have not been provided.
3212 # This makes sense when only the print functions are used
3214 # Otherwise the ndr_table XXX will reference these
3216 $self->pidl("#ifndef SKIP_NDR_TABLE_$interface->{NAME}");
3217 $self->FunctionTable($interface);
3218 $self->pidl("#endif /* SKIP_NDR_TABLE_$interface->{NAME} */");
3220 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
3223 sub GenerateIncludes($)
3227 $self->pidl("#include \"includes.h\"");
3229 $self->pidl("#ifndef _GNU_SOURCE");
3230 $self->pidl("#define _GNU_SOURCE");
3231 $self->pidl("#endif");
3232 $self->pidl("#include <stdint.h>");
3233 $self->pidl("#include <stdlib.h>");
3234 $self->pidl("#include <stdio.h>");
3235 $self->pidl("#include <stdbool.h>");
3236 $self->pidl("#include <stdarg.h>");
3237 $self->pidl("#include <string.h>");
3241 #####################################################################
3242 # parse a parsed IDL structure back into an IDL file
3245 my($self, $ndr,$gen_header,$ndr_header) = @_;
3247 $self->pidl_hdr("/* header auto-generated by pidl */");
3248 $self->pidl_hdr("");
3249 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
3250 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
3251 $self->pidl_hdr("");
3253 $self->pidl("/* parser auto-generated by pidl */");
3255 $self->GenerateIncludes();
3256 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
3262 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
3266 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
3267 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
3268 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
3271 return ($self->{res_hdr}, $self->{res});
3274 sub NeededElement($$$)
3276 my ($e, $dir, $needed) = @_;
3278 return if ($e->{TYPE} eq "EMPTY");
3280 return if (ref($e->{TYPE}) eq "HASH" and
3281 not defined($e->{TYPE}->{NAME}));
3284 if (ref($e->{TYPE}) eq "HASH") {
3285 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
3290 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
3291 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
3293 $rt = $e->{REPRESENTATION_TYPE};
3296 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
3299 if ($dir eq "print") {
3300 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
3301 } elsif ($dir eq "pull") {
3302 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
3303 push (@fn, "ndr_$t\_to_$rt")
3305 } elsif ($dir eq "push") {
3306 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
3307 push (@fn, "ndr_$rt\_to_$t")
3310 die("invalid direction `$dir'");
3314 unless (defined($needed->{$_})) {
3320 sub NeededFunction($$)
3322 my ($fn,$needed) = @_;
3323 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
3324 $needed->{"ndr_push_$fn->{NAME}"} = 1;
3325 $needed->{"ndr_print_$fn->{NAME}"} = 1;
3326 foreach my $e (@{$fn->{ELEMENTS}}) {
3328 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
3334 sub NeededType($$$);
3335 my ($t,$needed,$req) = @_;
3337 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
3338 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "PIPE");
3340 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
3341 return unless defined($t->{ELEMENTS});
3342 for my $e (@{$t->{ELEMENTS}}) {
3344 if (has_property($e, "compression")) {
3345 $needed->{"compression"} = 1;
3347 NeededElement($e, $req, $needed);
3348 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
3353 #####################################################################
3354 # work out what parse functions are needed
3355 sub NeededInterface($$)
3357 my ($interface,$needed) = @_;
3358 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
3359 foreach (reverse @{$interface->{TYPES}}) {
3361 if (has_property($_, "public")) {
3362 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
3363 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
3366 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
3367 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
3368 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
3369 if (has_property($_, "gensize")) {
3370 $needed->{"ndr_size_$_->{NAME}"} = 1;
3375 sub TypeFunctionName($$)
3377 my ($prefix, $t) = @_;
3379 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
3380 $t->{TYPE} eq "TYPEDEF");
3381 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
3382 return "$prefix\_$t";