sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2024-12-24 21:34:56 +03:00
Code
2ffccf9c01
samba-mirror/buildtools
History
Douglas Bagnall a78f69cb7d pidl: optionally annotate output for debug purposes 
It can sometimes be hard to tell which bit of pidl generated which bit
of C. This commit wants to help.

If the PIDL_DEVELOPER environment variable is set (via waf
--pidl-developer or some other means), pidl will annotate *most* C
indicating which lines were generated by which bits of pidl. It looks
something like this:

_PUBLIC_ enum ndr_err_code ndr_push_auth_session_info(struct ndr_push *ndr, int ndr_flags, const struct auth_session_info *r)
{  //:PIDL: Parse::Pidl::Samba4::NDR::Parser::ParseTypePushFunction  lib/Parse/Pidl/Samba4/NDR/Parser.pm:3079
	NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);  //:PIDL: Parse::Pidl::Samba4::NDR::Parser::ParseStructPush  lib/Parse/Pidl/Samba4/NDR/Parser.pm:604
	if (ndr_flags & NDR_SCALARS) {
		NDR_CHECK(ndr_push_align(ndr, 5));  //:PIDL: Parse::Pidl::Samba4::NDR::Parser::ParseStructPushPrimitives  lib/Parse/Pidl/Samba4/NDR/Parser.pm:1448
		NDR_CHECK(ndr_push_unique_ptr(ndr, r->security_token));  //:PIDL: Parse::Pidl::Samba4::NDR::Parser::ParsePtrPush  lib/Parse/Pidl/Samba4/NDR/Parser.pm:604
		NDR_CHECK(ndr_push_unique_ptr(ndr, r->unix_token));
		NDR_CHECK(ndr_push_unique_ptr(ndr, r->info));
		NDR_CHECK(ndr_push_unique_ptr(ndr, r->unix_info));
		NDR_CHECK(ndr_push_uint3264(ndr, NDR_SCALARS, 0));
		/* [ignore] 'torture' */  //:PIDL: Parse::Pidl::Samba4::NDR::Parser::ParseElementPushLevel  lib/Parse/Pidl/Samba4/NDR/Parser.pm:729
		NDR_CHECK(ndr_push_DATA_BLOB(ndr, NDR_SCALARS, r->session_key));  //:PIDL: Parse::Pidl::Samba4::NDR::Parser::ParseDataPush  lib/Parse/Pidl/Samba4/NDR/Parser.pm:604
		NDR_CHECK(ndr_push_uint3264(ndr, NDR_SCALARS, 0));  //:PIDL: Parse::Pidl::Samba4::NDR::Parser::ParsePtrPush  lib/Parse/Pidl/Samba4/NDR/Parser.pm:604
		/* [ignore] 'credentials' */  //:PIDL: Parse::Pidl::Samba4::NDR::Parser::ParseElementPushLevel  lib/Parse/Pidl/Samba4/NDR/Parser.pm:729

The comments starting with '//:PIDL:' have the function name, the filename,
and line number. The comment follows the ordinary output, and uses the '//'
style so as not to interfere with multiline /* */ comments if they happen
to exist.

A '//:PIDL:' comment is added whenever the pidl function or indentation
level changes, and very occasionally at other places if pidl runs for a
while without either of these things happening.

This does not affect pidl parsers that do not inherit from Parse::Pidl::Base,
and is careful to have no performance impact on non-debug generation.

This may help with semi-automated flow analysis.

Signed-off-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
2019-12-04 05:10:31 +00:00
..
bin waf: upgrade to 2.0.18 2019-10-20 12:06:30 +00:00
examples PY3: change shebang to python3 in misc dirs 2018-12-14 18:00:40 +01:00
scripts abi_gen.sh: ignore gdb customisations when comparing signatures 2019-02-02 20:19:05 +01:00
wafsamba pidl: optionally annotate output for debug purposes 2019-12-04 05:10:31 +00:00
compare_config_h4.sh waf/buildtools: use /bin/sh instead of /bin/bash and put ^ in quotes 2010-12-02 10:36:06 +01:00
compare_generated.sh waf/buildtools: use /bin/sh instead of /bin/bash and put ^ in quotes 2010-12-02 10:36:06 +01:00
compare_install.sh waf/buildtools: use /bin/sh instead of /bin/bash and put ^ in quotes 2010-12-02 10:36:06 +01:00
README Include waf as an extracted source directory, rather than as a one-in-a-file script. 2012-01-04 22:34:20 +01:00
testwaf.sh ldb: make ldb a top level library for Samba 4.0 2011-07-05 17:24:47 +10:00

README 

See http://code.google.com/p/waf/ for more information on waf

You can get a svn copy of the upstream source with:

  svn checkout http://waf.googlecode.com/svn/trunk/ waf-read-only

Samba currently uses waf 1.5, which can be found at:

  http://waf.googlecode.com/svn/branches/waf-1.5

To update the current copy of waf, use the update-waf.sh script in this
directory.