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, Build
   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     'struct __va_list_tag *' : 'va_list'
  11     }
  12
  13 version_key = lambda x: map(int, x.split("."))
  14
  15 def normalise_signature(sig):
  16     '''normalise a signature from gdb'''
  17     sig = sig.strip()
  18     sig = re.sub('^\$[0-9]+\s=\s\{(.+)\}$', r'\1', sig)
  19     sig = re.sub('^\$[0-9]+\s=\s\{(.+)\}(\s0x[0-9a-f]+\s<\w+>)+$', r'\1', sig)
  20     sig = re.sub('^\$[0-9]+\s=\s(0x[0-9a-f]+)\s?(<\w+>)?$', r'\1', sig)
  21     sig = re.sub('0x[0-9a-f]+', '0xXXXX', sig)
  22     sig = re.sub('", <incomplete sequence (\\\\[a-z0-9]+)>', r'\1"', sig)
  23
  24     for t in abi_type_maps:
  25         # we need to cope with non-word characters in mapped types
  26         m = t
  27         m = m.replace('*', '\*')
  28         if m[-1].isalnum() or m[-1] == '_':
  29             m += '\\b'
  30         if m[0].isalnum() or m[0] == '_':
  31             m = '\\b' + m
  32         sig = re.sub(m, abi_type_maps[t], sig)
  33     return sig
  34
  35
  36 def normalise_varargs(sig):
  37     '''cope with older versions of gdb'''
  38     sig = re.sub(',\s\.\.\.', '', sig)
  39     return sig
  40
  41
  42 def parse_sigs(sigs, abi_match):
  43     '''parse ABI signatures file'''
  44     abi_match = samba_utils.TO_LIST(abi_match)
  45     ret = {}
  46     a = sigs.split('\n')
  47     for s in a:
  48         if s.find(':') == -1:
  49             continue
  50         sa = s.split(':')
  51         if abi_match:
  52             matched = False
  53             negative = False
  54             for p in abi_match:
  55                 if p[0] == '!' and fnmatch.fnmatch(sa[0], p[1:]):
  56                     negative = True
  57                     break
  58                 elif fnmatch.fnmatch(sa[0], p):
  59                     matched = True
  60                     break
  61             if (not matched) and negative:
  62                 continue
  63         Logs.debug("%s -> %s" % (sa[1], normalise_signature(sa[1])))
  64         ret[sa[0]] = normalise_signature(sa[1])
  65     return ret
  66
  67 def save_sigs(sig_file, parsed_sigs):
  68     '''save ABI signatures to a file'''
  69     sigs = ''
  70     for s in sorted(parsed_sigs.keys()):
  71         sigs += '%s: %s\n' % (s, parsed_sigs[s])
  72     return samba_utils.save_file(sig_file, sigs, create_dir=True)
  73
  74
  75 def abi_check_task(self):
  76     '''check if the ABI has changed'''
  77     abi_gen = self.ABI_GEN
  78
  79     libpath = self.inputs[0].abspath(self.env)
  80     libname = os.path.basename(libpath)
  81
  82     sigs = Utils.cmd_output([abi_gen, libpath])
  83     parsed_sigs = parse_sigs(sigs, self.ABI_MATCH)
  84
  85     sig_file = self.ABI_FILE
  86
  87     old_sigs = samba_utils.load_file(sig_file)
  88     if old_sigs is None or Options.options.ABI_UPDATE:
  89         if not save_sigs(sig_file, parsed_sigs):
  90             raise Utils.WafError('Failed to save ABI file "%s"' % sig_file)
  91         Logs.warn('Generated ABI signatures %s' % sig_file)
  92         return
  93
  94     parsed_old_sigs = parse_sigs(old_sigs, self.ABI_MATCH)
  95
  96     # check all old sigs
  97     got_error = False
  98     for s in parsed_old_sigs:
  99         if not s in parsed_sigs:
 100             Logs.error('%s: symbol %s has been removed - please update major version\n\tsignature: %s' % (
 101                 libname, s, parsed_old_sigs[s]))
 102             got_error = True
 103         elif normalise_varargs(parsed_old_sigs[s]) != normalise_varargs(parsed_sigs[s]):
 104             Logs.error('%s: symbol %s has changed - please update major version\n\told_signature: %s\n\tnew_signature: %s' % (
 105                 libname, s, parsed_old_sigs[s], parsed_sigs[s]))
 106             got_error = True
 107
 108     for s in parsed_sigs:
 109         if not s in parsed_old_sigs:
 110             Logs.error('%s: symbol %s has been added - please mark it _PRIVATE_ or update minor version\n\tsignature: %s' % (
 111                 libname, s, parsed_sigs[s]))
 112             got_error = True
 113
 114     if got_error:
 115         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\nIf you have not changed any ABI, and your platform always gives this error, please configure with --abi-check-disable to skip this check' % libname)
 116
 117
 118 t = Task.task_type_from_func('abi_check', abi_check_task, color='BLUE', ext_in='.bin')
 119 t.quiet = True
 120 # allow "waf --abi-check" to force re-checking the ABI
 121 if '--abi-check' in sys.argv:
 122     Task.always_run(t)
 123
 124 @after('apply_link')
 125 @feature('abi_check')
 126 def abi_check(self):
 127     '''check that ABI matches saved signatures'''
 128     env = self.bld.env
 129     if not env.ABI_CHECK or self.abi_directory is None:
 130         return
 131
 132     # if the platform doesn't support -fvisibility=hidden then the ABI
 133     # checks become fairly meaningless
 134     if not env.HAVE_VISIBILITY_ATTR:
 135         return
 136
 137     topsrc = self.bld.srcnode.abspath()
 138     abi_gen = os.path.join(topsrc, 'buildtools/scripts/abi_gen.sh')
 139
 140     abi_file = "%s/%s-%s.sigs" % (self.abi_directory, self.name, self.vnum)
 141
 142     tsk = self.create_task('abi_check', self.link_task.outputs[0])
 143     tsk.ABI_FILE = abi_file
 144     tsk.ABI_MATCH = self.abi_match
 145     tsk.ABI_GEN = abi_gen
 146
 147
 148 def abi_process_file(fname, version, symmap):
 149     '''process one ABI file, adding new symbols to the symmap'''
 150     f = open(fname, mode='r')
 151     for line in f:
 152         symname = line.split(":")[0]
 153         if not symname in symmap:
 154             symmap[symname] = version
 155     f.close()
 156
 157
 158 def abi_write_vscript(f, libname, current_version, versions, symmap, abi_match):
 159     """Write a vscript file for a library in --version-script format.
 160
 161     :param f: File-like object to write to
 162     :param libname: Name of the library, uppercased
 163     :param current_version: Current version
 164     :param versions: Versions to consider
 165     :param symmap: Dictionary mapping symbols -> version
 166     :param abi_match: List of symbols considered to be public in the current
 167         version
 168     """
 169
 170     invmap = {}
 171     for s in symmap:
 172         invmap.setdefault(symmap[s], []).append(s)
 173
 174     last_key = ""
 175     versions = sorted(versions, key=version_key)
 176     for k in versions:
 177         symver = "%s_%s" % (libname, k)
 178         if symver == current_version:
 179             break
 180         f.write("%s {\n" % symver)
 181         if k in sorted(invmap.keys()):
 182             f.write("\tglobal:\n")
 183             for s in invmap.get(k, []):
 184                 f.write("\t\t%s;\n" % s);
 185         f.write("}%s;\n\n" % last_key)
 186         last_key = " %s" % symver
 187     f.write("%s {\n" % current_version)
 188     local_abi = filter(lambda x: x[0] == '!', abi_match)
 189     global_abi = filter(lambda x: x[0] != '!', abi_match)
 190     f.write("\tglobal:\n")
 191     if len(global_abi) > 0:
 192         for x in global_abi:
 193             f.write("\t\t%s;\n" % x)
 194     else:
 195         f.write("\t\t*;\n")
 196     if abi_match != ["*"]:
 197         f.write("\tlocal:\n")
 198         for x in local_abi:
 199             f.write("\t\t%s;\n" % x[1:])
 200         if len(global_abi) > 0:
 201             f.write("\t\t*;\n")
 202     f.write("};\n")
 203
 204
 205 def abi_build_vscript(task):
 206     '''generate a vscript file for our public libraries'''
 207
 208     tgt = task.outputs[0].bldpath(task.env)
 209
 210     symmap = {}
 211     versions = []
 212     for f in task.inputs:
 213         fname = f.abspath(task.env)
 214         basename = os.path.basename(fname)
 215         version = basename[len(task.env.LIBNAME)+1:-len(".sigs")]
 216         versions.append(version)
 217         abi_process_file(fname, version, symmap)
 218     f = open(tgt, mode='w')
 219     try:
 220         abi_write_vscript(f, task.env.LIBNAME, task.env.VERSION, versions,
 221             symmap, task.env.ABI_MATCH)
 222     finally:
 223         f.close()
 224
 225
 226 def ABI_VSCRIPT(bld, libname, abi_directory, version, vscript, abi_match=None):
 227     '''generate a vscript file for our public libraries'''
 228     if abi_directory:
 229         source = bld.path.ant_glob('%s/%s-[0-9]*.sigs' % (abi_directory, libname))
 230         def abi_file_key(path):
 231             return version_key(path[:-len(".sigs")].rsplit("-")[-1])
 232         source = sorted(source.split(), key=abi_file_key)
 233     else:
 234         source = ''
 235
 236     libname = os.path.basename(libname)
 237     version = os.path.basename(version)
 238     libname = libname.replace("-", "_").replace("+","_").upper()
 239     version = version.replace("-", "_").replace("+","_").upper()
 240
 241     t = bld.SAMBA_GENERATOR(vscript,
 242                             rule=abi_build_vscript,
 243                             source=source,
 244                             group='vscripts',
 245                             target=vscript)
 246     if abi_match is None:
 247         abi_match = ["*"]
 248     else:
 249         abi_match = samba_utils.TO_LIST(abi_match)
 250     t.env.ABI_MATCH = abi_match
 251     t.env.VERSION = version
 252     t.env.LIBNAME = libname
 253     t.vars = ['LIBNAME', 'VERSION', 'ABI_MATCH']
 254 Build.BuildContext.ABI_VSCRIPT = ABI_VSCRIPT