build: added functions for compound configuration testing
[nivanova/samba-autobuild/.git] / buildtools / wafsamba / samba_autoconf.py
index 86f36a5f39425169b3e52fe4aa6f8ed4a1063b3d..4ee0852b75ac862f6720ceb481eb868ae702af43 100644 (file)
@@ -14,9 +14,9 @@ missing_headers = set()
 
 @runonce
 @conf
-def DEFINE(conf, d, v, add_to_cflags=False):
+def DEFINE(conf, d, v, add_to_cflags=False, quote=False):
     '''define a config option'''
-    conf.define(d, v, quote=False)
+    conf.define(d, v, quote=quote)
     if add_to_cflags:
         conf.env.append_value('CCDEFINES', d + '=' + str(v))
 
@@ -32,6 +32,43 @@ def hlist_to_string(conf, headers=None):
     return hdrs
 
 
+@conf
+def COMPOUND_START(conf, msg):
+    '''start a compound test'''
+    def null_check_message_1(self,*k,**kw):
+        return
+    def null_check_message_2(self,*k,**kw):
+        return
+
+    v = getattr(conf.env, 'in_compound', [])
+    if v != [] and v != 0:
+        conf.env.in_compound = v + 1
+        return
+    conf.check_message_1(msg)
+    conf.saved_check_message_1 = conf.check_message_1
+    conf.check_message_1 = null_check_message_1
+    conf.saved_check_message_2 = conf.check_message_2
+    conf.check_message_2 = null_check_message_2
+    conf.env.in_compound = 1
+
+
+@conf
+def COMPOUND_END(conf, result):
+    '''start a compound test'''
+    conf.env.in_compound -= 1
+    if conf.env.in_compound != 0:
+        return
+    conf.check_message_1 = conf.saved_check_message_1
+    conf.check_message_2 = conf.saved_check_message_2
+    p = conf.check_message_2
+    if result == True:
+        p('ok ')
+    elif result == False:
+        p('not found', 'YELLOW')
+    else:
+        p(result)
+
+
 @feature('nolink')
 def nolink(self):
     '''using the nolink type in conf.check() allows us to avoid
@@ -40,7 +77,7 @@ def nolink(self):
     pass
 
 
-def CHECK_HEADER(conf, h, add_headers=False):
+def CHECK_HEADER(conf, h, add_headers=False, lib=None):
     '''check for a header'''
     if h in missing_headers:
         return False
@@ -53,10 +90,13 @@ def CHECK_HEADER(conf, h, add_headers=False):
                 conf.env.hlist.append(h)
         return True
 
+    (ccflags, ldflags) = library_flags(conf, lib)
+
     hdrs = hlist_to_string(conf, headers=h)
     ret = conf.check(fragment='%s\nint main(void) { return 0; }' % hdrs,
                      type='nolink',
                      execute=0,
+                     ccflags=ccflags,
                      msg="Checking for header %s" % h)
     if not ret:
         missing_headers.add(h)
@@ -69,35 +109,50 @@ def CHECK_HEADER(conf, h, add_headers=False):
 
 
 @conf
-def CHECK_HEADERS(conf, headers, add_headers=False):
-    '''check for a list of headers'''
+def CHECK_HEADERS(conf, headers, add_headers=False, together=False, lib=None):
+    '''check for a list of headers
+
+    when together==True, then the headers accumulate within this test.
+    This is useful for interdependent headers
+    '''
     ret = True
+    if not add_headers and together:
+        saved_hlist = conf.env.hlist[:]
+        set_add_headers = True
+    else:
+        set_add_headers = add_headers
     for hdr in TO_LIST(headers):
-        if not CHECK_HEADER(conf, hdr, add_headers):
+        if not CHECK_HEADER(conf, hdr, set_add_headers, lib=lib):
             ret = False
+    if not add_headers and together:
+        conf.env.hlist = saved_hlist
     return ret
 
-def header_list(conf, headers=None):
+
+def header_list(conf, headers=None, lib=None):
     '''form a list of headers which exist, as a string'''
     hlist=[]
     if headers is not None:
         for h in TO_LIST(headers):
-            if CHECK_HEADER(conf, h, add_headers=False):
+            if CHECK_HEADER(conf, h, add_headers=False, lib=lib):
                 hlist.append(h)
     return hlist_to_string(conf, headers=hlist)
 
 
 @conf
-def CHECK_TYPE(conf, t, alternate=None, headers=None, define=None):
+def CHECK_TYPE(conf, t, alternate=None, headers=None, define=None, lib=None, msg=None):
     '''check for a single type'''
     if define is None:
         define = 'HAVE_' + t.upper().replace(' ', '_')
+    if msg is None:
+        msg='Checking for %s' % t
     ret = CHECK_CODE(conf, '%s _x' % t,
                      define,
                      execute=False,
                      headers=headers,
-                     msg='Checking for %s' % t,
                      local_include=False,
+                     msg=msg,
+                     lib=lib,
                      link=False)
     if not ret and alternate:
         conf.DEFINE(t, alternate)
@@ -105,11 +160,12 @@ def CHECK_TYPE(conf, t, alternate=None, headers=None, define=None):
 
 
 @conf
-def CHECK_TYPES(conf, list, headers=None, define=None, alternate=None):
+def CHECK_TYPES(conf, list, headers=None, define=None, alternate=None, lib=None):
     '''check for a list of types'''
     ret = True
     for t in TO_LIST(list):
-        if not CHECK_TYPE(conf, t, headers=headers, define=define, alternate=alternate):
+        if not CHECK_TYPE(conf, t, headers=headers,
+                          define=define, alternate=alternate, lib=lib):
             ret = False
     return ret
 
@@ -121,7 +177,8 @@ def CHECK_TYPE_IN(conf, t, headers=None, alternate=None, define=None):
 
 
 @conf
-def CHECK_VARIABLE(conf, v, define=None, always=False, headers=None, msg=None):
+def CHECK_VARIABLE(conf, v, define=None, always=False,
+                   headers=None, msg=None, lib=None):
     '''check for a variable declaration (or define)'''
     if define is None:
         define = 'HAVE_%s' % v.upper()
@@ -140,6 +197,7 @@ def CHECK_VARIABLE(conf, v, define=None, always=False, headers=None, msg=None):
                       link=False,
                       msg=msg,
                       local_include=False,
+                      lib=lib,
                       headers=headers,
                       define=define,
                       always=always)
@@ -166,26 +224,31 @@ def CHECK_DECLS(conf, vars, reverse=False, headers=None):
     return ret
 
 
-def CHECK_FUNC(conf, f, link=None, lib='c', headers=None):
+def CHECK_FUNC(conf, f, link=True, lib=None, headers=None):
     '''check for a function'''
     define='HAVE_%s' % f.upper()
 
-    # there are two ways to find a function. The first is
-    # to see if there is a declaration of the function, the
-    # 2nd is to try and link a program that calls the function
-    # unfortunately both strategies have problems.
-    # the 'check the declaration' approach works fine as long
-    # as the function has a declaraion in a header. If there is
-    # no header declaration we can get a false negative.
-    # The link method works fine as long as the compiler
-    # doesn't have a builtin for the function, which could cause
-    # a false negative due to mismatched parameters
-    # so to be sure, we need to try both
     ret = False
 
+    conf.COMPOUND_START('Checking for %s' % f)
+
     if link is None or link == True:
         ret = CHECK_CODE(conf,
-                         'int main(void) { extern void %s(void); %s(); return 0; }' % (f, f),
+                         # this is based on the autoconf strategy
+                         '''
+                         #define %s __fake__%s
+                         #ifdef HAVE_LIMITS_H
+                         # include <limits.h>
+                         #else
+                         # include <assert.h>
+                         #endif
+                         #undef %s
+                         #if defined __stub_%s || defined __stub___%s
+                         #error "bad glibc stub"
+                         #endif
+                         extern char %s();
+                         int main() { return %s(); }
+                         ''' % (f, f, f, f, f, f, f),
                          execute=False,
                          link=True,
                          addmain=False,
@@ -196,16 +259,31 @@ def CHECK_FUNC(conf, f, link=None, lib='c', headers=None):
                          headers=headers,
                          msg='Checking for %s' % f)
 
+        if not ret:
+            ret = CHECK_CODE(conf,
+                             # it might be a macro
+                             'void *__x = (void *)%s' % f,
+                             execute=False,
+                             link=True,
+                             addmain=True,
+                             add_headers=True,
+                             define=define,
+                             local_include=False,
+                             lib=lib,
+                             headers=headers,
+                             msg='Checking for macro %s' % f)
+
     if not ret and (link is None or link == False):
         ret = CHECK_VARIABLE(conf, f,
                              define=define,
                              headers=headers,
                              msg='Checking for declaration of %s' % f)
+    conf.COMPOUND_END(ret)
     return ret
 
 
 @conf
-def CHECK_FUNCS(conf, list, link=None, lib='c', headers=None):
+def CHECK_FUNCS(conf, list, link=True, lib=None, headers=None):
     '''check for a list of functions'''
     ret = True
     for f in TO_LIST(list):
@@ -241,7 +319,7 @@ def CHECK_CODE(conf, code, define,
                always=False, execute=False, addmain=True,
                add_headers=True, mandatory=False,
                headers=None, msg=None, cflags='', includes='# .',
-               local_include=True, lib='c', link=True,
+               local_include=True, lib=None, link=True,
                define_ret=False, quote=False):
     '''check if some code compiles and/or runs'''
 
@@ -249,10 +327,10 @@ def CHECK_CODE(conf, code, define,
         return True
 
     if headers is not None:
-        CHECK_HEADERS(conf, headers=headers)
+        CHECK_HEADERS(conf, headers=headers, lib=lib)
 
     if add_headers:
-        hdrs = header_list(conf, headers=headers)
+        hdrs = header_list(conf, headers=headers, lib=lib)
     else:
         hdrs = ''
     if execute:
@@ -261,9 +339,9 @@ def CHECK_CODE(conf, code, define,
         execute = 0
 
     if addmain:
-        fragment='#include "__confdefs.h"\n%s\n int main(void) { %s; return 0; }' % (hdrs, code)
+        fragment='#include "__confdefs.h"\n%s\n int main(void) { %s; return 0; }\n' % (hdrs, code)
     else:
-        fragment='#include "__confdefs.h"\n%s\n%s' % (hdrs, code)
+        fragment='#include "__confdefs.h"\n%s\n%s\n' % (hdrs, code)
 
     conf.write_config_header('__confdefs.h', top=True)
 
@@ -281,17 +359,30 @@ def CHECK_CODE(conf, code, define,
     else:
         type='cprogram'
 
-    if conf.check(fragment=fragment,
-                  execute=execute,
-                  define_name = define,
-                  mandatory = mandatory,
-                  ccflags=TO_LIST(cflags),
-                  includes=includes,
-                  lib=lib, # how do I make this conditional, so I can avoid the -lc?
-                  type=type,
-                  msg=msg,
-                  quote=quote,
-                  define_ret=define_ret):
+    uselib = TO_LIST(lib)
+
+    (ccflags, ldflags) = library_flags(conf, uselib)
+
+    cflags = TO_LIST(cflags)
+    cflags.extend(ccflags)
+
+    ret = conf.check(fragment=fragment,
+                     execute=execute,
+                     define_name = define,
+                     mandatory = mandatory,
+                     ccflags=cflags,
+                     ldflags=ldflags,
+                     includes=includes,
+                     uselib=uselib,
+                     type=type,
+                     msg=msg,
+                     quote=quote,
+                     define_ret=define_ret)
+    if not ret and CONFIG_SET(conf, define):
+        # sometimes conf.check() returns false, but it
+        # sets the define. Maybe a waf bug?
+        ret = True
+    if ret:
         if not define_ret:
             conf.DEFINE(define, 1)
         return True
@@ -322,34 +413,54 @@ def CHECK_STRUCTURE_MEMBER(conf, structname, member,
 def CHECK_CFLAGS(conf, cflags):
     '''check if the given cflags are accepted by the compiler
     '''
-    return conf.check(fragment='int main(void) { return 0; }',
+    return conf.check(fragment='int main(void) { return 0; }\n',
                       execute=0,
+                      type='nolink',
                       ccflags=cflags,
                       msg="Checking compiler accepts %s" % cflags)
 
 
-#################################################
-# return True if a configuration option was found
 @conf
 def CONFIG_SET(conf, option):
+    '''return True if a configuration option was found'''
     return (option in conf.env) and (conf.env[option] != ())
 Build.BuildContext.CONFIG_SET = CONFIG_SET
 
 
+def library_flags(conf, libs):
+    '''work out flags from pkg_config'''
+    ccflags = []
+    ldflags = []
+    for lib in TO_LIST(libs):
+        inc_path = None
+        inc_path = getattr(conf.env, 'CPPPATH_%s' % lib.upper(), [])
+        lib_path = getattr(conf.env, 'LIBPATH_%s' % lib.upper(), [])
+        for i in inc_path:
+            ccflags.append('-I%s' % i)
+        for l in lib_path:
+            ldflags.append('-L%s' % l)
+    return (ccflags, ldflags)
+
+
 @conf
-def CHECK_LIB(conf, libs):
+def CHECK_LIB(conf, libs, mandatory=False, empty_decl=True):
     '''check if a set of libraries exist'''
-    liblist   = TO_LIST(library)
 
+    liblist  = TO_LIST(libs)
     ret = True
     for lib in liblist[:]:
         if GET_TARGET_TYPE(conf, lib):
             continue
-        if not conf.check(lib=lib, uselib_store=lib):
-            conf.ASSERT(not mandatory,
-                        "Mandatory library '%s' not found for functions '%s'" % (lib, list))
-            # if it isn't a mandatory library, then remove it from dependency lists
-            SET_TARGET_TYPE(conf, lib, 'EMPTY')
+
+        (ccflags, ldflags) = library_flags(conf, lib)
+
+        if not conf.check(lib=lib, uselib_store=lib, ccflags=ccflags, ldflags=ldflags):
+            if mandatory:
+                print("Mandatory library '%s' not found for functions '%s'" % (lib, list))
+                sys.exit(1)
+            if empty_decl:
+                # if it isn't a mandatory library, then remove it from dependency lists
+                SET_TARGET_TYPE(conf, lib, 'EMPTY')
             ret = False
         else:
             conf.define('HAVE_LIB%s' % lib.upper().replace('-','_'), 1)
@@ -359,20 +470,23 @@ def CHECK_LIB(conf, libs):
     return ret
 
 
-###########################################################
-# check that the functions in 'list' are available in 'library'
-# if they are, then make that library available as a dependency
-#
-# if the library is not available and mandatory==True, then
-# raise an error.
-#
-# If the library is not available and mandatory==False, then
-# add the library to the list of dependencies to remove from
-# build rules
-#
-# optionally check for the functions first in libc
+
 @conf
-def CHECK_FUNCS_IN(conf, list, library, mandatory=False, checklibc=False, headers=None, link=None):
+def CHECK_FUNCS_IN(conf, list, library, mandatory=False, checklibc=False,
+                   headers=None, link=True, empty_decl=True):
+    """
+    check that the functions in 'list' are available in 'library'
+    if they are, then make that library available as a dependency
+
+    if the library is not available and mandatory==True, then
+    raise an error.
+
+    If the library is not available and mandatory==False, then
+    add the library to the list of dependencies to remove from
+    build rules
+
+    optionally check for the functions first in libc
+    """
     remaining = TO_LIST(list)
     liblist   = TO_LIST(library)
 
@@ -389,27 +503,19 @@ def CHECK_FUNCS_IN(conf, list, library, mandatory=False, checklibc=False, header
 
     if remaining == []:
         for lib in liblist:
-            if GET_TARGET_TYPE(conf, lib) != 'SYSLIB':
+            if GET_TARGET_TYPE(conf, lib) != 'SYSLIB' and empty_decl:
                 SET_TARGET_TYPE(conf, lib, 'EMPTY')
         return True
 
-    ret = True
+    conf.CHECK_LIB(liblist, empty_decl=empty_decl)
     for lib in liblist[:]:
-        if GET_TARGET_TYPE(conf, lib):
-            continue
-        if not conf.check(lib=lib, uselib_store=lib):
-            conf.ASSERT(not mandatory,
-                        "Mandatory library '%s' not found for functions '%s'" % (lib, list))
+        if not GET_TARGET_TYPE(conf, lib) == 'SYSLIB':
+            if mandatory:
+                print("Mandatory library '%s' not found for functions '%s'" % (lib, list))
+                sys.exit(1)
             # if it isn't a mandatory library, then remove it from dependency lists
-            SET_TARGET_TYPE(conf, lib, 'EMPTY')
-            ret = False
-        else:
-            conf.define('HAVE_LIB%s' % lib.upper().replace('-','_'), 1)
-            conf.env['LIB_' + lib.upper()] = lib
-            LOCAL_CACHE_SET(conf, 'TARGET_TYPE', lib, 'SYSLIB')
-
-    if not ret:
-        return ret
+            liblist.remove(lib)
+            continue
 
     ret = True
     for f in remaining:
@@ -420,30 +526,26 @@ def CHECK_FUNCS_IN(conf, list, library, mandatory=False, checklibc=False, header
 
 
 @conf
-def CHECK_C_PROTOTYPE(conf, function, prototype, define, headers=None):
-    '''verify that a C prototype matches the one on the current system'''
-    if not conf.CHECK_DECLS(function, headers=headers):
-        return False
-    return conf.CHECK_CODE('%s; void *_x = (void *)%s' % (prototype, function),
-                           define=define,
-                           local_include=False,
-                           msg='Checking C prototype for %s' % function)
+def IN_LAUNCH_DIR(conf):
+    '''return True if this rule is being run from the launch directory'''
+    return os.path.realpath(conf.curdir) == os.path.realpath(Options.launch_dir)
 
 
-
-
-#################################################
-# write out config.h in the right directory
 @conf
 def SAMBA_CONFIG_H(conf, path=None):
+    '''write out config.h in the right directory'''
     # we don't want to produce a config.h in places like lib/replace
     # when we are building projects that depend on lib/replace
-    if os.path.realpath(conf.curdir) != os.path.realpath(Options.launch_dir):
+    if not IN_LAUNCH_DIR(conf):
         return
 
     if Options.options.developer:
         # we add these here to ensure that -Wstrict-prototypes is not set during configure
-        conf.ADD_CFLAGS('-Wall -g -Wfatal-errors -Wshadow -Wstrict-prototypes -Wpointer-arith -Wcast-qual -Wcast-align -Wwrite-strings -Werror-implicit-function-declaration -Wformat=2 -Wno-format-y2k')
+        conf.ADD_CFLAGS('-Wall -g -Wfatal-errors -Wshadow -Wstrict-prototypes -Wpointer-arith -Wcast-qual -Wcast-align -Wwrite-strings -Werror-implicit-function-declaration -Wformat=2 -Wno-format-y2k',
+                        testflags=True)
+
+    if Options.options.pedantic:
+       conf.ADD_CFLAGS('-W', testflags=True)
 
     if path is None:
         conf.write_config_header('config.h', top=True)
@@ -451,10 +553,9 @@ def SAMBA_CONFIG_H(conf, path=None):
         conf.write_config_header(path)
 
 
-##############################################################
-# setup a configurable path
 @conf
 def CONFIG_PATH(conf, name, default):
+    '''setup a configurable path'''
     if not name in conf.env:
         if default[0] == '/':
             conf.env[name] = default
@@ -462,26 +563,35 @@ def CONFIG_PATH(conf, name, default):
             conf.env[name] = conf.env['PREFIX'] + default
     conf.define(name, conf.env[name], quote=True)
 
-##############################################################
-# add some CFLAGS to the command line
+
 @conf
-def ADD_CFLAGS(conf, flags):
+def ADD_CFLAGS(conf, flags, testflags=False):
+    '''add some CFLAGS to the command line
+       optionally set testflags to ensure all the flags work
+    '''
+    if testflags:
+        ok_flags=[]
+        for f in flags.split():
+            if CHECK_CFLAGS(conf, f):
+                ok_flags.append(f)
+        flags = ok_flags
     if not 'EXTRA_CFLAGS' in conf.env:
         conf.env['EXTRA_CFLAGS'] = []
     conf.env['EXTRA_CFLAGS'].extend(TO_LIST(flags))
 
-##############################################################
-# add some extra include directories to all builds
+
+
 @conf
 def ADD_EXTRA_INCLUDES(conf, includes):
+    '''add some extra include directories to all builds'''
     if not 'EXTRA_INCLUDES' in conf.env:
         conf.env['EXTRA_INCLUDES'] = []
     conf.env['EXTRA_INCLUDES'].extend(TO_LIST(includes))
 
 
-##############################################################
-# work out the current flags. local flags are added first
+
 def CURRENT_CFLAGS(bld, target, cflags):
+    '''work out the current flags. local flags are added first'''
     if not 'EXTRA_CFLAGS' in bld.env:
         list = []
     else:
@@ -490,20 +600,11 @@ def CURRENT_CFLAGS(bld, target, cflags):
     ret.extend(list)
     return ret
 
-@conf
-def CHECK_RPATH_SUPPORT(conf):
-    '''see if the system supports rpath'''
-    return conf.CHECK_CODE('int x',
-                           define='HAVE_RPATH_SUPPORT',
-                           execute=True,
-                           local_include=False,
-                           msg='Checking for rpath support',
-                           cflags='-Wl,-rpath=.')
 
 @conf
 def CHECK_CC_ENV(conf):
-    '''trim whitespaces from 'CC'.
-    The build farm sometimes puts a space at the start'''
+    """trim whitespaces from 'CC'.
+    The build farm sometimes puts a space at the start"""
     if os.environ.get('CC'):
         conf.env.CC = TO_LIST(os.environ.get('CC'))
         if len(conf.env.CC) == 1: