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
35 # some systems have broken threading in python
36 if os.environ.get('WAF_NOTHREADS') == '1':
41 os.environ['PYTHONUNBUFFERED'] = '1'
44 if Constants.HEXVERSION < 0x105019:
46 Please use the version of waf that comes with Samba, not
47 a system installed version. See http://wiki.samba.org/index.php/Waf
50 Alternatively, please run ./configure and make as usual. That will
51 call the right version of waf.''')
56 def SAMBA_BUILD_ENV(conf):
57 '''create the samba build environment'''
58 conf.env.BUILD_DIRECTORY = conf.blddir
59 mkdir_p(os.path.join(conf.blddir, LIB_PATH))
60 mkdir_p(os.path.join(conf.blddir, LIB_PATH, "private"))
61 mkdir_p(os.path.join(conf.blddir, "modules"))
62 mkdir_p(os.path.join(conf.blddir, 'python/samba/dcerpc'))
63 # this allows all of the bin/shared and bin/python targets
64 # to be expressed in terms of build directory paths
65 mkdir_p(os.path.join(conf.blddir, 'default'))
66 for p in ['python','shared', 'modules']:
67 link_target = os.path.join(conf.blddir, 'default/' + p)
68 if not os.path.lexists(link_target):
69 os.symlink('../' + p, link_target)
71 # get perl to put the blib files in the build directory
72 blib_bld = os.path.join(conf.blddir, 'default/pidl/blib')
73 blib_src = os.path.join(conf.srcdir, 'pidl/blib')
74 mkdir_p(blib_bld + '/man1')
75 mkdir_p(blib_bld + '/man3')
76 if os.path.islink(blib_src):
78 elif os.path.exists(blib_src):
79 shutil.rmtree(blib_src)
82 def ADD_INIT_FUNCTION(bld, subsystem, target, init_function):
83 '''add an init_function to the list for a subsystem'''
84 if init_function is None:
86 bld.ASSERT(subsystem is not None, "You must specify a subsystem for init_function '%s'" % init_function)
87 cache = LOCAL_CACHE(bld, 'INIT_FUNCTIONS')
88 if not subsystem in cache:
90 cache[subsystem].append( { 'TARGET':target, 'INIT_FUNCTION':init_function } )
91 Build.BuildContext.ADD_INIT_FUNCTION = ADD_INIT_FUNCTION
95 #################################################################
96 def SAMBA_LIBRARY(bld, libname, source,
101 public_headers_install=True,
108 external_library=False,
111 autoproto_extra_source='',
122 target_type='LIBRARY',
123 bundled_extension=True,
129 private_library=False,
130 grouping_library=False,
131 allow_undefined_symbols=False,
133 '''define a Samba library'''
136 SET_TARGET_TYPE(bld, libname, 'DISABLED')
139 source = bld.EXPAND_VARIABLES(source, vars=vars)
141 source = bld.SUBDIR(subdir, source)
143 # remember empty libraries, so we can strip the dependencies
144 if ((source == '') or (source == [])) and deps == '' and public_deps == '':
145 SET_TARGET_TYPE(bld, libname, 'EMPTY')
148 if BUILTIN_LIBRARY(bld, libname):
151 obj_target = libname + '.objlist'
153 if group == 'libraries':
154 subsystem_group = 'main'
156 subsystem_group = group
158 # first create a target for building the object files for this library
159 # by separating in this way, we avoid recompiling the C files
160 # separately for the install library and the build library
161 bld.SAMBA_SUBSYSTEM(obj_target,
164 public_deps = public_deps,
166 public_headers = public_headers,
167 public_headers_install = public_headers_install,
168 header_path = header_path,
170 group = subsystem_group,
171 autoproto = autoproto,
172 autoproto_extra_source=autoproto_extra_source,
173 depends_on = depends_on,
174 hide_symbols = hide_symbols,
175 pyext = pyext or (target_type == "PYTHON"),
176 local_include = local_include,
177 global_include = global_include)
179 if BUILTIN_LIBRARY(bld, libname):
182 if not SET_TARGET_TYPE(bld, libname, target_type):
185 # the library itself will depend on that object target
186 deps += ' ' + public_deps
188 deps.append(obj_target)
190 realname = bld.map_shlib_extension(realname, python=(target_type=='PYTHON'))
191 link_name = bld.map_shlib_extension(link_name, python=(target_type=='PYTHON'))
193 # we don't want any public libraries without version numbers
194 if (not private_library and target_type != 'PYTHON' and not realname):
195 if vnum is None and soname is None:
196 raise Utils.WafError("public library '%s' must have a vnum" %
199 raise Utils.WafError("public library '%s' must have pkg-config file" %
201 if public_headers is None:
202 raise Utils.WafError("public library '%s' must have header files" %
205 if target_type == 'PYTHON' or realname or not private_library:
206 bundled_name = libname.replace('_', '-')
208 bundled_name = PRIVATE_NAME(bld, libname, bundled_extension,
211 ldflags = TO_LIST(ldflags)
213 features = 'cc cshlib symlink_lib install_lib'
214 if target_type == 'PYTHON':
217 # this is quite strange. we should add pyext feature for pyext
218 # but that breaks the build. This may be a bug in the waf python tool
219 features += ' pyembed'
222 features += ' abi_check'
225 if bld.env.HAVE_LD_VERSION_SCRIPT:
227 version = "%s_%s" % (Utils.g_module.APPNAME, Utils.g_module.VERSION)
229 version = "%s_%s" % (libname, vnum)
233 vscript = "%s.vscript" % libname
234 bld.ABI_VSCRIPT(libname, abi_directory, version, vscript,
236 fullname = apply_pattern(bundled_name, bld.env.shlib_PATTERN)
237 fullpath = bld.path.find_or_declare(fullname)
238 vscriptpath = bld.path.find_or_declare(vscript)
240 raise Utils.WafError("unable to find fullpath for %s" % fullname)
242 raise Utils.WafError("unable to find vscript path for %s" % vscript)
243 bld.add_manual_dependency(fullpath, vscriptpath)
244 if Options.is_install:
245 # also make the .inst file depend on the vscript
246 instname = apply_pattern(bundled_name + '.inst', bld.env.shlib_PATTERN)
247 bld.add_manual_dependency(bld.path.find_or_declare(instname), bld.path.find_or_declare(vscript))
248 vscript = os.path.join(bld.path.abspath(bld.env), vscript)
250 bld.SET_BUILD_GROUP(group)
254 target = bundled_name,
255 depends_on = depends_on,
256 samba_ldflags = ldflags,
258 samba_includes = includes,
259 version_script = vscript,
260 local_include = local_include,
261 global_include = global_include,
265 samba_inst_path = install_path,
267 samba_realname = realname,
268 samba_install = install,
269 abi_directory = "%s/%s" % (bld.path.abspath(), abi_directory),
270 abi_match = abi_match,
271 private_library = private_library,
272 grouping_library=grouping_library,
273 allow_undefined_symbols=allow_undefined_symbols
276 if realname and not link_name:
277 link_name = 'shared/%s' % realname
280 t.link_name = link_name
282 if pc_files is not None and not private_library:
283 bld.PKG_CONFIG_FILES(pc_files, vnum=vnum)
285 if (manpages is not None and 'XSLTPROC_MANPAGES' in bld.env and
286 bld.env['XSLTPROC_MANPAGES']):
287 bld.MANPAGES(manpages)
290 Build.BuildContext.SAMBA_LIBRARY = SAMBA_LIBRARY
293 #################################################################
294 def SAMBA_BINARY(bld, binname, source,
304 use_global_deps=True,
317 '''define a Samba binary'''
320 SET_TARGET_TYPE(bld, binname, 'DISABLED')
323 if not SET_TARGET_TYPE(bld, binname, 'BINARY'):
326 features = 'cc cprogram symlink_bin install_bin'
328 features += ' pyembed'
330 obj_target = binname + '.objlist'
332 source = bld.EXPAND_VARIABLES(source, vars=vars)
334 source = bld.SUBDIR(subdir, source)
335 source = unique_list(TO_LIST(source))
337 if group == 'binaries':
338 subsystem_group = 'main'
340 subsystem_group = group
342 # first create a target for building the object files for this binary
343 # by separating in this way, we avoid recompiling the C files
344 # separately for the install binary and the build binary
345 bld.SAMBA_SUBSYSTEM(obj_target,
350 group = subsystem_group,
351 autoproto = autoproto,
352 subsystem_name = subsystem_name,
353 local_include = local_include,
354 global_include = global_include,
355 use_hostcc = use_hostcc,
357 use_global_deps= use_global_deps)
359 bld.SET_BUILD_GROUP(group)
361 # the binary itself will depend on that object target
363 deps.append(obj_target)
370 samba_includes = includes,
371 local_include = local_include,
372 global_include = global_include,
373 samba_modules = modules,
375 samba_subsystem= subsystem_name,
377 samba_inst_path= install_path,
378 samba_install = install,
379 samba_ldflags = TO_LIST(ldflags)
382 if manpages is not None and 'XSLTPROC_MANPAGES' in bld.env and bld.env['XSLTPROC_MANPAGES']:
383 bld.MANPAGES(manpages)
385 Build.BuildContext.SAMBA_BINARY = SAMBA_BINARY
388 #################################################################
389 def SAMBA_MODULE(bld, modname, source,
394 module_init_name='samba_init_module',
396 autoproto_extra_source='',
398 internal_module=True,
405 allow_undefined_symbols=False
407 '''define a Samba module.'''
409 source = bld.EXPAND_VARIABLES(source, vars=vars)
411 source = bld.SUBDIR(subdir, source)
413 if internal_module or BUILTIN_LIBRARY(bld, modname):
414 bld.SAMBA_SUBSYSTEM(modname, source,
418 autoproto_extra_source=autoproto_extra_source,
420 local_include=local_include,
421 global_include=global_include,
424 bld.ADD_INIT_FUNCTION(subsystem, modname, init_function)
428 SET_TARGET_TYPE(bld, modname, 'DISABLED')
431 obj_target = modname + '.objlist'
434 if subsystem is not None:
435 deps += ' ' + subsystem
436 while realname.startswith("lib"+subsystem+"_"):
437 realname = realname[len("lib"+subsystem+"_"):]
438 while realname.startswith(subsystem+"_"):
439 realname = realname[len(subsystem+"_"):]
441 realname = bld.make_libname(realname)
442 while realname.startswith("lib"):
443 realname = realname[len("lib"):]
445 build_link_name = "modules/%s/%s" % (subsystem, realname)
448 cflags += " -D%s=%s" % (init_function, module_init_name)
450 bld.SAMBA_LIBRARY(modname,
456 autoproto = autoproto,
457 local_include=local_include,
458 global_include=global_include,
460 link_name=build_link_name,
461 install_path="${MODULESDIR}/%s" % subsystem,
463 allow_undefined_symbols=allow_undefined_symbols
467 Build.BuildContext.SAMBA_MODULE = SAMBA_MODULE
470 #################################################################
471 def SAMBA_SUBSYSTEM(bld, modname, source,
476 public_headers_install=True,
481 init_function_sentinal=None,
483 autoproto_extra_source='',
486 local_include_first=True,
491 use_global_deps=True,
496 '''define a Samba subsystem'''
499 SET_TARGET_TYPE(bld, modname, 'DISABLED')
502 # remember empty subsystems, so we can strip the dependencies
503 if ((source == '') or (source == [])) and deps == '' and public_deps == '':
504 SET_TARGET_TYPE(bld, modname, 'EMPTY')
507 if not SET_TARGET_TYPE(bld, modname, 'SUBSYSTEM'):
510 source = bld.EXPAND_VARIABLES(source, vars=vars)
512 source = bld.SUBDIR(subdir, source)
513 source = unique_list(TO_LIST(source))
515 deps += ' ' + public_deps
517 bld.SET_BUILD_GROUP(group)
527 samba_cflags = CURRENT_CFLAGS(bld, modname, cflags, hide_symbols=hide_symbols),
528 depends_on = depends_on,
529 samba_deps = TO_LIST(deps),
530 samba_includes = includes,
531 local_include = local_include,
532 local_include_first = local_include_first,
533 global_include = global_include,
534 samba_subsystem= subsystem_name,
535 samba_use_hostcc = use_hostcc,
536 samba_use_global_deps = use_global_deps
539 if cflags_end is not None:
540 t.samba_cflags.extend(TO_LIST(cflags_end))
542 if autoproto is not None:
543 bld.SAMBA_AUTOPROTO(autoproto, source + TO_LIST(autoproto_extra_source))
544 if public_headers is not None:
545 bld.PUBLIC_HEADERS(public_headers, header_path=header_path,
546 public_headers_install=public_headers_install)
550 Build.BuildContext.SAMBA_SUBSYSTEM = SAMBA_SUBSYSTEM
553 def SAMBA_GENERATOR(bld, name, rule, source='', target='',
554 group='generators', enabled=True,
556 public_headers_install=True,
560 '''A generic source generator target'''
562 if not SET_TARGET_TYPE(bld, name, 'GENERATOR'):
568 bld.SET_BUILD_GROUP(group)
571 source=bld.EXPAND_VARIABLES(source, vars=vars),
573 shell=isinstance(rule, str),
577 samba_type='GENERATOR',
578 dep_vars = [rule] + (vars or []),
584 if public_headers is not None:
585 bld.PUBLIC_HEADERS(public_headers, header_path=header_path,
586 public_headers_install=public_headers_install)
588 Build.BuildContext.SAMBA_GENERATOR = SAMBA_GENERATOR
593 def SETUP_BUILD_GROUPS(bld):
594 '''setup build groups used to ensure that the different build
595 phases happen consecutively'''
596 bld.p_ln = bld.srcnode # we do want to see all targets!
597 bld.env['USING_BUILD_GROUPS'] = True
598 bld.add_group('setup')
599 bld.add_group('build_compiler_source')
600 bld.add_group('vscripts')
601 bld.add_group('base_libraries')
602 bld.add_group('generators')
603 bld.add_group('compiler_prototypes')
604 bld.add_group('compiler_libraries')
605 bld.add_group('build_compilers')
606 bld.add_group('build_source')
607 bld.add_group('prototypes')
608 bld.add_group('headers')
609 bld.add_group('main')
610 bld.add_group('symbolcheck')
611 bld.add_group('libraries')
612 bld.add_group('binaries')
613 bld.add_group('syslibcheck')
614 bld.add_group('final')
615 Build.BuildContext.SETUP_BUILD_GROUPS = SETUP_BUILD_GROUPS
618 def SET_BUILD_GROUP(bld, group):
619 '''set the current build group'''
620 if not 'USING_BUILD_GROUPS' in bld.env:
623 Build.BuildContext.SET_BUILD_GROUP = SET_BUILD_GROUP
628 def ENABLE_TIMESTAMP_DEPENDENCIES(conf):
629 """use timestamps instead of file contents for deps
630 this currently doesn't work"""
631 def h_file(filename):
633 st = os.stat(filename)
634 if stat.S_ISDIR(st[stat.ST_MODE]): raise IOError('not a file')
636 m.update(str(st.st_mtime))
637 m.update(str(st.st_size))
640 Utils.h_file = h_file
643 def SAMBA_SCRIPT(bld, name, pattern, installdir, installname=None):
644 '''used to copy scripts from the source tree into the build directory
645 for use by selftest'''
647 source = bld.path.ant_glob(pattern)
649 bld.SET_BUILD_GROUP('build_source')
650 for s in TO_LIST(source):
652 if installname != None:
654 target = os.path.join(installdir, iname)
655 tgtdir = os.path.dirname(os.path.join(bld.srcnode.abspath(bld.env), '..', target))
657 link_src = os.path.normpath(os.path.join(bld.curdir, s))
658 link_dst = os.path.join(tgtdir, os.path.basename(iname))
659 if os.path.islink(link_dst) and os.readlink(link_dst) == link_src:
661 if os.path.exists(link_dst):
663 Logs.info("symlink: %s -> %s/%s" % (s, installdir, iname))
664 os.symlink(link_src, link_dst)
665 Build.BuildContext.SAMBA_SCRIPT = SAMBA_SCRIPT
668 def copy_and_fix_python_path(task):
669 pattern='sys.path.insert(0, "bin/python")'
670 if task.env["PYTHONARCHDIR"] in sys.path and task.env["PYTHONDIR"] in sys.path:
672 elif task.env["PYTHONARCHDIR"] == task.env["PYTHONDIR"]:
673 replacement="""sys.path.insert(0, "%s")""" % task.env["PYTHONDIR"]
675 replacement="""sys.path.insert(0, "%s")
676 sys.path.insert(1, "%s")""" % (task.env["PYTHONARCHDIR"], task.env["PYTHONDIR"])
678 installed_location=task.outputs[0].bldpath(task.env)
679 source_file = open(task.inputs[0].srcpath(task.env))
680 installed_file = open(installed_location, 'w')
681 for line in source_file:
684 newline = line.replace(pattern, replacement)
685 installed_file.write(newline)
686 installed_file.close()
687 os.chmod(installed_location, 0755)
691 def install_file(bld, destdir, file, chmod=MODE_644, flat=False,
692 python_fixup=False, destname=None, base_name=None):
694 destdir = bld.EXPAND_VARIABLES(destdir)
698 destname = os.path.basename(destname)
699 dest = os.path.join(destdir, destname)
701 # fixup the python path it will use to find Samba modules
702 inst_file = file + '.inst'
703 bld.SAMBA_GENERATOR('python_%s' % destname,
704 rule=copy_and_fix_python_path,
707 bld.add_manual_dependency(bld.path.find_or_declare(inst_file), bld.env["PYTHONARCHDIR"])
708 bld.add_manual_dependency(bld.path.find_or_declare(inst_file), bld.env["PYTHONDIR"])
711 file = os.path.join(base_name, file)
712 bld.install_as(dest, file, chmod=chmod)
715 def INSTALL_FILES(bld, destdir, files, chmod=MODE_644, flat=False,
716 python_fixup=False, destname=None, base_name=None):
717 '''install a set of files'''
718 for f in TO_LIST(files):
719 install_file(bld, destdir, f, chmod=chmod, flat=flat,
720 python_fixup=python_fixup, destname=destname,
722 Build.BuildContext.INSTALL_FILES = INSTALL_FILES
725 def INSTALL_WILDCARD(bld, destdir, pattern, chmod=MODE_644, flat=False,
726 python_fixup=False, exclude=None, trim_path=None):
727 '''install a set of files matching a wildcard pattern'''
728 files=TO_LIST(bld.path.ant_glob(pattern))
732 files2.append(os_path_relpath(f, trim_path))
737 if fnmatch.fnmatch(f, exclude):
739 INSTALL_FILES(bld, destdir, files, chmod=chmod, flat=flat,
740 python_fixup=python_fixup, base_name=trim_path)
741 Build.BuildContext.INSTALL_WILDCARD = INSTALL_WILDCARD
744 def INSTALL_DIRS(bld, destdir, dirs):
745 '''install a set of directories'''
746 destdir = bld.EXPAND_VARIABLES(destdir)
747 dirs = bld.EXPAND_VARIABLES(dirs)
748 for d in TO_LIST(dirs):
749 bld.install_dir(os.path.join(destdir, d))
750 Build.BuildContext.INSTALL_DIRS = INSTALL_DIRS
753 def MANPAGES(bld, manpages):
754 '''build and install manual pages'''
755 bld.env.MAN_XSL = 'http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl'
756 for m in manpages.split():
758 bld.SAMBA_GENERATOR(m,
762 rule='${XSLTPROC} -o ${TGT} --nonet ${MAN_XSL} ${SRC}'
764 bld.INSTALL_FILES('${MANDIR}/man%s' % m[-1], m, flat=True)
765 Build.BuildContext.MANPAGES = MANPAGES
768 #############################################################
769 # give a nicer display when building different types of files
770 def progress_display(self, msg, fname):
771 col1 = Logs.colors(self.color)
772 col2 = Logs.colors.NORMAL
773 total = self.position[1]
775 fs = '[%%%dd/%%%dd] %s %%s%%s%%s\n' % (n, n, msg)
776 return fs % (self.position[0], self.position[1], col1, fname, col2)
778 def link_display(self):
779 if Options.options.progress_bar != 0:
780 return Task.Task.old_display(self)
781 fname = self.outputs[0].bldpath(self.env)
782 return progress_display(self, 'Linking', fname)
783 Task.TaskBase.classes['cc_link'].display = link_display
785 def samba_display(self):
786 if Options.options.progress_bar != 0:
787 return Task.Task.old_display(self)
789 targets = LOCAL_CACHE(self, 'TARGET_TYPE')
790 if self.name in targets:
791 target_type = targets[self.name]
792 type_map = { 'GENERATOR' : 'Generating',
793 'PROTOTYPE' : 'Generating'
795 if target_type in type_map:
796 return progress_display(self, type_map[target_type], self.name)
798 if len(self.inputs) == 0:
799 return Task.Task.old_display(self)
801 fname = self.inputs[0].bldpath(self.env)
802 if fname[0:3] == '../':
804 ext_loc = fname.rfind('.')
806 return Task.Task.old_display(self)
807 ext = fname[ext_loc:]
809 ext_map = { '.idl' : 'Compiling IDL',
810 '.et' : 'Compiling ERRTABLE',
811 '.asn1': 'Compiling ASN1',
814 return progress_display(self, ext_map[ext], fname)
815 return Task.Task.old_display(self)
817 Task.TaskBase.classes['Task'].old_display = Task.TaskBase.classes['Task'].display
818 Task.TaskBase.classes['Task'].display = samba_display
823 def apply_bundle_remove_dynamiclib_patch(self):
824 if self.env['MACBUNDLE'] or getattr(self,'mac_bundle',False):
825 if not getattr(self,'vnum',None):
827 self.env['LINKFLAGS'].remove('-dynamiclib')
828 self.env['LINKFLAGS'].remove('-single_module')