pidl/NDR/Parser: also do range checks on the array size
[Samba.git] / pidl / lib / Parse / Pidl / Samba4 / NDR / Parser.pm
blob3676d6d077dcd83383cb67afffb8104cb2b3e1c3
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;
10 require Exporter;
11 @ISA = qw(Exporter);
12 @EXPORT_OK = qw(check_null_pointer NeededFunction NeededElement NeededType $res NeededInterface TypeFunctionName ParseElementPrint);
14 use strict;
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 ContainsPipe 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);
24 $VERSION = '0.01';
26 # list of known types
27 my %typefamily;
29 sub new($$) {
30 my ($class) = @_;
31 my $self = { res => "", res_hdr => "", deferred => [], tabs => "", defer_tabs => "" };
32 bless($self, $class);
35 sub get_typefamily($)
37 my $n = shift;
38 return $typefamily{$n};
41 sub append_prefix($$)
43 my ($e, $var_name) = @_;
44 my $pointers = 0;
45 my $arrays = 0;
47 foreach my $l (@{$e->{LEVELS}}) {
48 if ($l->{TYPE} eq "POINTER") {
49 $pointers++;
50 } elsif ($l->{TYPE} eq "ARRAY") {
51 $arrays++;
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);
64 return $var_name;
67 sub has_fast_array($$)
69 my ($e,$l) = @_;
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
86 sub pidl($$)
88 my ($self, $d) = @_;
89 if ($d) {
90 $self->{res} .= $self->{tabs};
91 $self->{res} .= $d;
93 $self->{res} .="\n";
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); }
107 sub defer($$)
109 my ($self, $d) = @_;
110 if ($d) {
111 push(@{$self->{deferred}}, $self->{defer_tabs}.$d);
115 ########################################
116 # add the deferred content to the current
117 # output
118 sub add_deferred($)
120 my ($self) = @_;
121 $self->pidl($_) foreach (@{$self->{deferred}});
122 $self->{deferred} = [];
123 $self->{defer_tabs} = "";
126 sub indent($)
128 my ($self) = @_;
129 $self->{tabs} .= "\t";
132 sub deindent($)
134 my ($self) = @_;
135 $self->{tabs} = substr($self->{tabs}, 0, -1);
138 #####################################################################
139 # declare a function public or static, depending on its attributes
140 sub fn_declare($$$$)
142 my ($self,$type,$fn,$decl) = @_;
144 if (has_property($fn, "no$type")) {
145 $self->pidl_hdr("$decl;");
146 return 0;
149 if (has_property($fn, "public")) {
150 $self->pidl_hdr("$decl;");
151 $self->pidl("_PUBLIC_ $decl");
152 } else {
153 $self->pidl("static $decl");
156 return 1;
159 ###################################################################
160 # setup any special flags for an element or structure
161 sub start_flags($$$)
163 my ($self, $e, $ndr) = @_;
164 my $flags = has_property($e, "flag");
165 if (defined $flags) {
166 $self->pidl("{");
167 $self->indent;
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
175 sub end_flags($$$)
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};");
181 $self->deindent;
182 $self->pidl("}");
186 #####################################################################
187 # parse the data of an array - push side
188 sub ParseArrayPushHeader($$$$$$)
190 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
192 my $size;
193 my $length;
195 if ($l->{IS_ZERO_TERMINATED}) {
196 if (has_property($e, "charset")) {
197 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
198 } else {
199 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
201 } else {
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));");
215 return $length;
218 sub check_fully_dereferenced($$)
220 my ($element, $env) = @_;
222 return sub ($) {
223 my $origvar = shift;
224 my $check = 0;
226 # Figure out the number of pointers in $ptr
227 my $expandedvar = $origvar;
228 $expandedvar =~ s/^(\**)//;
229 my $ptr = $1;
231 my $var = undef;
232 foreach (keys %$env) {
233 if ($env->{$_} eq $expandedvar) {
234 $var = $_;
235 last;
239 return($origvar) unless (defined($var));
240 my $e;
241 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
242 if ($_->{NAME} eq $var) {
243 $e = $_;
244 last;
248 $e or die("Environment doesn't match siblings");
250 # See if pointer at pointer level $level
251 # needs to be checked.
252 my $nump = 0;
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));
259 return ($origvar);
263 sub check_null_pointer($$$$)
265 my ($element, $env, $print_fn, $return) = @_;
267 return sub ($) {
268 my $expandedvar = shift;
269 my $check = 0;
271 # Figure out the number of pointers in $ptr
272 $expandedvar =~ s/^(\**)//;
273 my $ptr = $1;
275 my $var = undef;
276 foreach (keys %$env) {
277 if ($env->{$_} eq $expandedvar) {
278 $var = $_;
279 last;
283 if (defined($var)) {
284 my $e;
285 # lookup ptr in $e
286 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
287 if ($_->{NAME} eq $var) {
288 $e = $_;
289 last;
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");
302 last;
305 if ($l->{TYPE} eq "DATA") {
306 warning($element, "too much dereferences for `$var'");
309 } else {
310 warning($element, "unknown dereferenced expression `$expandedvar'");
311 $check = 1;
314 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
318 sub ParseArrayPullGetSize($$$$$$)
320 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
322 my $size;
324 if ($l->{IS_CONFORMANT}) {
325 $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
326 } elsif ($l->{IS_ZERO_TERMINATED} and $l->{SIZE_IS} == 0 and $l->{LENGTH_IS} == 0) { # Noheader arrays
327 $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
328 } else {
329 $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
330 check_null_pointer($e, $env, sub { $self->pidl(shift); },
331 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
332 check_fully_dereferenced($e, $env));
335 $self->pidl("size_$e->{NAME}_$l->{LEVEL_INDEX} = $size;");
336 my $array_size = "size_$e->{NAME}_$l->{LEVEL_INDEX}";
338 if (my $range = has_property($e, "range")) {
339 my ($low, $high) = split(/,/, $range, 2);
340 if ($low < 0) {
341 warning(0, "$low is invalid for the range of an array size");
343 if ($low == 0) {
344 $self->pidl("if ($array_size > $high) {");
345 } else {
346 $self->pidl("if ($array_size < $low || $array_size > $high) {");
348 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
349 $self->pidl("}");
352 return $array_size;
355 #####################################################################
356 # parse an array - pull side
357 sub ParseArrayPullGetLength($$$$$$;$)
359 my ($self,$e,$l,$ndr,$var_name,$env,$array_size) = @_;
361 if (not defined($array_size)) {
362 $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
365 if (not $l->{IS_VARYING}) {
366 return $array_size;
369 my $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
370 $self->pidl("length_$e->{NAME}_$l->{LEVEL_INDEX} = $length;");
371 my $array_length = "length_$e->{NAME}_$l->{LEVEL_INDEX}";
373 if (my $range = has_property($e, "range")) {
374 my ($low, $high) = split(/,/, $range, 2);
375 if ($low < 0) {
376 warning(0, "$low is invalid for the range of an array size");
378 if ($low == 0) {
379 $self->pidl("if ($array_length > $high) {");
380 } else {
381 $self->pidl("if ($array_length < $low || $array_length > $high) {");
383 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
384 $self->pidl("}");
387 return $array_length;
390 #####################################################################
391 # parse an array - pull side
392 sub ParseArrayPullHeader($$$$$$)
394 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
396 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
397 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, " . get_pointer_to($var_name) . "));");
400 if ($l->{IS_VARYING}) {
401 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
404 my $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
405 my $array_length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env, $array_size);
407 if ($array_length ne $array_size) {
408 $self->pidl("if ($array_length > $array_size) {");
409 $self->indent;
410 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $array_size, $array_length);");
411 $self->deindent;
412 $self->pidl("}");
415 if ($l->{IS_CONFORMANT} and not $l->{IS_ZERO_TERMINATED}) {
416 $self->defer("if ($var_name) {");
417 $self->defer_indent;
418 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
419 check_null_pointer($e, $env, sub { $self->defer(shift); },
420 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
421 check_fully_dereferenced($e, $env));
422 $self->defer("NDR_CHECK(ndr_check_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
423 $self->defer_deindent;
424 $self->defer("}");
427 if ($l->{IS_VARYING} and not $l->{IS_ZERO_TERMINATED}) {
428 $self->defer("if ($var_name) {");
429 $self->defer_indent;
430 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
431 check_null_pointer($e, $env, sub { $self->defer(shift); },
432 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
433 check_fully_dereferenced($e, $env));
434 $self->defer("NDR_CHECK(ndr_check_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
435 $self->defer_deindent;
436 $self->defer("}");
439 if (ArrayDynamicallyAllocated($e,$l) and not is_charset_array($e,$l)) {
440 $self->AllocateArrayLevel($e,$l,$ndr,$var_name,$array_size);
443 return $array_length;
446 sub compression_alg($$)
448 my ($e, $l) = @_;
449 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
451 return $alg;
454 sub compression_clen($$$)
456 my ($e, $l, $env) = @_;
457 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
459 return ParseExpr($clen, $env, $e->{ORIGINAL});
462 sub compression_dlen($$$)
464 my ($e,$l,$env) = @_;
465 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
467 return ParseExpr($dlen, $env, $e->{ORIGINAL});
470 sub ParseCompressionPushStart($$$$$)
472 my ($self,$e,$l,$ndr,$env) = @_;
473 my $comndr = "$ndr\_compressed";
474 my $alg = compression_alg($e, $l);
475 my $dlen = compression_dlen($e, $l, $env);
477 $self->pidl("{");
478 $self->indent;
479 $self->pidl("struct ndr_push *$comndr;");
480 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));");
482 return $comndr;
485 sub ParseCompressionPushEnd($$$$$)
487 my ($self,$e,$l,$ndr,$env) = @_;
488 my $comndr = "$ndr\_compressed";
489 my $alg = compression_alg($e, $l);
490 my $dlen = compression_dlen($e, $l, $env);
492 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));");
493 $self->deindent;
494 $self->pidl("}");
497 sub ParseCompressionPullStart($$$$$)
499 my ($self,$e,$l,$ndr,$env) = @_;
500 my $comndr = "$ndr\_compressed";
501 my $alg = compression_alg($e, $l);
502 my $dlen = compression_dlen($e, $l, $env);
504 $self->pidl("{");
505 $self->indent;
506 $self->pidl("struct ndr_pull *$comndr;");
507 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));");
509 return $comndr;
512 sub ParseCompressionPullEnd($$$$$)
514 my ($self,$e,$l,$ndr,$env) = @_;
515 my $comndr = "$ndr\_compressed";
516 my $alg = compression_alg($e, $l);
517 my $dlen = compression_dlen($e, $l, $env);
519 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
520 $self->deindent;
521 $self->pidl("}");
524 sub ParseSubcontextPushStart($$$$$)
526 my ($self,$e,$l,$ndr,$env) = @_;
527 my $subndr = "_ndr_$e->{NAME}";
528 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
530 $self->pidl("{");
531 $self->indent;
532 $self->pidl("struct ndr_push *$subndr;");
533 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
535 if (defined $l->{COMPRESSION}) {
536 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
539 return $subndr;
542 sub ParseSubcontextPushEnd($$$$$)
544 my ($self,$e,$l,$ndr,$env) = @_;
545 my $subndr = "_ndr_$e->{NAME}";
546 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
548 if (defined $l->{COMPRESSION}) {
549 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
552 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
553 $self->deindent;
554 $self->pidl("}");
557 sub ParseSubcontextPullStart($$$$$)
559 my ($self,$e,$l,$ndr,$env) = @_;
560 my $subndr = "_ndr_$e->{NAME}";
561 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
563 $self->pidl("{");
564 $self->indent;
565 $self->pidl("struct ndr_pull *$subndr;");
566 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
568 if (defined $l->{COMPRESSION}) {
569 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
572 return $subndr;
575 sub ParseSubcontextPullEnd($$$$$)
577 my ($self,$e,$l,$ndr,$env) = @_;
578 my $subndr = "_ndr_$e->{NAME}";
579 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
581 if (defined $l->{COMPRESSION}) {
582 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
585 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
586 $self->deindent;
587 $self->pidl("}");
590 sub ParseElementPushLevel
592 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
594 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
596 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
597 $var_name = get_pointer_to($var_name);
600 if (defined($ndr_flags)) {
601 if ($l->{TYPE} eq "SUBCONTEXT") {
602 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
603 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
604 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
605 } elsif ($l->{TYPE} eq "POINTER") {
606 $self->ParsePtrPush($e, $l, $ndr, $var_name);
607 } elsif ($l->{TYPE} eq "ARRAY") {
608 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
610 my $nl = GetNextLevel($e, $l);
612 # Allow speedups for arrays of scalar types
613 if (is_charset_array($e,$l)) {
614 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
615 return;
616 } elsif (has_fast_array($e,$l)) {
617 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
618 return;
620 } elsif ($l->{TYPE} eq "SWITCH") {
621 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
622 } elsif ($l->{TYPE} eq "DATA") {
623 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
624 } elsif ($l->{TYPE} eq "TYPEDEF") {
625 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
629 if ($l->{TYPE} eq "POINTER" and $deferred) {
630 my $rel_var_name = $var_name;
631 if ($l->{POINTER_TYPE} ne "ref") {
632 $self->pidl("if ($var_name) {");
633 $self->indent;
634 if ($l->{POINTER_TYPE} eq "relative") {
635 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_start($ndr, $rel_var_name));");
637 if ($l->{POINTER_TYPE} eq "relative_short") {
638 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr2($ndr, $var_name));");
641 $var_name = get_value_of($var_name);
642 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
644 if ($l->{POINTER_TYPE} ne "ref") {
645 if ($l->{POINTER_TYPE} eq "relative") {
646 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_end($ndr, $rel_var_name));");
648 $self->deindent;
649 $self->pidl("}");
651 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
652 not is_charset_array($e, $l)) {
653 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
654 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
656 my $array_pointless = ($length eq "0");
658 if ($array_pointless) {
659 warning($e->{ORIGINAL}, "pointless array `$e->{NAME}' will always have size 0");
662 $var_name = get_array_element($var_name, $counter);
664 if ((($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) and not $array_pointless) {
665 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
666 $self->indent;
667 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
668 $self->deindent;
669 $self->pidl("}");
672 if ($deferred and ContainsDeferred($e, $l) and not $array_pointless) {
673 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
674 $self->indent;
675 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
676 $self->deindent;
677 $self->pidl("}");
679 } elsif ($l->{TYPE} eq "SWITCH") {
680 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
684 #####################################################################
685 # parse scalars in a structure element
686 sub ParseElementPush($$$$$$)
688 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
689 my $subndr = undef;
691 my $var_name = $env->{$e->{NAME}};
693 return if ContainsPipe($e, $e->{LEVELS}[0]);
695 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
697 # Representation type is different from transmit_as
698 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
699 $self->pidl("{");
700 $self->indent;
701 my $transmit_name = "_transmit_$e->{NAME}";
702 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
703 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
704 $var_name = $transmit_name;
707 $var_name = append_prefix($e, $var_name);
709 $self->start_flags($e, $ndr);
711 if (defined(my $value = has_property($e, "value"))) {
712 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
715 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
717 $self->end_flags($e, $ndr);
719 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
720 $self->deindent;
721 $self->pidl("}");
725 #####################################################################
726 # parse a pointer in a struct element or function
727 sub ParsePtrPush($$$$$)
729 my ($self,$e,$l,$ndr,$var_name) = @_;
731 if ($l->{POINTER_TYPE} eq "ref") {
732 $self->pidl("if ($var_name == NULL) {");
733 $self->indent;
734 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
735 $self->deindent;
736 $self->pidl("}");
737 if ($l->{LEVEL} eq "EMBEDDED") {
738 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
740 } elsif ($l->{POINTER_TYPE} eq "relative") {
741 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
742 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
743 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr1($ndr, $var_name));");
744 } elsif ($l->{POINTER_TYPE} eq "unique") {
745 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
746 } elsif ($l->{POINTER_TYPE} eq "full") {
747 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
748 } else {
749 die("Unhandled pointer type $l->{POINTER_TYPE}");
753 sub need_pointer_to($$$)
755 my ($e, $l, $scalar_only) = @_;
757 my $t;
758 if (ref($l->{DATA_TYPE})) {
759 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
760 } else {
761 $t = $l->{DATA_TYPE};
764 if (not Parse::Pidl::Typelist::is_scalar($t)) {
765 return 1 if $scalar_only;
768 my $arrays = 0;
770 foreach my $tl (@{$e->{LEVELS}}) {
771 last if $l == $tl;
772 if ($tl->{TYPE} eq "ARRAY") {
773 $arrays++;
777 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
778 return 1 unless $arrays;
781 return 0;
784 sub ParseDataPrint($$$$$)
786 my ($self, $e, $l, $ndr, $var_name) = @_;
788 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
790 if (need_pointer_to($e, $l, 1)) {
791 $var_name = get_pointer_to($var_name);
794 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
795 } else {
796 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
800 #####################################################################
801 # print scalars in a structure element
802 sub ParseElementPrint($$$$$)
804 my($self, $e, $ndr, $var_name, $env) = @_;
806 return if (has_property($e, "noprint"));
808 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
809 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
810 return;
813 $var_name = append_prefix($e, $var_name);
815 if (defined(my $value = has_property($e, "value"))) {
816 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
819 foreach my $l (@{$e->{LEVELS}}) {
820 if ($l->{TYPE} eq "POINTER") {
821 $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
822 $self->pidl("$ndr->depth++;");
823 if ($l->{POINTER_TYPE} ne "ref") {
824 $self->pidl("if ($var_name) {");
825 $self->indent;
827 $var_name = get_value_of($var_name);
828 } elsif ($l->{TYPE} eq "ARRAY") {
829 my $length;
831 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
832 $var_name = get_pointer_to($var_name);
835 if ($l->{IS_ZERO_TERMINATED}) {
836 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
837 } else {
838 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
839 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
842 if (is_charset_array($e,$l)) {
843 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
844 last;
845 } elsif (has_fast_array($e, $l)) {
846 my $nl = GetNextLevel($e, $l);
847 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
848 last;
849 } else {
850 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
852 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
853 $self->pidl("$ndr->depth++;");
854 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
855 $self->indent;
857 $var_name = get_array_element($var_name, $counter);
859 } elsif ($l->{TYPE} eq "DATA") {
860 $self->ParseDataPrint($e, $l, $ndr, $var_name);
861 } elsif ($l->{TYPE} eq "SWITCH") {
862 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
863 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
864 $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
868 foreach my $l (reverse @{$e->{LEVELS}}) {
869 if ($l->{TYPE} eq "POINTER") {
870 if ($l->{POINTER_TYPE} ne "ref") {
871 $self->deindent;
872 $self->pidl("}");
874 $self->pidl("$ndr->depth--;");
875 } elsif (($l->{TYPE} eq "ARRAY")
876 and not is_charset_array($e,$l)
877 and not has_fast_array($e,$l)) {
878 $self->deindent;
879 $self->pidl("}");
880 $self->pidl("$ndr->depth--;");
885 #####################################################################
886 # parse scalars in a structure element - pull size
887 sub ParseSwitchPull($$$$$$)
889 my($self,$e,$l,$ndr,$var_name,$env) = @_;
890 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
891 check_null_pointer($e, $env, sub { $self->pidl(shift); },
892 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
893 check_fully_dereferenced($e, $env));
895 $var_name = get_pointer_to($var_name);
896 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
899 #####################################################################
900 # push switch element
901 sub ParseSwitchPush($$$$$$)
903 my($self,$e,$l,$ndr,$var_name,$env) = @_;
904 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
905 check_null_pointer($e, $env, sub { $self->pidl(shift); },
906 "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
907 check_fully_dereferenced($e, $env));
909 $var_name = get_pointer_to($var_name);
910 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
913 sub ParseDataPull($$$$$$$)
915 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
917 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
919 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
921 if (need_pointer_to($e, $l, 0)) {
922 $var_name = get_pointer_to($var_name);
925 $var_name = get_pointer_to($var_name);
927 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
929 my $pl = GetPrevLevel($e, $l);
931 my $range = has_property($e, "range");
932 if ($range and $pl->{TYPE} ne "ARRAY") {
933 $var_name = get_value_of($var_name);
934 my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
935 my ($low, $high) = split(/,/, $range, 2);
936 if ($low < 0 and not $signed) {
937 warning(0, "$low is invalid for the range of an unsigned type");
939 if ($low == 0 and not $signed) {
940 $self->pidl("if ($var_name > $high) {");
941 } else {
942 $self->pidl("if ($var_name < $low || $var_name > $high) {");
944 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
945 $self->pidl("}");
947 } else {
948 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
952 sub ParseDataPush($$$$$$$)
954 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
956 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
958 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
960 # strings are passed by value rather than reference
961 if (need_pointer_to($e, $l, 1)) {
962 $var_name = get_pointer_to($var_name);
965 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
966 } else {
967 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
971 sub CalcNdrFlags($$$)
973 my ($l,$primitives,$deferred) = @_;
975 my $scalars = 0;
976 my $buffers = 0;
978 # Add NDR_SCALARS if this one is deferred
979 # and deferreds may be pushed
980 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
982 # Add NDR_SCALARS if this one is not deferred and
983 # primitives may be pushed
984 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
986 # Add NDR_BUFFERS if this one contains deferred stuff
987 # and deferreds may be pushed
988 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
990 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
991 return "NDR_SCALARS" if ($scalars);
992 return "NDR_BUFFERS" if ($buffers);
993 return undef;
996 sub ParseMemCtxPullFlags($$$$)
998 my ($self, $e, $l) = @_;
1000 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
1002 return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
1003 return undef if has_fast_array($e, $l);
1004 return undef if is_charset_array($e, $l);
1006 my $mem_flags = "0";
1008 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
1009 my $nl = GetNextLevel($e, $l);
1010 return undef if ($nl->{TYPE} eq "PIPE");
1011 return undef if ($nl->{TYPE} eq "ARRAY");
1012 return undef if (($nl->{TYPE} eq "DATA") and ($nl->{DATA_TYPE} eq "string"));
1014 if ($l->{LEVEL} eq "TOP") {
1015 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
1019 return $mem_flags;
1022 sub ParseMemCtxPullStart($$$$$)
1024 my ($self, $e, $l, $ndr, $ptr_name) = @_;
1026 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1027 my $mem_c_ctx = $ptr_name;
1028 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
1030 return unless defined($mem_c_flags);
1032 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
1033 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
1036 sub ParseMemCtxPullEnd($$$$)
1038 my ($self, $e, $l, $ndr) = @_;
1040 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1041 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
1043 return unless defined($mem_r_flags);
1045 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
1048 sub CheckStringTerminator($$$$$)
1050 my ($self,$ndr,$e,$l,$length) = @_;
1051 my $nl = GetNextLevel($e, $l);
1053 # Make sure last element is zero!
1054 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
1057 sub ParseElementPullLevel
1059 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1061 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1062 my $array_length = undef;
1064 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1065 $var_name = get_pointer_to($var_name);
1068 # Only pull something if there's actually something to be pulled
1069 if (defined($ndr_flags)) {
1070 if ($l->{TYPE} eq "SUBCONTEXT") {
1071 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1072 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1073 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1074 } elsif ($l->{TYPE} eq "ARRAY") {
1075 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1076 $array_length = $length;
1078 my $nl = GetNextLevel($e, $l);
1080 if (is_charset_array($e,$l)) {
1081 if ($l->{IS_ZERO_TERMINATED}) {
1082 $self->CheckStringTerminator($ndr, $e, $l, $length);
1084 if ($l->{IS_TO_NULL}) {
1085 $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}));");
1086 } else {
1087 $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}));");
1089 return;
1090 } elsif (has_fast_array($e, $l)) {
1091 if ($l->{IS_ZERO_TERMINATED}) {
1092 $self->CheckStringTerminator($ndr,$e,$l,$length);
1094 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1095 return;
1097 } elsif ($l->{TYPE} eq "POINTER") {
1098 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1099 } elsif ($l->{TYPE} eq "SWITCH") {
1100 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1101 } elsif ($l->{TYPE} eq "DATA") {
1102 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1103 } elsif ($l->{TYPE} eq "TYPEDEF") {
1104 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1108 # add additional constructions
1109 if ($l->{TYPE} eq "POINTER" and $deferred) {
1110 if ($l->{POINTER_TYPE} ne "ref") {
1111 $self->pidl("if ($var_name) {");
1112 $self->indent;
1114 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1115 $self->pidl("uint32_t _relative_save_offset;");
1116 $self->pidl("_relative_save_offset = $ndr->offset;");
1117 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1121 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1123 $var_name = get_value_of($var_name);
1124 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1126 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1128 if ($l->{POINTER_TYPE} ne "ref") {
1129 if ($l->{POINTER_TYPE} eq "relative") {
1130 $self->pidl("if ($ndr->offset > $ndr->relative_highest_offset) {");
1131 $self->indent;
1132 $self->pidl("$ndr->relative_highest_offset = $ndr->offset;");
1133 $self->deindent;
1134 $self->pidl("}");
1135 $self->pidl("$ndr->offset = _relative_save_offset;");
1137 $self->deindent;
1138 $self->pidl("}");
1140 } elsif ($l->{TYPE} eq "ARRAY" and
1141 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1142 my $length = $array_length;
1143 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1144 my $array_name = $var_name;
1146 if (not defined($length)) {
1147 $length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env);
1150 $var_name = get_array_element($var_name, $counter);
1152 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1154 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1155 my $nl = GetNextLevel($e,$l);
1157 if ($l->{IS_ZERO_TERMINATED}) {
1158 $self->CheckStringTerminator($ndr,$e,$l,$length);
1161 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1162 $self->indent;
1163 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1164 $self->deindent;
1165 $self->pidl("}");
1168 if ($deferred and ContainsDeferred($e, $l)) {
1169 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1170 $self->indent;
1171 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1172 $self->deindent;
1173 $self->pidl("}");
1176 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1178 } elsif ($l->{TYPE} eq "SWITCH") {
1179 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1183 #####################################################################
1184 # parse scalars in a structure element - pull size
1185 sub ParseElementPull($$$$$$)
1187 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1189 my $var_name = $env->{$e->{NAME}};
1190 my $represent_name;
1191 my $transmit_name;
1193 return if ContainsPipe($e, $e->{LEVELS}[0]);
1195 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1197 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1198 $self->pidl("{");
1199 $self->indent;
1200 $represent_name = $var_name;
1201 $transmit_name = "_transmit_$e->{NAME}";
1202 $var_name = $transmit_name;
1203 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1206 $var_name = append_prefix($e, $var_name);
1208 $self->start_flags($e, $ndr);
1210 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1212 $self->end_flags($e, $ndr);
1214 # Representation type is different from transmit_as
1215 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1216 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1217 $self->deindent;
1218 $self->pidl("}");
1222 #####################################################################
1223 # parse a pointer in a struct element or function
1224 sub ParsePtrPull($$$$$)
1226 my($self, $e,$l,$ndr,$var_name) = @_;
1228 my $nl = GetNextLevel($e, $l);
1229 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1230 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1231 ($nl->{DATA_TYPE} eq "string"));
1233 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1235 if (!$next_is_array and !$next_is_string) {
1236 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1237 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1238 $self->pidl("}");
1241 return;
1242 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1243 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1244 } elsif (($l->{POINTER_TYPE} eq "unique") or
1245 ($l->{POINTER_TYPE} eq "relative") or
1246 ($l->{POINTER_TYPE} eq "full")) {
1247 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1248 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
1249 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr_short($ndr, &_ptr_$e->{NAME}));");
1250 } else {
1251 die("Unhandled pointer type $l->{POINTER_TYPE}");
1254 $self->pidl("if (_ptr_$e->{NAME}) {");
1255 $self->indent;
1257 # Don't do this for arrays, they're allocated at the actual level
1258 # of the array
1259 unless ($next_is_array or $next_is_string) {
1260 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1261 } else {
1262 # FIXME: Yes, this is nasty.
1263 # We allocate an array twice
1264 # - once just to indicate that it's there,
1265 # - then the real allocation...
1266 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1269 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1270 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1271 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1273 $self->deindent;
1274 $self->pidl("} else {");
1275 $self->pidl("\t$var_name = NULL;");
1276 $self->pidl("}");
1279 sub ParseStructPushPrimitives($$$$$)
1281 my ($self, $struct, $ndr, $varname, $env) = @_;
1283 # see if the structure contains a conformant array. If it
1284 # does, then it must be the last element of the structure, and
1285 # we need to push the conformant length early, as it fits on
1286 # the wire before the structure (and even before the structure
1287 # alignment)
1288 if (defined($struct->{SURROUNDING_ELEMENT})) {
1289 my $e = $struct->{SURROUNDING_ELEMENT};
1291 if (defined($e->{LEVELS}[0]) and
1292 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1293 my $size;
1295 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1296 if (has_property($e, "charset")) {
1297 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1298 } else {
1299 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1301 } else {
1302 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1305 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
1306 } else {
1307 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1311 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1313 if (defined($struct->{PROPERTIES}{relative_base})) {
1314 # set the current offset as base for relative pointers
1315 # and store it based on the toplevel struct/union
1316 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1319 $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1321 $self->pidl("NDR_CHECK(ndr_push_trailer_align($ndr, $struct->{ALIGN}));");
1324 sub ParseStructPushDeferred($$$$)
1326 my ($self, $struct, $ndr, $varname, $env) = @_;
1327 if (defined($struct->{PROPERTIES}{relative_base})) {
1328 # retrieve the current offset as base for relative pointers
1329 # based on the toplevel struct/union
1330 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1332 $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1335 #####################################################################
1336 # parse a struct
1337 sub ParseStructPush($$$$)
1339 my ($self, $struct, $ndr, $varname) = @_;
1341 return unless defined($struct->{ELEMENTS});
1343 my $env = GenerateStructEnv($struct, $varname);
1345 EnvSubstituteValue($env, $struct);
1347 $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1349 $self->start_flags($struct, $ndr);
1351 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1352 $self->indent;
1353 $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1354 $self->deindent;
1355 $self->pidl("}");
1357 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1358 $self->indent;
1359 $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1360 $self->deindent;
1361 $self->pidl("}");
1363 $self->end_flags($struct, $ndr);
1366 #####################################################################
1367 # generate a push function for an enum
1368 sub ParseEnumPush($$$$)
1370 my($self,$enum,$ndr,$varname) = @_;
1371 my($type_fn) = $enum->{BASE_TYPE};
1373 $self->start_flags($enum, $ndr);
1374 $self->pidl("NDR_CHECK(ndr_push_enum_$type_fn($ndr, NDR_SCALARS, $varname));");
1375 $self->end_flags($enum, $ndr);
1378 #####################################################################
1379 # generate a pull function for an enum
1380 sub ParseEnumPull($$$$)
1382 my($self,$enum,$ndr,$varname) = @_;
1383 my($type_fn) = $enum->{BASE_TYPE};
1384 my($type_v_decl) = mapTypeName($type_fn);
1386 $self->pidl("$type_v_decl v;");
1387 $self->start_flags($enum, $ndr);
1388 $self->pidl("NDR_CHECK(ndr_pull_enum_$type_fn($ndr, NDR_SCALARS, &v));");
1389 $self->pidl("*$varname = v;");
1391 $self->end_flags($enum, $ndr);
1394 #####################################################################
1395 # generate a print function for an enum
1396 sub ParseEnumPrint($$$$$)
1398 my($self,$enum,$ndr,$name,$varname) = @_;
1400 $self->pidl("const char *val = NULL;");
1401 $self->pidl("");
1403 $self->start_flags($enum, $ndr);
1405 $self->pidl("switch ($varname) {");
1406 $self->indent;
1407 my $els = \@{$enum->{ELEMENTS}};
1408 foreach my $i (0 .. $#{$els}) {
1409 my $e = ${$els}[$i];
1410 chomp $e;
1411 if ($e =~ /^(.*)=/) {
1412 $e = $1;
1414 $self->pidl("case $e: val = \"$e\"; break;");
1417 $self->deindent;
1418 $self->pidl("}");
1420 $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1422 $self->end_flags($enum, $ndr);
1425 sub DeclEnum($$$$)
1427 my ($e,$t,$name,$varname) = @_;
1428 return "enum $name " .
1429 ($t eq "pull"?"*":"") . $varname;
1432 $typefamily{ENUM} = {
1433 DECL => \&DeclEnum,
1434 PUSH_FN_BODY => \&ParseEnumPush,
1435 PULL_FN_BODY => \&ParseEnumPull,
1436 PRINT_FN_BODY => \&ParseEnumPrint,
1439 #####################################################################
1440 # generate a push function for a bitmap
1441 sub ParseBitmapPush($$$$)
1443 my($self,$bitmap,$ndr,$varname) = @_;
1444 my($type_fn) = $bitmap->{BASE_TYPE};
1446 $self->start_flags($bitmap, $ndr);
1448 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1450 $self->end_flags($bitmap, $ndr);
1453 #####################################################################
1454 # generate a pull function for an bitmap
1455 sub ParseBitmapPull($$$$)
1457 my($self,$bitmap,$ndr,$varname) = @_;
1458 my $type_fn = $bitmap->{BASE_TYPE};
1459 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1461 $self->pidl("$type_decl v;");
1462 $self->start_flags($bitmap, $ndr);
1463 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1464 $self->pidl("*$varname = v;");
1466 $self->end_flags($bitmap, $ndr);
1469 #####################################################################
1470 # generate a print function for an bitmap
1471 sub ParseBitmapPrintElement($$$$$$)
1473 my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1474 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1475 my($type_fn) = $bitmap->{BASE_TYPE};
1476 my($flag);
1478 if ($e =~ /^(\w+) .*$/) {
1479 $flag = "$1";
1480 } else {
1481 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1484 $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1487 #####################################################################
1488 # generate a print function for an bitmap
1489 sub ParseBitmapPrint($$$$$)
1491 my($self,$bitmap,$ndr,$name,$varname) = @_;
1492 my($type_decl) = mapTypeName($bitmap->{TYPE});
1493 my($type_fn) = $bitmap->{BASE_TYPE};
1495 $self->start_flags($bitmap, $ndr);
1497 $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1499 $self->pidl("$ndr->depth++;");
1500 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1501 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1503 $self->pidl("$ndr->depth--;");
1505 $self->end_flags($bitmap, $ndr);
1508 sub DeclBitmap($$$$)
1510 my ($e,$t,$name,$varname) = @_;
1511 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1512 ($t eq "pull"?" *":" ") . $varname;
1515 $typefamily{BITMAP} = {
1516 DECL => \&DeclBitmap,
1517 PUSH_FN_BODY => \&ParseBitmapPush,
1518 PULL_FN_BODY => \&ParseBitmapPull,
1519 PRINT_FN_BODY => \&ParseBitmapPrint,
1522 #####################################################################
1523 # generate a struct print function
1524 sub ParseStructPrint($$$$$)
1526 my($self,$struct,$ndr,$name,$varname) = @_;
1528 return unless defined $struct->{ELEMENTS};
1530 my $env = GenerateStructEnv($struct, $varname);
1532 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1534 $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1535 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
1537 $self->start_flags($struct, $ndr);
1539 $self->pidl("$ndr->depth++;");
1541 $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1542 foreach (@{$struct->{ELEMENTS}});
1543 $self->pidl("$ndr->depth--;");
1545 $self->end_flags($struct, $ndr);
1548 sub DeclarePtrVariables($$)
1550 my ($self,$e) = @_;
1551 foreach my $l (@{$e->{LEVELS}}) {
1552 my $size = 32;
1553 if ($l->{TYPE} eq "POINTER" and
1554 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1555 if ($l->{POINTER_TYPE} eq "relative_short") {
1556 $size = 16;
1558 $self->pidl("uint${size}_t _ptr_$e->{NAME};");
1559 last;
1564 sub DeclareArrayVariables($$;$)
1566 my ($self,$e,$pull) = @_;
1568 foreach my $l (@{$e->{LEVELS}}) {
1569 next if ($l->{TYPE} ne "ARRAY");
1570 if (defined($pull)) {
1571 $self->pidl("uint32_t size_$e->{NAME}_$l->{LEVEL_INDEX} = 0;");
1572 if ($l->{IS_VARYING}) {
1573 $self->pidl("uint32_t length_$e->{NAME}_$l->{LEVEL_INDEX} = 0;");
1576 next if has_fast_array($e,$l);
1577 next if is_charset_array($e,$l);
1578 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1582 sub DeclareArrayVariablesNoZero($$$)
1584 my ($self,$e,$env) = @_;
1586 foreach my $l (@{$e->{LEVELS}}) {
1587 next if ($l->{TYPE} ne "ARRAY");
1588 next if has_fast_array($e,$l);
1589 next if is_charset_array($e,$l);
1590 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1591 if ($length eq "0") {
1592 warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1593 } else {
1594 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1599 sub DeclareMemCtxVariables($$)
1601 my ($self,$e) = @_;
1602 foreach my $l (@{$e->{LEVELS}}) {
1603 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1604 if (defined($mem_flags)) {
1605 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1610 sub ParseStructPullPrimitives($$$$$)
1612 my($self,$struct,$ndr,$varname,$env) = @_;
1614 if (defined $struct->{SURROUNDING_ELEMENT}) {
1615 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1618 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1620 if (defined($struct->{PROPERTIES}{relative_base})) {
1621 # set the current offset as base for relative pointers
1622 # and store it based on the toplevel struct/union
1623 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1626 $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1628 $self->add_deferred();
1630 $self->pidl("NDR_CHECK(ndr_pull_trailer_align($ndr, $struct->{ALIGN}));");
1633 sub ParseStructPullDeferred($$$$$)
1635 my ($self,$struct,$ndr,$varname,$env) = @_;
1637 if (defined($struct->{PROPERTIES}{relative_base})) {
1638 # retrieve the current offset as base for relative pointers
1639 # based on the toplevel struct/union
1640 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1642 foreach my $e (@{$struct->{ELEMENTS}}) {
1643 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1646 $self->add_deferred();
1649 #####################################################################
1650 # parse a struct - pull side
1651 sub ParseStructPull($$$$)
1653 my($self,$struct,$ndr,$varname) = @_;
1655 return unless defined $struct->{ELEMENTS};
1657 # declare any internal pointers we need
1658 foreach my $e (@{$struct->{ELEMENTS}}) {
1659 $self->DeclarePtrVariables($e);
1660 $self->DeclareArrayVariables($e, "pull");
1661 $self->DeclareMemCtxVariables($e);
1664 $self->start_flags($struct, $ndr);
1666 my $env = GenerateStructEnv($struct, $varname);
1668 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1669 $self->indent;
1670 $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1671 $self->deindent;
1672 $self->pidl("}");
1673 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1674 $self->indent;
1675 $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1676 $self->deindent;
1677 $self->pidl("}");
1679 $self->end_flags($struct, $ndr);
1682 #####################################################################
1683 # calculate size of ndr struct
1684 sub ParseStructNdrSize($$$$)
1686 my ($self,$t, $name, $varname) = @_;
1687 my $sizevar;
1689 if (my $flags = has_property($t, "flag")) {
1690 $self->pidl("flags |= $flags;");
1692 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1695 sub DeclStruct($$$$)
1697 my ($e,$t,$name,$varname) = @_;
1698 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1701 sub ArgsStructNdrSize($$$)
1703 my ($d, $name, $varname) = @_;
1704 return "const struct $name *$varname, int flags";
1707 $typefamily{STRUCT} = {
1708 PUSH_FN_BODY => \&ParseStructPush,
1709 DECL => \&DeclStruct,
1710 PULL_FN_BODY => \&ParseStructPull,
1711 PRINT_FN_BODY => \&ParseStructPrint,
1712 SIZE_FN_BODY => \&ParseStructNdrSize,
1713 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1716 #####################################################################
1717 # calculate size of ndr struct
1718 sub ParseUnionNdrSize($$$)
1720 my ($self, $t, $name, $varname) = @_;
1721 my $sizevar;
1723 if (my $flags = has_property($t, "flag")) {
1724 $self->pidl("flags |= $flags;");
1727 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1730 sub ParseUnionPushPrimitives($$$$)
1732 my ($self, $e, $ndr ,$varname) = @_;
1734 my $have_default = 0;
1736 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1738 if (defined($e->{SWITCH_TYPE})) {
1739 if (defined($e->{ALIGN})) {
1740 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1743 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1746 if (defined($e->{ALIGN})) {
1747 if ($e->{IS_MS_UNION}) {
1748 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1749 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $e->{ALIGN}));");
1750 } else {
1751 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1755 $self->pidl("switch (level) {");
1756 $self->indent;
1757 foreach my $el (@{$e->{ELEMENTS}}) {
1758 if ($el->{CASE} eq "default") {
1759 $have_default = 1;
1761 $self->pidl("$el->{CASE}: {");
1763 if ($el->{TYPE} ne "EMPTY") {
1764 $self->indent;
1765 if (defined($e->{PROPERTIES}{relative_base})) {
1766 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1767 # set the current offset as base for relative pointers
1768 # and store it based on the toplevel struct/union
1769 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1771 $self->DeclareArrayVariables($el);
1772 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1773 $self->deindent;
1775 $self->pidl("break; }");
1776 $self->pidl("");
1778 if (! $have_default) {
1779 $self->pidl("default:");
1780 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1782 $self->deindent;
1783 $self->pidl("}");
1786 sub ParseUnionPushDeferred($$$$)
1788 my ($self,$e,$ndr,$varname) = @_;
1790 my $have_default = 0;
1792 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1793 if (defined($e->{PROPERTIES}{relative_base})) {
1794 # retrieve the current offset as base for relative pointers
1795 # based on the toplevel struct/union
1796 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1798 $self->pidl("switch (level) {");
1799 $self->indent;
1800 foreach my $el (@{$e->{ELEMENTS}}) {
1801 if ($el->{CASE} eq "default") {
1802 $have_default = 1;
1805 $self->pidl("$el->{CASE}:");
1806 if ($el->{TYPE} ne "EMPTY") {
1807 $self->indent;
1808 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1809 $self->deindent;
1811 $self->pidl("break;");
1812 $self->pidl("");
1814 if (! $have_default) {
1815 $self->pidl("default:");
1816 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1818 $self->deindent;
1819 $self->pidl("}");
1822 #####################################################################
1823 # parse a union - push side
1824 sub ParseUnionPush($$$$)
1826 my ($self,$e,$ndr,$varname) = @_;
1827 my $have_default = 0;
1829 $self->start_flags($e, $ndr);
1831 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1832 $self->indent;
1833 $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1834 $self->deindent;
1835 $self->pidl("}");
1836 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1837 $self->indent;
1838 $self->ParseUnionPushDeferred($e, $ndr, $varname);
1839 $self->deindent;
1840 $self->pidl("}");
1841 $self->end_flags($e, $ndr);
1844 #####################################################################
1845 # print a union
1846 sub ParseUnionPrint($$$$$)
1848 my ($self,$e,$ndr,$name,$varname) = @_;
1849 my $have_default = 0;
1851 $self->pidl("uint32_t level;");
1852 foreach my $el (@{$e->{ELEMENTS}}) {
1853 $self->DeclareArrayVariables($el);
1856 $self->start_flags($e, $ndr);
1858 $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1860 $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1862 $self->pidl("switch (level) {");
1863 $self->indent;
1864 foreach my $el (@{$e->{ELEMENTS}}) {
1865 if ($el->{CASE} eq "default") {
1866 $have_default = 1;
1868 $self->pidl("$el->{CASE}:");
1869 if ($el->{TYPE} ne "EMPTY") {
1870 $self->indent;
1871 $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1872 $self->deindent;
1874 $self->pidl("break;");
1875 $self->pidl("");
1877 if (! $have_default) {
1878 $self->pidl("default:");
1879 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1881 $self->deindent;
1882 $self->pidl("}");
1884 $self->end_flags($e, $ndr);
1887 sub ParseUnionPullPrimitives($$$$$)
1889 my ($self,$e,$ndr,$varname,$switch_type) = @_;
1890 my $have_default = 0;
1893 if (defined($switch_type)) {
1894 if (defined($e->{ALIGN})) {
1895 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1898 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
1899 $self->pidl("if (_level != level) {");
1900 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname at \%s\", _level, __location__);");
1901 $self->pidl("}");
1904 if (defined($e->{ALIGN})) {
1905 if ($e->{IS_MS_UNION}) {
1906 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1907 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $e->{ALIGN}));");
1908 } else {
1909 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1913 $self->pidl("switch (level) {");
1914 $self->indent;
1915 foreach my $el (@{$e->{ELEMENTS}}) {
1916 if ($el->{CASE} eq "default") {
1917 $have_default = 1;
1919 $self->pidl("$el->{CASE}: {");
1921 if ($el->{TYPE} ne "EMPTY") {
1922 $self->indent;
1923 if (defined($e->{PROPERTIES}{relative_base})) {
1924 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
1925 # set the current offset as base for relative pointers
1926 # and store it based on the toplevel struct/union
1927 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1929 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1930 $self->deindent;
1932 $self->pidl("break; }");
1933 $self->pidl("");
1935 if (! $have_default) {
1936 $self->pidl("default:");
1937 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1939 $self->deindent;
1940 $self->pidl("}");
1943 sub ParseUnionPullDeferred($$$$)
1945 my ($self,$e,$ndr,$varname) = @_;
1946 my $have_default = 0;
1948 if (defined($e->{PROPERTIES}{relative_base})) {
1949 # retrieve the current offset as base for relative pointers
1950 # based on the toplevel struct/union
1951 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1953 $self->pidl("switch (level) {");
1954 $self->indent;
1955 foreach my $el (@{$e->{ELEMENTS}}) {
1956 if ($el->{CASE} eq "default") {
1957 $have_default = 1;
1960 $self->pidl("$el->{CASE}:");
1961 if ($el->{TYPE} ne "EMPTY") {
1962 $self->indent;
1963 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1964 $self->deindent;
1966 $self->pidl("break;");
1967 $self->pidl("");
1969 if (! $have_default) {
1970 $self->pidl("default:");
1971 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1973 $self->deindent;
1974 $self->pidl("}");
1979 #####################################################################
1980 # parse a union - pull side
1981 sub ParseUnionPull($$$$)
1983 my ($self,$e,$ndr,$varname) = @_;
1984 my $switch_type = $e->{SWITCH_TYPE};
1986 $self->pidl("uint32_t level;");
1987 if (defined($switch_type)) {
1988 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1989 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1991 $self->pidl(mapTypeName($switch_type) . " _level;");
1994 my %double_cases = ();
1995 foreach my $el (@{$e->{ELEMENTS}}) {
1996 next if ($el->{TYPE} eq "EMPTY");
1997 next if ($double_cases{"$el->{NAME}"});
1998 $self->DeclareMemCtxVariables($el);
1999 $self->DeclarePtrVariables($el);
2000 $self->DeclareArrayVariables($el, "pull");
2001 $double_cases{"$el->{NAME}"} = 1;
2004 $self->start_flags($e, $ndr);
2006 $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
2008 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
2009 $self->indent;
2010 $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
2011 $self->deindent;
2012 $self->pidl("}");
2014 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
2015 $self->indent;
2016 $self->ParseUnionPullDeferred($e,$ndr,$varname);
2017 $self->deindent;
2018 $self->pidl("}");
2020 $self->add_deferred();
2022 $self->end_flags($e, $ndr);
2025 sub DeclUnion($$$$)
2027 my ($e,$t,$name,$varname) = @_;
2028 return ($t ne "pull"?"const ":"") . "union $name *$varname";
2031 sub ArgsUnionNdrSize($$)
2033 my ($d,$name) = @_;
2034 return "const union $name *r, uint32_t level, int flags";
2037 $typefamily{UNION} = {
2038 PUSH_FN_BODY => \&ParseUnionPush,
2039 DECL => \&DeclUnion,
2040 PULL_FN_BODY => \&ParseUnionPull,
2041 PRINT_FN_BODY => \&ParseUnionPrint,
2042 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
2043 SIZE_FN_BODY => \&ParseUnionNdrSize,
2046 #####################################################################
2047 # parse a typedef - push side
2048 sub ParseTypedefPush($$$$)
2050 my($self,$e,$ndr,$varname) = @_;
2052 my $env;
2054 $env->{$e->{NAME}} = $varname;
2056 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2059 #####################################################################
2060 # parse a typedef - pull side
2061 sub ParseTypedefPull($$$$)
2063 my($self,$e,$ndr,$varname) = @_;
2065 my $env;
2067 $env->{$e->{NAME}} = $varname;
2069 $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2072 #####################################################################
2073 # parse a typedef - print side
2074 sub ParseTypedefPrint($$$$$)
2076 my($self,$e,$ndr,$name,$varname) = @_;
2078 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
2081 #####################################################################
2082 ## calculate the size of a structure
2083 sub ParseTypedefNdrSize($$$$)
2085 my($self,$t,$name,$varname) = @_;
2087 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
2090 sub DeclTypedef($$$$)
2092 my ($e, $t, $name, $varname) = @_;
2094 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2097 sub ArgsTypedefNdrSize($$$)
2099 my ($d, $name, $varname) = @_;
2100 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2103 $typefamily{TYPEDEF} = {
2104 PUSH_FN_BODY => \&ParseTypedefPush,
2105 DECL => \&DeclTypedef,
2106 PULL_FN_BODY => \&ParseTypedefPull,
2107 PRINT_FN_BODY => \&ParseTypedefPrint,
2108 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2109 SIZE_FN_BODY => \&ParseTypedefNdrSize,
2112 sub ParsePipePushChunk($$)
2114 my ($self, $t) = @_;
2116 my $pipe = $t;
2117 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2118 my $struct = $pipe->{DATA};
2120 my $name = "$struct->{NAME}";
2121 my $ndr = "ndr";
2122 my $varname = "r";
2124 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "push", $name, $varname);
2126 $self->fn_declare("push", $struct, "enum ndr_err_code ndr_push_$name(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2128 return if has_property($t, "nopush");
2130 $self->pidl("{");
2131 $self->indent;
2133 $self->ParseStructPush($struct, $ndr, $varname);
2134 $self->pidl("");
2136 $self->pidl("NDR_CHECK(ndr_push_pipe_chunk_trailer(ndr, ndr_flags, $varname->count));");
2137 $self->pidl("");
2139 $self->pidl("return NDR_ERR_SUCCESS;");
2140 $self->deindent;
2141 $self->pidl("}");
2142 $self->pidl("");
2145 sub ParsePipePullChunk($$)
2147 my ($self, $t) = @_;
2149 my $pipe = $t;
2150 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2151 my $struct = $pipe->{DATA};
2153 my $name = "$struct->{NAME}";
2154 my $ndr = "ndr";
2155 my $varname = "r";
2157 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "pull", $name, $varname);
2159 $self->fn_declare("pull", $struct, "enum ndr_err_code ndr_pull_$name(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2161 return if has_property($struct, "nopull");
2163 $self->pidl("{");
2164 $self->indent;
2166 $self->ParseStructPull($struct, $ndr, $varname);
2167 $self->pidl("");
2169 $self->pidl("NDR_CHECK(ndr_check_pipe_chunk_trailer($ndr, ndr_flags, $varname->count));");
2170 $self->pidl("");
2172 $self->pidl("return NDR_ERR_SUCCESS;");
2173 $self->deindent;
2174 $self->pidl("}");
2175 $self->pidl("");
2178 sub ParsePipePrintChunk($$)
2180 my ($self, $t) = @_;
2182 my $pipe = $t;
2183 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2184 my $struct = $pipe->{DATA};
2186 my $name = "$struct->{NAME}";
2187 my $ndr = "ndr";
2188 my $varname = "r";
2190 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "print", $name, $varname);
2192 $self->pidl_hdr("void ndr_print_$name(struct ndr_print *ndr, const char *name, $args);");
2194 return if (has_property($t, "noprint"));
2196 $self->pidl("_PUBLIC_ void ndr_print_$name(struct ndr_print *$ndr, const char *name, $args)");
2197 $self->pidl("{");
2198 $self->indent;
2199 $self->ParseTypePrint($struct, $ndr, $varname);
2200 $self->deindent;
2201 $self->pidl("}");
2202 $self->pidl("");
2205 #####################################################################
2206 # parse a function - print side
2207 sub ParseFunctionPrint($$)
2209 my($self, $fn) = @_;
2210 my $ndr = "ndr";
2212 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2214 return if has_property($fn, "noprint");
2216 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2217 $self->pidl("{");
2218 $self->indent;
2220 foreach my $e (@{$fn->{ELEMENTS}}) {
2221 $self->DeclareArrayVariables($e);
2224 $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2225 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
2226 $self->pidl("$ndr->depth++;");
2228 $self->pidl("if (flags & NDR_SET_VALUES) {");
2229 $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2230 $self->pidl("}");
2232 $self->pidl("if (flags & NDR_IN) {");
2233 $self->indent;
2234 $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2235 $self->pidl("$ndr->depth++;");
2237 my $env = GenerateFunctionInEnv($fn);
2239 foreach my $e (@{$fn->{ELEMENTS}}) {
2240 if (grep(/in/,@{$e->{DIRECTION}})) {
2241 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2244 $self->pidl("$ndr->depth--;");
2245 $self->deindent;
2246 $self->pidl("}");
2248 $self->pidl("if (flags & NDR_OUT) {");
2249 $self->indent;
2250 $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2251 $self->pidl("$ndr->depth++;");
2253 $env = GenerateFunctionOutEnv($fn);
2254 foreach my $e (@{$fn->{ELEMENTS}}) {
2255 if (grep(/out/,@{$e->{DIRECTION}})) {
2256 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2259 if ($fn->{RETURN_TYPE}) {
2260 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2262 $self->pidl("$ndr->depth--;");
2263 $self->deindent;
2264 $self->pidl("}");
2266 $self->pidl("$ndr->depth--;");
2267 $self->deindent;
2268 $self->pidl("}");
2269 $self->pidl("");
2272 #####################################################################
2273 # parse a function
2274 sub ParseFunctionPush($$)
2276 my($self, $fn) = @_;
2277 my $ndr = "ndr";
2279 $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;
2281 return if has_property($fn, "nopush");
2283 $self->pidl("{");
2284 $self->indent;
2286 foreach my $e (@{$fn->{ELEMENTS}}) {
2287 $self->DeclareArrayVariables($e);
2290 $self->pidl("if (flags & NDR_IN) {");
2291 $self->indent;
2293 my $env = GenerateFunctionInEnv($fn);
2295 EnvSubstituteValue($env, $fn);
2297 foreach my $e (@{$fn->{ELEMENTS}}) {
2298 if (grep(/in/,@{$e->{DIRECTION}})) {
2299 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2303 $self->deindent;
2304 $self->pidl("}");
2306 $self->pidl("if (flags & NDR_OUT) {");
2307 $self->indent;
2309 $env = GenerateFunctionOutEnv($fn);
2310 foreach my $e (@{$fn->{ELEMENTS}}) {
2311 if (grep(/out/,@{$e->{DIRECTION}})) {
2312 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2316 if ($fn->{RETURN_TYPE}) {
2317 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2320 $self->deindent;
2321 $self->pidl("}");
2322 $self->pidl("return NDR_ERR_SUCCESS;");
2323 $self->deindent;
2324 $self->pidl("}");
2325 $self->pidl("");
2328 sub AllocateArrayLevel($$$$$$)
2330 my ($self,$e,$l,$ndr,$var,$size) = @_;
2332 my $pl = GetPrevLevel($e, $l);
2333 if (defined($pl) and
2334 $pl->{TYPE} eq "POINTER" and
2335 $pl->{POINTER_TYPE} eq "ref"
2336 and not $l->{IS_ZERO_TERMINATED}) {
2337 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2338 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2339 $self->pidl("}");
2340 if (grep(/in/,@{$e->{DIRECTION}}) and
2341 grep(/out/,@{$e->{DIRECTION}})) {
2342 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2344 return;
2347 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2350 #####################################################################
2351 # parse a function
2352 sub ParseFunctionPull($$)
2354 my($self,$fn) = @_;
2355 my $ndr = "ndr";
2357 # pull function args
2358 $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;
2360 $self->pidl("{");
2361 $self->indent;
2363 # declare any internal pointers we need
2364 foreach my $e (@{$fn->{ELEMENTS}}) {
2365 $self->DeclarePtrVariables($e);
2366 $self->DeclareArrayVariables($e, "pull");
2369 my %double_cases = ();
2370 foreach my $e (@{$fn->{ELEMENTS}}) {
2371 next if ($e->{TYPE} eq "EMPTY");
2372 next if ($double_cases{"$e->{NAME}"});
2373 $self->DeclareMemCtxVariables($e);
2374 $double_cases{"$e->{NAME}"} = 1;
2377 $self->pidl("if (flags & NDR_IN) {");
2378 $self->indent;
2380 # auto-init the out section of a structure. I originally argued that
2381 # this was a bad idea as it hides bugs, but coping correctly
2382 # with initialisation and not wiping ref vars is turning
2383 # out to be too tricky (tridge)
2384 foreach my $e (@{$fn->{ELEMENTS}}) {
2385 next unless grep(/out/, @{$e->{DIRECTION}});
2386 $self->pidl("ZERO_STRUCT(r->out);");
2387 $self->pidl("");
2388 last;
2391 my $env = GenerateFunctionInEnv($fn);
2393 foreach my $e (@{$fn->{ELEMENTS}}) {
2394 next unless (grep(/in/, @{$e->{DIRECTION}}));
2395 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2398 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2399 # own flag rather than be in NDR_IN ?
2401 foreach my $e (@{$fn->{ELEMENTS}}) {
2402 next unless (grep(/out/, @{$e->{DIRECTION}}));
2403 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2404 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2405 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2406 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2407 next if ($e->{LEVELS}[1]->{TYPE} eq "PIPE");
2408 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2409 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2411 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2412 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2413 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2414 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2415 check_fully_dereferenced($e, $env));
2416 $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2418 if (grep(/in/, @{$e->{DIRECTION}})) {
2419 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2420 } else {
2421 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2423 } elsif ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2424 if (grep(/in/, @{$e->{DIRECTION}})) {
2425 $self->pidl("r->out.$e->{NAME} = r->in.$e->{NAME};");
2426 } else {
2427 $self->pidl("r->out.$e->{NAME} = NULL;");
2429 } else {
2430 $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2432 if (grep(/in/, @{$e->{DIRECTION}})) {
2433 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2434 } else {
2435 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2440 $self->add_deferred();
2441 $self->deindent;
2442 $self->pidl("}");
2444 $self->pidl("if (flags & NDR_OUT) {");
2445 $self->indent;
2447 $env = GenerateFunctionOutEnv($fn);
2448 foreach my $e (@{$fn->{ELEMENTS}}) {
2449 next unless grep(/out/, @{$e->{DIRECTION}});
2450 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2453 if ($fn->{RETURN_TYPE}) {
2454 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2457 $self->add_deferred();
2458 $self->deindent;
2459 $self->pidl("}");
2461 $self->pidl("return NDR_ERR_SUCCESS;");
2462 $self->deindent;
2463 $self->pidl("}");
2464 $self->pidl("");
2467 sub AuthServiceStruct($$$)
2469 my ($self, $ifacename, $authservice) = @_;
2470 my @a = split /,/, $authservice;
2471 my $authservice_count = $#a + 1;
2473 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2474 foreach my $ap (@a) {
2475 $self->pidl("\t$ap, ");
2477 $self->pidl("};");
2478 $self->pidl("");
2480 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2481 $self->pidl("\t.count\t= $authservice_count,");
2482 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2483 $self->pidl("};");
2484 $self->pidl("");
2487 sub ParseGeneratePipeArray($$$)
2489 my ($self, $fn, $direction) = @_;
2491 $self->pidl("static const struct ndr_interface_call_pipe $fn->{NAME}\_$direction\_pipes[] = {");
2492 $self->indent;
2494 foreach my $e (@{$fn->{ELEMENTS}}) {
2495 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2496 next unless (grep(/$direction/, @{$e->{DIRECTION}}));
2498 my $cname = "$e->{TYPE}_chunk";
2500 $self->pidl("{");
2501 $self->indent;
2502 $self->pidl("\"$direction.$e->{NAME}\",");
2503 $self->pidl("\"$cname\",");
2504 $self->pidl("sizeof(struct $cname),");
2505 $self->pidl("(ndr_push_flags_fn_t) ndr_push_$cname,");
2506 $self->pidl("(ndr_pull_flags_fn_t) ndr_pull_$cname,");
2507 $self->pidl("(ndr_print_fn_t) ndr_print_$cname,");
2508 $self->deindent;
2509 $self->pidl("},");
2511 $self->pidl("{ NULL, NULL, 0, NULL, NULL, NULL }");
2512 $self->deindent;
2513 $self->pidl("};");
2514 $self->pidl("");
2517 sub FunctionCallPipes($$)
2519 my ($self, $d) = @_;
2520 return if not defined($d->{OPNUM});
2522 my $in_pipes = 0;
2523 my $out_pipes = 0;
2525 foreach my $e (@{$d->{ELEMENTS}}) {
2526 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2528 if (grep(/in/, @{$e->{DIRECTION}})) {
2529 $in_pipes++;
2531 if (grep(/out/, @{$e->{DIRECTION}})) {
2532 $out_pipes++;
2536 if ($in_pipes) {
2537 $self->ParseGeneratePipeArray($d, "in");
2540 if ($out_pipes) {
2541 $self->ParseGeneratePipeArray($d, "out");
2545 sub FunctionCallEntry($$)
2547 my ($self, $d) = @_;
2548 return 0 if not defined($d->{OPNUM});
2550 my $in_pipes = 0;
2551 my $out_pipes = 0;
2553 foreach my $e (@{$d->{ELEMENTS}}) {
2554 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2556 if (grep(/in/, @{$e->{DIRECTION}})) {
2557 $in_pipes++;
2559 if (grep(/out/, @{$e->{DIRECTION}})) {
2560 $out_pipes++;
2564 my $in_pipes_ptr = "NULL";
2565 my $out_pipes_ptr = "NULL";
2567 if ($in_pipes) {
2568 $in_pipes_ptr = "$d->{NAME}_in_pipes";
2571 if ($out_pipes) {
2572 $out_pipes_ptr = "$d->{NAME}_out_pipes";
2575 $self->pidl("\t{");
2576 $self->pidl("\t\t\"$d->{NAME}\",");
2577 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2578 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2579 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2580 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2581 $self->pidl("\t\t{ $in_pipes, $in_pipes_ptr },");
2582 $self->pidl("\t\t{ $out_pipes, $out_pipes_ptr },");
2583 $self->pidl("\t},");
2584 return 1;
2587 #####################################################################
2588 # produce a function call table
2589 sub FunctionTable($$)
2591 my($self,$interface) = @_;
2592 my $count = 0;
2593 my $uname = uc $interface->{NAME};
2595 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2596 return unless defined ($interface->{PROPERTIES}->{uuid});
2598 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2599 $self->FunctionCallPipes($d);
2602 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2604 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2605 $count += $self->FunctionCallEntry($d);
2607 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL }");
2608 $self->pidl("};");
2609 $self->pidl("");
2611 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2612 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2613 $self->pidl("\t$ep, ");
2615 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2617 $self->pidl("};");
2618 $self->pidl("");
2620 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2621 $self->pidl("\t.count\t= $endpoint_count,");
2622 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2623 $self->pidl("};");
2624 $self->pidl("");
2626 if (! defined $interface->{PROPERTIES}->{authservice}) {
2627 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2630 $self->AuthServiceStruct($interface->{NAME},
2631 $interface->{PROPERTIES}->{authservice});
2633 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2634 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2635 $self->pidl("\t.syntax_id\t= {");
2636 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2637 $self->pidl("\t\tNDR_$uname\_VERSION");
2638 $self->pidl("\t},");
2639 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2640 $self->pidl("\t.num_calls\t= $count,");
2641 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2642 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2643 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2644 $self->pidl("};");
2645 $self->pidl("");
2649 #####################################################################
2650 # generate include statements for imported idl files
2651 sub HeaderImport
2653 my $self = shift;
2654 my @imports = @_;
2655 foreach (@imports) {
2656 $_ = unmake_str($_);
2657 s/\.idl$//;
2658 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2662 #####################################################################
2663 # generate include statements for included header files
2664 sub HeaderInclude
2666 my $self = shift;
2667 my @includes = @_;
2668 foreach (@includes) {
2669 $self->pidl_hdr("#include $_");
2673 #####################################################################
2674 # generate prototypes and defines for the interface definitions
2675 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2676 # NDR parser and so do not belong here, technically speaking
2677 sub HeaderInterface($$$)
2679 my($self,$interface,$needed) = @_;
2681 my $count = 0;
2683 if ($needed->{"compression"}) {
2684 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2687 if (has_property($interface, "object")) {
2688 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2691 if (defined $interface->{PROPERTIES}->{helper}) {
2692 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2695 if (defined $interface->{PROPERTIES}->{uuid}) {
2696 my $name = uc $interface->{NAME};
2697 $self->pidl_hdr("#define NDR_$name\_UUID " .
2698 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid})));
2700 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2701 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{PROPERTIES}->{version}");
2703 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2705 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2706 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2708 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2711 foreach (@{$interface->{FUNCTIONS}}) {
2712 next if has_property($_, "noopnum");
2713 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2714 my $u_name = uc $_->{NAME};
2716 my $val = sprintf("0x%02x", $count);
2717 if (defined($interface->{BASE})) {
2718 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2721 $self->pidl_hdr("#define NDR_$u_name ($val)");
2723 $self->pidl_hdr("");
2724 $count++;
2727 my $val = $count;
2729 if (defined($interface->{BASE})) {
2730 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2733 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2737 sub ParseTypePush($$$$$$)
2739 my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2741 # save the old relative_base_offset
2742 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2743 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2744 # restore the old relative_base_offset
2745 $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2748 sub ParseTypePushFunction($$$)
2750 my ($self, $e, $varname) = @_;
2751 my $ndr = "ndr";
2753 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2755 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2757 $self->pidl("{");
2758 $self->indent;
2759 $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2760 $self->pidl("return NDR_ERR_SUCCESS;");
2761 $self->deindent;
2762 $self->pidl("}");
2763 $self->pidl("");;
2766 sub ParseTypePull($$$$$$)
2768 my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2770 # save the old relative_base_offset
2771 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2772 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2773 # restore the old relative_base_offset
2774 $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2777 sub ParseTypePullFunction($$)
2779 my ($self, $e, $varname) = @_;
2780 my $ndr = "ndr";
2782 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2784 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2786 $self->pidl("{");
2787 $self->indent;
2788 $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2789 $self->pidl("return NDR_ERR_SUCCESS;");
2790 $self->deindent;
2791 $self->pidl("}");
2792 $self->pidl("");
2795 sub ParseTypePrint($$$$)
2797 my ($self, $e, $ndr, $varname) = @_;
2799 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2802 sub ParseTypePrintFunction($$$)
2804 my ($self, $e, $varname) = @_;
2805 my $ndr = "ndr";
2807 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2809 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2811 return if (has_property($e, "noprint"));
2813 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2814 $self->pidl("{");
2815 $self->indent;
2816 $self->ParseTypePrint($e, $ndr, $varname);
2817 $self->deindent;
2818 $self->pidl("}");
2819 $self->pidl("");
2822 sub ParseTypeNdrSize($$)
2824 my ($self,$t) = @_;
2826 my $varname = "r";
2827 my $tf = $typefamily{$t->{TYPE}};
2828 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2830 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2832 $self->pidl("{");
2833 $self->indent;
2834 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2835 $self->deindent;
2836 $self->pidl("}");
2837 $self->pidl("");
2840 #####################################################################
2841 # parse the interface definitions
2842 sub ParseInterface($$$)
2844 my($self,$interface,$needed) = @_;
2846 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2847 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2849 $self->pidl_hdr("");
2851 $self->HeaderInterface($interface, $needed);
2853 # Typedefs
2854 foreach my $d (@{$interface->{TYPES}}) {
2855 if (Parse::Pidl::Typelist::typeIs($d, "PIPE")) {
2856 ($needed->{TypeFunctionName("ndr_push", $d)}) &&
2857 $self->ParsePipePushChunk($d);
2858 ($needed->{TypeFunctionName("ndr_pull", $d)}) &&
2859 $self->ParsePipePullChunk($d);
2860 ($needed->{TypeFunctionName("ndr_print", $d)}) &&
2861 $self->ParsePipePrintChunk($d);
2863 $needed->{TypeFunctionName("ndr_pull", $d)} = 0;
2864 $needed->{TypeFunctionName("ndr_push", $d)} = 0;
2865 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2866 next;
2869 next unless(typeHasBody($d));
2871 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2872 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2873 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2875 # Make sure we don't generate a function twice...
2876 $needed->{TypeFunctionName("ndr_push", $d)} =
2877 $needed->{TypeFunctionName("ndr_pull", $d)} =
2878 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2880 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2883 # Functions
2884 foreach my $d (@{$interface->{FUNCTIONS}}) {
2885 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2886 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2887 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2890 $self->FunctionTable($interface);
2892 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2895 sub GenerateIncludes($)
2897 my ($self) = @_;
2898 if (is_intree()) {
2899 $self->pidl("#include \"includes.h\"");
2900 } else {
2901 $self->pidl("#ifndef _GNU_SOURCE");
2902 $self->pidl("#define _GNU_SOURCE");
2903 $self->pidl("#endif");
2904 $self->pidl("#include <stdint.h>");
2905 $self->pidl("#include <stdlib.h>");
2906 $self->pidl("#include <stdio.h>");
2907 $self->pidl("#include <stdbool.h>");
2908 $self->pidl("#include <stdarg.h>");
2909 $self->pidl("#include <string.h>");
2913 #####################################################################
2914 # parse a parsed IDL structure back into an IDL file
2915 sub Parse($$$$)
2917 my($self, $ndr,$gen_header,$ndr_header) = @_;
2919 $self->pidl_hdr("/* header auto-generated by pidl */");
2920 $self->pidl_hdr("");
2921 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2922 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2923 $self->pidl_hdr("");
2925 $self->pidl("/* parser auto-generated by pidl */");
2926 $self->pidl("");
2927 $self->GenerateIncludes();
2928 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2929 $self->pidl("");
2931 my %needed = ();
2933 foreach (@{$ndr}) {
2934 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2937 foreach (@{$ndr}) {
2938 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2939 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2940 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2943 return ($self->{res_hdr}, $self->{res});
2946 sub NeededElement($$$)
2948 my ($e, $dir, $needed) = @_;
2950 return if ($e->{TYPE} eq "EMPTY");
2952 return if (ref($e->{TYPE}) eq "HASH" and
2953 not defined($e->{TYPE}->{NAME}));
2955 my ($t, $rt);
2956 if (ref($e->{TYPE}) eq "HASH") {
2957 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2958 } else {
2959 $t = $e->{TYPE};
2962 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2963 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2964 } else {
2965 $rt = $e->{REPRESENTATION_TYPE};
2968 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2970 my @fn = ();
2971 if ($dir eq "print") {
2972 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2973 } elsif ($dir eq "pull") {
2974 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2975 push (@fn, "ndr_$t\_to_$rt")
2976 if ($rt ne $t);
2977 } elsif ($dir eq "push") {
2978 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2979 push (@fn, "ndr_$rt\_to_$t")
2980 if ($rt ne $t);
2981 } else {
2982 die("invalid direction `$dir'");
2985 foreach (@fn) {
2986 unless (defined($needed->{$_})) {
2987 $needed->{$_} = 1;
2992 sub NeededFunction($$)
2994 my ($fn,$needed) = @_;
2995 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
2996 $needed->{"ndr_push_$fn->{NAME}"} = 1;
2997 $needed->{"ndr_print_$fn->{NAME}"} = 1;
2998 foreach my $e (@{$fn->{ELEMENTS}}) {
2999 $e->{PARENT} = $fn;
3000 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
3004 sub NeededType($$$)
3006 sub NeededType($$$);
3007 my ($t,$needed,$req) = @_;
3009 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
3010 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "PIPE");
3012 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
3013 return unless defined($t->{ELEMENTS});
3014 for my $e (@{$t->{ELEMENTS}}) {
3015 $e->{PARENT} = $t;
3016 if (has_property($e, "compression")) {
3017 $needed->{"compression"} = 1;
3019 NeededElement($e, $req, $needed);
3020 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
3025 #####################################################################
3026 # work out what parse functions are needed
3027 sub NeededInterface($$)
3029 my ($interface,$needed) = @_;
3030 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
3031 foreach (reverse @{$interface->{TYPES}}) {
3033 if (has_property($_, "public")) {
3034 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
3035 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
3038 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
3039 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
3040 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
3041 if (has_property($_, "gensize")) {
3042 $needed->{"ndr_size_$_->{NAME}"} = 1;
3047 sub TypeFunctionName($$)
3049 my ($prefix, $t) = @_;
3051 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
3052 $t->{TYPE} eq "TYPEDEF");
3053 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
3054 return "$prefix\_$t";