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