buildtools/wafsamba/samba_utils.py

   1 # a waf tool to add autoconf-like macros to the configure section
   2 # and for SAMBA_ macros for building libraries, binaries etc
   3
   4 import Build, os, sys, Options, Utils, Task, re, fnmatch, Logs
   5 from TaskGen import feature, before
   6 from Configure import conf, ConfigurationContext
   7 from Logs import debug
   8 import shlex
   9
  10 # TODO: make this a --option
  11 LIB_PATH="shared"
  12
  13
  14 # sigh, python octal constants are a mess
  15 MODE_644 = int('644', 8)
  16 MODE_755 = int('755', 8)
  17
  18 @conf
  19 def SET_TARGET_TYPE(ctx, target, value):
  20     '''set the target type of a target'''
  21     cache = LOCAL_CACHE(ctx, 'TARGET_TYPE')
  22     if target in cache and cache[target] != 'EMPTY':
  23         Logs.error("ERROR: Target '%s' in directory %s re-defined as %s - was %s" % (target, ctx.curdir, value, cache[target]))
  24         sys.exit(1)
  25     LOCAL_CACHE_SET(ctx, 'TARGET_TYPE', target, value)
  26     debug("task_gen: Target '%s' created of type '%s' in %s" % (target, value, ctx.curdir))
  27     return True
  28
  29
  30 def GET_TARGET_TYPE(ctx, target):
  31     '''get target type from cache'''
  32     cache = LOCAL_CACHE(ctx, 'TARGET_TYPE')
  33     if not target in cache:
  34         return None
  35     return cache[target]
  36
  37
  38 ######################################################
  39 # this is used as a decorator to make functions only
  40 # run once. Based on the idea from
  41 # http://stackoverflow.com/questions/815110/is-there-a-decorator-to-simply-cache-function-return-values
  42 runonce_ret = {}
  43 def runonce(function):
  44     def runonce_wrapper(*args):
  45         if args in runonce_ret:
  46             return runonce_ret[args]
  47         else:
  48             ret = function(*args)
  49             runonce_ret[args] = ret
  50             return ret
  51     return runonce_wrapper
  52
  53
  54 def ADD_LD_LIBRARY_PATH(path):
  55     '''add something to LD_LIBRARY_PATH'''
  56     if 'LD_LIBRARY_PATH' in os.environ:
  57         oldpath = os.environ['LD_LIBRARY_PATH']
  58     else:
  59         oldpath = ''
  60     newpath = oldpath.split(':')
  61     if not path in newpath:
  62         newpath.append(path)
  63         os.environ['LD_LIBRARY_PATH'] = ':'.join(newpath)
  64
  65
  66 def needs_private_lib(bld, target):
  67     '''return True if a target links to a private library'''
  68     for lib in getattr(target, "final_libs", []):
  69         t = bld.name_to_obj(lib, bld.env)
  70         if t and getattr(t, 'private_library', False):
  71             return True
  72     return False
  73
  74
  75 def install_rpath(target):
  76     '''the rpath value for installation'''
  77     bld = target.bld
  78     bld.env['RPATH'] = []
  79     ret = set()
  80     if bld.env.RPATH_ON_INSTALL:
  81         ret.add(bld.EXPAND_VARIABLES(bld.env.LIBDIR))
  82     if bld.env.RPATH_ON_INSTALL_PRIVATE and needs_private_lib(bld, target):
  83         ret.add(bld.EXPAND_VARIABLES(bld.env.PRIVATELIBDIR))
  84     return list(ret)
  85
  86
  87 def build_rpath(bld):
  88     '''the rpath value for build'''
  89     rpaths = [os.path.normpath('%s/%s' % (bld.env.BUILD_DIRECTORY, d)) for d in ("shared", "shared/private")]
  90     bld.env['RPATH'] = []
  91     if bld.env.RPATH_ON_BUILD:
  92         return rpaths
  93     for rpath in rpaths:
  94         ADD_LD_LIBRARY_PATH(rpath)
  95     return []
  96
  97
  98 @conf
  99 def LOCAL_CACHE(ctx, name):
 100     '''return a named build cache dictionary, used to store
 101        state inside other functions'''
 102     if name in ctx.env:
 103         return ctx.env[name]
 104     ctx.env[name] = {}
 105     return ctx.env[name]
 106
 107
 108 @conf
 109 def LOCAL_CACHE_SET(ctx, cachename, key, value):
 110     '''set a value in a local cache'''
 111     cache = LOCAL_CACHE(ctx, cachename)
 112     cache[key] = value
 113
 114
 115 @conf
 116 def ASSERT(ctx, expression, msg):
 117     '''a build assert call'''
 118     if not expression:
 119         raise Utils.WafError("ERROR: %s\n" % msg)
 120 Build.BuildContext.ASSERT = ASSERT
 121
 122
 123 def SUBDIR(bld, subdir, list):
 124     '''create a list of files by pre-pending each with a subdir name'''
 125     ret = ''
 126     for l in TO_LIST(list):
 127         ret = ret + os.path.normpath(os.path.join(subdir, l)) + ' '
 128     return ret
 129 Build.BuildContext.SUBDIR = SUBDIR
 130
 131
 132 def dict_concat(d1, d2):
 133     '''concatenate two dictionaries d1 += d2'''
 134     for t in d2:
 135         if t not in d1:
 136             d1[t] = d2[t]
 137
 138
 139 def exec_command(self, cmd, **kw):
 140     '''this overrides the 'waf -v' debug output to be in a nice
 141     unix like format instead of a python list.
 142     Thanks to ita on #waf for this'''
 143     import Utils, Logs
 144     _cmd = cmd
 145     if isinstance(cmd, list):
 146         _cmd = ' '.join(cmd)
 147     debug('runner: %s' % _cmd)
 148     if self.log:
 149         self.log.write('%s\n' % cmd)
 150         kw['log'] = self.log
 151     try:
 152         if not kw.get('cwd', None):
 153             kw['cwd'] = self.cwd
 154     except AttributeError:
 155         self.cwd = kw['cwd'] = self.bldnode.abspath()
 156     return Utils.exec_command(cmd, **kw)
 157 Build.BuildContext.exec_command = exec_command
 158
 159
 160 def ADD_COMMAND(opt, name, function):
 161     '''add a new top level command to waf'''
 162     Utils.g_module.__dict__[name] = function
 163     opt.name = function
 164 Options.Handler.ADD_COMMAND = ADD_COMMAND
 165
 166
 167 @feature('cc', 'cshlib', 'cprogram')
 168 @before('apply_core','exec_rule')
 169 def process_depends_on(self):
 170     '''The new depends_on attribute for build rules
 171        allow us to specify a dependency on output from
 172        a source generation rule'''
 173     if getattr(self , 'depends_on', None):
 174         lst = self.to_list(self.depends_on)
 175         for x in lst:
 176             y = self.bld.name_to_obj(x, self.env)
 177             self.bld.ASSERT(y is not None, "Failed to find dependency %s of %s" % (x, self.name))
 178             y.post()
 179             if getattr(y, 'more_includes', None):
 180                   self.includes += " " + y.more_includes
 181
 182
 183 os_path_relpath = getattr(os.path, 'relpath', None)
 184 if os_path_relpath is None:
 185     # Python < 2.6 does not have os.path.relpath, provide a replacement
 186     # (imported from Python2.6.5~rc2)
 187     def os_path_relpath(path, start):
 188         """Return a relative version of a path"""
 189         start_list = os.path.abspath(start).split("/")
 190         path_list = os.path.abspath(path).split("/")
 191
 192         # Work out how much of the filepath is shared by start and path.
 193         i = len(os.path.commonprefix([start_list, path_list]))
 194
 195         rel_list = ['..'] * (len(start_list)-i) + path_list[i:]
 196         if not rel_list:
 197             return start
 198         return os.path.join(*rel_list)
 199
 200
 201 def unique_list(seq):
 202     '''return a uniquified list in the same order as the existing list'''
 203     seen = {}
 204     result = []
 205     for item in seq:
 206         if item in seen: continue
 207         seen[item] = True
 208         result.append(item)
 209     return result
 210
 211
 212 def TO_LIST(str, delimiter=None):
 213     '''Split a list, preserving quoted strings and existing lists'''
 214     if str is None:
 215         return []
 216     if isinstance(str, list):
 217         return str
 218     if len(str) == 0:
 219         return []
 220     lst = str.split(delimiter)
 221     # the string may have had quotes in it, now we
 222     # check if we did have quotes, and use the slower shlex
 223     # if we need to
 224     for e in lst:
 225         if e[0] == '"':
 226             return shlex.split(str)
 227     return lst
 228
 229
 230 def subst_vars_error(string, env):
 231     '''substitute vars, throw an error if a variable is not defined'''
 232     lst = re.split('(\$\{\w+\})', string)
 233     out = []
 234     for v in lst:
 235         if re.match('\$\{\w+\}', v):
 236             vname = v[2:-1]
 237             if not vname in env:
 238                 raise KeyError("Failed to find variable %s in %s" % (vname, string))
 239             v = env[vname]
 240         out.append(v)
 241     return ''.join(out)
 242
 243
 244 @conf
 245 def SUBST_ENV_VAR(ctx, varname):
 246     '''Substitute an environment variable for any embedded variables'''
 247     return subst_vars_error(ctx.env[varname], ctx.env)
 248 Build.BuildContext.SUBST_ENV_VAR = SUBST_ENV_VAR
 249
 250
 251 def ENFORCE_GROUP_ORDERING(bld):
 252     '''enforce group ordering for the project. This
 253        makes the group ordering apply only when you specify
 254        a target with --target'''
 255     if Options.options.compile_targets:
 256         @feature('*')
 257         @before('exec_rule', 'apply_core', 'collect')
 258         def force_previous_groups(self):
 259             if getattr(self.bld, 'enforced_group_ordering', False):
 260                 return
 261             self.bld.enforced_group_ordering = True
 262
 263             def group_name(g):
 264                 tm = self.bld.task_manager
 265                 return [x for x in tm.groups_names if id(tm.groups_names[x]) == id(g)][0]
 266
 267             my_id = id(self)
 268             bld = self.bld
 269             stop = None
 270             for g in bld.task_manager.groups:
 271                 for t in g.tasks_gen:
 272                     if id(t) == my_id:
 273                         stop = id(g)
 274                         debug('group: Forcing up to group %s for target %s',
 275                               group_name(g), self.name or self.target)
 276                         break
 277                 if stop is not None:
 278                     break
 279             if stop is None:
 280                 return
 281
 282             for i in xrange(len(bld.task_manager.groups)):
 283                 g = bld.task_manager.groups[i]
 284                 bld.task_manager.current_group = i
 285                 if id(g) == stop:
 286                     break
 287                 debug('group: Forcing group %s', group_name(g))
 288                 for t in g.tasks_gen:
 289                     if not getattr(t, 'forced_groups', False):
 290                         debug('group: Posting %s', t.name or t.target)
 291                         t.forced_groups = True
 292                         t.post()
 293 Build.BuildContext.ENFORCE_GROUP_ORDERING = ENFORCE_GROUP_ORDERING
 294
 295
 296 def recursive_dirlist(dir, relbase, pattern=None):
 297     '''recursive directory list'''
 298     ret = []
 299     for f in os.listdir(dir):
 300         f2 = dir + '/' + f
 301         if os.path.isdir(f2):
 302             ret.extend(recursive_dirlist(f2, relbase))
 303         else:
 304             if pattern and not fnmatch.fnmatch(f, pattern):
 305                 continue
 306             ret.append(os_path_relpath(f2, relbase))
 307     return ret
 308
 309
 310 def mkdir_p(dir):
 311     '''like mkdir -p'''
 312     if not dir:
 313         return
 314     if dir.endswith("/"):
 315         mkdir_p(dir[:-1])
 316         return
 317     if os.path.isdir(dir):
 318         return
 319     mkdir_p(os.path.dirname(dir))
 320     os.mkdir(dir)
 321
 322
 323 def SUBST_VARS_RECURSIVE(string, env):
 324     '''recursively expand variables'''
 325     if string is None:
 326         return string
 327     limit=100
 328     while (string.find('${') != -1 and limit > 0):
 329         string = subst_vars_error(string, env)
 330         limit -= 1
 331     return string
 332
 333
 334 @conf
 335 def EXPAND_VARIABLES(ctx, varstr, vars=None):
 336     '''expand variables from a user supplied dictionary
 337
 338     This is most useful when you pass vars=locals() to expand
 339     all your local variables in strings
 340     '''
 341
 342     if isinstance(varstr, list):
 343         ret = []
 344         for s in varstr:
 345             ret.append(EXPAND_VARIABLES(ctx, s, vars=vars))
 346         return ret
 347
 348     if not isinstance(varstr, str):
 349         return varstr
 350
 351     import Environment
 352     env = Environment.Environment()
 353     ret = varstr
 354     # substitute on user supplied dict if avaiilable
 355     if vars is not None:
 356         for v in vars.keys():
 357             env[v] = vars[v]
 358         ret = SUBST_VARS_RECURSIVE(ret, env)
 359
 360     # if anything left, subst on the environment as well
 361     if ret.find('${') != -1:
 362         ret = SUBST_VARS_RECURSIVE(ret, ctx.env)
 363     # make sure there is nothing left. Also check for the common
 364     # typo of $( instead of ${
 365     if ret.find('${') != -1 or ret.find('$(') != -1:
 366         Logs.error('Failed to substitute all variables in varstr=%s' % ret)
 367         sys.exit(1)
 368     return ret
 369 Build.BuildContext.EXPAND_VARIABLES = EXPAND_VARIABLES
 370
 371
 372 def RUN_COMMAND(cmd,
 373                 env=None,
 374                 shell=False):
 375     '''run a external command, return exit code or signal'''
 376     if env:
 377         cmd = SUBST_VARS_RECURSIVE(cmd, env)
 378
 379     status = os.system(cmd)
 380     if os.WIFEXITED(status):
 381         return os.WEXITSTATUS(status)
 382     if os.WIFSIGNALED(status):
 383         return - os.WTERMSIG(status)
 384     Logs.error("Unknown exit reason %d for command: %s" (status, cmd))
 385     return -1
 386
 387
 388 # make sure we have md5. some systems don't have it
 389 try:
 390     from hashlib import md5
 391     # Even if hashlib.md5 exists, it may be unusable.
 392     # Try to use MD5 function. In FIPS mode this will cause an exception
 393     # and we'll get to the replacement code
 394     foo = md5('abcd')
 395 except:
 396     try:
 397         import md5
 398         # repeat the same check here, mere success of import is not enough.
 399         # Try to use MD5 function. In FIPS mode this will cause an exception
 400         foo = md5.md5('abcd')
 401     except:
 402         import Constants
 403         Constants.SIG_NIL = hash('abcd')
 404         class replace_md5(object):
 405             def __init__(self):
 406                 self.val = None
 407             def update(self, val):
 408                 self.val = hash((self.val, val))
 409             def digest(self):
 410                 return str(self.val)
 411             def hexdigest(self):
 412                 return self.digest().encode('hex')
 413         def replace_h_file(filename):
 414             f = open(filename, 'rb')
 415             m = replace_md5()
 416             while (filename):
 417                 filename = f.read(100000)
 418                 m.update(filename)
 419             f.close()
 420             return m.digest()
 421         Utils.md5 = replace_md5
 422         Task.md5 = replace_md5
 423         Utils.h_file = replace_h_file
 424
 425
 426 def LOAD_ENVIRONMENT():
 427     '''load the configuration environment, allowing access to env vars
 428        from new commands'''
 429     import Environment
 430     env = Environment.Environment()
 431     try:
 432         env.load('.lock-wscript')
 433         env.load(env.blddir + '/c4che/default.cache.py')
 434     except:
 435         pass
 436     return env
 437
 438
 439 def IS_NEWER(bld, file1, file2):
 440     '''return True if file1 is newer than file2'''
 441     t1 = os.stat(os.path.join(bld.curdir, file1)).st_mtime
 442     t2 = os.stat(os.path.join(bld.curdir, file2)).st_mtime
 443     return t1 > t2
 444 Build.BuildContext.IS_NEWER = IS_NEWER
 445
 446
 447 @conf
 448 def RECURSE(ctx, directory):
 449     '''recurse into a directory, relative to the curdir or top level'''
 450     try:
 451         visited_dirs = ctx.visited_dirs
 452     except:
 453         visited_dirs = ctx.visited_dirs = set()
 454     d = os.path.join(ctx.curdir, directory)
 455     if os.path.exists(d):
 456         abspath = os.path.abspath(d)
 457     else:
 458         abspath = os.path.abspath(os.path.join(Utils.g_module.srcdir, directory))
 459     ctxclass = ctx.__class__.__name__
 460     key = ctxclass + ':' + abspath
 461     if key in visited_dirs:
 462         # already done it
 463         return
 464     visited_dirs.add(key)
 465     relpath = os_path_relpath(abspath, ctx.curdir)
 466     if ctxclass == 'Handler':
 467         return ctx.sub_options(relpath)
 468     if ctxclass == 'ConfigurationContext':
 469         return ctx.sub_config(relpath)
 470     if ctxclass == 'BuildContext':
 471         return ctx.add_subdirs(relpath)
 472     Logs.error('Unknown RECURSE context class', ctxclass)
 473     raise
 474 Options.Handler.RECURSE = RECURSE
 475 Build.BuildContext.RECURSE = RECURSE
 476
 477
 478 def CHECK_MAKEFLAGS(bld):
 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:
 482         return
 483     makeflags = os.environ.get('MAKEFLAGS')
 484     if makeflags is None:
 485         return
 486     jobs_set = False
 487     # we need to use shlex.split to cope with the escaping of spaces
 488     # in makeflags
 489     for opt in shlex.split(makeflags):
 490         # options can come either as -x or as x
 491         if opt[0:2] == 'V=':
 492             Options.options.verbose = Logs.verbose = int(opt[2:])
 493             if Logs.verbose > 0:
 494                 Logs.zones = ['runner']
 495             if Logs.verbose > 2:
 496                 Logs.zones = ['*']
 497         elif opt[0].isupper() and opt.find('=') != -1:
 498             # this allows us to set waf options on the make command line
 499             # for example, if you do "make FOO=blah", then we set the
 500             # option 'FOO' in Options.options, to blah. If you look in wafsamba/wscript
 501             # you will see that the command line accessible options have their dest=
 502             # set to uppercase, to allow for passing of options from make in this way
 503             # this is also how "make test TESTS=testpattern" works, and
 504             # "make VERBOSE=1" as well as things like "make SYMBOLCHECK=1"
 505             loc = opt.find('=')
 506             setattr(Options.options, opt[0:loc], opt[loc+1:])
 507         elif opt[0] != '-':
 508             for v in opt:
 509                 if v == 'j':
 510                     jobs_set = True
 511                 elif v == 'k':
 512                     Options.options.keep = True
 513         elif opt == '-j':
 514             jobs_set = True
 515         elif opt == '-k':
 516             Options.options.keep = True
 517     if not jobs_set:
 518         # default to one job
 519         Options.options.jobs = 1
 520
 521 Build.BuildContext.CHECK_MAKEFLAGS = CHECK_MAKEFLAGS
 522
 523 option_groups = {}
 524
 525 def option_group(opt, name):
 526     '''find or create an option group'''
 527     global option_groups
 528     if name in option_groups:
 529         return option_groups[name]
 530     gr = opt.add_option_group(name)
 531     option_groups[name] = gr
 532     return gr
 533 Options.Handler.option_group = option_group
 534
 535
 536 def save_file(filename, contents, create_dir=False):
 537     '''save data to a file'''
 538     if create_dir:
 539         mkdir_p(os.path.dirname(filename))
 540     try:
 541         f = open(filename, 'w')
 542         f.write(contents)
 543         f.close()
 544     except:
 545         return False
 546     return True
 547
 548
 549 def load_file(filename):
 550     '''return contents of a file'''
 551     try:
 552         f = open(filename, 'r')
 553         r = f.read()
 554         f.close()
 555     except:
 556         return None
 557     return r
 558
 559
 560 def reconfigure(ctx):
 561     '''rerun configure if necessary'''
 562     import Configure, samba_wildcard, Scripting
 563     if not os.path.exists(".lock-wscript"):
 564         raise Utils.WafError('configure has not been run')
 565     bld = samba_wildcard.fake_build_environment()
 566     Configure.autoconfig = True
 567     Scripting.check_configured(bld)
 568
 569
 570 def map_shlib_extension(ctx, name, python=False):
 571     '''map a filename with a shared library extension of .so to the real shlib name'''
 572     if name is None:
 573         return None
 574     if name[-1:].isdigit():
 575         # some libraries have specified versions in the wscript rule
 576         return name
 577     (root1, ext1) = os.path.splitext(name)
 578     if python:
 579         (root2, ext2) = os.path.splitext(ctx.env.pyext_PATTERN)
 580     else:
 581         (root2, ext2) = os.path.splitext(ctx.env.shlib_PATTERN)
 582     return root1+ext2
 583 Build.BuildContext.map_shlib_extension = map_shlib_extension
 584
 585 def apply_pattern(filename, pattern):
 586     '''apply a filename pattern to a filename that may have a directory component'''
 587     dirname = os.path.dirname(filename)
 588     if not dirname:
 589         return pattern % filename
 590     basename = os.path.basename(filename)
 591     return os.path.join(dirname, pattern % basename)
 592
 593 def make_libname(ctx, name, nolibprefix=False, version=None, python=False):
 594     """make a library filename
 595          Options:
 596               nolibprefix: don't include the lib prefix
 597               version    : add a version number
 598               python     : if we should use python module name conventions"""
 599
 600     if python:
 601         libname = apply_pattern(name, ctx.env.pyext_PATTERN)
 602     else:
 603         libname = apply_pattern(name, ctx.env.shlib_PATTERN)
 604     if nolibprefix and libname[0:3] == 'lib':
 605         libname = libname[3:]
 606     if version:
 607         if version[0] == '.':
 608             version = version[1:]
 609         (root, ext) = os.path.splitext(libname)
 610         if ext == ".dylib":
 611             # special case - version goes before the prefix
 612             libname = "%s.%s%s" % (root, version, ext)
 613         else:
 614             libname = "%s%s.%s" % (root, ext, version)
 615     return libname
 616 Build.BuildContext.make_libname = make_libname
 617
 618
 619 def get_tgt_list(bld):
 620     '''return a list of build objects for samba'''
 621
 622     targets = LOCAL_CACHE(bld, 'TARGET_TYPE')
 623
 624     # build a list of task generators we are interested in
 625     tgt_list = []
 626     for tgt in targets:
 627         type = targets[tgt]
 628         if not type in ['SUBSYSTEM', 'MODULE', 'BINARY', 'LIBRARY', 'ASN1', 'PYTHON']:
 629             continue
 630         t = bld.name_to_obj(tgt, bld.env)
 631         if t is None:
 632             Logs.error("Target %s of type %s has no task generator" % (tgt, type))
 633             sys.exit(1)
 634         tgt_list.append(t)
 635     return tgt_list
 636
 637 from Constants import WSCRIPT_FILE
 638 def PROCESS_SEPARATE_RULE(self, rule):
 639     ''' cause waf to process additional script based on `rule'.
 640         You should have file named wscript_<stage>_rule in the current directory
 641         where stage is either 'configure' or 'build'
 642     '''
 643     ctxclass = self.__class__.__name__
 644     stage = ''
 645     if ctxclass == 'ConfigurationContext':
 646         stage = 'configure'
 647     elif ctxclass == 'BuildContext':
 648         stage = 'build'
 649     file_path = os.path.join(self.curdir, WSCRIPT_FILE+'_'+stage+'_'+rule)
 650     txt = load_file(file_path)
 651     if txt:
 652         dc = {'ctx': self}
 653         if getattr(self.__class__, 'pre_recurse', None):
 654             dc = self.pre_recurse(txt, file_path, self.curdir)
 655         exec(compile(txt, file_path, 'exec'), dc)
 656         if getattr(self.__class__, 'post_recurse', None):
 657             dc = self.post_recurse(txt, file_path, self.curdir)
 658
 659 Build.BuildContext.PROCESS_SEPARATE_RULE = PROCESS_SEPARATE_RULE
 660 ConfigurationContext.PROCESS_SEPARATE_RULE = PROCESS_SEPARATE_RULE
 661
 662 def AD_DC_BUILD_IS_ENABLED(self):
 663     if self.CONFIG_SET('AD_DC_BUILD_IS_ENABLED'):
 664         return True
 665     return False
 666
 667 Build.BuildContext.AD_DC_BUILD_IS_ENABLED = AD_DC_BUILD_IS_ENABLED