################################################### # Samba4 parser generator for IDL structures # Copyright tridge@samba.org 2000-2003 # Copyright tpot@samba.org 2001,2004 # released under the GNU GPL package IdlEParser; use strict; # the list of needed functions my %needed; my %structs; my $module; my $if_uuid; my $if_version; my $if_endpoints; sub pidl($) { print OUT shift; } ##################################################################### # parse a properties list sub ParseProperties($) { my($props) = shift; foreach my $d (@{$props}) { if (ref($d) ne "HASH") { pidl "[$d] "; } else { foreach my $k (keys %{$d}) { pidl "[$k($d->{$k})] "; } } } } ################################### # find a sibling var in a structure sub find_sibling($$) { my($e) = shift; my($name) = shift; my($fn) = $e->{PARENT}; if ($name =~ /\*(.*)/) { $name = $1; } if ($fn->{TYPE} eq "FUNCTION") { for my $e2 (@{$fn->{DATA}}) { if ($e2->{NAME} eq $name) { return $e2; } } } for my $e2 (@{$fn->{ELEMENTS}}) { if ($e2->{NAME} eq $name) { return $e2; } } die "invalid sibling '$name'"; } #################################################################### # work out the name of a size_is() variable sub find_size_var($$) { my($e) = shift; my($size) = shift; my($fn) = $e->{PARENT}; if (util::is_constant($size)) { return $size; } if ($size =~ /ndr->|\(/) { return $size; } my $prefix = ""; if ($size =~ /\*(.*)/) { $size = $1; $prefix = "*"; } if ($fn->{TYPE} ne "FUNCTION") { return $prefix . "elt_$size"; } my $e2 = find_sibling($e, $size); if (util::has_property($e2, "in") && util::has_property($e2, "out")) { return $prefix . "elt_$size"; } if (util::has_property($e2, "in")) { return $prefix . "elt_$size"; } if (util::has_property($e2, "out")) { return $prefix . "elt_$size"; } die "invalid variable in $size for element $e->{NAME} in $fn->{NAME}\n"; } ##################################################################### # work out is a parse function should be declared static or not sub fn_prefix($) { my $fn = shift; if ($fn->{TYPE} eq "TYPEDEF") { if (util::has_property($fn->{DATA}, "public")) { return ""; } } if ($fn->{TYPE} eq "FUNCTION") { if (util::has_property($fn, "public")) { return ""; } } return "static "; } ################################################################### # setup any special flags for an element or structure sub start_flags($) { my $e = shift; my $flags = util::has_property($e, "flag"); if (defined $flags) { pidl "\t{ guint32 _flags_save_$e->{TYPE} = ndr->flags;\n"; pidl "\tndr->flags |= $flags;\n"; } } ################################################################### # end any special flags for an element or structure sub end_flags($) { my $e = shift; my $flags = util::has_property($e, "flag"); if (defined $flags) { pidl "\tndr->flags = _flags_save_$e->{TYPE};\n\t}\n"; } } ##################################################################### # work out the correct alignment for a structure sub struct_alignment { my $s = shift; my $align = 1; for my $e (@{$s->{ELEMENTS}}) { my $a = 1; if (!util::need_wire_pointer($e) && defined $structs{$e->{TYPE}}) { if ($structs{$e->{TYPE}}->{DATA}->{TYPE} eq "STRUCT") { $a = struct_alignment($structs{$e->{TYPE}}->{DATA}); } elsif ($structs{$e->{TYPE}}->{DATA}->{TYPE} eq "UNION") { if (defined $structs{$e->{TYPE}}->{DATA}) { $a = union_alignment($structs{$e->{TYPE}}->{DATA}); } } } else { $a = util::type_align($e); } if ($align < $a) { $align = $a; } } return $align; } ##################################################################### # work out the correct alignment for a union sub union_alignment { my $u = shift; my $align = 1; foreach my $e (@{$u->{DATA}}) { my $a = 1; if ($e->{TYPE} eq "EMPTY") { next; } if (!util::need_wire_pointer($e) && defined $structs{$e->{DATA}->{TYPE}}) { my $s = $structs{$e->{DATA}->{TYPE}}; if ($s->{DATA}->{TYPE} eq "STRUCT") { $a = struct_alignment($s->{DATA}); } elsif ($s->{DATA}->{TYPE} eq "UNION") { $a = union_alignment($s->{DATA}); } } else { $a = util::type_align($e->{DATA}); } if ($align < $a) { $align = $a; } } return $align; } ##################################################################### # parse an array - pull side sub ParseArrayPull($$) { my $e = shift; my $ndr_flags = shift; my $size = find_size_var($e, util::array_size($e)); my $alloc_size = $size; # if this is a conformant array then we use that size to allocate, and make sure # we allocate enough to pull the elements if (defined $e->{CONFORMANT_SIZE}) { $alloc_size = $e->{CONFORMANT_SIZE}; pidl "\tif ($size > $alloc_size) {\n"; pidl "\t\tproto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"Bad conformant size (%u should be %u)\", $alloc_size, $size);\n"; pidl "\t\tif (check_col(ndr->pinfo->cinfo, COL_INFO))\n"; pidl "\t\t\tcol_append_fstr(ndr->pinfo->cinfo, COL_INFO, \", Bad conformant size\", $alloc_size, $size);\n"; pidl "\t}\n"; } elsif (!util::is_inline_array($e)) { # if ($var_prefix =~ /^r->out/ && $size =~ /^\*r->in/) { # my $size2 = substr($size, 1); # pidl "if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) { NDR_ALLOC(ndr, $size2); }\n"; # } # non fixed arrays encode the size just before the array pidl "\t{\n"; pidl "\t\tguint32 _array_size;\n\n"; pidl "\t\tndr_pull_uint32(ndr, tree, hf_array_size, &_array_size);\n"; if ($size =~ /r->in/) { pidl "\t\tif (!(ndr->flags & LIBNDR_FLAG_REF_ALLOC) && _array_size != $size) {\n"; } else { pidl "\t\tif ($size != _array_size) {\n"; } pidl "\t\t\tproto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"Bad array size (%u should be %u)\", _array_size, $size);\n"; pidl "\t\t\tif (check_col(ndr->pinfo->cinfo, COL_INFO))\n"; pidl "\t\t\t\tcol_append_fstr(ndr->pinfo->cinfo, COL_INFO, \", Bad array size (%u should be %u)\", _array_size, $size);\n"; pidl "\t\t}\n"; if ($size =~ /r->in/) { pidl "else { $size = _array_size; }\n"; } pidl "\t}\n"; } # if ((util::need_alloc($e) && !util::is_fixed_array($e)) || # ($var_prefix eq "r->in." && util::has_property($e, "ref"))) { # if (!util::is_inline_array($e) || $ndr_flags eq "NDR_SCALARS") { # pidl "\t\tNDR_ALLOC_N(ndr, $var_prefix$e->{NAME}, MAX(1, $alloc_size));\n"; # } # } # if (($var_prefix eq "r->out." && util::has_property($e, "ref"))) { # if (!util::is_inline_array($e) || $ndr_flags eq "NDR_SCALARS") { # pidl "\tif (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {"; # pidl "\t\tNDR_ALLOC_N(ndr, $var_prefix$e->{NAME}, MAX(1, $alloc_size));\n"; # pidl "\t}\n"; # } # } pidl "\t{\n"; if (my $length = util::has_property($e, "length_is")) { $length = find_size_var($e, $length); pidl "\t\tguint32 _offset, _length;\n"; pidl "\t\tndr_pull_uint32(ndr, tree, hf_array_offset, &_offset);\n"; pidl "\t\tndr_pull_uint32(ndr, tree, hf_array_length, &_length);\n"; pidl "\t\tif (_offset != 0) {\n"; pidl "\t\t\tproto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"Bad array offset %d\", _offset);\n"; pidl "\t\t\tif (check_col(ndr->pinfo->cinfo, COL_INFO))\n"; pidl "\t\t\t\tcol_append_fstr(ndr->pinfo->cinfo, COL_INFO, \"Bad array offset %d\", _offset);\n"; pidl "\t\t}\n"; pidl "\t\tif (_length > $size || _length != $length) {\n"; pidl "\t\t\tproto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"Bad array length %d > size %d\", _offset, $size);\n"; pidl "\t\t\tif (check_col(ndr->pinfo->cinfo, COL_INFO))\n"; pidl "\t\t\t\tcol_append_fstr(ndr->pinfo->cinfo, COL_INFO, \", Bad array length %d > size %d\", _offset, $size);\n"; pidl "\t\t}\n"; $size = "_length"; } if (util::is_scalar_type($e->{TYPE})) { pidl "\t\tndr_pull_array_$e->{TYPE}(ndr, tree, hf_$e->{NAME}_$e->{TYPE}, $ndr_flags, $size);\n"; } else { pidl "\t\tndr_pull_array(ndr, tree, $ndr_flags, $size, ndr_pull_$e->{TYPE});\n"; } pidl "\t}\n"; } ##################################################################### # parse scalars in a structure element - pull size sub ParseElementPullSwitch($$$) { my($e) = shift; my($ndr_flags) = shift; my $switch = shift; my $switch_var = find_size_var($e, $switch); my $cprefix = util::c_pull_prefix($e); my $utype = $structs{$e->{TYPE}}; if (!defined $utype || !util::has_property($utype->{DATA}, "nodiscriminant")) { my $e2 = find_sibling($e, $switch); pidl "\tguint16 _level;\n"; pidl "\tif (($ndr_flags) & NDR_SCALARS) {\n"; pidl "\t\tndr_pull_level(ndr, tree, hf_level, &_level);\n"; pidl "\t}\n"; } my $sub_size = util::has_property($e, "subcontext"); if (defined $sub_size) { pidl "\tndr_pull_subcontext_union_fn(ndr, tree, $sub_size, $switch_var, (ndr_pull_union_fn_t) ndr_pull_$e->{TYPE});\n"; } else { pidl "\tndr_pull_$e->{TYPE}(ndr, tree, $ndr_flags, _level);\n"; } } ##################################################################### # parse scalars in a structure element - pull size sub ParseElementPullScalar($$) { my($e) = shift; my($ndr_flags) = shift; my $cprefix = util::c_pull_prefix($e); my $sub_size = util::has_property($e, "subcontext"); start_flags($e); if (util::has_property($e, "relative")) { pidl "\tndr_pull_relative(ndr, subtree_$e->{NAME}, ndr_pull_$e->{TYPE});\n"; } elsif (util::is_inline_array($e)) { ParseArrayPull($e, "NDR_SCALARS"); } elsif (util::need_wire_pointer($e)) { pidl "\tndr_pull_ptr(ndr, tree, hf_ptr, &ptr_$e->{NAME});\n"; # pidl "\tif (ptr_$e->{NAME}) {\n"; # pidl "\t\tNDR_ALLOC(ndr, $var_prefix$e->{NAME});\n"; # pidl "\t} else {\n"; # pidl "\t\t$var_prefix$e->{NAME} = NULL;\n"; # pidl "\t}\n"; } elsif (util::need_alloc($e)) { # no scalar component } elsif (my $switch = util::has_property($e, "switch_is")) { ParseElementPullSwitch($e, $ndr_flags, $switch); } elsif (defined $sub_size) { if (util::is_builtin_type($e->{TYPE})) { pidl "\tndr_pull_subcontext_fn(ndr, tree, $sub_size, (ndr_pull_fn_t) ndr_pull_$e->{TYPE});\n"; } else { pidl "\tndr_pull_subcontext_flags_fn(ndr, tree, $sub_size, (ndr_pull_flags_fn_t) ndr_pull_$e->{TYPE});\n"; } } elsif (util::is_builtin_type($e->{TYPE})) { pidl "\tndr_pull_$e->{TYPE}(ndr, tree, hf_$e->{NAME}_$e->{TYPE}, &elt_$e->{NAME});\n"; } else { pidl "\tndr_pull_$e->{TYPE}(ndr, subtree_$e->{NAME}, $ndr_flags);\n"; } end_flags($e); } ##################################################################### # parse buffers in a structure element - pull side sub ParseElementPullBuffer($$) { my($e) = shift; my($ndr_flags) = shift; my $cprefix = util::c_pull_prefix($e); my $sub_size = util::has_property($e, "subcontext"); if (util::is_pure_scalar($e)) { return; } if (util::has_property($e, "relative")) { return; } start_flags($e); if (util::need_wire_pointer($e)) { pidl "\tif (ptr_$e->{NAME}) {\n"; } if (util::is_inline_array($e)) { ParseArrayPull($e, "NDR_BUFFERS"); } elsif (util::array_size($e)) { ParseArrayPull($e, "NDR_SCALARS|NDR_BUFFERS"); } elsif (my $switch = util::has_property($e, "switch_is")) { if ($e->{POINTERS}) { ParseElementPullSwitch($e, "NDR_SCALARS|NDR_BUFFERS", $switch); } else { ParseElementPullSwitch($e, "NDR_BUFFERS", $switch); } } elsif (defined $sub_size) { if ($e->{POINTERS}) { if (util::is_builtin_type($e->{TYPE})) { pidl "\tndr_pull_subcontext_fn(ndr, tree, $sub_size, _pull_$e->{TYPE});\n"; } else { pidl "\tndr_pull_subcontext_flags_fn(ndr, tree, $sub_size, ndr_pull_$e->{TYPE});\n"; } } } elsif (util::is_builtin_type($e->{TYPE})) { pidl "\tndr_pull_$e->{TYPE}(ndr, tree, hf_$e->{NAME}_$e->{TYPE}, &elt_$e->{NAME});\n"; } elsif ($e->{POINTERS}) { pidl "\tndr_pull_$e->{TYPE}(ndr, tree, NDR_SCALARS|NDR_BUFFERS);\n"; } else { pidl "\tndr_pull_$e->{TYPE}(ndr, subtree_$e->{NAME}, $ndr_flags);\n"; } if (util::need_wire_pointer($e)) { pidl "\t}\n"; } end_flags($e); } ##################################################################### # parse a struct - pull side sub ParseStructPull($) { my($struct) = shift; my $conform_e; for my $x (@{$struct->{ELEMENTS}}) { pidl "\tg$x->{TYPE} elt_$x->{NAME};\n", if util::is_builtin_type($x->{TYPE}); } if (! defined $struct->{ELEMENTS}) { return; } # see if the structure contains a conformant array. If it # does, then it must be the last element of the structure, and # we need to pull the conformant length early, as it fits on # the wire before the structure (and even before the structure # alignment) my $e = $struct->{ELEMENTS}[-1]; if (defined $e->{ARRAY_LEN} && $e->{ARRAY_LEN} eq "*") { $conform_e = $e; pidl "\tguint32 _conformant_size;\n"; $conform_e->{CONFORMANT_SIZE} = "_conformant_size"; } # declare any internal pointers we need foreach my $e (@{$struct->{ELEMENTS}}) { if (util::need_wire_pointer($e) && !util::has_property($e, "relative")) { pidl "\tguint32 ptr_$e->{NAME};\n"; } if (!util::is_scalar_type($e->{TYPE})) { pidl "\tproto_tree *subtree_$e->{NAME} = tree;\n"; } } pidl "\n"; # Some debugging stuff pidl "\tif ((ndr_flags & (NDR_SCALARS|NDR_BUFFERS)) == (NDR_SCALARS|NDR_BUFFERS))\n"; pidl "\t\tproto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"NDR_SCALARS|NDR_BUFFERS\");\n"; pidl "\telse if (ndr_flags & NDR_SCALARS)\n"; pidl "\t\tproto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"NDR_SCALARS\");\n"; pidl "\telse if (ndr_flags & NDR_BUFFERS)\n"; pidl "\t\tproto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"NDR_BUFFERS\");\n"; pidl "\n"; start_flags($struct); pidl "\tif ((ndr_flags & (NDR_SCALARS|NDR_BUFFERS)) == (NDR_SCALARS|NDR_BUFFERS)) {\n"; pidl "\t\tproto_item *item = proto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"$struct->{PARENT}{NAME}\");\n"; pidl "\t\ttree = proto_item_add_subtree(item, ett_$struct->{PARENT}{NAME});\n"; foreach my $e (@{$struct->{ELEMENTS}}) { if (!util::is_scalar_type($e->{TYPE})) { pidl "\t\titem = proto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"$e->{NAME}\");\n"; pidl "\t\tsubtree_$e->{NAME} = proto_item_add_subtree(item, ett_dcerpc_$module);\n"; } } pidl "\t}\n\n"; pidl "\tif (!(ndr_flags & NDR_SCALARS)) goto buffers;\n\n"; pidl "\tndr_pull_struct_start(ndr);\n"; if (defined $conform_e) { pidl "\tndr_pull_uint32(ndr, tree, hf_conformant_size, &$conform_e->{CONFORMANT_SIZE});\n"; } my $align = struct_alignment($struct); pidl "\tndr_pull_align(ndr, $align);\n"; foreach my $e (@{$struct->{ELEMENTS}}) { ParseElementPullScalar($e, "NDR_SCALARS"); } pidl "\nbuffers:\n\n"; pidl "\tif (!(ndr_flags & NDR_BUFFERS)) goto done;\n"; foreach my $e (@{$struct->{ELEMENTS}}) { ParseElementPullBuffer($e, "NDR_BUFFERS"); } pidl "\tndr_pull_struct_end(ndr);\n"; pidl "done: ;\n"; end_flags($struct); } ##################################################################### # parse a union - pull side sub ParseUnionPull($) { my $e = shift; my $have_default = 0; start_flags($e); pidl "\titem = proto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"$e->{PARENT}{NAME}\");\n"; pidl "\ttree = proto_item_add_subtree(item, ett_$e->{PARENT}{NAME});\n"; pidl "\tif (!(ndr_flags & NDR_SCALARS)) goto buffers;\n"; pidl "\tndr_pull_struct_start(ndr);\n"; # my $align = union_alignment($e); # pidl "\tndr_pull_align(ndr, $align);\n"; pidl "\tswitch (level) {\n"; foreach my $el (@{$e->{DATA}}) { if ($el->{CASE} eq "default") { pidl "\t\tdefault: {\n"; $have_default = 1; } else { pidl "\tcase $el->{CASE}: {\n"; pidl "\tproto_tree *subtree_$el->{DATA}{NAME} = tree;\n"; } if ($el->{TYPE} eq "UNION_ELEMENT") { my $e2 = $el->{DATA}; if ($e2->{POINTERS}) { pidl "\t\tguint32 ptr_$e2->{NAME};\n"; } ParseElementPullScalar($el->{DATA}, "NDR_SCALARS"); } pidl "\t\tbreak;\n\t}\n"; } if (! $have_default) { pidl "\tdefault:\n"; pidl "\t\tproto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"Bad switch value %u\", level);\n"; pidl "\t\tif (check_col(ndr->pinfo->cinfo, COL_INFO))\n"; pidl "\t\t\tcol_append_fstr(ndr->pinfo->cinfo, COL_INFO, \", Bad switch value %u\", level);\n"; } pidl "\t}\n"; pidl "buffers:\n"; pidl "\tif (!(ndr_flags & NDR_BUFFERS)) goto done;\n"; pidl "\tswitch (level) {\n"; foreach my $el (@{$e->{DATA}}) { if ($el->{CASE} eq "default") { pidl "\tdefault:\n"; } else { pidl "\tcase $el->{CASE}: {\n"; pidl "\tproto_tree *subtree_$el->{DATA}{NAME} = tree;\n"; } if ($el->{TYPE} eq "UNION_ELEMENT") { ParseElementPullBuffer($el->{DATA}, "NDR_BUFFERS"); } pidl "\t\tbreak;\n\t}\n"; } if (! $have_default) { pidl "\tdefault:\n"; pidl "\t\tproto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"Bad switch value %u\", level);\n"; pidl "\t\tif (check_col(ndr->pinfo->cinfo, COL_INFO))\n"; pidl "\t\t\tcol_append_fstr(ndr->pinfo->cinfo, COL_INFO, \", 7Bad switch value %u\", level);\n"; } pidl "\t}\n"; pidl "\tndr_pull_struct_end(ndr);\n"; pidl "done:\n"; end_flags($e); } ##################################################################### # parse a enum - pull side sub ParseEnumPull($) { my $e = shift; my $name; my $ndx = 0; for my $x (@{$e->{ELEMENTS}}) { if ($x =~ /([a-zA-Z_]+)=([0-9]+)/) { $name = $1; $ndx = $2; } else { $name = $x; } pidl "#define $name $ndx\n"; $ndx++; } pidl "\n"; } ##################################################################### # parse a type sub ParseTypePull($) { my($data) = shift; if (ref($data) eq "HASH") { ($data->{TYPE} eq "STRUCT") && ParseStructPull($data); ($data->{TYPE} eq "UNION") && ParseUnionPull($data); ($data->{TYPE} eq "ENUM") && ParseEnumPull($data); } } ##################################################################### # parse a typedef - pull side sub ParseTypedefPull($) { my($e) = shift; my $static = fn_prefix($e); # if (! $needed{"pull_$e->{NAME}"}) { # print "pull_$e->{NAME} not needed\n"; # return; # } pidl "/*\n\n"; pidl IdlDump::DumpTypedef($e); pidl "*/\n\n"; if ($e->{DATA}->{TYPE} eq "STRUCT") { pidl "static gint ett_$e->{NAME} = -1;\n\n"; pidl $static . "void ndr_pull_$e->{NAME}(struct e_ndr_pull *ndr, proto_tree *tree, int ndr_flags)"; pidl "\n{\n"; ParseTypePull($e->{DATA}); pidl "}\n\n"; } if ($e->{DATA}->{TYPE} eq "UNION") { pidl "static gint ett_$e->{NAME} = -1;\n\n"; pidl $static . "void ndr_pull_$e->{NAME}(struct e_ndr_pull *ndr, proto_tree *tree, int ndr_flags, int level)"; pidl "\n{\n"; pidl "\tproto_item *item = NULL;\n"; ParseTypePull($e->{DATA}); pidl "}\n\n"; } if ($e->{DATA}->{TYPE} eq "ENUM") { ParseEnumPull($e->{DATA}); } } ##################################################################### # parse a function element sub ParseFunctionElementPull($$) { my $e = shift; my $inout = shift; if (util::array_size($e)) { if (util::need_wire_pointer($e)) { pidl "\tndr_pull_ptr(ndr, &ptr_$e->{NAME});\n"; pidl "\tif (ptr_$e->{NAME}) {\n"; } elsif ($inout eq "out" && util::has_property($e, "ref")) { pidl "\tif (r->$inout.$e->{NAME}) {\n"; } else { pidl "\t{\n"; } ParseArrayPull($e, "NDR_SCALARS|NDR_BUFFERS"); pidl "\t}\n"; } else { if ($inout eq "out" && util::has_property($e, "ref")) { # pidl "\tif (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {\n"; # pidl "\tNDR_ALLOC(ndr, r->out.$e->{NAME});\n"; # pidl "\t}\n"; } if ($inout eq "in" && util::has_property($e, "ref")) { # pidl "\tNDR_ALLOC(ndr, r->in.$e->{NAME});\n"; } ParseElementPullScalar($e, "NDR_SCALARS|NDR_BUFFERS"); if ($e->{POINTERS}) { ParseElementPullBuffer($e, "NDR_SCALARS|NDR_BUFFERS"); } } } ##################################################################### # parse a function sub ParseFunctionPull($) { my($fn) = shift; my $static = fn_prefix($fn); # Comment displaying IDL for this function pidl "/*\n\n"; pidl IdlDump::DumpFunction($fn); pidl "*/\n\n"; # Request pidl $static . "int $fn->{NAME}_rqst(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *toplevel_tree, guint8 *drep)\n"; pidl "{\n"; pidl "\tstruct e_ndr_pull *ndr = ndr_pull_init(tvb, offset, pinfo, drep);\n"; pidl "\tproto_item *item;\n"; pidl "\tproto_tree *tree = toplevel_tree;\n"; # declare any internal pointers we need foreach my $e (@{$fn->{DATA}}) { if (util::has_property($e, "in")) { if (util::need_wire_pointer($e)) { pidl "\tguint32 ptr_$e->{NAME};\n"; } pidl "\tg$e->{TYPE} elt_$e->{NAME};\n", if util::is_builtin_type($e->{TYPE}); if (util::need_wire_pointer($e) || !util::is_scalar_type($e->{TYPE})) { pidl "\tproto_tree *subtree_$e->{NAME} = tree;\n"; } } } pidl "\n"; foreach my $e (@{$fn->{DATA}}) { if (util::has_property($e, "in") && !util::is_scalar_type($e->{TYPE})) { pidl "\titem = proto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"$e->{NAME}\");\n"; pidl "\tsubtree_$e->{NAME} = proto_item_add_subtree(item, ett_dcerpc_$module);\n"; } } pidl "\n"; foreach my $e (@{$fn->{DATA}}) { if (util::has_property($e, "in")) { ParseFunctionElementPull($e, "in"); } } pidl "\toffset = ndr->offset;\n"; pidl "\tndr_pull_free(ndr);\n"; pidl "\n"; pidl "\treturn offset;\n"; pidl "}\n\n"; # Response pidl $static . "int $fn->{NAME}_resp(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *toplevel_tree, guint8 *drep)\n"; pidl "{\n"; pidl "\tstruct e_ndr_pull *ndr = ndr_pull_init(tvb, offset, pinfo, drep);\n"; pidl "\tproto_item *item;\n"; pidl "\tproto_tree *tree = toplevel_tree;\n"; # declare any internal pointers we need foreach my $e (@{$fn->{DATA}}) { if (util::has_property($e, "out")) { if (util::need_wire_pointer($e)) { pidl "\tguint32 ptr_$e->{NAME};\n"; } pidl "\tg$e->{TYPE} elt_$e->{NAME};\n", if util::is_builtin_type($e->{TYPE}); if (util::need_wire_pointer($e) || !util::is_scalar_type($e->{TYPE})) { pidl "\tproto_tree *subtree_$e->{NAME} = tree;\n"; } } } pidl "\n"; foreach my $e (@{$fn->{DATA}}) { if (util::has_property($e, "out") && !util::is_scalar_type($e->{TYPE})) { pidl "\titem = proto_tree_add_text(tree, ndr->tvb, ndr->offset, 0, \"$e->{NAME}\");\n"; pidl "\tsubtree_$e->{NAME} = proto_item_add_subtree(item, ett_dcerpc_$module);\n"; } } pidl "\n"; foreach my $e (@{$fn->{DATA}}) { if (util::has_property($e, "out")) { ParseFunctionElementPull($e, "out"); } } if ($fn->{RETURN_TYPE} && $fn->{RETURN_TYPE} ne "void") { pidl "\tndr_pull_$fn->{RETURN_TYPE}(ndr, tree, hf_rc);\n"; } pidl "\toffset = ndr->offset;\n"; pidl "\tndr_pull_free(ndr);\n"; pidl "\n"; pidl "\treturn offset;\n"; pidl "}\n\n"; } ##################################################################### # produce a function call table sub FunctionTable($) { my($interface) = shift; my($data) = $interface->{DATA}; my $count = 0; my $uname = uc $interface->{NAME}; foreach my $d (@{$data}) { if ($d->{TYPE} eq "FUNCTION") { $count++; } } if ($count == 0) { return; } pidl "static dcerpc_sub_dissector dcerpc_dissectors[] = {\n"; my $num = 0; foreach my $d (@{$data}) { if ($d->{TYPE} eq "FUNCTION") { # Strip module name from function name, if present my($n) = $d->{NAME}; $n = substr($d->{NAME}, length($module) + 1), if $module eq substr($d->{NAME}, 0, length($module)); pidl "\t{ $num, \"$n\",\n"; pidl "\t\t$d->{NAME}_rqst,\n"; pidl "\t\t$d->{NAME}_resp },\n"; $num++; } } pidl "};\n\n"; } ##################################################################### # parse the interface definitions sub ParseInterface($) { my($interface) = shift; my($data) = $interface->{DATA}; foreach my $d (@{$data}) { if ($d->{TYPE} eq "TYPEDEF") { $structs{$d->{NAME}} = $d; } } foreach my $d (@{$data}) { ($d->{TYPE} eq "TYPEDEF") && ParseTypedefPull($d); ($d->{TYPE} eq "FUNCTION") && ParseFunctionPull($d); } FunctionTable($interface); } sub type2ft($) { my($t) = shift; return "FT_UINT32", if ($t eq "uint32"); return "FT_UINT16", if ($t eq "uint16"); return "FT_UINT8", if ($t eq "uint8"); return "FT_BYTES"; } sub type2base($) { my($t) = shift; return "BASE_DEC", if ($t eq "uint32") or ($t eq "uint16") or ($t eq "uint8"); return "BASE_NONE"; } sub NeededFunction($) { my $fn = shift; foreach my $e (@{$fn->{DATA}}) { $needed{"hf_$e->{NAME}_$e->{TYPE}"} = { 'name' => $e->{NAME}, 'type' => $e->{TYPE}, 'ft' => type2ft($e->{TYPE}), 'base' => type2base($e->{TYPE}) }; $e->{PARENT} = $fn; } } sub NeededTypedef($) { my $t = shift; if (util::has_property($t->{DATA}, "public")) { $needed{"pull_$t->{NAME}"} = 1; } if ($t->{DATA}->{TYPE} eq "STRUCT") { $needed{"ett_$t->{NAME}"} = 1; for my $e (@{$t->{DATA}->{ELEMENTS}}) { $needed{"hf_$e->{NAME}_$e->{TYPE}"} = { 'name' => $e->{NAME}, 'type' => $e->{TYPE}, 'ft' => type2ft($e->{TYPE}), 'base' => type2base($e->{TYPE}) }; $e->{PARENT} = $t->{DATA}; if ($needed{"pull_$t->{NAME}"}) { $needed{"pull_$e->{TYPE}"} = 1; } } } if ($t->{DATA}->{TYPE} eq "UNION") { $needed{"ett_$t->{NAME}"} = 1; for my $e (@{$t->{DATA}->{DATA}}) { $e->{PARENT} = $t->{DATA}; if ($e->{TYPE} eq "UNION_ELEMENT") { if ($needed{"pull_$t->{NAME}"}) { $needed{"pull_$e->{DATA}->{TYPE}"} = 1; } } } } } ##################################################################### # work out what parse functions are needed sub BuildNeeded($) { my($interface) = shift; my($data) = $interface->{DATA}; foreach my $d (@{$data}) { ($d->{TYPE} eq "FUNCTION") && NeededFunction($d); } foreach my $d (reverse @{$data}) { ($d->{TYPE} eq "TYPEDEF") && NeededTypedef($d); } } ##################################################################### # parse the interface definitions sub ModuleHeader($) { my($h) = shift; $if_uuid = $h->{PROPERTIES}->{uuid}; $if_version = $h->{PROPERTIES}->{version}; $if_endpoints = $h->{PROPERTIES}->{endpoints}; } sub ParseHeader($$) { my($idl) = shift; my($filename) = shift; open(OUT, ">$filename") || die "can't open $filename"; pidl "/* parser auto-generated by pidl */\n\n"; foreach my $x (@{$idl}) { if ($x->{TYPE} eq "INTERFACE") { foreach my $d (@{$x->{DATA}}) { if ($d->{TYPE} eq "TYPEDEF" and util::has_property($d->{DATA}, "public")) { if ($d->{DATA}{TYPE} eq "STRUCT") { pidl "void ndr_pull_$d->{NAME}(struct e_ndr_pull *ndr, proto_tree *tree, int ndr_flags);\n"; } if ($d->{DATA}{TYPE} eq "UNION") { pidl "void ndr_pull_$d->{NAME}(struct e_ndr_pull *ndr, proto_tree *tree, int ndr_flags, int level);\n"; } } } } } close(OUT); } ##################################################################### # parse a parsed IDL structure back into an IDL file sub Parse($$) { my($idl) = shift; my($filename) = shift; %needed = (); open(OUT, ">$filename") || die "can't open $filename"; foreach my $x (@{$idl}) { ($x->{TYPE} eq "MODULEHEADER") && ModuleHeader($x); if ($x->{TYPE} eq "INTERFACE") { $module = $x->{NAME}; BuildNeeded($x); } } pidl "/* parser auto-generated by pidl */\n\n"; pidl "#ifdef HAVE_CONFIG_H\n"; pidl "#include \"config.h\"\n"; pidl "#endif\n\n"; pidl "#include \"packet-dcerpc.h\"\n"; pidl "#include \"packet-dcerpc-nt.h\"\n\n"; pidl "#include \"packet-dcerpc-eparser.h\"\n\n"; pidl "extern const value_string NT_errors[];\n\n"; pidl "static int proto_dcerpc_$module = -1;\n\n"; pidl "static gint ett_dcerpc_$module = -1;\n\n"; pidl "static int hf_opnum = -1;\n"; pidl "static int hf_rc = -1;\n"; pidl "static int hf_ptr = -1;\n"; pidl "static int hf_array_size = -1;\n"; pidl "static int hf_array_offset = -1;\n"; pidl "static int hf_array_length = -1;\n"; pidl "static int hf_conformant_size = -1;\n"; pidl "static int hf_level = -1;\n"; # Declarations for hf variables foreach my $y (keys(%needed)) { pidl "static int $y = -1;\n", if $y =~ /^hf_/; } pidl "\n"; for my $x (@{$idl}) { ParseInterface($x); } # Only perform module initialisation if we found a uuid if (defined($if_uuid)) { pidl "static e_uuid_t uuid_dcerpc_$module = {\n"; pidl "\t0x" . substr($if_uuid, 0, 8); pidl ", 0x" . substr($if_uuid, 9, 4); pidl ", 0x" . substr($if_uuid, 14, 4) . ",\n"; pidl "\t{ 0x" . substr($if_uuid, 19, 2); pidl ", 0x" . substr($if_uuid, 21, 2); pidl ", 0x" . substr($if_uuid, 24, 2); pidl ", 0x" . substr($if_uuid, 26, 2); pidl ", 0x" . substr($if_uuid, 28, 2); pidl ", 0x" . substr($if_uuid, 30, 2); pidl ", 0x" . substr($if_uuid, 32, 2); pidl ", 0x" . substr($if_uuid, 34, 2) . " }\n"; pidl "};\n\n"; pidl "static guint16 ver_dcerpc_$module = " . $if_version . ";\n\n"; } pidl "void proto_register_dcerpc_$module(void)\n"; pidl "{\n"; pidl "\tstatic hf_register_info hf[] = {\n"; pidl "\t{ &hf_opnum, { \"Operation\", \"$module.opnum\", FT_UINT16, BASE_DEC, NULL, 0x0, \"Operation\", HFILL }},\n"; pidl "\t{ &hf_rc, { \"Return code\", \"$module.rc\", FT_UINT32, BASE_HEX, VALS(NT_errors), 0x0, \"Return status code\", HFILL }},\n"; pidl "\t{ &hf_array_size, { \"Array size\", \"$module.array_size\", FT_UINT32, BASE_DEC, NULL, 0x0, \"Array size\", HFILL }},\n"; pidl "\t{ &hf_array_offset, { \"Array offset\", \"$module.array_offset\", FT_UINT32, BASE_DEC, NULL, 0x0, \"Array offset\", HFILL }},\n"; pidl "\t{ &hf_array_length, { \"Array length\", \"$module.array_length\", FT_UINT32, BASE_DEC, NULL, 0x0, \"Array length\", HFILL }},\n"; pidl "\t{ &hf_conformant_size, { \"Conformant size\", \"$module.conformant_size\", FT_UINT32, BASE_DEC, NULL, 0x0, \"Conformant size\", HFILL }},\n"; pidl "\t{ &hf_level, { \"Level\", \"$module.level\", FT_UINT32, BASE_DEC, NULL, 0x0, \"Level\", HFILL }},\n"; pidl "\t{ &hf_ptr, { \"Pointer\", \"$module.ptr\", FT_UINT32, BASE_HEX, NULL, 0x0, \"Pointer\", HFILL }},\n"; foreach my $x (keys(%needed)) { next, if !($x =~ /^hf_/); pidl "\t{ &$x,\n"; pidl "\t { \"$needed{$x}{name}\", \"$x\", $needed{$x}{ft}, $needed{$x}{base}, NULL, 0, \"$x\", HFILL }},\n"; } pidl "\t};\n\n"; pidl "\tstatic gint *ett[] = {\n"; pidl "\t\t&ett_dcerpc_$module,\n"; foreach my $x (keys(%needed)) { pidl "\t\t&$x,\n", if $x =~ /^ett_/; } pidl "\t};\n\n"; if (defined($if_uuid)) { pidl "\tproto_dcerpc_$module = proto_register_protocol(\"$module\", \"$module\", \"$module\");\n\n"; pidl "\tproto_register_field_array(proto_dcerpc_$module, hf, array_length (hf));\n"; pidl "\tproto_register_subtree_array(ett, array_length(ett));\n"; pidl "}\n\n"; pidl "void proto_reg_handoff_dcerpc_$module(void)\n"; pidl "{\n"; pidl "\tdcerpc_init_uuid(proto_dcerpc_$module, ett_dcerpc_$module, \n"; pidl "\t\t&uuid_dcerpc_$module, ver_dcerpc_$module, \n"; pidl "\t\tdcerpc_dissectors, hf_opnum);\n"; pidl "}\n"; } else { pidl "\tint proto_dcerpc;\n\n"; pidl "\tproto_dcerpc = proto_get_id_by_filter_name(\"dcerpc\");\n"; pidl "\tproto_register_field_array(proto_dcerpc, hf, array_length(hf));\n"; pidl "\tproto_register_subtree_array(ett, array_length(ett));\n"; pidl "}\n"; } close(OUT); } 1;