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