buildtools/wafsamba/wafsamba.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, Task, Utils, cc, TaskGen, fnmatch, re, shutil, Logs, Constants
   5 from Configure import conf
   6 from Logs import debug
   7 from samba_utils import SUBST_VARS_RECURSIVE
   8 TaskGen.task_gen.apply_verif = Utils.nada
   9
  10 # bring in the other samba modules
  11 from samba_optimisation import *
  12 from samba_utils import *
  13 from samba_version import *
  14 from samba_autoconf import *
  15 from samba_patterns import *
  16 from samba_pidl import *
  17 from samba_autoproto import *
  18 from samba_python import *
  19 from samba_perl import *
  20 from samba_deps import *
  21 from samba_bundled import *
  22 from samba_third_party import *
  23 import samba_cross
  24 import samba_install
  25 import samba_conftests
  26 import samba_abi
  27 import samba_headers
  28 import tru64cc
  29 import irixcc
  30 import hpuxcc
  31 import generic_cc
  32 import samba_dist
  33 import samba_wildcard
  34 import stale_files
  35 import symbols
  36 import pkgconfig
  37 import configure_file
  38
  39 # some systems have broken threading in python
  40 if os.environ.get('WAF_NOTHREADS') == '1':
  41     import nothreads
  42
  43 LIB_PATH="shared"
  44
  45 os.environ['PYTHONUNBUFFERED'] = '1'
  46
  47
  48 if Constants.HEXVERSION < 0x105019:
  49     Logs.error('''
  50 Please use the version of waf that comes with Samba, not
  51 a system installed version. See http://wiki.samba.org/index.php/Waf
  52 for details.
  53
  54 Alternatively, please run ./configure and make as usual. That will
  55 call the right version of waf.''')
  56     sys.exit(1)
  57
  58
  59 @conf
  60 def SAMBA_BUILD_ENV(conf):
  61     '''create the samba build environment'''
  62     conf.env.BUILD_DIRECTORY = conf.blddir
  63     mkdir_p(os.path.join(conf.blddir, LIB_PATH))
  64     mkdir_p(os.path.join(conf.blddir, LIB_PATH, "private"))
  65     mkdir_p(os.path.join(conf.blddir, "modules"))
  66     mkdir_p(os.path.join(conf.blddir, 'python/samba/dcerpc'))
  67     # this allows all of the bin/shared and bin/python targets
  68     # to be expressed in terms of build directory paths
  69     mkdir_p(os.path.join(conf.blddir, 'default'))
  70     for (source, target) in [('shared', 'shared'), ('modules', 'modules'), ('python', 'python_modules')]:
  71         link_target = os.path.join(conf.blddir, 'default/' + target)
  72         if not os.path.lexists(link_target):
  73             os.symlink('../' + source, link_target)
  74
  75     # get perl to put the blib files in the build directory
  76     blib_bld = os.path.join(conf.blddir, 'default/pidl/blib')
  77     blib_src = os.path.join(conf.srcdir, 'pidl/blib')
  78     mkdir_p(blib_bld + '/man1')
  79     mkdir_p(blib_bld + '/man3')
  80     if os.path.islink(blib_src):
  81         os.unlink(blib_src)
  82     elif os.path.exists(blib_src):
  83         shutil.rmtree(blib_src)
  84
  85
  86 def ADD_INIT_FUNCTION(bld, subsystem, target, init_function):
  87     '''add an init_function to the list for a subsystem'''
  88     if init_function is None:
  89         return
  90     bld.ASSERT(subsystem is not None, "You must specify a subsystem for init_function '%s'" % init_function)
  91     cache = LOCAL_CACHE(bld, 'INIT_FUNCTIONS')
  92     if not subsystem in cache:
  93         cache[subsystem] = []
  94     cache[subsystem].append( { 'TARGET':target, 'INIT_FUNCTION':init_function } )
  95 Build.BuildContext.ADD_INIT_FUNCTION = ADD_INIT_FUNCTION
  96
  97
  98 def generate_empty_file(task):
  99     task.outputs[0].write('')
 100     return 0
 101
 102 #################################################################
 103 def SAMBA_LIBRARY(bld, libname, source,
 104                   deps='',
 105                   public_deps='',
 106                   includes='',
 107                   public_headers=None,
 108                   public_headers_install=True,
 109                   private_headers=None,
 110                   header_path=None,
 111                   pc_files=None,
 112                   vnum=None,
 113                   soname=None,
 114                   cflags='',
 115                   cflags_end=None,
 116                   ldflags='',
 117                   external_library=False,
 118                   realname=None,
 119                   keep_underscore=False,
 120                   autoproto=None,
 121                   autoproto_extra_source='',
 122                   group='main',
 123                   depends_on='',
 124                   local_include=True,
 125                   global_include=True,
 126                   vars=None,
 127                   subdir=None,
 128                   install_path=None,
 129                   install=True,
 130                   pyembed=False,
 131                   pyext=False,
 132                   target_type='LIBRARY',
 133                   bundled_extension=False,
 134                   bundled_name=None,
 135                   link_name=None,
 136                   abi_directory=None,
 137                   abi_match=None,
 138                   hide_symbols=False,
 139                   manpages=None,
 140                   private_library=False,
 141                   grouping_library=False,
 142                   allow_undefined_symbols=False,
 143                   allow_warnings=False,
 144                   enabled=True):
 145     '''define a Samba library'''
 146
 147     if pyembed and bld.env['IS_EXTRA_PYTHON']:
 148         public_headers = None
 149
 150     if private_library and public_headers:
 151         raise Utils.WafError("private library '%s' must not have public header files" %
 152                              libname)
 153
 154     if LIB_MUST_BE_PRIVATE(bld, libname):
 155         private_library = True
 156
 157     if not enabled:
 158         SET_TARGET_TYPE(bld, libname, 'DISABLED')
 159         return
 160
 161     source = bld.EXPAND_VARIABLES(source, vars=vars)
 162     if subdir:
 163         source = bld.SUBDIR(subdir, source)
 164
 165     # remember empty libraries, so we can strip the dependencies
 166     if ((source == '') or (source == [])):
 167         if deps == '' and public_deps == '':
 168             SET_TARGET_TYPE(bld, libname, 'EMPTY')
 169             return
 170         empty_c = libname + '.empty.c'
 171         bld.SAMBA_GENERATOR('%s_empty_c' % libname,
 172                             rule=generate_empty_file,
 173                             target=empty_c)
 174         source=empty_c
 175
 176     if BUILTIN_LIBRARY(bld, libname):
 177         obj_target = libname
 178     else:
 179         obj_target = libname + '.objlist'
 180
 181     if group == 'libraries':
 182         subsystem_group = 'main'
 183     else:
 184         subsystem_group = group
 185
 186     # first create a target for building the object files for this library
 187     # by separating in this way, we avoid recompiling the C files
 188     # separately for the install library and the build library
 189     bld.SAMBA_SUBSYSTEM(obj_target,
 190                         source         = source,
 191                         deps           = deps,
 192                         public_deps    = public_deps,
 193                         includes       = includes,
 194                         public_headers = public_headers,
 195                         public_headers_install = public_headers_install,
 196                         private_headers= private_headers,
 197                         header_path    = header_path,
 198                         cflags         = cflags,
 199                         cflags_end     = cflags_end,
 200                         group          = subsystem_group,
 201                         autoproto      = autoproto,
 202                         autoproto_extra_source=autoproto_extra_source,
 203                         depends_on     = depends_on,
 204                         hide_symbols   = hide_symbols,
 205                         allow_warnings = allow_warnings,
 206                         pyembed        = pyembed,
 207                         pyext          = pyext,
 208                         local_include  = local_include,
 209                         global_include = global_include)
 210
 211     if BUILTIN_LIBRARY(bld, libname):
 212         return
 213
 214     if not SET_TARGET_TYPE(bld, libname, target_type):
 215         return
 216
 217     # the library itself will depend on that object target
 218     deps += ' ' + public_deps
 219     deps = TO_LIST(deps)
 220     deps.append(obj_target)
 221
 222     realname = bld.map_shlib_extension(realname, python=(target_type=='PYTHON'))
 223     link_name = bld.map_shlib_extension(link_name, python=(target_type=='PYTHON'))
 224
 225     # we don't want any public libraries without version numbers
 226     if (not private_library and target_type != 'PYTHON' and not realname):
 227         if vnum is None and soname is None:
 228             raise Utils.WafError("public library '%s' must have a vnum" %
 229                     libname)
 230         if pc_files is None:
 231             raise Utils.WafError("public library '%s' must have pkg-config file" %
 232                        libname)
 233         if public_headers is None and not bld.env['IS_EXTRA_PYTHON']:
 234             raise Utils.WafError("public library '%s' must have header files" %
 235                        libname)
 236
 237     if bundled_name is not None:
 238         pass
 239     elif target_type == 'PYTHON' or realname or not private_library:
 240         if keep_underscore:
 241             bundled_name = libname
 242         else:
 243             bundled_name = libname.replace('_', '-')
 244     else:
 245         assert (private_library == True and realname is None)
 246         if abi_directory or vnum or soname:
 247             bundled_extension=True
 248         bundled_name = PRIVATE_NAME(bld, libname.replace('_', '-'),
 249                                     bundled_extension, private_library)
 250
 251     ldflags = TO_LIST(ldflags)
 252     if bld.env['ENABLE_RELRO'] is True:
 253         ldflags.extend(TO_LIST('-Wl,-z,relro,-z,now'))
 254
 255     features = 'c cshlib symlink_lib install_lib'
 256     if pyext:
 257         features += ' pyext'
 258     if pyembed:
 259         features += ' pyembed'
 260
 261     if abi_directory:
 262         features += ' abi_check'
 263
 264     if pyembed and bld.env['PYTHON_SO_ABI_FLAG']:
 265         # For ABI checking, we don't care about the exact Python version.
 266         # Replace the Python ABI tag (e.g. ".cpython-35m") by a generic ".py3"
 267         abi_flag = bld.env['PYTHON_SO_ABI_FLAG']
 268         replacement = '.py%s' % bld.env['PYTHON_VERSION'].split('.')[0]
 269         version_libname = libname.replace(abi_flag, replacement)
 270     else:
 271         version_libname = libname
 272
 273     vscript = None
 274     if bld.env.HAVE_LD_VERSION_SCRIPT:
 275         if private_library:
 276             version = "%s_%s" % (Utils.g_module.APPNAME, Utils.g_module.VERSION)
 277         elif vnum:
 278             version = "%s_%s" % (libname, vnum)
 279         else:
 280             version = None
 281         if version:
 282             vscript = "%s.vscript" % libname
 283             bld.ABI_VSCRIPT(version_libname, abi_directory, version, vscript,
 284                             abi_match)
 285             fullname = apply_pattern(bundled_name, bld.env.shlib_PATTERN)
 286             fullpath = bld.path.find_or_declare(fullname)
 287             vscriptpath = bld.path.find_or_declare(vscript)
 288             if not fullpath:
 289                 raise Utils.WafError("unable to find fullpath for %s" % fullname)
 290             if not vscriptpath:
 291                 raise Utils.WafError("unable to find vscript path for %s" % vscript)
 292             bld.add_manual_dependency(fullpath, vscriptpath)
 293             if bld.is_install:
 294                 # also make the .inst file depend on the vscript
 295                 instname = apply_pattern(bundled_name + '.inst', bld.env.shlib_PATTERN)
 296                 bld.add_manual_dependency(bld.path.find_or_declare(instname), bld.path.find_or_declare(vscript))
 297             vscript = os.path.join(bld.path.abspath(bld.env), vscript)
 298
 299     bld.SET_BUILD_GROUP(group)
 300     t = bld(
 301         features        = features,
 302         source          = [],
 303         target          = bundled_name,
 304         depends_on      = depends_on,
 305         samba_ldflags   = ldflags,
 306         samba_deps      = deps,
 307         samba_includes  = includes,
 308         version_script  = vscript,
 309         version_libname = version_libname,
 310         local_include   = local_include,
 311         global_include  = global_include,
 312         vnum            = vnum,
 313         soname          = soname,
 314         install_path    = None,
 315         samba_inst_path = install_path,
 316         name            = libname,
 317         samba_realname  = realname,
 318         samba_install   = install,
 319         abi_directory   = "%s/%s" % (bld.path.abspath(), abi_directory),
 320         abi_match       = abi_match,
 321         private_library = private_library,
 322         grouping_library=grouping_library,
 323         allow_undefined_symbols=allow_undefined_symbols
 324         )
 325
 326     if realname and not link_name:
 327         link_name = 'shared/%s' % realname
 328
 329     if link_name:
 330         t.link_name = link_name
 331
 332     if pc_files is not None and not private_library:
 333         if pyembed and bld.env['IS_EXTRA_PYTHON']:
 334             bld.PKG_CONFIG_FILES(pc_files, vnum=vnum, extra_name=bld.env['PYTHON_SO_ABI_FLAG'])
 335         else:
 336             bld.PKG_CONFIG_FILES(pc_files, vnum=vnum)
 337
 338     if (manpages is not None and 'XSLTPROC_MANPAGES' in bld.env and
 339         bld.env['XSLTPROC_MANPAGES']):
 340         bld.MANPAGES(manpages, install)
 341
 342
 343 Build.BuildContext.SAMBA_LIBRARY = SAMBA_LIBRARY
 344
 345
 346 #################################################################
 347 def SAMBA_BINARY(bld, binname, source,
 348                  deps='',
 349                  includes='',
 350                  public_headers=None,
 351                  private_headers=None,
 352                  header_path=None,
 353                  modules=None,
 354                  ldflags=None,
 355                  cflags='',
 356                  autoproto=None,
 357                  use_hostcc=False,
 358                  use_global_deps=True,
 359                  compiler=None,
 360                  group='main',
 361                  manpages=None,
 362                  local_include=True,
 363                  global_include=True,
 364                  subsystem_name=None,
 365                  pyembed=False,
 366                  vars=None,
 367                  subdir=None,
 368                  install=True,
 369                  install_path=None,
 370                  enabled=True):
 371     '''define a Samba binary'''
 372
 373     if not enabled:
 374         SET_TARGET_TYPE(bld, binname, 'DISABLED')
 375         return
 376
 377     if not SET_TARGET_TYPE(bld, binname, 'BINARY'):
 378         return
 379
 380     features = 'c cprogram symlink_bin install_bin'
 381     if pyembed:
 382         features += ' pyembed'
 383
 384     obj_target = binname + '.objlist'
 385
 386     source = bld.EXPAND_VARIABLES(source, vars=vars)
 387     if subdir:
 388         source = bld.SUBDIR(subdir, source)
 389     source = unique_list(TO_LIST(source))
 390
 391     if group == 'binaries':
 392         subsystem_group = 'main'
 393     else:
 394         subsystem_group = group
 395
 396     # only specify PIE flags for binaries
 397     pie_cflags = cflags
 398     pie_ldflags = TO_LIST(ldflags)
 399     if bld.env['ENABLE_PIE'] is True:
 400         pie_cflags += ' -fPIE'
 401         pie_ldflags.extend(TO_LIST('-pie'))
 402     if bld.env['ENABLE_RELRO'] is True:
 403         pie_ldflags.extend(TO_LIST('-Wl,-z,relro,-z,now'))
 404
 405     # first create a target for building the object files for this binary
 406     # by separating in this way, we avoid recompiling the C files
 407     # separately for the install binary and the build binary
 408     bld.SAMBA_SUBSYSTEM(obj_target,
 409                         source         = source,
 410                         deps           = deps,
 411                         includes       = includes,
 412                         cflags         = pie_cflags,
 413                         group          = subsystem_group,
 414                         autoproto      = autoproto,
 415                         subsystem_name = subsystem_name,
 416                         local_include  = local_include,
 417                         global_include = global_include,
 418                         use_hostcc     = use_hostcc,
 419                         pyext          = pyembed,
 420                         use_global_deps= use_global_deps)
 421
 422     bld.SET_BUILD_GROUP(group)
 423
 424     # the binary itself will depend on that object target
 425     deps = TO_LIST(deps)
 426     deps.append(obj_target)
 427
 428     t = bld(
 429         features       = features,
 430         source         = [],
 431         target         = binname,
 432         samba_deps     = deps,
 433         samba_includes = includes,
 434         local_include  = local_include,
 435         global_include = global_include,
 436         samba_modules  = modules,
 437         top            = True,
 438         samba_subsystem= subsystem_name,
 439         install_path   = None,
 440         samba_inst_path= install_path,
 441         samba_install  = install,
 442         samba_ldflags  = pie_ldflags
 443         )
 444
 445     if manpages is not None and 'XSLTPROC_MANPAGES' in bld.env and bld.env['XSLTPROC_MANPAGES']:
 446         bld.MANPAGES(manpages, install)
 447
 448 Build.BuildContext.SAMBA_BINARY = SAMBA_BINARY
 449
 450
 451 #################################################################
 452 def SAMBA_MODULE(bld, modname, source,
 453                  deps='',
 454                  includes='',
 455                  subsystem=None,
 456                  init_function=None,
 457                  module_init_name='samba_init_module',
 458                  autoproto=None,
 459                  autoproto_extra_source='',
 460                  cflags='',
 461                  internal_module=True,
 462                  local_include=True,
 463                  global_include=True,
 464                  vars=None,
 465                  subdir=None,
 466                  enabled=True,
 467                  pyembed=False,
 468                  manpages=None,
 469                  allow_undefined_symbols=False,
 470                  allow_warnings=False,
 471                  install=True
 472                  ):
 473     '''define a Samba module.'''
 474
 475     bld.ASSERT(subsystem, "You must specify a subsystem for SAMBA_MODULE(%s)" % modname)
 476
 477     source = bld.EXPAND_VARIABLES(source, vars=vars)
 478     if subdir:
 479         source = bld.SUBDIR(subdir, source)
 480
 481     if internal_module or BUILTIN_LIBRARY(bld, modname):
 482         # Do not create modules for disabled subsystems
 483         if GET_TARGET_TYPE(bld, subsystem) == 'DISABLED':
 484             return
 485         bld.SAMBA_SUBSYSTEM(modname, source,
 486                     deps=deps,
 487                     includes=includes,
 488                     autoproto=autoproto,
 489                     autoproto_extra_source=autoproto_extra_source,
 490                     cflags=cflags,
 491                     local_include=local_include,
 492                     global_include=global_include,
 493                     allow_warnings=allow_warnings,
 494                     enabled=enabled)
 495
 496         bld.ADD_INIT_FUNCTION(subsystem, modname, init_function)
 497         return
 498
 499     if not enabled:
 500         SET_TARGET_TYPE(bld, modname, 'DISABLED')
 501         return
 502
 503     # Do not create modules for disabled subsystems
 504     if GET_TARGET_TYPE(bld, subsystem) == 'DISABLED':
 505         return
 506
 507     realname = modname
 508     deps += ' ' + subsystem
 509     while realname.startswith("lib"+subsystem+"_"):
 510         realname = realname[len("lib"+subsystem+"_"):]
 511     while realname.startswith(subsystem+"_"):
 512         realname = realname[len(subsystem+"_"):]
 513
 514     build_name = "%s_module_%s" % (subsystem, realname)
 515
 516     realname = bld.make_libname(realname)
 517     while realname.startswith("lib"):
 518         realname = realname[len("lib"):]
 519
 520     build_link_name = "modules/%s/%s" % (subsystem, realname)
 521
 522     if init_function:
 523         cflags += " -D%s=%s" % (init_function, module_init_name)
 524
 525     bld.SAMBA_LIBRARY(modname,
 526                       source,
 527                       deps=deps,
 528                       includes=includes,
 529                       cflags=cflags,
 530                       realname = realname,
 531                       autoproto = autoproto,
 532                       local_include=local_include,
 533                       global_include=global_include,
 534                       vars=vars,
 535                       bundled_name=build_name,
 536                       link_name=build_link_name,
 537                       install_path="${MODULESDIR}/%s" % subsystem,
 538                       pyembed=pyembed,
 539                       manpages=manpages,
 540                       allow_undefined_symbols=allow_undefined_symbols,
 541                       allow_warnings=allow_warnings,
 542                       install=install
 543                       )
 544
 545
 546 Build.BuildContext.SAMBA_MODULE = SAMBA_MODULE
 547
 548
 549 #################################################################
 550 def SAMBA_SUBSYSTEM(bld, modname, source,
 551                     deps='',
 552                     public_deps='',
 553                     includes='',
 554                     public_headers=None,
 555                     public_headers_install=True,
 556                     private_headers=None,
 557                     header_path=None,
 558                     cflags='',
 559                     cflags_end=None,
 560                     group='main',
 561                     init_function_sentinel=None,
 562                     autoproto=None,
 563                     autoproto_extra_source='',
 564                     depends_on='',
 565                     local_include=True,
 566                     local_include_first=True,
 567                     global_include=True,
 568                     subsystem_name=None,
 569                     enabled=True,
 570                     use_hostcc=False,
 571                     use_global_deps=True,
 572                     vars=None,
 573                     subdir=None,
 574                     hide_symbols=False,
 575                     allow_warnings=False,
 576                     pyext=False,
 577                     pyembed=False):
 578     '''define a Samba subsystem'''
 579
 580     if not enabled:
 581         SET_TARGET_TYPE(bld, modname, 'DISABLED')
 582         return
 583
 584     # remember empty subsystems, so we can strip the dependencies
 585     if ((source == '') or (source == [])):
 586         if deps == '' and public_deps == '':
 587             SET_TARGET_TYPE(bld, modname, 'EMPTY')
 588             return
 589         empty_c = modname + '.empty.c'
 590         bld.SAMBA_GENERATOR('%s_empty_c' % modname,
 591                             rule=generate_empty_file,
 592                             target=empty_c)
 593         source=empty_c
 594
 595     if not SET_TARGET_TYPE(bld, modname, 'SUBSYSTEM'):
 596         return
 597
 598     source = bld.EXPAND_VARIABLES(source, vars=vars)
 599     if subdir:
 600         source = bld.SUBDIR(subdir, source)
 601     source = unique_list(TO_LIST(source))
 602
 603     deps += ' ' + public_deps
 604
 605     bld.SET_BUILD_GROUP(group)
 606
 607     features = 'c'
 608     if pyext:
 609         features += ' pyext'
 610     if pyembed:
 611         features += ' pyembed'
 612
 613     t = bld(
 614         features       = features,
 615         source         = source,
 616         target         = modname,
 617         samba_cflags   = CURRENT_CFLAGS(bld, modname, cflags,
 618                                         allow_warnings=allow_warnings,
 619                                         hide_symbols=hide_symbols),
 620         depends_on     = depends_on,
 621         samba_deps     = TO_LIST(deps),
 622         samba_includes = includes,
 623         local_include  = local_include,
 624         local_include_first  = local_include_first,
 625         global_include = global_include,
 626         samba_subsystem= subsystem_name,
 627         samba_use_hostcc = use_hostcc,
 628         samba_use_global_deps = use_global_deps,
 629         )
 630
 631     if cflags_end is not None:
 632         t.samba_cflags.extend(TO_LIST(cflags_end))
 633
 634     if autoproto is not None:
 635         bld.SAMBA_AUTOPROTO(autoproto, source + TO_LIST(autoproto_extra_source))
 636     if public_headers is not None:
 637         bld.PUBLIC_HEADERS(public_headers, header_path=header_path,
 638                            public_headers_install=public_headers_install)
 639     return t
 640
 641
 642 Build.BuildContext.SAMBA_SUBSYSTEM = SAMBA_SUBSYSTEM
 643
 644
 645 def SAMBA_GENERATOR(bld, name, rule, source='', target='',
 646                     group='generators', enabled=True,
 647                     public_headers=None,
 648                     public_headers_install=True,
 649                     private_headers=None,
 650                     header_path=None,
 651                     vars=None,
 652                     dep_vars=[],
 653                     always=False):
 654     '''A generic source generator target'''
 655
 656     if not SET_TARGET_TYPE(bld, name, 'GENERATOR'):
 657         return
 658
 659     if not enabled:
 660         return
 661
 662     dep_vars.append('ruledeps')
 663     dep_vars.append('SAMBA_GENERATOR_VARS')
 664
 665     bld.SET_BUILD_GROUP(group)
 666     t = bld(
 667         rule=rule,
 668         source=bld.EXPAND_VARIABLES(source, vars=vars),
 669         target=target,
 670         shell=isinstance(rule, str),
 671         update_outputs=True,
 672         before='cc',
 673         ext_out='.c',
 674         samba_type='GENERATOR',
 675         dep_vars = dep_vars,
 676         name=name)
 677
 678     if vars is None:
 679         vars = {}
 680     t.env.SAMBA_GENERATOR_VARS = vars
 681
 682     if always:
 683         t.always = True
 684
 685     if public_headers is not None:
 686         bld.PUBLIC_HEADERS(public_headers, header_path=header_path,
 687                            public_headers_install=public_headers_install)
 688     return t
 689 Build.BuildContext.SAMBA_GENERATOR = SAMBA_GENERATOR
 690
 691
 692
 693 @Utils.run_once
 694 def SETUP_BUILD_GROUPS(bld):
 695     '''setup build groups used to ensure that the different build
 696     phases happen consecutively'''
 697     bld.p_ln = bld.srcnode # we do want to see all targets!
 698     bld.env['USING_BUILD_GROUPS'] = True
 699     bld.add_group('setup')
 700     bld.add_group('build_compiler_source')
 701     bld.add_group('vscripts')
 702     bld.add_group('base_libraries')
 703     bld.add_group('generators')
 704     bld.add_group('compiler_prototypes')
 705     bld.add_group('compiler_libraries')
 706     bld.add_group('build_compilers')
 707     bld.add_group('build_source')
 708     bld.add_group('prototypes')
 709     bld.add_group('headers')
 710     bld.add_group('main')
 711     bld.add_group('symbolcheck')
 712     bld.add_group('syslibcheck')
 713     bld.add_group('final')
 714 Build.BuildContext.SETUP_BUILD_GROUPS = SETUP_BUILD_GROUPS
 715
 716
 717 def SET_BUILD_GROUP(bld, group):
 718     '''set the current build group'''
 719     if not 'USING_BUILD_GROUPS' in bld.env:
 720         return
 721     bld.set_group(group)
 722 Build.BuildContext.SET_BUILD_GROUP = SET_BUILD_GROUP
 723
 724
 725
 726 @conf
 727 def ENABLE_TIMESTAMP_DEPENDENCIES(conf):
 728     """use timestamps instead of file contents for deps
 729     this currently doesn't work"""
 730     def h_file(filename):
 731         import stat
 732         st = os.stat(filename)
 733         if stat.S_ISDIR(st[stat.ST_MODE]): raise IOError('not a file')
 734         m = Utils.md5()
 735         m.update(str(st.st_mtime))
 736         m.update(str(st.st_size))
 737         m.update(filename)
 738         return m.digest()
 739     Utils.h_file = h_file
 740
 741
 742 def SAMBA_SCRIPT(bld, name, pattern, installdir, installname=None):
 743     '''used to copy scripts from the source tree into the build directory
 744        for use by selftest'''
 745
 746     source = bld.path.ant_glob(pattern, flat=True)
 747
 748     bld.SET_BUILD_GROUP('build_source')
 749     for s in TO_LIST(source):
 750         iname = s
 751         if installname is not None:
 752             iname = installname
 753         target = os.path.join(installdir, iname)
 754         tgtdir = os.path.dirname(os.path.join(bld.srcnode.abspath(bld.env), '..', target))
 755         mkdir_p(tgtdir)
 756         link_src = os.path.normpath(os.path.join(bld.curdir, s))
 757         link_dst = os.path.join(tgtdir, os.path.basename(iname))
 758         if os.path.islink(link_dst) and os.readlink(link_dst) == link_src:
 759             continue
 760         if os.path.exists(link_dst):
 761             os.unlink(link_dst)
 762         Logs.info("symlink: %s -> %s/%s" % (s, installdir, iname))
 763         os.symlink(link_src, link_dst)
 764 Build.BuildContext.SAMBA_SCRIPT = SAMBA_SCRIPT
 765
 766
 767 def copy_and_fix_python_path(task):
 768     pattern='sys.path.insert(0, "bin/python")'
 769     if task.env["PYTHONARCHDIR"] in sys.path and task.env["PYTHONDIR"] in sys.path:
 770         replacement = ""
 771     elif task.env["PYTHONARCHDIR"] == task.env["PYTHONDIR"]:
 772         replacement="""sys.path.insert(0, "%s")""" % task.env["PYTHONDIR"]
 773     else:
 774         replacement="""sys.path.insert(0, "%s")
 775 sys.path.insert(1, "%s")""" % (task.env["PYTHONARCHDIR"], task.env["PYTHONDIR"])
 776
 777     if task.env["PYTHON"][0] == "/":
 778         replacement_shebang = "#!%s\n" % task.env["PYTHON"]
 779     else:
 780         replacement_shebang = "#!/usr/bin/env %s\n" % task.env["PYTHON"]
 781
 782     installed_location=task.outputs[0].bldpath(task.env)
 783     source_file = open(task.inputs[0].srcpath(task.env))
 784     installed_file = open(installed_location, 'w')
 785     lineno = 0
 786     for line in source_file:
 787         newline = line
 788         if (lineno == 0 and task.env["PYTHON_SPECIFIED"] is True and
 789                 line[:2] == "#!"):
 790             newline = replacement_shebang
 791         elif pattern in line:
 792             newline = line.replace(pattern, replacement)
 793         installed_file.write(newline)
 794         lineno = lineno + 1
 795     installed_file.close()
 796     os.chmod(installed_location, 0755)
 797     return 0
 798
 799 def copy_and_fix_perl_path(task):
 800     pattern='use lib "$RealBin/lib";'
 801
 802     replacement = ""
 803     if not task.env["PERL_LIB_INSTALL_DIR"] in task.env["PERL_INC"]:
 804          replacement = 'use lib "%s";' % task.env["PERL_LIB_INSTALL_DIR"]
 805
 806     if task.env["PERL"][0] == "/":
 807         replacement_shebang = "#!%s\n" % task.env["PERL"]
 808     else:
 809         replacement_shebang = "#!/usr/bin/env %s\n" % task.env["PERL"]
 810
 811     installed_location=task.outputs[0].bldpath(task.env)
 812     source_file = open(task.inputs[0].srcpath(task.env))
 813     installed_file = open(installed_location, 'w')
 814     lineno = 0
 815     for line in source_file:
 816         newline = line
 817         if lineno == 0 and task.env["PERL_SPECIFIED"] == True and line[:2] == "#!":
 818             newline = replacement_shebang
 819         elif pattern in line:
 820             newline = line.replace(pattern, replacement)
 821         installed_file.write(newline)
 822         lineno = lineno + 1
 823     installed_file.close()
 824     os.chmod(installed_location, 0755)
 825     return 0
 826
 827
 828 def install_file(bld, destdir, file, chmod=MODE_644, flat=False,
 829                  python_fixup=False, perl_fixup=False,
 830                  destname=None, base_name=None):
 831     '''install a file'''
 832     destdir = bld.EXPAND_VARIABLES(destdir)
 833     if not destname:
 834         destname = file
 835         if flat:
 836             destname = os.path.basename(destname)
 837     dest = os.path.join(destdir, destname)
 838     if python_fixup:
 839         # fix the path python will use to find Samba modules
 840         inst_file = file + '.inst'
 841         bld.SAMBA_GENERATOR('python_%s' % destname,
 842                             rule=copy_and_fix_python_path,
 843                             dep_vars=["PYTHON","PYTHON_SPECIFIED","PYTHONDIR","PYTHONARCHDIR"],
 844                             source=file,
 845                             target=inst_file)
 846         file = inst_file
 847     if perl_fixup:
 848         # fix the path perl will use to find Samba modules
 849         inst_file = file + '.inst'
 850         bld.SAMBA_GENERATOR('perl_%s' % destname,
 851                             rule=copy_and_fix_perl_path,
 852                             dep_vars=["PERL","PERL_SPECIFIED","PERL_LIB_INSTALL_DIR"],
 853                             source=file,
 854                             target=inst_file)
 855         file = inst_file
 856     if base_name:
 857         file = os.path.join(base_name, file)
 858     bld.install_as(dest, file, chmod=chmod)
 859
 860
 861 def INSTALL_FILES(bld, destdir, files, chmod=MODE_644, flat=False,
 862                   python_fixup=False, perl_fixup=False,
 863                   destname=None, base_name=None):
 864     '''install a set of files'''
 865     for f in TO_LIST(files):
 866         install_file(bld, destdir, f, chmod=chmod, flat=flat,
 867                      python_fixup=python_fixup, perl_fixup=perl_fixup,
 868                      destname=destname, base_name=base_name)
 869 Build.BuildContext.INSTALL_FILES = INSTALL_FILES
 870
 871
 872 def INSTALL_WILDCARD(bld, destdir, pattern, chmod=MODE_644, flat=False,
 873                      python_fixup=False, exclude=None, trim_path=None):
 874     '''install a set of files matching a wildcard pattern'''
 875     files=TO_LIST(bld.path.ant_glob(pattern, flat=True))
 876     if trim_path:
 877         files2 = []
 878         for f in files:
 879             files2.append(os_path_relpath(f, trim_path))
 880         files = files2
 881
 882     if exclude:
 883         for f in files[:]:
 884             if fnmatch.fnmatch(f, exclude):
 885                 files.remove(f)
 886     INSTALL_FILES(bld, destdir, files, chmod=chmod, flat=flat,
 887                   python_fixup=python_fixup, base_name=trim_path)
 888 Build.BuildContext.INSTALL_WILDCARD = INSTALL_WILDCARD
 889
 890 def INSTALL_DIR(bld, path, chmod=0o755, env=None):
 891     """Install a directory if it doesn't exist, always set permissions."""
 892
 893     if not path:
 894         return []
 895
 896     destpath = bld.get_install_path(path, env)
 897
 898     if bld.is_install > 0:
 899         if not os.path.isdir(destpath):
 900             try:
 901                 os.makedirs(destpath)
 902                 os.chmod(destpath, chmod)
 903             except OSError as e:
 904                 if not os.path.isdir(destpath):
 905                     raise Utils.WafError("Cannot create the folder '%s' (error: %s)" % (path, e))
 906 Build.BuildContext.INSTALL_DIR = INSTALL_DIR
 907
 908 def INSTALL_DIRS(bld, destdir, dirs, chmod=0o755, env=None):
 909     '''install a set of directories'''
 910     destdir = bld.EXPAND_VARIABLES(destdir)
 911     dirs = bld.EXPAND_VARIABLES(dirs)
 912     for d in TO_LIST(dirs):
 913         INSTALL_DIR(bld, os.path.join(destdir, d), chmod, env)
 914 Build.BuildContext.INSTALL_DIRS = INSTALL_DIRS
 915
 916
 917 def MANPAGES(bld, manpages, install):
 918     '''build and install manual pages'''
 919     bld.env.MAN_XSL = 'http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl'
 920     for m in manpages.split():
 921         source = m + '.xml'
 922         bld.SAMBA_GENERATOR(m,
 923                             source=source,
 924                             target=m,
 925                             group='final',
 926                             rule='${XSLTPROC} --xinclude -o ${TGT} --nonet ${MAN_XSL} ${SRC}'
 927                             )
 928         if install:
 929             bld.INSTALL_FILES('${MANDIR}/man%s' % m[-1], m, flat=True)
 930 Build.BuildContext.MANPAGES = MANPAGES
 931
 932 def SAMBAMANPAGES(bld, manpages, extra_source=None):
 933     '''build and install manual pages'''
 934     bld.env.SAMBA_EXPAND_XSL = bld.srcnode.abspath() + '/docs-xml/xslt/expand-sambadoc.xsl'
 935     bld.env.SAMBA_MAN_XSL = bld.srcnode.abspath() + '/docs-xml/xslt/man.xsl'
 936     bld.env.SAMBA_CATALOG = bld.srcnode.abspath() + '/bin/default/docs-xml/build/catalog.xml'
 937     bld.env.SAMBA_CATALOGS = 'file:///etc/xml/catalog file:///usr/local/share/xml/catalog file://' + bld.env.SAMBA_CATALOG
 938
 939     for m in manpages.split():
 940         source = m + '.xml'
 941         if extra_source is not None:
 942             source = [source, extra_source]
 943         bld.SAMBA_GENERATOR(m,
 944                             source=source,
 945                             target=m,
 946                             group='final',
 947                             dep_vars=['SAMBA_MAN_XSL', 'SAMBA_EXPAND_XSL', 'SAMBA_CATALOG'],
 948                             rule='''XML_CATALOG_FILES="${SAMBA_CATALOGS}"
 949                                     export XML_CATALOG_FILES
 950                                     ${XSLTPROC} --xinclude --stringparam noreference 0 -o ${TGT}.xml --nonet ${SAMBA_EXPAND_XSL} ${SRC[0].abspath(env)}
 951                                     ${XSLTPROC} --nonet -o ${TGT} ${SAMBA_MAN_XSL} ${TGT}.xml'''
 952                             )
 953         bld.INSTALL_FILES('${MANDIR}/man%s' % m[-1], m, flat=True)
 954 Build.BuildContext.SAMBAMANPAGES = SAMBAMANPAGES
 955
 956 #############################################################
 957 # give a nicer display when building different types of files
 958 def progress_display(self, msg, fname):
 959     col1 = Logs.colors(self.color)
 960     col2 = Logs.colors.NORMAL
 961     total = self.position[1]
 962     n = len(str(total))
 963     fs = '[%%%dd/%%%dd] %s %%s%%s%%s\n' % (n, n, msg)
 964     return fs % (self.position[0], self.position[1], col1, fname, col2)
 965
 966 def link_display(self):
 967     if Options.options.progress_bar != 0:
 968         return Task.Task.old_display(self)
 969     fname = self.outputs[0].bldpath(self.env)
 970     return progress_display(self, 'Linking', fname)
 971 Task.TaskBase.classes['cc_link'].display = link_display
 972
 973 def samba_display(self):
 974     if Options.options.progress_bar != 0:
 975         return Task.Task.old_display(self)
 976
 977     targets    = LOCAL_CACHE(self, 'TARGET_TYPE')
 978     if self.name in targets:
 979         target_type = targets[self.name]
 980         type_map = { 'GENERATOR' : 'Generating',
 981                      'PROTOTYPE' : 'Generating'
 982                      }
 983         if target_type in type_map:
 984             return progress_display(self, type_map[target_type], self.name)
 985
 986     if len(self.inputs) == 0:
 987         return Task.Task.old_display(self)
 988
 989     fname = self.inputs[0].bldpath(self.env)
 990     if fname[0:3] == '../':
 991         fname = fname[3:]
 992     ext_loc = fname.rfind('.')
 993     if ext_loc == -1:
 994         return Task.Task.old_display(self)
 995     ext = fname[ext_loc:]
 996
 997     ext_map = { '.idl' : 'Compiling IDL',
 998                 '.et'  : 'Compiling ERRTABLE',
 999                 '.asn1': 'Compiling ASN1',
1000                 '.c'   : 'Compiling' }
1001     if ext in ext_map:
1002         return progress_display(self, ext_map[ext], fname)
1003     return Task.Task.old_display(self)
1004
1005 Task.TaskBase.classes['Task'].old_display = Task.TaskBase.classes['Task'].display
1006 Task.TaskBase.classes['Task'].display = samba_display
1007
1008
1009 @after('apply_link')
1010 @feature('cshlib')
1011 def apply_bundle_remove_dynamiclib_patch(self):
1012     if self.env['MACBUNDLE'] or getattr(self,'mac_bundle',False):
1013         if not getattr(self,'vnum',None):
1014             try:
1015                 self.env['LINKFLAGS'].remove('-dynamiclib')
1016                 self.env['LINKFLAGS'].remove('-single_module')
1017             except ValueError:
1018                 pass