MAN page from CentOS 8 samba-pidl-4.13.8-1.el8.noarch.rpm


Section: User Contributed Perl Documentation (1)
Updated: 2020-07-09


pidl - An IDL compiler written in Perl 


pidl --help

pidl [--outputdir[=OUTNAME]] [--includedir DIR...] [--parse-idl-tree] [--dump-idl-tree] [--dump-ndr-tree] [--header[=OUTPUT]] [--python[=OUTPUT]] [--ndr-parser[=OUTPUT]] [--client] [--server] [--warn-compat] [--quiet] [--verbose] [--template] [--ws-parser[=OUTPUT]] [--diff] [--dump-idl] [--tdr-parser[=OUTPUT]] [--samba3-ndr-client[=OUTPUT]] [--samba3-ndr-server[=OUTPUT]] [--typelib=[OUTPUT]] [<idlfile>.idl]... 


pidl is an IDL compiler written in Perl that aims to be somewhatcompatible with the midl compiler. IDL is short for``Interface Definition Language''.

pidl can generate stubs for DCE/RPC server code, DCE/RPCclient code and Wireshark dissectors for DCE/RPC traffic.

IDL compilers like pidl take a descriptionof an interface as their input and use it to generate C(though support for other languages may be added later) code thatcan use these interfaces, pretty print data sentusing these interfaces, or even generate Wiresharkdissectors that can parse data sent over thewire by these interfaces.

pidl takes IDL files in the same format as is used by midl,converts it to a .pidl file (which contains pidl's internal representation of the interface) and can then generate whatever output you need..pidl files should be used for debugging purposes only. Write yourinterface definitions in .idl format.

The goal of pidl is to implement a IDL compiler that can be usedwhile developing the RPC subsystem in Samba (forboth marshalling/unmarshalling and debugging purposes). 


Show list of available options.
Show pidl version
--outputdir OUTNAME
Write output files to the specified directory. Defaults to the currentdirectory.
--includedir DIR
Add DIR to the search path used by the preprocessor. This option can bespecified multiple times.
Read internal tree structure from input files ratherthan assuming they contain IDL.
Generate a new IDL file. File will be named OUTNAME.idl.
Generate a C header file for the specified interface. Filename defaults to OUTNAME.h.
Generate a C file and C header containing NDR parsers. The filename forthe parser defaults to ndr_OUTNAME.c. The header filename will be theparser filename with the extension changed from .c to .h.
Generate a C file and C header containing TDR parsers. The filename forthe parser defaults to tdr_OUTNAME.c. The header filename will be theparser filename with the extension changed from .c to .h.
Write type information to the specified file.
Generate boilerplate for the RPC server that implementsthe interface. Filename defaults to ndr_OUTNAME_s.c.
Generate stubs for a RPC server that implements the interface. Output willbe written to stdout.
Generate an Wireshark dissector (in C) and header file. The dissector filenamedefaults to packet-dcerpc-OUTNAME.c while the header filename defaults topacket-dcerpc-OUTNAME.h.

Pidl will read additional data from an Wireshark conformance file if present.Such a file should have the same location as the IDL file but with theextension cnf rather than idl. See Parse::Pidl::Wireshark::Conformancefor details on the format of this file.

Parse an IDL file, generate a new IDL file based on the internal datastructures and see if there are any differences with the original IDL file.Useful for debugging pidl.
Tell pidl to dump the internal tree representation of an IDLfile the to disk. Useful for debugging pidl.
Tell pidl to dump the internal NDR information tree it generatedfrom the IDL file to disk. Useful for debugging pidl.
Generate client calls for Samba3, to be placed in rpc_client/. Instead ofcalling out to the code in Samba3's rpc_parse/, this will call out toSamba4's NDR code instead.
Generate server calls for Samba3, to be placed in rpc_server/. Instead ofcalling out to the code in Samba3's rpc_parse/, this will call out toSamba4's NDR code instead.


IDL files are always preprocessed using the C preprocessor.

Pretty much everything in an interface (the interface itself, functions,parameters) can have attributes (or properties whatever name you give them).Attributes always prepend the element they apply to and are surroundedby square brackets ([]). Multiple attributes are separated by comma's;arguments to attributes are specified between parentheses.

See the section COMPATIBILITY for the list of attributes thatpidl supports.

C-style comments can be used. 


A conformant array is one with that ends in [*] or []. The strangethings about conformant arrays are that they can only appear as the lastelement of a structure (unless there is a pointer to the conformant array,of course) and the array size appears before the structure itself on the wire.

So, in this example:

        typedef struct {                long abc;                long count;                long foo;                [size_is(count)] long s[*];        } Struct1;

it appears like this:

        [size_is] [abc] [count] [foo] [s...]

the first [size_is] field is the allocation size of the array, andoccurs before the array elements and even before the structurealignment.

Note that size_is() can refer to a constant, but that doesn't changethe wire representation. It does not make the array a fixed array.

midl.exe would write the above array as the following C header:

   typedef struct {                long abc;                long count;                long foo;                long s[1];        } Struct1;

pidl takes a different approach, and writes it like this:

        typedef struct {                long abc;                long count;                long foo;                long *s;        } Struct1;


A varying array looks like this:

        typedef struct {                long abc;                long count;                long foo;                [size_is(count)] long *s;        } Struct1;

This will look like this on the wire:

        [abc] [count] [foo] [PTR_s]    [count] [s...]


A fixed array looks like this:

        typedef struct {                long s[10];        } Struct1;

The NDR representation looks just like 10 separate longdeclarations. The array size is not encoded on the wire.

pidl also supports ``inline'' arrays, which are not part of the IDL/NDRstandard. These are declared like this:

        typedef struct {                uint32 foo;                uint32 count;                uint32 bar;                long s[count];        } Struct1;

This appears like this:

        [foo] [count] [bar] [s...]

Fixed arrays are an extension added to support some of the strangeembedded structures in security descriptors and spoolss.

This section is by no means complete. See the OpenGroup and MSDN        documentation for additional information.



Missing features in pidl

The following MIDL features are not (yet) implemented in pidlor are implemented with an incompatible interface:
Asynchronous communication
Typelibs (.tlb files)
Datagram support (ncadg_*)

Supported attributes and statements

in, out, ref, length_is, switch_is, size_is, uuid, case, default, string,unique, ptr, pointer_default, v1_enum, object, helpstring, range, local,call_as, endpoint, switch_type, progid, coclass, iid_is, represent_as,transmit_as, import, include, cpp_quote. 

PIDL Specific properties

The [public] property on a structure or union is a pidl extension thatforces the generated pull/push functions to be non-static. This allowsyou to declare types that can be used between modules. If you don'tspecify [public] then pull/push functions for other than top-levelfunctions are declared static.
The [noprint] property is a pidl extension that allows you to specifythat pidl should not generate a ndr_print_*() function for thatstructure or union. This is used when you wish to define your ownprint function that prints a structure in a nicer manner. A goodexample is the use of [noprint] on dom_sid, which allows thepretty-printing of SIDs.
The [value(expression)] property is a pidl extension that allows youto specify the value of a field when it is put on the wire. Thisallows fields that always have a well-known value to be automaticallyfilled in, thus making the API more programmer friendly. Theexpression can be any C expression.
The [relative] property can be supplied on a pointer. When it is usedit declares the pointer as a spoolss style ``relative'' pointer, whichmeans it appears on the wire as an offset within the currentencapsulating structure. This is not part of normal IDL/NDR, but it isa very useful extension as it avoids the manual encoding of manycomplex structures.
Specifies that a size of lengthbytes should be read, followed by a blob of that size,which will be parsed as NDR.

subcontext() is deprecated now, and should not be used in new code.Instead, use represent_as() or transmit_as().

Specify boolean options, mostly used forlow-level NDR options. Several optionscan be specified using the | character.Note that flags are inherited by substructures!
The [nodiscriminant] property on a union means that the usual uint16discriminent field at the start of the union on the wire isomitted. This is not normally allowed in IDL/NDR, but is used for somespoolss structures.
Specify that the array or string uses the specifiedcharset. If this attribute is specified, pidl willtake care of converting the character data from this formatto the host format. Commonly used values are UCS2, DOS and UTF8.

Unsupported MIDL properties or statements

aggregatable, appobject, async_uuid, bindable, control,defaultbind, defaultcollelem, defaultvalue, defaultvtable, dispinterface,displaybind, dual, entry, first_is, helpcontext, helpfile, helpstringcontext,helpstringdll, hidden, idl_module, idl_quote, id, immediatebind, importlib,includelib, last_is, lcid, licensed, max_is, module,ms_union, no_injected_text, nonbrowsable, noncreatable, nonextensible, odl,oleautomation, optional, pragma, propget, propputref, propput, readonly,requestedit, restricted, retval, source, uidefault,usesgetlasterror, vararg, vi_progid, wire_marshal. 


        # Generating an Wireshark parser        $ ./pidl --ws-parser -- atsvc.idl        # Generating a TDR parser and header        $ ./pidl --tdr-parser --header -- regf.idl        # Generating a Samba3 client and server        $ ./pidl --samba3-ndr-client --samba3-ndr-server -- dfs.idl        # Generating a Samba4 NDR parser, client and server        $ ./pidl --ndr-parser --ndr-client --ndr-server -- samr.idl




pidl is licensed under the GNU General Public License <>. 


pidl was written by Andrew Tridgell, Stefan Metzmacher, Tim Potter and JelmerVernooij. The current maintainer is Jelmer Vernooij.

This manpage was written by Jelmer Vernooij, partially based on the originalpidl README by Andrew Tridgell.



Missing features in pidl
Supported attributes and statements
PIDL Specific properties
Unsupported MIDL properties or statements

This document was created byman2html,using the manual pages.