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-2005
6 # released under the GNU GPL
26 return $typefamily{$n};
29 sub RegisterPrimitives()
50 "error_status_t" => 4,
60 foreach my $k (keys %type_alignments) {
66 ALIGN => $type_alignments{$k}
76 if (my $dt = $typedefs{$type}->{DATA}->{TYPE}) {
77 return 1 if ($dt eq "SCALAR" or $dt eq "ENUM" or $dt eq "BITMAP");
87 return undef unless $e->{POINTERS};
89 return "ref" if (util::has_property($e, "ref"));
90 return "ptr" if (util::has_property($e, "ptr"));
91 return "unique" if (util::has_property($e, "unique"));
92 return "relative" if (util::has_property($e, "relative"));
93 return "ignore" if (util::has_property($e, "ignore"));
98 # determine if an element needs a reference pointer on the wire
99 # in its NDR representation
100 sub need_wire_pointer($)
105 return 0 unless ($pt = pointer_type($e));
114 # determine if an element is a pure scalar. pure scalars do not
115 # have a "buffers" section in NDR
116 sub is_pure_scalar($)
119 if (util::has_property($e, "ref")) {
122 if (is_scalar_type($e->{TYPE}) &&
124 !util::array_size($e)) {
130 # see if a variable needs to be allocated by the NDR subsystem on pull
135 if (util::has_property($e, "ref")) {
139 if ($e->{POINTERS} || util::array_size($e)) {
147 # determine the C prefix used to refer to a variable when passing to a push
148 # function. This will be '*' for pointers to scalar types, '' for scalar
149 # types and normal pointers and '&' for pass-by-reference structures
154 if ($e->{TYPE} =~ "string") {
158 if (is_scalar_type($e->{TYPE}) &&
162 if (!is_scalar_type($e->{TYPE}) &&
164 !util::array_size($e)) {
171 # determine the C prefix used to refer to a variable when passing to a pull
177 if (!$e->{POINTERS} && !util::array_size($e)) {
181 if ($e->{TYPE} =~ "string") {
206 $tabs = substr($tabs, 0, -1);
209 ###################################
210 # find a sibling var in a structure
215 my($fn) = $e->{PARENT};
217 if ($name =~ /\*(.*)/) {
221 for my $e2 (@{$fn->{ELEMENTS}}) {
222 return $e2 if ($e2->{NAME} eq $name);
225 die "invalid sibling '$name'";
228 ####################################################################
229 # work out the name of a size_is() variable
234 my($var_prefix) = shift;
236 my($fn) = $e->{PARENT};
238 return $size if (util::is_constant($size));
240 return $size if ($size =~ /ndr->|\(/);
244 if ($size =~ /\*(.*)/) {
249 if ($fn->{TYPE} ne "FUNCTION") {
250 return $prefix . "r->$size";
253 my $e2 = find_sibling($e, $size);
255 if (util::has_property($e2, "in") && util::has_property($e2, "out")) {
256 return $prefix . "$var_prefix$size";
259 if (util::has_property($e2, "in")) {
260 return $prefix . "r->in.$size";
263 if (util::has_property($e2, "out")) {
264 return $prefix . "r->out.$size";
267 die "invalid variable in $size for element $e->{NAME} in $fn->{NAME}\n";
270 #####################################################################
271 # check that a variable we get from ParseExpr isn't a null pointer
272 sub check_null_pointer($)
275 if ($size =~ /^\*/) {
276 my $size2 = substr($size, 1);
277 pidl "if ($size2 == NULL) return NT_STATUS_INVALID_PARAMETER_MIX;";
281 #####################################################################
282 # check that a variable we get from ParseExpr isn't a null pointer
283 # void return varient
284 sub check_null_pointer_void($)
287 if ($size =~ /^\*/) {
288 my $size2 = substr($size, 1);
289 pidl "if ($size2 == NULL) return;";
293 #####################################################################
294 # work out is a parse function should be declared static or not
298 if ($fn->{TYPE} eq "TYPEDEF") {
299 if (util::has_property($fn, "public")) {
304 if ($fn->{TYPE} eq "FUNCTION") {
305 if (util::has_property($fn, "public")) {
312 ###################################################################
313 # setup any special flags for an element or structure
317 my $flags = util::has_property($e, "flag");
318 if (defined $flags) {
319 pidl "{ uint32_t _flags_save_$e->{TYPE} = ndr->flags;";
320 pidl "ndr_set_flags(&ndr->flags, $flags);";
324 ###################################################################
325 # end any special flags for an element or structure
329 my $flags = util::has_property($e, "flag");
330 if (defined $flags) {
331 pidl "ndr->flags = _flags_save_$e->{TYPE};\n\t}";
335 #####################################################################
336 # work out the correct alignment for a structure or union
337 sub find_largest_alignment($)
342 for my $e (@{$s->{ELEMENTS}}) {
345 if (need_wire_pointer($e)) {
348 $a = align_type($e->{TYPE});
351 $align = $a if ($align < $a);
357 #####################################################################
363 unless (defined($typedefs{$e}) && defined($typedefs{$e}->{DATA}->{TYPE})) {
364 # it must be an external type - all we can do is guess
365 # print "Warning: assuming alignment of unknown type '$e' is 4\n";
369 my $dt = $typedefs{$e}->{DATA};
371 return $dt->{ALIGN} if ($dt->{ALIGN});
372 return $typefamily{$dt->{TYPE}}->{ALIGN}->($dt);
375 #####################################################################
376 # parse an array - push side
377 sub ParseArrayPush($$$)
380 my $var_prefix = shift;
381 my $ndr_flags = shift;
383 my $size = ParseExpr($e, util::array_size($e), $var_prefix);
385 if (defined $e->{CONFORMANT_SIZE}) {
386 # the conformant size has already been pushed
387 } elsif (!util::is_inline_array($e)) {
388 # we need to emit the array size
389 pidl "NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, $size));";
392 if (my $length = util::has_property($e, "length_is")) {
393 $length = ParseExpr($e, $length, $var_prefix);
394 pidl "NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));";
395 pidl "NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, $length));";
399 if (is_scalar_type($e->{TYPE})) {
400 pidl "NDR_CHECK(ndr_push_array_$e->{TYPE}(ndr, $ndr_flags, $var_prefix$e->{NAME}, $size));";
402 pidl "NDR_CHECK(ndr_push_array(ndr, $ndr_flags, $var_prefix$e->{NAME}, sizeof($var_prefix$e->{NAME}\[0]), $size, (ndr_push_flags_fn_t)ndr_push_$e->{TYPE}));";
406 #####################################################################
408 sub ParseArrayPrint($$)
411 my $var_prefix = shift;
412 my $size = ParseExpr($e, util::array_size($e), $var_prefix);
413 my $length = util::has_property($e, "length_is");
415 if (defined $length) {
416 $size = ParseExpr($e, $length, $var_prefix);
419 if (is_scalar_type($e->{TYPE})) {
420 pidl "ndr_print_array_$e->{TYPE}(ndr, \"$e->{NAME}\", $var_prefix$e->{NAME}, $size);";
422 pidl "ndr_print_array(ndr, \"$e->{NAME}\", $var_prefix$e->{NAME}, sizeof($var_prefix$e->{NAME}\[0]), $size, (ndr_print_fn_t)ndr_print_$e->{TYPE});";
426 #####################################################################
427 # check the size_is and length_is constraints
428 sub CheckArraySizes($$)
431 my $var_prefix = shift;
433 if (!defined $e->{CONFORMANT_SIZE} &&
434 util::has_property($e, "size_is")) {
435 my $size = ParseExpr($e, util::array_size($e), $var_prefix);
436 pidl "if ($var_prefix$e->{NAME}) {";
438 check_null_pointer($size);
439 pidl "NDR_CHECK(ndr_check_array_size(ndr, (void*)&$var_prefix$e->{NAME}, $size));";
444 if (my $length = util::has_property($e, "length_is")) {
445 $length = ParseExpr($e, $length, $var_prefix);
446 pidl "if ($var_prefix$e->{NAME}) {";
448 check_null_pointer($length);
449 pidl "NDR_CHECK(ndr_check_array_length(ndr, (void*)&$var_prefix$e->{NAME}, $length));";
455 #####################################################################
456 # parse an array - pull side
457 sub ParseArrayPull($$$)
460 my $var_prefix = shift;
461 my $ndr_flags = shift;
463 my $size = ParseExpr($e, util::array_size($e), $var_prefix);
464 my $alloc_size = $size;
466 # if this is a conformant array then we use that size to allocate, and make sure
467 # we allocate enough to pull the elements
468 if (defined $e->{CONFORMANT_SIZE}) {
469 $alloc_size = $e->{CONFORMANT_SIZE};
470 check_null_pointer($size);
471 pidl "if ($size > $alloc_size) {";
473 pidl "return ndr_pull_error(ndr, NDR_ERR_CONFORMANT_SIZE, \"Bad conformant size %u should be %u\", $alloc_size, $size);";
476 } elsif (!util::is_inline_array($e)) {
477 if ($var_prefix =~ /^r->out/ && $size =~ /^\*r->in/) {
478 my $size2 = substr($size, 1);
479 pidl "if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) { NDR_ALLOC(ndr, $size2); }";
482 # non fixed arrays encode the size just before the array
483 pidl "NDR_CHECK(ndr_pull_array_size(ndr, &$var_prefix$e->{NAME}));";
484 $alloc_size = "ndr_get_array_size(ndr, &$var_prefix$e->{NAME})";
487 if ((need_alloc($e) && !util::is_fixed_array($e)) ||
488 ($var_prefix eq "r->in." && util::has_property($e, "ref"))) {
489 if (!util::is_inline_array($e) || $ndr_flags eq "NDR_SCALARS") {
490 pidl "NDR_ALLOC_N(ndr, $var_prefix$e->{NAME}, $alloc_size);";
494 if (($var_prefix eq "r->out." && util::has_property($e, "ref"))) {
495 if (!util::is_inline_array($e) || $ndr_flags eq "NDR_SCALARS") {
496 pidl "if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {";
498 pidl "NDR_ALLOC_N(ndr, $var_prefix$e->{NAME}, $alloc_size);";
504 if (my $length = util::has_property($e, "length_is")) {
505 pidl "NDR_CHECK(ndr_pull_array_length(ndr, &$var_prefix$e->{NAME}));";
506 $size = "ndr_get_array_length(ndr, &$var_prefix$e->{NAME})";
509 check_null_pointer($size);
510 if (is_scalar_type($e->{TYPE})) {
511 pidl "NDR_CHECK(ndr_pull_array_$e->{TYPE}(ndr, $ndr_flags, $var_prefix$e->{NAME}, $size));";
513 pidl "NDR_CHECK(ndr_pull_array(ndr, $ndr_flags, (void **)$var_prefix$e->{NAME}, sizeof($var_prefix$e->{NAME}\[0]), $size, (ndr_pull_flags_fn_t)ndr_pull_$e->{TYPE}));";
517 #####################################################################
518 # parse scalars in a structure element
519 sub ParseElementPushScalar($$$)
522 my($var_prefix) = shift;
523 my($ndr_flags) = shift;
524 my $cprefix = c_push_prefix($e);
525 my $sub_size = util::has_property($e, "subcontext");
529 if (my $value = util::has_property($e, "value")) {
530 pidl "$cprefix$var_prefix$e->{NAME} = $value;";
533 if (util::has_property($e, "relative")) {
534 pidl "NDR_CHECK(ndr_push_relative_ptr1(ndr, $var_prefix$e->{NAME}));";
535 } elsif (util::is_inline_array($e)) {
536 ParseArrayPush($e, "r->", "NDR_SCALARS");
537 } elsif (need_wire_pointer($e)) {
538 ParseElementPushPtr($e, $var_prefix, $ndr_flags);
539 } elsif (need_alloc($e)) {
540 # no scalar component
541 } elsif (my $switch = util::has_property($e, "switch_is")) {
542 ParseElementPushSwitch($e, $var_prefix, $ndr_flags, $switch);
543 } elsif (defined $sub_size) {
544 pidl "NDR_CHECK(ndr_push_subcontext_flags_fn(ndr, $sub_size, $cprefix$var_prefix$e->{NAME}, (ndr_push_flags_fn_t) ndr_push_$e->{TYPE}));";
546 pidl "NDR_CHECK(ndr_push_$e->{TYPE}(ndr, $ndr_flags, $cprefix$var_prefix$e->{NAME}));";
552 #####################################################################
553 # parse a pointer in a struct element or function
554 sub ParseElementPushPtr($$$)
557 my $var_prefix = shift;
558 my $ndr_flags = shift;
560 pidl "NDR_CHECK(ndr_push_unique_ptr(ndr, $var_prefix$e->{NAME}));";
564 #####################################################################
565 # print scalars in a structure element
566 sub ParseElementPrintScalar($$)
569 my($var_prefix) = shift;
570 my $cprefix = c_push_prefix($e);
572 if (util::has_property($e, "noprint")) {
576 if (my $value = util::has_property($e, "value")) {
577 pidl "if (ndr->flags & LIBNDR_PRINT_SET_VALUES) {";
579 pidl "$cprefix$var_prefix$e->{NAME} = $value;";
584 if (util::is_fixed_array($e)) {
585 ParseElementPrintBuffer($e, $var_prefix);
586 } elsif ($e->{POINTERS} || util::array_size($e)) {
587 pidl "ndr_print_ptr(ndr, \"$e->{NAME}\", $var_prefix$e->{NAME});";
588 pidl "ndr->depth++;";
589 ParseElementPrintBuffer($e, $var_prefix);
590 pidl "ndr->depth--;";
591 } elsif (my $switch = util::has_property($e, "switch_is")) {
592 ParseElementPrintSwitch($e, $var_prefix, $switch);
594 pidl "ndr_print_$e->{TYPE}(ndr, \"$e->{NAME}\", $cprefix$var_prefix$e->{NAME});";
598 #####################################################################
599 # parse scalars in a structure element - pull size
600 sub ParseElementPullSwitch($$$$)
603 my($var_prefix) = shift;
604 my($ndr_flags) = shift;
606 my $switch_var = ParseExpr($e, $switch, $var_prefix);
608 my $cprefix = c_pull_prefix($e);
610 my $utype = $typedefs{$e->{TYPE}};
612 check_null_pointer($switch_var);
614 if (!defined $utype ||
615 !util::has_property($utype, "nodiscriminant")) {
616 my $e2 = find_sibling($e, $switch);
617 my $type_decl = util::map_type($e2->{TYPE});
618 pidl "if (($ndr_flags) & NDR_SCALARS) {";
620 if ($typedefs{$e2->{TYPE}}->{DATA}->{TYPE} eq "ENUM") {
621 $type_decl = util::enum_type_decl($e2);
622 } elsif ($typedefs{$e2->{TYPE}}->{DATA}->{TYPE} eq "BITMAP") {
623 $type_decl = util::bitmap_type_decl($e2);
625 pidl "$type_decl _level;";
626 pidl "NDR_CHECK(ndr_pull_$e2->{TYPE}(ndr, NDR_SCALARS, &_level));";
627 if ($switch_var =~ /r->in/) {
628 pidl "if (!(ndr->flags & LIBNDR_FLAG_REF_ALLOC) && _level != $switch_var) {";
631 pidl "if (_level != $switch_var) {";
634 pidl "return ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u in $e->{NAME}\", _level);";
636 if ($switch_var =~ /r->/) {
637 pidl "} else { $switch_var = _level; }";
645 my $sub_size = util::has_property($e, "subcontext");
646 if (defined $sub_size) {
647 pidl "if (($ndr_flags) & NDR_SCALARS) {";
649 pidl "NDR_CHECK(ndr_pull_subcontext_union_fn(ndr, $sub_size, $switch_var, $cprefix$var_prefix$e->{NAME}, (ndr_pull_union_fn_t) ndr_pull_$e->{TYPE}));";
653 pidl "NDR_CHECK(ndr_pull_$e->{TYPE}(ndr, $ndr_flags, $switch_var, $cprefix$var_prefix$e->{NAME}));";
659 #####################################################################
660 # push switch element
661 sub ParseElementPushSwitch($$$$)
664 my($var_prefix) = shift;
665 my($ndr_flags) = shift;
667 my $switch_var = ParseExpr($e, $switch, $var_prefix);
668 my $cprefix = c_push_prefix($e);
670 check_null_pointer($switch_var);
672 my $utype = $typedefs{$e->{TYPE}};
673 if (!defined $utype ||
674 !util::has_property($utype, "nodiscriminant")) {
675 my $e2 = find_sibling($e, $switch);
676 pidl "if (($ndr_flags) & NDR_SCALARS) {";
678 pidl "NDR_CHECK(ndr_push_$e2->{TYPE}(ndr, NDR_SCALARS, $switch_var));";
683 my $sub_size = util::has_property($e, "subcontext");
684 if (defined $sub_size) {
685 pidl "if(($ndr_flags) & NDR_SCALARS) {";
687 pidl "NDR_CHECK(ndr_push_subcontext_union_fn(ndr, $sub_size, $switch_var, $cprefix$var_prefix$e->{NAME}, (ndr_push_union_fn_t) ndr_push_$e->{TYPE}));";
691 pidl "NDR_CHECK(ndr_push_$e->{TYPE}(ndr, $ndr_flags, $switch_var, $cprefix$var_prefix$e->{NAME}));";
695 #####################################################################
696 # print scalars in a structure element
697 sub ParseElementPrintSwitch($$$)
700 my($var_prefix) = shift;
702 my $switch_var = ParseExpr($e, $switch, $var_prefix);
703 my $cprefix = c_push_prefix($e);
705 check_null_pointer_void($switch_var);
707 pidl "ndr_print_$e->{TYPE}(ndr, \"$e->{NAME}\", $switch_var, $cprefix$var_prefix$e->{NAME});";
711 #####################################################################
712 # parse scalars in a structure element - pull size
713 sub ParseElementPullScalar($$$)
716 my($var_prefix) = shift;
717 my($ndr_flags) = shift;
718 my $cprefix = c_pull_prefix($e);
719 my $sub_size = util::has_property($e, "subcontext");
723 if (util::is_inline_array($e)) {
724 ParseArrayPull($e, "r->", "NDR_SCALARS");
725 } elsif (need_wire_pointer($e)) {
726 ParseElementPullPtr($e, $var_prefix, $ndr_flags);
727 } elsif (need_alloc($e)) {
728 # no scalar component
729 } elsif (my $switch = util::has_property($e, "switch_is")) {
730 ParseElementPullSwitch($e, $var_prefix, $ndr_flags, $switch);
731 } elsif (defined $sub_size) {
732 pidl "NDR_CHECK(ndr_pull_subcontext_flags_fn(ndr, $sub_size, $cprefix$var_prefix$e->{NAME}, (ndr_pull_flags_fn_t) ndr_pull_$e->{TYPE}));";
734 pidl "NDR_CHECK(ndr_pull_$e->{TYPE}(ndr, $ndr_flags, $cprefix$var_prefix$e->{NAME}));";
736 if (my $range = util::has_property($e, "range")) {
737 my ($low, $high) = split(/ /, $range, 2);
738 pidl "if ($var_prefix$e->{NAME} < $low || $var_prefix$e->{NAME} > $high) {";
739 pidl "\treturn ndr_pull_error(ndr, NDR_ERR_RANGE, \"value out of range\");";
746 #####################################################################
747 # parse a pointer in a struct element or function
748 sub ParseElementPullPtr($$$)
751 my($var_prefix) = shift;
752 my($ndr_flags) = shift;
754 pidl "NDR_CHECK(ndr_pull_unique_ptr(ndr, &_ptr_$e->{NAME}));";
755 pidl "if (_ptr_$e->{NAME}) {";
757 pidl "NDR_ALLOC(ndr, $var_prefix$e->{NAME});";
758 if (util::has_property($e, "relative")) {
759 pidl "NDR_CHECK(ndr_pull_relative_ptr1(ndr, $var_prefix$e->{NAME}, _ptr_$e->{NAME}));";
763 pidl "\t$var_prefix$e->{NAME} = NULL;";
767 #####################################################################
768 # parse buffers in a structure element
769 sub ParseElementPushBuffer($$$)
772 my($var_prefix) = shift;
773 my($ndr_flags) = shift;
774 my $cprefix = c_push_prefix($e);
775 my $sub_size = util::has_property($e, "subcontext");
777 if (is_pure_scalar($e)) {
783 if (need_wire_pointer($e)) {
784 pidl "if ($var_prefix$e->{NAME}) {";
786 if (util::has_property($e, "relative")) {
787 pidl "NDR_CHECK(ndr_push_relative_ptr2(ndr, $var_prefix$e->{NAME}));";
791 if (util::is_inline_array($e)) {
792 ParseArrayPush($e, "r->", "NDR_BUFFERS");
793 } elsif (util::array_size($e)) {
794 ParseArrayPush($e, "r->", "NDR_SCALARS|NDR_BUFFERS");
795 } elsif (my $switch = util::has_property($e, "switch_is")) {
796 if ($e->{POINTERS}) {
797 ParseElementPushSwitch($e, $var_prefix, "NDR_BUFFERS|NDR_SCALARS", $switch);
799 ParseElementPushSwitch($e, $var_prefix, "NDR_BUFFERS", $switch);
801 } elsif (defined $sub_size) {
802 if ($e->{POINTERS}) {
803 pidl "NDR_CHECK(ndr_push_subcontext_flags_fn(ndr, $sub_size, $cprefix$var_prefix$e->{NAME}, (ndr_push_flags_fn_t) ndr_push_$e->{TYPE}));";
805 } elsif ($e->{POINTERS}) {
806 pidl "NDR_CHECK(ndr_push_$e->{TYPE}(ndr, NDR_SCALARS|NDR_BUFFERS, $cprefix$var_prefix$e->{NAME}));";
808 pidl "NDR_CHECK(ndr_push_$e->{TYPE}(ndr, $ndr_flags, $cprefix$var_prefix$e->{NAME}));";
811 if (need_wire_pointer($e)) {
819 #####################################################################
820 # print buffers in a structure element
821 sub ParseElementPrintBuffer($$)
824 my($var_prefix) = shift;
825 my $cprefix = c_push_prefix($e);
827 if (need_wire_pointer($e)) {
828 pidl "if ($var_prefix$e->{NAME}) {";
832 if (util::array_size($e)) {
833 ParseArrayPrint($e, $var_prefix)
834 } elsif (my $switch = util::has_property($e, "switch_is")) {
835 ParseElementPrintSwitch($e, $var_prefix, $switch);
837 pidl "ndr_print_$e->{TYPE}(ndr, \"$e->{NAME}\", $cprefix$var_prefix$e->{NAME});";
840 if (need_wire_pointer($e)) {
846 #####################################################################
847 # parse buffers in a structure element - pull side
848 sub ParseElementPullBuffer($$$)
851 my($var_prefix) = shift;
852 my($ndr_flags) = shift;
853 my $cprefix = c_pull_prefix($e);
854 my $sub_size = util::has_property($e, "subcontext");
856 if (is_pure_scalar($e)) {
862 if (need_wire_pointer($e)) {
863 pidl "if ($var_prefix$e->{NAME}) {";
865 if (util::has_property($e, "relative")) {
866 pidl "struct ndr_pull_save _relative_save;";
867 pidl "ndr_pull_save(ndr, &_relative_save);";
868 pidl "NDR_CHECK(ndr_pull_relative_ptr2(ndr, $var_prefix$e->{NAME}));";
872 if (util::is_inline_array($e)) {
873 ParseArrayPull($e, "r->", "NDR_BUFFERS");
874 } elsif (util::array_size($e)) {
875 ParseArrayPull($e, "r->", "NDR_SCALARS|NDR_BUFFERS");
876 } elsif (my $switch = util::has_property($e, "switch_is")) {
877 if ($e->{POINTERS}) {
878 ParseElementPullSwitch($e, $var_prefix, "NDR_SCALARS|NDR_BUFFERS", $switch);
880 ParseElementPullSwitch($e, $var_prefix, "NDR_BUFFERS", $switch);
882 } elsif (defined $sub_size) {
883 if ($e->{POINTERS}) {
884 pidl "NDR_CHECK(ndr_pull_subcontext_flags_fn(ndr, $sub_size, $cprefix$var_prefix$e->{NAME}, (ndr_pull_flags_fn_t) ndr_pull_$e->{TYPE}));";
886 } elsif ($e->{POINTERS}) {
887 pidl "NDR_CHECK(ndr_pull_$e->{TYPE}(ndr, NDR_SCALARS|NDR_BUFFERS, $cprefix$var_prefix$e->{NAME}));";
889 pidl "NDR_CHECK(ndr_pull_$e->{TYPE}(ndr, $ndr_flags, $cprefix$var_prefix$e->{NAME}));";
892 if (need_wire_pointer($e)) {
893 if (util::has_property($e, "relative")) {
894 pidl "ndr_pull_restore(ndr, &_relative_save);";
903 #####################################################################
905 sub ParseStructPush($)
909 return unless defined($struct->{ELEMENTS});
911 start_flags($struct);
913 # see if the structure contains a conformant array. If it
914 # does, then it must be the last element of the structure, and
915 # we need to push the conformant length early, as it fits on
916 # the wire before the structure (and even before the structure
918 my $e = $struct->{ELEMENTS}[-1];
919 if (defined $e->{ARRAY_LEN} && $e->{ARRAY_LEN} eq "*") {
920 my $size = ParseExpr($e, util::array_size($e), "r->");
921 $e->{CONFORMANT_SIZE} = $size;
922 check_null_pointer($size);
923 pidl "NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, $size));";
926 if (defined $e->{TYPE} && $e->{TYPE} eq "string"
927 && util::property_matches($e, "flag", ".*LIBNDR_FLAG_STR_CONFORMANT.*")) {
928 pidl "NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, ndr_string_array_size(ndr, r->$e->{NAME})));";
931 pidl "if (!(ndr_flags & NDR_SCALARS)) goto buffers;";
933 pidl "NDR_CHECK(ndr_push_struct_start(ndr));";
935 my $align = find_largest_alignment($struct);
936 pidl "NDR_CHECK(ndr_push_align(ndr, $align));";
938 foreach my $e (@{$struct->{ELEMENTS}}) {
939 ParseElementPushScalar($e, "r->", "NDR_SCALARS");
943 pidl "if (!(ndr_flags & NDR_BUFFERS)) goto done;";
944 foreach my $e (@{$struct->{ELEMENTS}}) {
945 ParseElementPushBuffer($e, "r->", "NDR_BUFFERS");
948 pidl "ndr_push_struct_end(ndr);";
955 #####################################################################
956 # generate a push function for an enum
960 my($type_fn) = util::enum_type_fn($enum);
964 pidl "NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, r));";
969 #####################################################################
970 # generate a pull function for an enum
974 my($type_fn) = util::enum_type_fn($enum);
975 my($type_v_decl) = util::map_type(util::enum_type_fn($enum));
977 pidl "$type_v_decl v;";
979 pidl "NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));";
985 #####################################################################
986 # generate a print function for an enum
987 sub ParseEnumPrint($)
991 pidl "const char *val = NULL;";
998 my $els = \@{$enum->{ELEMENTS}};
999 foreach my $i (0 .. $#{$els}) {
1000 my $e = ${$els}[$i];
1002 if ($e =~ /^(.*)=/) {
1005 pidl "case $e: val = \"$e\"; break;";
1011 pidl "ndr_print_enum(ndr, name, \"$enum->{TYPE}\", val, r);";
1019 return "struct ndr_push *ndr, int ndr_flags, enum $e->{NAME} r";
1022 sub ArgsEnumPrint($)
1025 return "struct ndr_print *ndr, const char *name, enum $e->{NAME} r";
1031 return "struct ndr_pull *ndr, int ndr_flags, enum $e->{NAME} *r";
1034 $typefamily{ENUM} = {
1035 PUSH_FN_BODY => \&ParseEnumPush,
1036 PUSH_FN_ARGS => \&ArgsEnumPush,
1037 PULL_FN_BODY => \&ParseEnumPull,
1038 PULL_FN_ARGS => \&ArgsEnumPull,
1039 PRINT_FN_BODY => \&ParseEnumPrint,
1040 PRINT_FN_ARGS => \&ArgsEnumPrint,
1041 ALIGN => sub { return align_type(util::enum_type_fn(shift)); }
1044 #####################################################################
1045 # generate a push function for a bitmap
1046 sub ParseBitmapPush($)
1048 my($bitmap) = shift;
1049 my($type_fn) = util::bitmap_type_fn($bitmap);
1051 start_flags($bitmap);
1053 pidl "NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, r));";
1058 #####################################################################
1059 # generate a pull function for an bitmap
1060 sub ParseBitmapPull($)
1062 my($bitmap) = shift;
1063 my($type_fn) = util::bitmap_type_fn($bitmap);
1064 my($type_decl) = util::bitmap_type_decl($bitmap);
1066 pidl "$type_decl v;";
1067 start_flags($bitmap);
1068 pidl "NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));";
1074 #####################################################################
1075 # generate a print function for an bitmap
1076 sub ParseBitmapPrintElement($$)
1079 my($bitmap) = shift;
1080 my($type_decl) = util::bitmap_type_decl($bitmap);
1081 my($type_fn) = util::bitmap_type_fn($bitmap);
1082 my($name) = $bitmap->{PARENT}->{NAME};
1085 if ($e =~ /^(\w+) .*$/) {
1088 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1091 pidl "ndr_print_bitmap_flag(ndr, sizeof($type_decl), \"$flag\", $flag, r);";
1094 #####################################################################
1095 # generate a print function for an bitmap
1096 sub ParseBitmapPrint($)
1098 my($bitmap) = shift;
1099 my($type_decl) = util::bitmap_type_decl($bitmap);
1100 my($type_fn) = util::bitmap_type_fn($bitmap);
1102 start_flags($bitmap);
1104 pidl "ndr_print_$type_fn(ndr, name, r);";
1106 pidl "ndr->depth++;";
1107 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1108 ParseBitmapPrintElement($e, $bitmap);
1110 pidl "ndr->depth--;";
1115 sub ArgsBitmapPush($)
1118 my $type_decl = util::bitmap_type_decl($e->{DATA});
1119 return "struct ndr_push *ndr, int ndr_flags, $type_decl r";
1122 sub ArgsBitmapPrint($)
1125 my $type_decl = util::bitmap_type_decl($e->{DATA});
1126 return "struct ndr_print *ndr, const char *name, $type_decl r";
1129 sub ArgsBitmapPull($)
1132 my $type_decl = util::bitmap_type_decl($e->{DATA});
1133 return "struct ndr_pull *ndr, int ndr_flags, $type_decl *r";
1136 $typefamily{BITMAP} = {
1137 PUSH_FN_BODY => \&ParseBitmapPush,
1138 PUSH_FN_ARGS => \&ArgsBitmapPush,
1139 PULL_FN_BODY => \&ParseBitmapPull,
1140 PULL_FN_ARGS => \&ArgsBitmapPull,
1141 PRINT_FN_BODY => \&ParseBitmapPrint,
1142 PRINT_FN_ARGS => \&ArgsBitmapPrint,
1143 ALIGN => sub { return align_type(util::bitmap_type_fn(shift)); }
1146 #####################################################################
1147 # generate a struct print function
1148 sub ParseStructPrint($)
1150 my($struct) = shift;
1151 my($name) = $struct->{PARENT}->{NAME};
1153 return unless defined $struct->{ELEMENTS};
1155 pidl "ndr_print_struct(ndr, name, \"$name\");";
1157 start_flags($struct);
1159 pidl "ndr->depth++;";
1160 foreach my $e (@{$struct->{ELEMENTS}}) {
1161 ParseElementPrintScalar($e, "r->");
1163 pidl "ndr->depth--;";
1168 #####################################################################
1169 # parse a struct - pull side
1170 sub ParseStructPull($)
1172 my($struct) = shift;
1175 return unless defined $struct->{ELEMENTS};
1177 # see if the structure contains a conformant array. If it
1178 # does, then it must be the last element of the structure, and
1179 # we need to pull the conformant length early, as it fits on
1180 # the wire before the structure (and even before the structure
1182 my $e = $struct->{ELEMENTS}[-1];
1183 if (defined $e->{ARRAY_LEN} && $e->{ARRAY_LEN} eq "*") {
1187 if (defined $e->{TYPE} && $e->{TYPE} eq "string"
1188 && util::property_matches($e, "flag", ".*LIBNDR_FLAG_STR_CONFORMANT.*")) {
1192 if (defined $conform_e) {
1194 pidl "uint32_t _conformant_size;";
1195 $conform_e->{CONFORMANT_SIZE} = "_conformant_size";
1198 # declare any internal pointers we need
1199 foreach my $e (@{$struct->{ELEMENTS}}) {
1200 if (need_wire_pointer($e)) {
1201 pidl "uint32_t _ptr_$e->{NAME};";
1205 start_flags($struct);
1207 pidl "if (!(ndr_flags & NDR_SCALARS)) goto buffers;";
1209 pidl "NDR_CHECK(ndr_pull_struct_start(ndr));";
1211 if (defined $conform_e) {
1212 pidl "NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &$conform_e->{CONFORMANT_SIZE}));";
1215 my $align = find_largest_alignment($struct);
1216 pidl "NDR_CHECK(ndr_pull_align(ndr, $align));";
1218 foreach my $e (@{$struct->{ELEMENTS}}) {
1219 ParseElementPullScalar($e, "r->", "NDR_SCALARS");
1223 pidl "if (!(ndr_flags & NDR_BUFFERS)) goto done;";
1224 foreach my $e (@{$struct->{ELEMENTS}}) {
1225 ParseElementPullBuffer($e, "r->", "NDR_BUFFERS");
1228 foreach my $e (@{$struct->{ELEMENTS}}) {
1229 CheckArraySizes($e, "r->");
1232 pidl "ndr_pull_struct_end(ndr);";
1239 #####################################################################
1240 # calculate size of ndr struct
1241 sub ParseStructNdrSize($)
1244 my $static = fn_prefix($t);
1247 pidl "size_t ndr_size_$t->{NAME}(const struct $t->{NAME} *r, int flags)";
1250 if (my $flags = util::has_property($t, "flag")) {
1251 pidl "flags |= $flags;";
1253 pidl "return ndr_size_struct(r, flags, (ndr_push_flags_fn_t)ndr_push_$t->{NAME});";
1259 sub ArgsStructPush($)
1262 return "struct ndr_push *ndr, int ndr_flags, struct $e->{NAME} *r";
1265 sub ArgsStructPrint($)
1268 return "struct ndr_print *ndr, const char *name, struct $e->{NAME} *r";
1271 sub ArgsStructPull($)
1274 return "struct ndr_pull *ndr, int ndr_flags, struct $e->{NAME} *r";
1277 $typefamily{STRUCT} = {
1278 PUSH_FN_BODY => \&ParseStructPush,
1279 PUSH_FN_ARGS => \&ArgsStructPush,
1280 PULL_FN_BODY => \&ParseStructPull,
1281 PULL_FN_ARGS => \&ArgsStructPull,
1282 PRINT_FN_BODY => \&ParseStructPrint,
1283 PRINT_FN_ARGS => \&ArgsStructPrint,
1284 SIZE_FN => \&ParseStructNdrSize,
1285 ALIGN => \&find_largest_alignment
1288 #####################################################################
1289 # calculate size of ndr struct
1290 sub ParseUnionNdrSize($)
1293 my $static = fn_prefix($t);
1296 pidl "size_t ndr_size_$t->{NAME}(const union $t->{NAME} *r, int level, int flags)";
1299 if (my $flags = util::has_property($t, "flag")) {
1300 pidl "flags |= $flags;";
1302 pidl "return ndr_size_union(r, flags, level, (ndr_push_union_fn_t)ndr_push_$t->{NAME});";
1308 #####################################################################
1309 # parse a union - push side
1310 sub ParseUnionPush($)
1313 my $have_default = 0;
1317 pidl "if (!(ndr_flags & NDR_SCALARS)) goto buffers;";
1319 pidl "NDR_CHECK(ndr_push_struct_start(ndr));";
1321 # my $align = union_alignment($e);
1322 # pidl "NDR_CHECK(ndr_push_align(ndr, $align));";
1324 pidl "switch (level) {";
1326 foreach my $el (@{$e->{ELEMENTS}}) {
1327 if (util::has_property($el, "default")) {
1331 pidl "case $el->{PROPERTIES}->{case}:";
1334 if ($el->{TYPE} ne "EMPTY") {
1336 ParseElementPushScalar($el, "r->", "NDR_SCALARS");
1342 if (! $have_default) {
1344 pidl "\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1349 pidl "if (!(ndr_flags & NDR_BUFFERS)) goto done;";
1350 pidl "switch (level) {";
1352 foreach my $el (@{$e->{ELEMENTS}}) {
1353 if (util::has_property($el, "default")) {
1356 pidl "case $el->{PROPERTIES}->{case}:";
1358 if ($el->{TYPE} ne "EMPTY") {
1360 ParseElementPushBuffer($el, "r->", "NDR_BUFFERS");
1366 if (! $have_default) {
1368 pidl "\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1372 pidl "ndr_push_struct_end(ndr);";
1377 #####################################################################
1379 sub ParseUnionPrint($)
1382 my $have_default = 0;
1383 my($name) = $e->{PARENT}->{NAME};
1385 pidl "ndr_print_union(ndr, name, level, \"$name\");";
1388 pidl "switch (level) {";
1390 foreach my $el (@{$e->{ELEMENTS}}) {
1391 if (util::has_property($el, "default")) {
1395 pidl "case $el->{PROPERTIES}->{case}:";
1397 if ($el->{TYPE} ne "EMPTY") {
1399 ParseElementPrintScalar($el, "r->");
1405 if (! $have_default) {
1407 pidl "\tndr_print_bad_level(ndr, name, level);";
1415 #####################################################################
1416 # parse a union - pull side
1417 sub ParseUnionPull($)
1420 my $have_default = 0;
1424 pidl "if (!(ndr_flags & NDR_SCALARS)) goto buffers;";
1426 pidl "NDR_CHECK(ndr_pull_struct_start(ndr));";
1428 # my $align = union_alignment($e);
1429 # pidl "\tNDR_CHECK(ndr_pull_align(ndr, $align));\n";
1431 pidl "switch (level) {";
1433 foreach my $el (@{$e->{ELEMENTS}}) {
1434 if (util::has_property($el, "default")) {
1438 pidl "case $el->{PROPERTIES}->{case}: {";
1440 if ($el->{TYPE} ne "EMPTY") {
1442 if ($el->{POINTERS}) {
1443 pidl "uint32_t _ptr_$el->{NAME};";
1445 ParseElementPullScalar($el, "r->", "NDR_SCALARS");
1451 if (! $have_default) {
1453 pidl "\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1458 pidl "if (!(ndr_flags & NDR_BUFFERS)) goto done;";
1459 pidl "switch (level) {";
1461 foreach my $el (@{$e->{ELEMENTS}}) {
1462 if (util::has_property($el, "default")) {
1465 pidl "case $el->{PROPERTIES}->{case}:";
1467 if ($el->{TYPE} ne "EMPTY") {
1469 ParseElementPullBuffer($el, "r->", "NDR_BUFFERS");
1475 if (! $have_default) {
1477 pidl "\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1481 pidl "ndr_pull_struct_end(ndr);";
1486 sub ArgsUnionPush($)
1489 return "struct ndr_push *ndr, int ndr_flags, int level, union $e->{NAME} *r";
1492 sub ArgsUnionPrint($)
1495 return "struct ndr_print *ndr, const char *name, int level, union $e->{NAME} *r";
1498 sub ArgsUnionPull($)
1501 return "struct ndr_pull *ndr, int ndr_flags, int level, union $e->{NAME} *r";
1504 $typefamily{UNION} = {
1505 PUSH_FN_BODY => \&ParseUnionPush,
1506 PUSH_FN_ARGS => \&ArgsUnionPush,
1507 PULL_FN_BODY => \&ParseUnionPull,
1508 PULL_FN_ARGS => \&ArgsUnionPull,
1509 PRINT_FN_BODY => \&ParseUnionPrint,
1510 PRINT_FN_ARGS => \&ArgsUnionPrint,
1511 SIZE_FN => \&ParseUnionNdrSize,
1512 ALIGN => \&find_largest_alignment
1515 #####################################################################
1516 # parse a typedef - push side
1517 sub ParseTypedefPush($)
1520 my $static = fn_prefix($e);
1522 return unless needed::is_needed("push_$e->{NAME}");
1524 my $args = $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_ARGS}->($e);
1525 pidl $static . "NTSTATUS ndr_push_$e->{NAME}($args)";
1529 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($e->{DATA});
1530 pidl "return NT_STATUS_OK;";
1537 #####################################################################
1538 # parse a typedef - pull side
1539 sub ParseTypedefPull($)
1542 my $static = fn_prefix($e);
1544 return unless needed::is_needed("pull_$e->{NAME}");
1546 my $args = $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_ARGS}->($e);
1548 pidl $static . "NTSTATUS ndr_pull_$e->{NAME}($args)";
1552 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($e->{DATA});
1553 pidl "return NT_STATUS_OK;";
1559 #####################################################################
1560 # parse a typedef - print side
1561 sub ParseTypedefPrint($)
1565 my $args = $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_ARGS}->($e);
1567 pidl "void ndr_print_$e->{NAME}($args)";
1570 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($e->{DATA});
1575 #####################################################################
1576 ## calculate the size of a structure
1577 sub ParseTypedefNdrSize($)
1581 return unless needed::is_needed("ndr_size_$t->{NAME}");
1583 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN}($t);
1586 #####################################################################
1587 # parse a function - print side
1588 sub ParseFunctionPrint($)
1592 pidl "void ndr_print_$fn->{NAME}(struct ndr_print *ndr, const char *name, int flags, struct $fn->{NAME} *r)";
1595 pidl "ndr_print_struct(ndr, name, \"$fn->{NAME}\");";
1596 pidl "ndr->depth++;";
1598 pidl "if (flags & NDR_SET_VALUES) {";
1599 pidl "\tndr->flags |= LIBNDR_PRINT_SET_VALUES;";
1602 pidl "if (flags & NDR_IN) {";
1604 pidl "ndr_print_struct(ndr, \"in\", \"$fn->{NAME}\");";
1605 pidl "ndr->depth++;";
1607 foreach my $e (@{$fn->{ELEMENTS}}) {
1608 if (util::has_property($e, "in")) {
1609 ParseElementPrintScalar($e, "r->in.");
1612 pidl "ndr->depth--;";
1616 pidl "if (flags & NDR_OUT) {";
1618 pidl "ndr_print_struct(ndr, \"out\", \"$fn->{NAME}\");";
1619 pidl "ndr->depth++;";
1620 foreach my $e (@{$fn->{ELEMENTS}}) {
1621 if (util::has_property($e, "out")) {
1622 ParseElementPrintScalar($e, "r->out.");
1625 if ($fn->{RETURN_TYPE} && $fn->{RETURN_TYPE} ne "void") {
1627 $cprefix = "" if (is_scalar_type($fn->{RETURN_TYPE})) ; # FIXME: Should really use util::c_push_prefix here
1628 pidl "ndr_print_$fn->{RETURN_TYPE}(ndr, \"result\", $cprefix"."r->out.result);";
1630 pidl "ndr->depth--;";
1634 pidl "ndr->depth--;";
1640 #####################################################################
1641 # parse a function element
1642 sub ParseFunctionElementPush($$)
1647 if (util::array_size($e)) {
1648 if (need_wire_pointer($e)) {
1649 pidl "NDR_CHECK(ndr_push_unique_ptr(ndr, r->$inout.$e->{NAME}));";
1650 pidl "if (r->$inout.$e->{NAME}) {";
1652 ParseArrayPush($e, "r->$inout.", "NDR_SCALARS|NDR_BUFFERS");
1656 ParseArrayPush($e, "r->$inout.", "NDR_SCALARS|NDR_BUFFERS");
1659 ParseElementPushScalar($e, "r->$inout.", "NDR_SCALARS|NDR_BUFFERS");
1661 if ($e->{POINTERS}) {
1662 ParseElementPushBuffer($e, "r->$inout.", "NDR_SCALARS|NDR_BUFFERS");
1667 #####################################################################
1669 sub ParseFunctionPush($)
1672 my $static = fn_prefix($fn);
1674 pidl $static . "NTSTATUS ndr_push_$fn->{NAME}(struct ndr_push *ndr, int flags, struct $fn->{NAME} *r)";
1678 pidl "if (!(flags & NDR_IN)) goto ndr_out;";
1681 foreach my $e (@{$fn->{ELEMENTS}}) {
1682 if (util::has_property($e, "in")) {
1683 ParseFunctionElementPush($e, "in");
1688 pidl "if (!(flags & NDR_OUT)) goto done;";
1691 foreach my $e (@{$fn->{ELEMENTS}}) {
1692 if (util::has_property($e, "out")) {
1693 ParseFunctionElementPush($e, "out");
1697 if ($fn->{RETURN_TYPE} && $fn->{RETURN_TYPE} ne "void") {
1698 pidl "NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, r->out.result));";
1702 pidl "return NT_STATUS_OK;";
1708 #####################################################################
1709 # parse a function element
1710 sub ParseFunctionElementPull($$)
1715 if (util::array_size($e)) {
1716 if (need_wire_pointer($e)) {
1717 pidl "NDR_CHECK(ndr_pull_unique_ptr(ndr, &_ptr_$e->{NAME}));";
1718 pidl "r->$inout.$e->{NAME} = NULL;";
1719 pidl "if (_ptr_$e->{NAME}) {";
1721 } elsif ($inout eq "out" && util::has_property($e, "ref")) {
1722 pidl "if (r->$inout.$e->{NAME}) {";
1728 ParseArrayPull($e, "r->$inout.", "NDR_SCALARS|NDR_BUFFERS");
1732 if ($inout eq "out" && util::has_property($e, "ref")) {
1733 pidl "if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {";
1734 pidl "\tNDR_ALLOC(ndr, r->out.$e->{NAME});";
1737 if ($inout eq "in" && util::has_property($e, "ref")) {
1738 pidl "NDR_ALLOC(ndr, r->in.$e->{NAME});";
1741 ParseElementPullScalar($e, "r->$inout.", "NDR_SCALARS|NDR_BUFFERS");
1742 if ($e->{POINTERS}) {
1743 ParseElementPullBuffer($e, "r->$inout.", "NDR_SCALARS|NDR_BUFFERS");
1748 ############################################################
1749 # allocate ref variables
1750 sub AllocateRefVars($)
1753 my $asize = util::array_size($e);
1755 # note that if the variable is also an "in"
1756 # variable then we copy the initial value from
1759 if (!defined $asize) {
1760 # its a simple variable
1761 pidl "NDR_ALLOC(ndr, r->out.$e->{NAME});";
1762 if (util::has_property($e, "in")) {
1763 pidl "*r->out.$e->{NAME} = *r->in.$e->{NAME};";
1765 pidl "ZERO_STRUCTP(r->out.$e->{NAME});";
1771 my $size = ParseExpr($e, $asize, "r->out.");
1772 check_null_pointer($size);
1773 pidl "NDR_ALLOC_N(ndr, r->out.$e->{NAME}, $size);";
1774 if (util::has_property($e, "in")) {
1775 pidl "memcpy(r->out.$e->{NAME},r->in.$e->{NAME},$size * sizeof(*r->in.$e->{NAME}));";
1777 pidl "memset(r->out.$e->{NAME}, 0, $size * sizeof(*r->out.$e->{NAME}));";
1781 #####################################################################
1783 sub ParseFunctionPull($)
1786 my $static = fn_prefix($fn);
1788 # pull function args
1789 pidl $static . "NTSTATUS ndr_pull_$fn->{NAME}(struct ndr_pull *ndr, int flags, struct $fn->{NAME} *r)";
1793 # declare any internal pointers we need
1794 foreach my $e (@{$fn->{ELEMENTS}}) {
1795 if (need_wire_pointer($e)) {
1796 pidl "uint32_t _ptr_$e->{NAME};";
1800 pidl "if (!(flags & NDR_IN)) goto ndr_out;";
1803 # auto-init the out section of a structure. I originally argued that
1804 # this was a bad idea as it hides bugs, but coping correctly
1805 # with initialisation and not wiping ref vars is turning
1806 # out to be too tricky (tridge)
1807 foreach my $e (@{$fn->{ELEMENTS}}) {
1808 if (util::has_property($e, "out")) {
1809 pidl "ZERO_STRUCT(r->out);";
1815 foreach my $e (@{$fn->{ELEMENTS}}) {
1816 if (util::has_property($e, "in")) {
1817 ParseFunctionElementPull($e, "in");
1819 # we need to allocate any reference output variables, so that
1820 # a dcerpc backend can be sure they are non-null
1821 if (util::has_property($e, "out") && util::has_property($e, "ref")) {
1822 AllocateRefVars($e);
1826 foreach my $e (@{$fn->{ELEMENTS}}) {
1827 if (util::has_property($e, "in")) {
1828 CheckArraySizes($e, "r->in.");
1833 pidl "if (!(flags & NDR_OUT)) goto done;";
1836 foreach my $e (@{$fn->{ELEMENTS}}) {
1837 if (util::has_property($e, "out")) {
1838 ParseFunctionElementPull($e, "out");
1842 foreach my $e (@{$fn->{ELEMENTS}}) {
1843 if (util::has_property($e, "out")) {
1844 CheckArraySizes($e, "r->out.");
1848 if ($fn->{RETURN_TYPE} && $fn->{RETURN_TYPE} ne "void") {
1849 pidl "NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, &r->out.result));";
1854 pidl "return NT_STATUS_OK;";
1860 #####################################################################
1861 # produce a function call table
1862 sub FunctionTable($)
1864 my($interface) = shift;
1865 my($data) = $interface->{INHERITED_DATA};
1867 my $uname = uc $interface->{NAME};
1869 foreach my $d (@{$data}) {
1870 if ($d->{TYPE} eq "FUNCTION") { $count++; }
1873 return if ($count == 0);
1875 pidl "static const struct dcerpc_interface_call $interface->{NAME}\_calls[] = {";
1876 foreach my $d (@{$data}) {
1877 if ($d->{TYPE} eq "FUNCTION") {
1879 pidl "\t\t\"$d->{NAME}\",";
1880 pidl "\t\tsizeof(struct $d->{NAME}),";
1881 pidl "\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},";
1882 pidl "\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},";
1883 pidl "\t\t(ndr_print_function_t) ndr_print_$d->{NAME}";
1887 pidl "\t{ NULL, 0, NULL, NULL, NULL }";
1891 # If no endpoint is set, default to the interface name as a named pipe
1892 if (! defined $interface->{PROPERTIES}->{endpoint}) {
1893 $interface->{PROPERTIES}->{endpoint} = "\"ncacn_np:[\\\\pipe\\\\" . $interface->{NAME} . "]\"";
1896 my @e = split / /, $interface->{PROPERTIES}->{endpoint};
1897 my $endpoint_count = $#e + 1;
1899 pidl "static const char * const $interface->{NAME}\_endpoint_strings[] = {";
1900 foreach my $ep (@e) {
1906 pidl "static const struct dcerpc_endpoint_list $interface->{NAME}\_endpoints = {";
1907 pidl "\t$endpoint_count, $interface->{NAME}\_endpoint_strings";
1911 pidl "\nconst struct dcerpc_interface_table dcerpc_table_$interface->{NAME} = {";
1912 pidl "\t\"$interface->{NAME}\",";
1913 pidl "\tDCERPC_$uname\_UUID,";
1914 pidl "\tDCERPC_$uname\_VERSION,";
1915 pidl "\tDCERPC_$uname\_HELPSTRING,";
1917 pidl "\t$interface->{NAME}\_calls,";
1918 pidl "\t&$interface->{NAME}\_endpoints";
1922 pidl "static NTSTATUS dcerpc_ndr_$interface->{NAME}_init(void)";
1924 pidl "\treturn librpc_register_interface(&dcerpc_table_$interface->{NAME});";
1929 #####################################################################
1930 # parse the interface definitions
1931 sub ParseInterface($)
1933 my($interface) = shift;
1934 my($data) = $interface->{DATA};
1937 foreach my $d (@{$data}) {
1938 ($d->{TYPE} eq "TYPEDEF") &&
1939 ParseTypedefPush($d);
1940 ($d->{TYPE} eq "FUNCTION") &&
1941 ParseFunctionPush($d);
1945 foreach my $d (@{$data}) {
1946 ($d->{TYPE} eq "TYPEDEF") &&
1947 ParseTypedefPull($d);
1948 ($d->{TYPE} eq "FUNCTION") &&
1949 ParseFunctionPull($d);
1953 foreach my $d (@{$data}) {
1954 if ($d->{TYPE} eq "TYPEDEF" &&
1955 !util::has_property($d, "noprint")) {
1956 ParseTypedefPrint($d);
1958 if ($d->{TYPE} eq "FUNCTION" &&
1959 !util::has_property($d, "noprint")) {
1960 ParseFunctionPrint($d);
1965 foreach my $d (@{$data}) {
1966 ($d->{TYPE} eq "TYPEDEF") &&
1967 ParseTypedefNdrSize($d);
1970 FunctionTable($interface);
1973 sub RegistrationFunction($$)
1976 my $filename = shift;
1978 $filename =~ /.*\/ndr_(.*).c/;
1980 pidl "NTSTATUS dcerpc_$basename\_init(void)";
1983 pidl "NTSTATUS status = NT_STATUS_OK;";
1984 foreach my $interface (@{$idl}) {
1985 next if $interface->{TYPE} ne "INTERFACE";
1987 my $data = $interface->{INHERITED_DATA};
1989 foreach my $d (@{$data}) {
1990 if ($d->{TYPE} eq "FUNCTION") { $count++; }
1993 next if ($count == 0);
1995 pidl "status = dcerpc_ndr_$interface->{NAME}_init();";
1996 pidl "if (NT_STATUS_IS_ERR(status)) {";
1997 pidl "\treturn status;";
2001 pidl "return status;";
2007 sub CheckPointerTypes($$)
2010 my $default = shift;
2012 foreach my $e (@{$s->{ELEMENTS}}) {
2013 if ($e->{POINTERS}) {
2014 if (not defined(pointer_type($e))) {
2015 $e->{PROPERTIES}->{$default} = 1;
2018 if (pointer_type($e) eq "ptr") {
2019 print "Warning: ptr is not supported by pidl yet\n";
2025 sub LoadInterface($)
2029 if (not util::has_property($x, "pointer_default")) {
2030 # MIDL defaults to "ptr" in DCE compatible mode (/osf)
2031 # and "unique" in Microsoft Extensions mode (default)
2032 $x->{PROPERTIES}->{pointer_default} = "unique";
2035 foreach my $d (@{$x->{DATA}}) {
2036 if (($d->{TYPE} eq "DECLARE") or ($d->{TYPE} eq "TYPEDEF")) {
2037 $typedefs{$d->{NAME}} = $d;
2038 if ($d->{DATA}->{TYPE} eq "STRUCT" or $d->{DATA}->{TYPE} eq "UNION") {
2039 CheckPointerTypes($d->{DATA}, $x->{PROPERTIES}->{pointer_default});
2042 if (defined($d->{PROPERTIES}) && !defined($d->{DATA}->{PROPERTIES})) {
2043 $d->{DATA}->{PROPERTIES} = $d->{PROPERTIES};
2046 if ($d->{TYPE} eq "FUNCTION") {
2047 CheckPointerTypes($d,
2048 $x->{PROPERTIES}->{pointer_default} # MIDL defaults to "ref"
2054 # Add ORPC specific bits to an interface.
2055 sub InterfaceORPC($)
2058 # Add [in] ORPCTHIS *this, [out] ORPCTHAT *that
2059 # for 'object' interfaces
2060 if (util::has_property($x, "object")) {
2061 foreach my $e (@{$x->{DATA}}) {
2062 if($e->{TYPE} eq "FUNCTION") {
2063 $e->{PROPERTIES}->{object} = 1;
2064 unshift(@{$e->{ELEMENTS}},
2065 { 'NAME' => 'ORPCthis',
2067 'PROPERTIES' => { 'in' => '1' },
2068 'TYPE' => 'ORPCTHIS'
2070 unshift(@{$e->{ELEMENTS}},
2071 { 'NAME' => 'ORPCthat',
2073 'PROPERTIES' => { 'out' => '1' },
2074 'TYPE' => 'ORPCTHAT'
2085 foreach my $x (@{$idl}) {
2090 #####################################################################
2091 # parse a parsed IDL structure back into an IDL file
2095 my($filename) = shift;
2096 my $h_filename = $filename;
2101 if ($h_filename =~ /(.*)\.c/) {
2102 $h_filename = "$1.h";
2105 pidl "/* parser auto-generated by pidl */";
2107 pidl "#include \"includes.h\"";
2108 pidl "#include \"$h_filename\"";
2111 foreach my $x (@{$idl}) {
2112 if ($x->{TYPE} eq "INTERFACE") {
2113 needed::BuildNeeded($x);
2118 RegistrationFunction($idl, $filename);
2123 RegisterPrimitives();