buildtools/wafsamba/samba_pidl.py

   1 # waf build tool for building IDL files with pidl
   2
   3 import os
   4 from waflib import Build, Utils
   5 from waflib.TaskGen import feature, before
   6 from samba_utils import SET_TARGET_TYPE, TO_LIST, LOCAL_CACHE
   7
   8 def SAMBA_PIDL(bld, pname, source,
   9                options='',
  10                output_dir='.',
  11                generate_tables=True):
  12     '''Build a IDL file using pidl.
  13        This will produce up to 17 output files depending on the options used'''
  14
  15     bname = source[0:-4] # strip off the .idl suffix
  16     bname = os.path.basename(bname)
  17     name = "%s_%s" % (pname, bname.upper())
  18
  19     if not SET_TARGET_TYPE(bld, name, 'PIDL'):
  20         return
  21
  22     bld.SET_BUILD_GROUP('build_source')
  23
  24     # the output files depend on the options used. Use this dictionary
  25     # to map between the options and the resulting file names
  26     options_map = { '--header'            : '%s.h',
  27                     '--ndr-parser'        : 'ndr_%s.c ndr_%s.h',
  28                     '--samba3-ndr-server' : 'srv_%s.c srv_%s.h',
  29                     '--samba3-ndr-client' : 'cli_%s.c cli_%s.h',
  30                     '--server'            : 'ndr_%s_s.c',
  31                     '--server-compat'     : 'ndr_%s_scompat.c ndr_%s_scompat.h',
  32                     '--client'            : 'ndr_%s_c.c ndr_%s_c.h',
  33                     '--python'            : 'py_%s.c',
  34                     '--tdr-parser'        : 'tdr_%s.c tdr_%s.h',
  35                     '--dcom-proxy'        : '%s_p.c',
  36                     '--com-header'        : 'com_%s.h'
  37                     }
  38
  39     table_header_idx = None
  40     out_files = []
  41     options_list = TO_LIST(options)
  42
  43     for o in options_list:
  44         if o in options_map:
  45             ofiles = TO_LIST(options_map[o])
  46             for f in ofiles:
  47                 out_files.append(os.path.join(output_dir, f % bname))
  48                 if f == 'ndr_%s.h':
  49                     # remember this one for the tables generation
  50                     table_header_idx = len(out_files) - 1
  51
  52     # depend on the full pidl sources
  53     source = TO_LIST(source)
  54     try:
  55         pidl_src_nodes = bld.pidl_files_cache
  56     except AttributeError:
  57         bld.pidl_files_cache = bld.srcnode.ant_glob('pidl/lib/Parse/**/*.pm', flat=False)
  58         bld.pidl_files_cache.extend(bld.srcnode.ant_glob('pidl', flat=False))
  59         pidl_src_nodes = bld.pidl_files_cache
  60
  61     # the cd .. is needed because pidl currently is sensitive to the directory it is run in
  62     cpp = ""
  63     cc = ""
  64     if bld.CONFIG_SET("CPP") and bld.CONFIG_GET("CPP") != "":
  65         if isinstance(bld.CONFIG_GET("CPP"), list):
  66             cpp = 'CPP="%s"' % " ".join(bld.CONFIG_GET("CPP"))
  67         else:
  68             cpp = 'CPP="%s"' % bld.CONFIG_GET("CPP")
  69
  70     if cpp == "CPP=xlc_r":
  71         cpp = ""
  72
  73     if bld.env['PIDL_DEVELOPER_MODE']:
  74         pidl_dev = 'PIDL_DEVELOPER=1 '
  75     else:
  76         pidl_dev = ''
  77
  78     if bld.CONFIG_SET("CC"):
  79         if isinstance(bld.CONFIG_GET("CC"), list):
  80             cc = 'CC="%s"' % " ".join(bld.CONFIG_GET("CC"))
  81         else:
  82             cc = 'CC="%s"' % bld.CONFIG_GET("CC")
  83
  84     t = bld(rule='cd ${PIDL_LAUNCH_DIR} && %s%s %s ${PERL} ${PIDL} --quiet ${OPTIONS} --outputdir ${OUTPUTDIR} -- "${IDLSRC}"' % (pidl_dev, cpp, cc),
  85             ext_out    = '.c',
  86             before     = 'c',
  87             update_outputs = True,
  88             shell      = True,
  89             source     = source,
  90             target     = out_files,
  91             name       = name,
  92             samba_type = 'PIDL')
  93
  94
  95     t.env.PIDL_LAUNCH_DIR = bld.srcnode.path_from(bld.bldnode)
  96     pnode = bld.srcnode.find_resource('pidl/pidl')
  97     t.env.PIDL = pnode.path_from(bld.srcnode)
  98     t.env.OPTIONS = TO_LIST(options)
  99     snode = t.path.find_resource(source[0])
 100     t.env.IDLSRC = snode.path_from(bld.srcnode)
 101     t.env.OUTPUTDIR = bld.bldnode.path_from(bld.srcnode) + '/' + bld.path.find_dir(output_dir).path_from(bld.srcnode)
 102
 103     bld.add_manual_dependency(snode, pidl_src_nodes)
 104
 105     if generate_tables and table_header_idx is not None:
 106         pidl_headers = LOCAL_CACHE(bld, 'PIDL_HEADERS')
 107         pidl_headers[name] = [bld.path.find_or_declare(out_files[table_header_idx])]
 108
 109     t.more_includes = '#' + bld.path.path_from(bld.srcnode)
 110 Build.BuildContext.SAMBA_PIDL = SAMBA_PIDL
 111
 112 def SAMBA_PIDL_LIST(bld, name, source,
 113                     options='',
 114                     output_dir='.',
 115                     generate_tables=True,
 116                     generate_fuzzers=True):
 117     '''A wrapper for building a set of IDL files'''
 118     for p in TO_LIST(source):
 119         bld.SAMBA_PIDL(name, p, options=options, output_dir=output_dir, generate_tables=generate_tables)
 120
 121         # Some IDL files don't exactly match between name and
 122         # "interface" so we need a way to skip those, while other IDL
 123         # files have the table generation skipped entirely, on which
 124         # the fuzzers rely
 125         if generate_tables and generate_fuzzers:
 126             interface = p[0:-4] # strip off the .idl suffix
 127             bld.SAMBA_NDR_FUZZ(interface,
 128                                auto_deps=True,
 129                                fuzz_type="TYPE_STRUCT")
 130
 131             # Only generate the TYPE_STRUCT fuzzer if this isn't
 132             # really DCE/RPC
 133             if '--client' in options:
 134                 bld.SAMBA_NDR_FUZZ(interface,
 135                                    auto_deps=True,
 136                                    fuzz_type="TYPE_IN")
 137                 bld.SAMBA_NDR_FUZZ(interface,
 138                                    auto_deps=True,
 139                                    fuzz_type="TYPE_OUT")
 140 Build.BuildContext.SAMBA_PIDL_LIST = SAMBA_PIDL_LIST
 141
 142
 143 #################################################################
 144 # the rule for generating the NDR tables
 145 @feature('collect')
 146 @before('exec_rule')
 147 def collect(self):
 148     pidl_headers = LOCAL_CACHE(self.bld, 'PIDL_HEADERS')
 149     # The first source is tables.pl itself
 150     self.source = Utils.to_list(self.source)
 151     for (name, hd) in pidl_headers.items():
 152         y = self.bld.get_tgen_by_name(name)
 153         self.bld.ASSERT(y is not None, 'Failed to find PIDL header %s' % name)
 154         y.post()
 155         for node in hd:
 156             self.bld.ASSERT(node is not None, 'Got None as build node generating PIDL table for %s' % name)
 157             self.source.append(node)
 158
 159
 160 def SAMBA_PIDL_TABLES(bld, name, target):
 161     '''generate the pidl NDR tables file'''
 162     bld.SET_BUILD_GROUP('main')
 163     t = bld(
 164             features = 'collect',
 165             rule     = '${PERL} ${SRC} > ${TGT}',
 166             ext_out  = '.c',
 167             before   = 'c',
 168             update_outputs = True,
 169             shell    = True,
 170             source   = '../../librpc/tables.pl',
 171             target   = target,
 172             name     = name)
 173     t.env.LIBRPC = os.path.join(bld.srcnode.abspath(), 'librpc')
 174 Build.BuildContext.SAMBA_PIDL_TABLES = SAMBA_PIDL_TABLES
 175