1 # a waf tool to add autoconf-like macros to the configure section
2 # and for SAMBA_ macros for building libraries, binaries etc
4 import os, sys, re, fnmatch, shlex, inspect
5 from optparse import SUPPRESS_HELP
6 from waflib import Build, Options, Utils, Task, Logs, Configure, Errors, Context
7 from waflib.TaskGen import feature, before, after
8 from waflib.Configure import ConfigurationContext
9 from waflib.Logs import debug
10 from waflib import ConfigSet
11 from waflib.Build import CACHE_SUFFIX
13 # TODO: make this a --option
17 # sigh, python octal constants are a mess
18 MODE_644 = int('644', 8)
19 MODE_755 = int('755', 8)
22 # override in order to propagate the argument "mandatory"
26 mandatory = kw['mandatory']
31 except Errors.ConfigurationError:
35 fun.__name__ = f.__name__
36 if 'mandatory' in inspect.getsource(f):
39 setattr(Configure.ConfigurationContext, f.__name__, fun)
40 setattr(Build.BuildContext, f.__name__, fun)
43 Configure.conftest = conf
46 def SET_TARGET_TYPE(ctx, target, value):
47 '''set the target type of a target'''
48 cache = LOCAL_CACHE(ctx, 'TARGET_TYPE')
49 if target in cache and cache[target] != 'EMPTY':
50 Logs.error("ERROR: Target '%s' in directory %s re-defined as %s - was %s" % (target, ctx.path.abspath(), value, cache[target]))
52 LOCAL_CACHE_SET(ctx, 'TARGET_TYPE', target, value)
53 debug("task_gen: Target '%s' created of type '%s' in %s" % (target, value, ctx.path.abspath()))
57 def GET_TARGET_TYPE(ctx, target):
58 '''get target type from cache'''
59 cache = LOCAL_CACHE(ctx, 'TARGET_TYPE')
60 if not target in cache:
65 def ADD_LD_LIBRARY_PATH(path):
66 '''add something to LD_LIBRARY_PATH'''
67 if 'LD_LIBRARY_PATH' in os.environ:
68 oldpath = os.environ['LD_LIBRARY_PATH']
71 newpath = oldpath.split(':')
72 if not path in newpath:
74 os.environ['LD_LIBRARY_PATH'] = ':'.join(newpath)
77 def needs_private_lib(bld, target):
78 '''return True if a target links to a private library'''
79 for lib in getattr(target, "final_libs", []):
80 t = bld.get_tgen_by_name(lib)
81 if t and getattr(t, 'private_library', False):
86 def install_rpath(target):
87 '''the rpath value for installation'''
91 if bld.env.RPATH_ON_INSTALL:
92 ret.add(bld.EXPAND_VARIABLES(bld.env.LIBDIR))
93 if bld.env.RPATH_ON_INSTALL_PRIVATE and needs_private_lib(bld, target):
94 ret.add(bld.EXPAND_VARIABLES(bld.env.PRIVATELIBDIR))
99 '''the rpath value for build'''
100 rpaths = [os.path.normpath('%s/%s' % (bld.env.BUILD_DIRECTORY, d)) for d in ("shared", "shared/private")]
101 bld.env['RPATH'] = []
102 if bld.env.RPATH_ON_BUILD:
105 ADD_LD_LIBRARY_PATH(rpath)
110 def LOCAL_CACHE(ctx, name):
111 '''return a named build cache dictionary, used to store
112 state inside other functions'''
120 def LOCAL_CACHE_SET(ctx, cachename, key, value):
121 '''set a value in a local cache'''
122 cache = LOCAL_CACHE(ctx, cachename)
127 def ASSERT(ctx, expression, msg):
128 '''a build assert call'''
130 raise Errors.WafError("ERROR: %s\n" % msg)
131 Build.BuildContext.ASSERT = ASSERT
134 def SUBDIR(bld, subdir, list):
135 '''create a list of files by pre-pending each with a subdir name'''
137 for l in TO_LIST(list):
138 ret = ret + os.path.normpath(os.path.join(subdir, l)) + ' '
140 Build.BuildContext.SUBDIR = SUBDIR
143 def dict_concat(d1, d2):
144 '''concatenate two dictionaries d1 += d2'''
149 def ADD_COMMAND(opt, name, function):
150 '''add a new top level command to waf'''
151 Context.g_module.__dict__[name] = function
153 Options.OptionsContext.ADD_COMMAND = ADD_COMMAND
156 @feature('c', 'cc', 'cshlib', 'cprogram')
157 @before('apply_core','exec_rule')
158 def process_depends_on(self):
159 '''The new depends_on attribute for build rules
160 allow us to specify a dependency on output from
161 a source generation rule'''
162 if getattr(self , 'depends_on', None):
163 lst = self.to_list(self.depends_on)
165 y = self.bld.get_tgen_by_name(x)
166 self.bld.ASSERT(y is not None, "Failed to find dependency %s of %s" % (x, self.name))
168 if getattr(y, 'more_includes', None):
169 self.includes += " " + y.more_includes
172 os_path_relpath = getattr(os.path, 'relpath', None)
173 if os_path_relpath is None:
174 # Python < 2.6 does not have os.path.relpath, provide a replacement
175 # (imported from Python2.6.5~rc2)
176 def os_path_relpath(path, start):
177 """Return a relative version of a path"""
178 start_list = os.path.abspath(start).split("/")
179 path_list = os.path.abspath(path).split("/")
181 # Work out how much of the filepath is shared by start and path.
182 i = len(os.path.commonprefix([start_list, path_list]))
184 rel_list = ['..'] * (len(start_list)-i) + path_list[i:]
187 return os.path.join(*rel_list)
190 def unique_list(seq):
191 '''return a uniquified list in the same order as the existing list'''
195 if item in seen: continue
201 def TO_LIST(str, delimiter=None):
202 '''Split a list, preserving quoted strings and existing lists'''
205 if isinstance(str, list):
206 # we need to return a new independent list...
210 lst = str.split(delimiter)
211 # the string may have had quotes in it, now we
212 # check if we did have quotes, and use the slower shlex
216 return shlex.split(str)
220 def subst_vars_error(string, env):
221 '''substitute vars, throw an error if a variable is not defined'''
222 lst = re.split('(\$\{\w+\})', string)
225 if re.match('\$\{\w+\}', v):
228 raise KeyError("Failed to find variable %s in %s in env %s <%s>" % (vname, string, env.__class__, str(env)))
230 if isinstance(v, list):
237 def SUBST_ENV_VAR(ctx, varname):
238 '''Substitute an environment variable for any embedded variables'''
239 return subst_vars_error(ctx.env[varname], ctx.env)
240 Build.BuildContext.SUBST_ENV_VAR = SUBST_ENV_VAR
243 def recursive_dirlist(dir, relbase, pattern=None):
244 '''recursive directory list'''
246 for f in os.listdir(dir):
248 if os.path.isdir(f2):
249 ret.extend(recursive_dirlist(f2, relbase))
251 if pattern and not fnmatch.fnmatch(f, pattern):
253 ret.append(os_path_relpath(f2, relbase))
261 if dir.endswith("/"):
264 if os.path.isdir(dir):
266 mkdir_p(os.path.dirname(dir))
270 def SUBST_VARS_RECURSIVE(string, env):
271 '''recursively expand variables'''
275 while (string.find('${') != -1 and limit > 0):
276 string = subst_vars_error(string, env)
282 def EXPAND_VARIABLES(ctx, varstr, vars=None):
283 '''expand variables from a user supplied dictionary
285 This is most useful when you pass vars=locals() to expand
286 all your local variables in strings
289 if isinstance(varstr, list):
292 ret.append(EXPAND_VARIABLES(ctx, s, vars=vars))
295 if not isinstance(varstr, str):
298 env = ConfigSet.ConfigSet()
300 # substitute on user supplied dict if avaiilable
302 for v in vars.keys():
304 ret = SUBST_VARS_RECURSIVE(ret, env)
306 # if anything left, subst on the environment as well
307 if ret.find('${') != -1:
308 ret = SUBST_VARS_RECURSIVE(ret, ctx.env)
309 # make sure there is nothing left. Also check for the common
310 # typo of $( instead of ${
311 if ret.find('${') != -1 or ret.find('$(') != -1:
312 Logs.error('Failed to substitute all variables in varstr=%s' % ret)
315 Build.BuildContext.EXPAND_VARIABLES = EXPAND_VARIABLES
321 '''run a external command, return exit code or signal'''
323 cmd = SUBST_VARS_RECURSIVE(cmd, env)
325 status = os.system(cmd)
326 if os.WIFEXITED(status):
327 return os.WEXITSTATUS(status)
328 if os.WIFSIGNALED(status):
329 return - os.WTERMSIG(status)
330 Logs.error("Unknown exit reason %d for command: %s" (status, cmd))
334 def RUN_PYTHON_TESTS(testfiles, pythonpath=None, extra_env=None):
335 env = LOAD_ENVIRONMENT()
336 if pythonpath is None:
337 pythonpath = os.path.join(Context.g_module.out, 'python')
339 for interp in env.python_interpreters:
340 if not isinstance(interp, str):
341 interp = ' '.join(interp)
342 for testfile in testfiles:
343 cmd = "PYTHONPATH=%s %s %s" % (pythonpath, interp, testfile)
345 for key, value in extra_env.items():
346 cmd = "%s=%s %s" % (key, value, cmd)
347 print('Running Python test with %s: %s' % (interp, testfile))
348 ret = RUN_COMMAND(cmd)
350 print('Python test failed: %s' % cmd)
355 # make sure we have md5. some systems don't have it
357 from hashlib import md5
358 # Even if hashlib.md5 exists, it may be unusable.
359 # Try to use MD5 function. In FIPS mode this will cause an exception
360 # and we'll get to the replacement code
365 # repeat the same check here, mere success of import is not enough.
366 # Try to use MD5 function. In FIPS mode this will cause an exception
367 foo = md5.md5('abcd')
369 Context.SIG_NIL = hash('abcd')
370 class replace_md5(object):
373 def update(self, val):
374 self.val = hash((self.val, val))
378 return self.digest().encode('hex')
379 def replace_h_file(filename):
380 f = open(filename, 'rb')
383 filename = f.read(100000)
387 Utils.md5 = replace_md5
388 Task.md5 = replace_md5
389 Utils.h_file = replace_h_file
392 def LOAD_ENVIRONMENT():
393 '''load the configuration environment, allowing access to env vars
395 env = ConfigSet.ConfigSet()
397 p = os.path.join(Context.g_module.out, 'c4che/default'+CACHE_SUFFIX)
399 except (OSError, IOError):
404 def IS_NEWER(bld, file1, file2):
405 '''return True if file1 is newer than file2'''
406 curdir = bld.path.abspath()
407 t1 = os.stat(os.path.join(curdir, file1)).st_mtime
408 t2 = os.stat(os.path.join(curdir, file2)).st_mtime
410 Build.BuildContext.IS_NEWER = IS_NEWER
414 def RECURSE(ctx, directory):
415 '''recurse into a directory, relative to the curdir or top level'''
417 visited_dirs = ctx.visited_dirs
418 except AttributeError:
419 visited_dirs = ctx.visited_dirs = set()
420 d = os.path.join(ctx.path.abspath(), directory)
421 if os.path.exists(d):
422 abspath = os.path.abspath(d)
424 abspath = os.path.abspath(os.path.join(Context.g_module.top, directory))
425 ctxclass = ctx.__class__.__name__
426 key = ctxclass + ':' + abspath
427 if key in visited_dirs:
430 visited_dirs.add(key)
431 relpath = os_path_relpath(abspath, ctx.path.abspath())
432 if ctxclass in ['tmp', 'OptionsContext', 'ConfigurationContext', 'BuildContext']:
433 return ctx.recurse(relpath)
434 if 'waflib.extras.compat15' in sys.modules:
435 return ctx.recurse(relpath)
436 Logs.error('Unknown RECURSE context class: {}'.format(ctxclass))
438 Options.OptionsContext.RECURSE = RECURSE
439 Build.BuildContext.RECURSE = RECURSE
442 def CHECK_MAKEFLAGS(bld):
443 '''check for MAKEFLAGS environment variable in case we are being
444 called from a Makefile try to honor a few make command line flags'''
445 if not 'WAF_MAKE' in os.environ:
447 makeflags = os.environ.get('MAKEFLAGS')
448 if makeflags is None:
451 # we need to use shlex.split to cope with the escaping of spaces
453 for opt in shlex.split(makeflags):
454 # options can come either as -x or as x
456 Options.options.verbose = Logs.verbose = int(opt[2:])
458 Logs.zones = ['runner']
461 elif opt[0].isupper() and opt.find('=') != -1:
462 # this allows us to set waf options on the make command line
463 # for example, if you do "make FOO=blah", then we set the
464 # option 'FOO' in Options.options, to blah. If you look in wafsamba/wscript
465 # you will see that the command line accessible options have their dest=
466 # set to uppercase, to allow for passing of options from make in this way
467 # this is also how "make test TESTS=testpattern" works, and
468 # "make VERBOSE=1" as well as things like "make SYMBOLCHECK=1"
470 setattr(Options.options, opt[0:loc], opt[loc+1:])
476 Options.options.keep = True
480 Options.options.keep = True
483 Options.options.jobs = 1
485 Build.BuildContext.CHECK_MAKEFLAGS = CHECK_MAKEFLAGS
489 def option_group(opt, name):
490 '''find or create an option group'''
492 if name in option_groups:
493 return option_groups[name]
494 gr = opt.add_option_group(name)
495 option_groups[name] = gr
497 Options.OptionsContext.option_group = option_group
500 def save_file(filename, contents, create_dir=False):
501 '''save data to a file'''
503 mkdir_p(os.path.dirname(filename))
505 f = open(filename, 'w')
513 def load_file(filename):
514 '''return contents of a file'''
516 f = open(filename, 'r')
524 def reconfigure(ctx):
525 '''rerun configure if necessary'''
526 if not os.path.exists(".lock-wscript"):
527 raise Errors.WafError('configure has not been run')
528 import samba_wildcard
529 bld = samba_wildcard.fake_build_environment()
530 Configure.autoconfig = True
531 Scripting.check_configured(bld)
534 def map_shlib_extension(ctx, name, python=False):
535 '''map a filename with a shared library extension of .so to the real shlib name'''
538 if name[-1:].isdigit():
539 # some libraries have specified versions in the wscript rule
541 (root1, ext1) = os.path.splitext(name)
543 return ctx.env.pyext_PATTERN % root1
545 (root2, ext2) = os.path.splitext(ctx.env.cshlib_PATTERN)
547 Build.BuildContext.map_shlib_extension = map_shlib_extension
549 def apply_pattern(filename, pattern):
550 '''apply a filename pattern to a filename that may have a directory component'''
551 dirname = os.path.dirname(filename)
553 return pattern % filename
554 basename = os.path.basename(filename)
555 return os.path.join(dirname, pattern % basename)
557 def make_libname(ctx, name, nolibprefix=False, version=None, python=False):
558 """make a library filename
560 nolibprefix: don't include the lib prefix
561 version : add a version number
562 python : if we should use python module name conventions"""
565 libname = apply_pattern(name, ctx.env.pyext_PATTERN)
567 libname = apply_pattern(name, ctx.env.cshlib_PATTERN)
568 if nolibprefix and libname[0:3] == 'lib':
569 libname = libname[3:]
571 if version[0] == '.':
572 version = version[1:]
573 (root, ext) = os.path.splitext(libname)
575 # special case - version goes before the prefix
576 libname = "%s.%s%s" % (root, version, ext)
578 libname = "%s%s.%s" % (root, ext, version)
580 Build.BuildContext.make_libname = make_libname
583 def get_tgt_list(bld):
584 '''return a list of build objects for samba'''
586 targets = LOCAL_CACHE(bld, 'TARGET_TYPE')
588 # build a list of task generators we are interested in
592 if not type in ['SUBSYSTEM', 'MODULE', 'BINARY', 'LIBRARY', 'ASN1', 'PYTHON']:
594 t = bld.get_tgen_by_name(tgt)
596 Logs.error("Target %s of type %s has no task generator" % (tgt, type))
601 from waflib.Context import WSCRIPT_FILE
602 def PROCESS_SEPARATE_RULE(self, rule):
603 ''' cause waf to process additional script based on `rule'.
604 You should have file named wscript_<stage>_rule in the current directory
605 where stage is either 'configure' or 'build'
608 if isinstance(self, Configure.ConfigurationContext):
610 elif isinstance(self, Build.BuildContext):
612 file_path = os.path.join(self.path.abspath(), WSCRIPT_FILE+'_'+stage+'_'+rule)
613 node = self.root.find_node(file_path)
616 cache = self.recurse_cache
617 except AttributeError:
618 cache = self.recurse_cache = {}
619 if node not in cache:
621 self.pre_recurse(node)
623 function_code = node.read('rU', None)
624 exec(compile(function_code, node.abspath(), 'exec'), self.exec_dict)
626 self.post_recurse(node)
628 Build.BuildContext.PROCESS_SEPARATE_RULE = PROCESS_SEPARATE_RULE
629 ConfigurationContext.PROCESS_SEPARATE_RULE = PROCESS_SEPARATE_RULE
631 def AD_DC_BUILD_IS_ENABLED(self):
632 if self.CONFIG_SET('AD_DC_BUILD_IS_ENABLED'):
636 Build.BuildContext.AD_DC_BUILD_IS_ENABLED = AD_DC_BUILD_IS_ENABLED
638 @feature('cprogram', 'cshlib', 'cstaticlib')
639 @after('apply_lib_vars')
640 @before('apply_obj_vars')
641 def samba_before_apply_obj_vars(self):
642 """before apply_obj_vars for uselib, this removes the standard paths"""
644 def is_standard_libpath(env, path):
645 for _path in env.STANDARD_LIBPATH:
646 if _path == os.path.normpath(path):
653 if is_standard_libpath(v, i):
656 for i in v['LIBPATH']:
657 if is_standard_libpath(v, i):
658 v['LIBPATH'].remove(i)
660 def samba_add_onoff_option(opt, option, help=(), dest=None, default=True,
661 with_name="with", without_name="without"):
664 elif default is True:
666 elif default is False:
669 default_str = str(default)
672 help = ("Build with %s support (default=%s)" % (option, default_str))
674 dest = "with_%s" % option.replace('-', '_')
676 with_val = "--%s-%s" % (with_name, option)
677 without_val = "--%s-%s" % (without_name, option)
679 opt.add_option(with_val, help=help, action="store_true", dest=dest,
681 opt.add_option(without_val, help=SUPPRESS_HELP, action="store_false",
683 Options.OptionsContext.samba_add_onoff_option = samba_add_onoff_option