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