1 ###################################################
2 # Samba4 NDR parser generator for IDL structures
3 # Copyright tridge@samba.org 2000-2003
4 # Copyright tpot@samba.org 2001
5 # Copyright jelmer@samba.org 2004-2006
6 # released under the GNU GPL
8 package Parse::Pidl::Samba4::NDR::Parser;
12 @EXPORT_OK = qw(check_null_pointer NeededFunction NeededElement NeededType $res NeededInterface TypeFunctionName ParseElementPrint);
15 use Parse::Pidl::Typelist qw(hasType getType mapTypeName typeHasBody);
16 use Parse::Pidl::Util qw(has_property ParseExpr ParseExprExt print_uuid unmake_str);
17 use Parse::Pidl::CUtil qw(get_pointer_to get_value_of get_array_element);
18 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred is_charset_array);
19 use Parse::Pidl::Samba4 qw(is_intree choose_header ArrayDynamicallyAllocated);
20 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv);
21 use Parse::Pidl qw(warning);
23 use vars qw($VERSION);
31 my $self = { res => "", res_hdr => "", deferred => [], tabs => "", defer_tabs => "" };
38 return $typefamily{$n};
43 my ($e, $var_name) = @_;
47 foreach my $l (@{$e->{LEVELS}}) {
48 if ($l->{TYPE} eq "POINTER") {
50 } elsif ($l->{TYPE} eq "ARRAY") {
52 if (($pointers == 0) and
53 (not $l->{IS_FIXED}) and
54 (not $l->{IS_INLINE})) {
55 return get_value_of($var_name);
57 } elsif ($l->{TYPE} eq "DATA") {
58 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
59 return get_value_of($var_name) unless ($pointers or $arrays);
67 sub has_fast_array($$)
71 return 0 if ($l->{TYPE} ne "ARRAY");
73 my $nl = GetNextLevel($e,$l);
74 return 0 unless ($nl->{TYPE} eq "DATA");
75 return 0 unless (hasType($nl->{DATA_TYPE}));
77 my $t = getType($nl->{DATA_TYPE});
79 # Only uint8 and string have fast array functions at the moment
80 return ($t->{NAME} eq "uint8") or ($t->{NAME} eq "string");
84 ####################################
85 # pidl() is our basic output routine
90 $self->{res} .= $self->{tabs};
96 sub pidl_hdr($$) { my ($self, $d) = @_; $self->{res_hdr} .= "$d\n"; }
98 ####################################
99 # defer() is like pidl(), but adds to
100 # a deferred buffer which is then added to the
101 # output buffer at the end of the structure/union/function
102 # This is needed to cope with code that must be pushed back
103 # to the end of a block of elements
104 sub defer_indent($) { my ($self) = @_; $self->{defer_tabs}.="\t"; }
105 sub defer_deindent($) { my ($self) = @_; $self->{defer_tabs}=substr($self->{defer_tabs}, 0, -1); }
111 push(@{$self->{deferred}}, $self->{defer_tabs}.$d);
115 ########################################
116 # add the deferred content to the current
121 $self->pidl($_) foreach (@{$self->{deferred}});
122 $self->{deferred} = [];
123 $self->{defer_tabs} = "";
129 $self->{tabs} .= "\t";
135 $self->{tabs} = substr($self->{tabs}, 0, -1);
138 #####################################################################
139 # declare a function public or static, depending on its attributes
142 my ($self,$type,$fn,$decl) = @_;
144 if (has_property($fn, "no$type")) {
145 $self->pidl_hdr("$decl;");
149 if (has_property($fn, "public")) {
150 $self->pidl_hdr("$decl;");
151 $self->pidl("_PUBLIC_ $decl");
153 $self->pidl("static $decl");
159 ###################################################################
160 # setup any special flags for an element or structure
163 my ($self, $e, $ndr) = @_;
164 my $flags = has_property($e, "flag");
165 if (defined $flags) {
168 $self->pidl("uint32_t _flags_save_$e->{TYPE} = $ndr->flags;");
169 $self->pidl("ndr_set_flags(&$ndr->flags, $flags);");
173 ###################################################################
174 # end any special flags for an element or structure
177 my ($self, $e, $ndr) = @_;
178 my $flags = has_property($e, "flag");
179 if (defined $flags) {
180 $self->pidl("$ndr->flags = _flags_save_$e->{TYPE};");
186 #####################################################################
187 # parse the data of an array - push side
188 sub ParseArrayPushHeader($$$$$$)
190 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
195 if ($l->{IS_ZERO_TERMINATED}) {
196 if (has_property($e, "charset")) {
197 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
199 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
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_uint32($ndr, NDR_SCALARS, $size));");
210 if ($l->{IS_VARYING}) {
211 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, 0));"); # array offset
212 $self->pidl("NDR_CHECK(ndr_push_uint32($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 derefenced 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 #####################################################################
319 # parse an array - pull side
320 sub ParseArrayPullHeader($$$$$$)
322 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
327 if ($l->{IS_CONFORMANT}) {
328 $length = $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
329 } elsif ($l->{IS_ZERO_TERMINATED}) { # Noheader arrays
330 $length = $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
332 $length = $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
333 check_null_pointer($e, $env, sub { $self->pidl(shift); },
334 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
335 check_fully_dereferenced($e, $env));
338 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
339 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, " . get_pointer_to($var_name) . "));");
342 if ($l->{IS_VARYING}) {
343 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
344 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
347 if ($length ne $size) {
348 $self->pidl("if ($length > $size) {");
350 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $size, $length);");
355 if ($l->{IS_CONFORMANT} and not $l->{IS_ZERO_TERMINATED}) {
356 $self->defer("if ($var_name) {");
358 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
359 check_null_pointer($e, $env, sub { $self->defer(shift); },
360 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
361 check_fully_dereferenced($e, $env));
362 $self->defer("NDR_CHECK(ndr_check_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
363 $self->defer_deindent;
367 if ($l->{IS_VARYING} and not $l->{IS_ZERO_TERMINATED}) {
368 $self->defer("if ($var_name) {");
370 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
371 check_null_pointer($e, $env, sub { $self->defer(shift); },
372 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
373 check_fully_dereferenced($e, $env));
374 $self->defer("NDR_CHECK(ndr_check_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
375 $self->defer_deindent;
379 if (ArrayDynamicallyAllocated($e,$l) and not is_charset_array($e,$l)) {
380 $self->AllocateArrayLevel($e,$l,$ndr,$var_name,$size);
386 sub compression_alg($$)
389 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
394 sub compression_clen($$$)
396 my ($e, $l, $env) = @_;
397 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
399 return ParseExpr($clen, $env, $e->{ORIGINAL});
402 sub compression_dlen($$$)
404 my ($e,$l,$env) = @_;
405 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
407 return ParseExpr($dlen, $env, $e->{ORIGINAL});
410 sub ParseCompressionPushStart($$$$$)
412 my ($self,$e,$l,$ndr,$env) = @_;
413 my $comndr = "$ndr\_compressed";
414 my $alg = compression_alg($e, $l);
415 my $dlen = compression_dlen($e, $l, $env);
419 $self->pidl("struct ndr_push *$comndr;");
420 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));");
425 sub ParseCompressionPushEnd($$$$$)
427 my ($self,$e,$l,$ndr,$env) = @_;
428 my $comndr = "$ndr\_compressed";
429 my $alg = compression_alg($e, $l);
430 my $dlen = compression_dlen($e, $l, $env);
432 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));");
437 sub ParseCompressionPullStart($$$$$)
439 my ($self,$e,$l,$ndr,$env) = @_;
440 my $comndr = "$ndr\_compressed";
441 my $alg = compression_alg($e, $l);
442 my $dlen = compression_dlen($e, $l, $env);
446 $self->pidl("struct ndr_pull *$comndr;");
447 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));");
452 sub ParseCompressionPullEnd($$$$$)
454 my ($self,$e,$l,$ndr,$env) = @_;
455 my $comndr = "$ndr\_compressed";
456 my $alg = compression_alg($e, $l);
457 my $dlen = compression_dlen($e, $l, $env);
459 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
464 sub ParseSubcontextPushStart($$$$$)
466 my ($self,$e,$l,$ndr,$env) = @_;
467 my $subndr = "_ndr_$e->{NAME}";
468 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
472 $self->pidl("struct ndr_push *$subndr;");
473 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
475 if (defined $l->{COMPRESSION}) {
476 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
482 sub ParseSubcontextPushEnd($$$$$)
484 my ($self,$e,$l,$ndr,$env) = @_;
485 my $subndr = "_ndr_$e->{NAME}";
486 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
488 if (defined $l->{COMPRESSION}) {
489 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
492 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
497 sub ParseSubcontextPullStart($$$$$)
499 my ($self,$e,$l,$ndr,$env) = @_;
500 my $subndr = "_ndr_$e->{NAME}";
501 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
505 $self->pidl("struct ndr_pull *$subndr;");
506 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
508 if (defined $l->{COMPRESSION}) {
509 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
515 sub ParseSubcontextPullEnd($$$$$)
517 my ($self,$e,$l,$ndr,$env) = @_;
518 my $subndr = "_ndr_$e->{NAME}";
519 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
521 if (defined $l->{COMPRESSION}) {
522 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
525 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
530 sub ParseElementPushLevel
532 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
534 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
536 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
537 $var_name = get_pointer_to($var_name);
540 if (defined($ndr_flags)) {
541 if ($l->{TYPE} eq "SUBCONTEXT") {
542 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
543 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
544 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
545 } elsif ($l->{TYPE} eq "POINTER") {
546 $self->ParsePtrPush($e, $l, $ndr, $var_name);
547 } elsif ($l->{TYPE} eq "ARRAY") {
548 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
550 my $nl = GetNextLevel($e, $l);
552 # Allow speedups for arrays of scalar types
553 if (is_charset_array($e,$l)) {
554 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
556 } elsif (has_fast_array($e,$l)) {
557 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
560 } elsif ($l->{TYPE} eq "SWITCH") {
561 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
562 } elsif ($l->{TYPE} eq "DATA") {
563 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
564 } elsif ($l->{TYPE} eq "TYPEDEF") {
565 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
569 if ($l->{TYPE} eq "POINTER" and $deferred) {
570 if ($l->{POINTER_TYPE} ne "ref") {
571 $self->pidl("if ($var_name) {");
573 if ($l->{POINTER_TYPE} eq "relative") {
574 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2($ndr, $var_name));");
577 $var_name = get_value_of($var_name);
578 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
580 if ($l->{POINTER_TYPE} ne "ref") {
584 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
585 not is_charset_array($e, $l)) {
586 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
587 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
589 $var_name = get_array_element($var_name, $counter);
591 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
592 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
594 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
599 if ($deferred and ContainsDeferred($e, $l)) {
600 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
602 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
606 } elsif ($l->{TYPE} eq "SWITCH") {
607 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
611 #####################################################################
612 # parse scalars in a structure element
613 sub ParseElementPush($$$$$$)
615 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
618 my $var_name = $env->{$e->{NAME}};
620 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
622 # Representation type is different from transmit_as
623 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
626 my $transmit_name = "_transmit_$e->{NAME}";
627 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
628 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
629 $var_name = $transmit_name;
632 $var_name = append_prefix($e, $var_name);
634 $self->start_flags($e, $ndr);
636 if (defined(my $value = has_property($e, "value"))) {
637 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
640 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
642 $self->end_flags($e, $ndr);
644 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
650 #####################################################################
651 # parse a pointer in a struct element or function
652 sub ParsePtrPush($$$$$)
654 my ($self,$e,$l,$ndr,$var_name) = @_;
656 if ($l->{POINTER_TYPE} eq "ref") {
657 $self->pidl("if ($var_name == NULL) {");
659 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
662 if ($l->{LEVEL} eq "EMBEDDED") {
663 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
665 } elsif ($l->{POINTER_TYPE} eq "relative") {
666 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
667 } elsif ($l->{POINTER_TYPE} eq "unique") {
668 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
669 } elsif ($l->{POINTER_TYPE} eq "full") {
670 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
672 die("Unhandled pointer type $l->{POINTER_TYPE}");
676 sub need_pointer_to($$$)
678 my ($e, $l, $scalar_only) = @_;
681 if (ref($l->{DATA_TYPE})) {
682 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
684 $t = $l->{DATA_TYPE};
687 if (not Parse::Pidl::Typelist::is_scalar($t)) {
688 return 1 if $scalar_only;
693 foreach my $tl (@{$e->{LEVELS}}) {
695 if ($tl->{TYPE} eq "ARRAY") {
700 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
701 return 1 unless $arrays;
707 sub ParseDataPrint($$$$$)
709 my ($self, $e, $l, $ndr, $var_name) = @_;
711 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
713 if (need_pointer_to($e, $l, 1)) {
714 $var_name = get_pointer_to($var_name);
717 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
719 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
723 #####################################################################
724 # print scalars in a structure element
725 sub ParseElementPrint($$$$$)
727 my($self, $e, $ndr, $var_name, $env) = @_;
729 return if (has_property($e, "noprint"));
731 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
732 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
736 $var_name = append_prefix($e, $var_name);
738 if (defined(my $value = has_property($e, "value"))) {
739 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
742 foreach my $l (@{$e->{LEVELS}}) {
743 if ($l->{TYPE} eq "POINTER") {
744 $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
745 $self->pidl("$ndr->depth++;");
746 if ($l->{POINTER_TYPE} ne "ref") {
747 $self->pidl("if ($var_name) {");
750 $var_name = get_value_of($var_name);
751 } elsif ($l->{TYPE} eq "ARRAY") {
754 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
755 $var_name = get_pointer_to($var_name);
758 if ($l->{IS_ZERO_TERMINATED}) {
759 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
761 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
762 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
765 if (is_charset_array($e,$l)) {
766 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
768 } elsif (has_fast_array($e, $l)) {
769 my $nl = GetNextLevel($e, $l);
770 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
773 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
775 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
776 $self->pidl("$ndr->depth++;");
777 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
779 $self->pidl("char *idx_$l->{LEVEL_INDEX}=NULL;");
780 $self->pidl("if (asprintf(&idx_$l->{LEVEL_INDEX}, \"[\%d]\", $counter) != -1) {");
783 $var_name = get_array_element($var_name, $counter);
785 } elsif ($l->{TYPE} eq "DATA") {
786 $self->ParseDataPrint($e, $l, $ndr, $var_name);
787 } elsif ($l->{TYPE} eq "SWITCH") {
788 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
789 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
790 $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
794 foreach my $l (reverse @{$e->{LEVELS}}) {
795 if ($l->{TYPE} eq "POINTER") {
796 if ($l->{POINTER_TYPE} ne "ref") {
800 $self->pidl("$ndr->depth--;");
801 } elsif (($l->{TYPE} eq "ARRAY")
802 and not is_charset_array($e,$l)
803 and not has_fast_array($e,$l)) {
804 $self->pidl("free(idx_$l->{LEVEL_INDEX});");
809 $self->pidl("$ndr->depth--;");
814 #####################################################################
815 # parse scalars in a structure element - pull size
816 sub ParseSwitchPull($$$$$$)
818 my($self,$e,$l,$ndr,$var_name,$env) = @_;
819 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
820 check_null_pointer($e, $env, sub { $self->pidl(shift); },
821 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
822 check_fully_dereferenced($e, $env));
824 $var_name = get_pointer_to($var_name);
825 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
828 #####################################################################
829 # push switch element
830 sub ParseSwitchPush($$$$$$)
832 my($self,$e,$l,$ndr,$var_name,$env) = @_;
833 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
834 check_null_pointer($e, $env, sub { $self->pidl(shift); },
835 "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
836 check_fully_dereferenced($e, $env));
838 $var_name = get_pointer_to($var_name);
839 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
842 sub ParseDataPull($$$$$$$)
844 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
846 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
848 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
850 if (need_pointer_to($e, $l, 0)) {
851 $var_name = get_pointer_to($var_name);
854 $var_name = get_pointer_to($var_name);
856 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
858 if (my $range = has_property($e, "range")) {
859 $var_name = get_value_of($var_name);
860 my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
861 my ($low, $high) = split(/,/, $range, 2);
862 if ($low < 0 and not $signed) {
863 warning(0, "$low is invalid for the range of an unsigned type");
865 if ($low == 0 and not $signed) {
866 $self->pidl("if ($var_name > $high) {");
868 $self->pidl("if ($var_name < $low || $var_name > $high) {");
870 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
874 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
878 sub ParseDataPush($$$$$$$)
880 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
882 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
884 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
886 # strings are passed by value rather than reference
887 if (need_pointer_to($e, $l, 1)) {
888 $var_name = get_pointer_to($var_name);
891 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
893 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
897 sub CalcNdrFlags($$$)
899 my ($l,$primitives,$deferred) = @_;
904 # Add NDR_SCALARS if this one is deferred
905 # and deferreds may be pushed
906 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
908 # Add NDR_SCALARS if this one is not deferred and
909 # primitives may be pushed
910 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
912 # Add NDR_BUFFERS if this one contains deferred stuff
913 # and deferreds may be pushed
914 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
916 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
917 return "NDR_SCALARS" if ($scalars);
918 return "NDR_BUFFERS" if ($buffers);
922 sub ParseMemCtxPullFlags($$$$)
924 my ($self, $e, $l) = @_;
926 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
928 return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
929 return undef if has_fast_array($e, $l);
930 return undef if is_charset_array($e, $l);
934 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
935 my $nl = GetNextLevel($e, $l);
936 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
937 my $next_is_string = (($nl->{TYPE} eq "DATA") and
938 ($nl->{DATA_TYPE} eq "string"));
939 if ($next_is_array or $next_is_string) {
941 } elsif ($l->{LEVEL} eq "TOP") {
942 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
949 sub ParseMemCtxPullStart($$$$$)
951 my ($self, $e, $l, $ndr, $ptr_name) = @_;
953 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
954 my $mem_c_ctx = $ptr_name;
955 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
957 return unless defined($mem_c_flags);
959 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
960 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
963 sub ParseMemCtxPullEnd($$$$)
965 my ($self, $e, $l, $ndr) = @_;
967 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
968 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
970 return unless defined($mem_r_flags);
972 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
975 sub CheckStringTerminator($$$$$)
977 my ($self,$ndr,$e,$l,$length) = @_;
978 my $nl = GetNextLevel($e, $l);
980 # Make sure last element is zero!
981 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
984 sub ParseElementPullLevel
986 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
988 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
990 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
991 $var_name = get_pointer_to($var_name);
994 # Only pull something if there's actually something to be pulled
995 if (defined($ndr_flags)) {
996 if ($l->{TYPE} eq "SUBCONTEXT") {
997 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
998 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
999 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1000 } elsif ($l->{TYPE} eq "ARRAY") {
1001 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1003 my $nl = GetNextLevel($e, $l);
1005 if (is_charset_array($e,$l)) {
1006 if ($l->{IS_ZERO_TERMINATED}) {
1007 $self->CheckStringTerminator($ndr, $e, $l, $length);
1009 $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}));");
1011 } elsif (has_fast_array($e, $l)) {
1012 if ($l->{IS_ZERO_TERMINATED}) {
1013 $self->CheckStringTerminator($ndr,$e,$l,$length);
1015 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1018 } elsif ($l->{TYPE} eq "POINTER") {
1019 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1020 } elsif ($l->{TYPE} eq "SWITCH") {
1021 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1022 } elsif ($l->{TYPE} eq "DATA") {
1023 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1024 } elsif ($l->{TYPE} eq "TYPEDEF") {
1025 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1029 # add additional constructions
1030 if ($l->{TYPE} eq "POINTER" and $deferred) {
1031 if ($l->{POINTER_TYPE} ne "ref") {
1032 $self->pidl("if ($var_name) {");
1035 if ($l->{POINTER_TYPE} eq "relative") {
1036 $self->pidl("uint32_t _relative_save_offset;");
1037 $self->pidl("_relative_save_offset = $ndr->offset;");
1038 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1042 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1044 $var_name = get_value_of($var_name);
1045 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1047 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1049 if ($l->{POINTER_TYPE} ne "ref") {
1050 if ($l->{POINTER_TYPE} eq "relative") {
1051 $self->pidl("$ndr->offset = _relative_save_offset;");
1056 } elsif ($l->{TYPE} eq "ARRAY" and
1057 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1058 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1059 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1060 my $array_name = $var_name;
1062 $var_name = get_array_element($var_name, $counter);
1064 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1066 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1067 my $nl = GetNextLevel($e,$l);
1069 if ($l->{IS_ZERO_TERMINATED}) {
1070 $self->CheckStringTerminator($ndr,$e,$l,$length);
1073 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1075 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1080 if ($deferred and ContainsDeferred($e, $l)) {
1081 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1083 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1088 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1090 } elsif ($l->{TYPE} eq "SWITCH") {
1091 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1095 #####################################################################
1096 # parse scalars in a structure element - pull size
1097 sub ParseElementPull($$$$$$)
1099 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1101 my $var_name = $env->{$e->{NAME}};
1105 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1107 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1110 $represent_name = $var_name;
1111 $transmit_name = "_transmit_$e->{NAME}";
1112 $var_name = $transmit_name;
1113 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1116 $var_name = append_prefix($e, $var_name);
1118 $self->start_flags($e, $ndr);
1120 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1122 $self->end_flags($e, $ndr);
1124 # Representation type is different from transmit_as
1125 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1126 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1132 #####################################################################
1133 # parse a pointer in a struct element or function
1134 sub ParsePtrPull($$$$$)
1136 my($self, $e,$l,$ndr,$var_name) = @_;
1138 my $nl = GetNextLevel($e, $l);
1139 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1140 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1141 ($nl->{DATA_TYPE} eq "string"));
1143 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1145 if (!$next_is_array and !$next_is_string) {
1146 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1147 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1152 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1153 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1154 } elsif (($l->{POINTER_TYPE} eq "unique") or
1155 ($l->{POINTER_TYPE} eq "relative") or
1156 ($l->{POINTER_TYPE} eq "full")) {
1157 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1159 die("Unhandled pointer type $l->{POINTER_TYPE}");
1162 $self->pidl("if (_ptr_$e->{NAME}) {");
1165 # Don't do this for arrays, they're allocated at the actual level
1167 unless ($next_is_array or $next_is_string) {
1168 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1170 # FIXME: Yes, this is nasty.
1171 # We allocate an array twice
1172 # - once just to indicate that it's there,
1173 # - then the real allocation...
1174 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1177 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1178 if ($l->{POINTER_TYPE} eq "relative") {
1179 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1182 $self->pidl("} else {");
1183 $self->pidl("\t$var_name = NULL;");
1187 sub ParseStructPushPrimitives($$$$$)
1189 my ($self, $struct, $ndr, $varname, $env) = @_;
1191 # see if the structure contains a conformant array. If it
1192 # does, then it must be the last element of the structure, and
1193 # we need to push the conformant length early, as it fits on
1194 # the wire before the structure (and even before the structure
1196 if (defined($struct->{SURROUNDING_ELEMENT})) {
1197 my $e = $struct->{SURROUNDING_ELEMENT};
1199 if (defined($e->{LEVELS}[0]) and
1200 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1203 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1204 if (has_property($e, "charset")) {
1205 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1207 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1210 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1213 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $size));");
1215 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1219 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1221 if (defined($struct->{PROPERTIES}{relative_base})) {
1222 # set the current offset as base for relative pointers
1223 # and store it based on the toplevel struct/union
1224 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1227 $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1230 sub ParseStructPushDeferred($$$$)
1232 my ($self, $struct, $ndr, $varname, $env) = @_;
1233 if (defined($struct->{PROPERTIES}{relative_base})) {
1234 # retrieve the current offset as base for relative pointers
1235 # based on the toplevel struct/union
1236 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1238 $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1241 #####################################################################
1243 sub ParseStructPush($$$$)
1245 my ($self, $struct, $ndr, $varname) = @_;
1247 return unless defined($struct->{ELEMENTS});
1249 my $env = GenerateStructEnv($struct, $varname);
1251 EnvSubstituteValue($env, $struct);
1253 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1255 $self->start_flags($struct, $ndr);
1257 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1259 $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1263 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1265 $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1269 $self->end_flags($struct, $ndr);
1272 #####################################################################
1273 # generate a push function for an enum
1274 sub ParseEnumPush($$$$)
1276 my($self,$enum,$ndr,$varname) = @_;
1277 my($type_fn) = $enum->{BASE_TYPE};
1279 $self->start_flags($enum, $ndr);
1280 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1281 $self->end_flags($enum, $ndr);
1284 #####################################################################
1285 # generate a pull function for an enum
1286 sub ParseEnumPull($$$$)
1288 my($self,$enum,$ndr,$varname) = @_;
1289 my($type_fn) = $enum->{BASE_TYPE};
1290 my($type_v_decl) = mapTypeName($type_fn);
1292 $self->pidl("$type_v_decl v;");
1293 $self->start_flags($enum, $ndr);
1294 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1295 $self->pidl("*$varname = v;");
1297 $self->end_flags($enum, $ndr);
1300 #####################################################################
1301 # generate a print function for an enum
1302 sub ParseEnumPrint($$$$$)
1304 my($self,$enum,$ndr,$name,$varname) = @_;
1306 $self->pidl("const char *val = NULL;");
1309 $self->start_flags($enum, $ndr);
1311 $self->pidl("switch ($varname) {");
1313 my $els = \@{$enum->{ELEMENTS}};
1314 foreach my $i (0 .. $#{$els}) {
1315 my $e = ${$els}[$i];
1317 if ($e =~ /^(.*)=/) {
1320 $self->pidl("case $e: val = \"$e\"; break;");
1326 $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1328 $self->end_flags($enum, $ndr);
1333 my ($e,$t,$name,$varname) = @_;
1334 return "enum $name " .
1335 ($t eq "pull"?"*":"") . $varname;
1338 $typefamily{ENUM} = {
1340 PUSH_FN_BODY => \&ParseEnumPush,
1341 PULL_FN_BODY => \&ParseEnumPull,
1342 PRINT_FN_BODY => \&ParseEnumPrint,
1345 #####################################################################
1346 # generate a push function for a bitmap
1347 sub ParseBitmapPush($$$$)
1349 my($self,$bitmap,$ndr,$varname) = @_;
1350 my($type_fn) = $bitmap->{BASE_TYPE};
1352 $self->start_flags($bitmap, $ndr);
1354 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1356 $self->end_flags($bitmap, $ndr);
1359 #####################################################################
1360 # generate a pull function for an bitmap
1361 sub ParseBitmapPull($$$$)
1363 my($self,$bitmap,$ndr,$varname) = @_;
1364 my $type_fn = $bitmap->{BASE_TYPE};
1365 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1367 $self->pidl("$type_decl v;");
1368 $self->start_flags($bitmap, $ndr);
1369 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1370 $self->pidl("*$varname = v;");
1372 $self->end_flags($bitmap, $ndr);
1375 #####################################################################
1376 # generate a print function for an bitmap
1377 sub ParseBitmapPrintElement($$$$$$)
1379 my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1380 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1381 my($type_fn) = $bitmap->{BASE_TYPE};
1384 if ($e =~ /^(\w+) .*$/) {
1387 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1390 $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1393 #####################################################################
1394 # generate a print function for an bitmap
1395 sub ParseBitmapPrint($$$$$)
1397 my($self,$bitmap,$ndr,$name,$varname) = @_;
1398 my($type_decl) = mapTypeName($bitmap->{TYPE});
1399 my($type_fn) = $bitmap->{BASE_TYPE};
1401 $self->start_flags($bitmap, $ndr);
1403 $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1405 $self->pidl("$ndr->depth++;");
1406 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1407 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1409 $self->pidl("$ndr->depth--;");
1411 $self->end_flags($bitmap, $ndr);
1414 sub DeclBitmap($$$$)
1416 my ($e,$t,$name,$varname) = @_;
1417 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1418 ($t eq "pull"?" *":" ") . $varname;
1421 $typefamily{BITMAP} = {
1422 DECL => \&DeclBitmap,
1423 PUSH_FN_BODY => \&ParseBitmapPush,
1424 PULL_FN_BODY => \&ParseBitmapPull,
1425 PRINT_FN_BODY => \&ParseBitmapPrint,
1428 #####################################################################
1429 # generate a struct print function
1430 sub ParseStructPrint($$$$$)
1432 my($self,$struct,$ndr,$name,$varname) = @_;
1434 return unless defined $struct->{ELEMENTS};
1436 my $env = GenerateStructEnv($struct, $varname);
1438 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1440 $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1442 $self->start_flags($struct, $ndr);
1444 $self->pidl("$ndr->depth++;");
1446 $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1447 foreach (@{$struct->{ELEMENTS}});
1448 $self->pidl("$ndr->depth--;");
1450 $self->end_flags($struct, $ndr);
1453 sub DeclarePtrVariables($$)
1456 foreach my $l (@{$e->{LEVELS}}) {
1457 if ($l->{TYPE} eq "POINTER" and
1458 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1459 $self->pidl("uint32_t _ptr_$e->{NAME};");
1465 sub DeclareArrayVariables($$)
1469 foreach my $l (@{$e->{LEVELS}}) {
1470 next if has_fast_array($e,$l);
1471 next if is_charset_array($e,$l);
1472 if ($l->{TYPE} eq "ARRAY") {
1473 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1478 sub DeclareMemCtxVariables($$)
1481 foreach my $l (@{$e->{LEVELS}}) {
1482 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1483 if (defined($mem_flags)) {
1484 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1489 sub ParseStructPullPrimitives($$$$$)
1491 my($self,$struct,$ndr,$varname,$env) = @_;
1493 if (defined $struct->{SURROUNDING_ELEMENT}) {
1494 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1497 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1499 if (defined($struct->{PROPERTIES}{relative_base})) {
1500 # set the current offset as base for relative pointers
1501 # and store it based on the toplevel struct/union
1502 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1505 $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1507 $self->add_deferred();
1510 sub ParseStructPullDeferred($$$$$)
1512 my ($self,$struct,$ndr,$varname,$env) = @_;
1514 if (defined($struct->{PROPERTIES}{relative_base})) {
1515 # retrieve the current offset as base for relative pointers
1516 # based on the toplevel struct/union
1517 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1519 foreach my $e (@{$struct->{ELEMENTS}}) {
1520 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1523 $self->add_deferred();
1526 #####################################################################
1527 # parse a struct - pull side
1528 sub ParseStructPull($$$$)
1530 my($self,$struct,$ndr,$varname) = @_;
1532 return unless defined $struct->{ELEMENTS};
1534 # declare any internal pointers we need
1535 foreach my $e (@{$struct->{ELEMENTS}}) {
1536 $self->DeclarePtrVariables($e);
1537 $self->DeclareArrayVariables($e);
1538 $self->DeclareMemCtxVariables($e);
1541 $self->start_flags($struct, $ndr);
1543 my $env = GenerateStructEnv($struct, $varname);
1545 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1547 $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1550 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1552 $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1556 $self->end_flags($struct, $ndr);
1559 #####################################################################
1560 # calculate size of ndr struct
1561 sub ParseStructNdrSize($$$$)
1563 my ($self,$t, $name, $varname) = @_;
1566 if (my $flags = has_property($t, "flag")) {
1567 $self->pidl("flags |= $flags;");
1569 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name, ic);");
1572 sub DeclStruct($$$$)
1574 my ($e,$t,$name,$varname) = @_;
1575 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1578 sub ArgsStructNdrSize($$$)
1580 my ($d, $name, $varname) = @_;
1581 return "const struct $name *$varname, struct smb_iconv_convenience *ic, int flags";
1584 $typefamily{STRUCT} = {
1585 PUSH_FN_BODY => \&ParseStructPush,
1586 DECL => \&DeclStruct,
1587 PULL_FN_BODY => \&ParseStructPull,
1588 PRINT_FN_BODY => \&ParseStructPrint,
1589 SIZE_FN_BODY => \&ParseStructNdrSize,
1590 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1593 #####################################################################
1594 # calculate size of ndr struct
1595 sub ParseUnionNdrSize($$$)
1597 my ($self, $t, $name, $varname) = @_;
1600 if (my $flags = has_property($t, "flag")) {
1601 $self->pidl("flags |= $flags;");
1604 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name, ic);");
1607 sub ParseUnionPushPrimitives($$$$)
1609 my ($self, $e, $ndr ,$varname) = @_;
1611 my $have_default = 0;
1613 $self->pidl("int level = ndr_push_get_switch_value($ndr, $varname);");
1615 if (defined($e->{SWITCH_TYPE})) {
1616 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1619 $self->pidl("switch (level) {");
1621 foreach my $el (@{$e->{ELEMENTS}}) {
1622 if ($el->{CASE} eq "default") {
1625 $self->pidl("$el->{CASE}: {");
1627 if ($el->{TYPE} ne "EMPTY") {
1629 if (defined($e->{PROPERTIES}{relative_base})) {
1630 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1631 # set the current offset as base for relative pointers
1632 # and store it based on the toplevel struct/union
1633 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1635 $self->DeclareArrayVariables($el);
1636 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1639 $self->pidl("break; }");
1642 if (! $have_default) {
1643 $self->pidl("default:");
1644 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1650 sub ParseUnionPushDeferred($$$$)
1652 my ($self,$e,$ndr,$varname) = @_;
1654 my $have_default = 0;
1656 $self->pidl("int level = ndr_push_get_switch_value($ndr, $varname);");
1657 if (defined($e->{PROPERTIES}{relative_base})) {
1658 # retrieve the current offset as base for relative pointers
1659 # based on the toplevel struct/union
1660 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1662 $self->pidl("switch (level) {");
1664 foreach my $el (@{$e->{ELEMENTS}}) {
1665 if ($el->{CASE} eq "default") {
1669 $self->pidl("$el->{CASE}:");
1670 if ($el->{TYPE} ne "EMPTY") {
1672 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1675 $self->pidl("break;");
1678 if (! $have_default) {
1679 $self->pidl("default:");
1680 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1686 #####################################################################
1687 # parse a union - push side
1688 sub ParseUnionPush($$$$)
1690 my ($self,$e,$ndr,$varname) = @_;
1691 my $have_default = 0;
1693 $self->start_flags($e, $ndr);
1695 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1697 $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1700 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1702 $self->ParseUnionPushDeferred($e, $ndr, $varname);
1705 $self->end_flags($e, $ndr);
1708 #####################################################################
1710 sub ParseUnionPrint($$$$$)
1712 my ($self,$e,$ndr,$name,$varname) = @_;
1713 my $have_default = 0;
1715 $self->pidl("int level;");
1716 foreach my $el (@{$e->{ELEMENTS}}) {
1717 $self->DeclareArrayVariables($el);
1720 $self->start_flags($e, $ndr);
1722 $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1724 $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1726 $self->pidl("switch (level) {");
1728 foreach my $el (@{$e->{ELEMENTS}}) {
1729 if ($el->{CASE} eq "default") {
1732 $self->pidl("$el->{CASE}:");
1733 if ($el->{TYPE} ne "EMPTY") {
1735 $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1738 $self->pidl("break;");
1741 if (! $have_default) {
1742 $self->pidl("default:");
1743 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1748 $self->end_flags($e, $ndr);
1751 sub ParseUnionPullPrimitives($$$$$)
1753 my ($self,$e,$ndr,$varname,$switch_type) = @_;
1754 my $have_default = 0;
1756 if (defined($switch_type)) {
1757 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
1758 $self->pidl("if (_level != level) {");
1759 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname\", _level);");
1763 $self->pidl("switch (level) {");
1765 foreach my $el (@{$e->{ELEMENTS}}) {
1766 if ($el->{CASE} eq "default") {
1769 $self->pidl("$el->{CASE}: {");
1771 if ($el->{TYPE} ne "EMPTY") {
1773 $self->DeclarePtrVariables($el);
1774 $self->DeclareArrayVariables($el);
1775 if (defined($e->{PROPERTIES}{relative_base})) {
1776 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
1777 # set the current offset as base for relative pointers
1778 # and store it based on the toplevel struct/union
1779 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1781 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1784 $self->pidl("break; }");
1787 if (! $have_default) {
1788 $self->pidl("default:");
1789 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1795 sub ParseUnionPullDeferred($$$$)
1797 my ($self,$e,$ndr,$varname) = @_;
1798 my $have_default = 0;
1800 if (defined($e->{PROPERTIES}{relative_base})) {
1801 # retrieve the current offset as base for relative pointers
1802 # based on the toplevel struct/union
1803 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1805 $self->pidl("switch (level) {");
1807 foreach my $el (@{$e->{ELEMENTS}}) {
1808 if ($el->{CASE} eq "default") {
1812 $self->pidl("$el->{CASE}:");
1813 if ($el->{TYPE} ne "EMPTY") {
1815 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1818 $self->pidl("break;");
1821 if (! $have_default) {
1822 $self->pidl("default:");
1823 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1831 #####################################################################
1832 # parse a union - pull side
1833 sub ParseUnionPull($$$$)
1835 my ($self,$e,$ndr,$varname) = @_;
1836 my $switch_type = $e->{SWITCH_TYPE};
1838 $self->pidl("int level;");
1839 if (defined($switch_type)) {
1840 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1841 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1843 $self->pidl(mapTypeName($switch_type) . " _level;");
1846 my %double_cases = ();
1847 foreach my $el (@{$e->{ELEMENTS}}) {
1848 next if ($el->{TYPE} eq "EMPTY");
1849 next if ($double_cases{"$el->{NAME}"});
1850 $self->DeclareMemCtxVariables($el);
1851 $double_cases{"$el->{NAME}"} = 1;
1854 $self->start_flags($e, $ndr);
1856 $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
1858 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1860 $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
1864 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1866 $self->ParseUnionPullDeferred($e,$ndr,$varname);
1870 $self->add_deferred();
1872 $self->end_flags($e, $ndr);
1877 my ($e,$t,$name,$varname) = @_;
1878 return ($t ne "pull"?"const ":"") . "union $name *$varname";
1881 sub ArgsUnionNdrSize($$)
1884 return "const union $name *r, uint32_t level, struct smb_iconv_convenience *ic, int flags";
1887 $typefamily{UNION} = {
1888 PUSH_FN_BODY => \&ParseUnionPush,
1889 DECL => \&DeclUnion,
1890 PULL_FN_BODY => \&ParseUnionPull,
1891 PRINT_FN_BODY => \&ParseUnionPrint,
1892 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
1893 SIZE_FN_BODY => \&ParseUnionNdrSize,
1896 #####################################################################
1897 # parse a typedef - push side
1898 sub ParseTypedefPush($$$$)
1900 my($self,$e,$ndr,$varname) = @_;
1904 $env->{$e->{NAME}} = $varname;
1906 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
1909 #####################################################################
1910 # parse a typedef - pull side
1911 sub ParseTypedefPull($$$$)
1913 my($self,$e,$ndr,$varname) = @_;
1917 $env->{$e->{NAME}} = $varname;
1919 $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
1922 #####################################################################
1923 # parse a typedef - print side
1924 sub ParseTypedefPrint($$$$$)
1926 my($self,$e,$ndr,$name,$varname) = @_;
1928 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
1931 #####################################################################
1932 ## calculate the size of a structure
1933 sub ParseTypedefNdrSize($$$$)
1935 my($self,$t,$name,$varname) = @_;
1937 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
1940 sub DeclTypedef($$$$)
1942 my ($e, $t, $name, $varname) = @_;
1944 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
1947 sub ArgsTypedefNdrSize($$$)
1949 my ($d, $name, $varname) = @_;
1950 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
1953 $typefamily{TYPEDEF} = {
1954 PUSH_FN_BODY => \&ParseTypedefPush,
1955 DECL => \&DeclTypedef,
1956 PULL_FN_BODY => \&ParseTypedefPull,
1957 PRINT_FN_BODY => \&ParseTypedefPrint,
1958 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
1959 SIZE_FN_BODY => \&ParseTypedefNdrSize,
1962 #####################################################################
1963 # parse a function - print side
1964 sub ParseFunctionPrint($$)
1966 my($self, $fn) = @_;
1969 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
1971 return if has_property($fn, "noprint");
1973 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
1977 foreach my $e (@{$fn->{ELEMENTS}}) {
1978 $self->DeclareArrayVariables($e);
1981 $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
1982 $self->pidl("$ndr->depth++;");
1984 $self->pidl("if (flags & NDR_SET_VALUES) {");
1985 $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
1988 $self->pidl("if (flags & NDR_IN) {");
1990 $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
1991 $self->pidl("$ndr->depth++;");
1993 my $env = GenerateFunctionInEnv($fn);
1995 foreach my $e (@{$fn->{ELEMENTS}}) {
1996 if (grep(/in/,@{$e->{DIRECTION}})) {
1997 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2000 $self->pidl("$ndr->depth--;");
2004 $self->pidl("if (flags & NDR_OUT) {");
2006 $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2007 $self->pidl("$ndr->depth++;");
2009 $env = GenerateFunctionOutEnv($fn);
2010 foreach my $e (@{$fn->{ELEMENTS}}) {
2011 if (grep(/out/,@{$e->{DIRECTION}})) {
2012 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2015 if ($fn->{RETURN_TYPE}) {
2016 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2018 $self->pidl("$ndr->depth--;");
2022 $self->pidl("$ndr->depth--;");
2028 #####################################################################
2030 sub ParseFunctionPush($$)
2032 my($self, $fn) = @_;
2035 $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;
2037 return if has_property($fn, "nopush");
2042 foreach my $e (@{$fn->{ELEMENTS}}) {
2043 $self->DeclareArrayVariables($e);
2046 $self->pidl("if (flags & NDR_IN) {");
2049 my $env = GenerateFunctionInEnv($fn);
2051 EnvSubstituteValue($env, $fn);
2053 foreach my $e (@{$fn->{ELEMENTS}}) {
2054 if (grep(/in/,@{$e->{DIRECTION}})) {
2055 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2062 $self->pidl("if (flags & NDR_OUT) {");
2065 $env = GenerateFunctionOutEnv($fn);
2066 foreach my $e (@{$fn->{ELEMENTS}}) {
2067 if (grep(/out/,@{$e->{DIRECTION}})) {
2068 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2072 if ($fn->{RETURN_TYPE}) {
2073 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2078 $self->pidl("return NDR_ERR_SUCCESS;");
2084 sub AllocateArrayLevel($$$$$$)
2086 my ($self,$e,$l,$ndr,$var,$size) = @_;
2088 my $pl = GetPrevLevel($e, $l);
2089 if (defined($pl) and
2090 $pl->{TYPE} eq "POINTER" and
2091 $pl->{POINTER_TYPE} eq "ref"
2092 and not $l->{IS_ZERO_TERMINATED}) {
2093 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2094 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2096 if (grep(/in/,@{$e->{DIRECTION}}) and
2097 grep(/out/,@{$e->{DIRECTION}})) {
2098 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, $size * sizeof(*r->in.$e->{NAME}));");
2103 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2106 #####################################################################
2108 sub ParseFunctionPull($$)
2113 # pull function args
2114 $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;
2119 # declare any internal pointers we need
2120 foreach my $e (@{$fn->{ELEMENTS}}) {
2121 $self->DeclarePtrVariables($e);
2122 $self->DeclareArrayVariables($e);
2125 my %double_cases = ();
2126 foreach my $e (@{$fn->{ELEMENTS}}) {
2127 next if ($e->{TYPE} eq "EMPTY");
2128 next if ($double_cases{"$e->{NAME}"});
2129 $self->DeclareMemCtxVariables($e);
2130 $double_cases{"$e->{NAME}"} = 1;
2133 $self->pidl("if (flags & NDR_IN) {");
2136 # auto-init the out section of a structure. I originally argued that
2137 # this was a bad idea as it hides bugs, but coping correctly
2138 # with initialisation and not wiping ref vars is turning
2139 # out to be too tricky (tridge)
2140 foreach my $e (@{$fn->{ELEMENTS}}) {
2141 next unless grep(/out/, @{$e->{DIRECTION}});
2142 $self->pidl("ZERO_STRUCT(r->out);");
2147 my $env = GenerateFunctionInEnv($fn);
2149 foreach my $e (@{$fn->{ELEMENTS}}) {
2150 next unless (grep(/in/, @{$e->{DIRECTION}}));
2151 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2154 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2155 # own flag rather than be in NDR_IN ?
2157 foreach my $e (@{$fn->{ELEMENTS}}) {
2158 next unless (grep(/out/, @{$e->{DIRECTION}}));
2159 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2160 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2161 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2162 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2163 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2164 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2166 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2167 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2168 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2169 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2170 check_fully_dereferenced($e, $env));
2171 $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2173 if (grep(/in/, @{$e->{DIRECTION}})) {
2174 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2176 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2179 $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2181 if (grep(/in/, @{$e->{DIRECTION}})) {
2182 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2184 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2189 $self->add_deferred();
2193 $self->pidl("if (flags & NDR_OUT) {");
2196 $env = GenerateFunctionOutEnv($fn);
2197 foreach my $e (@{$fn->{ELEMENTS}}) {
2198 next unless grep(/out/, @{$e->{DIRECTION}});
2199 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2202 if ($fn->{RETURN_TYPE}) {
2203 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2206 $self->add_deferred();
2210 $self->pidl("return NDR_ERR_SUCCESS;");
2216 sub AuthServiceStruct($$$)
2218 my ($self, $ifacename, $authservice) = @_;
2219 my @a = split /,/, $authservice;
2220 my $authservice_count = $#a + 1;
2222 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2223 foreach my $ap (@a) {
2224 $self->pidl("\t$ap, ");
2229 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2230 $self->pidl("\t.count\t= $authservice_count,");
2231 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2236 sub FunctionCallEntry($$)
2238 my ($self, $d) = @_;
2239 return 0 if not defined($d->{OPNUM});
2241 $self->pidl("\t\t\"$d->{NAME}\",");
2242 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2243 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2244 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2245 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2246 $self->pidl("\t\t".($d->{ASYNC}?"true":"false").",");
2247 $self->pidl("\t},");
2251 #####################################################################
2252 # produce a function call table
2253 sub FunctionTable($$)
2255 my($self,$interface) = @_;
2257 my $uname = uc $interface->{NAME};
2259 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2260 return unless defined ($interface->{PROPERTIES}->{uuid});
2262 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2264 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2265 $count += $self->FunctionCallEntry($d);
2267 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL, false }");
2271 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2272 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2273 $self->pidl("\t$ep, ");
2275 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2280 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2281 $self->pidl("\t.count\t= $endpoint_count,");
2282 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2286 if (! defined $interface->{PROPERTIES}->{authservice}) {
2287 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2290 $self->AuthServiceStruct($interface->{NAME},
2291 $interface->{PROPERTIES}->{authservice});
2293 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2294 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2295 $self->pidl("\t.syntax_id\t= {");
2296 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2297 $self->pidl("\t\tNDR_$uname\_VERSION");
2298 $self->pidl("\t},");
2299 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2300 $self->pidl("\t.num_calls\t= $count,");
2301 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2302 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2303 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2309 #####################################################################
2310 # generate include statements for imported idl files
2315 foreach (@imports) {
2316 $_ = unmake_str($_);
2318 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2322 #####################################################################
2323 # generate include statements for included header files
2328 foreach (@includes) {
2329 $self->pidl_hdr("#include $_");
2333 #####################################################################
2334 # generate prototypes and defines for the interface definitions
2335 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2336 # NDR parser and so do not belong here, technically speaking
2337 sub HeaderInterface($$$)
2339 my($self,$interface,$needed) = @_;
2343 if ($needed->{"compression"}) {
2344 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2347 if (has_property($interface, "object")) {
2348 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2351 if (defined $interface->{PROPERTIES}->{helper}) {
2352 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2355 if (defined $interface->{PROPERTIES}->{uuid}) {
2356 my $name = uc $interface->{NAME};
2357 $self->pidl_hdr("#define NDR_$name\_UUID " .
2358 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid})));
2360 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2361 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{PROPERTIES}->{version}");
2363 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2365 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2366 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2368 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2371 foreach (@{$interface->{FUNCTIONS}}) {
2372 next if has_property($_, "noopnum");
2373 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2374 my $u_name = uc $_->{NAME};
2376 my $val = sprintf("0x%02x", $count);
2377 if (defined($interface->{BASE})) {
2378 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2381 $self->pidl_hdr("#define NDR_$u_name ($val)");
2383 $self->pidl_hdr("");
2389 if (defined($interface->{BASE})) {
2390 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2393 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2397 sub ParseTypePush($$$$$$)
2399 my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2401 # save the old relative_base_offset
2402 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2403 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2404 # restore the old relative_base_offset
2405 $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2408 sub ParseTypePushFunction($$$)
2410 my ($self, $e, $varname) = @_;
2413 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2415 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2419 $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2420 $self->pidl("return NDR_ERR_SUCCESS;");
2426 sub ParseTypePull($$$$$$)
2428 my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2430 # save the old relative_base_offset
2431 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2432 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2433 # restore the old relative_base_offset
2434 $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2437 sub ParseTypePullFunction($$)
2439 my ($self, $e, $varname) = @_;
2442 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2444 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2448 $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2449 $self->pidl("return NDR_ERR_SUCCESS;");
2455 sub ParseTypePrint($$$$)
2457 my ($self, $e, $ndr, $varname) = @_;
2459 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2462 sub ParseTypePrintFunction($$$)
2464 my ($self, $e, $varname) = @_;
2467 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2469 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2471 return if (has_property($e, "noprint"));
2473 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2476 $self->ParseTypePrint($e, $ndr, $varname);
2482 sub ParseTypeNdrSize($$)
2487 my $tf = $typefamily{$t->{TYPE}};
2488 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2490 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2494 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2500 #####################################################################
2501 # parse the interface definitions
2502 sub ParseInterface($$$)
2504 my($self,$interface,$needed) = @_;
2506 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2507 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2509 $self->pidl_hdr("");
2511 $self->HeaderInterface($interface, $needed);
2514 foreach my $d (@{$interface->{TYPES}}) {
2515 next unless(typeHasBody($d));
2517 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2518 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2519 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2521 # Make sure we don't generate a function twice...
2522 $needed->{TypeFunctionName("ndr_push", $d)} =
2523 $needed->{TypeFunctionName("ndr_pull", $d)} =
2524 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2526 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2530 foreach my $d (@{$interface->{FUNCTIONS}}) {
2531 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2532 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2533 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2535 # Make sure we don't generate a function twice...
2536 $needed->{"ndr_push_$d->{NAME}"} = $needed->{"ndr_pull_$d->{NAME}"} =
2537 $needed->{"ndr_print_$d->{NAME}"} = 0;
2540 $self->FunctionTable($interface);
2542 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2545 sub GenerateIncludes($)
2549 $self->pidl("#include \"includes.h\"");
2551 $self->pidl("#ifndef _GNU_SOURCE");
2552 $self->pidl("#define _GNU_SOURCE");
2553 $self->pidl("#endif");
2554 $self->pidl("#include <stdint.h>");
2555 $self->pidl("#include <stdlib.h>");
2556 $self->pidl("#include <stdio.h>");
2557 $self->pidl("#include <stdbool.h>");
2558 $self->pidl("#include <stdarg.h>");
2559 $self->pidl("#include <string.h>");
2563 #####################################################################
2564 # parse a parsed IDL structure back into an IDL file
2567 my($self, $ndr,$gen_header,$ndr_header) = @_;
2569 $self->pidl_hdr("/* header auto-generated by pidl */");
2570 $self->pidl_hdr("");
2571 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2572 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2573 $self->pidl_hdr("");
2575 $self->pidl("/* parser auto-generated by pidl */");
2577 $self->GenerateIncludes();
2578 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2584 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2588 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2589 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2590 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2593 return ($self->{res_hdr}, $self->{res});
2596 sub NeededElement($$$)
2598 my ($e, $dir, $needed) = @_;
2600 return if ($e->{TYPE} eq "EMPTY");
2602 return if (ref($e->{TYPE}) eq "HASH" and
2603 not defined($e->{TYPE}->{NAME}));
2606 if (ref($e->{TYPE}) eq "HASH") {
2607 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2612 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2613 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2615 $rt = $e->{REPRESENTATION_TYPE};
2618 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2621 if ($dir eq "print") {
2622 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2623 } elsif ($dir eq "pull") {
2624 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2625 push (@fn, "ndr_$t\_to_$rt")
2627 } elsif ($dir eq "push") {
2628 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2629 push (@fn, "ndr_$rt\_to_$t")
2632 die("invalid direction `$dir'");
2636 unless (defined($needed->{$_})) {
2642 sub NeededFunction($$)
2644 my ($fn,$needed) = @_;
2645 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
2646 $needed->{"ndr_push_$fn->{NAME}"} = 1;
2647 $needed->{"ndr_print_$fn->{NAME}"} = 1;
2648 foreach my $e (@{$fn->{ELEMENTS}}) {
2650 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
2656 sub NeededType($$$);
2657 my ($t,$needed,$req) = @_;
2659 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
2661 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
2662 return unless defined($t->{ELEMENTS});
2663 for my $e (@{$t->{ELEMENTS}}) {
2665 if (has_property($e, "compression")) {
2666 $needed->{"compression"} = 1;
2668 NeededElement($e, $req, $needed);
2669 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
2674 #####################################################################
2675 # work out what parse functions are needed
2676 sub NeededInterface($$)
2678 my ($interface,$needed) = @_;
2679 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
2680 foreach (reverse @{$interface->{TYPES}}) {
2681 if (has_property($_, "public")) {
2682 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
2683 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
2686 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
2687 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
2688 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
2689 if (has_property($_, "gensize")) {
2690 $needed->{"ndr_size_$_->{NAME}"} = 1;
2695 sub TypeFunctionName($$)
2697 my ($prefix, $t) = @_;
2699 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
2700 $t->{TYPE} eq "TYPEDEF");
2701 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
2702 return "$prefix\_$t";