aadl2glueC.py 20.6 KB
Newer Older
1
#!/usr/bin/env python3
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# vim: set expandtab ts=8 sts=4 shiftwidth=4
#
# (C) Semantix Information Technologies.
#
# Semantix Information Technologies is licensing the code of the
# Data Modelling Tools (DMT) in the following dual-license mode:
#
# Commercial Developer License:
#       The DMT Commercial Developer License is the suggested version
# to use for the development of proprietary and/or commercial software.
# This version is for developers/companies who do not want to comply
# with the terms of the GNU Lesser General Public License version 2.1.
#
# GNU LGPL v. 2.1:
#       This version of DMT is the one to use for the development of
# applications, when you are willing to comply with the terms of the
# GNU Lesser General Public License version 2.1.
#
# Note that in both cases, there are no charges (royalties) for the
# generated code.
#
'''
Code Integrator

This is the core of the "glue" generators that Semantix developed for
the European research project ASSERT. It has been enhanced in the
context of Data Modelling and Data Modelling Tuning projects,
and continuous to evolve over the course of other projects.

This code starts by reading the AADL specification of the system.
It then generates the runtime bridge-code that will map the message
data structures from those generated by the Semantix Certified ASN.1
compiler to/from those generated by the modeling tool used to
functionally model the APLC subsystem (e.g. SCADE, ObjectGeode,
Matlab/Simulink, C, Ada, etc).

The code generation is done via user-visible (and editable) backends.

There are three kinds of backends:

1. Synchronous backends
=======================

For these, the working logic is:

for each subprogram implementation
    Load B mapper
    call OnStartup
    for each subprogram param
        Call OnBasic/OnSequence/OnEnumerated etc
    call OnShutdown

That is, there is OnStartup/OnInteger/OnSequence/.../OnShutdown cycle
done PER EACH SUBPROGRAM.

2. Asynchronous backends
========================

Asynchronous backends are only generating standalone encoders and decoders
(they are not doing this per sp.param).

The working logic is therefore different

OnStartup called ONCE for each async backend in use (used by this system's PIs)
Via the asynchronous.py, after visiting all params and collecting them,
for each asn.1 type that is actually used (at least once) as a param:
    Call Encoder and Decoder
Call OnShutdown ONCE for each async backend in use (used by this system's PIs)

3. Special backends
===================

GUI, Python, (VHDL?), etc...

These have custom requirements, so each one is handled by specific AADL2GLUEC
code. As it is now, the pattern follows that of the synchronous backends,
but with an extra call to OnFinal at the end.
'''

import os
import sys
import copy
84
import distutils.spawn as spawn
85
from importlib import import_module
86

87
88
from typing import Tuple, Any  # NOQA pylint: disable=unused-import

89
from . import commonPy
90

91
92
from .commonPy.utility import panic, inform
from .commonPy import verify
93
94
95
from .commonPy.asnParser import Filename, Typename, AST_Lookup, AST_TypesOfFile, AST_Leaftypes  # NOQA pylint: disable=unused-import
from .commonPy.asnAST import AsnNode  # NOQA pylint: disable=unused-import
from .commonPy.aadlAST import ApLevelContainer  # NOQA pylint: disable=unused-import
96

97
from . import B_mappers  # NOQA pylint: disable=unused-import
98

99
100
101
102
103
# To unpickle the Py2/ANTLR2-generated pickle file...
#    http://stackoverflow.com/questions/2121874/python-pickling-after-changing-a-modules-directory
from . import commonPy2
sys.modules['commonPy2'] = commonPy2

104
105
106
107
108
109
110
111
112
113
114
115
116
117
g_mappedName = {
    'SEQUENCE': 'OnSequence',
    'SET': 'OnSet',
    'CHOICE': 'OnChoice',
    'SEQUENCEOF': 'OnSequenceOf',
    'SETOF': 'OnSetOf',
    'ENUMERATED': 'OnEnumerated'
}


def ParseAADLfilesAndResolveSignals():
    '''Invokes the ANTLR generated AADL parser, and resolves
all references to AAADL Data types into the param._signal member
of each SUBPROGRAM param.'''
118
119
120
121
122
123
    import tempfile
    f = tempfile.NamedTemporaryFile(delete=False)
    astFile = f.name
    f.close()
    os.unlink(astFile)
    parserUtility = os.path.join(os.path.abspath(os.path.dirname(__file__)), "parse_aadl.py")
124
    cmd = "python2 " + parserUtility + " -o " + astFile + ' ' + ' '.join(sys.argv[1:])
125
126
127
128
129
    if os.system(cmd) != 0:
        if os.path.exists(astFile):
            os.unlink(astFile)
        panic("AADL parsing failed. Aborting...")

130
131
132
133
134
135
136
137
138
    def FixMetaClasses(sp):
        def patchMe(o):
            try:
                python2className = str(o.__class__).split("'")[1]
                if 'commonPy2' in python2className:
                    klass = commonPy
                    for step in python2className.split('.')[1:]:
                        klass = getattr(klass, step)
                    o.__class__ = klass
Thanassis Tsiodras's avatar
Thanassis Tsiodras committed
139
            except Exception as _:
140
141
142
143
144
145
146
                pass

        patchMe(sp)
        for param in sp._params:
            patchMe(param)
            patchMe(param._signal)
            patchMe(param._sourceElement)
Thanassis Tsiodras's avatar
Thanassis Tsiodras committed
147
148
149
150
        for c in sp._calls:
            patchMe(c)
        for cn in sp._connections:
            patchMe(cn)
151
152
    try:
        import pickle
153
        astInfo = pickle.load(open(astFile, 'rb'), fix_imports=False)
154
155
156
        for k in ['g_processImplementations', 'g_apLevelContainers',
                  'g_signals', 'g_systems', 'g_subProgramImplementations',
                  'g_threadImplementations']:
157
            setattr(commonPy.aadlAST, k, astInfo[k])
158
159
160
        for k in ['g_processImplementations',
                  'g_subProgramImplementations', 'g_threadImplementations']:
            for si in astInfo[k]:
Thanassis Tsiodras's avatar
Thanassis Tsiodras committed
161
162
                # sp, sp_impl, modelingLanguage, maybeFVname = si[0], si[1], si[2], si[3]
                sp = si[0]
163
164
                sp = commonPy.aadlAST.g_apLevelContainers[sp]
                FixMetaClasses(sp)
165
166
167
168
169
    except Exception as e:
        if os.path.exists(astFile):
            os.unlink(astFile)
        panic(str(e))

170
171
172
173
174
175

def SpecialCodes(unused_SystemsAndImplementations, unused_uniqueDataFiles, asnFiles, unused_useOSS):
    '''This function handles the code generations needs that reside outside
the scope of individual parameters (e.g. it needs access to all ASN.1
types). This used to cover Dumpable C/Ada Types and OG headers.'''
    outputDir = commonPy.configMT.outputDir
176
    asn1SccPath = spawn.find_executable('asn1.exe')
177
    if len(asnFiles) != 0:
178
        if not asn1SccPath:
179
            panic("ASN1SCC seems not installed on your system (asn1.exe not found in PATH).\n")  # pragma: no cover
180
        os.system('mono "{}" -wordSize 8 -typePrefix asn1Scc -Ada -equal -uPER -o "{}" "{}"'
Thanassis Tsiodras's avatar
Thanassis Tsiodras committed
181
                  .format(asn1SccPath, outputDir, '" "'.join(asnFiles)))
182
183
184
185
186
187


def main():
    if sys.argv.count("-o") != 0:
        idx = sys.argv.index("-o")
        try:
188
            commonPy.configMT.outputDir = os.path.normpath(sys.argv[idx + 1]) + os.sep
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
        except:  # pragma: no cover
            panic('Usage: %s [-verbose] [-useOSS] [-o dirname] input1.aadl [input2.aadl] ...\n' % sys.argv[0])  # pragma: no cover
        del sys.argv[idx]
        del sys.argv[idx]
        if not os.path.isdir(commonPy.configMT.outputDir):
            panic("'%s' is not a directory!\n" % commonPy.configMT.outputDir)  # pragma: no cover
    if "-onlySP" in sys.argv:  # pragma: no cover
        commonPy.configMT.g_bOnlySubprograms = True  # pragma: no cover
        sys.argv.remove("-onlySP")  # pragma: no cover
    if "-verbose" in sys.argv:
        commonPy.configMT.verbose = True
        sys.argv.remove("-verbose")
    useOSS = "-useOSS" in sys.argv
    if useOSS:
        sys.argv.remove("-useOSS")

    # No other options must remain in the cmd line...
    if len(sys.argv) < 2:
        panic('Usage: %s [-verbose] [-useOSS] [-o dirname] input1.aadl [input2.aadl] ...\n' % sys.argv[0])  # pragma: no cover
    commonPy.configMT.showCode = True
    for f in sys.argv[1:]:
        if not os.path.isfile(f):
            panic("'%s' is not a file!\n" % f)  # pragma: no cover

    ParseAADLfilesAndResolveSignals()

215
    uniqueDataFiles = {}  # type: Dict[Filename, Dict[str, List[ApLevelContainer]]]
216
    for sp in list(commonPy.aadlAST.g_apLevelContainers.values()):
217
218
219
220
221
        for param in sp._params:
            uniqueDataFiles.setdefault(param._signal._asnFilename, {})
            uniqueDataFiles[param._signal._asnFilename].setdefault(sp._language, [])
            uniqueDataFiles[param._signal._asnFilename][sp._language].append(sp)

222
    uniqueASNfiles = {}  # type: Dict[Filename, Tuple[AST_Lookup, List[AsnNode], AST_Leaftypes]]
223
224
    if len(list(uniqueDataFiles.keys())) != 0:
        commonPy.asnParser.ParseAsnFileList(list(uniqueDataFiles.keys()))
225
226

    for asnFile in uniqueDataFiles:
227
        tmpNames = {}  # type: AST_Lookup
228
229
230
        for name in commonPy.asnParser.g_typesOfFile[asnFile]:
            tmpNames[name] = commonPy.asnParser.g_names[name]

231
        uniqueASNfiles[asnFile] = (
232
233
            copy.copy(tmpNames),                            # map Typename to type definition class from asnAST
            copy.copy(commonPy.asnParser.g_astOfFile[asnFile]),    # list of nameless type definitions
234
            copy.copy(commonPy.asnParser.g_leafTypeDict))   # map from Typename to leafType
235
236

        inform("Checking that all base nodes have mandatory ranges set in %s..." % asnFile)
237
        for node in list(tmpNames.values()):
238
239
            verify.VerifyRanges(node, commonPy.asnParser.g_names)

240
    loadedBackends = set()  # type: Set[str]
241
242
243
244
245
246
247

    SystemsAndImplementations = commonPy.aadlAST.g_subProgramImplementations[:]
    SystemsAndImplementations.extend(commonPy.aadlAST.g_threadImplementations[:])
    SystemsAndImplementations.extend(commonPy.aadlAST.g_processImplementations[:])

    # Update ASN.1 nodes to carry size info (only for Signal params)
    for si in SystemsAndImplementations:
248
249
        spName, sp_impl, modelingLanguage = si[0], si[1], si[2]
        sp = commonPy.aadlAST.g_apLevelContainers[spName]
250
251
252
253
254
255
256
257
258
259
        for param in sp._params:
            asnFile = param._signal._asnFilename
            names = uniqueASNfiles[asnFile][0]
            leafTypeDict = uniqueASNfiles[asnFile][2]
            for nodeTypename in names:
                if nodeTypename != param._signal._asnNodename:
                    continue
                node = names[nodeTypename]
                if node._leafType == "AsciiString":
                    panic("You cannot use IA5String as a parameter - use OCTET STRING instead\n(%s)" % node.Location())  # pragma: no cover
260
                # (typo?) node._asnSize = param._signal._asnSize
261
262

    # If some AST nodes must be skipped (for any reason), go learn about them
263
    badTypes = commonPy.cleanupNodes.DiscoverBadTypes()
264

Maxime Perrotin's avatar
Maxime Perrotin committed
265
    if {"ada", "qgenada"} & {y[2].lower() for y in SystemsAndImplementations}:
266
267
        SpecialCodes(SystemsAndImplementations, uniqueDataFiles, uniqueASNfiles, useOSS)

268
    asynchronousBackends = []  # type: List[Any]  # No idea how to say list of module
269
270

    for si in SystemsAndImplementations:
271
272
        spName, sp_impl, modelingLanguage, maybeFVname = si[0], si[1], si[2], si[3]
        sp = commonPy.aadlAST.g_apLevelContainers[spName]
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
        inform("Creating glue for parameters of %s.%s...", sp._id, sp_impl)
        if modelingLanguage is None:
            continue  # pragma: no cover

        # Avoid generating empty glue - no parameters for this APLC
        if len(sp._params) == 0:
            continue

        # All SCADE versions are handled by lustre_B_mapper
        # if modelingLanguage[:6] == "Lustre" or modelingLanguage[:5] == "SCADE":
        #    modelingLanguage = "Lustre"  # pragma: no cover

        # The code for these mappers needs C ASN.1 codecs
        if modelingLanguage.lower() in ["gui_ri", "gui_pi", "vhdl", "rhapsody"]:
            modelingLanguage = "C"

289
        backendFilename = "." + modelingLanguage.lower() + "_B_mapper.py"
290
291
        inform("Parsing %s...", backendFilename)
        try:
292
            backend = import_module(backendFilename[:-3], 'dmt.B_mappers')  # pragma: no cover
293
            if backendFilename[:-3] not in loadedBackends:
294
                loadedBackends.add(backendFilename[:-3])
295
296
                if commonPy.configMT.verbose:
                    backend.Version()
297
298
        except ImportError as err:  # pragma: no cover
            panic("Failed to load backend ({}) for {}.{}: {}\n".format(backendFilename, sp._id, sp_impl, str(err)))  # pragma: no cover
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
            continue  # pragma: no cover

        # Asynchronous backends are only generating standalone encoders and decoders
        # (they are not doing this per sp.param).
        #
        # They must however do this when they have collected ALL the types they are
        # supposed to handle, so this can only be done when the loop over
        # SystemsAndImplementations has completed. We therefore accumulate them in a
        # container, and call their 'OnShutdown' method (which generates the encoders
        # and decoders) at the end (outside the loop). This of course means that we
        # can only call OnStartup once (when the backend is first loaded)
        if backend.isAsynchronous:
            if backend not in asynchronousBackends:
                asynchronousBackends.append(backend)
                # Only call OnStartup ONCE for asynchronous backends
                if 'OnStartup' in dir(backend):
                    # Also notice, no SP or SPIMPL are passed. We are asynchronous, so
                    # we only generate "generic" encoders and decoders, not SP-specific ones.
                    backend.OnStartup(modelingLanguage, asnFile, commonPy.configMT.outputDir, maybeFVname, useOSS)
        else:
            # In synchronous tools, always call OnStartup and OnShutdown for each SystemsAndImplementation
            if 'OnStartup' in dir(backend):
                backend.OnStartup(modelingLanguage, asnFile, sp, sp_impl, commonPy.configMT.outputDir, maybeFVname, useOSS)

        for param in sp._params:
            inform("Creating glue for param %s...", param._id)
            asnFile = param._signal._asnFilename
            names = commonPy.asnParser.g_names
            leafTypeDict = commonPy.asnParser.g_leafTypeDict

            inform("This param uses definitions from %s", asnFile)
            for nodeTypename in names:
                # Check if this type must be skipped
332
                if nodeTypename in badTypes:
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
                    continue

                # Async backends need to collect all types and create Encode/Decode functions for them.
                # So we allow async backends to pass thru this "if" - the collection of types
                # is done in the typesToWorkOn dictionary *inside* the base class (asynchronousTool.py)
                if (not backend.isAsynchronous) and nodeTypename != param._signal._asnNodename:
                    # For sync tools, only allow the typename we are using in this param to pass
                    continue
                node = names[nodeTypename]
                inform("ASN.1 node is %s", nodeTypename)

                # First, make sure we know what leaf type this node is
                if node._isArtificial:
                    continue  # artificially created (inner) type

                leafType = leafTypeDict[nodeTypename]
                # If it is a base type,
                if leafType in ['BOOLEAN', 'INTEGER', 'REAL', 'OCTET STRING']:
                    # make sure we have mapping instructions for BASE elements
                    if 'OnBasic' not in dir(backend):
                        panic("ASN.1 grammar contains literal(%s) but no BASE section found in the mapping grammar (%s)" % (nodeTypename, backendFilename))  # pragma: no cover
                    if not backend.isAsynchronous:
                        backend.OnBasic(nodeTypename, node, sp, sp_impl, param, leafTypeDict, names)
                    else:
                        backend.OnBasic(nodeTypename, node, leafTypeDict, names)
                # if it is a complex type
                elif leafType in ['SEQUENCE', 'SET', 'CHOICE', 'SEQUENCEOF', 'SETOF', 'ENUMERATED']:
                    # make sure we have mapping instructions for the element
                    if g_mappedName[leafType] not in dir(backend):
                        panic("ASN.1 grammar contains %s but no %s section found in the mapping grammar (%s)" % (nodeTypename, g_mappedName[leafType], backendFilename))  # pragma: no cover
                    processor = backend.__dict__[g_mappedName[leafType]]
                    if not backend.isAsynchronous:
                        processor(nodeTypename, node, sp, sp_impl, param, leafTypeDict, names)
                    else:
                        processor(nodeTypename, node, leafTypeDict, names)
                # what type is it?
                else:  # pragma: no cover
                    panic("Unexpected type of element: %s" % leafTypeDict[nodeTypename])  # pragma: no cover

        # For synchronous backend, call OnShutdown once per each sp_impl
        if not backend.isAsynchronous:
            if 'OnShutdown' in dir(backend):
                backend.OnShutdown(modelingLanguage, asnFile, sp, sp_impl, maybeFVname)

    # SystemsAndImplementation loop completed - time to call OnShutdown ONCE for each async backend that we loaded
    for asyncBackend in asynchronousBackends:
        if 'OnShutdown' in dir(backend):
            asyncBackend.OnShutdown(modelingLanguage, asnFile, maybeFVname)

    # The code generators for GUIs, Python mappers and VHDL mappers are different: they need access to
    # both ASN.1 types and SP params.
    # Custom code follows...

    # Do we need to handle any special subprograms?
    workedOnGUIs = False
    workedOnVHDL = False

    def mappers(lang):
        if lang.lower() in ["gui_pi", "gui_ri"]:
392
393
            return [import_module(".python_B_mapper", "dmt.B_mappers"),
                    import_module(".pyside_B_mapper", "dmt.B_mappers")]  # pragma: no cover
394
        elif lang.lower() == "vhdl":  # pragma: no cover
395
            return [import_module(".vhdl_B_mapper", "dmt.B_mappers")]  # pragma: no cover
396
397
398

    for si in [x for x in SystemsAndImplementations if x[2] is not None and x[2].lower() in ["gui_ri", "gui_pi", "vhdl"]]:
        # We do, start the work
399
400
        spName, sp_impl, lang, maybeFVname = si[0], si[1], si[2], si[3]
        sp = commonPy.aadlAST.g_apLevelContainers[spName]
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
        if len(sp._params) == 0:
            if lang.lower() == "gui_ri":  # pragma: no cover
                if "gui_polling" not in sp._id:  # pragma: no cover
                    panic("Due to wxWidgets limitations, your TCs must have at least one parameter (fix %s)" % sp._id)  # pragma: no cover
            continue  # pragma: no cover
        if lang.lower() in ["gui_pi", "gui_ri"]:
            workedOnGUIs = True
        if lang.lower() == "vhdl":
            workedOnVHDL = True  # pragma: no cover
        inform("Creating %s for %s.%s", lang.upper(), sp._id, sp_impl)
        for b in mappers(lang):
            b.OnStartup(lang, asnFile, sp, sp_impl, commonPy.configMT.outputDir, maybeFVname, useOSS)
        for param in sp._params:
            inform("Processing param %s...", param._id)
            asnFile = param._signal._asnFilename
            names = commonPy.asnParser.g_names
            leafTypeDict = commonPy.asnParser.g_leafTypeDict
            nodeTypename = param._signal._asnNodename
            node = names[nodeTypename]
            inform("ASN.1 node is %s", nodeTypename)
Thanassis Tsiodras's avatar
Thanassis Tsiodras committed
421
422
            # if node._isArtificial:
            #     continue # artificially created (inner) type pragma: no cover
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
            leafType = leafTypeDict[nodeTypename]
            if leafType in ['BOOLEAN', 'INTEGER', 'REAL', 'OCTET STRING']:
                for b in mappers(lang):
                    b.OnBasic(nodeTypename, node, sp, sp_impl, param, leafTypeDict, names)
            elif leafType in ['SEQUENCE', 'SET', 'CHOICE', 'SEQUENCEOF', 'SETOF', 'ENUMERATED']:
                for b in mappers(lang):
                    processor = b.__dict__[g_mappedName[leafType]]
                    processor(nodeTypename, node, sp, sp_impl, param, leafTypeDict, names)
            else:  # pragma: no cover
                panic("Unexpected type of element: %s" % leafTypeDict[nodeTypename])  # pragma: no cover
        for b in mappers(lang):
            b.OnShutdown(lang, asnFile, sp, sp_impl, maybeFVname)
    # if we processed any GUI subprogram, add footers and close files
    if workedOnGUIs:
        for b in mappers('gui_ri'):
            b.OnFinal()
    # if we processed any VHDL subprogram, add footers and close files
    if workedOnVHDL:
        for b in mappers('vhdl'):  # pragma: no cover
            b.OnFinal()  # pragma: no cover

if __name__ == "__main__":
445
446
447
448
449
450
    if "-pdb" in sys.argv:
        sys.argv.remove("-pdb")  # pragma: no cover
        import pdb  # pragma: no cover pylint: disable=wrong-import-position,wrong-import-order
        pdb.run('main()')  # pragma: no cover
    else:
        main()