build: added abi_type_maps for FC12 struct va_list
[samba.git] / buildtools / wafsamba / samba_abi.py
1 # functions for handling ABI checking of libraries
2
3 import Options, Utils, os, Logs, samba_utils, sys, Task, fnmatch, re
4 from TaskGen import feature, before, after
5
6 # these type maps cope with platform specific names for common types
7 # please add new type mappings into the list below
8 abi_type_maps = {
9     '_Bool' : 'bool',
10     '__va_list_tag' : 'va_list',
11     'struct va_list' : 'va_list'
12     }
13
14 def normalise_signature(sig):
15     '''normalise a signature from gdb'''
16     sig = sig.strip()
17     sig = re.sub('^\$[0-9]+\s=\s\{*', '', sig)
18     sig = re.sub('\}(\s0x[0-9a-f]+\s<\w+>)?$', '', sig)
19     sig = re.sub('0x[0-9a-f]+', '0xXXXX', sig)
20
21     for t in abi_type_maps:
22         sig = re.sub('\\b%s\\b' % t, abi_type_maps[t], sig)
23     return sig
24
25 def normalise_varargs(sig):
26     '''cope with older versions of gdb'''
27     sig = re.sub(',\s\.\.\.', '', sig)
28     return sig
29
30 def parse_sigs(sigs, abi_match):
31     '''parse ABI signatures file'''
32     abi_match = samba_utils.TO_LIST(abi_match)
33     ret = {}
34     a = sigs.split('\n')
35     for s in a:
36         if s.find(':') == -1:
37             continue
38         sa = s.split(':')
39         if abi_match:
40             matched = False
41             for p in abi_match:
42                 if fnmatch.fnmatch(sa[0], p):
43                     matched = True
44                     break
45             if not matched:
46                 continue
47         ret[sa[0]] = normalise_signature(sa[1])
48     return ret
49
50 def save_sigs(sig_file, parsed_sigs):
51     '''save ABI signatures to a file'''
52     sigs = ''
53     for s in sorted(parsed_sigs.keys()):
54         sigs += '%s: %s\n' % (s, parsed_sigs[s])
55     return samba_utils.save_file(sig_file, sigs, create_dir=True)
56
57
58 def abi_check_task(self):
59     '''check if the ABI has changed'''
60     abi_gen = self.ABI_GEN
61
62     libpath = self.inputs[0].abspath(self.env)
63     libname = os.path.basename(libpath)
64
65     sigs = Utils.cmd_output([abi_gen, libpath])
66     parsed_sigs = parse_sigs(sigs, self.ABI_MATCH)
67
68     sig_file = self.ABI_FILE
69
70     old_sigs = samba_utils.load_file(sig_file)
71     if old_sigs is None or Options.options.ABI_UPDATE:
72         if not save_sigs(sig_file, parsed_sigs):
73             raise Utils.WafError('Failed to save ABI file "%s"' % sig_file)
74         Logs.warn('Generated ABI signatures %s' % sig_file)
75         return
76
77     parsed_old_sigs = parse_sigs(old_sigs, self.ABI_MATCH)
78
79     # check all old sigs
80     got_error = False
81     for s in parsed_old_sigs:
82         if not s in parsed_sigs:
83             Logs.error('%s: symbol %s has been removed - please update major version\n\tsignature: %s' % (
84                 libname, s, parsed_old_sigs[s]))
85             got_error = True
86         elif normalise_varargs(parsed_old_sigs[s]) != normalise_varargs(parsed_sigs[s]):
87             Logs.error('%s: symbol %s has changed - please update major version\n\told_signature: %s\n\tnew_signature: %s' % (
88                 libname, s, parsed_old_sigs[s], parsed_sigs[s]))
89             got_error = True
90
91     for s in parsed_sigs:
92         if not s in parsed_old_sigs:
93             Logs.error('%s: symbol %s has been added - please mark it _PRIVATE_ or update minor version\n\tsignature: %s' % (
94                 libname, s, parsed_sigs[s]))
95             got_error = True
96
97     if got_error:
98         raise Utils.WafError('ABI for %s has changed - please fix library version then build with --abi-update\nSee http://wiki.samba.org/index.php/Waf#ABI_Checking for more information' % libname)
99
100
101 t = Task.task_type_from_func('abi_check', abi_check_task, color='BLUE', ext_in='.bin')
102 t.quiet = True
103
104 @after('apply_link')
105 @feature('abi_check')
106 def abi_check(self):
107     '''check that ABI matches saved signatures'''
108     env = self.bld.env
109     if not env.ABI_CHECK or self.abi_file is None:
110         return
111
112     # if the platform doesn't support -fvisibility=hidden then the ABI
113     # checks become fairly meaningless
114     if not env.HAVE_VISIBILITY_ATTR:
115         return
116
117     topsrc = self.bld.srcnode.abspath()
118     abi_gen = os.path.join(topsrc, 'buildtools/scripts/abi_gen.sh')
119
120     tsk = self.create_task('abi_check', self.link_task.outputs[0])
121     tsk.ABI_FILE = self.abi_file
122     tsk.ABI_MATCH = self.abi_match
123     tsk.ABI_GEN = abi_gen