1 # a waf tool to add autoconf-like macros to the configure section
2 # and for SAMBA_ macros for building libraries, binaries etc
5 import os
, sys
, re
, fnmatch
, shlex
, inspect
6 from optparse
import SUPPRESS_HELP
7 from waflib
import Build
, Options
, Utils
, Task
, Logs
, Configure
, Errors
, Context
8 from waflib
import Scripting
9 from waflib
.TaskGen
import feature
, before
, after
10 from waflib
.Configure
import ConfigurationContext
11 from waflib
.Logs
import debug
12 from waflib
import ConfigSet
13 from waflib
.Build
import CACHE_SUFFIX
15 # TODO: make this a --option
19 PY3
= sys
.version_info
[0] == 3
23 # helper function to get a string from a variable that maybe 'str' or
24 # 'bytes' if 'bytes' then it is decoded using 'utf8'. If 'str' is passed
25 # it is returned unchanged
26 # Using this function is PY2/PY3 code should ensure in most cases
27 # the PY2 code runs unchanged in PY2 whereas the code in PY3 possibly
28 # decodes the variable (see PY2 implementation of this function below)
29 def get_string(bytesorstring
):
31 if isinstance(bytesorstring
, bytes
):
32 tmp
= bytesorstring
.decode('utf8')
33 elif not isinstance(bytesorstring
, str):
34 raise ValueError('Expected byte of string for %s:%s' % (type(bytesorstring
), bytesorstring
))
39 # Helper function to return string.
40 # if 'str' or 'unicode' passed in they are returned unchanged
41 # otherwise an exception is generated
42 # Using this function is PY2/PY3 code should ensure in most cases
43 # the PY2 code runs unchanged in PY2 whereas the code in PY3 possibly
44 # decodes the variable (see PY3 implementation of this function above)
45 def get_string(bytesorstring
):
47 if not(isinstance(bytesorstring
, str) or isinstance(bytesorstring
, unicode)):
48 raise ValueError('Expected str or unicode for %s:%s' % (type(bytesorstring
), bytesorstring
))
51 # sigh, python octal constants are a mess
52 MODE_644
= int('644', 8)
53 MODE_744
= int('744', 8)
54 MODE_755
= int('755', 8)
55 MODE_777
= int('777', 8)
58 # override in order to propagate the argument "mandatory"
62 mandatory
= kw
['mandatory']
67 except Errors
.ConfigurationError
:
71 fun
.__name
__ = f
.__name
__
72 if 'mandatory' in inspect
.getsource(f
):
75 setattr(Configure
.ConfigurationContext
, f
.__name
__, fun
)
76 setattr(Build
.BuildContext
, f
.__name
__, fun
)
79 Configure
.conftest
= conf
82 def SET_TARGET_TYPE(ctx
, target
, value
):
83 '''set the target type of a target'''
84 cache
= LOCAL_CACHE(ctx
, 'TARGET_TYPE')
85 if target
in cache
and cache
[target
] != 'EMPTY':
86 Logs
.error("ERROR: Target '%s' in directory %s re-defined as %s - was %s" % (target
, ctx
.path
.abspath(), value
, cache
[target
]))
88 LOCAL_CACHE_SET(ctx
, 'TARGET_TYPE', target
, value
)
89 debug("task_gen: Target '%s' created of type '%s' in %s" % (target
, value
, ctx
.path
.abspath()))
93 def GET_TARGET_TYPE(ctx
, target
):
94 '''get target type from cache'''
95 cache
= LOCAL_CACHE(ctx
, 'TARGET_TYPE')
96 if not target
in cache
:
101 def ADD_LD_LIBRARY_PATH(path
):
102 '''add something to LD_LIBRARY_PATH'''
103 if 'LD_LIBRARY_PATH' in os
.environ
:
104 oldpath
= os
.environ
['LD_LIBRARY_PATH']
107 newpath
= oldpath
.split(':')
108 if not path
in newpath
:
110 os
.environ
['LD_LIBRARY_PATH'] = ':'.join(newpath
)
113 def needs_private_lib(bld
, target
):
114 '''return True if a target links to a private library'''
115 for lib
in getattr(target
, "final_libs", []):
116 t
= bld
.get_tgen_by_name(lib
)
117 if t
and getattr(t
, 'private_library', False):
122 def install_rpath(target
):
123 '''the rpath value for installation'''
125 bld
.env
['RPATH'] = []
127 if bld
.env
.RPATH_ON_INSTALL
:
128 ret
.add(bld
.EXPAND_VARIABLES(bld
.env
.LIBDIR
))
129 if bld
.env
.RPATH_ON_INSTALL_PRIVATE
and needs_private_lib(bld
, target
):
130 ret
.add(bld
.EXPAND_VARIABLES(bld
.env
.PRIVATELIBDIR
))
134 def build_rpath(bld
):
135 '''the rpath value for build'''
136 rpaths
= [os
.path
.normpath('%s/%s' % (bld
.env
.BUILD_DIRECTORY
, d
)) for d
in ("shared", "shared/private")]
137 bld
.env
['RPATH'] = []
138 if bld
.env
.RPATH_ON_BUILD
:
141 ADD_LD_LIBRARY_PATH(rpath
)
146 def LOCAL_CACHE(ctx
, name
):
147 '''return a named build cache dictionary, used to store
148 state inside other functions'''
156 def LOCAL_CACHE_SET(ctx
, cachename
, key
, value
):
157 '''set a value in a local cache'''
158 cache
= LOCAL_CACHE(ctx
, cachename
)
163 def ASSERT(ctx
, expression
, msg
):
164 '''a build assert call'''
166 raise Errors
.WafError("ERROR: %s\n" % msg
)
167 Build
.BuildContext
.ASSERT
= ASSERT
170 def SUBDIR(bld
, subdir
, list):
171 '''create a list of files by pre-pending each with a subdir name'''
173 for l
in TO_LIST(list):
174 ret
= ret
+ os
.path
.normpath(os
.path
.join(subdir
, l
)) + ' '
176 Build
.BuildContext
.SUBDIR
= SUBDIR
179 def dict_concat(d1
, d2
):
180 '''concatenate two dictionaries d1 += d2'''
185 def ADD_COMMAND(opt
, name
, function
):
186 '''add a new top level command to waf'''
187 Context
.g_module
.__dict
__[name
] = function
189 Options
.OptionsContext
.ADD_COMMAND
= ADD_COMMAND
192 @feature('c', 'cc', 'cshlib', 'cprogram')
193 @before('apply_core','exec_rule')
194 def process_depends_on(self
):
195 '''The new depends_on attribute for build rules
196 allow us to specify a dependency on output from
197 a source generation rule'''
198 if getattr(self
, 'depends_on', None):
199 lst
= self
.to_list(self
.depends_on
)
201 y
= self
.bld
.get_tgen_by_name(x
)
202 self
.bld
.ASSERT(y
is not None, "Failed to find dependency %s of %s" % (x
, self
.name
))
204 if getattr(y
, 'more_includes', None):
205 self
.includes
+= " " + y
.more_includes
208 def unique_list(seq
):
209 '''return a uniquified list in the same order as the existing list'''
213 if item
in seen
: continue
219 def TO_LIST(str, delimiter
=None):
220 '''Split a list, preserving quoted strings and existing lists'''
223 if isinstance(str, list):
224 # we need to return a new independent list...
228 lst
= str.split(delimiter
)
229 # the string may have had quotes in it, now we
230 # check if we did have quotes, and use the slower shlex
234 return shlex
.split(str)
238 def subst_vars_error(string
, env
):
239 '''substitute vars, throw an error if a variable is not defined'''
240 lst
= re
.split('(\$\{\w+\})', string
)
243 if re
.match('\$\{\w+\}', v
):
246 raise KeyError("Failed to find variable %s in %s in env %s <%s>" % (vname
, string
, env
.__class
__, str(env
)))
248 if isinstance(v
, list):
255 def SUBST_ENV_VAR(ctx
, varname
):
256 '''Substitute an environment variable for any embedded variables'''
257 return subst_vars_error(ctx
.env
[varname
], ctx
.env
)
258 Build
.BuildContext
.SUBST_ENV_VAR
= SUBST_ENV_VAR
261 def recursive_dirlist(dir, relbase
, pattern
=None):
262 '''recursive directory list'''
264 for f
in os
.listdir(dir):
266 if os
.path
.isdir(f2
):
267 ret
.extend(recursive_dirlist(f2
, relbase
))
269 if pattern
and not fnmatch
.fnmatch(f
, pattern
):
271 ret
.append(os
.path
.relpath(f2
, relbase
))
275 def symlink(src
, dst
, force
=True):
276 """Can create symlink by force"""
279 except OSError as exc
:
280 if exc
.errno
== errno
.EEXIST
and force
:
291 if dir.endswith("/"):
294 if os
.path
.isdir(dir):
296 mkdir_p(os
.path
.dirname(dir))
300 def SUBST_VARS_RECURSIVE(string
, env
):
301 '''recursively expand variables'''
305 while (string
.find('${') != -1 and limit
> 0):
306 string
= subst_vars_error(string
, env
)
312 def EXPAND_VARIABLES(ctx
, varstr
, vars=None):
313 '''expand variables from a user supplied dictionary
315 This is most useful when you pass vars=locals() to expand
316 all your local variables in strings
319 if isinstance(varstr
, list):
322 ret
.append(EXPAND_VARIABLES(ctx
, s
, vars=vars))
325 if not isinstance(varstr
, str):
328 env
= ConfigSet
.ConfigSet()
330 # substitute on user supplied dict if avaiilable
332 for v
in vars.keys():
334 ret
= SUBST_VARS_RECURSIVE(ret
, env
)
336 # if anything left, subst on the environment as well
337 if ret
.find('${') != -1:
338 ret
= SUBST_VARS_RECURSIVE(ret
, ctx
.env
)
339 # make sure there is nothing left. Also check for the common
340 # typo of $( instead of ${
341 if ret
.find('${') != -1 or ret
.find('$(') != -1:
342 Logs
.error('Failed to substitute all variables in varstr=%s' % ret
)
345 Build
.BuildContext
.EXPAND_VARIABLES
= EXPAND_VARIABLES
351 '''run a external command, return exit code or signal'''
353 cmd
= SUBST_VARS_RECURSIVE(cmd
, env
)
355 status
= os
.system(cmd
)
356 if os
.WIFEXITED(status
):
357 return os
.WEXITSTATUS(status
)
358 if os
.WIFSIGNALED(status
):
359 return - os
.WTERMSIG(status
)
360 Logs
.error("Unknown exit reason %d for command: %s" % (status
, cmd
))
364 def RUN_PYTHON_TESTS(testfiles
, pythonpath
=None, extra_env
=None):
365 env
= LOAD_ENVIRONMENT()
366 if pythonpath
is None:
367 pythonpath
= os
.path
.join(Context
.g_module
.out
, 'python')
369 for interp
in env
.python_interpreters
:
370 if not isinstance(interp
, str):
371 interp
= ' '.join(interp
)
372 for testfile
in testfiles
:
373 cmd
= "PYTHONPATH=%s %s %s" % (pythonpath
, interp
, testfile
)
375 for key
, value
in extra_env
.items():
376 cmd
= "%s=%s %s" % (key
, value
, cmd
)
377 print('Running Python test with %s: %s' % (interp
, testfile
))
378 ret
= RUN_COMMAND(cmd
)
380 print('Python test failed: %s' % cmd
)
385 # make sure we have md5. some systems don't have it
387 from hashlib
import md5
388 # Even if hashlib.md5 exists, it may be unusable.
389 # Try to use MD5 function. In FIPS mode this will cause an exception
390 # and we'll get to the replacement code
395 # repeat the same check here, mere success of import is not enough.
396 # Try to use MD5 function. In FIPS mode this will cause an exception
397 foo
= md5
.md5(b
'abcd')
399 Context
.SIG_NIL
= hash('abcd')
400 class replace_md5(object):
403 def update(self
, val
):
404 self
.val
= hash((self
.val
, val
))
408 return self
.digest().encode('hex')
409 def replace_h_file(filename
):
410 f
= open(filename
, 'rb')
413 filename
= f
.read(100000)
417 Utils
.md5
= replace_md5
418 Task
.md5
= replace_md5
419 Utils
.h_file
= replace_h_file
422 def LOAD_ENVIRONMENT():
423 '''load the configuration environment, allowing access to env vars
425 env
= ConfigSet
.ConfigSet()
427 p
= os
.path
.join(Context
.g_module
.out
, 'c4che/default'+CACHE_SUFFIX
)
429 except (OSError, IOError):
434 def IS_NEWER(bld
, file1
, file2
):
435 '''return True if file1 is newer than file2'''
436 curdir
= bld
.path
.abspath()
437 t1
= os
.stat(os
.path
.join(curdir
, file1
)).st_mtime
438 t2
= os
.stat(os
.path
.join(curdir
, file2
)).st_mtime
440 Build
.BuildContext
.IS_NEWER
= IS_NEWER
444 def RECURSE(ctx
, directory
):
445 '''recurse into a directory, relative to the curdir or top level'''
447 visited_dirs
= ctx
.visited_dirs
448 except AttributeError:
449 visited_dirs
= ctx
.visited_dirs
= set()
450 d
= os
.path
.join(ctx
.path
.abspath(), directory
)
451 if os
.path
.exists(d
):
452 abspath
= os
.path
.abspath(d
)
454 abspath
= os
.path
.abspath(os
.path
.join(Context
.g_module
.top
, directory
))
455 ctxclass
= ctx
.__class
__.__name
__
456 key
= ctxclass
+ ':' + abspath
457 if key
in visited_dirs
:
460 visited_dirs
.add(key
)
461 relpath
= os
.path
.relpath(abspath
, ctx
.path
.abspath())
462 if ctxclass
in ['OptionsContext',
463 'ConfigurationContext',
469 return ctx
.recurse(relpath
)
470 if 'waflib.extras.compat15' in sys
.modules
:
471 return ctx
.recurse(relpath
)
472 Logs
.error('Unknown RECURSE context class: {}'.format(ctxclass
))
474 Options
.OptionsContext
.RECURSE
= RECURSE
475 Build
.BuildContext
.RECURSE
= RECURSE
478 def CHECK_MAKEFLAGS(options
):
479 '''check for MAKEFLAGS environment variable in case we are being
480 called from a Makefile try to honor a few make command line flags'''
481 if not 'WAF_MAKE' in os
.environ
:
483 makeflags
= os
.environ
.get('MAKEFLAGS')
484 if makeflags
is None:
488 # we need to use shlex.split to cope with the escaping of spaces
490 for opt
in shlex
.split(makeflags
):
491 # options can come either as -x or as x
493 options
.verbose
= Logs
.verbose
= int(opt
[2:])
495 Logs
.zones
= ['runner']
498 elif opt
[0].isupper() and opt
.find('=') != -1:
499 # this allows us to set waf options on the make command line
500 # for example, if you do "make FOO=blah", then we set the
501 # option 'FOO' in Options.options, to blah. If you look in wafsamba/wscript
502 # you will see that the command line accessible options have their dest=
503 # set to uppercase, to allow for passing of options from make in this way
504 # this is also how "make test TESTS=testpattern" works, and
505 # "make VERBOSE=1" as well as things like "make SYMBOLCHECK=1"
507 setattr(options
, opt
[0:loc
], opt
[loc
+1:])
510 if re
.search(r
'j[0-9]*$', v
):
512 jobs
= opt
.strip('j')
515 elif re
.search(r
'-j[0-9]*$', opt
):
517 jobs
= opt
.strip('-j')
523 elif jobs_set
and jobs
:
524 options
.jobs
= int(jobs
)
526 waflib_options_parse_cmd_args
= Options
.OptionsContext
.parse_cmd_args
527 def wafsamba_options_parse_cmd_args(self
, _args
=None, cwd
=None, allow_unknown
=False):
528 (options
, commands
, envvars
) = \
529 waflib_options_parse_cmd_args(self
,
532 allow_unknown
=allow_unknown
)
533 CHECK_MAKEFLAGS(options
)
534 if options
.jobs
== 1:
536 # waflib.Runner.Parallel processes jobs inline if the possible number
537 # of jobs is just 1. But (at least in waf <= 2.0.12) it still calls
538 # create a waflib.Runner.Spawner() which creates a single
539 # waflib.Runner.Consumer() thread that tries to process jobs from the
542 # This has strange effects, which are not noticed typically,
543 # but at least on AIX python has broken threading and fails
546 # So we just add a dummy Spawner class.
547 class NoOpSpawner(object):
548 def __init__(self
, master
):
550 from waflib
import Runner
551 Runner
.Spawner
= NoOpSpawner
552 return options
, commands
, envvars
553 Options
.OptionsContext
.parse_cmd_args
= wafsamba_options_parse_cmd_args
557 def option_group(opt
, name
):
558 '''find or create an option group'''
560 if name
in option_groups
:
561 return option_groups
[name
]
562 gr
= opt
.add_option_group(name
)
563 option_groups
[name
] = gr
565 Options
.OptionsContext
.option_group
= option_group
568 def save_file(filename
, contents
, create_dir
=False):
569 '''save data to a file'''
571 mkdir_p(os
.path
.dirname(filename
))
573 f
= open(filename
, 'w')
581 def load_file(filename
):
582 '''return contents of a file'''
584 f
= open(filename
, 'r')
592 def reconfigure(ctx
):
593 '''rerun configure if necessary'''
594 if not os
.path
.exists(os
.environ
.get('WAFLOCK', '.lock-wscript')):
595 raise Errors
.WafError('configure has not been run')
596 import samba_wildcard
597 bld
= samba_wildcard
.fake_build_environment()
598 Configure
.autoconfig
= True
599 Scripting
.check_configured(bld
)
602 def map_shlib_extension(ctx
, name
, python
=False):
603 '''map a filename with a shared library extension of .so to the real shlib name'''
606 if name
[-1:].isdigit():
607 # some libraries have specified versions in the wscript rule
609 (root1
, ext1
) = os
.path
.splitext(name
)
611 return ctx
.env
.pyext_PATTERN
% root1
613 (root2
, ext2
) = os
.path
.splitext(ctx
.env
.cshlib_PATTERN
)
615 Build
.BuildContext
.map_shlib_extension
= map_shlib_extension
617 def apply_pattern(filename
, pattern
):
618 '''apply a filename pattern to a filename that may have a directory component'''
619 dirname
= os
.path
.dirname(filename
)
621 return pattern
% filename
622 basename
= os
.path
.basename(filename
)
623 return os
.path
.join(dirname
, pattern
% basename
)
625 def make_libname(ctx
, name
, nolibprefix
=False, version
=None, python
=False):
626 """make a library filename
628 nolibprefix: don't include the lib prefix
629 version : add a version number
630 python : if we should use python module name conventions"""
633 libname
= apply_pattern(name
, ctx
.env
.pyext_PATTERN
)
635 libname
= apply_pattern(name
, ctx
.env
.cshlib_PATTERN
)
636 if nolibprefix
and libname
[0:3] == 'lib':
637 libname
= libname
[3:]
639 if version
[0] == '.':
640 version
= version
[1:]
641 (root
, ext
) = os
.path
.splitext(libname
)
643 # special case - version goes before the prefix
644 libname
= "%s.%s%s" % (root
, version
, ext
)
646 libname
= "%s%s.%s" % (root
, ext
, version
)
648 Build
.BuildContext
.make_libname
= make_libname
651 def get_tgt_list(bld
):
652 '''return a list of build objects for samba'''
654 targets
= LOCAL_CACHE(bld
, 'TARGET_TYPE')
656 # build a list of task generators we are interested in
660 if not type in ['SUBSYSTEM', 'BUILTIN', 'MODULE', 'BINARY', 'LIBRARY', 'PLUGIN', 'ASN1', 'PYTHON']:
662 t
= bld
.get_tgen_by_name(tgt
)
664 Logs
.error("Target %s of type %s has no task generator" % (tgt
, type))
669 from waflib
.Context
import WSCRIPT_FILE
670 def PROCESS_SEPARATE_RULE(self
, rule
):
671 ''' cause waf to process additional script based on `rule'.
672 You should have file named wscript_<stage>_rule in the current directory
673 where stage is either 'configure' or 'build'
676 if isinstance(self
, Configure
.ConfigurationContext
):
678 elif isinstance(self
, Build
.BuildContext
):
680 file_path
= os
.path
.join(self
.path
.abspath(), WSCRIPT_FILE
+'_'+stage
+'_'+rule
)
681 node
= self
.root
.find_node(file_path
)
684 cache
= self
.recurse_cache
685 except AttributeError:
686 cache
= self
.recurse_cache
= {}
687 if node
not in cache
:
689 self
.pre_recurse(node
)
691 function_code
= node
.read('r', None)
692 exec(compile(function_code
, node
.abspath(), 'exec'), self
.exec_dict
)
694 self
.post_recurse(node
)
696 Build
.BuildContext
.PROCESS_SEPARATE_RULE
= PROCESS_SEPARATE_RULE
697 ConfigurationContext
.PROCESS_SEPARATE_RULE
= PROCESS_SEPARATE_RULE
699 def AD_DC_BUILD_IS_ENABLED(self
):
700 if self
.CONFIG_SET('AD_DC_BUILD_IS_ENABLED'):
704 Build
.BuildContext
.AD_DC_BUILD_IS_ENABLED
= AD_DC_BUILD_IS_ENABLED
706 @feature('cprogram', 'cshlib', 'cstaticlib')
707 @after('apply_lib_vars')
708 @before('apply_obj_vars')
709 def samba_before_apply_obj_vars(self
):
710 """before apply_obj_vars for uselib, this removes the standard paths"""
712 def is_standard_libpath(env
, path
):
713 for _path
in env
.STANDARD_LIBPATH
:
714 if _path
== os
.path
.normpath(path
):
721 if is_standard_libpath(v
, i
):
724 for i
in v
['LIBPATH']:
725 if is_standard_libpath(v
, i
):
726 v
['LIBPATH'].remove(i
)
728 # Samba options are mostly on by default (administrators and packagers
729 # specify features to remove, not add), which is why default=True
731 def samba_add_onoff_option(opt
, option
, help=(), dest
=None, default
=True,
732 with_name
="with", without_name
="without"):
735 elif default
is True:
737 elif default
is False:
740 default_str
= str(default
)
743 help = ("Build with %s support (default=%s)" % (option
, default_str
))
745 dest
= "with_%s" % option
.replace('-', '_')
747 with_val
= "--%s-%s" % (with_name
, option
)
748 without_val
= "--%s-%s" % (without_name
, option
)
750 opt
.add_option(with_val
, help=help, action
="store_true", dest
=dest
,
752 opt
.add_option(without_val
, help=SUPPRESS_HELP
, action
="store_false",
754 Options
.OptionsContext
.samba_add_onoff_option
= samba_add_onoff_option