buildtools/wafsamba/samba_autoconf.py

   1 # a waf tool to add autoconf-like macros to the configure section
   2
   3 import Build, os, Options, preproc, Logs
   4 import string
   5 from Configure import conf
   6 from samba_utils import *
   7 import samba_cross
   8
   9 missing_headers = set()
  10
  11 ####################################################
  12 # some autoconf like helpers, to make the transition
  13 # to waf a bit easier for those used to autoconf
  14 # m4 files
  15
  16 @runonce
  17 @conf
  18 def DEFINE(conf, d, v, add_to_cflags=False, quote=False):
  19     '''define a config option'''
  20     conf.define(d, v, quote=quote)
  21     if add_to_cflags:
  22         conf.env.append_value('CCDEFINES', d + '=' + str(v))
  23
  24 def hlist_to_string(conf, headers=None):
  25     '''convert a headers list to a set of #include lines'''
  26     hdrs=''
  27     hlist = conf.env.hlist
  28     if headers:
  29         hlist = hlist[:]
  30         hlist.extend(TO_LIST(headers))
  31     for h in hlist:
  32         hdrs += '#include <%s>\n' % h
  33     return hdrs
  34
  35
  36 @conf
  37 def COMPOUND_START(conf, msg):
  38     '''start a compound test'''
  39     def null_check_message_1(self,*k,**kw):
  40         return
  41     def null_check_message_2(self,*k,**kw):
  42         return
  43
  44     v = getattr(conf.env, 'in_compound', [])
  45     if v != [] and v != 0:
  46         conf.env.in_compound = v + 1
  47         return
  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
  54
  55
  56 @conf
  57 def COMPOUND_END(conf, result):
  58     '''start a compound test'''
  59     conf.env.in_compound -= 1
  60     if conf.env.in_compound != 0:
  61         return
  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
  65     if result == True:
  66         p('ok ')
  67     elif result == False:
  68         p('not found', 'YELLOW')
  69     else:
  70         p(result)
  71
  72
  73 @feature('nolink')
  74 def nolink(self):
  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'''
  78     pass
  79
  80
  81 def CHECK_HEADER(conf, h, add_headers=False, lib=None):
  82     '''check for a header'''
  83     if h in missing_headers:
  84         return False
  85     d = h.upper().replace('/', '_')
  86     d = d.replace('.', '_')
  87     d = d.replace('-', '_')
  88     d = 'HAVE_%s' % d
  89     if CONFIG_SET(conf, d):
  90         if add_headers:
  91             if not h in conf.env.hlist:
  92                 conf.env.hlist.append(h)
  93         return True
  94
  95     (ccflags, ldflags) = library_flags(conf, lib)
  96
  97     hdrs = hlist_to_string(conf, headers=h)
  98     ret = conf.check(fragment='%s\nint main(void) { return 0; }' % hdrs,
  99                      type='nolink',
 100                      execute=0,
 101                      ccflags=ccflags,
 102                      msg="Checking for header %s" % h)
 103     if not ret:
 104         missing_headers.add(h)
 105         return False
 106
 107     conf.DEFINE(d, 1)
 108     if add_headers and not h in conf.env.hlist:
 109         conf.env.hlist.append(h)
 110     return ret
 111
 112
 113 @conf
 114 def CHECK_HEADERS(conf, headers, add_headers=False, together=False, lib=None):
 115     '''check for a list of headers
 116
 117     when together==True, then the headers accumulate within this test.
 118     This is useful for interdependent headers
 119     '''
 120     ret = True
 121     if not add_headers and together:
 122         saved_hlist = conf.env.hlist[:]
 123         set_add_headers = True
 124     else:
 125         set_add_headers = add_headers
 126     for hdr in TO_LIST(headers):
 127         if not CHECK_HEADER(conf, hdr, set_add_headers, lib=lib):
 128             ret = False
 129     if not add_headers and together:
 130         conf.env.hlist = saved_hlist
 131     return ret
 132
 133
 134 def header_list(conf, headers=None, lib=None):
 135     '''form a list of headers which exist, as a string'''
 136     hlist=[]
 137     if headers is not None:
 138         for h in TO_LIST(headers):
 139             if CHECK_HEADER(conf, h, add_headers=False, lib=lib):
 140                 hlist.append(h)
 141     return hlist_to_string(conf, headers=hlist)
 142
 143
 144 @conf
 145 def CHECK_TYPE(conf, t, alternate=None, headers=None, define=None, lib=None, msg=None):
 146     '''check for a single type'''
 147     if define is None:
 148         define = 'HAVE_' + t.upper().replace(' ', '_')
 149     if msg is None:
 150         msg='Checking for %s' % t
 151     ret = CHECK_CODE(conf, '%s _x' % t,
 152                      define,
 153                      execute=False,
 154                      headers=headers,
 155                      local_include=False,
 156                      msg=msg,
 157                      lib=lib,
 158                      link=False)
 159     if not ret and alternate:
 160         conf.DEFINE(t, alternate)
 161     return ret
 162
 163
 164 @conf
 165 def CHECK_TYPES(conf, list, headers=None, define=None, alternate=None, lib=None):
 166     '''check for a list of types'''
 167     ret = True
 168     for t in TO_LIST(list):
 169         if not CHECK_TYPE(conf, t, headers=headers,
 170                           define=define, alternate=alternate, lib=lib):
 171             ret = False
 172     return ret
 173
 174
 175 @conf
 176 def CHECK_TYPE_IN(conf, t, headers=None, alternate=None, define=None):
 177     '''check for a single type with a header'''
 178     return CHECK_TYPE(conf, t, headers=headers, alternate=alternate, define=define)
 179
 180
 181 @conf
 182 def CHECK_VARIABLE(conf, v, define=None, always=False,
 183                    headers=None, msg=None, lib=None):
 184     '''check for a variable declaration (or define)'''
 185     if define is None:
 186         define = 'HAVE_%s' % v.upper()
 187
 188     if msg is None:
 189         msg="Checking for variable %s" % v
 190
 191     return CHECK_CODE(conf,
 192                       # we need to make sure the compiler doesn't
 193                       # optimize it out...
 194                       '''
 195                       #ifndef %s
 196                       void *_x; _x=(void *)&%s; return (int)_x;
 197                       #endif
 198                       return 0
 199                       ''' % (v, v),
 200                       execute=False,
 201                       link=False,
 202                       msg=msg,
 203                       local_include=False,
 204                       lib=lib,
 205                       headers=headers,
 206                       define=define,
 207                       always=always)
 208
 209
 210 @conf
 211 def CHECK_DECLS(conf, vars, reverse=False, headers=None, always=False):
 212     '''check a list of variable declarations, using the HAVE_DECL_xxx form
 213        of define
 214
 215        When reverse==True then use HAVE_xxx_DECL instead of HAVE_DECL_xxx
 216        '''
 217     ret = True
 218     for v in TO_LIST(vars):
 219         if not reverse:
 220             define='HAVE_DECL_%s' % v.upper()
 221         else:
 222             define='HAVE_%s_DECL' % v.upper()
 223         if not CHECK_VARIABLE(conf, v,
 224                               define=define,
 225                               headers=headers,
 226                               msg='Checking for declaration of %s' % v,
 227                               always=always):
 228             ret = False
 229     return ret
 230
 231
 232 def CHECK_FUNC(conf, f, link=True, lib=None, headers=None):
 233     '''check for a function'''
 234     define='HAVE_%s' % f.upper()
 235
 236     ret = False
 237
 238     conf.COMPOUND_START('Checking for %s' % f)
 239
 240     if link is None or link == True:
 241         ret = CHECK_CODE(conf,
 242                          # this is based on the autoconf strategy
 243                          '''
 244                          #define %s __fake__%s
 245                          #ifdef HAVE_LIMITS_H
 246                          # include <limits.h>
 247                          #else
 248                          # include <assert.h>
 249                          #endif
 250                          #undef %s
 251                          #if defined __stub_%s || defined __stub___%s
 252                          #error "bad glibc stub"
 253                          #endif
 254                          extern char %s();
 255                          int main() { return %s(); }
 256                          ''' % (f, f, f, f, f, f, f),
 257                          execute=False,
 258                          link=True,
 259                          addmain=False,
 260                          add_headers=False,
 261                          define=define,
 262                          local_include=False,
 263                          lib=lib,
 264                          headers=headers,
 265                          msg='Checking for %s' % f)
 266
 267         if not ret:
 268             ret = CHECK_CODE(conf,
 269                              # it might be a macro
 270                              # we need to make sure the compiler doesn't
 271                              # optimize it out...
 272                              'void *__x = (void *)%s; return (int)__x' % f,
 273                              execute=False,
 274                              link=True,
 275                              addmain=True,
 276                              add_headers=True,
 277                              define=define,
 278                              local_include=False,
 279                              lib=lib,
 280                              headers=headers,
 281                              msg='Checking for macro %s' % f)
 282
 283     if not ret and (link is None or link == False):
 284         ret = CHECK_VARIABLE(conf, f,
 285                              define=define,
 286                              headers=headers,
 287                              msg='Checking for declaration of %s' % f)
 288     conf.COMPOUND_END(ret)
 289     return ret
 290
 291
 292 @conf
 293 def CHECK_FUNCS(conf, list, link=True, lib=None, headers=None):
 294     '''check for a list of functions'''
 295     ret = True
 296     for f in TO_LIST(list):
 297         if not CHECK_FUNC(conf, f, link=link, lib=lib, headers=headers):
 298             ret = False
 299     return ret
 300
 301
 302 @conf
 303 def CHECK_SIZEOF(conf, vars, headers=None, define=None):
 304     '''check the size of a type'''
 305     ret = True
 306     for v in TO_LIST(vars):
 307         v_define = define
 308         if v_define is None:
 309             v_define = 'SIZEOF_%s' % v.upper().replace(' ', '_')
 310         if not CHECK_CODE(conf,
 311                           'printf("%%u", (unsigned)sizeof(%s))' % v,
 312                           define=v_define,
 313                           execute=True,
 314                           define_ret=True,
 315                           quote=False,
 316                           headers=headers,
 317                           local_include=False,
 318                           msg="Checking size of %s" % v):
 319             ret = False
 320     return ret
 321
 322
 323
 324 @conf
 325 def CHECK_CODE(conf, code, define,
 326                always=False, execute=False, addmain=True,
 327                add_headers=True, mandatory=False,
 328                headers=None, msg=None, cflags='', includes='# .',
 329                local_include=True, lib=None, link=True,
 330                define_ret=False, quote=False,
 331                on_target=True):
 332     '''check if some code compiles and/or runs'''
 333
 334     if CONFIG_SET(conf, define):
 335         return True
 336
 337     if headers is not None:
 338         CHECK_HEADERS(conf, headers=headers, lib=lib)
 339
 340     if add_headers:
 341         hdrs = header_list(conf, headers=headers, lib=lib)
 342     else:
 343         hdrs = ''
 344     if execute:
 345         execute = 1
 346     else:
 347         execute = 0
 348
 349     defs = conf.get_config_header()
 350
 351     if addmain:
 352         fragment='%s\n%s\n int main(void) { %s; return 0; }\n' % (defs, hdrs, code)
 353     else:
 354         fragment='%s\n%s\n%s\n' % (defs, hdrs, code)
 355
 356     if msg is None:
 357         msg="Checking for %s" % define
 358
 359     if local_include:
 360         cflags += ' -I%s' % conf.curdir
 361
 362     if not link:
 363         type='nolink'
 364     else:
 365         type='cprogram'
 366
 367     uselib = TO_LIST(lib)
 368
 369     (ccflags, ldflags) = library_flags(conf, uselib)
 370
 371     cflags = TO_LIST(cflags)
 372     cflags.extend(ccflags)
 373
 374     if on_target:
 375         exec_args = conf.SAMBA_CROSS_ARGS(msg=msg)
 376     else:
 377         exec_args = []
 378
 379     conf.COMPOUND_START(msg)
 380
 381     ret = conf.check(fragment=fragment,
 382                      execute=execute,
 383                      define_name = define,
 384                      mandatory = mandatory,
 385                      ccflags=cflags,
 386                      ldflags=ldflags,
 387                      includes=includes,
 388                      uselib=uselib,
 389                      type=type,
 390                      msg=msg,
 391                      quote=quote,
 392                      exec_args=exec_args,
 393                      define_ret=define_ret)
 394     if not ret and CONFIG_SET(conf, define):
 395         # sometimes conf.check() returns false, but it
 396         # sets the define. Maybe a waf bug?
 397         ret = True
 398     if ret:
 399         if not define_ret:
 400             conf.DEFINE(define, 1)
 401             conf.COMPOUND_END(True)
 402         else:
 403             conf.COMPOUND_END(conf.env[define])
 404         return True
 405     if always:
 406         conf.DEFINE(define, 0)
 407     conf.COMPOUND_END(False)
 408     return False
 409
 410
 411
 412 @conf
 413 def CHECK_STRUCTURE_MEMBER(conf, structname, member,
 414                            always=False, define=None, headers=None):
 415     '''check for a structure member'''
 416     if define is None:
 417         define = 'HAVE_%s' % member.upper()
 418     return CHECK_CODE(conf,
 419                       '%s s; void *_x; _x=(void *)&s.%s' % (structname, member),
 420                       define,
 421                       execute=False,
 422                       link=False,
 423                       always=always,
 424                       headers=headers,
 425                       local_include=False,
 426                       msg="Checking for member %s in %s" % (member, structname))
 427
 428
 429 @conf
 430 def CHECK_CFLAGS(conf, cflags):
 431     '''check if the given cflags are accepted by the compiler
 432     '''
 433     return conf.check(fragment='int main(void) { return 0; }\n',
 434                       execute=0,
 435                       type='nolink',
 436                       ccflags=cflags,
 437                       msg="Checking compiler accepts %s" % cflags)
 438
 439
 440 @conf
 441 def CONFIG_SET(conf, option):
 442     '''return True if a configuration option was found'''
 443     return (option in conf.env) and (conf.env[option] != ())
 444 Build.BuildContext.CONFIG_SET = CONFIG_SET
 445
 446
 447 def library_flags(conf, libs):
 448     '''work out flags from pkg_config'''
 449     ccflags = []
 450     ldflags = []
 451     for lib in TO_LIST(libs):
 452         inc_path = None
 453         inc_path = getattr(conf.env, 'CPPPATH_%s' % lib.upper(), [])
 454         lib_path = getattr(conf.env, 'LIBPATH_%s' % lib.upper(), [])
 455         for i in inc_path:
 456             ccflags.append('-I%s' % i)
 457         for l in lib_path:
 458             ldflags.append('-L%s' % l)
 459     return (ccflags, ldflags)
 460
 461
 462 @conf
 463 def CHECK_LIB(conf, libs, mandatory=False, empty_decl=True):
 464     '''check if a set of libraries exist'''
 465
 466     liblist  = TO_LIST(libs)
 467     ret = True
 468     for lib in liblist[:]:
 469         if GET_TARGET_TYPE(conf, lib) == 'SYSLIB':
 470             continue
 471
 472         (ccflags, ldflags) = library_flags(conf, lib)
 473
 474         if not conf.check(lib=lib, uselib_store=lib, ccflags=ccflags, ldflags=ldflags):
 475             if mandatory:
 476                 Logs.error("Mandatory library '%s' not found for functions '%s'" % (lib, list))
 477                 sys.exit(1)
 478             if empty_decl:
 479                 # if it isn't a mandatory library, then remove it from dependency lists
 480                 SET_TARGET_TYPE(conf, lib, 'EMPTY')
 481             ret = False
 482         else:
 483             conf.define('HAVE_LIB%s' % lib.upper().replace('-','_'), 1)
 484             conf.env['LIB_' + lib.upper()] = lib
 485             LOCAL_CACHE_SET(conf, 'TARGET_TYPE', lib, 'SYSLIB')
 486
 487     return ret
 488
 489
 490
 491 @conf
 492 def CHECK_FUNCS_IN(conf, list, library, mandatory=False, checklibc=False,
 493                    headers=None, link=True, empty_decl=True):
 494     """
 495     check that the functions in 'list' are available in 'library'
 496     if they are, then make that library available as a dependency
 497
 498     if the library is not available and mandatory==True, then
 499     raise an error.
 500
 501     If the library is not available and mandatory==False, then
 502     add the library to the list of dependencies to remove from
 503     build rules
 504
 505     optionally check for the functions first in libc
 506     """
 507     remaining = TO_LIST(list)
 508     liblist   = TO_LIST(library)
 509
 510     # check if some already found
 511     for f in remaining[:]:
 512         if CONFIG_SET(conf, 'HAVE_%s' % f.upper()):
 513             remaining.remove(f)
 514
 515     # see if the functions are in libc
 516     if checklibc:
 517         for f in remaining[:]:
 518             if CHECK_FUNC(conf, f, link=True, headers=headers):
 519                 remaining.remove(f)
 520
 521     if remaining == []:
 522         for lib in liblist:
 523             if GET_TARGET_TYPE(conf, lib) != 'SYSLIB' and empty_decl:
 524                 SET_TARGET_TYPE(conf, lib, 'EMPTY')
 525         return True
 526
 527     conf.CHECK_LIB(liblist, empty_decl=empty_decl)
 528     for lib in liblist[:]:
 529         if not GET_TARGET_TYPE(conf, lib) == 'SYSLIB':
 530             if mandatory:
 531                 Logs.error("Mandatory library '%s' not found for functions '%s'" % (lib, list))
 532                 sys.exit(1)
 533             # if it isn't a mandatory library, then remove it from dependency lists
 534             liblist.remove(lib)
 535             continue
 536
 537     ret = True
 538     for f in remaining:
 539         if not CHECK_FUNC(conf, f, lib=' '.join(liblist), headers=headers, link=link):
 540             ret = False
 541
 542     return ret
 543
 544
 545 @conf
 546 def IN_LAUNCH_DIR(conf):
 547     '''return True if this rule is being run from the launch directory'''
 548     return os.path.realpath(conf.curdir) == os.path.realpath(Options.launch_dir)
 549 Options.Handler.IN_LAUNCH_DIR = IN_LAUNCH_DIR
 550
 551
 552 @conf
 553 def SAMBA_CONFIG_H(conf, path=None):
 554     '''write out config.h in the right directory'''
 555     # we don't want to produce a config.h in places like lib/replace
 556     # when we are building projects that depend on lib/replace
 557     if not IN_LAUNCH_DIR(conf):
 558         return
 559
 560     if Options.options.developer:
 561         # we add these here to ensure that -Wstrict-prototypes is not set during configure
 562         conf.ADD_CFLAGS('-Wall -g -Wshadow -Wstrict-prototypes -Wpointer-arith -Wcast-qual -Wcast-align -Wwrite-strings -Werror-implicit-function-declaration -Wformat=2 -Wno-format-y2k',
 563                         testflags=True)
 564
 565     if Options.options.picky_developer:
 566         conf.ADD_CFLAGS('-Werror', testflags=True)
 567
 568     if Options.options.fatal_errors:
 569         conf.ADD_CFLAGS('-Wfatal-errors', testflags=True)
 570
 571     if Options.options.pedantic:
 572         conf.ADD_CFLAGS('-W', testflags=True)
 573
 574     if path is None:
 575         conf.write_config_header('config.h', top=True)
 576     else:
 577         conf.write_config_header(path)
 578     conf.SAMBA_CROSS_CHECK_COMPLETE()
 579
 580
 581 @conf
 582 def CONFIG_PATH(conf, name, default):
 583     '''setup a configurable path'''
 584     if not name in conf.env:
 585         if default[0] == '/':
 586             conf.env[name] = default
 587         else:
 588             conf.env[name] = conf.env['PREFIX'] + default
 589
 590 @conf
 591 def ADD_CFLAGS(conf, flags, testflags=False):
 592     '''add some CFLAGS to the command line
 593        optionally set testflags to ensure all the flags work
 594     '''
 595     if testflags:
 596         ok_flags=[]
 597         for f in flags.split():
 598             if CHECK_CFLAGS(conf, f):
 599                 ok_flags.append(f)
 600         flags = ok_flags
 601     if not 'EXTRA_CFLAGS' in conf.env:
 602         conf.env['EXTRA_CFLAGS'] = []
 603     conf.env['EXTRA_CFLAGS'].extend(TO_LIST(flags))
 604
 605
 606
 607 @conf
 608 def ADD_EXTRA_INCLUDES(conf, includes):
 609     '''add some extra include directories to all builds'''
 610     if not 'EXTRA_INCLUDES' in conf.env:
 611         conf.env['EXTRA_INCLUDES'] = []
 612     conf.env['EXTRA_INCLUDES'].extend(TO_LIST(includes))
 613
 614
 615
 616 def CURRENT_CFLAGS(bld, target, cflags, hide_symbols=False):
 617     '''work out the current flags. local flags are added first'''
 618     if not 'EXTRA_CFLAGS' in bld.env:
 619         list = []
 620     else:
 621         list = bld.env['EXTRA_CFLAGS'];
 622     ret = TO_LIST(cflags)
 623     ret.extend(list)
 624     if hide_symbols and bld.env.HAVE_VISIBILITY_ATTR:
 625         ret.append('-fvisibility=hidden')
 626     return ret
 627
 628
 629 @conf
 630 def CHECK_CC_ENV(conf):
 631     """trim whitespaces from 'CC'.
 632     The build farm sometimes puts a space at the start"""
 633     if os.environ.get('CC'):
 634         conf.env.CC = TO_LIST(os.environ.get('CC'))
 635         if len(conf.env.CC) == 1:
 636             # make for nicer logs if just a single command
 637             conf.env.CC = conf.env.CC[0]
 638
 639
 640 @conf
 641 def SETUP_CONFIGURE_CACHE(conf, enable):
 642     '''enable/disable cache of configure results'''
 643     if enable:
 644         # when -C is chosen, we will use a private cache and will
 645         # not look into system includes. This roughtly matches what
 646         # autoconf does with -C
 647         cache_path = os.path.join(conf.blddir, '.confcache')
 648         mkdir_p(cache_path)
 649         Options.cache_global = os.environ['WAFCACHE'] = cache_path
 650     else:
 651         # when -C is not chosen we will not cache configure checks
 652         # We set the recursion limit low to prevent waf from spending
 653         # a lot of time on the signatures of the files.
 654         Options.cache_global = os.environ['WAFCACHE'] = ''
 655         preproc.recursion_limit = 1
 656     # in either case we don't need to scan system includes
 657     preproc.go_absolute = False