epan/dissectors/pidl/README

   1 A note about PIDL generated files
   2 =================================
   3
   4 Quick guide
   5 ===========
   6
   7 Run 'make -f Makefile.pidl all' inside the pidl folder to generate all the dissectors and place
   8 them in the epan/dissectors folder.
   9
  10 Complete infos
  11 ==============
  12
  13 The following files:
  14 ../packet-dcerpc-atsvc.h
  15 ../packet-dcerpc-budb.c
  16 ../packet-dcerpc-budb.h
  17 ../packet-dcerpc-butc.c
  18 ../packet-dcerpc-butc.h
  19 ../packet-dcerpc-dfs.h
  20 ../packet-dcerpc-dnsserver.h
  21 ../packet-dcerpc-drsuapi.c
  22 ../packet-dcerpc-drsuapi.h
  23 ../packet-dcerpc-dssetup.h
  24 ../packet-dcerpc-efs.h
  25 ../packet-dcerpc-eventlog.h
  26 ../packet-dcerpc-frsrpc.h
  27 ../packet-dcerpc-frstrans.h
  28 ../packet-dcerpc-initshutdown.h
  29 ../packet-dcerpc-iwbemlevel1login.h
  30 ../packet-dcerpc-iwbemloginclientid.h
  31 ../packet-dcerpc-iwbemloginclientidex.h
  32 ../packet-dcerpc-iwbemservices.h
  33 ../packet-dcerpc-lsa.h
  34 ../packet-dcerpc-mapi.h
  35 ../packet-dcerpc-misc.h
  36 ../packet-dcerpc-nspi.h
  37 ../packet-dcerpc-rfr.h
  38 ../packet-dcerpc-samr.h
  39 ../packet-dcerpc-srvsvc.h
  40 ../packet-dcerpc-winreg.h
  41 ../packet-dcerpc-wkssvc.h
  42 ../packet-dcerpc-wzcsvc.h
  43
  44 are automatically generated via a tool called "pidl"; you shouldn't
  45 modify them manually.
  46
  47 The pidl tool is maintained by the Samba project (http://samba.org,
  48 samba-technical@samba.org).  We have a version in ../../../tools/pidl;
  49 it currently differs from the Samba version only in its Wireshark-parser
  50 generator, as we had to change it to reflect some API differences
  51 between the current Wireshark release and the development trunk.
  52
  53 The Samba version can be fetched from their git tree:
  54     git clone git://git.samba.org/samba.git
  55
  56 Running pidl
  57 ============
  58
  59 You have to run the pidl command inside the pidl folder of the wireshark
  60 source tree.
  61
  62 The command to compile file:
  63     ../../../tools/pidl/pidl --includedir . --ws-parser -- <idl-file>
  64                                                         ^^^
  65                                                         This is *VERY* important
  66 The command generates 2 files:
  67     packet-dcerpc-<interfacename>.h
  68     packet-dcerpc-<interfacename>.c
  69
  70 For instance, with the atsvc.idl, the command will be:
  71
  72         ../../../tools/pidl/pidl --includedir . --ws-parser -- atsvc.idl
  73
  74 This will generate 2 files:
  75     packet-dcerpc-atsvc.h
  76     packet-dcerpc-atsvc.c
  77
  78 If you run outside the dissectors/pidl directory, this *will* result in a
  79 warning such as:
  80
  81     atsvc.idl:5:23: idl_types.h: No such file or directory
  82
  83 and *may* result in additional warnings such as:
  84
  85     Warning: No conformance file `initshutdown.cnf'
  86     Unable to handle string with flags STR_LEN4|STR_NOTERM at /usr/lib/perl5/site_perl/5.8.6/Parse/Pidl/Wireshark/NDR.pm line 283.
  87
  88 Notes about the in-tree pidl
  89 ============================
  90
  91 To allow building Wireshark pidl dissectors without having to
  92 *explicitly* access a remote git repository, and to allow us to make
  93 changes to the Wireshark parser generator that the Samba developers
  94 might not want to make until a new major release of Wireshark comes out,
  95 so as to allow users to build dissectors to run in the current Wireshark
  96 release, a copy of pidl is located in tools/pidl.
  97
  98 Not compiling idl
  99 =================
 100 As of September 26, 2014, the following idl have issues when generating
 101 and compiling:
 102
 103 pidl complains that inline arrays aren't supported for these:
 104
 105         dnsserver/dnsserver.idl
 106         eventlog/eventlog.idl
 107
 108 pidl complains about a syntax error due to a line commented out with a
 109 // comment for these:
 110
 111         nspi/nspi.idl
 112
 113 pidl generates possibly-incorrect code for these - this needs checking:
 114
 115         rfr/rfr.idl
 116
 117 pidl complains about not being able to open include files for these:
 118
 119         samr/samr.idl
 120         winspool/winspool.idl