19fc6d12118e8b83e875530382b2305be916e816
[samba.git] / wscript
1 #!/usr/bin/env python
2
3 srcdir = '.'
4 blddir = 'bin'
5
6 APPNAME='samba'
7 VERSION=None
8
9 import sys, os, tempfile
10 sys.path.insert(0, srcdir+"/buildtools/wafsamba")
11 import wafsamba, Options, samba_dist, samba_git, Scripting, Utils, samba_version
12 import Logs, samba_utils
13 import shutil
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 set_options(opt):
36     opt.BUILTIN_DEFAULT('NONE')
37     opt.PRIVATE_EXTENSION_DEFAULT('samba4')
38     opt.RECURSE('lib/audit_logging')
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/lib/tls')
45     opt.RECURSE('source4/dsdb/samdb/ldb_modules')
46     opt.RECURSE('pidl')
47     opt.RECURSE('source3')
48     opt.RECURSE('lib/util')
49     opt.RECURSE('lib/crypto')
50     opt.RECURSE('ctdb')
51
52
53     opt.samba_add_onoff_option('pthreadpool', with_name="enable", without_name="disable", default=True)
54
55     opt.add_option('--with-system-mitkrb5',
56                    help='build Samba with system MIT Kerberos. ' +
57                         'You may specify list of paths where Kerberos is installed (e.g. /usr/local /usr/kerberos) to search krb5-config',
58                    action='callback', callback=system_mitkrb5_callback, dest='with_system_mitkrb5', default=False)
59     opt.add_option('--with-system-mitkdc',
60                    help=('Specify the path to the krb5kdc binary from MIT Kerberos'),
61                    type="string",
62                    dest='with_system_mitkdc',
63                    default=None)
64
65     opt.add_option('--with-system-heimdalkrb5',
66                    help=('build Samba with system Heimdal Kerberos. ' +
67                          'Requires --without-ad-dc' and
68                          'conflicts with --with-system-mitkrb5'),
69                    action='store_true',
70                    dest='with_system_heimdalkrb5',
71                    default=False)
72
73     opt.add_option('--without-ad-dc',
74                    help='disable AD DC functionality (enables only Samba FS (File Server, Winbind, NMBD) and client utilities.',
75                    action='store_true', dest='without_ad_dc', default=False)
76
77     opt.add_option('--with-ntvfs-fileserver',
78                    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',
79                    action='store_true', dest='with_ntvfs_fileserver')
80
81     opt.add_option('--without-ntvfs-fileserver',
82                    help='disable the deprecated NTVFS file server from the original Samba4 branch',
83                    action='store_false', dest='with_ntvfs_fileserver')
84
85     opt.add_option('--with-pie',
86                   help=("Build Position Independent Executables " +
87                         "(default if supported by compiler)"),
88                   action="store_true", dest='enable_pie')
89     opt.add_option('--without-pie',
90                   help=("Disable Position Independent Executable builds"),
91                   action="store_false", dest='enable_pie')
92
93     opt.add_option('--with-relro',
94                   help=("Build with full RELocation Read-Only (RELRO)" +
95                         "(default if supported by compiler)"),
96                   action="store_true", dest='enable_relro')
97     opt.add_option('--without-relro',
98                   help=("Disable RELRO builds"),
99                   action="store_false", dest='enable_relro')
100
101     gr = opt.option_group('developer options')
102
103     opt.tool_options('python') # options for disabling pyc or pyo compilation
104     # enable options related to building python extensions
105
106
107 def configure(conf):
108     version = samba_version.load_version(env=conf.env)
109
110     conf.DEFINE('CONFIG_H_IS_FROM_SAMBA', 1)
111     conf.DEFINE('_SAMBA_BUILD_', version.MAJOR, add_to_cflags=True)
112     conf.DEFINE('HAVE_CONFIG_H', 1, add_to_cflags=True)
113
114     if Options.options.developer:
115         conf.ADD_CFLAGS('-DDEVELOPER -DDEBUG_PASSWORD')
116         conf.env.DEVELOPER = True
117         # if we are in a git tree without a pre-commit hook, install a
118         # simple default.
119         pre_commit_hook = os.path.join(srcdir, '.git/hooks/pre-commit')
120         if (os.path.isdir(os.path.dirname(pre_commit_hook)) and
121             not os.path.exists(pre_commit_hook)):
122             shutil.copy(os.path.join(srcdir, 'script/git-hooks/pre-commit-hook'),
123                         pre_commit_hook)
124
125     conf.ADD_EXTRA_INCLUDES('#include/public #source4 #lib #source4/lib #source4/include #include #lib/replace')
126
127     conf.env.replace_add_global_pthread = True
128     conf.RECURSE('lib/replace')
129
130     conf.RECURSE('examples/fuse')
131
132     conf.SAMBA_CHECK_PERL(mandatory=True)
133     conf.find_program('xsltproc', var='XSLTPROC')
134
135     if conf.env.disable_python:
136         if not (Options.options.without_ad_dc):
137             raise Utils.WafError('--disable-python requires --without-ad-dc')
138
139     conf.SAMBA_CHECK_PYTHON(mandatory=True, version=(2, 6, 0))
140     conf.SAMBA_CHECK_PYTHON_HEADERS(mandatory=(not conf.env.disable_python))
141
142     if sys.platform == 'darwin' and not conf.env['HAVE_ENVIRON_DECL']:
143         # Mac OSX needs to have this and it's also needed that the python is compiled with this
144         # otherwise you face errors about common symbols
145         if not conf.CHECK_SHLIB_W_PYTHON("Checking if -fno-common is needed"):
146             conf.ADD_CFLAGS('-fno-common')
147         if not conf.CHECK_SHLIB_W_PYTHON("Checking if -undefined dynamic_lookup is not need"):
148             conf.env.append_value('shlib_LINKFLAGS', ['-undefined', 'dynamic_lookup'])
149
150     if sys.platform == 'darwin':
151         conf.ADD_LDFLAGS('-framework CoreFoundation')
152
153     if int(conf.env['PYTHON_VERSION'][0]) >= 3:
154         raise Utils.WafError('Python version 3.x is not supported by Samba yet')
155
156     conf.RECURSE('dynconfig')
157     conf.RECURSE('selftest')
158
159     if conf.CHECK_FOR_THIRD_PARTY():
160         conf.RECURSE('third_party')
161     else:
162         if not conf.CHECK_ZLIB():
163             raise Utils.WafError('zlib development packages have not been found.\nIf third_party is installed, check that it is in the proper place.')
164         else:
165             conf.define('USING_SYSTEM_ZLIB',1)
166
167         if not conf.CHECK_POPT():
168             raise Utils.WafError('popt development packages have not been found.\nIf third_party is installed, check that it is in the proper place.')
169         else:
170             conf.define('USING_SYSTEM_POPT', 1)
171
172         if not conf.CHECK_CMOCKA():
173             raise Utils.WafError('cmocka development packages has not been found.\nIf third_party is installed, check that it is in the proper place.')
174         else:
175             conf.define('USING_SYSTEM_CMOCKA', 1)
176
177         if conf.CONFIG_GET('ENABLE_SELFTEST'):
178             if not conf.CHECK_SOCKET_WRAPPER():
179                 raise Utils.WafError('socket_wrapper package has not been found.\nIf third_party is installed, check that it is in the proper place.')
180             else:
181                 conf.define('USING_SYSTEM_SOCKET_WRAPPER', 1)
182
183             if not conf.CHECK_NSS_WRAPPER():
184                 raise Utils.WafError('nss_wrapper package has not been found.\nIf third_party is installed, check that it is in the proper place.')
185             else:
186                 conf.define('USING_SYSTEM_NSS_WRAPPER', 1)
187
188             if not conf.CHECK_RESOLV_WRAPPER():
189                 raise Utils.WafError('resolv_wrapper package has not been found.\nIf third_party is installed, check that it is in the proper place.')
190             else:
191                 conf.define('USING_SYSTEM_RESOLV_WRAPPER', 1)
192
193             if not conf.CHECK_UID_WRAPPER():
194                 raise Utils.WafError('uid_wrapper package has not been found.\nIf third_party is installed, check that it is in the proper place.')
195             else:
196                 conf.define('USING_SYSTEM_UID_WRAPPER', 1)
197
198             if not conf.CHECK_PAM_WRAPPER():
199                 raise Utils.WafError('pam_wrapper package has not been found.\nIf third_party is installed, check that it is in the proper place.')
200             else:
201                 conf.define('USING_SYSTEM_PAM_WRAPPER', 1)
202
203     conf.RECURSE('lib/ldb')
204
205     if conf.CHECK_LDFLAGS(['-Wl,--wrap=test']):
206         conf.env['HAVE_LDWRAP'] = True
207         conf.define('HAVE_LDWRAP', 1)
208
209     if not (Options.options.without_ad_dc):
210         conf.DEFINE('AD_DC_BUILD_IS_ENABLED', 1)
211
212     if Options.options.with_system_mitkrb5:
213         conf.PROCESS_SEPARATE_RULE('system_mitkrb5')
214     if not (Options.options.without_ad_dc or Options.options.with_system_mitkrb5):
215         conf.DEFINE('AD_DC_BUILD_IS_ENABLED', 1)
216
217     if Options.options.with_system_heimdalkrb5:
218         if Options.options.with_system_mitkrb5:
219             raise Utils.WafError('--with-system-heimdalkrb5 conflicts with ' +
220                                  '--with-system-mitkrb5')
221         if not Options.options.without_ad_dc:
222             raise Utils.WafError('--with-system-heimdalkrb5 requires ' +
223                                  '--without-ad-dc')
224         conf.env.SYSTEM_LIBS += ('heimdal', 'asn1', 'com_err', 'roken',
225                                  'hx509', 'wind', 'gssapi', 'hcrypto',
226                                  'krb5', 'heimbase', 'asn1_compile',
227                                  'compile_et', 'kdc', 'hdb', 'heimntlm')
228
229     # Only process heimdal_build for non-MIT KRB5 builds
230     # When MIT KRB5 checks are done as above, conf.env.KRB5_VENDOR will be set
231     # to the lowcased output of 'krb5-config --vendor'.
232     # If it is not set or the output is 'heimdal', we are dealing with
233     # system-provided or embedded Heimdal build
234     if conf.CONFIG_GET('KRB5_VENDOR') in (None, 'heimdal'):
235         conf.RECURSE('source4/heimdal_build')
236     conf.RECURSE('lib/audit_logging')
237     conf.RECURSE('source4/lib/tls')
238     conf.RECURSE('source4/dsdb/samdb/ldb_modules')
239     conf.RECURSE('source4/ntvfs/sysdep')
240     conf.RECURSE('lib/util')
241     conf.RECURSE('lib/util/charset')
242     conf.RECURSE('source4/auth')
243     conf.RECURSE('nsswitch')
244     conf.RECURSE('libcli/smbreadline')
245     conf.RECURSE('lib/crypto')
246     conf.RECURSE('pidl')
247     if conf.CONFIG_GET('ENABLE_SELFTEST'):
248         if Options.options.with_ntvfs_fileserver != False:
249             if not (Options.options.without_ad_dc):
250                 conf.DEFINE('WITH_NTVFS_FILESERVER', 1)
251         if Options.options.with_ntvfs_fileserver == False:
252             if not (Options.options.without_ad_dc):
253                 raise Utils.WafError('--without-ntvfs-fileserver conflicts with --enable-selftest while building the AD DC')
254         conf.RECURSE('testsuite/unittests')
255
256     if Options.options.with_ntvfs_fileserver == True:
257         if Options.options.without_ad_dc:
258             raise Utils.WafError('--with-ntvfs-fileserver conflicts with --without-ad-dc')
259         conf.DEFINE('WITH_NTVFS_FILESERVER', 1)
260
261     if Options.options.with_pthreadpool:
262         if conf.CONFIG_SET('HAVE_PTHREAD'):
263             conf.DEFINE('WITH_PTHREADPOOL', '1')
264         else:
265             Logs.warn("pthreadpool support cannot be enabled when pthread support was not found")
266             conf.undefine('WITH_PTHREADPOOL')
267
268     conf.RECURSE('source3')
269     conf.RECURSE('lib/texpect')
270     conf.RECURSE('python')
271     if conf.env.with_ctdb:
272         conf.RECURSE('ctdb')
273     conf.RECURSE('lib/socket')
274     conf.RECURSE('packaging')
275
276     conf.SAMBA_CHECK_UNDEFINED_SYMBOL_FLAGS()
277
278     # gentoo always adds this. We want our normal build to be as
279     # strict as the strictest OS we support, so adding this here
280     # allows us to find problems on our development hosts faster.
281     # It also results in faster load time.
282
283     conf.env.asneeded_ldflags = conf.ADD_LDFLAGS('-Wl,--as-needed', testflags=True)
284
285     if not conf.CHECK_NEED_LC("-lc not needed"):
286         conf.ADD_LDFLAGS('-lc', testflags=False)
287
288     if not conf.CHECK_CODE('#include "tests/summary.c"',
289                            define='SUMMARY_PASSES',
290                            addmain=False,
291                            msg='Checking configure summary'):
292         raise Utils.WafError('configure summary failed')
293
294     if Options.options.enable_pie != False:
295         if Options.options.enable_pie == True:
296                 need_pie = True
297         else:
298                 # not specified, only build PIEs if supported by compiler
299                 need_pie = False
300         if conf.check_cc(cflags='-fPIE', ldflags='-pie', mandatory=need_pie,
301                          msg="Checking compiler for PIE support"):
302             conf.env['ENABLE_PIE'] = True
303
304     if Options.options.enable_relro != False:
305         if Options.options.enable_relro == True:
306             need_relro = True
307         else:
308             # not specified, only build RELROs if supported by compiler
309             need_relro = False
310         if conf.check_cc(cflags='', ldflags='-Wl,-z,relro,-z,now', mandatory=need_relro,
311                          msg="Checking compiler for full RELRO support"):
312             conf.env['ENABLE_RELRO'] = True
313
314     conf.SAMBA_CONFIG_H('include/config.h')
315
316 def etags(ctx):
317     '''build TAGS file using etags'''
318     import Utils
319     source_root = os.path.dirname(Utils.g_module.root_path)
320     cmd = 'rm -f %s/TAGS && (find %s -name "*.[ch]" | egrep -v \.inst\. | xargs -n 100 etags -a)' % (source_root, source_root)
321     print("Running: %s" % cmd)
322     status = os.system(cmd)
323     if os.WEXITSTATUS(status):
324         raise Utils.WafError('etags failed')
325
326 def ctags(ctx):
327     "build 'tags' file using ctags"
328     import Utils
329     source_root = os.path.dirname(Utils.g_module.root_path)
330     cmd = 'ctags --python-kinds=-i $(find %s -name "*.[ch]" | grep -v "*_proto\.h" | egrep -v \.inst\.) $(find %s -name "*.py")' % (source_root, source_root)
331     print("Running: %s" % cmd)
332     status = os.system(cmd)
333     if os.WEXITSTATUS(status):
334         raise Utils.WafError('ctags failed')
335
336
337 # putting this here enabled build in the list
338 # of commands in --help
339 def build(bld):
340     '''build all targets'''
341     samba_version.load_version(env=bld.env, is_install=bld.is_install)
342
343
344 def pydoctor(ctx):
345     '''build python apidocs'''
346     bp = os.path.abspath('bin/python')
347     mpaths = {}
348     modules = ['talloc', 'tdb', 'ldb']
349     for m in modules:
350         f = os.popen("PYTHONPATH=%s python -c 'import %s; print %s.__file__'" % (bp, m, m), 'r')
351         try:
352             mpaths[m] = f.read().strip()
353         finally:
354             f.close()
355     mpaths['main'] = bp
356     cmd = ('PYTHONPATH=%(main)s pydoctor --introspect-c-modules --project-name=Samba '
357            '--project-url=http://www.samba.org --make-html --docformat=restructuredtext '
358            '--add-package bin/python/samba ' + ''.join('--add-module %s ' % n for n in modules))
359     cmd = cmd % mpaths
360     print("Running: %s" % cmd)
361     status = os.system(cmd)
362     if os.WEXITSTATUS(status):
363         raise Utils.WafError('pydoctor failed')
364
365
366 def pep8(ctx):
367     '''run pep8 validator'''
368     cmd='PYTHONPATH=bin/python pep8 -r bin/python/samba'
369     print("Running: %s" % cmd)
370     status = os.system(cmd)
371     if os.WEXITSTATUS(status):
372         raise Utils.WafError('pep8 failed')
373
374
375 def wafdocs(ctx):
376     '''build wafsamba apidocs'''
377     from samba_utils import recursive_dirlist
378     os.system('pwd')
379     list = recursive_dirlist('../buildtools/wafsamba', '.', pattern='*.py')
380
381     cmd='PYTHONPATH=bin/python pydoctor --project-name=wafsamba --project-url=http://www.samba.org --make-html --docformat=restructuredtext'
382     print(list)
383     for f in list:
384         cmd += ' --add-module %s' % f
385     print("Running: %s" % cmd)
386     status = os.system(cmd)
387     if os.WEXITSTATUS(status):
388         raise Utils.WafError('wafdocs failed')
389
390
391 def dist():
392     '''makes a tarball for distribution'''
393     sambaversion = samba_version.load_version(env=None)
394
395     os.system("make -C ctdb manpages")
396     samba_dist.DIST_FILES('ctdb/doc:ctdb/doc', extend=True)
397
398     os.system("DOC_VERSION='" + sambaversion.STRING + "' " + srcdir + "/release-scripts/build-manpages-nogit")
399     samba_dist.DIST_FILES('bin/docs:docs', extend=True)
400
401     if sambaversion.IS_SNAPSHOT:
402         # write .distversion file and add to tar
403         if not os.path.isdir(blddir):
404             os.makedirs(blddir)
405         distversionf = tempfile.NamedTemporaryFile(mode='w', prefix='.distversion',dir=blddir)
406         for field in sambaversion.vcs_fields:
407             distveroption = field + '=' + str(sambaversion.vcs_fields[field])
408             distversionf.write(distveroption + '\n')
409         distversionf.flush()
410         samba_dist.DIST_FILES('%s:.distversion' % distversionf.name, extend=True)
411
412         samba_dist.dist()
413         distversionf.close()
414     else:
415         samba_dist.dist()
416
417
418 def distcheck():
419     '''test that distribution tarball builds and installs'''
420     samba_version.load_version(env=None)
421     import Scripting
422     d = Scripting.distcheck
423     d()
424
425 def wildcard_cmd(cmd):
426     '''called on a unknown command'''
427     from samba_wildcard import run_named_build_task
428     run_named_build_task(cmd)
429
430 def main():
431     from samba_wildcard import wildcard_main
432
433     wildcard_main(wildcard_cmd)
434 Scripting.main = main
435
436 def reconfigure(ctx):
437     '''reconfigure if config scripts have changed'''
438     import samba_utils
439     samba_utils.reconfigure(ctx)
440
441
442 if os.path.isdir(os.path.join(srcdir, ".git")):
443     # Check if there are submodules that are checked out but out of date.
444     for submodule, status in samba_git.read_submodule_status(srcdir):
445         if status == "out-of-date":
446             raise Utils.WafError("some submodules are out of date. Please run 'git submodule update'")