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