pidl/lib/Parse/Pidl/Wireshark/NDR.pm

   1 ##################################################
   2 # Wireshark NDR parser generator for IDL structures
   3 # Copyright tridge@samba.org 2000-2003
   4 # Copyright tpot@samba.org 2001,2005
   5 # Copyright jelmer@samba.org 2004-2007
   6 # Portions based on idl2eth.c by Ronnie Sahlberg
   7 # released under the GNU GPL
   8
   9 =pod
  10
  11 =head1 NAME
  12
  13 Parse::Pidl::Wireshark::NDR - Parser generator for Wireshark
  14
  15 =cut
  16
  17 package Parse::Pidl::Wireshark::NDR;
  18
  19 use Exporter;
  20 @ISA = qw(Exporter);
  21 @EXPORT_OK = qw(field2name %res PrintIdl StripPrefixes RegisterInterfaceHandoff register_hf_field CheckUsed ProcessImport ProcessInclude find_type DumpEttList DumpEttDeclaration DumpHfList DumpHfDeclaration DumpFunctionTable register_type register_ett);
  22
  23 use strict;
  24 use Parse::Pidl qw(error warning);
  25 use Parse::Pidl::Typelist qw(getType);
  26 use Parse::Pidl::Util qw(has_property property_matches make_str);
  27 use Parse::Pidl::NDR qw(ContainsString GetNextLevel);
  28 use Parse::Pidl::Dump qw(DumpType DumpFunction);
  29 use Parse::Pidl::Wireshark::Conformance qw(ReadConformance);
  30 use File::Basename;
  31
  32 use vars qw($VERSION);
  33 $VERSION = '0.01';
  34
  35 my %return_types = ();
  36 my %dissector_used = ();
  37
  38 my %ptrtype_mappings = (
  39         "unique" => "NDR_POINTER_UNIQUE",
  40         "ref" => "NDR_POINTER_REF",
  41         "ptr" => "NDR_POINTER_PTR"
  42 );
  43
  44 sub StripPrefixes($$)
  45 {
  46         my ($s, $prefixes) = @_;
  47
  48         foreach (@$prefixes) {
  49                 $s =~ s/^$_\_//g;
  50         }
  51
  52         return $s;
  53 }
  54
  55 # Convert a IDL structure field name (e.g access_mask) to a prettier
  56 # string like 'Access Mask'.
  57
  58 sub field2name($)
  59 {
  60     my($field) = shift;
  61
  62     $field =~ s/_/ /g;          # Replace underscores with spaces
  63     $field =~ s/(\w+)/\u\L$1/g; # Capitalise each word
  64
  65     return $field;
  66 }
  67
  68 sub new($)
  69 {
  70         my ($class) = @_;
  71         my $self = {res => {hdr => "", def => "", code => ""}, tabs => "", cur_fn => undef,
  72                 hf_used => {}, ett => [], conformance => undef
  73
  74         };
  75         bless($self, $class);
  76 }
  77
  78 sub pidl_fn_start($$)
  79 {
  80         my ($self, $fn) = @_;
  81         $self->{cur_fn} = $fn;
  82 }
  83 sub pidl_fn_end($$)
  84 {
  85         my ($self, $fn) = @_;
  86         die("Inconsistent state: $fn != $self->{cur_fn}") if ($fn ne $self->{cur_fn});
  87         $self->{cur_fn} = undef;
  88 }
  89
  90 sub pidl_code($$)
  91 {
  92         my ($self, $d) = @_;
  93         return if (defined($self->{cur_fn}) and defined($self->{conformance}->{manual}->{$self->{cur_fn}}));
  94
  95         if ($d) {
  96                 $self->{res}->{code} .= $self->{tabs};
  97                 $self->{res}->{code} .= $d;
  98         }
  99         $self->{res}->{code} .="\n";
 100 }
 101
 102 sub pidl_hdr($$) { my ($self,$x) = @_; $self->{res}->{hdr} .= "$x\n"; }
 103 sub pidl_def($$) { my ($self,$x) = @_; $self->{res}->{def} .= "$x\n"; }
 104
 105 sub indent($)
 106 {
 107         my ($self) = @_;
 108         $self->{tabs} .= "\t";
 109 }
 110
 111 sub deindent($)
 112 {
 113         my ($self) = @_;
 114         $self->{tabs} = substr($self->{tabs}, 0, -1);
 115 }
 116
 117 sub PrintIdl($$)
 118 {
 119         my ($self, $idl) = @_;
 120
 121         foreach (split /\n/, $idl) {
 122                 $self->pidl_code("/* IDL: $_ */");
 123         }
 124
 125         $self->pidl_code("");
 126 }
 127
 128 #####################################################################
 129 # parse the interface definitions
 130 sub Interface($$)
 131 {
 132         my($self, $interface) = @_;
 133         $self->Const($_,$interface->{NAME}) foreach (@{$interface->{CONSTS}});
 134         $self->Type($_, $_->{NAME}, $interface->{NAME}) foreach (@{$interface->{TYPES}});
 135         $self->Function($_,$interface->{NAME}) foreach (@{$interface->{FUNCTIONS}});
 136 }
 137
 138 sub Enum($$$$)
 139 {
 140         my ($self, $e,$name,$ifname) = @_;
 141         my $valsstring = "$ifname\_$name\_vals";
 142         my $dissectorname = "$ifname\_dissect\_enum\_".StripPrefixes($name, $self->{conformance}->{strip_prefixes});
 143
 144         return if (defined($self->{conformance}->{noemit}->{StripPrefixes($name, $self->{conformance}->{strip_prefixes})}));
 145
 146         foreach (@{$e->{ELEMENTS}}) {
 147                 if (/([^=]*)=(.*)/) {
 148                         $self->pidl_hdr("#define $1 ($2)");
 149                 }
 150         }
 151
 152         $self->pidl_hdr("extern const value_string $valsstring\[];");
 153         $self->pidl_hdr("int $dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 *param _U_);");
 154
 155         $self->pidl_def("const value_string ".$valsstring."[] = {");
 156         foreach (@{$e->{ELEMENTS}}) {
 157                 next unless (/([^=]*)=(.*)/);
 158                 $self->pidl_def("\t{ $1, \"$1\" },");
 159         }
 160
 161         $self->pidl_def("{ 0, NULL }");
 162         $self->pidl_def("};");
 163
 164         $self->pidl_fn_start($dissectorname);
 165         $self->pidl_code("int");
 166         $self->pidl_code("$dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 *param _U_)");
 167         $self->pidl_code("{");
 168         $self->indent;
 169         $self->pidl_code("g$e->{BASE_TYPE} parameter=0;");
 170         $self->pidl_code("if(param){");
 171         $self->indent;
 172         $self->pidl_code("parameter=(g$e->{BASE_TYPE})*param;");
 173         $self->deindent;
 174         $self->pidl_code("}");
 175         $self->pidl_code("offset = dissect_ndr_$e->{BASE_TYPE}(tvb, offset, pinfo, tree, drep, hf_index, &parameter);");
 176         $self->pidl_code("if(param){");
 177         $self->indent;
 178         $self->pidl_code("*param=(guint32)parameter;");
 179         $self->deindent;
 180         $self->pidl_code("}");
 181         $self->pidl_code("return offset;");
 182         $self->deindent;
 183         $self->pidl_code("}\n");
 184         $self->pidl_fn_end($dissectorname);
 185
 186         my $enum_size = $e->{BASE_TYPE};
 187         $enum_size =~ s/uint//g;
 188         $self->register_type($name, "offset = $dissectorname(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_UINT$enum_size", "BASE_DEC", "0", "VALS($valsstring)", $enum_size / 8);
 189 }
 190
 191 sub Pipe($$$$)
 192 {
 193         my ($self,$e,$name,$ifname) = @_;
 194         error($e->{ORIGINAL}, "Pipe not yet supported");
 195         return;
 196 }
 197
 198 sub Bitmap($$$$)
 199 {
 200         my ($self,$e,$name,$ifname) = @_;
 201         my $dissectorname = "$ifname\_dissect\_bitmap\_".StripPrefixes($name, $self->{conformance}->{strip_prefixes});
 202
 203         $self->register_ett("ett_$ifname\_$name");
 204
 205         $self->pidl_hdr("int $dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 param _U_);");
 206
 207         $self->pidl_fn_start($dissectorname);
 208         $self->pidl_code("int");
 209         $self->pidl_code("$dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *parent_tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 param _U_)");
 210         $self->pidl_code("{");
 211         $self->indent;
 212         $self->pidl_code("proto_item *item = NULL;");
 213         $self->pidl_code("proto_tree *tree = NULL;");
 214         $self->pidl_code("");
 215
 216         $self->pidl_code("g$e->{BASE_TYPE} flags;");
 217         if ($e->{ALIGN} > 1) {
 218                 $self->pidl_code("ALIGN_TO_$e->{ALIGN}_BYTES;");
 219         }
 220
 221         $self->pidl_code("");
 222
 223         $self->pidl_code("if (parent_tree) {");
 224         $self->indent;
 225         $self->pidl_code("item = proto_tree_add_item(parent_tree, hf_index, tvb, offset, $e->{ALIGN}, DREP_ENC_INTEGER(drep));");
 226         $self->pidl_code("tree = proto_item_add_subtree(item,ett_$ifname\_$name);");
 227         $self->deindent;
 228         $self->pidl_code("}\n");
 229
 230         $self->pidl_code("offset = dissect_ndr_$e->{BASE_TYPE}(tvb, offset, pinfo, NULL, drep, -1, &flags);");
 231
 232         $self->pidl_code("proto_item_append_text(item, \": \");\n");
 233         $self->pidl_code("if (!flags)");
 234         $self->pidl_code("\tproto_item_append_text(item, \"(No values set)\");\n");
 235
 236         foreach (@{$e->{ELEMENTS}}) {
 237                 next unless (/([^ ]*) (.*)/);
 238                 my ($en,$ev) = ($1,$2);
 239                 my $hf_bitname = "hf_$ifname\_$name\_$en";
 240                 my $filtername = "$ifname\.$name\.$en";
 241
 242                 $self->{hf_used}->{$hf_bitname} = 1;
 243
 244                 $self->register_hf_field($hf_bitname, field2name($en), $filtername, "FT_BOOLEAN", $e->{ALIGN} * 8, "TFS(&$name\_$en\_tfs)", $ev, "");
 245
 246                 $self->pidl_def("static const true_false_string $name\_$en\_tfs = {");
 247                 if (defined($self->{conformance}->{tfs}->{$hf_bitname})) {
 248                         $self->pidl_def("   $self->{conformance}->{tfs}->{$hf_bitname}->{TRUE_STRING},");
 249                         $self->pidl_def("   $self->{conformance}->{tfs}->{$hf_bitname}->{FALSE_STRING},");
 250                         $self->{conformance}->{tfs}->{$hf_bitname}->{USED} = 1;
 251                 } else {
 252                         $self->pidl_def("   \"$en is SET\",");
 253                         $self->pidl_def("   \"$en is NOT SET\",");
 254                 }
 255                 $self->pidl_def("};");
 256
 257                 $self->pidl_code("proto_tree_add_boolean(tree, $hf_bitname, tvb, offset-$e->{ALIGN}, $e->{ALIGN}, flags);");
 258                 $self->pidl_code("if (flags&$ev){");
 259                 $self->pidl_code("\tproto_item_append_text(item, \"$en\");");
 260                 $self->pidl_code("\tif (flags & (~$ev))");
 261                 $self->pidl_code("\t\tproto_item_append_text(item, \", \");");
 262                 $self->pidl_code("}");
 263                 $self->pidl_code("flags&=(~$ev);");
 264                 $self->pidl_code("");
 265         }
 266
 267         $self->pidl_code("if (flags) {");
 268         $self->pidl_code("\tproto_item_append_text(item, \"Unknown bitmap value 0x%x\", flags);");
 269         $self->pidl_code("}\n");
 270         $self->pidl_code("return offset;");
 271         $self->deindent;
 272         $self->pidl_code("}\n");
 273         $self->pidl_fn_end($dissectorname);
 274
 275         my $size = $e->{BASE_TYPE};
 276         $size =~ s/uint//g;
 277         $self->register_type($name, "offset = $dissectorname(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_UINT$size", "BASE_HEX", "0", "NULL", $size/8);
 278 }
 279
 280 sub ElementLevel($$$$$$$$)
 281 {
 282         my ($self,$e,$l,$hf,$myname,$pn,$ifname,$param) = @_;
 283
 284         if (defined($self->{conformance}->{dissectorparams}->{$myname})) {
 285                 $param = $self->{conformance}->{dissectorparams}->{$myname}->{PARAM};
 286         }
 287
 288         if ($l->{TYPE} eq "POINTER") {
 289                 my $type;
 290                 if ($l->{LEVEL} eq "TOP") {
 291                         $type = "toplevel";
 292                 } elsif ($l->{LEVEL} eq "EMBEDDED") {
 293                         $type = "embedded";
 294                 }
 295                 $self->pidl_code("offset = dissect_ndr_$type\_pointer(tvb, offset, pinfo, tree, drep, $myname\_, $ptrtype_mappings{$l->{POINTER_TYPE}}, \"Pointer to ".field2name(StripPrefixes($e->{NAME}, $self->{conformance}->{strip_prefixes})) . " ($e->{TYPE})\",$hf);");
 296         } elsif ($l->{TYPE} eq "ARRAY") {
 297                 if ($l->{IS_INLINE}) {
 298                         error($e->{ORIGINAL}, "Inline arrays not supported");
 299                 } elsif ($l->{IS_FIXED}) {
 300                         $self->pidl_code("int i;");
 301                         $self->pidl_code("for (i = 0; i < $l->{SIZE_IS}; i++)");
 302                         $self->pidl_code("\toffset = $myname\_(tvb, offset, pinfo, tree, drep);");
 303                 } else {
 304                         my $type = "";
 305                         $type .= "c" if ($l->{IS_CONFORMANT});
 306                         $type .= "v" if ($l->{IS_VARYING});
 307
 308                         unless ($l->{IS_ZERO_TERMINATED}) {
 309                                 $self->pidl_code("offset = dissect_ndr_u" . $type . "array(tvb, offset, pinfo, tree, drep, $myname\_);");
 310                         } else {
 311                                 my $nl = GetNextLevel($e,$l);
 312                                 $self->pidl_code("char *data;");
 313                                 $self->pidl_code("");
 314                                 $self->pidl_code("offset = dissect_ndr_$type" . "string(tvb, offset, pinfo, tree, drep, sizeof(g$nl->{DATA_TYPE}), $hf, FALSE, &data);");
 315                                 $self->pidl_code("proto_item_append_text(tree, \": %s\", data);");
 316                         }
 317                 }
 318         } elsif ($l->{TYPE} eq "DATA") {
 319                 if ($l->{DATA_TYPE} eq "string") {
 320                         my $bs = 2; # Byte size defaults to that of UCS2
 321
 322
 323                         ($bs = 1) if (property_matches($e, "flag", ".*LIBNDR_FLAG_STR_ASCII.*"));
 324
 325                         if (property_matches($e, "flag", ".*LIBNDR_FLAG_STR_SIZE4.*") and property_matches($e, "flag", ".*LIBNDR_FLAG_STR_LEN4.*")) {
 326                                 $self->pidl_code("char *data;\n");
 327                                 $self->pidl_code("offset = dissect_ndr_cvstring(tvb, offset, pinfo, tree, drep, $bs, $hf, FALSE, &data);");
 328                                 $self->pidl_code("proto_item_append_text(tree, \": %s\", data);");
 329                         } elsif (property_matches($e, "flag", ".*LIBNDR_FLAG_STR_SIZE4.*")) {
 330                                 $self->pidl_code("offset = dissect_ndr_vstring(tvb, offset, pinfo, tree, drep, $bs, $hf, FALSE, NULL);");
 331                         } elsif (property_matches($e, "flag", ".*STR_NULLTERM.*")) {
 332                                 if ($bs == 2) {
 333                                         $self->pidl_code("offset = dissect_null_term_wstring(tvb, offset, pinfo, tree, drep, $hf , 0);")
 334                                 } else {
 335                                         $self->pidl_code("offset = dissect_null_term_string(tvb, offset, pinfo, tree, drep, $hf , 0);")
 336                                 }
 337                         } else {
 338                                 warn("Unable to handle string with flags $e->{PROPERTIES}->{flag}");
 339                         }
 340                 } elsif ($l->{DATA_TYPE} eq "DATA_BLOB") {
 341                         my $remain = 0;
 342                         $remain = 1 if (property_matches($e->{ORIGINAL}, "flag", ".*LIBNDR_FLAG_REMAINING.*"));
 343                         $self->pidl_code("offset = dissect_ndr_datablob(tvb, offset, pinfo, tree, drep, $hf, $remain);");
 344                 } else {
 345                         my $call;
 346
 347                         if ($self->{conformance}->{imports}->{$l->{DATA_TYPE}}) {
 348                                 $call = $self->{conformance}->{imports}->{$l->{DATA_TYPE}}->{DATA};
 349                                 $self->{conformance}->{imports}->{$l->{DATA_TYPE}}->{USED} = 1;
 350
 351                         } elsif (defined($self->{conformance}->{imports}->{"$pn.$e->{NAME}"})) {
 352                                 $call = $self->{conformance}->{imports}->{"$pn.$e->{NAME}"}->{DATA};
 353                                 $self->{conformance}->{imports}->{"$pn.$e->{NAME}"}->{USED} = 1;
 354
 355                         } elsif (defined($self->{conformance}->{types}->{$l->{DATA_TYPE}})) {
 356                                 $call= $self->{conformance}->{types}->{$l->{DATA_TYPE}}->{DISSECTOR_NAME};
 357                                 $self->{conformance}->{types}->{$l->{DATA_TYPE}}->{USED} = 1;
 358                         } else {
 359                                 my $t;
 360                                 if (ref($l->{DATA_TYPE}) eq "HASH" ) {
 361                                         $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
 362                                 } else {
 363                                         $t = $l->{DATA_TYPE};
 364                                 }
 365
 366                                 $self->pidl_code("offset = $ifname\_dissect_struct_" . $t . "(tvb,offset,pinfo,tree,drep,$hf,$param);");
 367
 368                                 return;
 369                         }
 370
 371                         $call =~ s/\@HF\@/$hf/g;
 372                         $call =~ s/\@PARAM\@/$param/g;
 373                         $self->pidl_code($call);
 374                 }
 375         } elsif ($_->{TYPE} eq "SUBCONTEXT") {
 376                 my $varswitch;
 377                 if (has_property($e, "switch_is")) {
 378                         $varswitch = $e->{PROPERTIES}->{switch_is};
 379                 }
 380                 my $num_bits = ($l->{HEADER_SIZE}*8);
 381                 my $hf2 = $self->register_hf_field($hf."_", "Subcontext length", "$ifname.$pn.$_->{NAME}subcontext", "FT_UINT$num_bits", "BASE_HEX", "NULL", 0, "");
 382                 $num_bits = 3264 if ($num_bits == 32);
 383                 $self->{hf_used}->{$hf2} = 1;
 384                 $self->pidl_code("dcerpc_info *di = (dcerpc_info*)pinfo->private_data;");
 385                 $self->pidl_code("guint$num_bits size;");
 386                 $self->pidl_code("int conformant = di->conformant_run;");
 387                 $self->pidl_code("tvbuff_t *subtvb;");
 388                 $self->pidl_code("");
 389                 # We need to be able to dissect the length of the context in every case
 390                 # and conformant run skips the dissections of scalars ...
 391                 $self->pidl_code("if (!conformant) {");
 392                 $self->indent;
 393                 $self->pidl_code("guint32 saved_flags = di->call_data->flags;");
 394                 $self->pidl_code("offset = dissect_ndr_uint$num_bits(tvb, offset, pinfo, tree, drep, $hf2, &size);");
 395                 # This is a subcontext, there is normally no such thing as
 396                 # 64 bit NDR is subcontext so we clear the flag so that we can
 397                 # continue to dissect handmarshalled stuff with pidl
 398                 $self->pidl_code("di->call_data->flags &= ~DCERPC_IS_NDR64;");
 399
 400                 $self->pidl_code("subtvb = tvb_new_subset(tvb, offset, size, -1);");
 401                 if ($param ne 0) {
 402                         $self->pidl_code("$myname\_(subtvb, 0, pinfo, tree, drep, $param);");
 403                 } else {
 404                         $self->pidl_code("$myname\_(subtvb, 0, pinfo, tree, drep);");
 405                 }
 406                 $self->pidl_code("offset += size;");
 407                 $self->pidl_code("di->call_data->flags = saved_flags;");
 408                 $self->deindent;
 409                 $self->pidl_code("}");
 410         } elsif ($_->{TYPE} eq "PIPE") {
 411                 error($e->{ORIGINAL}, "Type PIPE not yet supported");
 412         } else {
 413                 die("Unknown type `$_->{TYPE}'");
 414         }
 415 }
 416
 417 sub Element($$$$$)
 418 {
 419         my ($self,$e,$pn,$ifname,$isoruseswitch) = @_;
 420
 421         my $dissectorname = "$ifname\_dissect\_element\_".StripPrefixes($pn, $self->{conformance}->{strip_prefixes})."\_".StripPrefixes($e->{NAME}, $self->{conformance}->{strip_prefixes});
 422
 423         my ($call_code, $moreparam);
 424         my $param = 0;
 425         if (defined $isoruseswitch) {
 426                 my $type = $isoruseswitch->[0];
 427                 my $name = $isoruseswitch->[1];
 428
 429                 my $switch_dt =  getType($type);
 430                 my $switch_type;
 431                 if ($switch_dt->{DATA}->{TYPE} eq "ENUM") {
 432                         $switch_type = "g".Parse::Pidl::Typelist::enum_type_fn($switch_dt->{DATA});
 433                 } elsif ($switch_dt->{DATA}->{TYPE} eq "SCALAR") {
 434                         $switch_type = "g$e->{SWITCH_TYPE}";
 435                 }
 436                 $moreparam = ", $switch_type *".$name;
 437                 $param = $name;
 438                 $call_code = "offset = $dissectorname(tvb, offset, pinfo, tree, drep, &$name);";
 439         } else {
 440                 $moreparam = "";
 441                 $call_code = "offset = $dissectorname(tvb, offset, pinfo, tree, drep);";
 442         }
 443
 444
 445         my $type = $self->find_type($e->{TYPE});
 446
 447         if (not defined($type)) {
 448                 # default settings
 449                 $type = {
 450                         MASK => 0,
 451                         VALSSTRING => "NULL",
 452                         FT_TYPE => "FT_NONE",
 453                         BASE_TYPE => "BASE_NONE"
 454                 };
 455         }
 456
 457         if (ContainsString($e)) {
 458                 $type = {
 459                         MASK => 0,
 460                         VALSSTRING => "NULL",
 461                         FT_TYPE => "FT_STRING",
 462                         BASE_TYPE => "BASE_NONE"
 463                 };
 464         }
 465
 466         my $hf = $self->register_hf_field("hf_$ifname\_$pn\_$e->{NAME}", field2name($e->{NAME}), "$ifname.$pn.$e->{NAME}", $type->{FT_TYPE}, $type->{BASE_TYPE}, $type->{VALSSTRING}, $type->{MASK}, "");
 467         $self->{hf_used}->{$hf} = 1;
 468
 469         my $eltname = StripPrefixes($pn, $self->{conformance}->{strip_prefixes}) . ".$e->{NAME}";
 470         if (defined($self->{conformance}->{noemit}->{$eltname})) {
 471                 return $call_code;
 472         }
 473
 474         my $add = "";
 475
 476         my $oldparam = undef;
 477         foreach (@{$e->{LEVELS}}) {
 478                 if (defined $_->{SWITCH_IS}) {
 479                         $oldparam = $param;
 480                         $param = "*$param";
 481                 }
 482                 next if ($_->{TYPE} eq "SWITCH");
 483                 $self->pidl_def("static int $dissectorname$add(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_$moreparam);");
 484                 $self->pidl_fn_start("$dissectorname$add");
 485                 $self->pidl_code("static int");
 486                 $self->pidl_code("$dissectorname$add(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_$moreparam)");
 487                 $self->pidl_code("{");
 488                 $self->indent;
 489
 490                 $self->ElementLevel($e,$_,$hf,$dissectorname.$add,$pn,$ifname,$param);
 491                 if (defined $oldparam) {
 492                         $param = $oldparam;
 493                 }
 494
 495                 $self->pidl_code("");
 496                 $self->pidl_code("return offset;");
 497                 $self->deindent;
 498                 $self->pidl_code("}\n");
 499                 $self->pidl_fn_end("$dissectorname$add");
 500                 $add.="_";
 501                 last if ($_->{TYPE} eq "ARRAY" and $_->{IS_ZERO_TERMINATED});
 502         }
 503
 504         return $call_code;
 505 }
 506
 507 sub Function($$$)
 508 {
 509         my ($self, $fn,$ifname) = @_;
 510
 511         my %dissectornames;
 512
 513         foreach (@{$fn->{ELEMENTS}}) {
 514             $dissectornames{$_->{NAME}} = $self->Element($_, $fn->{NAME}, $ifname, undef) if not defined($dissectornames{$_->{NAME}});
 515         }
 516
 517         my $fn_name = $_->{NAME};
 518         $fn_name =~ s/^${ifname}_//;
 519
 520         $self->PrintIdl(DumpFunction($fn->{ORIGINAL}));
 521         $self->pidl_fn_start("$ifname\_dissect\_$fn_name\_response");
 522         $self->pidl_code("static int");
 523         $self->pidl_code("$ifname\_dissect\_${fn_name}_response(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_)");
 524         $self->pidl_code("{");
 525         $self->indent;
 526         if ( not defined($fn->{RETURN_TYPE})) {
 527         } elsif ($fn->{RETURN_TYPE} eq "NTSTATUS" or $fn->{RETURN_TYPE} eq "WERROR")
 528         {
 529                 $self->pidl_code("guint32 status;\n");
 530         } elsif (my $type = getType($fn->{RETURN_TYPE})) {
 531                 if ($type->{DATA}->{TYPE} eq "ENUM") {
 532                         $self->pidl_code("g".Parse::Pidl::Typelist::enum_type_fn($type->{DATA}) . " status;\n");
 533                 } elsif ($type->{DATA}->{TYPE} eq "SCALAR") {
 534                         $self->pidl_code("g$fn->{RETURN_TYPE} status;\n");
 535                 } else {
 536                 error($fn, "return type `$fn->{RETURN_TYPE}' not yet supported");
 537                 }
 538         } else {
 539                 error($fn, "unknown return type `$fn->{RETURN_TYPE}'");
 540         }
 541
 542         $self->pidl_code("pinfo->dcerpc_procedure_name=\"${fn_name}\";");
 543         foreach (@{$fn->{ELEMENTS}}) {
 544                 if (grep(/out/,@{$_->{DIRECTION}})) {
 545                         $self->pidl_code("$dissectornames{$_->{NAME}}");
 546                         $self->pidl_code("offset = dissect_deferred_pointers(pinfo, tvb, offset, drep);");
 547                         $self->pidl_code("");
 548                 }
 549         }
 550
 551         if (not defined($fn->{RETURN_TYPE})) {
 552         } elsif ($fn->{RETURN_TYPE} eq "NTSTATUS") {
 553                 $self->pidl_code("offset = dissect_ntstatus(tvb, offset, pinfo, tree, drep, hf\_$ifname\_status, &status);\n");
 554                 $self->pidl_code("if (status != 0)");
 555                 $self->pidl_code("\tcol_append_fstr(pinfo->cinfo, COL_INFO, \", Error: %s\", val_to_str(status, NT_errors, \"Unknown NT status 0x%08x\"));\n");
 556                 $return_types{$ifname}->{"status"} = ["NTSTATUS", "NT Error"];
 557         } elsif ($fn->{RETURN_TYPE} eq "WERROR") {
 558                 $self->pidl_code("offset = dissect_ndr_uint32(tvb, offset, pinfo, tree, drep, hf\_$ifname\_werror, &status);\n");
 559                 $self->pidl_code("if (status != 0)");
 560                 $self->pidl_code("\tcol_append_fstr(pinfo->cinfo, COL_INFO, \", Error: %s\", val_to_str(status, WERR_errors, \"Unknown DOS error 0x%08x\"));\n");
 561
 562                 $return_types{$ifname}->{"werror"} = ["WERROR", "Windows Error"];
 563         } elsif (my $type = getType($fn->{RETURN_TYPE})) {
 564                 if ($type->{DATA}->{TYPE} eq "ENUM") {
 565                         my $return_type = "g".Parse::Pidl::Typelist::enum_type_fn($type->{DATA});
 566                         my $return_dissect = "dissect_ndr_" .Parse::Pidl::Typelist::enum_type_fn($type->{DATA});
 567
 568                         $self->pidl_code("offset = $return_dissect(tvb, offset, pinfo, tree, drep, hf\_$ifname\_$fn->{RETURN_TYPE}_status, &status);");
 569                         $self->pidl_code("if (status != 0)");
 570                         $self->pidl_code("\tcol_append_fstr(pinfo->cinfo, COL_INFO, \", Status: %s\", val_to_str(status, $ifname\_$fn->{RETURN_TYPE}\_vals, \"Unknown " . $fn->{RETURN_TYPE} . " error 0x%08x\"));\n");
 571                         $return_types{$ifname}->{$fn->{RETURN_TYPE}."_status"} = [$fn->{RETURN_TYPE}, $fn->{RETURN_TYPE}];
 572                 } elsif ($type->{DATA}->{TYPE} eq "SCALAR") {
 573                         $self->pidl_code("offset = dissect_ndr_$fn->{RETURN_TYPE}(tvb, offset, pinfo, tree, drep, hf\_$ifname\_$fn->{RETURN_TYPE}_status, &status);");
 574                         $self->pidl_code("if (status != 0)");
 575                         $self->pidl_code("\tcol_append_fstr(pinfo->cinfo, COL_INFO, \", Status: %d\", status);\n");
 576                         $return_types{$ifname}->{$fn->{RETURN_TYPE}."_status"} = [$fn->{RETURN_TYPE}, $fn->{RETURN_TYPE}];
 577                 }
 578         }
 579
 580         $self->pidl_code("return offset;");
 581         $self->deindent;
 582         $self->pidl_code("}\n");
 583         $self->pidl_fn_end("$ifname\_dissect\_$fn_name\_response");
 584
 585         $self->pidl_fn_start("$ifname\_dissect\_$fn_name\_request");
 586         $self->pidl_code("static int");
 587         $self->pidl_code("$ifname\_dissect\_${fn_name}_request(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_)");
 588         $self->pidl_code("{");
 589         $self->indent;
 590         $self->pidl_code("pinfo->dcerpc_procedure_name=\"${fn_name}\";");
 591         foreach (@{$fn->{ELEMENTS}}) {
 592                 if (grep(/in/,@{$_->{DIRECTION}})) {
 593                         $self->pidl_code("$dissectornames{$_->{NAME}}");
 594                         $self->pidl_code("offset = dissect_deferred_pointers(pinfo, tvb, offset, drep);");
 595                 }
 596
 597         }
 598
 599         $self->pidl_code("return offset;");
 600         $self->deindent;
 601         $self->pidl_code("}\n");
 602         $self->pidl_fn_end("$ifname\_dissect\_$fn_name\_request");
 603 }
 604
 605 sub Struct($$$$)
 606 {
 607         my ($self,$e,$name,$ifname) = @_;
 608         my $dissectorname = "$ifname\_dissect\_struct\_".StripPrefixes($name, $self->{conformance}->{strip_prefixes});
 609
 610         return if (defined($self->{conformance}->{noemit}->{StripPrefixes($name, $self->{conformance}->{strip_prefixes})}));
 611
 612         $self->register_ett("ett_$ifname\_$name");
 613
 614         my $res = "";
 615         my $varswitchs = {};
 616         # will contain the switch var declaration;
 617         my $vars = [];
 618         foreach (@{$e->{ELEMENTS}}) {
 619                 if (has_property($_, "switch_is")) {
 620                         $varswitchs->{$_->{PROPERTIES}->{switch_is}} = [];
 621                 }
 622         }
 623         foreach (@{$e->{ELEMENTS}}) {
 624                 my $switch_info = undef;
 625
 626                 my $v = $_->{NAME};
 627                 if (scalar(grep {/$v/} keys(%$varswitchs)) == 1) {
 628                         # This element is one of the switch attribute
 629                         my $switch_dt =  getType($_->{TYPE});
 630                         my $switch_type;
 631                         if ($switch_dt->{DATA}->{TYPE} eq "ENUM") {
 632                                 $switch_type = "g".Parse::Pidl::Typelist::enum_type_fn($switch_dt->{DATA});
 633                         } elsif ($switch_dt->{DATA}->{TYPE} eq "SCALAR") {
 634                                 $switch_type = "g$e->{SWITCH_TYPE}";
 635                         }
 636
 637                         push @$vars, "$switch_type $v;";
 638                         $switch_info = [ $_->{TYPE}, $v ];
 639                         $varswitchs->{$v} = $switch_info;
 640                 }
 641
 642                 if (has_property($_, "switch_is")) {
 643                         my $varswitch = $_->{PROPERTIES}->{switch_is};
 644                         $switch_info = $varswitchs->{$varswitch};
 645                 }
 646
 647                 $res.="\t".$self->Element($_, $name, $ifname, $switch_info)."\n\n";
 648         }
 649
 650         $self->pidl_hdr("int $dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *parent_tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 param _U_);");
 651
 652         $self->pidl_fn_start($dissectorname);
 653         $self->pidl_code("int");
 654         $self->pidl_code("$dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *parent_tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 param _U_)");
 655         $self->pidl_code("{");
 656         $self->indent;
 657         $self->pidl_code($_) foreach (@$vars);
 658         $self->pidl_code("proto_item *item = NULL;");
 659         $self->pidl_code("proto_tree *tree = NULL;");
 660         if ($e->{ALIGN} > 1) {
 661                 $self->pidl_code("dcerpc_info *di = (dcerpc_info *)pinfo->private_data;");
 662         }
 663         $self->pidl_code("int old_offset;");
 664         $self->pidl_code("");
 665
 666         if ($e->{ALIGN} > 1 and not property_matches($e, "flag", ".*LIBNDR_FLAG_NOALIGN.*")) {
 667                 $self->pidl_code("ALIGN_TO_$e->{ALIGN}_BYTES;");
 668         }
 669         $self->pidl_code("");
 670
 671         $self->pidl_code("old_offset = offset;");
 672         $self->pidl_code("");
 673         $self->pidl_code("if (parent_tree) {");
 674         $self->indent;
 675         $self->pidl_code("item = proto_tree_add_item(parent_tree, hf_index, tvb, offset, -1, ENC_NA);");
 676         $self->pidl_code("tree = proto_item_add_subtree(item, ett_$ifname\_$name);");
 677         $self->deindent;
 678         $self->pidl_code("}");
 679
 680         $self->pidl_code("\n$res");
 681
 682         $self->pidl_code("proto_item_set_len(item, offset-old_offset);\n");
 683         if ($e->{ALIGN} > 1) {
 684                 $self->pidl_code("");
 685                 $self->pidl_code("if (di->call_data->flags & DCERPC_IS_NDR64) {");
 686                 $self->indent;
 687                 $self->pidl_code("ALIGN_TO_$e->{ALIGN}_BYTES;");
 688                 $self->deindent;
 689                 $self->pidl_code("}");
 690         }
 691         $self->pidl_code("");
 692         $self->pidl_code("return offset;");
 693         $self->deindent;
 694         $self->pidl_code("}\n");
 695         $self->pidl_fn_end($dissectorname);
 696
 697         $self->register_type($name, "offset = $dissectorname(tvb,offset,pinfo,tree,drep,\@HF\@,\@PARAM\@);", "FT_NONE", "BASE_NONE", 0, "NULL", 0);
 698 }
 699
 700 sub Union($$$$)
 701 {
 702         my ($self,$e,$name,$ifname) = @_;
 703
 704         my $dissectorname = "$ifname\_dissect_".StripPrefixes($name, $self->{conformance}->{strip_prefixes});
 705
 706         return if (defined($self->{conformance}->{noemit}->{StripPrefixes($name, $self->{conformance}->{strip_prefixes})}));
 707
 708         $self->register_ett("ett_$ifname\_$name");
 709
 710         my $res = "";
 711         foreach (@{$e->{ELEMENTS}}) {
 712                 $res.="\n\t\t$_->{CASE}:\n";
 713                 if ($_->{TYPE} ne "EMPTY") {
 714                         $res.="\t\t\t".$self->Element($_, $name, $ifname, undef)."\n";
 715                 }
 716                 $res.="\t\tbreak;\n";
 717         }
 718
 719         my $switch_type;
 720         my $switch_dissect;
 721         my $switch_dt = getType($e->{SWITCH_TYPE});
 722         if ($switch_dt->{DATA}->{TYPE} eq "ENUM") {
 723                 $switch_type = "g".Parse::Pidl::Typelist::enum_type_fn($switch_dt->{DATA});
 724                 $switch_dissect = "dissect_ndr_" .Parse::Pidl::Typelist::enum_type_fn($switch_dt->{DATA});
 725         } elsif ($switch_dt->{DATA}->{TYPE} eq "SCALAR") {
 726                 $switch_type = "g$e->{SWITCH_TYPE}";
 727                 $switch_dissect = "dissect_ndr_$e->{SWITCH_TYPE}";
 728         }
 729
 730         $self->pidl_fn_start($dissectorname);
 731         $self->pidl_code("static int");
 732         $self->pidl_code("$dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *parent_tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 param _U_)");
 733         $self->pidl_code("{");
 734         $self->indent;
 735         $self->pidl_code("proto_item *item = NULL;");
 736         $self->pidl_code("proto_tree *tree = NULL;");
 737         $self->pidl_code("int old_offset;");
 738         if (!defined $switch_type) {
 739                 $self->pidl_code("guint32 level = param;");
 740         } else {
 741                 $self->pidl_code("$switch_type level;");
 742         }
 743         $self->pidl_code("");
 744
 745         $self->pidl_code("old_offset = offset;");
 746         $self->pidl_code("if (parent_tree) {");
 747         $self->indent;
 748         $self->pidl_code("item = proto_tree_add_text(parent_tree, tvb, offset, -1, \"$name\");");
 749         $self->pidl_code("tree = proto_item_add_subtree(item, ett_$ifname\_$name);");
 750         $self->deindent;
 751         $self->pidl_code("}");
 752
 753         $self->pidl_code("");
 754
 755         if (defined $switch_type) {
 756                 $self->pidl_code("offset = $switch_dissect(tvb, offset, pinfo, tree, drep, hf_index, &level);");
 757
 758                 if ($e->{ALIGN} > 1) {
 759                         $self->pidl_code("ALIGN_TO_$e->{ALIGN}_BYTES;");
 760                         $self->pidl_code("");
 761                 }
 762         }
 763
 764
 765         $self->pidl_code("switch(level) {$res\t}");
 766         $self->pidl_code("proto_item_set_len(item, offset-old_offset);\n");
 767         $self->pidl_code("");
 768
 769         $self->pidl_code("return offset;");
 770         $self->deindent;
 771         $self->pidl_code("}");
 772         $self->pidl_fn_end($dissectorname);
 773
 774         $self->register_type($name, "offset = $dissectorname(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_NONE", "BASE_NONE", 0, "NULL", 0);
 775 }
 776
 777 sub Const($$$)
 778 {
 779         my ($self,$const,$ifname) = @_;
 780
 781         if (!defined($const->{ARRAY_LEN}[0])) {
 782                 $self->pidl_hdr("#define $const->{NAME}\t( $const->{VALUE} )\n");
 783         } else {
 784                 $self->pidl_hdr("#define $const->{NAME}\t $const->{VALUE}\n");
 785         }
 786 }
 787
 788 sub Typedef($$$$)
 789 {
 790         my ($self,$e,$name,$ifname) = @_;
 791
 792         $self->Type($e->{DATA}, $name, $ifname);
 793 }
 794
 795 sub Type($$$$)
 796 {
 797         my ($self, $e, $name, $ifname) = @_;
 798
 799         $self->PrintIdl(DumpType($e->{ORIGINAL}));
 800         {
 801                 ENUM => \&Enum,
 802                 STRUCT => \&Struct,
 803                 UNION => \&Union,
 804                 BITMAP => \&Bitmap,
 805                 TYPEDEF => \&Typedef,
 806                 PIPE    => \&Pipe
 807         }->{$e->{TYPE}}->($self, $e, $name, $ifname);
 808 }
 809
 810 sub RegisterInterface($$)
 811 {
 812         my ($self, $x) = @_;
 813
 814         $self->pidl_fn_start("proto_register_dcerpc_$x->{NAME}");
 815         $self->pidl_code("void proto_register_dcerpc_$x->{NAME}(void)");
 816         $self->pidl_code("{");
 817         $self->indent;
 818
 819         $self->{res}->{code}.=$self->DumpHfList()."\n";
 820         $self->{res}->{code}.="\n".DumpEttList($self->{ett})."\n";
 821
 822         if (defined($x->{UUID})) {
 823             # These can be changed to non-pidl_code names if the old dissectors
 824             # in epan/dissctors are deleted.
 825
 826             my $name = uc($x->{NAME}) . " (pidl)";
 827             my $short_name = uc($x->{NAME});
 828             my $filter_name = $x->{NAME};
 829
 830             if (has_property($x, "helpstring")) {
 831                 $name = $x->{PROPERTIES}->{helpstring};
 832             }
 833
 834             if (defined($self->{conformance}->{protocols}->{$x->{NAME}})) {
 835                 $short_name = $self->{conformance}->{protocols}->{$x->{NAME}}->{SHORTNAME};
 836                 $name = $self->{conformance}->{protocols}->{$x->{NAME}}->{LONGNAME};
 837                 $filter_name = $self->{conformance}->{protocols}->{$x->{NAME}}->{FILTERNAME};
 838             }
 839
 840             $self->pidl_code("proto_dcerpc_$x->{NAME} = proto_register_protocol(".make_str($name).", ".make_str($short_name).", ".make_str($filter_name).");");
 841
 842             $self->pidl_code("proto_register_field_array(proto_dcerpc_$x->{NAME}, hf, array_length (hf));");
 843             $self->pidl_code("proto_register_subtree_array(ett, array_length(ett));");
 844         } else {
 845             $self->pidl_code("proto_dcerpc = proto_get_id_by_filter_name(\"dcerpc\");");
 846             $self->pidl_code("proto_register_field_array(proto_dcerpc, hf, array_length(hf));");
 847             $self->pidl_code("proto_register_subtree_array(ett, array_length(ett));");
 848         }
 849
 850         $self->deindent;
 851         $self->pidl_code("}\n");
 852         $self->pidl_fn_end("proto_register_dcerpc_$x->{NAME}");
 853 }
 854
 855 sub RegisterInterfaceHandoff($$)
 856 {
 857         my ($self,$x) = @_;
 858
 859         if (defined($x->{UUID})) {
 860                 $self->pidl_fn_start("proto_reg_handoff_dcerpc_$x->{NAME}");
 861             $self->pidl_code("void proto_reg_handoff_dcerpc_$x->{NAME}(void)");
 862             $self->pidl_code("{");
 863             $self->indent;
 864             $self->pidl_code("dcerpc_init_uuid(proto_dcerpc_$x->{NAME}, ett_dcerpc_$x->{NAME},");
 865             $self->pidl_code("\t&uuid_dcerpc_$x->{NAME}, ver_dcerpc_$x->{NAME},");
 866             $self->pidl_code("\t$x->{NAME}_dissectors, hf_$x->{NAME}_opnum);");
 867             $self->deindent;
 868             $self->pidl_code("}");
 869                 $self->pidl_fn_end("proto_reg_handoff_dcerpc_$x->{NAME}");
 870
 871                 $self->{hf_used}->{"hf_$x->{NAME}_opnum"} = 1;
 872         }
 873 }
 874
 875 sub ProcessInclude
 876 {
 877         my $self = shift;
 878         my @includes = @_;
 879         foreach (@includes) {
 880                 $self->pidl_hdr("#include \"$_\"");
 881         }
 882         $self->pidl_hdr("");
 883 }
 884
 885 sub ProcessImport
 886 {
 887         my $self = shift;
 888         my @imports = @_;
 889         foreach (@imports) {
 890                 next if($_ eq "security");
 891                 s/^\"//;
 892                 s/\.idl"?$//;
 893                 $self->pidl_hdr("#include \"packet-dcerpc-$_\.h\"");
 894         }
 895         $self->pidl_hdr("");
 896 }
 897
 898 sub ProcessInterface($$)
 899 {
 900         my ($self, $x) = @_;
 901
 902         push(@{$self->{conformance}->{strip_prefixes}}, $x->{NAME});
 903
 904         my $define = "__PACKET_DCERPC_" . uc($_->{NAME}) . "_H";
 905         $self->pidl_hdr("#ifndef $define");
 906         $self->pidl_hdr("#define $define");
 907         $self->pidl_hdr("");
 908
 909         $self->pidl_def("static gint proto_dcerpc_$x->{NAME} = -1;");
 910         $self->register_ett("ett_dcerpc_$x->{NAME}");
 911         $self->register_hf_field("hf_$x->{NAME}_opnum", "Operation", "$x->{NAME}.opnum", "FT_UINT16", "BASE_DEC", "NULL", 0, "");
 912
 913         if (defined($x->{UUID})) {
 914                 my $if_uuid = $x->{UUID};
 915
 916             $self->pidl_def("/* Version information */\n\n");
 917
 918             $self->pidl_def("static e_uuid_t uuid_dcerpc_$x->{NAME} = {");
 919             $self->pidl_def("\t0x" . substr($if_uuid, 1, 8)
 920                 . ", 0x" . substr($if_uuid, 10, 4)
 921             . ", 0x" . substr($if_uuid, 15, 4) . ",");
 922             $self->pidl_def("\t{ 0x" . substr($if_uuid, 20, 2)
 923                 . ", 0x" . substr($if_uuid, 22, 2)
 924             . ", 0x" . substr($if_uuid, 25, 2)
 925             . ", 0x" . substr($if_uuid, 27, 2)
 926             . ", 0x" . substr($if_uuid, 29, 2)
 927             . ", 0x" . substr($if_uuid, 31, 2)
 928             . ", 0x" . substr($if_uuid, 33, 2)
 929             . ", 0x" . substr($if_uuid, 35, 2) . " }");
 930             $self->pidl_def("};");
 931
 932             my $maj = 0x0000FFFF & $x->{VERSION};
 933             $maj =~ s/\.(.*)$//g;
 934             $self->pidl_def("static guint16 ver_dcerpc_$x->{NAME} = $maj;");
 935             $self->pidl_def("");
 936         }
 937
 938         $return_types{$x->{NAME}} = {};
 939
 940         $self->Interface($x);
 941         $self->pidl_code("\n".DumpFunctionTable($x));
 942
 943         foreach (sort(keys %{$return_types{$x->{NAME}}})) {
 944                 my ($type, $desc) = @{$return_types{$x->{NAME}}->{$_}};
 945                 my $dt = $self->find_type($type);
 946                 $dt or die("Unable to find information about return type `$type'");
 947                 $self->register_hf_field("hf_$x->{NAME}_$_", $desc, "$x->{NAME}.$_", $dt->{FT_TYPE}, "BASE_HEX", $dt->{VALSSTRING}, 0, "");
 948                 $self->{hf_used}->{"hf_$x->{NAME}_$_"} = 1;
 949         }
 950
 951         $self->RegisterInterface($x);
 952         $self->RegisterInterfaceHandoff($x);
 953
 954         $self->pidl_hdr("#endif /* $define */");
 955 }
 956
 957 sub find_type($$)
 958 {
 959         my ($self, $n) = @_;
 960
 961         return $self->{conformance}->{types}->{$n};
 962 }
 963
 964 sub register_type($$$$$$$$)
 965 {
 966         my ($self, $type,$call,$ft,$base,$mask,$vals,$length) = @_;
 967
 968         return if (defined($self->{conformance}->{types}->{$type}));
 969
 970         $self->{conformance}->{types}->{$type} = {
 971                 NAME => $type,
 972                 DISSECTOR_NAME => $call,
 973                 FT_TYPE => $ft,
 974                 BASE_TYPE => $base,
 975                 MASK => $mask,
 976                 VALSSTRING => $vals,
 977                 ALIGNMENT => $length
 978         };
 979 }
 980
 981 # Loads the default types
 982 sub Initialize($$)
 983 {
 984         my ($self, $cnf_file) = @_;
 985
 986         $self->{conformance} = {
 987                 imports => {},
 988                 header_fields=> {}
 989         };
 990
 991         ReadConformance($cnf_file, $self->{conformance}) or print STDERR "warning: No conformance file `$cnf_file'\n";
 992
 993         foreach my $bytes (qw(1 2 4 8)) {
 994                 my $bits = $bytes * 8;
 995                 $self->register_type("uint$bits", "offset = PIDL_dissect_uint$bits(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_UINT$bits", "BASE_DEC", 0, "NULL", $bytes);
 996                 $self->register_type("int$bits", "offset = PIDL_dissect_uint$bits(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_INT$bits", "BASE_DEC", 0, "NULL", $bytes);
 997         }
 998
 999         $self->register_type("uint3264", "offset = dissect_ndr_uint3264(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);", "FT_UINT32", "BASE_DEC", 0, "NULL", 8);
1000         $self->register_type("hyper", "offset = dissect_ndr_uint64(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);", "FT_UINT64", "BASE_DEC", 0, "NULL", 8);
1001         $self->register_type("udlong", "offset = dissect_ndr_duint32(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);", "FT_UINT64", "BASE_DEC", 0, "NULL", 4);
1002         $self->register_type("bool8", "offset = PIDL_dissect_uint8(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);","FT_INT8", "BASE_DEC", 0, "NULL", 1);
1003         $self->register_type("char", "offset = PIDL_dissect_uint8(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);","FT_INT8", "BASE_DEC", 0, "NULL", 1);
1004         $self->register_type("long", "offset = PIDL_dissect_uint32(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);","FT_INT32", "BASE_DEC", 0, "NULL", 4);
1005         $self->register_type("dlong", "offset = dissect_ndr_duint32(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_INT64", "BASE_DEC", 0, "NULL", 8);
1006         $self->register_type("GUID", "offset = dissect_ndr_uuid_t(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_GUID", "BASE_NONE", 0, "NULL", 4);
1007         $self->register_type("policy_handle", "offset = PIDL_dissect_policy_hnd(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);","FT_BYTES", "BASE_NONE", 0, "NULL", 4);
1008         $self->register_type("NTTIME", "offset = dissect_ndr_nt_NTTIME(tvb, offset, pinfo, tree, drep, \@HF\@);","FT_ABSOLUTE_TIME", "ABSOLUTE_TIME_LOCAL", 0, "NULL", 4);
1009         $self->register_type("NTTIME_hyper", "offset = dissect_ndr_nt_NTTIME(tvb, offset, pinfo, tree, drep, \@HF\@);","FT_ABSOLUTE_TIME", "ABSOLUTE_TIME_LOCAL", 0, "NULL", 4);
1010         $self->register_type("time_t", "offset = dissect_ndr_time_t(tvb, offset, pinfo,tree, drep, \@HF\@, NULL);","FT_ABSOLUTE_TIME", "ABSOLUTE_TIME_LOCAL", 0, "NULL", 4);
1011         $self->register_type("NTTIME_1sec", "offset = dissect_ndr_nt_NTTIME(tvb, offset, pinfo, tree, drep, \@HF\@);", "FT_ABSOLUTE_TIME", "ABSOLUTE_TIME_LOCAL", 0, "NULL", 4);
1012         $self->register_type("dom_sid28", "{
1013                 dcerpc_info *di = (dcerpc_info *)pinfo->private_data;
1014                 di->hf_index = \@HF\@;
1015
1016                 offset = dissect_ndr_nt_SID28(tvb, offset, pinfo, tree, drep);
1017         }", "FT_STRING", "BASE_NONE", 0, "NULL", 4);
1018         $self->register_type("SID", "{
1019                 dcerpc_info *di = (dcerpc_info *)pinfo->private_data;
1020
1021                 di->hf_index = \@HF\@;
1022
1023                 offset = dissect_ndr_nt_SID_with_options(tvb, offset, pinfo, tree, drep, param);
1024         }", "FT_STRING", "BASE_NONE", 0, "NULL", 4);
1025         $self->register_type("WERROR",
1026                 "offset = PIDL_dissect_uint32(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);","FT_UINT32", "BASE_DEC", 0, "VALS(WERR_errors)", 4);
1027         $self->register_type("NTSTATUS",
1028                 "offset = PIDL_dissect_uint32(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);","FT_UINT32", "BASE_DEC", 0, "VALS(NT_errors)", 4);
1029
1030 }
1031
1032 #####################################################################
1033 # Generate Wireshark parser and header code
1034 sub Parse($$$$$)
1035 {
1036         my($self,$ndr,$idl_file,$h_filename,$cnf_file) = @_;
1037
1038         $self->Initialize($cnf_file);
1039
1040         return (undef, undef) if defined($self->{conformance}->{noemit_dissector});
1041
1042         my $notice =
1043 "/* DO NOT EDIT
1044         This filter was automatically generated
1045         from $idl_file and $cnf_file.
1046
1047         Pidl is a perl based IDL compiler for DCE/RPC idl files.
1048         It is maintained by the Samba team, not the Wireshark team.
1049         Instructions on how to download and install Pidl can be
1050         found at http://wiki.wireshark.org/Pidl
1051
1052         \$Id\$
1053 */
1054
1055 ";
1056
1057         $self->pidl_hdr($notice);
1058
1059         $self->{res}->{headers} = "\n";
1060         $self->{res}->{headers} .= "#include \"config.h\"\n";
1061
1062         $self->{res}->{headers} .= "#ifdef _MSC_VER\n";
1063         $self->{res}->{headers} .= "#pragma warning(disable:4005)\n";
1064         $self->{res}->{headers} .= "#pragma warning(disable:4013)\n";
1065         $self->{res}->{headers} .= "#pragma warning(disable:4018)\n";
1066         $self->{res}->{headers} .= "#pragma warning(disable:4101)\n";
1067         $self->{res}->{headers} .= "#endif\n\n";
1068
1069         $self->{res}->{headers} .= "#include <glib.h>\n";
1070         $self->{res}->{headers} .= "#include <string.h>\n";
1071         $self->{res}->{headers} .= "#include <epan/packet.h>\n\n";
1072
1073         $self->{res}->{headers} .= "#include \"packet-dcerpc.h\"\n";
1074         $self->{res}->{headers} .= "#include \"packet-dcerpc-nt.h\"\n";
1075         $self->{res}->{headers} .= "#include \"packet-windows-common.h\"\n";
1076
1077         my $h_basename = basename($h_filename);
1078
1079         $self->{res}->{headers} .= "#include \"$h_basename\"\n";
1080         $self->pidl_code("");
1081
1082         if (defined($self->{conformance}->{ett})) {
1083                 register_ett($self,$_) foreach(@{$self->{conformance}->{ett}})
1084         }
1085
1086         # Wireshark protocol registration
1087
1088         foreach (@$ndr) {
1089                 $self->ProcessInterface($_) if ($_->{TYPE} eq "INTERFACE");
1090                 $self->ProcessImport(@{$_->{PATHS}}) if ($_->{TYPE} eq "IMPORT");
1091                 $self->ProcessInclude(@{$_->{PATHS}}) if ($_->{TYPE} eq "INCLUDE");
1092         }
1093
1094         $self->{res}->{ett} = DumpEttDeclaration($self->{ett});
1095         $self->{res}->{hf} = $self->DumpHfDeclaration();
1096
1097         my $parser = $notice;
1098         $parser.= $self->{res}->{headers};
1099         $parser.=$self->{res}->{ett};
1100         $parser.=$self->{res}->{hf};
1101         $parser.=$self->{res}->{def};
1102         if (exists ($self->{conformance}->{override})) {
1103                 $parser.=$self->{conformance}->{override};
1104         }
1105         $parser.=$self->{res}->{code};
1106
1107         my $header = "/* autogenerated by pidl */\n\n";
1108         $header.=$self->{res}->{hdr};
1109
1110         $self->CheckUsed($self->{conformance});
1111
1112         return ($parser,$header);
1113 }
1114
1115 ###############################################################################
1116 # ETT
1117 ###############################################################################
1118
1119 sub register_ett($$)
1120 {
1121         my ($self, $name) = @_;
1122
1123         push (@{$self->{ett}}, $name);
1124 }
1125
1126 sub DumpEttList
1127 {
1128         my ($ett) = @_;
1129         my $res = "\tstatic gint *ett[] = {\n";
1130         foreach (@$ett) {
1131                 $res .= "\t\t&$_,\n";
1132         }
1133
1134         return "$res\t};\n";
1135 }
1136
1137 sub DumpEttDeclaration
1138 {
1139         my ($ett) = @_;
1140         my $res = "\n/* Ett declarations */\n";
1141         foreach (@$ett) {
1142                 $res .= "static gint $_ = -1;\n";
1143         }
1144
1145         return "$res\n";
1146 }
1147
1148 ###############################################################################
1149 # HF
1150 ###############################################################################
1151
1152 sub register_hf_field($$$$$$$$$)
1153 {
1154         my ($self,$index,$name,$filter_name,$ft_type,$base_type,$valsstring,$mask,$blurb) = @_;
1155
1156         if (defined ($self->{conformance}->{hf_renames}->{$index})) {
1157                 $self->{conformance}->{hf_renames}->{$index}->{USED} = 1;
1158                 return $self->{conformance}->{hf_renames}->{$index}->{NEWNAME};
1159         }
1160
1161         $self->{conformance}->{header_fields}->{$index} = {
1162                 INDEX => $index,
1163                 NAME => $name,
1164                 FILTER => $filter_name,
1165                 FT_TYPE => $ft_type,
1166                 BASE_TYPE => $base_type,
1167                 VALSSTRING => $valsstring,
1168                 MASK => $mask,
1169                 BLURB => $blurb
1170         };
1171
1172         if ((not defined($blurb) or $blurb eq "") and
1173                         defined($self->{conformance}->{fielddescription}->{$index})) {
1174                 $self->{conformance}->{header_fields}->{$index}->{BLURB} =
1175                         $self->{conformance}->{fielddescription}->{$index}->{DESCRIPTION};
1176                 $self->{conformance}->{fielddescription}->{$index}->{USED} = 1;
1177         }
1178
1179         return $index;
1180 }
1181
1182 sub change_hf_field_type($$$$)
1183 {
1184         my ($self,$index,$ft_type,$base_type) = @_;
1185         if (defined ($self->{conformance}->{hf_renames}->{$index})) {
1186                 print "Field $index has been renamed to ".$self->{conformance}->{hf_renames}->{$index}->{NEWNAME}." you can't change it's type";
1187                 return 0;
1188         }
1189
1190         if (!defined ($self->{conformance}->{header_fields}->{$index})) {
1191                 print "Field $index doesn't exists";
1192                 return 0;
1193         }
1194         $self->{conformance}->{header_fields}->{$index}->{FT_TYPE} = $ft_type;
1195         $self->{conformance}->{header_fields}->{$index}->{BASE_TYPE} = $base_type;
1196         return 1;
1197 }
1198
1199 sub DumpHfDeclaration($)
1200 {
1201         my ($self) = @_;
1202         my $res = "";
1203
1204         $res = "\n/* Header field declarations */\n";
1205
1206         foreach (sort(keys %{$self->{conformance}->{header_fields}}))
1207         {
1208                 $res .= "static gint $_ = -1;\n";
1209         }
1210
1211         return "$res\n";
1212 }
1213
1214 sub make_str_or_null($)
1215 {
1216       my $str = shift;
1217       if (substr($str, 0, 1) eq "\"") {
1218               $str = substr($str, 1, length($str)-2);
1219       }
1220       $str =~ s/^\s*//;
1221       $str =~ s/\s*$//;
1222       if ($str eq "") {
1223               return "NULL";
1224       }
1225       return make_str($str);
1226 }
1227
1228 sub DumpHfList($)
1229 {
1230         my ($self) = @_;
1231         my $res = "\tstatic hf_register_info hf[] = {\n";
1232
1233         foreach (sort {$a->{INDEX} cmp $b->{INDEX}} values %{$self->{conformance}->{header_fields}})
1234         {
1235                 $res .= "\t{ &$_->{INDEX},
1236           { ".make_str($_->{NAME}).", ".make_str($_->{FILTER}).", $_->{FT_TYPE}, $_->{BASE_TYPE}, $_->{VALSSTRING}, $_->{MASK}, ".make_str_or_null($_->{BLURB}).", HFILL }},
1237 ";
1238         }
1239
1240         return $res."\t};\n";
1241 }
1242
1243
1244 ###############################################################################
1245 # Function table
1246 ###############################################################################
1247
1248 sub DumpFunctionTable($)
1249 {
1250         my $if = shift;
1251
1252         my $res = "static dcerpc_sub_dissector $if->{NAME}\_dissectors[] = {\n";
1253         foreach (@{$if->{FUNCTIONS}}) {
1254                 my $fn_name = $_->{NAME};
1255                 $fn_name =~ s/^$if->{NAME}_//;
1256                 $res.= "\t{ $_->{OPNUM}, \"$fn_name\",\n";
1257                 $res.= "\t   $if->{NAME}_dissect_${fn_name}_request, $if->{NAME}_dissect_${fn_name}_response},\n";
1258         }
1259
1260         $res .= "\t{ 0, NULL, NULL, NULL }\n";
1261
1262         return "$res};\n";
1263 }
1264
1265 sub CheckUsed($$)
1266 {
1267         my ($self, $conformance) = @_;
1268         foreach (values %{$conformance->{header_fields}}) {
1269                 if (not defined($self->{hf_used}->{$_->{INDEX}})) {
1270                         warning($_->{POS}, "hf field `$_->{INDEX}' not used");
1271                 }
1272         }
1273
1274         foreach (values %{$conformance->{hf_renames}}) {
1275                 if (not $_->{USED}) {
1276                         warning($_->{POS}, "hf field `$_->{OLDNAME}' not used");
1277                 }
1278         }
1279
1280         foreach (values %{$conformance->{dissectorparams}}) {
1281                 if (not $_->{USED}) {
1282                         warning($_->{POS}, "dissector param never used");
1283                 }
1284         }
1285
1286         foreach (values %{$conformance->{imports}}) {
1287                 if (not $_->{USED}) {
1288                         warning($_->{POS}, "import never used");
1289                 }
1290         }
1291
1292         foreach (values %{$conformance->{types}}) {
1293                 if (not $_->{USED} and defined($_->{POS})) {
1294                         warning($_->{POS}, "type never used");
1295                 }
1296         }
1297
1298         foreach (values %{$conformance->{fielddescription}}) {
1299                 if (not $_->{USED}) {
1300                         warning($_->{POS}, "description never used");
1301                 }
1302         }
1303
1304         foreach (values %{$conformance->{tfs}}) {
1305                 if (not $_->{USED}) {
1306                         warning($_->{POS}, "True/False description never used");
1307                 }
1308         }
1309 }
1310
1311 1;