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, Options, Task, Utils, cc, TaskGen
   5 from Configure import conf
   6 from Logs import debug
   7
   8 # bring in the other samba modules
   9 from samba_optimisation import *
  10 from samba_utils import *
  11 from samba_autoconf import *
  12 from samba_patterns import *
  13 from samba_pidl import *
  14 from samba_errtable import *
  15 from samba_asn1 import *
  16 from samba_autoproto import *
  17 from samba_python import *
  18 from samba_deps import *
  19
  20 LIB_PATH="shared"
  21
  22
  23
  24 #################################################################
  25 # create the samba build environment
  26 @conf
  27 def SAMBA_BUILD_ENV(conf):
  28     conf.env['BUILD_DIRECTORY'] = conf.blddir
  29     mkdir_p(os.path.join(conf.blddir, LIB_PATH))
  30     mkdir_p(os.path.join(conf.blddir, 'python/samba/dcerpc'))
  31     # this allows all of the bin/shared and bin/python targets
  32     # to be expressed in terms of build directory paths
  33     for p in ['python','shared']:
  34         link_target = os.path.join(conf.blddir, 'default/' + p)
  35         if not os.path.lexists(link_target):
  36             os.symlink('../' + p, link_target)
  37
  38
  39
  40 ################################################################
  41 # add an init_function to the list for a subsystem
  42 def ADD_INIT_FUNCTION(bld, subsystem, target, init_function):
  43     if init_function is None:
  44         return
  45     bld.ASSERT(subsystem is not None, "You must specify a subsystem for init_function '%s'" % init_function)
  46     cache = LOCAL_CACHE(bld, 'INIT_FUNCTIONS')
  47     if not subsystem in cache:
  48         cache[subsystem] = []
  49     cache[subsystem].append( { 'TARGET':target, 'INIT_FUNCTION':init_function } )
  50 Build.BuildContext.ADD_INIT_FUNCTION = ADD_INIT_FUNCTION
  51
  52
  53 #################################################################
  54 # define a Samba library
  55 def SAMBA_LIBRARY(bld, libname, source,
  56                   deps='',
  57                   public_deps='',
  58                   includes='',
  59                   public_headers=None,
  60                   vnum=None,
  61                   cflags='',
  62                   external_library=False,
  63                   realname=None,
  64                   autoproto=None,
  65                   group='main',
  66                   depends_on='',
  67                   local_include=True,
  68                   install_path=None,
  69                   install=True,
  70                   enabled=True):
  71
  72     if not enabled:
  73         SET_TARGET_TYPE(bld, libname, 'DISABLED')
  74         return
  75
  76     # remember empty libraries, so we can strip the dependencies
  77     if (source == '') or (source == []):
  78         SET_TARGET_TYPE(bld, libname, 'EMPTY')
  79         return
  80
  81     if not SET_TARGET_TYPE(bld, libname, 'LIBRARY'):
  82         return
  83
  84     obj_target = libname + '.objlist'
  85
  86     # first create a target for building the object files for this library
  87     # by separating in this way, we avoid recompiling the C files
  88     # separately for the install library and the build library
  89     bld.SAMBA_SUBSYSTEM(obj_target,
  90                         source         = source,
  91                         deps           = deps,
  92                         public_deps    = public_deps,
  93                         includes       = includes,
  94                         public_headers = public_headers,
  95                         cflags         = cflags,
  96                         group          = group,
  97                         autoproto      = autoproto,
  98                         depends_on     = depends_on,
  99                         local_include  = local_include)
 100
 101     # the library itself will depend on that object target
 102     deps += ' ' + public_deps
 103     deps = TO_LIST(deps)
 104     deps.append(obj_target)
 105
 106     bld.SET_BUILD_GROUP(group)
 107     t = bld(
 108         features        = 'cc cshlib symlink_lib',
 109         source          = [],
 110         target          = libname,
 111         samba_cflags    = CURRENT_CFLAGS(bld, libname, cflags),
 112         depends_on      = depends_on,
 113         samba_deps      = deps,
 114         samba_includes  = includes,
 115         local_include   = local_include,
 116         vnum            = vnum,
 117         install_path    = None
 118         )
 119
 120     if install_path is None:
 121         install_path = '${PREFIX}/lib'
 122
 123     if install:
 124         # create a separate install library, which may have
 125         # different rpath settings
 126         SET_TARGET_TYPE(bld, libname + '.inst', 'LIBRARY')
 127         t = bld(
 128             features        = 'cc cshlib',
 129             source          = [],
 130             target          = libname + '.inst',
 131             samba_cflags    = CURRENT_CFLAGS(bld, libname, cflags),
 132             depends_on      = depends_on,
 133             samba_deps      = deps,
 134             samba_includes  = includes,
 135             local_include   = local_include,
 136             vnum            = vnum,
 137             install_as      = libname,
 138             install_path    = None,
 139             )
 140         t.env['RPATH'] = install_rpath(bld)
 141
 142         if vnum:
 143             vnum_base = vnum.split('.')[0]
 144             install_name = 'lib%s.so.%s' % (libname, vnum)
 145             install_link = 'lib%s.so.%s' % (libname, vnum_base)
 146         else:
 147             install_name = 'lib%s.so' % libname
 148             install_link = None
 149
 150         bld.install_as(os.path.join(install_path, install_name),
 151                        'lib%s.inst.so' % libname)
 152         if install_link:
 153             bld.symlink_as(os.path.join(install_path, install_link), install_name)
 154
 155
 156     if autoproto is not None:
 157         bld.SAMBA_AUTOPROTO(autoproto, source)
 158
 159 Build.BuildContext.SAMBA_LIBRARY = SAMBA_LIBRARY
 160
 161
 162 #################################################################
 163 # define a Samba binary
 164 def SAMBA_BINARY(bld, binname, source,
 165                  deps='',
 166                  includes='',
 167                  public_headers=None,
 168                  modules=None,
 169                  installdir=None,
 170                  ldflags=None,
 171                  cflags='',
 172                  autoproto=None,
 173                  use_hostcc=None,
 174                  compiler=None,
 175                  group='binaries',
 176                  manpages=None,
 177                  local_include=True,
 178                  subsystem_name=None,
 179                  needs_python=False,
 180                  install=True,
 181                  install_path=None):
 182
 183     if not SET_TARGET_TYPE(bld, binname, 'BINARY'):
 184         return
 185
 186     features = 'cc cprogram'
 187     if needs_python:
 188         features += ' pyembed'
 189
 190     bld.SET_BUILD_GROUP(group)
 191
 192     obj_target = binname + '.objlist'
 193
 194     # first create a target for building the object files for this binary
 195     # by separating in this way, we avoid recompiling the C files
 196     # separately for the install binary and the build binary
 197     bld.SAMBA_SUBSYSTEM(obj_target,
 198                         source         = source,
 199                         deps           = deps,
 200                         includes       = includes,
 201                         cflags         = cflags,
 202                         group          = group,
 203                         autoproto      = autoproto,
 204                         subsystem_name = subsystem_name,
 205                         needs_python   = needs_python,
 206                         local_include  = local_include)
 207
 208     # the library itself will depend on that object target
 209     deps = TO_LIST(deps)
 210     deps.append(obj_target)
 211
 212     bld(
 213         features       = features + ' symlink_bin',
 214         source         = [],
 215         target         = binname,
 216         samba_cflags   = CURRENT_CFLAGS(bld, binname, cflags),
 217         samba_deps     = deps,
 218         samba_includes = includes,
 219         local_include  = local_include,
 220         samba_modules  = modules,
 221         top            = True,
 222         samba_subsystem= subsystem_name,
 223         install_path   = None
 224         )
 225
 226     if install_path is None:
 227         install_path = '${PREFIX}/bin'
 228
 229     if install:
 230         # we create a separate 'install' binary, which
 231         # will have different rpath settings
 232         SET_TARGET_TYPE(bld, binname + '.inst', 'BINARY')
 233         t = bld(
 234             features       = features,
 235             source         = [],
 236             target         = binname + '.inst',
 237             samba_cflags   = CURRENT_CFLAGS(bld, binname, cflags),
 238             samba_deps     = deps,
 239             samba_includes = includes,
 240             local_include  = local_include,
 241             samba_modules  = modules,
 242             top            = True,
 243             samba_subsystem= subsystem_name,
 244             install_path   = None
 245             )
 246         t.env['RPATH'] = install_rpath(bld)
 247
 248         bld.install_as(os.path.join(install_path, binname),
 249                        binname + '.inst',
 250                        chmod=0755)
 251
 252     # setup the subsystem_name as an alias for the real
 253     # binary name, so it can be found when expanding
 254     # subsystem dependencies
 255     if subsystem_name is not None:
 256         bld.TARGET_ALIAS(subsystem_name, binname)
 257
 258     if autoproto is not None:
 259         bld.SAMBA_AUTOPROTO(autoproto, source)
 260 Build.BuildContext.SAMBA_BINARY = SAMBA_BINARY
 261
 262
 263 #################################################################
 264 # define a Samba module.
 265 def SAMBA_MODULE(bld, modname, source,
 266                  deps='',
 267                  includes='',
 268                  subsystem=None,
 269                  init_function=None,
 270                  autoproto=None,
 271                  autoproto_extra_source='',
 272                  aliases=None,
 273                  cflags='',
 274                  internal_module=True,
 275                  local_include=True,
 276                  enabled=True):
 277
 278     if internal_module:
 279         # treat internal modules as subsystems for now
 280         SAMBA_SUBSYSTEM(bld, modname, source,
 281                         deps=deps,
 282                         includes=includes,
 283                         autoproto=autoproto,
 284                         autoproto_extra_source=autoproto_extra_source,
 285                         cflags=cflags,
 286                         local_include=local_include,
 287                         enabled=enabled)
 288         # even though we're treating it as a subsystem, we need to
 289         # add it to the init_function list
 290         # TODO: we should also create an implicit dependency
 291         # between the subsystem target and this target
 292         if enabled:
 293             bld.ADD_INIT_FUNCTION(subsystem, modname, init_function)
 294         return
 295
 296     if not enabled:
 297         SET_TARGET_TYPE(bld, modname, 'DISABLED')
 298         return
 299
 300     # remember empty modules, so we can strip the dependencies
 301     if (source == '') or (source == []):
 302         SET_TARGET_TYPE(bld, modname, 'EMPTY')
 303         return
 304
 305     if not SET_TARGET_TYPE(bld, modname, 'MODULE'):
 306         return
 307
 308
 309     bld.ADD_INIT_FUNCTION(subsystem, modname, init_function)
 310
 311     if subsystem is not None:
 312         deps += ' ' + subsystem
 313
 314     bld.SET_BUILD_GROUP('main')
 315     bld(
 316         features       = 'cc',
 317         source         = source,
 318         target         = modname,
 319         samba_cflags   = CURRENT_CFLAGS(bld, modname, cflags),
 320         samba_includes = includes,
 321         local_include  = local_include,
 322         samba_deps     = TO_LIST(deps)
 323         )
 324
 325     if autoproto is not None:
 326         bld.SAMBA_AUTOPROTO(autoproto, source + ' ' + autoproto_extra_source)
 327
 328 Build.BuildContext.SAMBA_MODULE = SAMBA_MODULE
 329
 330
 331 #################################################################
 332 # define a Samba subsystem
 333 def SAMBA_SUBSYSTEM(bld, modname, source,
 334                     deps='',
 335                     public_deps='',
 336                     includes='',
 337                     public_headers=None,
 338                     cflags='',
 339                     cflags_end=None,
 340                     group='main',
 341                     init_function_sentinal=None,
 342                     heimdal_autoproto=None,
 343                     heimdal_autoproto_options=None,
 344                     heimdal_autoproto_private=None,
 345                     autoproto=None,
 346                     autoproto_extra_source='',
 347                     depends_on='',
 348                     local_include=True,
 349                     local_include_first=True,
 350                     subsystem_name=None,
 351                     enabled=True,
 352                     needs_python=False):
 353
 354     if not enabled:
 355         SET_TARGET_TYPE(bld, modname, 'DISABLED')
 356         return
 357
 358     # remember empty subsystems, so we can strip the dependencies
 359     if (source == '') or (source == []):
 360         SET_TARGET_TYPE(bld, modname, 'EMPTY')
 361         return
 362
 363     if not SET_TARGET_TYPE(bld, modname, 'SUBSYSTEM'):
 364         return
 365
 366     deps += ' ' + public_deps
 367
 368     bld.SET_BUILD_GROUP(group)
 369
 370     features = 'cc'
 371     if needs_python:
 372         features += ' pyext'
 373
 374     t = bld(
 375         features       = features,
 376         source         = source,
 377         target         = modname,
 378         samba_cflags   = CURRENT_CFLAGS(bld, modname, cflags),
 379         depends_on     = depends_on,
 380         samba_deps     = TO_LIST(deps),
 381         samba_includes = includes,
 382         local_include  = local_include,
 383         local_include_first  = local_include_first,
 384         samba_subsystem= subsystem_name
 385         )
 386
 387     if cflags_end is not None:
 388         t.samba_cflags.extend(TO_LIST(cflags_end))
 389
 390     if heimdal_autoproto is not None:
 391         bld.HEIMDAL_AUTOPROTO(heimdal_autoproto, source, options=heimdal_autoproto_options)
 392     if heimdal_autoproto_private is not None:
 393         bld.HEIMDAL_AUTOPROTO_PRIVATE(heimdal_autoproto_private, source)
 394     if autoproto is not None:
 395         bld.SAMBA_AUTOPROTO(autoproto, source + ' ' + autoproto_extra_source)
 396     return t
 397
 398 Build.BuildContext.SAMBA_SUBSYSTEM = SAMBA_SUBSYSTEM
 399
 400
 401 def SAMBA_GENERATOR(bld, name, rule, source, target,
 402                     group='build_source'):
 403     '''A generic source generator target'''
 404
 405     if not SET_TARGET_TYPE(bld, name, 'GENERATOR'):
 406         return
 407
 408     bld.SET_BUILD_GROUP(group)
 409     bld(
 410         rule=rule,
 411         source=source,
 412         target=target,
 413         before='cc',
 414         ext_out='.c')
 415 Build.BuildContext.SAMBA_GENERATOR = SAMBA_GENERATOR
 416
 417
 418
 419 ###############################################################
 420 # add a new set of build rules from a subdirectory
 421 # the @runonce decorator ensures we don't end up
 422 # with duplicate rules
 423 def BUILD_SUBDIR(bld, dir):
 424     path = os.path.normpath(bld.curdir + '/' + dir)
 425     cache = LOCAL_CACHE(bld, 'SUBDIR_LIST')
 426     if path in cache: return
 427     cache[path] = True
 428     debug("build: Processing subdirectory %s" % dir)
 429     bld.add_subdirs(dir)
 430
 431 Build.BuildContext.BUILD_SUBDIR = BUILD_SUBDIR
 432
 433
 434 ##########################################################
 435 # add a new top level command to waf
 436 def ADD_COMMAND(opt, name, function):
 437     Utils.g_module.__dict__[name] = function
 438     opt.name = function
 439 Options.Handler.ADD_COMMAND = ADD_COMMAND
 440
 441 ###########################################################
 442 # setup build groups used to ensure that the different build
 443 # phases happen consecutively
 444 @runonce
 445 def SETUP_BUILD_GROUPS(bld):
 446     bld.p_ln = bld.srcnode # we do want to see all targets!
 447     bld.env['USING_BUILD_GROUPS'] = True
 448     bld.add_group('setup')
 449     bld.add_group('base_libraries')
 450     bld.add_group('build_compilers')
 451     bld.add_group('build_source')
 452     bld.add_group('prototypes')
 453     bld.add_group('main')
 454     bld.add_group('binaries')
 455     bld.add_group('final')
 456 Build.BuildContext.SETUP_BUILD_GROUPS = SETUP_BUILD_GROUPS
 457
 458
 459 ###########################################################
 460 # set the current build group
 461 def SET_BUILD_GROUP(bld, group):
 462     if not 'USING_BUILD_GROUPS' in bld.env:
 463         return
 464     bld.set_group(group)
 465 Build.BuildContext.SET_BUILD_GROUP = SET_BUILD_GROUP
 466
 467
 468 def h_file(filename):
 469     import stat
 470     st = os.stat(filename)
 471     if stat.S_ISDIR(st[stat.ST_MODE]): raise IOError('not a file')
 472     m = Utils.md5()
 473     m.update(str(st.st_mtime))
 474     m.update(str(st.st_size))
 475     m.update(filename)
 476     return m.digest()
 477
 478 @conf
 479 def ENABLE_TIMESTAMP_DEPENDENCIES(conf):
 480     Utils.h_file = h_file
 481
 482
 483 ##############################
 484 # handle the creation of links for libraries and binaries
 485 # note that we use a relative symlink path to allow the whole tree
 486 # to me moved/copied elsewhere without breaking the links
 487 t = Task.simple_task_type('symlink_lib', 'ln -sf ${LINK_SOURCE} ${LINK_TARGET}',
 488                           color='PINK', ext_in='.bin')
 489 t.quiet = True
 490
 491 @feature('symlink_lib')
 492 @after('apply_link')
 493 def symlink_lib(self):
 494     tsk = self.create_task('symlink_lib', self.link_task.outputs[0])
 495
 496     # calculat the link target and put it in the environment
 497     soext=""
 498     vnum = getattr(self, 'vnum', None)
 499     if vnum is not None:
 500         soext = '.' + vnum.split('.')[0]
 501
 502     link_target = getattr(self, 'link_name', '')
 503     if link_target == '':
 504         link_target = '%s/lib%s.so%s' % (LIB_PATH, self.sname, soext)
 505
 506
 507     link_source = os_path_relpath(self.link_task.outputs[0].abspath(self.env),
 508                                   os.path.join(self.env.BUILD_DIRECTORY, link_target))
 509
 510     tsk.env.LINK_TARGET = link_target
 511     tsk.env.LINK_SOURCE = link_source[3:]
 512     debug('task_gen: LINK for %s is %s -> %s',
 513           self.name, tsk.env.LINK_SOURCE, tsk.env.LINK_TARGET)
 514
 515
 516 t = Task.simple_task_type('symlink_bin', 'ln -sf ${SRC} ${BIN_TARGET}',
 517                           color='PINK', ext_in='.bin')
 518 t.quiet = True
 519
 520 @feature('symlink_bin')
 521 @after('apply_link')
 522 def symlink_bin(self):
 523     if Options.is_install:
 524         # we don't want to copy the install binary, as
 525         # that has the install rpath, not the build rpath
 526         # The rpath of the binaries in bin/default/foo/blah is different
 527         # during the install phase, as distros insist on not using rpath in installed binaries
 528         return
 529     tsk = self.create_task('symlink_bin', self.link_task.outputs[0])
 530
 531     tsk.env.BIN_TARGET = self.target
 532     debug('task_gen: BIN_TARGET for %s is %s', self.name, tsk.env.BIN_TARGET)
 533
 534
 535
 536
 537 t = Task.simple_task_type('copy_script', 'ln -sf ${SRC[0].abspath(env)} ${LINK_TARGET}',
 538                           color='PINK', ext_in='.bin', shell=True)
 539 t.quiet = True
 540
 541 @feature('copy_script')
 542 @before('apply_link')
 543 def copy_script(self):
 544     tsk = self.create_task('copy_script', self.allnodes[0])
 545     tsk.env.TARGET = self.target
 546
 547 def SAMBA_SCRIPT(bld, name, pattern, installdir, installname=None):
 548     '''used to copy scripts from the source tree into the build directory
 549        for use by selftest'''
 550
 551     source = bld.path.ant_glob(pattern)
 552
 553     bld.SET_BUILD_GROUP('build_source')
 554     for s in TO_LIST(source):
 555         iname = s
 556         if installname != None:
 557             iname = installname
 558         target = os.path.join(installdir, iname)
 559         tgtdir = os.path.dirname(os.path.join(bld.srcnode.abspath(bld.env), '..', target))
 560         mkdir_p(tgtdir)
 561         t = bld(features='copy_script',
 562                 source       = s,
 563                 target       = target,
 564                 always       = True,
 565                 install_path = None)
 566         t.env.LINK_TARGET = target
 567
 568 Build.BuildContext.SAMBA_SCRIPT = SAMBA_SCRIPT
 569