source: rtems-libbsd/builder.py @ 314be23

4.1155-freebsd-126-freebsd-12freebsd-9.3
Last change on this file since 314be23 was 314be23, checked in by Chris Johns <chrisj@…>, on 05/01/15 at 06:02:22

freebsd-to-rtems: Refactor the conversion support to allow multiples build systems.

Split the freebsd-to-rtems.py into separate parts to allow more than
a single build system generator.
  • Property mode set to 100755
File size: 16.5 KB
Line 
1#
2#  Copyright (c) 2015 Chris Johns <chrisj@rtems.org>. All rights reserved.
3#
4#  Copyright (c) 2009-2015 embedded brains GmbH.  All rights reserved.
5#
6#   embedded brains GmbH
7#   Dornierstr. 4
8#   82178 Puchheim
9#   Germany
10#   <info@embedded-brains.de>
11#
12#  Copyright (c) 2012 OAR Corporation. All rights reserved.
13#
14#  Redistribution and use in source and binary forms, with or without
15#  modification, are permitted provided that the following conditions
16#  are met:
17#  1. Redistributions of source code must retain the above copyright
18#     notice, this list of conditions and the following disclaimer.
19#  2. Redistributions in binary form must reproduce the above copyright
20#     notice, this list of conditions and the following disclaimer in the
21#     documentation and/or other materials provided with the distribution.
22#
23#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24#  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25#  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26#  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27#  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28#  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29#  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30#  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31#  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32#  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34
35# FreeBSD: http://svn.freebsd.org/base/releng/8.2/sys (revision 222485)
36
37import shutil
38import os
39import re
40import sys
41import getopt
42import filecmp
43import difflib
44
45#
46# Global controls.
47#
48RTEMS_DIR = "."
49FreeBSD_DIR = "freebsd-org"
50isVerbose = False
51isDryRun = False
52isDiffMode = False
53filesProcessed = 0
54
55# compare and process file only if different
56#  + copy or diff depending on execution mode
57def processIfDifferent(new, old, src):
58
59    global filesProcessed
60    global isVerbose, isDryRun, isEarlyExit
61
62    if not os.path.exists(old) or \
63       filecmp.cmp(new, old, shallow = False) == False:
64        filesProcessed += 1
65        if isDiffMode == False:
66            if isVerbose == True:
67                print "Move " + src + " to " + old
68            if isDryRun == False:
69                shutil.move(new, old)
70        else:
71            if isVerbose == True:
72                print "Diff %s => %s" % (src, new)
73            old_contents = open(old).readlines()
74            new_contents = open(new).readlines()
75            for line in \
76                difflib.unified_diff(old_contents, new_contents,
77                                     fromfile = src, tofile = new, n = 5):
78                sys.stdout.write(line)
79
80# Move target dependent files under a machine directory
81def mapCPUDependentPath(path):
82  return path.replace("include/", "include/machine/")
83
84def fixIncludes(data):
85    data = re.sub('#include <sys/lock.h>', '#include <rtems/bsd/sys/lock.h>', data)
86    data = re.sub('#include <sys/time.h>', '#include <rtems/bsd/sys/time.h>', data)
87    data = re.sub('#include <sys/cpuset.h>', '#include <rtems/bsd/sys/cpuset.h>', data)
88    data = re.sub('#include <sys/errno.h>', '#include <rtems/bsd/sys/errno.h>', data)
89    data = re.sub('#include <sys/param.h>', '#include <rtems/bsd/sys/param.h>', data)
90    data = re.sub('#include <sys/types.h>', '#include <rtems/bsd/sys/types.h>', data)
91    data = re.sub('#include <sys/resource.h>', '#include <rtems/bsd/sys/resource.h>', data)
92    data = re.sub('#include <sys/unistd.h>', '#include <rtems/bsd/sys/unistd.h>', data)
93    data = re.sub('#include <sys/_types.h>', '#include <rtems/bsd/sys/_types.h>', data)
94    return data
95
96# revert fixing the include paths inside a C or .h file
97def revertFixIncludes(data):
98    data = re.sub('#include <rtems/bsd/', '#include <', data)
99    data = re.sub('#include <util.h>', '#include <rtems/bsd/util.h>', data)
100    data = re.sub('#include <bsd.h>', '#include <rtems/bsd/bsd.h>', data)
101    data = re.sub('#include <zerocopy.h>', '#include <rtems/bsd/zerocopy.h>', data)
102    return data
103
104# fix include paths inside a C or .h file
105def fixLocalIncludes(data):
106    data = re.sub('#include "opt_([^"]*)"', '#include <rtems/bsd/local/opt_\\1>', data)
107    data = re.sub('#include "([^"]*)_if.h"', '#include <rtems/bsd/local/\\1_if.h>', data)
108    data = re.sub('#include "miidevs([^"]*)"', '#include <rtems/bsd/local/miidevs\\1>', data)
109    data = re.sub('#include "usbdevs([^"]*)"', '#include <rtems/bsd/local/usbdevs\\1>', data)
110    return data
111
112# revert fixing the include paths inside a C or .h file
113def revertFixLocalIncludes(data):
114    data = re.sub('#include <rtems/bsd/local/([^>]*)>', '#include "\\1"', data)
115    return data
116
117def assertHeaderFile(path):
118    if path[-2] != '.' or path[-1] != 'h':
119        print "*** " + path + " does not end in .h"
120        print "*** Move it to a C source file list"
121        sys.exit(2)
122
123def assertSourceFile(path):
124    if path[-2] != '.' or (path[-1] != 'c' and path[-1] != 'S'):
125        print "*** " + path + " does not end in .c"
126        print "*** Move it to a header file list"
127        sys.exit(2)
128
129class Converter(object):
130    def convert(self, src):
131        return open(src).read()
132
133    def isConvertible(self):
134        return True
135
136class NoConverter(Converter):
137    def convert(self, src):
138        raise
139
140    def isConvertible(self):
141        return False
142
143class EmptyConverter(Converter):
144    def convert(self, src):
145        return '/* EMPTY */\n'
146
147class FromFreeBSDToRTEMSHeaderConverter(Converter):
148    def convert(self, src):
149        data = super(FromFreeBSDToRTEMSHeaderConverter, self).convert(src)
150        data = fixLocalIncludes(data)
151        data = fixIncludes(data)
152        return data
153
154class FromFreeBSDToRTEMSUserSpaceHeaderConverter(Converter):
155    def convert(self, src):
156        data = super(FromFreeBSDToRTEMSUserSpaceHeaderConverter, self).convert(src)
157        data = fixIncludes(data)
158        return data
159
160class FromFreeBSDToRTEMSSourceConverter(Converter):
161    def convert(self, src):
162        data = super(FromFreeBSDToRTEMSSourceConverter, self).convert(src)
163        data = fixLocalIncludes(data)
164        data = fixIncludes(data)
165        data = '#include <machine/rtems-bsd-kernel-space.h>\n\n' + data
166        return data
167
168class FromFreeBSDToRTEMSUserSpaceSourceConverter(Converter):
169    def convert(self, src):
170        data = super(FromFreeBSDToRTEMSUserSpaceSourceConverter, self).convert(src)
171        data = fixIncludes(data)
172        data = '#include <machine/rtems-bsd-user-space.h>\n\n' + data
173        return data
174
175class FromRTEMSToFreeBSDHeaderConverter(Converter):
176    def convert(self, src):
177        data = super(FromRTEMSToFreeBSDHeaderConverter, self).convert(src)
178        data = revertFixLocalIncludes(data)
179        data = revertFixIncludes(data)
180        return data
181
182class FromRTEMSToFreeBSDSourceConverter(Converter):
183    def convert(self, src):
184        data = super(FromRTEMSToFreeBSDSourceConverter, self).convert(src)
185        data = re.sub('#include <machine/rtems-bsd-kernel-space.h>\n\n', '', data)
186        data = re.sub('#include <machine/rtems-bsd-user-space.h>\n\n', '', data)
187        data = revertFixLocalIncludes(data)
188        data = revertFixIncludes(data)
189        return data
190
191class PathComposer(object):
192    def composeFreeBSDPath(self, path):
193        return path
194
195    def composeRTEMSPath(self, path, prefix):
196        path = prefix + path
197        return path
198
199class FreeBSDPathComposer(PathComposer):
200    def composeFreeBSDPath(self, path):
201        return FreeBSD_DIR + '/' + path
202
203    def composeRTEMSPath(self, path, prefix):
204        return prefix + 'freebsd/' + path
205
206class RTEMSPathComposer(PathComposer):
207    def composeFreeBSDPath(self, path):
208        return path
209
210    def composeRTEMSPath(self, path, prefix):
211        path = prefix + 'rtemsbsd/' + path
212        return path
213
214class CPUDependentPathComposer(FreeBSDPathComposer):
215    def composeRTEMSPath(self, path, prefix):
216        path = super(CPUDependentPathComposer, self).composeRTEMSPath(path, prefix)
217        path = mapCPUDependentPath(path)
218        return path
219
220class TargetSourceCPUDependentPathComposer(CPUDependentPathComposer):
221    def __init__(self, targetCPU, sourceCPU):
222        self.targetCPU = targetCPU
223        self.sourceCPU = sourceCPU
224
225    def composeRTEMSPath(self, path, prefix):
226        path = super(TargetSourceCPUDependentPathComposer, self).composeRTEMSPath(path, prefix)
227        path = path.replace(self.sourceCPU, self.targetCPU)
228        return path
229
230class BuildSystemFragmentComposer(object):
231    def compose(self, path):
232        return ''
233
234class File(object):
235    def __init__(self, path, pathComposer,
236                 fromFreeBSDToRTEMSConverter, fromRTEMSToFreeBSDConverter, buildSystemComposer):
237        self.path = path
238        self.pathComposer = pathComposer
239        self.fromFreeBSDToRTEMSConverter = fromFreeBSDToRTEMSConverter
240        self.fromRTEMSToFreeBSDConverter = fromRTEMSToFreeBSDConverter
241        self.buildSystemComposer = buildSystemComposer
242
243    def copy(self, dst, src, converter = None):
244        import tempfile
245        if converter is not None and converter.isConvertible():
246            try:
247                if isDryRun == False:
248                    os.makedirs(os.path.dirname(dst))
249            except OSError:
250                pass
251            data = converter.convert(src)
252            try:
253                out = tempfile.NamedTemporaryFile(delete = False)
254                out.write(data)
255                out.close()
256                processIfDifferent(out.name, dst, src)
257            finally:
258                try:
259                    os.remove(out.name)
260                except:
261                    pass
262
263    def copyFromFreeBSDToRTEMS(self):
264        src = self.pathComposer.composeFreeBSDPath(self.path)
265        dst = self.pathComposer.composeRTEMSPath(self.path, RTEMS_DIR + '/')
266        self.copy(dst, src, self.fromFreeBSDToRTEMSConverter)
267
268    def copyFromRTEMSToFreeBSD(self):
269        src = self.pathComposer.composeRTEMSPath(self.path, RTEMS_DIR + '/')
270        dst = self.pathComposer.composeFreeBSDPath(self.path)
271        self.copy(dst, src, self.fromRTEMSToFreeBSDConverter)
272
273    def getFragment(self):
274        return self.buildSystemComposer.compose(self.pathComposer.composeRTEMSPath(self.path, ''))
275
276# Module - logical group of related files we can perform actions on
277class Module:
278    def __init__(self, name):
279        self.name = name
280        self.conditionalOn = "none"
281        self.files = []
282        self.cpuDependentSourceFiles = {}
283        self.dependencies = []
284
285    def initCPUDependencies(self, cpu):
286        if cpu not in self.cpuDependentSourceFiles:
287            self.cpuDependentSourceFiles[cpu] = []
288
289    def copyFromFreeBSDToRTEMS(self):
290        for f in self.files:
291            f.copyFromFreeBSDToRTEMS()
292        for cpu, files in self.cpuDependentSourceFiles.items():
293            for f in files:
294                f.copyFromFreeBSDToRTEMS()
295
296    def copyFromRTEMSToFreeBSD(self):
297        for f in self.files:
298            f.copyFromRTEMSToFreeBSD()
299        for cpu, files in self.cpuDependentSourceFiles.items():
300            for f in files:
301                f.copyFromRTEMSToFreeBSD()
302
303    def addFiles(self, newFiles, buildSystemComposer = BuildSystemFragmentComposer()):
304        files = []
305        for newFile in newFiles:
306            assertFile(newFile)
307            files += [File(newFile, composers, buildSystemComposer)]
308        return files
309
310    def addFile(self, f):
311        self.files += [f]
312
313    def addFiles(self, newFiles,
314                 pathComposer, fromFreeBSDToRTEMSConverter, fromRTEMSToFreeBSDConverter,
315                 assertFile, buildSystemComposer = BuildSystemFragmentComposer()):
316        files = []
317        for newFile in newFiles:
318            assertFile(newFile)
319            files += [File(newFile, pathComposer, fromFreeBSDToRTEMSConverter,
320                           fromRTEMSToFreeBSDConverter, buildSystemComposer)]
321        return files
322
323    def addKernelSpaceHeaderFiles(self, files):
324        self.files += self.addFiles(files,
325                                    FreeBSDPathComposer(), FromFreeBSDToRTEMSHeaderConverter(),
326                                    FromRTEMSToFreeBSDHeaderConverter(), assertHeaderFile)
327
328    def addUserSpaceHeaderFiles(self, files):
329        self.files += self.addFiles(files,
330                                    FreeBSDPathComposer(), FromFreeBSDToRTEMSUserSpaceHeaderConverter(),
331                                    FromRTEMSToFreeBSDHeaderConverter(), assertHeaderFile)
332
333    def addRTEMSHeaderFiles(self, files):
334        self.files += self.addFiles(files, RTEMSPathComposer(),
335                                    NoConverter(), NoConverter(), assertHeaderFile)
336
337    def addCPUDependentHeaderFiles(self, files):
338        self.files += self.addFiles(files,
339                                    CPUDependentPathComposer(), FromFreeBSDToRTEMSHeaderConverter(),
340                                    FromRTEMSToFreeBSDHeaderConverter(), assertHeaderFile)
341
342    def addTargetSourceCPUDependentHeaderFiles(self, targetCPUs, sourceCPU, files):
343        for cpu in targetCPUs:
344            self.files += self.addFiles(files,
345                                        TargetSourceCPUDependentPathComposer(cpu, sourceCPU),
346                                        FromFreeBSDToRTEMSHeaderConverter(),
347                                        NoConverter(), assertHeaderFile)
348
349    def addSourceFiles(self, files, sourceFileFragmentComposer):
350        self.files += self.addFiles(files,
351                                    PathComposer(), NoConverter(), NoConverter(), assertSourceFile,
352                                    sourceFileFragmentComposer)
353
354    def addKernelSpaceSourceFiles(self, files, sourceFileFragmentComposer):
355        self.files += self.addFiles(files,
356                                    FreeBSDPathComposer(), FromFreeBSDToRTEMSSourceConverter(),
357                                    FromRTEMSToFreeBSDSourceConverter(), assertSourceFile,
358                                    sourceFileFragmentComposer)
359
360    def addUserSpaceSourceFiles(self, files, sourceFileFragmentComposer):
361        self.files += self.addFiles(files,
362                                    FreeBSDPathComposer(),
363                                    FromFreeBSDToRTEMSUserSpaceSourceConverter(),
364                                    FromRTEMSToFreeBSDSourceConverter(), assertSourceFile,
365                                    sourceFileFragmentComposer)
366
367    def addRTEMSSourceFiles(self, files, sourceFileFragmentComposer):
368        self.files += self.addFiles(files,
369                                    RTEMSPathComposer(), NoConverter(), NoConverter(),
370                                    assertSourceFile, sourceFileFragmentComposer)
371
372    def addCPUDependentSourceFiles(self, cpu, files, sourceFileFragmentComposer):
373        self.initCPUDependencies(cpu)
374        self.cpuDependentSourceFiles[cpu] += \
375            self.addFiles(files,
376                          CPUDependentPathComposer(), FromFreeBSDToRTEMSSourceConverter(),
377                          FromRTEMSToFreeBSDSourceConverter(), assertSourceFile,
378                          sourceFileFragmentComposer)
379
380    def addTargetSourceCPUDependentSourceFiles(self, targetCPUs, sourceCPU, files,
381                                               sourceFileFragmentComposer):
382        for cpu in targetCPUs:
383            self.initCPUDependencies(cpu)
384            self.cpuDependentSourceFiles[cpu] += \
385                self.addFiles(files,
386                              TargetSourceCPUDependentPathComposer(cpu, sourceCPU),
387                              FromFreeBSDToRTEMSSourceConverter(), NoConverter(),
388                              assertSourceFile, sourceFileFragmentComposer)
389
390    def addTest(self, testFragementComposer):
391        self.files += [File(testFragementComposer.testName,
392                            PathComposer(), NoConverter(), NoConverter(),
393                            testFragementComposer)]
394
395    def addDependency(self, dep):
396        self.dependencies += [dep]
397
398class ModuleManager:
399    def __init__(self):
400        self.modules = {}
401        self.generator = {}
402        self.setGenerators()
403
404    def __getitem__(self, key):
405        if key not in self.modules:
406            raise KeyError('module %s not found' % (key))
407        return self.modules[key]
408
409    def getModules(self):
410        return sorted(self.modules.keys())
411
412    def addModule(self, module):
413        self.modules[module.name] = module
414
415    def copyFromFreeBSDToRTEMS(self):
416        for m in sorted(self.modules):
417            self.modules[m].copyFromFreeBSDToRTEMS()
418
419    def copyFromRTEMSToFreeBSD(self):
420        for m in sorted(self.modules):
421            self.modules[m].copyFromRTEMSToFreeBSD()
Note: See TracBrowser for help on using the repository browser.