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