1 # a waf tool to add autoconf-like macros to the configure section
2 # and for SAMBA_ macros for building libraries, binaries etc
4 import Build, os, sys, Options, Task, Utils, cc, TaskGen, fnmatch, re, shutil, Logs, Constants
5 from Configure import conf
7 from samba_utils import SUBST_VARS_RECURSIVE
8 TaskGen.task_gen.apply_verif = Utils.nada
10 # bring in the other samba modules
11 from samba_optimisation import *
12 from samba_utils import *
13 from samba_version import *
14 from samba_autoconf import *
15 from samba_patterns import *
16 from samba_pidl import *
17 from samba_autoproto import *
18 from samba_python import *
19 from samba_deps import *
20 from samba_bundled import *
22 import samba_conftests
36 # some systems have broken threading in python
37 if os.environ.get('WAF_NOTHREADS') == '1':
42 os.environ['PYTHONUNBUFFERED'] = '1'
45 if Constants.HEXVERSION < 0x105019:
47 Please use the version of waf that comes with Samba, not
48 a system installed version. See http://wiki.samba.org/index.php/Waf
51 Alternatively, please run ./configure and make as usual. That will
52 call the right version of waf.''')
57 def SAMBA_BUILD_ENV(conf):
58 '''create the samba build environment'''
59 conf.env.BUILD_DIRECTORY = conf.blddir
60 mkdir_p(os.path.join(conf.blddir, LIB_PATH))
61 mkdir_p(os.path.join(conf.blddir, LIB_PATH, "private"))
62 mkdir_p(os.path.join(conf.blddir, "modules"))
63 mkdir_p(os.path.join(conf.blddir, 'python/samba/dcerpc'))
64 # this allows all of the bin/shared and bin/python targets
65 # to be expressed in terms of build directory paths
66 mkdir_p(os.path.join(conf.blddir, 'default'))
67 for (source, target) in [('shared', 'shared'), ('modules', 'modules'), ('python', 'python_modules')]:
68 link_target = os.path.join(conf.blddir, 'default/' + target)
69 if not os.path.lexists(link_target):
70 os.symlink('../' + source, link_target)
72 # get perl to put the blib files in the build directory
73 blib_bld = os.path.join(conf.blddir, 'default/pidl/blib')
74 blib_src = os.path.join(conf.srcdir, 'pidl/blib')
75 mkdir_p(blib_bld + '/man1')
76 mkdir_p(blib_bld + '/man3')
77 if os.path.islink(blib_src):
79 elif os.path.exists(blib_src):
80 shutil.rmtree(blib_src)
83 def ADD_INIT_FUNCTION(bld, subsystem, target, init_function):
84 '''add an init_function to the list for a subsystem'''
85 if init_function is None:
87 bld.ASSERT(subsystem is not None, "You must specify a subsystem for init_function '%s'" % init_function)
88 cache = LOCAL_CACHE(bld, 'INIT_FUNCTIONS')
89 if not subsystem in cache:
91 cache[subsystem].append( { 'TARGET':target, 'INIT_FUNCTION':init_function } )
92 Build.BuildContext.ADD_INIT_FUNCTION = ADD_INIT_FUNCTION
96 #################################################################
97 def SAMBA_LIBRARY(bld, libname, source,
102 public_headers_install=True,
109 external_library=False,
112 autoproto_extra_source='',
123 target_type='LIBRARY',
124 bundled_extension=True,
130 private_library=False,
131 grouping_library=False,
132 allow_undefined_symbols=False,
134 '''define a Samba library'''
136 if LIB_MUST_BE_PRIVATE(bld, libname):
140 SET_TARGET_TYPE(bld, libname, 'DISABLED')
143 source = bld.EXPAND_VARIABLES(source, vars=vars)
145 source = bld.SUBDIR(subdir, source)
147 # remember empty libraries, so we can strip the dependencies
148 if ((source == '') or (source == [])) and deps == '' and public_deps == '':
149 SET_TARGET_TYPE(bld, libname, 'EMPTY')
152 if BUILTIN_LIBRARY(bld, libname):
155 obj_target = libname + '.objlist'
157 if group == 'libraries':
158 subsystem_group = 'main'
160 subsystem_group = group
162 # first create a target for building the object files for this library
163 # by separating in this way, we avoid recompiling the C files
164 # separately for the install library and the build library
165 bld.SAMBA_SUBSYSTEM(obj_target,
168 public_deps = public_deps,
170 public_headers = public_headers,
171 public_headers_install = public_headers_install,
172 header_path = header_path,
174 group = subsystem_group,
175 autoproto = autoproto,
176 autoproto_extra_source=autoproto_extra_source,
177 depends_on = depends_on,
178 hide_symbols = hide_symbols,
181 local_include = local_include,
182 global_include = global_include)
184 if BUILTIN_LIBRARY(bld, libname):
187 if not SET_TARGET_TYPE(bld, libname, target_type):
190 # the library itself will depend on that object target
191 deps += ' ' + public_deps
193 deps.append(obj_target)
195 realname = bld.map_shlib_extension(realname, python=(target_type=='PYTHON'))
196 link_name = bld.map_shlib_extension(link_name, python=(target_type=='PYTHON'))
198 # we don't want any public libraries without version numbers
199 if (not private_library and target_type != 'PYTHON' and not realname):
200 if vnum is None and soname is None:
201 raise Utils.WafError("public library '%s' must have a vnum" %
204 raise Utils.WafError("public library '%s' must have pkg-config file" %
206 if public_headers is None:
207 raise Utils.WafError("public library '%s' must have header files" %
210 if target_type == 'PYTHON' or realname or not private_library:
211 bundled_name = libname.replace('_', '-')
213 bundled_name = PRIVATE_NAME(bld, libname, bundled_extension,
216 ldflags = TO_LIST(ldflags)
218 features = 'cc cshlib symlink_lib install_lib'
222 features += ' pyembed'
225 features += ' abi_check'
228 if bld.env.HAVE_LD_VERSION_SCRIPT:
230 version = "%s_%s" % (Utils.g_module.APPNAME, Utils.g_module.VERSION)
232 version = "%s_%s" % (libname, vnum)
236 vscript = "%s.vscript" % libname
237 bld.ABI_VSCRIPT(libname, abi_directory, version, vscript,
239 fullname = apply_pattern(bundled_name, bld.env.shlib_PATTERN)
240 fullpath = bld.path.find_or_declare(fullname)
241 vscriptpath = bld.path.find_or_declare(vscript)
243 raise Utils.WafError("unable to find fullpath for %s" % fullname)
245 raise Utils.WafError("unable to find vscript path for %s" % vscript)
246 bld.add_manual_dependency(fullpath, vscriptpath)
247 if Options.is_install:
248 # also make the .inst file depend on the vscript
249 instname = apply_pattern(bundled_name + '.inst', bld.env.shlib_PATTERN)
250 bld.add_manual_dependency(bld.path.find_or_declare(instname), bld.path.find_or_declare(vscript))
251 vscript = os.path.join(bld.path.abspath(bld.env), vscript)
253 bld.SET_BUILD_GROUP(group)
257 target = bundled_name,
258 depends_on = depends_on,
259 samba_ldflags = ldflags,
261 samba_includes = includes,
262 version_script = vscript,
263 local_include = local_include,
264 global_include = global_include,
268 samba_inst_path = install_path,
270 samba_realname = realname,
271 samba_install = install,
272 abi_directory = "%s/%s" % (bld.path.abspath(), abi_directory),
273 abi_match = abi_match,
274 private_library = private_library,
275 grouping_library=grouping_library,
276 allow_undefined_symbols=allow_undefined_symbols
279 if realname and not link_name:
280 link_name = 'shared/%s' % realname
283 t.link_name = link_name
285 if pc_files is not None and not private_library:
286 bld.PKG_CONFIG_FILES(pc_files, vnum=vnum)
288 if (manpages is not None and 'XSLTPROC_MANPAGES' in bld.env and
289 bld.env['XSLTPROC_MANPAGES']):
290 bld.MANPAGES(manpages, install)
293 Build.BuildContext.SAMBA_LIBRARY = SAMBA_LIBRARY
296 #################################################################
297 def SAMBA_BINARY(bld, binname, source,
307 use_global_deps=True,
320 '''define a Samba binary'''
323 SET_TARGET_TYPE(bld, binname, 'DISABLED')
326 if not SET_TARGET_TYPE(bld, binname, 'BINARY'):
329 features = 'cc cprogram symlink_bin install_bin'
331 features += ' pyembed'
333 obj_target = binname + '.objlist'
335 source = bld.EXPAND_VARIABLES(source, vars=vars)
337 source = bld.SUBDIR(subdir, source)
338 source = unique_list(TO_LIST(source))
340 if group == 'binaries':
341 subsystem_group = 'main'
343 subsystem_group = group
345 # first create a target for building the object files for this binary
346 # by separating in this way, we avoid recompiling the C files
347 # separately for the install binary and the build binary
348 bld.SAMBA_SUBSYSTEM(obj_target,
353 group = subsystem_group,
354 autoproto = autoproto,
355 subsystem_name = subsystem_name,
356 local_include = local_include,
357 global_include = global_include,
358 use_hostcc = use_hostcc,
360 use_global_deps= use_global_deps)
362 bld.SET_BUILD_GROUP(group)
364 # the binary itself will depend on that object target
366 deps.append(obj_target)
373 samba_includes = includes,
374 local_include = local_include,
375 global_include = global_include,
376 samba_modules = modules,
378 samba_subsystem= subsystem_name,
380 samba_inst_path= install_path,
381 samba_install = install,
382 samba_ldflags = TO_LIST(ldflags)
385 if manpages is not None and 'XSLTPROC_MANPAGES' in bld.env and bld.env['XSLTPROC_MANPAGES']:
386 bld.MANPAGES(manpages, install)
388 Build.BuildContext.SAMBA_BINARY = SAMBA_BINARY
391 #################################################################
392 def SAMBA_MODULE(bld, modname, source,
397 module_init_name='samba_init_module',
399 autoproto_extra_source='',
401 internal_module=True,
409 allow_undefined_symbols=False
411 '''define a Samba module.'''
413 source = bld.EXPAND_VARIABLES(source, vars=vars)
415 source = bld.SUBDIR(subdir, source)
417 if internal_module or BUILTIN_LIBRARY(bld, modname):
418 # Do not create modules for disabled subsystems
419 if subsystem and GET_TARGET_TYPE(bld, subsystem) == 'DISABLED':
421 bld.SAMBA_SUBSYSTEM(modname, source,
425 autoproto_extra_source=autoproto_extra_source,
427 local_include=local_include,
428 global_include=global_include,
431 bld.ADD_INIT_FUNCTION(subsystem, modname, init_function)
435 SET_TARGET_TYPE(bld, modname, 'DISABLED')
438 # Do not create modules for disabled subsystems
439 if subsystem and GET_TARGET_TYPE(bld, subsystem) == 'DISABLED':
442 obj_target = modname + '.objlist'
445 if subsystem is not None:
446 deps += ' ' + subsystem
447 while realname.startswith("lib"+subsystem+"_"):
448 realname = realname[len("lib"+subsystem+"_"):]
449 while realname.startswith(subsystem+"_"):
450 realname = realname[len(subsystem+"_"):]
452 realname = bld.make_libname(realname)
453 while realname.startswith("lib"):
454 realname = realname[len("lib"):]
456 build_link_name = "modules/%s/%s" % (subsystem, realname)
459 cflags += " -D%s=%s" % (init_function, module_init_name)
461 bld.SAMBA_LIBRARY(modname,
467 autoproto = autoproto,
468 local_include=local_include,
469 global_include=global_include,
471 link_name=build_link_name,
472 install_path="${MODULESDIR}/%s" % subsystem,
475 allow_undefined_symbols=allow_undefined_symbols
479 Build.BuildContext.SAMBA_MODULE = SAMBA_MODULE
482 #################################################################
483 def SAMBA_SUBSYSTEM(bld, modname, source,
488 public_headers_install=True,
493 init_function_sentinel=None,
495 autoproto_extra_source='',
498 local_include_first=True,
503 use_global_deps=True,
509 '''define a Samba subsystem'''
512 SET_TARGET_TYPE(bld, modname, 'DISABLED')
515 # remember empty subsystems, so we can strip the dependencies
516 if ((source == '') or (source == [])) and deps == '' and public_deps == '':
517 SET_TARGET_TYPE(bld, modname, 'EMPTY')
520 if not SET_TARGET_TYPE(bld, modname, 'SUBSYSTEM'):
523 source = bld.EXPAND_VARIABLES(source, vars=vars)
525 source = bld.SUBDIR(subdir, source)
526 source = unique_list(TO_LIST(source))
528 deps += ' ' + public_deps
530 bld.SET_BUILD_GROUP(group)
536 features += ' pyembed'
542 samba_cflags = CURRENT_CFLAGS(bld, modname, cflags, hide_symbols=hide_symbols),
543 depends_on = depends_on,
544 samba_deps = TO_LIST(deps),
545 samba_includes = includes,
546 local_include = local_include,
547 local_include_first = local_include_first,
548 global_include = global_include,
549 samba_subsystem= subsystem_name,
550 samba_use_hostcc = use_hostcc,
551 samba_use_global_deps = use_global_deps,
554 if cflags_end is not None:
555 t.samba_cflags.extend(TO_LIST(cflags_end))
557 if autoproto is not None:
558 bld.SAMBA_AUTOPROTO(autoproto, source + TO_LIST(autoproto_extra_source))
559 if public_headers is not None:
560 bld.PUBLIC_HEADERS(public_headers, header_path=header_path,
561 public_headers_install=public_headers_install)
565 Build.BuildContext.SAMBA_SUBSYSTEM = SAMBA_SUBSYSTEM
568 def SAMBA_GENERATOR(bld, name, rule, source='', target='',
569 group='generators', enabled=True,
571 public_headers_install=True,
575 '''A generic source generator target'''
577 if not SET_TARGET_TYPE(bld, name, 'GENERATOR'):
584 if isinstance(vars, dict):
585 dep_vars = vars.keys()
586 elif isinstance(vars, list):
589 bld.SET_BUILD_GROUP(group)
592 source=bld.EXPAND_VARIABLES(source, vars=vars),
594 shell=isinstance(rule, str),
598 samba_type='GENERATOR',
599 dep_vars = [rule] + dep_vars,
605 if public_headers is not None:
606 bld.PUBLIC_HEADERS(public_headers, header_path=header_path,
607 public_headers_install=public_headers_install)
609 Build.BuildContext.SAMBA_GENERATOR = SAMBA_GENERATOR
614 def SETUP_BUILD_GROUPS(bld):
615 '''setup build groups used to ensure that the different build
616 phases happen consecutively'''
617 bld.p_ln = bld.srcnode # we do want to see all targets!
618 bld.env['USING_BUILD_GROUPS'] = True
619 bld.add_group('setup')
620 bld.add_group('build_compiler_source')
621 bld.add_group('vscripts')
622 bld.add_group('base_libraries')
623 bld.add_group('generators')
624 bld.add_group('compiler_prototypes')
625 bld.add_group('compiler_libraries')
626 bld.add_group('build_compilers')
627 bld.add_group('build_source')
628 bld.add_group('prototypes')
629 bld.add_group('headers')
630 bld.add_group('main')
631 bld.add_group('symbolcheck')
632 bld.add_group('libraries')
633 bld.add_group('binaries')
634 bld.add_group('syslibcheck')
635 bld.add_group('final')
636 Build.BuildContext.SETUP_BUILD_GROUPS = SETUP_BUILD_GROUPS
639 def SET_BUILD_GROUP(bld, group):
640 '''set the current build group'''
641 if not 'USING_BUILD_GROUPS' in bld.env:
644 Build.BuildContext.SET_BUILD_GROUP = SET_BUILD_GROUP
649 def ENABLE_TIMESTAMP_DEPENDENCIES(conf):
650 """use timestamps instead of file contents for deps
651 this currently doesn't work"""
652 def h_file(filename):
654 st = os.stat(filename)
655 if stat.S_ISDIR(st[stat.ST_MODE]): raise IOError('not a file')
657 m.update(str(st.st_mtime))
658 m.update(str(st.st_size))
661 Utils.h_file = h_file
664 def SAMBA_SCRIPT(bld, name, pattern, installdir, installname=None):
665 '''used to copy scripts from the source tree into the build directory
666 for use by selftest'''
668 source = bld.path.ant_glob(pattern)
670 bld.SET_BUILD_GROUP('build_source')
671 for s in TO_LIST(source):
673 if installname is not None:
675 target = os.path.join(installdir, iname)
676 tgtdir = os.path.dirname(os.path.join(bld.srcnode.abspath(bld.env), '..', target))
678 link_src = os.path.normpath(os.path.join(bld.curdir, s))
679 link_dst = os.path.join(tgtdir, os.path.basename(iname))
680 if os.path.islink(link_dst) and os.readlink(link_dst) == link_src:
682 if os.path.exists(link_dst):
684 Logs.info("symlink: %s -> %s/%s" % (s, installdir, iname))
685 os.symlink(link_src, link_dst)
686 Build.BuildContext.SAMBA_SCRIPT = SAMBA_SCRIPT
689 def copy_and_fix_python_path(task):
690 pattern='sys.path.insert(0, "bin/python")'
691 if task.env["PYTHONARCHDIR"] in sys.path and task.env["PYTHONDIR"] in sys.path:
693 elif task.env["PYTHONARCHDIR"] == task.env["PYTHONDIR"]:
694 replacement="""sys.path.insert(0, "%s")""" % task.env["PYTHONDIR"]
696 replacement="""sys.path.insert(0, "%s")
697 sys.path.insert(1, "%s")""" % (task.env["PYTHONARCHDIR"], task.env["PYTHONDIR"])
701 if task.env["PYTHON"][0] == "/":
702 replacement_shebang = "#!%s" % task.env["PYTHON"]
704 replacement_shebang = "#!/usr/bin/env %s" % task.env["PYTHON"]
706 installed_location=task.outputs[0].bldpath(task.env)
707 source_file = open(task.inputs[0].srcpath(task.env))
708 installed_file = open(installed_location, 'w')
710 for line in source_file:
712 if lineno == 0 and task.env["PYTHON_SPECIFIED"] == True and line[:2] == "#!":
713 newline = replacement_shebang
714 elif pattern in line:
715 newline = line.replace(pattern, replacement)
716 installed_file.write(newline)
718 installed_file.close()
719 os.chmod(installed_location, 0755)
723 def install_file(bld, destdir, file, chmod=MODE_644, flat=False,
724 python_fixup=False, destname=None, base_name=None):
726 destdir = bld.EXPAND_VARIABLES(destdir)
730 destname = os.path.basename(destname)
731 dest = os.path.join(destdir, destname)
733 # fixup the python path it will use to find Samba modules
734 inst_file = file + '.inst'
735 bld.SAMBA_GENERATOR('python_%s' % destname,
736 rule=copy_and_fix_python_path,
739 bld.add_manual_dependency(bld.path.find_or_declare(inst_file), bld.env["PYTHONARCHDIR"])
740 bld.add_manual_dependency(bld.path.find_or_declare(inst_file), bld.env["PYTHONDIR"])
741 bld.add_manual_dependency(bld.path.find_or_declare(inst_file), str(bld.env["PYTHON_SPECIFIED"]))
742 bld.add_manual_dependency(bld.path.find_or_declare(inst_file), bld.env["PYTHON"])
745 file = os.path.join(base_name, file)
746 bld.install_as(dest, file, chmod=chmod)
749 def INSTALL_FILES(bld, destdir, files, chmod=MODE_644, flat=False,
750 python_fixup=False, destname=None, base_name=None):
751 '''install a set of files'''
752 for f in TO_LIST(files):
753 install_file(bld, destdir, f, chmod=chmod, flat=flat,
754 python_fixup=python_fixup, destname=destname,
756 Build.BuildContext.INSTALL_FILES = INSTALL_FILES
759 def INSTALL_WILDCARD(bld, destdir, pattern, chmod=MODE_644, flat=False,
760 python_fixup=False, exclude=None, trim_path=None):
761 '''install a set of files matching a wildcard pattern'''
762 files=TO_LIST(bld.path.ant_glob(pattern))
766 files2.append(os_path_relpath(f, trim_path))
771 if fnmatch.fnmatch(f, exclude):
773 INSTALL_FILES(bld, destdir, files, chmod=chmod, flat=flat,
774 python_fixup=python_fixup, base_name=trim_path)
775 Build.BuildContext.INSTALL_WILDCARD = INSTALL_WILDCARD
778 def INSTALL_DIRS(bld, destdir, dirs):
779 '''install a set of directories'''
780 destdir = bld.EXPAND_VARIABLES(destdir)
781 dirs = bld.EXPAND_VARIABLES(dirs)
782 for d in TO_LIST(dirs):
783 bld.install_dir(os.path.join(destdir, d))
784 Build.BuildContext.INSTALL_DIRS = INSTALL_DIRS
787 def MANPAGES(bld, manpages, install):
788 '''build and install manual pages'''
789 bld.env.MAN_XSL = 'http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl'
790 for m in manpages.split():
792 bld.SAMBA_GENERATOR(m,
796 rule='${XSLTPROC} --xinclude -o ${TGT} --nonet ${MAN_XSL} ${SRC}'
799 bld.INSTALL_FILES('${MANDIR}/man%s' % m[-1], m, flat=True)
800 Build.BuildContext.MANPAGES = MANPAGES
802 def SAMBAMANPAGES(bld, manpages):
803 '''build and install manual pages'''
804 bld.env.SAMBA_EXPAND_XSL = bld.srcnode.abspath() + '/docs-xml/xslt/expand-sambadoc.xsl'
805 bld.env.SAMBA_MAN_XSL = bld.srcnode.abspath() + '/docs-xml/xslt/man.xsl'
806 bld.env.SAMBA_CATALOGS = 'file:///etc/xml/catalog file:///usr/local/share/xml/catalog file://' + bld.srcnode.abspath() + '/bin/default/docs-xml/build/catalog.xml'
808 for m in manpages.split():
810 bld.SAMBA_GENERATOR(m,
814 rule='''XML_CATALOG_FILES="${SAMBA_CATALOGS}"
815 export XML_CATALOG_FILES
816 ${XSLTPROC} --xinclude --stringparam noreference 0 -o ${TGT}.xml --nonet ${SAMBA_EXPAND_XSL} ${SRC}
817 ${XSLTPROC} --nonet -o ${TGT} ${SAMBA_MAN_XSL} ${TGT}.xml'''
819 bld.INSTALL_FILES('${MANDIR}/man%s' % m[-1], m, flat=True)
820 Build.BuildContext.SAMBAMANPAGES = SAMBAMANPAGES
822 #############################################################
823 # give a nicer display when building different types of files
824 def progress_display(self, msg, fname):
825 col1 = Logs.colors(self.color)
826 col2 = Logs.colors.NORMAL
827 total = self.position[1]
829 fs = '[%%%dd/%%%dd] %s %%s%%s%%s\n' % (n, n, msg)
830 return fs % (self.position[0], self.position[1], col1, fname, col2)
832 def link_display(self):
833 if Options.options.progress_bar != 0:
834 return Task.Task.old_display(self)
835 fname = self.outputs[0].bldpath(self.env)
836 return progress_display(self, 'Linking', fname)
837 Task.TaskBase.classes['cc_link'].display = link_display
839 def samba_display(self):
840 if Options.options.progress_bar != 0:
841 return Task.Task.old_display(self)
843 targets = LOCAL_CACHE(self, 'TARGET_TYPE')
844 if self.name in targets:
845 target_type = targets[self.name]
846 type_map = { 'GENERATOR' : 'Generating',
847 'PROTOTYPE' : 'Generating'
849 if target_type in type_map:
850 return progress_display(self, type_map[target_type], self.name)
852 if len(self.inputs) == 0:
853 return Task.Task.old_display(self)
855 fname = self.inputs[0].bldpath(self.env)
856 if fname[0:3] == '../':
858 ext_loc = fname.rfind('.')
860 return Task.Task.old_display(self)
861 ext = fname[ext_loc:]
863 ext_map = { '.idl' : 'Compiling IDL',
864 '.et' : 'Compiling ERRTABLE',
865 '.asn1': 'Compiling ASN1',
868 return progress_display(self, ext_map[ext], fname)
869 return Task.Task.old_display(self)
871 Task.TaskBase.classes['Task'].old_display = Task.TaskBase.classes['Task'].display
872 Task.TaskBase.classes['Task'].display = samba_display
877 def apply_bundle_remove_dynamiclib_patch(self):
878 if self.env['MACBUNDLE'] or getattr(self,'mac_bundle',False):
879 if not getattr(self,'vnum',None):
881 self.env['LINKFLAGS'].remove('-dynamiclib')
882 self.env['LINKFLAGS'].remove('-single_module')