1 # a waf tool to add autoconf-like macros to the configure section
4 import Build, Options, preproc, Logs
5 from Configure import conf
6 from TaskGen import feature
7 from samba_utils import TO_LIST, GET_TARGET_TYPE, SET_TARGET_TYPE, runonce, unique_list, mkdir_p
9 missing_headers = set()
11 ####################################################
12 # some autoconf like helpers, to make the transition
13 # to waf a bit easier for those used to autoconf
18 def DEFINE(conf, d, v, add_to_cflags=False, quote=False):
19 '''define a config option'''
20 conf.define(d, v, quote=quote)
22 conf.env.append_value('CCDEFINES', d + '=' + str(v))
24 def hlist_to_string(conf, headers=None):
25 '''convert a headers list to a set of #include lines'''
27 hlist = conf.env.hlist
30 hlist.extend(TO_LIST(headers))
32 hdrs += '#include <%s>\n' % h
37 def COMPOUND_START(conf, msg):
38 '''start a compound test'''
39 def null_check_message_1(self,*k,**kw):
41 def null_check_message_2(self,*k,**kw):
44 v = getattr(conf.env, 'in_compound', [])
45 if v != [] and v != 0:
46 conf.env.in_compound = v + 1
48 conf.check_message_1(msg)
49 conf.saved_check_message_1 = conf.check_message_1
50 conf.check_message_1 = null_check_message_1
51 conf.saved_check_message_2 = conf.check_message_2
52 conf.check_message_2 = null_check_message_2
53 conf.env.in_compound = 1
57 def COMPOUND_END(conf, result):
58 '''start a compound test'''
59 conf.env.in_compound -= 1
60 if conf.env.in_compound != 0:
62 conf.check_message_1 = conf.saved_check_message_1
63 conf.check_message_2 = conf.saved_check_message_2
64 p = conf.check_message_2
68 p('not found', 'YELLOW')
75 '''using the nolink type in conf.check() allows us to avoid
76 the link stage of a test, thus speeding it up for tests
77 that where linking is not needed'''
81 def CHECK_HEADER(conf, h, add_headers=False, lib=None):
82 '''check for a header'''
83 if h in missing_headers and lib is None:
85 d = h.upper().replace('/', '_')
86 d = d.replace('.', '_')
87 d = d.replace('-', '_')
89 if CONFIG_SET(conf, d):
91 if not h in conf.env.hlist:
92 conf.env.hlist.append(h)
95 (ccflags, ldflags, cpppath) = library_flags(conf, lib)
97 hdrs = hlist_to_string(conf, headers=h)
100 ret = conf.check(fragment='%s\nint main(void) { return 0; }' % hdrs,
106 msg="Checking for header %s" % h)
108 missing_headers.add(h)
112 if add_headers and not h in conf.env.hlist:
113 conf.env.hlist.append(h)
118 def CHECK_HEADERS(conf, headers, add_headers=False, together=False, lib=None):
119 '''check for a list of headers
121 when together==True, then the headers accumulate within this test.
122 This is useful for interdependent headers
125 if not add_headers and together:
126 saved_hlist = conf.env.hlist[:]
127 set_add_headers = True
129 set_add_headers = add_headers
130 for hdr in TO_LIST(headers):
131 if not CHECK_HEADER(conf, hdr, set_add_headers, lib=lib):
133 if not add_headers and together:
134 conf.env.hlist = saved_hlist
138 def header_list(conf, headers=None, lib=None):
139 '''form a list of headers which exist, as a string'''
141 if headers is not None:
142 for h in TO_LIST(headers):
143 if CHECK_HEADER(conf, h, add_headers=False, lib=lib):
145 return hlist_to_string(conf, headers=hlist)
149 def CHECK_TYPE(conf, t, alternate=None, headers=None, define=None, lib=None, msg=None):
150 '''check for a single type'''
152 define = 'HAVE_' + t.upper().replace(' ', '_')
154 msg='Checking for %s' % t
155 ret = CHECK_CODE(conf, '%s _x' % t,
163 if not ret and alternate:
164 conf.DEFINE(t, alternate)
169 def CHECK_TYPES(conf, list, headers=None, define=None, alternate=None, lib=None):
170 '''check for a list of types'''
172 for t in TO_LIST(list):
173 if not CHECK_TYPE(conf, t, headers=headers,
174 define=define, alternate=alternate, lib=lib):
180 def CHECK_TYPE_IN(conf, t, headers=None, alternate=None, define=None):
181 '''check for a single type with a header'''
182 return CHECK_TYPE(conf, t, headers=headers, alternate=alternate, define=define)
186 def CHECK_VARIABLE(conf, v, define=None, always=False,
187 headers=None, msg=None, lib=None):
188 '''check for a variable declaration (or define)'''
190 define = 'HAVE_%s' % v.upper()
193 msg="Checking for variable %s" % v
195 return CHECK_CODE(conf,
196 # we need to make sure the compiler doesn't
200 void *_x; _x=(void *)&%s; return (int)_x;
215 def CHECK_DECLS(conf, vars, reverse=False, headers=None, always=False):
216 '''check a list of variable declarations, using the HAVE_DECL_xxx form
219 When reverse==True then use HAVE_xxx_DECL instead of HAVE_DECL_xxx
222 for v in TO_LIST(vars):
224 define='HAVE_DECL_%s' % v.upper()
226 define='HAVE_%s_DECL' % v.upper()
227 if not CHECK_VARIABLE(conf, v,
230 msg='Checking for declaration of %s' % v,
232 if not CHECK_CODE(conf,
238 msg='Checking for declaration of %s (as enum)' % v,
247 def CHECK_FUNC(conf, f, link=True, lib=None, headers=None):
248 '''check for a function'''
249 define='HAVE_%s' % f.upper()
253 conf.COMPOUND_START('Checking for %s' % f)
255 if link is None or link:
256 ret = CHECK_CODE(conf,
257 # this is based on the autoconf strategy
259 #define %s __fake__%s
266 #if defined __stub_%s || defined __stub___%s
267 #error "bad glibc stub"
270 int main() { return %s(); }
271 ''' % (f, f, f, f, f, f, f),
280 msg='Checking for %s' % f)
283 ret = CHECK_CODE(conf,
284 # it might be a macro
285 # we need to make sure the compiler doesn't
287 'void *__x = (void *)%s; return (int)__x' % f,
296 msg='Checking for macro %s' % f)
298 if not ret and (link is None or not link):
299 ret = CHECK_VARIABLE(conf, f,
302 msg='Checking for declaration of %s' % f)
303 conf.COMPOUND_END(ret)
308 def CHECK_FUNCS(conf, list, link=True, lib=None, headers=None):
309 '''check for a list of functions'''
311 for f in TO_LIST(list):
312 if not CHECK_FUNC(conf, f, link=link, lib=lib, headers=headers):
318 def CHECK_SIZEOF(conf, vars, headers=None, define=None, critical=True):
319 '''check the size of a type'''
320 for v in TO_LIST(vars):
324 v_define = 'SIZEOF_%s' % v.upper().replace(' ', '_')
325 for size in list((1, 2, 4, 8, 16, 32)):
327 'static int test_array[1 - 2 * !(((long int)(sizeof(%s))) <= %d)];' % (v, size),
332 msg="Checking if size of %s == %d" % (v, size)):
333 conf.DEFINE(v_define, size)
336 if not ret and critical:
337 Logs.error("Couldn't determine size of '%s'" % v)
342 def CHECK_VALUEOF(conf, v, headers=None, define=None):
343 '''check the value of a variable/define'''
347 v_define = 'VALUEOF_%s' % v.upper().replace(' ', '_')
349 'printf("%%u", (unsigned)(%s))' % v,
356 msg="Checking value of %s" % v):
357 return int(conf.env[v_define])
362 def CHECK_CODE(conf, code, define,
363 always=False, execute=False, addmain=True,
364 add_headers=True, mandatory=False,
365 headers=None, msg=None, cflags='', includes='# .',
366 local_include=True, lib=None, link=True,
367 define_ret=False, quote=False,
369 '''check if some code compiles and/or runs'''
371 if CONFIG_SET(conf, define):
374 if headers is not None:
375 CHECK_HEADERS(conf, headers=headers, lib=lib)
378 hdrs = header_list(conf, headers=headers, lib=lib)
386 defs = conf.get_config_header()
389 fragment='%s\n%s\n int main(void) { %s; return 0; }\n' % (defs, hdrs, code)
391 fragment='%s\n%s\n%s\n' % (defs, hdrs, code)
394 msg="Checking for %s" % define
396 cflags = TO_LIST(cflags)
399 cflags.append('-I%s' % conf.curdir)
406 uselib = TO_LIST(lib)
408 (ccflags, ldflags, cpppath) = library_flags(conf, uselib)
410 includes = TO_LIST(includes)
411 includes.extend(cpppath)
413 uselib = [l.upper() for l in uselib]
415 cflags.extend(ccflags)
418 exec_args = conf.SAMBA_CROSS_ARGS(msg=msg)
422 conf.COMPOUND_START(msg)
424 ret = conf.check(fragment=fragment,
426 define_name = define,
427 mandatory = mandatory,
436 define_ret=define_ret)
437 if not ret and CONFIG_SET(conf, define):
438 # sometimes conf.check() returns false, but it
439 # sets the define. Maybe a waf bug?
443 conf.DEFINE(define, 1)
444 conf.COMPOUND_END(True)
446 conf.COMPOUND_END(conf.env[define])
449 conf.DEFINE(define, 0)
450 conf.COMPOUND_END(False)
456 def CHECK_STRUCTURE_MEMBER(conf, structname, member,
457 always=False, define=None, headers=None):
458 '''check for a structure member'''
460 define = 'HAVE_%s' % member.upper()
461 return CHECK_CODE(conf,
462 '%s s; void *_x; _x=(void *)&s.%s' % (structname, member),
469 msg="Checking for member %s in %s" % (member, structname))
473 def CHECK_CFLAGS(conf, cflags, fragment='int main(void) { return 0; }\n'):
474 '''check if the given cflags are accepted by the compiler
476 return conf.check(fragment=fragment,
480 msg="Checking compiler accepts %s" % cflags)
483 def CHECK_LDFLAGS(conf, ldflags):
484 '''check if the given ldflags are accepted by the linker
486 return conf.check(fragment='int main(void) { return 0; }\n',
489 msg="Checking linker accepts %s" % ldflags)
493 def CONFIG_GET(conf, option):
494 '''return True if a configuration option was found'''
495 if (option in conf.env):
496 return conf.env[option]
501 def CONFIG_SET(conf, option):
502 '''return True if a configuration option was found'''
503 if option not in conf.env:
515 def CONFIG_RESET(conf, option):
516 if option not in conf.env:
520 Build.BuildContext.CONFIG_RESET = CONFIG_RESET
521 Build.BuildContext.CONFIG_SET = CONFIG_SET
522 Build.BuildContext.CONFIG_GET = CONFIG_GET
525 def library_flags(self, libs):
526 '''work out flags from pkg_config'''
530 for lib in TO_LIST(libs):
531 # note that we do not add the -I and -L in here, as that is added by the waf
532 # core. Adding it here would just change the order that it is put on the link line
533 # which can cause system paths to be added before internal libraries
534 extra_ccflags = TO_LIST(getattr(self.env, 'CCFLAGS_%s' % lib.upper(), []))
535 extra_ldflags = TO_LIST(getattr(self.env, 'LDFLAGS_%s' % lib.upper(), []))
536 extra_cpppath = TO_LIST(getattr(self.env, 'CPPPATH_%s' % lib.upper(), []))
537 ccflags.extend(extra_ccflags)
538 ldflags.extend(extra_ldflags)
539 cpppath.extend(extra_cpppath)
540 if 'EXTRA_LDFLAGS' in self.env:
541 ldflags.extend(self.env['EXTRA_LDFLAGS'])
543 ccflags = unique_list(ccflags)
544 ldflags = unique_list(ldflags)
545 cpppath = unique_list(cpppath)
546 return (ccflags, ldflags, cpppath)
550 def CHECK_LIB(conf, libs, mandatory=False, empty_decl=True, set_target=True, shlib=False):
551 '''check if a set of libraries exist as system libraries
553 returns the sublist of libs that do exist as a syslib or []
564 liblist = TO_LIST(libs)
565 for lib in liblist[:]:
566 if GET_TARGET_TYPE(conf, lib) == 'SYSLIB':
570 (ccflags, ldflags, cpppath) = library_flags(conf, lib)
572 res = conf.check(features='c cshlib', fragment=fragment, lib=lib, uselib_store=lib, ccflags=ccflags, ldflags=ldflags, uselib=lib.upper())
574 res = conf.check(lib=lib, uselib_store=lib, ccflags=ccflags, ldflags=ldflags, uselib=lib.upper())
578 Logs.error("Mandatory library '%s' not found for functions '%s'" % (lib, list))
581 # if it isn't a mandatory library, then remove it from dependency lists
583 SET_TARGET_TYPE(conf, lib, 'EMPTY')
585 conf.define('HAVE_LIB%s' % lib.upper().replace('-','_').replace('.','_'), 1)
586 conf.env['LIB_' + lib.upper()] = lib
588 conf.SET_TARGET_TYPE(lib, 'SYSLIB')
596 def CHECK_FUNCS_IN(conf, list, library, mandatory=False, checklibc=False,
597 headers=None, link=True, empty_decl=True, set_target=True):
599 check that the functions in 'list' are available in 'library'
600 if they are, then make that library available as a dependency
602 if the library is not available and mandatory==True, then
605 If the library is not available and mandatory==False, then
606 add the library to the list of dependencies to remove from
609 optionally check for the functions first in libc
611 remaining = TO_LIST(list)
612 liblist = TO_LIST(library)
614 # check if some already found
615 for f in remaining[:]:
616 if CONFIG_SET(conf, 'HAVE_%s' % f.upper()):
619 # see if the functions are in libc
621 for f in remaining[:]:
622 if CHECK_FUNC(conf, f, link=True, headers=headers):
627 if GET_TARGET_TYPE(conf, lib) != 'SYSLIB' and empty_decl:
628 SET_TARGET_TYPE(conf, lib, 'EMPTY')
631 checklist = conf.CHECK_LIB(liblist, empty_decl=empty_decl, set_target=set_target)
632 for lib in liblist[:]:
633 if not lib in checklist and mandatory:
634 Logs.error("Mandatory library '%s' not found for functions '%s'" % (lib, list))
639 if not CHECK_FUNC(conf, f, lib=' '.join(checklist), headers=headers, link=link):
646 def IN_LAUNCH_DIR(conf):
647 '''return True if this rule is being run from the launch directory'''
648 return os.path.realpath(conf.curdir) == os.path.realpath(Options.launch_dir)
649 Options.Handler.IN_LAUNCH_DIR = IN_LAUNCH_DIR
653 def SAMBA_CONFIG_H(conf, path=None):
654 '''write out config.h in the right directory'''
655 # we don't want to produce a config.h in places like lib/replace
656 # when we are building projects that depend on lib/replace
657 if not IN_LAUNCH_DIR(conf):
660 # we need to build real code that can't be optimized away to test
661 if conf.check(fragment='''
667 while (fgets(t, sizeof(t), stdin));
672 ccflags='-fstack-protector',
673 ldflags='-fstack-protector',
674 msg='Checking if toolchain accepts -fstack-protector'):
675 conf.ADD_CFLAGS('-fstack-protector')
676 conf.ADD_LDFLAGS('-fstack-protector')
678 if Options.options.debug:
679 conf.ADD_CFLAGS('-g', testflags=True)
681 if Options.options.developer:
682 conf.env.DEVELOPER_MODE = True
684 conf.ADD_CFLAGS('-g', testflags=True)
685 conf.ADD_CFLAGS('-Wall', testflags=True)
686 conf.ADD_CFLAGS('-Wshadow', testflags=True)
687 conf.ADD_CFLAGS('-Wmissing-prototypes', testflags=True)
688 conf.ADD_CFLAGS('-Wcast-align -Wcast-qual', testflags=True)
689 conf.ADD_CFLAGS('-fno-common', testflags=True)
691 conf.ADD_CFLAGS('-Werror=address', testflags=True)
692 # we add these here to ensure that -Wstrict-prototypes is not set during configure
693 conf.ADD_CFLAGS('-Werror=strict-prototypes -Wstrict-prototypes',
695 conf.ADD_CFLAGS('-Werror=write-strings -Wwrite-strings',
697 conf.ADD_CFLAGS('-Werror-implicit-function-declaration',
699 conf.ADD_CFLAGS('-Werror=pointer-arith -Wpointer-arith',
701 conf.ADD_CFLAGS('-Werror=declaration-after-statement -Wdeclaration-after-statement',
703 conf.ADD_CFLAGS('-Werror=return-type -Wreturn-type',
705 conf.ADD_CFLAGS('-Werror=uninitialized -Wuninitialized',
708 conf.ADD_CFLAGS('-Wformat=2 -Wno-format-y2k', testflags=True)
709 # This check is because for ldb_search(), a NULL format string
710 # is not an error, but some compilers complain about that.
711 if CHECK_CFLAGS(conf, ["-Werror=format", "-Wformat=2"], '''
712 int testformat(char *format, ...) __attribute__ ((format (__printf__, 1, 2)));
720 if not 'EXTRA_CFLAGS' in conf.env:
721 conf.env['EXTRA_CFLAGS'] = []
722 conf.env['EXTRA_CFLAGS'].extend(TO_LIST("-Werror=format"))
724 if Options.options.picky_developer:
725 conf.ADD_NAMED_CFLAGS('PICKY_CFLAGS', '-Werror -Wno-error=deprecated-declarations', testflags=True)
727 if Options.options.fatal_errors:
728 conf.ADD_CFLAGS('-Wfatal-errors', testflags=True)
730 if Options.options.pedantic:
731 conf.ADD_CFLAGS('-W', testflags=True)
733 if Options.options.address_sanitizer:
734 conf.ADD_CFLAGS('-fno-omit-frame-pointer -O1 -fsanitize=address', testflags=True)
735 conf.ADD_LDFLAGS('-fsanitize=address', testflags=True)
736 conf.env['ADDRESS_SANITIZER'] = True
739 # Let people pass an additional ADDITIONAL_{CFLAGS,LDFLAGS}
740 # environment variables which are only used the for final build.
742 # The CFLAGS and LDFLAGS environment variables are also
743 # used for the configure checks which might impact their results.
744 conf.add_os_flags('ADDITIONAL_CFLAGS')
745 if conf.env.ADDITIONAL_CFLAGS and conf.CHECK_CFLAGS(conf.env['ADDITIONAL_CFLAGS']):
746 conf.env['EXTRA_CFLAGS'].extend(conf.env['ADDITIONAL_CFLAGS'])
747 conf.add_os_flags('ADDITIONAL_LDFLAGS')
748 if conf.env.ADDITIONAL_LDFLAGS and conf.CHECK_LDFLAGS(conf.env['ADDITIONAL_LDFLAGS']):
749 conf.env['EXTRA_LDFLAGS'].extend(conf.env['ADDITIONAL_LDFLAGS'])
752 conf.write_config_header('config.h', top=True)
754 conf.write_config_header(path)
755 conf.SAMBA_CROSS_CHECK_COMPLETE()
759 def CONFIG_PATH(conf, name, default):
760 '''setup a configurable path'''
761 if not name in conf.env:
762 if default[0] == '/':
763 conf.env[name] = default
765 conf.env[name] = conf.env['PREFIX'] + default
768 def ADD_NAMED_CFLAGS(conf, name, flags, testflags=False):
769 '''add some CFLAGS to the command line
770 optionally set testflags to ensure all the flags work
774 for f in flags.split():
775 if CHECK_CFLAGS(conf, f):
778 if not name in conf.env:
780 conf.env[name].extend(TO_LIST(flags))
783 def ADD_CFLAGS(conf, flags, testflags=False):
784 '''add some CFLAGS to the command line
785 optionally set testflags to ensure all the flags work
787 ADD_NAMED_CFLAGS(conf, 'EXTRA_CFLAGS', flags, testflags=testflags)
790 def ADD_LDFLAGS(conf, flags, testflags=False):
791 '''add some LDFLAGS to the command line
792 optionally set testflags to ensure all the flags work
794 this will return the flags that are added, if any
798 for f in flags.split():
799 if CHECK_LDFLAGS(conf, f):
802 if not 'EXTRA_LDFLAGS' in conf.env:
803 conf.env['EXTRA_LDFLAGS'] = []
804 conf.env['EXTRA_LDFLAGS'].extend(TO_LIST(flags))
809 def ADD_EXTRA_INCLUDES(conf, includes):
810 '''add some extra include directories to all builds'''
811 if not 'EXTRA_INCLUDES' in conf.env:
812 conf.env['EXTRA_INCLUDES'] = []
813 conf.env['EXTRA_INCLUDES'].extend(TO_LIST(includes))
817 def CURRENT_CFLAGS(bld, target, cflags, allow_warnings=False, hide_symbols=False):
818 '''work out the current flags. local flags are added first'''
819 ret = TO_LIST(cflags)
820 if not 'EXTRA_CFLAGS' in bld.env:
823 list = bld.env['EXTRA_CFLAGS'];
825 if not allow_warnings and 'PICKY_CFLAGS' in bld.env:
826 list = bld.env['PICKY_CFLAGS'];
828 if hide_symbols and bld.env.HAVE_VISIBILITY_ATTR:
829 ret.append(bld.env.VISIBILITY_CFLAGS)
834 def CHECK_CC_ENV(conf):
835 """trim whitespaces from 'CC'.
836 The build farm sometimes puts a space at the start"""
837 if os.environ.get('CC'):
838 conf.env.CC = TO_LIST(os.environ.get('CC'))
839 if len(conf.env.CC) == 1:
840 # make for nicer logs if just a single command
841 conf.env.CC = conf.env.CC[0]
845 def SETUP_CONFIGURE_CACHE(conf, enable):
846 '''enable/disable cache of configure results'''
848 # when -C is chosen, we will use a private cache and will
849 # not look into system includes. This roughtly matches what
850 # autoconf does with -C
851 cache_path = os.path.join(conf.blddir, '.confcache')
853 Options.cache_global = os.environ['WAFCACHE'] = cache_path
855 # when -C is not chosen we will not cache configure checks
856 # We set the recursion limit low to prevent waf from spending
857 # a lot of time on the signatures of the files.
858 Options.cache_global = os.environ['WAFCACHE'] = ''
859 preproc.recursion_limit = 1
860 # in either case we don't need to scan system includes
861 preproc.go_absolute = False
865 def SAMBA_CHECK_UNDEFINED_SYMBOL_FLAGS(conf):
866 # we don't want any libraries or modules to rely on runtime
867 # resolution of symbols
868 if not sys.platform.startswith("openbsd"):
869 conf.env.undefined_ldflags = conf.ADD_LDFLAGS('-Wl,-no-undefined', testflags=True)
871 if not sys.platform.startswith("openbsd") and conf.env.undefined_ignore_ldflags == []:
872 if conf.CHECK_LDFLAGS(['-undefined', 'dynamic_lookup']):
873 conf.env.undefined_ignore_ldflags = ['-undefined', 'dynamic_lookup']
876 def CHECK_CFG(self, *k, **kw):
877 return self.check_cfg(*k, **kw)