wscript

   1 #!/usr/bin/env python
   2
   3 top = '.'
   4 out = 'bin'
   5
   6 APPNAME='samba'
   7 VERSION=None
   8
   9 import sys, os, tempfile
  10 sys.path.insert(0, top+"/buildtools/wafsamba")
  11 import shutil
  12 import wafsamba, samba_dist, samba_git, samba_version, samba_utils
  13 from waflib import Options, Scripting, Logs, Context, Errors
  14
  15 samba_dist.DIST_DIRS('.')
  16 samba_dist.DIST_BLACKLIST('.gitignore .bzrignore source4/selftest/provisions')
  17
  18 # install in /usr/local/samba by default
  19 default_prefix = Options.default_prefix = '/usr/local/samba'
  20
  21 # This callback optionally takes a list of paths as arguments:
  22 # --with-system_mitkrb5 /path/to/krb5 /another/path
  23 def system_mitkrb5_callback(option, opt, value, parser):
  24     setattr(parser.values, option.dest, True)
  25     value = []
  26     for arg in parser.rargs:
  27         # stop on --foo like options
  28         if arg[:2] == "--" and len(arg) > 2:
  29             break
  30         value.append(arg)
  31     if len(value)>0:
  32         del parser.rargs[:len(value)]
  33         setattr(parser.values, option.dest, value)
  34
  35 def options(opt):
  36     opt.BUILTIN_DEFAULT('NONE')
  37     opt.PRIVATE_EXTENSION_DEFAULT('samba4')
  38     opt.RECURSE('lib/replace')
  39     opt.RECURSE('dynconfig')
  40     opt.RECURSE('packaging')
  41     opt.RECURSE('lib/ldb')
  42     opt.RECURSE('selftest')
  43     opt.RECURSE('source4/dsdb/samdb/ldb_modules')
  44     opt.RECURSE('pidl')
  45     opt.RECURSE('source3')
  46     opt.RECURSE('lib/util')
  47     opt.RECURSE('lib/crypto')
  48     opt.RECURSE('ctdb')
  49
  50 # Optional Libraries
  51 # ------------------
  52 #
  53 # Most of the calls to opt.add_option() use default=True for the --with case
  54 #
  55 # To assist users and distributors to build Samba with the full feature
  56 # set, the build system will abort if our dependent libraries and their
  57 # header files are not found on the target system.  This will mean for
  58 # example, that xattr, acl and ldap headers must be installed for the
  59 # default build to complete.  The configure system will check for these
  60 # headers, and the error message will indicate the option (such as
  61 # --without-acl-support) that can be specified to skip this requirement.
  62 #
  63 # This will assist users and in particular distributors in building fully
  64 # functional packages, while allowing those on systems truly without these
  65 # facilities to continue to build Samba after careful consideration.
  66 #
  67 # It also ensures our container image generation in bootstrap/ is correct
  68 # as otherwise a missing package there would just silently work
  69
  70     opt.samba_add_onoff_option('pthreadpool', with_name="enable", without_name="disable", default=True)
  71
  72     opt.add_option('--with-system-mitkrb5',
  73                    help='build Samba with system MIT Kerberos. ' +
  74                         'You may specify list of paths where Kerberos is installed (e.g. /usr/local /usr/kerberos) to search krb5-config',
  75                    action='callback', callback=system_mitkrb5_callback, dest='with_system_mitkrb5', default=False)
  76
  77     opt.add_option('--with-experimental-mit-ad-dc',
  78                    help='Enable the experimental MIT Kerberos-backed AD DC.  ' +
  79                    'Note that security patches are not issued for this configuration',
  80                    action='store_true',
  81                    dest='with_experimental_mit_ad_dc',
  82                    default=False)
  83
  84     opt.add_option('--with-system-mitkdc',
  85                    help=('Specify the path to the krb5kdc binary from MIT Kerberos'),
  86                    type="string",
  87                    dest='with_system_mitkdc',
  88                    default=None)
  89
  90     opt.add_option('--with-system-heimdalkrb5',
  91                    help=('build Samba with system Heimdal Kerberos. ' +
  92                          'Requires --without-ad-dc' and
  93                          'conflicts with --with-system-mitkrb5'),
  94                    action='store_true',
  95                    dest='with_system_heimdalkrb5',
  96                    default=False)
  97
  98     opt.add_option('--without-ad-dc',
  99                    help='disable AD DC functionality (enables only Samba FS (File Server, Winbind, NMBD) and client utilities.',
 100                    action='store_true', dest='without_ad_dc', default=False)
 101
 102     opt.add_option('--with-ntvfs-fileserver',
 103                    help='enable the deprecated NTVFS file server from the original Samba4 branch (default if --enable-selftest specified).  Conflicts with --with-system-mitkrb5 and --without-ad-dc',
 104                    action='store_true', dest='with_ntvfs_fileserver')
 105
 106     opt.add_option('--without-ntvfs-fileserver',
 107                    help='disable the deprecated NTVFS file server from the original Samba4 branch',
 108                    action='store_false', dest='with_ntvfs_fileserver')
 109
 110     opt.add_option('--with-pie',
 111                   help=("Build Position Independent Executables " +
 112                         "(default if supported by compiler)"),
 113                   action="store_true", dest='enable_pie')
 114     opt.add_option('--without-pie',
 115                   help=("Disable Position Independent Executable builds"),
 116                   action="store_false", dest='enable_pie')
 117
 118     opt.add_option('--with-relro',
 119                   help=("Build with full RELocation Read-Only (RELRO)" +
 120                         "(default if supported by compiler)"),
 121                   action="store_true", dest='enable_relro')
 122     opt.add_option('--without-relro',
 123                   help=("Disable RELRO builds"),
 124                   action="store_false", dest='enable_relro')
 125
 126     gr = opt.option_group('developer options')
 127
 128     opt.load('python') # options for disabling pyc or pyo compilation
 129     # enable options related to building python extensions
 130
 131     opt.add_option('--with-json',
 132                    action='store_true', dest='with_json',
 133                    help=("Build with JSON support (default=True). This "
 134                          "requires the jansson development headers."))
 135     opt.add_option('--without-json',
 136                    action='store_false', dest='with_json',
 137                    help=("Build without JSON support."))
 138
 139 def configure(conf):
 140     version = samba_version.load_version(env=conf.env)
 141
 142     conf.DEFINE('CONFIG_H_IS_FROM_SAMBA', 1)
 143     conf.DEFINE('_SAMBA_BUILD_', version.MAJOR, add_to_cflags=True)
 144     conf.DEFINE('HAVE_CONFIG_H', 1, add_to_cflags=True)
 145
 146     if Options.options.developer:
 147         conf.ADD_CFLAGS('-DDEVELOPER -DDEBUG_PASSWORD')
 148         conf.env.DEVELOPER = True
 149         # if we are in a git tree without a pre-commit hook, install a
 150         # simple default.
 151         # we need git for 'waf dist'
 152         githooksdir = None
 153         conf.find_program('git', var='GIT')
 154         if 'GIT' in conf.env:
 155             githooksdir = conf.CHECK_COMMAND('%s rev-parse --git-path hooks' % conf.env.GIT[0],
 156                                msg='Finding githooks directory',
 157                                define=None,
 158                                on_target=False)
 159         if githooksdir and os.path.isdir(githooksdir):
 160             pre_commit_hook = os.path.join(githooksdir, 'pre-commit')
 161             if not os.path.exists(pre_commit_hook):
 162                 Logs.info("Installing script/git-hooks/pre-commit-hook as %s" %
 163                           pre_commit_hook)
 164                 shutil.copy(os.path.join(Context.g_module.top, 'script/git-hooks/pre-commit-hook'),
 165                             pre_commit_hook)
 166
 167     conf.ADD_EXTRA_INCLUDES('#include/public #source4 #lib #source4/lib #source4/include #include #lib/replace')
 168
 169     conf.env.replace_add_global_pthread = True
 170     conf.RECURSE('lib/replace')
 171
 172     conf.RECURSE('examples/fuse')
 173     conf.RECURSE('examples/winexe')
 174
 175     conf.SAMBA_CHECK_PERL(mandatory=True)
 176     conf.find_program('xsltproc', var='XSLTPROC')
 177
 178     if conf.env.disable_python:
 179         if not (Options.options.without_ad_dc):
 180             raise Errors.WafError('--disable-python requires --without-ad-dc')
 181
 182     conf.SAMBA_CHECK_PYTHON()
 183     conf.SAMBA_CHECK_PYTHON_HEADERS()
 184
 185     if sys.platform == 'darwin' and not conf.env['HAVE_ENVIRON_DECL']:
 186         # Mac OSX needs to have this and it's also needed that the python is compiled with this
 187         # otherwise you face errors about common symbols
 188         if not conf.CHECK_SHLIB_W_PYTHON("Checking if -fno-common is needed"):
 189             conf.ADD_CFLAGS('-fno-common')
 190         if not conf.CHECK_SHLIB_W_PYTHON("Checking if -undefined dynamic_lookup is not need"):
 191             conf.env.append_value('cshlib_LINKFLAGS', ['-undefined', 'dynamic_lookup'])
 192
 193     if sys.platform == 'darwin':
 194         conf.ADD_LDFLAGS('-framework CoreFoundation')
 195
 196     conf.RECURSE('dynconfig')
 197     conf.RECURSE('selftest')
 198
 199     conf.CHECK_CFG(package='zlib', minversion='1.2.3',
 200                    args='--cflags --libs',
 201                    mandatory=True)
 202     conf.CHECK_FUNCS_IN('inflateInit2', 'z')
 203
 204     if conf.CHECK_FOR_THIRD_PARTY():
 205         conf.RECURSE('third_party')
 206     else:
 207
 208         if not conf.CHECK_POPT():
 209             raise Errors.WafError('popt development packages have not been found.\nIf third_party is installed, check that it is in the proper place.')
 210         else:
 211             conf.define('USING_SYSTEM_POPT', 1)
 212
 213         if not conf.CHECK_CMOCKA():
 214             raise Errors.WafError('cmocka development packages has not been found.\nIf third_party is installed, check that it is in the proper place.')
 215         else:
 216             conf.define('USING_SYSTEM_CMOCKA', 1)
 217
 218         if conf.CONFIG_GET('ENABLE_SELFTEST'):
 219             if not conf.CHECK_SOCKET_WRAPPER():
 220                 raise Errors.WafError('socket_wrapper package has not been found.\nIf third_party is installed, check that it is in the proper place.')
 221             else:
 222                 conf.define('USING_SYSTEM_SOCKET_WRAPPER', 1)
 223
 224             if not conf.CHECK_NSS_WRAPPER():
 225                 raise Errors.WafError('nss_wrapper package has not been found.\nIf third_party is installed, check that it is in the proper place.')
 226             else:
 227                 conf.define('USING_SYSTEM_NSS_WRAPPER', 1)
 228
 229             if not conf.CHECK_RESOLV_WRAPPER():
 230                 raise Errors.WafError('resolv_wrapper package has not been found.\nIf third_party is installed, check that it is in the proper place.')
 231             else:
 232                 conf.define('USING_SYSTEM_RESOLV_WRAPPER', 1)
 233
 234             if not conf.CHECK_UID_WRAPPER():
 235                 raise Errors.WafError('uid_wrapper package has not been found.\nIf third_party is installed, check that it is in the proper place.')
 236             else:
 237                 conf.define('USING_SYSTEM_UID_WRAPPER', 1)
 238
 239             if not conf.CHECK_PAM_WRAPPER():
 240                 raise Errors.WafError('pam_wrapper package has not been found.\nIf third_party is installed, check that it is in the proper place.')
 241             else:
 242                 conf.define('USING_SYSTEM_PAM_WRAPPER', 1)
 243
 244     conf.RECURSE('lib/ldb')
 245
 246     if conf.CHECK_LDFLAGS(['-Wl,--wrap=test']):
 247         conf.env['HAVE_LDWRAP'] = True
 248         conf.define('HAVE_LDWRAP', 1)
 249
 250     if not (Options.options.without_ad_dc):
 251         conf.DEFINE('AD_DC_BUILD_IS_ENABLED', 1)
 252
 253     # Check for flex before doing the embedded heimdal checks so we can bail if we don't have it.
 254     Logs.info("Checking for flex")
 255     conf.find_program('flex', var='FLEX')
 256     if conf.env['FLEX']:
 257         conf.CHECK_COMMAND('%s --version' % conf.env.FLEX[0],
 258                            msg='Using flex version',
 259                            define=None,
 260                            on_target=False)
 261     conf.env.FLEXFLAGS = ['-t']
 262
 263     # #line statements in these generated files cause issues for lcov
 264     conf.env.FLEXFLAGS += ["--noline"]
 265
 266     if Options.options.with_system_mitkrb5:
 267         if not Options.options.with_experimental_mit_ad_dc and \
 268            not Options.options.without_ad_dc:
 269             raise Errors.WafError('The MIT Kerberos build of Samba as an AD DC ' +
 270                                   'is experimental. Therefore '
 271                                   '--with-system-mitkrb5 requires either ' +
 272                                   '--with-experimental-mit-ad-dc or ' +
 273                                   '--without-ad-dc')
 274
 275         conf.PROCESS_SEPARATE_RULE('system_mitkrb5')
 276
 277     if not (Options.options.without_ad_dc or Options.options.with_system_mitkrb5):
 278         conf.DEFINE('AD_DC_BUILD_IS_ENABLED', 1)
 279
 280     if Options.options.with_system_heimdalkrb5:
 281         if Options.options.with_system_mitkrb5:
 282             raise Errors.WafError('--with-system-heimdalkrb5 conflicts with ' +
 283                                   '--with-system-mitkrb5')
 284         if not Options.options.without_ad_dc:
 285             raise Errors.WafError('--with-system-heimdalkrb5 requires ' +
 286                                   '--without-ad-dc')
 287         conf.env.SYSTEM_LIBS += ('heimdal', 'asn1', 'com_err', 'roken',
 288                                  'hx509', 'wind', 'gssapi', 'hcrypto',
 289                                  'krb5', 'heimbase', 'asn1_compile',
 290                                  'compile_et', 'kdc', 'hdb', 'heimntlm')
 291         conf.PROCESS_SEPARATE_RULE('system_heimdal')
 292
 293     if not conf.CONFIG_GET('KRB5_VENDOR'):
 294         conf.PROCESS_SEPARATE_RULE('embedded_heimdal')
 295
 296     conf.PROCESS_SEPARATE_RULE('system_gnutls')
 297
 298     conf.RECURSE('source4/dsdb/samdb/ldb_modules')
 299     conf.RECURSE('source4/ntvfs/sysdep')
 300     conf.RECURSE('lib/util')
 301     conf.RECURSE('lib/util/charset')
 302     conf.RECURSE('source4/auth')
 303     conf.RECURSE('nsswitch')
 304     conf.RECURSE('libcli/smbreadline')
 305     conf.RECURSE('lib/crypto')
 306     conf.RECURSE('pidl')
 307     if conf.CONFIG_GET('ENABLE_SELFTEST'):
 308         if Options.options.with_ntvfs_fileserver != False:
 309             if not (Options.options.without_ad_dc):
 310                 conf.DEFINE('WITH_NTVFS_FILESERVER', 1)
 311         if Options.options.with_ntvfs_fileserver == False:
 312             if not (Options.options.without_ad_dc):
 313                 raise Errors.WafError('--without-ntvfs-fileserver conflicts with --enable-selftest while building the AD DC')
 314         conf.RECURSE('testsuite/unittests')
 315
 316     if Options.options.with_ntvfs_fileserver == True:
 317         if Options.options.without_ad_dc:
 318             raise Errors.WafError('--with-ntvfs-fileserver conflicts with --without-ad-dc')
 319         conf.DEFINE('WITH_NTVFS_FILESERVER', 1)
 320
 321     if Options.options.with_pthreadpool:
 322         if conf.CONFIG_SET('HAVE_PTHREAD'):
 323             conf.DEFINE('WITH_PTHREADPOOL', '1')
 324         else:
 325             Logs.warn("pthreadpool support cannot be enabled when pthread support was not found")
 326             conf.undefine('WITH_PTHREADPOOL')
 327
 328     conf.SET_TARGET_TYPE('jansson', 'EMPTY')
 329
 330     if Options.options.with_json != False:
 331         if conf.CHECK_CFG(package='jansson', args='--cflags --libs',
 332                           msg='Checking for jansson'):
 333             conf.CHECK_FUNCS_IN('json_object', 'jansson')
 334
 335     if not conf.CONFIG_GET('HAVE_JSON_OBJECT'):
 336         if Options.options.with_json != False:
 337             conf.fatal("Jansson JSON support not found. "
 338                        "Try installing libjansson-dev or jansson-devel. "
 339                        "Otherwise, use --without-json to build without "
 340                        "JSON support. "
 341                        "JSON support is required for the JSON "
 342                        "formatted audit log feature, the AD DC, and "
 343                        "the JSON printers of the net utility")
 344         if not Options.options.without_ad_dc:
 345             raise Errors.WafError('--without-json requires --without-ad-dc. '
 346                                  'Jansson JSON library is required for '
 347                                  'building the AD DC')
 348         Logs.info("Building without Jansson JSON log support")
 349
 350     conf.RECURSE('source3')
 351     conf.RECURSE('lib/texpect')
 352     conf.RECURSE('python')
 353     if conf.env.with_ctdb:
 354         conf.RECURSE('ctdb')
 355     conf.RECURSE('lib/socket')
 356     conf.RECURSE('lib/mscat')
 357     conf.RECURSE('packaging')
 358
 359     conf.SAMBA_CHECK_UNDEFINED_SYMBOL_FLAGS()
 360
 361     # gentoo always adds this. We want our normal build to be as
 362     # strict as the strictest OS we support, so adding this here
 363     # allows us to find problems on our development hosts faster.
 364     # It also results in faster load time.
 365
 366     if conf.CHECK_LDFLAGS('-Wl,--as-needed'):
 367         conf.env.append_unique('LINKFLAGS', '-Wl,--as-needed')
 368
 369     if not conf.CHECK_NEED_LC("-lc not needed"):
 370         conf.ADD_LDFLAGS('-lc', testflags=False)
 371
 372     if not conf.CHECK_CODE('#include "tests/summary.c"',
 373                            define='SUMMARY_PASSES',
 374                            addmain=False,
 375                            msg='Checking configure summary'):
 376         raise Errors.WafError('configure summary failed')
 377
 378     if Options.options.enable_pie != False:
 379         if Options.options.enable_pie == True:
 380                 need_pie = True
 381         else:
 382                 # not specified, only build PIEs if supported by compiler
 383                 need_pie = False
 384         if conf.check_cc(cflags='-fPIE', ldflags='-pie', mandatory=need_pie,
 385                          msg="Checking compiler for PIE support"):
 386             conf.env['ENABLE_PIE'] = True
 387
 388     if Options.options.enable_relro != False:
 389         if Options.options.enable_relro == True:
 390             need_relro = True
 391         else:
 392             # not specified, only build RELROs if supported by compiler
 393             need_relro = False
 394         if conf.check_cc(cflags='', ldflags='-Wl,-z,relro,-z,now', mandatory=need_relro,
 395                          msg="Checking compiler for full RELRO support"):
 396             conf.env['ENABLE_RELRO'] = True
 397
 398     conf.SAMBA_CONFIG_H('include/config.h')
 399
 400 def etags(ctx):
 401     '''build TAGS file using etags'''
 402     from waflib import Utils
 403     source_root = os.path.dirname(Context.g_module.root_path)
 404     cmd = 'rm -f %s/TAGS && (find %s -name "*.[ch]" | egrep -v \.inst\. | xargs -n 100 etags -a)' % (source_root, source_root)
 405     print("Running: %s" % cmd)
 406     status = os.system(cmd)
 407     if os.WEXITSTATUS(status):
 408         raise Errors.WafError('etags failed')
 409
 410 def ctags(ctx):
 411     "build 'tags' file using ctags"
 412     from waflib import Utils
 413     source_root = os.path.dirname(Context.g_module.root_path)
 414     cmd = 'ctags --python-kinds=-i $(find %s -name "*.[ch]" | grep -v "*_proto\.h" | egrep -v \.inst\.) $(find %s -name "*.py")' % (source_root, source_root)
 415     print("Running: %s" % cmd)
 416     status = os.system(cmd)
 417     if os.WEXITSTATUS(status):
 418         raise Errors.WafError('ctags failed')
 419
 420
 421 # putting this here enabled build in the list
 422 # of commands in --help
 423 def build(bld):
 424     '''build all targets'''
 425     samba_version.load_version(env=bld.env, is_install=bld.is_install)
 426
 427
 428 def pydoctor(ctx):
 429     '''build python apidocs'''
 430     bp = os.path.abspath('bin/python')
 431     mpaths = {}
 432     modules = ['talloc', 'tdb', 'ldb']
 433     for m in modules:
 434         f = os.popen("PYTHONPATH=%s python -c 'import %s; print %s.__file__'" % (bp, m, m), 'r')
 435         try:
 436             mpaths[m] = f.read().strip()
 437         finally:
 438             f.close()
 439     mpaths['main'] = bp
 440     cmd = ('PYTHONPATH=%(main)s pydoctor --introspect-c-modules --project-name=Samba '
 441            '--project-url=http://www.samba.org --make-html --docformat=restructuredtext '
 442            '--add-package bin/python/samba ' + ''.join('--add-module %s ' % n for n in modules))
 443     cmd = cmd % mpaths
 444     print("Running: %s" % cmd)
 445     status = os.system(cmd)
 446     if os.WEXITSTATUS(status):
 447         raise Errors.WafError('pydoctor failed')
 448
 449
 450 def pep8(ctx):
 451     '''run pep8 validator'''
 452     cmd='PYTHONPATH=bin/python pep8 -r bin/python/samba'
 453     print("Running: %s" % cmd)
 454     status = os.system(cmd)
 455     if os.WEXITSTATUS(status):
 456         raise Errors.WafError('pep8 failed')
 457
 458
 459 def wafdocs(ctx):
 460     '''build wafsamba apidocs'''
 461     from samba_utils import recursive_dirlist
 462     os.system('pwd')
 463     list = recursive_dirlist('../buildtools/wafsamba', '.', pattern='*.py')
 464
 465     print(list)
 466     cmd='PYTHONPATH=bin/python pydoctor --project-name=wafsamba --project-url=http://www.samba.org --make-html --docformat=restructuredtext' +\
 467         "".join(' --add-module %s' % f for f in list)
 468     print("Running: %s" % cmd)
 469     status = os.system(cmd)
 470     if os.WEXITSTATUS(status):
 471         raise Errors.WafError('wafdocs failed')
 472
 473
 474 def dist():
 475     '''makes a tarball for distribution'''
 476     sambaversion = samba_version.load_version(env=None)
 477
 478     os.system("make -C ctdb manpages")
 479     samba_dist.DIST_FILES('ctdb/doc:ctdb/doc', extend=True)
 480
 481     os.system("DOC_VERSION='" + sambaversion.STRING + "' " + Context.g_module.top + "/release-scripts/build-manpages-nogit")
 482     samba_dist.DIST_FILES('bin/docs:docs', extend=True)
 483
 484     if sambaversion.IS_SNAPSHOT:
 485         # write .distversion file and add to tar
 486         if not os.path.isdir(Context.g_module.out):
 487             os.makedirs(Context.g_module.out)
 488         distversionf = tempfile.NamedTemporaryFile(mode='w', prefix='.distversion',dir=Context.g_module.out)
 489         for field in sambaversion.vcs_fields:
 490             distveroption = field + '=' + str(sambaversion.vcs_fields[field])
 491             distversionf.write(distveroption + '\n')
 492         distversionf.flush()
 493         samba_dist.DIST_FILES('%s:.distversion' % distversionf.name, extend=True)
 494
 495         samba_dist.dist()
 496         distversionf.close()
 497     else:
 498         samba_dist.dist()
 499
 500
 501 def distcheck():
 502     '''test that distribution tarball builds and installs'''
 503     samba_version.load_version(env=None)
 504
 505 def wildcard_cmd(cmd):
 506     '''called on a unknown command'''
 507     from samba_wildcard import run_named_build_task
 508     run_named_build_task(cmd)
 509
 510 def main():
 511     from samba_wildcard import wildcard_main
 512
 513     wildcard_main(wildcard_cmd)
 514 Scripting.main = main
 515
 516 def reconfigure(ctx):
 517     '''reconfigure if config scripts have changed'''
 518     import samba_utils
 519     samba_utils.reconfigure(ctx)
 520
 521
 522 if os.path.isdir(os.path.join(top, ".git")):
 523     # Check if there are submodules that are checked out but out of date.
 524     for submodule, status in samba_git.read_submodule_status(top):
 525         if status == "out-of-date":
 526             raise Errors.WafError("some submodules are out of date. Please run 'git submodule update'")