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
, Options
, Task
, Utils
, cc
, TaskGen
, fnmatch
, re
, shutil
, Logs
, Constants
5 from Configure
import conf
7 from samba_utils
import SUBST_VARS_RECURSIVE
9 # bring in the other samba modules
10 from samba_optimisation
import *
11 from samba_utils
import *
12 from samba_version
import *
13 from samba_autoconf
import *
14 from samba_patterns
import *
15 from samba_pidl
import *
16 from samba_errtable
import *
17 from samba_asn1
import *
18 from samba_autoproto
import *
19 from samba_python
import *
20 from samba_deps
import *
21 from samba_bundled
import *
23 import samba_conftests
33 # some systems have broken threading in python
34 if os
.environ
.get('WAF_NOTHREADS') == '1':
39 os
.putenv('PYTHONUNBUFFERED', '1')
42 if Constants
.HEXVERSION
< 0x105016:
44 Please use the version of waf that comes with Samba, not
45 a system installed version. See http://wiki.samba.org/index.php/Waf
48 Alternatively, please use ./autogen-waf.sh, and then
49 run ./configure and make as usual. That will call the right version of waf.
55 def SAMBA_BUILD_ENV(conf
):
56 '''create the samba build environment'''
57 conf
.env
.BUILD_DIRECTORY
= conf
.blddir
58 mkdir_p(os
.path
.join(conf
.blddir
, LIB_PATH
))
59 mkdir_p(os
.path
.join(conf
.blddir
, 'python/samba/dcerpc'))
60 # this allows all of the bin/shared and bin/python targets
61 # to be expressed in terms of build directory paths
62 mkdir_p(os
.path
.join(conf
.blddir
, 'default'))
63 for p
in ['python','shared']:
64 link_target
= os
.path
.join(conf
.blddir
, 'default/' + p
)
65 if not os
.path
.lexists(link_target
):
66 os
.symlink('../' + p
, link_target
)
68 # get perl to put the blib files in the build directory
69 blib_bld
= os
.path
.join(conf
.blddir
, 'default/pidl/blib')
70 blib_src
= os
.path
.join(conf
.srcdir
, 'pidl/blib')
71 mkdir_p(blib_bld
+ '/man1')
72 mkdir_p(blib_bld
+ '/man3')
73 if os
.path
.islink(blib_src
):
75 elif os
.path
.exists(blib_src
):
76 shutil
.rmtree(blib_src
)
79 def ADD_INIT_FUNCTION(bld
, subsystem
, target
, init_function
):
80 '''add an init_function to the list for a subsystem'''
81 if init_function
is None:
83 bld
.ASSERT(subsystem
is not None, "You must specify a subsystem for init_function '%s'" % init_function
)
84 cache
= LOCAL_CACHE(bld
, 'INIT_FUNCTIONS')
85 if not subsystem
in cache
:
87 cache
[subsystem
].append( { 'TARGET':target
, 'INIT_FUNCTION':init_function
} )
88 Build
.BuildContext
.ADD_INIT_FUNCTION
= ADD_INIT_FUNCTION
92 #################################################################
93 def SAMBA_LIBRARY(bld
, libname
, source
,
102 external_library
=False,
112 target_type
='LIBRARY',
113 bundled_extension
=True,
120 '''define a Samba library'''
123 SET_TARGET_TYPE(bld
, libname
, 'DISABLED')
126 source
= bld
.EXPAND_VARIABLES(source
, vars=vars)
128 # remember empty libraries, so we can strip the dependencies
129 if ((source
== '') or (source
== [])) and deps
== '' and public_deps
== '':
130 SET_TARGET_TYPE(bld
, libname
, 'EMPTY')
133 if target_type
!= 'PYTHON' and BUILTIN_LIBRARY(bld
, libname
):
136 obj_target
= libname
+ '.objlist'
138 # first create a target for building the object files for this library
139 # by separating in this way, we avoid recompiling the C files
140 # separately for the install library and the build library
141 bld
.SAMBA_SUBSYSTEM(obj_target
,
144 public_deps
= public_deps
,
146 public_headers
= public_headers
,
147 header_path
= header_path
,
150 autoproto
= autoproto
,
151 depends_on
= depends_on
,
152 needs_python
= needs_python
,
153 hide_symbols
= hide_symbols
,
154 local_include
= local_include
)
156 if libname
== obj_target
:
159 if not SET_TARGET_TYPE(bld
, libname
, target_type
):
162 # the library itself will depend on that object target
163 deps
+= ' ' + public_deps
165 deps
.append(obj_target
)
167 if target_type
== 'PYTHON' or realname
or not is_bundled
:
168 # Sanitize the library name
169 bundled_name
= libname
.lower().replace('_', '-')
170 while bundled_name
.startswith("lib"):
171 bundled_name
= bundled_name
[3:]
173 bundled_name
= BUNDLED_NAME(bld
, libname
, bundled_extension
)
175 features
= 'cc cshlib symlink_lib install_lib'
176 if target_type
== 'PYTHON':
179 features
+= ' pyembed'
181 features
+= ' abi_check'
184 abi_file
= os
.path
.join(bld
.curdir
, abi_file
)
186 bld
.SET_BUILD_GROUP(group
)
190 target
= bundled_name
,
191 samba_cflags
= CURRENT_CFLAGS(bld
, libname
, cflags
),
192 depends_on
= depends_on
,
194 samba_includes
= includes
,
195 local_include
= local_include
,
198 samba_inst_path
= install_path
,
200 samba_realname
= realname
,
201 samba_install
= install
,
203 abi_match
= abi_match
206 if realname
and not link_name
:
207 link_name
= 'shared/%s' % realname
210 t
.link_name
= link_name
212 if pc_files
is not None:
213 bld
.PKG_CONFIG_FILES(pc_files
, vnum
=vnum
)
215 Build
.BuildContext
.SAMBA_LIBRARY
= SAMBA_LIBRARY
218 #################################################################
219 def SAMBA_BINARY(bld
, binname
, source
,
229 use_global_deps
=True,
240 '''define a Samba binary'''
243 SET_TARGET_TYPE(bld
, binname
, 'DISABLED')
246 if not SET_TARGET_TYPE(bld
, binname
, 'BINARY'):
249 features
= 'cc cprogram symlink_bin install_bin'
251 features
+= ' pyembed'
253 obj_target
= binname
+ '.objlist'
255 source
= bld
.EXPAND_VARIABLES(source
, vars=vars)
256 source
= unique_list(TO_LIST(source
))
258 # first create a target for building the object files for this binary
259 # by separating in this way, we avoid recompiling the C files
260 # separately for the install binary and the build binary
261 bld
.SAMBA_SUBSYSTEM(obj_target
,
267 autoproto
= autoproto
,
268 subsystem_name
= subsystem_name
,
269 needs_python
= needs_python
,
270 local_include
= local_include
,
271 use_hostcc
= use_hostcc
,
272 use_global_deps
= use_global_deps
)
274 bld
.SET_BUILD_GROUP(group
)
276 # the binary itself will depend on that object target
278 deps
.append(obj_target
)
284 samba_cflags
= CURRENT_CFLAGS(bld
, binname
, cflags
),
286 samba_includes
= includes
,
287 local_include
= local_include
,
288 samba_modules
= modules
,
290 samba_subsystem
= subsystem_name
,
292 samba_inst_path
= install_path
,
293 samba_install
= install
296 # setup the subsystem_name as an alias for the real
297 # binary name, so it can be found when expanding
298 # subsystem dependencies
299 if subsystem_name
is not None:
300 bld
.TARGET_ALIAS(subsystem_name
, binname
)
302 if manpages
is not None and 'XSLTPROC' in bld
.env
:
303 bld
.env
.MAN_XSL
= 'http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl'
304 for m
in manpages
.split():
306 bld
.SAMBA_GENERATOR(m
,
309 rule
='${XSLTPROC} -o ${TGT} ${MAN_XSL} ${SRC}'
311 bld
.INSTALL_FILES('${MANDIR}/man%s' % m
[-1], m
, flat
=True)
313 Build
.BuildContext
.SAMBA_BINARY
= SAMBA_BINARY
316 #################################################################
317 def SAMBA_MODULE(bld
, modname
, source
,
323 autoproto_extra_source
='',
326 internal_module
=True,
330 '''define a Samba module.'''
332 # we add the init function regardless of whether the module
333 # is enabled or not, as we need to generate a null list if
335 bld
.ADD_INIT_FUNCTION(subsystem
, modname
, init_function
)
337 if internal_module
or BUILTIN_LIBRARY(bld
, modname
):
338 # treat internal modules as subsystems for now
339 SAMBA_SUBSYSTEM(bld
, modname
, source
,
343 autoproto_extra_source
=autoproto_extra_source
,
345 local_include
=local_include
,
350 SET_TARGET_TYPE(bld
, modname
, 'DISABLED')
353 source
= bld
.EXPAND_VARIABLES(source
, vars=vars)
354 source
= unique_list(TO_LIST(source
))
356 # remember empty modules, so we can strip the dependencies
357 if ((source
== '') or (source
== [])) and deps
== '' and public_deps
== '':
358 SET_TARGET_TYPE(bld
, modname
, 'EMPTY')
361 if not SET_TARGET_TYPE(bld
, modname
, 'MODULE'):
364 if subsystem
is not None:
365 deps
+= ' ' + subsystem
367 bld
.SET_BUILD_GROUP('main')
372 samba_cflags
= CURRENT_CFLAGS(bld
, modname
, cflags
),
373 samba_includes
= includes
,
374 local_include
= local_include
,
375 samba_deps
= TO_LIST(deps
)
378 if autoproto
is not None:
379 bld
.SAMBA_AUTOPROTO(autoproto
, source
+ TO_LIST(autoproto_extra_source
))
381 Build
.BuildContext
.SAMBA_MODULE
= SAMBA_MODULE
384 #################################################################
385 def SAMBA_SUBSYSTEM(bld
, modname
, source
,
394 init_function_sentinal
=None,
395 heimdal_autoproto
=None,
396 heimdal_autoproto_options
=None,
397 heimdal_autoproto_private
=None,
399 autoproto_extra_source
='',
402 local_include_first
=True,
406 use_global_deps
=True,
410 '''define a Samba subsystem'''
413 SET_TARGET_TYPE(bld
, modname
, 'DISABLED')
416 # remember empty subsystems, so we can strip the dependencies
417 if ((source
== '') or (source
== [])) and deps
== '' and public_deps
== '':
418 SET_TARGET_TYPE(bld
, modname
, 'EMPTY')
421 if not SET_TARGET_TYPE(bld
, modname
, 'SUBSYSTEM'):
424 source
= bld
.EXPAND_VARIABLES(source
, vars=vars)
425 source
= unique_list(TO_LIST(source
))
427 deps
+= ' ' + public_deps
429 bld
.SET_BUILD_GROUP(group
)
439 samba_cflags
= CURRENT_CFLAGS(bld
, modname
, cflags
, hide_symbols
=hide_symbols
),
440 depends_on
= depends_on
,
441 samba_deps
= TO_LIST(deps
),
442 samba_includes
= includes
,
443 local_include
= local_include
,
444 local_include_first
= local_include_first
,
445 samba_subsystem
= subsystem_name
,
446 samba_use_hostcc
= use_hostcc
,
447 samba_use_global_deps
= use_global_deps
450 if cflags_end
is not None:
451 t
.samba_cflags
.extend(TO_LIST(cflags_end
))
453 if heimdal_autoproto
is not None:
454 bld
.HEIMDAL_AUTOPROTO(heimdal_autoproto
, source
, options
=heimdal_autoproto_options
)
455 if heimdal_autoproto_private
is not None:
456 bld
.HEIMDAL_AUTOPROTO_PRIVATE(heimdal_autoproto_private
, source
)
457 if autoproto
is not None:
458 bld
.SAMBA_AUTOPROTO(autoproto
, source
+ TO_LIST(autoproto_extra_source
))
459 if public_headers
is not None:
460 bld
.PUBLIC_HEADERS(public_headers
, header_path
=header_path
)
464 Build
.BuildContext
.SAMBA_SUBSYSTEM
= SAMBA_SUBSYSTEM
467 def SAMBA_GENERATOR(bld
, name
, rule
, source
='', target
='',
468 group
='generators', enabled
=True,
472 '''A generic source generator target'''
474 if not SET_TARGET_TYPE(bld
, name
, 'GENERATOR'):
480 bld
.SET_BUILD_GROUP(group
)
483 source
=bld
.EXPAND_VARIABLES(source
, vars=vars),
485 shell
=isinstance(rule
, str),
491 if public_headers
is not None:
492 bld
.PUBLIC_HEADERS(public_headers
, header_path
=header_path
)
494 Build
.BuildContext
.SAMBA_GENERATOR
= SAMBA_GENERATOR
499 def SETUP_BUILD_GROUPS(bld
):
500 '''setup build groups used to ensure that the different build
501 phases happen consecutively'''
502 bld
.p_ln
= bld
.srcnode
# we do want to see all targets!
503 bld
.env
['USING_BUILD_GROUPS'] = True
504 bld
.add_group('setup')
505 bld
.add_group('build_compiler_source')
506 bld
.add_group('base_libraries')
507 bld
.add_group('generators')
508 bld
.add_group('compiler_prototypes')
509 bld
.add_group('compiler_libraries')
510 bld
.add_group('build_compilers')
511 bld
.add_group('build_source')
512 bld
.add_group('prototypes')
513 bld
.add_group('main')
514 bld
.add_group('binaries')
515 bld
.add_group('final')
516 Build
.BuildContext
.SETUP_BUILD_GROUPS
= SETUP_BUILD_GROUPS
519 def SET_BUILD_GROUP(bld
, group
):
520 '''set the current build group'''
521 if not 'USING_BUILD_GROUPS' in bld
.env
:
524 Build
.BuildContext
.SET_BUILD_GROUP
= SET_BUILD_GROUP
529 def ENABLE_TIMESTAMP_DEPENDENCIES(conf
):
530 """use timestamps instead of file contents for deps
531 this currently doesn't work"""
532 def h_file(filename
):
534 st
= os
.stat(filename
)
535 if stat
.S_ISDIR(st
[stat
.ST_MODE
]): raise IOError('not a file')
537 m
.update(str(st
.st_mtime
))
538 m
.update(str(st
.st_size
))
541 Utils
.h_file
= h_file
545 t
= Task
.simple_task_type('copy_script', 'rm -f ${LINK_TARGET} && ln -s ${SRC[0].abspath(env)} ${LINK_TARGET}',
546 shell
=True, color
='PINK', ext_in
='.bin')
549 @feature('copy_script')
550 @before('apply_link')
551 def copy_script(self
):
552 tsk
= self
.create_task('copy_script', self
.allnodes
[0])
553 tsk
.env
.TARGET
= self
.target
555 def SAMBA_SCRIPT(bld
, name
, pattern
, installdir
, installname
=None):
556 '''used to copy scripts from the source tree into the build directory
557 for use by selftest'''
559 source
= bld
.path
.ant_glob(pattern
)
561 bld
.SET_BUILD_GROUP('build_source')
562 for s
in TO_LIST(source
):
564 if installname
!= None:
566 target
= os
.path
.join(installdir
, iname
)
567 tgtdir
= os
.path
.dirname(os
.path
.join(bld
.srcnode
.abspath(bld
.env
), '..', target
))
569 t
= bld(features
='copy_script',
574 t
.env
.LINK_TARGET
= target
576 Build
.BuildContext
.SAMBA_SCRIPT
= SAMBA_SCRIPT
579 def install_file(bld
, destdir
, file, chmod
=O644
, flat
=False,
580 python_fixup
=False, destname
=None, base_name
=None):
582 destdir
= bld
.EXPAND_VARIABLES(destdir
)
586 destname
= os
.path
.basename(destname
)
587 dest
= os
.path
.join(destdir
, destname
)
589 # fixup the python path it will use to find Samba modules
590 inst_file
= file + '.inst'
591 bld
.SAMBA_GENERATOR('python_%s' % destname
,
592 rule
="sed 's|\(sys.path.insert.*\)bin/python\(.*\)$|\\1${PYTHONDIR}\\2|g' < ${SRC} > ${TGT}",
597 file = os
.path
.join(base_name
, file)
598 bld
.install_as(dest
, file, chmod
=chmod
)
601 def INSTALL_FILES(bld
, destdir
, files
, chmod
=O644
, flat
=False,
602 python_fixup
=False, destname
=None, base_name
=None):
603 '''install a set of files'''
604 for f
in TO_LIST(files
):
605 install_file(bld
, destdir
, f
, chmod
=chmod
, flat
=flat
,
606 python_fixup
=python_fixup
, destname
=destname
,
608 Build
.BuildContext
.INSTALL_FILES
= INSTALL_FILES
611 def INSTALL_WILDCARD(bld
, destdir
, pattern
, chmod
=O644
, flat
=False,
612 python_fixup
=False, exclude
=None, trim_path
=None):
613 '''install a set of files matching a wildcard pattern'''
614 files
=TO_LIST(bld
.path
.ant_glob(pattern
))
618 files2
.append(os_path_relpath(f
, trim_path
))
623 if fnmatch
.fnmatch(f
, exclude
):
625 INSTALL_FILES(bld
, destdir
, files
, chmod
=chmod
, flat
=flat
,
626 python_fixup
=python_fixup
, base_name
=trim_path
)
627 Build
.BuildContext
.INSTALL_WILDCARD
= INSTALL_WILDCARD
630 def INSTALL_DIRS(bld
, destdir
, dirs
):
631 '''install a set of directories'''
632 destdir
= bld
.EXPAND_VARIABLES(destdir
)
633 dirs
= bld
.EXPAND_VARIABLES(dirs
)
634 for d
in TO_LIST(dirs
):
635 bld
.install_dir(os
.path
.join(destdir
, d
))
636 Build
.BuildContext
.INSTALL_DIRS
= INSTALL_DIRS
639 re_header
= re
.compile('#include[ \t]*"([^"]+)"', re
.I | re
.M
)
640 class header_task(Task
.Task
):
643 vars = ['INCLUDEDIR', 'HEADER_DEPS']
645 txt
= self
.inputs
[0].read(self
.env
)
647 txt
= txt
.replace('#if _SAMBA_BUILD_ == 4', '#if 1\n')
649 themap
= self
.generator
.bld
.subst_table
653 return "#include <%s>" % themap
.get(s
, s
)
656 txt
= re_header
.sub(repl
, txt
)
660 f
= open(self
.outputs
[0].abspath(self
.env
), 'w')
668 initialize the header substitution table
669 for now use the file headermap.txt but in the future we will compute the paths properly
672 if getattr(bld
, 'subst_table', None):
673 return bld
.subst_table_h
675 node
= bld
.srcnode
.find_resource("source4/headermap.txt")
678 bld
.subst_table_h
= 0
680 lines
= node
.read(None)
682 lines
= [x
.strip().split(': ') for x
in lines
.split('\n') if x
.rfind(': ') > -1]
683 bld
.subst_table
= dict(lines
)
685 # pidl file replacement (all of this is temporary, one step at a time)
686 keyz
= list(bld
.subst_table
.keys())
688 bld
.subst_table
['bin/default/' + k
] = bld
.subst_table
[k
]
690 tp
= tuple(bld
.subst_table
.keys())
691 bld
.subst_table_h
= hash(tp
)
692 return bld
.subst_table_h
694 @TaskGen.feature('pubh')
695 def make_public_headers(self
):
696 if not self
.bld
.is_install
:
697 # install time only (lazy)
700 self
.env
['HEADER_DEPS'] = init_subst(self
.bld
)
701 # adds a dependency and trigger a rebuild if the dict changes
703 header_path
= getattr(self
, 'header_path', None) or ''
705 for x
in self
.to_list(self
.headers
):
707 # too complicated, but what was the original idea?
708 if isinstance(header_path
, list):
710 for (p1
, dir) in header_path
:
711 lst
= self
.to_list(p1
)
713 if fnmatch
.fnmatch(x
, p2
):
721 inst_path
= header_path
725 if x
.find(':') != -1:
730 inn
= self
.path
.find_resource(name
)
732 raise ValueError("could not find the public header %r in %r" % (name
, self
.path
))
733 out
= inn
.change_ext('.inst.h')
734 self
.create_task('header', inn
, out
)
740 inst_path
= inst_path
+ '/'
741 inst_path
= inst_path
+ dest
743 #print("going to install the headers", inst_path, out)
744 self
.bld
.install_as('${INCLUDEDIR}/%s' % inst_path
, out
, self
.env
)
746 def PUBLIC_HEADERS(bld
, public_headers
, header_path
=None):
747 '''install some headers
749 header_path may either be a string that is added to the INCLUDEDIR,
750 or it can be a dictionary of wildcard patterns which map to destination
751 directories relative to INCLUDEDIR
753 bld
.SET_BUILD_GROUP('final')
754 ret
= bld(features
=['pubh'], headers
=public_headers
, header_path
=header_path
)
756 Build
.BuildContext
.PUBLIC_HEADERS
= PUBLIC_HEADERS
759 def subst_at_vars(task
):
760 '''substiture @VAR@ style variables in a file'''
761 src
= task
.inputs
[0].srcpath(task
.env
)
762 tgt
= task
.outputs
[0].bldpath(task
.env
)
768 a
= re
.split('(@\w+@)', s
)
771 back_sub
= [ ('PREFIX', '${prefix}'), ('EXEC_PREFIX', '${exec_prefix}')]
773 if re
.match('@\w+@', v
):
775 if not vname
in task
.env
and vname
.upper() in task
.env
:
776 vname
= vname
.upper()
777 if not vname
in task
.env
:
778 Logs
.error("Unknown substitution %s in %s" % (v
, task
.name
))
780 v
= SUBST_VARS_RECURSIVE(task
.env
[vname
], task
.env
)
781 # now we back substitute the allowed pc vars
782 for (b
, m
) in back_sub
:
785 if not b
in done_var
:
786 # we don't want to substitute the first usage
792 contents
= ''.join(out
)
794 s
= f
.write(contents
)
800 def PKG_CONFIG_FILES(bld
, pc_files
, vnum
=None):
801 '''install some pkg_config pc files'''
802 dest
= '${PKGCONFIGDIR}'
803 dest
= bld
.EXPAND_VARIABLES(dest
)
804 for f
in TO_LIST(pc_files
):
805 base
=os
.path
.basename(f
)
806 t
= bld
.SAMBA_GENERATOR('PKGCONFIG_%s' % base
,
811 t
.env
.PACKAGE_VERSION
= vnum
812 INSTALL_FILES(bld
, dest
, f
, flat
=True, destname
=base
)
813 Build
.BuildContext
.PKG_CONFIG_FILES
= PKG_CONFIG_FILES
817 #############################################################
818 # give a nicer display when building different types of files
819 def progress_display(self
, msg
, fname
):
820 col1
= Logs
.colors(self
.color
)
821 col2
= Logs
.colors
.NORMAL
822 total
= self
.position
[1]
824 fs
= '[%%%dd/%%%dd] %s %%s%%s%%s\n' % (n
, n
, msg
)
825 return fs
% (self
.position
[0], self
.position
[1], col1
, fname
, col2
)
827 def link_display(self
):
828 if Options
.options
.progress_bar
!= 0:
829 return Task
.Task
.old_display(self
)
830 fname
= self
.outputs
[0].bldpath(self
.env
)
831 return progress_display(self
, 'Linking', fname
)
832 Task
.TaskBase
.classes
['cc_link'].display
= link_display
834 def samba_display(self
):
835 if Options
.options
.progress_bar
!= 0:
836 return Task
.Task
.old_display(self
)
838 targets
= LOCAL_CACHE(self
, 'TARGET_TYPE')
839 if self
.name
in targets
:
840 target_type
= targets
[self
.name
]
841 type_map
= { 'GENERATOR' : 'Generating',
842 'PROTOTYPE' : 'Generating'
844 if target_type
in type_map
:
845 return progress_display(self
, type_map
[target_type
], self
.name
)
847 fname
= self
.inputs
[0].bldpath(self
.env
)
848 if fname
[0:3] == '../':
850 ext_loc
= fname
.rfind('.')
852 return Task
.Task
.old_display(self
)
853 ext
= fname
[ext_loc
:]
855 ext_map
= { '.idl' : 'Compiling IDL',
856 '.et' : 'Compiling ERRTABLE',
857 '.asn1': 'Compiling ASN1',
860 return progress_display(self
, ext_map
[ext
], fname
)
861 return Task
.Task
.old_display(self
)
863 Task
.TaskBase
.classes
['Task'].old_display
= Task
.TaskBase
.classes
['Task'].display
864 Task
.TaskBase
.classes
['Task'].display
= samba_display