AdaGenerator.py 127 KB
Newer Older
Maxime Perrotin's avatar
Maxime Perrotin committed
1
2
3
4
5
6
7
8
9
10
11
#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
    OpenGEODE - A tiny SDL Editor for TASTE

    This module generates Ada code from SDL process models.
    The Ada code is compliant with the TASTE interfaces, and is
    using the ASN.1 "Space-Certified" compiler for data type definition.
    (See TASTE documentation for more information)

Maxime Perrotin's avatar
Maxime Perrotin committed
12
    The design is flexible and can be used as basis for other backends.
Maxime Perrotin's avatar
Maxime Perrotin committed
13
14
15
16
17
18
19
20
21
22
23

    Entry point:
    The AST of the model that is parsed is described in ogAST.py

    A Visitor Pattern using Python's "singledispatch" mechanism is used
    to go through the AST and generate code for each SDL construct.

    There is a single function called "generate", decorated with the
    singledispatch mechanism, that needs to be called to generate the code
    of any AST element.

Maxime Perrotin's avatar
Maxime Perrotin committed
24
25
26
    The generate function returns two values: "code" and "local_decl",
    containing a set of statements and a set of local variables
    (that can be later placed anywhere in the code).
Maxime Perrotin's avatar
Maxime Perrotin committed
27

Maxime Perrotin's avatar
Maxime Perrotin committed
28
29
30
31
32
    Expressions (all classes derived from ogAST.Expression) are generated
    using the "expression" visitor (singledispatch set of function).

    Expressions return three values: "code", "ada_string" and "local_decl".
    The "ada_string" value is the usable string that corresponds
Maxime Perrotin's avatar
Maxime Perrotin committed
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
    to the result of the expression evaluation.

    For example, take the SDL statement "OUTPUT hello(a+5)"

    This results (in TASTE terminology) in calling the required interface
    called "hello" and passing a parameter of an ASN.1 type (say MyInteger).
    The parameter is always passed by reference.

    It is therefore necessary to build a temporary variable to hold the result
    of the "a+5" expression.

    In this example, the "generate" function will return:
    local_decl = ["tmp01 : MyInteger;"]
    (The template backend can then place it wherever appropriate)

    and code = ["tmp01 := a + 5;", "hello(tmp01);"]
    (The template will then do a '\n'.join(code) - and add indents, etc.)

    To know about "tmp01" and generate the code "hello(tmp01);",
    the function will recursively call "generate" and
    pass a+5 as parameter. The call will return the tuple:

    local_decl = ["tmp01 : MyInteger;"]
    code = ["tmp01 := a + 5;"]
    ada_string = "tmp01"

    This design allows to have any level of complexity in the embedded
    expression in a way that is easy to handle (adding constructs with
    this pattern is straightforward, once the generate function for each AST
    entry is properly implemented).

    Copyright (c) 2012-2013 European Space Agency

    Designed and implemented by Maxime Perrotin

    Contact: maxime.perrotin@esa.int
"""


import logging
73
import traceback
74
import os
75
import stat
76
from itertools import chain, product
Maxime Perrotin's avatar
Maxime Perrotin committed
77
78
79
from singledispatch import singledispatch

import ogAST
80
import Helper
Maxime Perrotin's avatar
Maxime Perrotin committed
81
82
83
84
85
86
87
88
89
90
91
92
93

LOG = logging.getLogger(__name__)

__all__ = ['generate']

# reference to the ASN.1 Data view and to the visible variables (in scope)
TYPES = None
VARIABLES = {}
LOCAL_VAR = {}
# List of output signals and procedures
OUT_SIGNALS = []
PROCEDURES = []

94
95
96
# Specify that the target is a shared library
SHARED_LIB = False

97
UNICODE_SEP = u'\u00dc'
98
LPREFIX = u'ctxt'
Maxime Perrotin's avatar
Maxime Perrotin committed
99

100
101
102
103
104
105
106
107
108
109

def is_numeric(string):
    ''' Return true if value is a number '''
    try:
        float(string)
    except ValueError:
        return False
    return True


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
def external_ri_list(process):
    ''' Helper function: create a list of RI with proper signature
    Used for the formal parameters of generic packages when using process type
    '''
    result = []
    for signal in process.output_signals:
        param_name = signal.get('param_name') \
                                or u'{}_param'.format(signal['name'])
        param_spec = ''
        if 'type' in signal:
            typename = type_name(signal['type'])
            param_spec = u'({pName}: access {sort})'.format(pName=param_name,
                                                            sort=typename)
        result.append(u"procedure RI{sep}{name}{param}".format(sep=UNICODE_SEP,
                                                           name=signal['name'],
                                                           param=param_spec))
    for proc in (proc for proc in process.procedures if proc.external):
        ri_header = u'procedure RI{sep}{sig_name}'.format(
                                                     sep=UNICODE_SEP,
                                                     sig_name=proc.inputString)
        params = []
        params_spec = ''
        for param in proc.fpar:
            typename = type_name(param['type'])
            params.append(u'{par[name]}: access {sort}'.format(par=param,
                                                               sort=typename))
        if params:
            params_spec = u"({})".format("; ".join(params))
            ri_header += params_spec
        result.append(ri_header)
140
141
142
143
144
145

    for timer in process.timers:
        result.append(u"procedure set_{}(val: access asn1SccT_Uint32)"
                      .format(timer))
        result.append(u"procedure reset_{}"
                      .format(timer))
146
147
148
    return result


Maxime Perrotin's avatar
Maxime Perrotin committed
149
@singledispatch
150
def generate(*args, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
151
152
    ''' Generate the code for an item of the AST '''
    raise TypeError('[AdaGenerator] Unsupported AST construct')
153
    return [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
154
155


Maxime Perrotin's avatar
Maxime Perrotin committed
156
# Processing of the AST
Maxime Perrotin's avatar
Maxime Perrotin committed
157
@generate.register(ogAST.Process)
158
159
160
161
162
def _process(process, simu=False, instance=False, **kwargs):
    ''' Generate the code for a complete process (AST Top level)
        use instance=True to generate the code for a process type instance
        rather than the process type itself.
    '''
163
    # support generation of code of a process type
164
165
166
167
168
169
170
171
172
173
174
175
176
    if not instance:
        process_name = process.instance_of_name or process.processName
        generic = process.instance_of_name  #  shortcut
        process_instance = process
        process = process.instance_of_ref or process
    else:
        process_name = process.processName
        generic = False
        process_instance = process

    if process_instance is not process:
        # Generate an instance of the process type, too.
        generate(process_instance, simu, instance=True)
177

Maxime Perrotin's avatar
Maxime Perrotin committed
178
179
180
181
182
183
    global TYPES
    TYPES = process.dataview
    del OUT_SIGNALS[:]
    del PROCEDURES[:]
    OUT_SIGNALS.extend(process.output_signals)
    PROCEDURES.extend(process.procedures)
184
    global SHARED_LIB
185
    global LPREFIX
186
187
    if simu:
        SHARED_LIB = True
188
        LPREFIX = process_name + u'_ctxt'
Maxime Perrotin's avatar
Maxime Perrotin committed
189

190
191
192
193
    # taste-properties module-specific flag for the Ada backend:
    # import the state data from an external module
    import_context = kwargs["ppty_check"] if "ppty_check" in kwargs else ""

194
195
196
197
198
199
200
201
202
203
204
    # When building a shared library (with simu=True), generate a "mini-cv"
    # for aadl2glueC to create the code interfacing with asn1scc
    minicv = ['-- Automatically generated by OpenGEODE - do NOT modify!']
    def aadl_template(sp_name, io_param, pi_or_ri):
        ''' AADL mini-cv code in case of shared library
            sp_name  : name of the PI or RI
            io_param : list of (param_name, type_name, direction)
            pi_or_ri : string "PI" or "RI" depending on the direction
            return a string
        '''
        res = []
205
206
207
208
209
        if not io_param:
            LOG.info('Parameterless interface "{}" will not appear in the'
                     ' AADL file but will be handled directly by the GUI'
                     .format(sp_name))
            return ''
210
211
212
213
214
215
        # In case of shared library, generate the AADL "mini-cv" code
        res.append('SUBPROGRAM {}'.format(sp_name))
        if io_param:
            res.append('FEATURES')
            for param_name, sort, direction in io_param:
                res.append('    {pname}: {io} PARAMETER DataView::{sort} '
216
217
218
                          '{{encoding=>Native;}};'.format(pname=param_name,
                                                          sort=sort,
                                                          io=direction))
219
220
221
222
223
224
225
226
227
        res.append('END {};\n'.format(sp_name))
        res.append('SUBPROGRAM IMPLEMENTATION {}.GUI_{}'
                      .format(sp_name, pi_or_ri))
        res.append('PROPERTIES')
        res.append('    FV_Name => "{}";'.format(process_name))
        res.append('    Source_Language => GUI_{};'.format(pi_or_ri))
        res.append('END {}.GUI_{};\n'.format(sp_name, pi_or_ri))
        return '\n'.join(res)

228
    # bash script to simulate the system (TEMPORARY)
229
230
231
232
233
234
235
236

    # go up to the root of the AST to get the list of ASN.1 files
    parent = process.parent
    while hasattr(parent, 'parent') and parent.parent:
        parent = parent.parent
    if isinstance(parent, ogAST.System):
        parent = parent.ast
    asn1_filenames = ' '.join(parent.asn1_filenames)
Maxime Perrotin's avatar
Maxime Perrotin committed
237
238
    asn1_uniq = ' '.join(each for each in parent.asn1_filenames
                         if each != 'dataview-uniq.asn')
239
    pr_path = ' '.join(parent.pr_files) if None not in parent.pr_files else ''
240
241
242
243
244
    pr_names = ' '.join(
                      os.path.basename(pr_file) for pr_file in parent.pr_files)
    asn1_modules = (name.lower().replace('-', '_') + '.o'
                    for name in process.asn1Modules)

245
    simu_script = '''#!/bin/bash -e
246
247
248
249
250
rm -rf {pr}_simu
mkdir -p {pr}_simu
cp {pr_path} {asn1} {pr}_simu
cd {pr}_simu
opengeode {pr_names} --shared
251
cat {uniq} >> dataview-uniq.asn '''.format(pr=process_name.lower(),
Maxime Perrotin's avatar
Maxime Perrotin committed
252
253
254
255
                                           asn1=asn1_filenames,
                                           pr_path=pr_path,
                                           uniq=asn1_uniq or '/dev/null',
                                           pr_names=pr_names)
256
257
258

    if asn1_filenames:
        simu_script += '''
259
260
261
mono $(which asn1.exe) -Ada -typePrefix asn1Scc -equal {asn1}
mono $(which asn1.exe) -c -typePrefix asn1Scc -equal {asn1}'''.format(
                                                           asn1=asn1_filenames)
262
263

    simu_script += '''
264
gnatmake -fPIC -gnat2012 -c *.adb
265
gnatbind -n -Llib{pr} {pr}
266
gnatmake -fPIC -c -gnat2012 b~{pr}.adb
267
gcc -shared -fPIC -o lib{pr}.so b~{pr}.o {pr}.o {asn1_mod} adaasn1rtl.o -lgnat
268
rm -f dataview-uniq.c dataview-uniq.h
269
asn2aadlPlus dataview-uniq.asn DataView.aadl
270
271
272
aadl2glueC DataView.aadl {pr}_interface.aadl
asn2dataModel -toPython dataview-uniq.asn
make -f Makefile.python
273
echo "errCodes=$(taste-asn1-errCodes ./dataview-uniq.h)" >>datamodel.py
274
LD_LIBRARY_PATH=. opengeode-simulator
275
'''.format(pr=process_name.lower(),
276
277
           asn1_files=asn1_filenames,
           asn1_mod=' '.join(asn1_modules))
278

279

Maxime Perrotin's avatar
Maxime Perrotin committed
280
281
    LOG.info('Generating Ada code for process ' + str(process_name))

282
    # In case model has nested states, flatten everything
283
    Helper.flatten(process, sep=UNICODE_SEP)
284

285
    # Process State aggregations (Parallel states) XXX Add to C backend
286

287
288
    # Find recursively in the AST all state aggregations
    # Format: {'aggregation_name' : [list of ogAST.CompositeState]
289
    aggregates = Helper.state_aggregations(process)
290

291
292
293
    # Extract the list of parallel states names inside the composite states
    # of state aggregations XXX add to C generator
    parallel_states = Helper.parallel_states(aggregates)
294

Maxime Perrotin's avatar
Maxime Perrotin committed
295
296
297
298
    # Make an maping {input: {state: transition...}} in order to easily
    # generate the lookup tables for the state machine runtime
    mapping = Helper.map_input_state(process)

Maxime Perrotin's avatar
Maxime Perrotin committed
299
300
301
    VARIABLES.update(process.variables)

    process_level_decl = []
302

303
    # Establish the list of states (excluding START states) XXX update C backend
304
    full_statelist = set(chain(aggregates.viewkeys(),
305
306
                               (name for name in process.mapping.iterkeys()
                                    if not name.endswith(u'START'))))
307
    reduced_statelist = {s for s in full_statelist if s not in parallel_states}
Maxime Perrotin's avatar
Maxime Perrotin committed
308
    if aggregates:
309
310
        # Parallel states in a state aggregation may terminate
        full_statelist.add(u'{}finished'.format(UNICODE_SEP))
311

Maxime Perrotin's avatar
Maxime Perrotin committed
312
    context_decl = []
313
    if full_statelist:
Maxime Perrotin's avatar
Maxime Perrotin committed
314
        context_decl.append(u'type States is ({});'
315
                            .format(u', '.join(full_statelist) or u'No_State'))
316
317

    # Generate the code to declare process-level context
Maxime Perrotin's avatar
Maxime Perrotin committed
318
    context_decl.extend(['type {}_Ty is'.format(LPREFIX), 'record'])
319

320
    if full_statelist:
Maxime Perrotin's avatar
Maxime Perrotin committed
321
        context_decl.append('state : States;')
322

Maxime Perrotin's avatar
Maxime Perrotin committed
323
    context_decl.append('initDone : Boolean := False;')
324

Maxime Perrotin's avatar
Maxime Perrotin committed
325
    # State aggregation: add list of substates (XXX to be added in C generator)
326
327
    for substates in aggregates.viewvalues():
        for each in substates:
Maxime Perrotin's avatar
Maxime Perrotin committed
328
            context_decl.append(u'{}{}state: States;'
329
                                      .format(each.statename, UNICODE_SEP))
Maxime Perrotin's avatar
Maxime Perrotin committed
330

Maxime Perrotin's avatar
Maxime Perrotin committed
331
332
333
334
    for var_name, (var_type, def_value) in process.variables.viewitems():
        if def_value:
            # Expression must be a ground expression, i.e. must not
            # require temporary variable to store computed result
Maxime Perrotin's avatar
Maxime Perrotin committed
335
            dst, dstr, dlocal = expression(def_value)
336
337
338
            varbty = find_basic_type(var_type)
            if varbty.kind in ('SequenceOfType', 'OctetStringType'):
                dstr = array_content(def_value, dstr, varbty)
Maxime Perrotin's avatar
Maxime Perrotin committed
339
            assert not dst and not dlocal, 'DCL: Expecting a ground expression'
Maxime Perrotin's avatar
Maxime Perrotin committed
340
        context_decl.append(
341
342
                        u'{n} : aliased {sort}{default};'
                        .format(n=var_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
343
344
                                sort=type_name(var_type),
                                default=u' := ' + dstr if def_value else u''))
Maxime Perrotin's avatar
Maxime Perrotin committed
345

Maxime Perrotin's avatar
Maxime Perrotin committed
346
    context_decl.append('end record;')
347
348
    # context is aliased so that the model checker can work with access type
    context_decl.append('{ctxt}: aliased {ctxt}_Ty;'.format(ctxt=LPREFIX))
349
    if simu:
350
351
        # Export the context, so that it can be manipulated from outside
        # (in practice used by the "properties" module.
Maxime Perrotin's avatar
Maxime Perrotin committed
352
        context_decl.append(u'pragma export (C, {ctxt}, "{ctxt}");'
353
                                  .format(ctxt=LPREFIX))
354
        # Exhaustive simulation needs a backup of the context to quickly undo
Maxime Perrotin's avatar
Maxime Perrotin committed
355
        context_decl.append(u'{ctxt}_bk: {ctxt}_Ty;'
356
357
358
359
360
                                  .format(ctxt=LPREFIX))
    elif import_context:
        # Possibility to have the context defined outside the module
        # in order for a model checker to view/modify internals without any
        # copy at runtime
Maxime Perrotin's avatar
Maxime Perrotin committed
361
        context_decl.append(u'pragma import (C, ctxt, "{}_ctxt");'
362
                                  .format(import_context))
363

Maxime Perrotin's avatar
Maxime Perrotin committed
364
    if not simu and not instance:
Maxime Perrotin's avatar
Maxime Perrotin committed
365
366
        process_level_decl.extend(context_decl)

367
    aggreg_start_proc = []
Maxime Perrotin's avatar
Maxime Perrotin committed
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
    start_transition = []
    # Continuous State transition id
    if not instance:
        process_level_decl.append('CS_Only  : constant Integer := {};'
                                  .format(len(process.transitions)))

        for name, val in process.mapping.viewitems():
            # Test val, in principle there is a value but if the code targets
            # generation of properties, the model may have been cleant up and
            # in that case no value would be set..
            if name.endswith(u'START') and name != u'START' and val:
                process_level_decl.append(u'{name} : constant := {val};'
                                          .format(name=name, val=str(val)))

        # Declare start procedure for aggregate states XXX add in C generator
        # should create one START per "via" clause, TODO later
        for name, substates in aggregates.viewitems():
            proc_name = u'procedure {}{}START'.format(name, UNICODE_SEP)
            process_level_decl.append(u'{};'.format(proc_name))
            aggreg_start_proc.extend([u'{} is'.format(proc_name),
                                      'begin'])
            aggreg_start_proc.extend(u'runTransition({sub}{sep}START);'
                                     .format(sub=subname.statename,
                                             sep=UNICODE_SEP)
                                     for subname in substates)
            aggreg_start_proc.extend([u'end {}{}START;'
                                     .format(name, UNICODE_SEP),
                                     '\n'])

        # Add the declaration of the runTransition procedure
        process_level_decl.append('procedure runTransition(Id: Integer);')

        # Generate the code of the start transition (if process not empty)
        initDone =  u'{ctxt}.initDone := True;'.format(ctxt=LPREFIX)
        if not simu:
            start_transition = [u'begin']
            if process.transitions:
                start_transition.append(u'runTransition(0);')
            start_transition.append(initDone)
        else:
            start_transition = [u'procedure Startup is',
                                u'begin',
                                u'   runTransition(0);' if process.transitions
                                                       else 'null;',
                                initDone,
                                u'end Startup;']
414

Maxime Perrotin's avatar
Maxime Perrotin committed
415
416
417
418
419
    # Generate the TASTE template
    try:
        asn1_modules = '\n'.join(['with {dv};\nuse {dv};'.format(
            dv=dv.replace('-', '_'))
            for dv in process.asn1Modules])
420
421
        if process.asn1Modules:
            asn1_modules += '\nwith adaasn1rtl;\nuse adaasn1rtl;'
Maxime Perrotin's avatar
Maxime Perrotin committed
422
423
    except TypeError:
        asn1_modules = '--  No ASN.1 data types are used in this model'
Maxime Perrotin's avatar
Maxime Perrotin committed
424
    taste_template = [u'''\
Maxime Perrotin's avatar
Maxime Perrotin committed
425
426
427
428
429
-- This file was generated automatically: DO NOT MODIFY IT !

with System.IO;
use System.IO;

430
with Ada.Unchecked_Conversion;
431
with Ada.Numerics.Generic_Elementary_Functions;
432

Maxime Perrotin's avatar
Maxime Perrotin committed
433
434
435
436
{dataview}

with Interfaces;
use Interfaces;
437
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
438
package body {process_name} is'''.format(process_name=process_name,
439
440
441
                                         dataview=asn1_modules,
                                         C='with Interfaces.C.Strings;\n'
                                           'use Interfaces.C.Strings;'
Maxime Perrotin's avatar
Maxime Perrotin committed
442
443
                                            if simu else '') if not instance
                            else u"package body {} is".format(process_name)]
Maxime Perrotin's avatar
Maxime Perrotin committed
444

445
    generic_spec, instance_decl = "", ""
446
447
448
449
450
    if generic:
        generic_spec = u"generic\n"
        ri_list = external_ri_list(process)
        if ri_list:
            generic_spec += u"    with " + u";\n    with ".join(ri_list) + ';'
451
452
453
    if instance:
        instance_decl = u"with {};".format(process.instance_of_name)

Maxime Perrotin's avatar
Maxime Perrotin committed
454
    # Generate the source file (.ads) header
455
    ads_template = [u'''\
Maxime Perrotin's avatar
Maxime Perrotin committed
456
457
458
-- This file was generated automatically: DO NOT MODIFY IT !

{dataview}
Maxime Perrotin's avatar
Maxime Perrotin committed
459
{C}
460
{instance}
461
{generic}
462
463
package {process_name} is'''.format(generic=generic_spec,
                                    instance=instance_decl,
464
                                    process_name=process_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
465
466
467
468
                                    dataview=asn1_modules,
                                    C='with Interfaces.C.Strings;\n'
                                      'use Interfaces.C.Strings;'
                                        if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
469
    dll_api = []
470
    if simu:
Maxime Perrotin's avatar
Maxime Perrotin committed
471
        ads_template.extend(context_decl)
472
473
        ads_template.append('--  API for simulation via DLL')
        dll_api.append('-- API to remotely change internal data')
474
475
        # Add function allowing to trace current state as a string
        process_level_decl.append("function get_state return chars_ptr "
476
477
478
479
                                  "is (New_String(states'Image({ctxt}.state)))"
                                  " with Export, Convention => C, "
                                  'Link_Name => "{name}_state";'
                                  .format(name=process_name, ctxt=LPREFIX))
480
481
        set_state_decl = "procedure set_state(new_state: chars_ptr)"
        ads_template.append("{};".format(set_state_decl))
482
        ads_template.append('pragma Export(C, set_state, "_set_state");')
483
484
        dll_api.append("{} is".format(set_state_decl))
        dll_api.append("begin")
485
486
        dll_api.append("{}.state := States'Value(Value(new_state));"
                       .format(LPREFIX))
487
488
489
        dll_api.append("end set_state;")
        dll_api.append("")

490
491
492
493
494
495
496
497
498
        # Save/restore state allow one step undo, as needed for model checking
        save_state_decl = "procedure save_context"
        restore_state_decl = "procedure restore_context"
        ads_template.append("{};".format(save_state_decl))
        ads_template.append('pragma Export(C, save_context, "_save_context");')
        ads_template.append("{};".format(restore_state_decl))
        ads_template.append('pragma Export(C, restore_context, "_restore_context");')
        dll_api.append("{} is".format(save_state_decl))
        dll_api.append("begin")
499
        dll_api.append("{ctxt}_bk := {ctxt};".format(ctxt=LPREFIX))
500
501
502
503
        dll_api.append("end save_context;")
        dll_api.append("")
        dll_api.append("{} is".format(restore_state_decl))
        dll_api.append("begin")
504
        dll_api.append("{ctxt} := {ctxt}_bk;".format(ctxt=LPREFIX))
505
506
507
        dll_api.append("end restore_context;")
        dll_api.append("")

508
509
510
511
512
        # Declare procedure Startup in .ads
        ads_template.append(u'procedure Startup;')
        ads_template.append(u'pragma Export(C, Startup, "{}_startup");'
                            .format(process_name))

513
514
515
516
517
518
519
520
521
522
523
        # interface to get/set state aggregations XXX add to C generator
        for substates in aggregates.viewvalues():
            for each in substates:
                process_level_decl.append(
                        u"function get_{name}_state return chars_ptr "
                        u"is (New_String(states'Image({ctxt}.{name}{sep}state)"
                        ")) with Export, Convention => C, "
                        'Link_Name => "{proc}_{name}_state";'
                        .format(name=each.statename, ctxt=LPREFIX,
                                proc=process_name, sep=UNICODE_SEP))

524
525
        # Functions to get gobal variables (length and value)
        for var_name, (var_type, _) in process.variables.viewitems():
526
            # Getters for external applications to view local variables via dll
527
528
529
530
531
            process_level_decl.append(u"function l_{name}_value"
                                     u" return access {sort} "
                                     u"is ({prefix}.{name}'access) with Export,"
                                     u" Convention => C,"
                                     u' Link_Name => "{name}_value";'
532
                                     .format(prefix=LPREFIX, name=var_name,
533
534
                                              sort=type_name(var_type)))
            # Setters for local variables
535
            setter_decl = u"procedure dll_set_l_{name}(value: access {sort})"\
536
                          .format(name=var_name, sort=type_name(var_type))
537
538
            ads_template.append(u'{};'.format(setter_decl))
            ads_template.append(u'pragma Export(C, dll_set_l_{name},'
539
                                ' "_set_{name}");'.format(name=var_name))
540
541
542
543
            dll_api.append(u'{} is'.format(setter_decl))
            dll_api.append(u'begin')
            dll_api.append(u'{}.{} := value.all;'.format(LPREFIX, var_name))
            dll_api.append(u'end dll_set_l_{};'.format(var_name))
544
545
            dll_api.append('')

Maxime Perrotin's avatar
Maxime Perrotin committed
546
547
548
549
550
551
    # Generate the the code of the procedures
    inner_procedures_code = []
    for proc in process.content.inner_procedures:
        proc_code, proc_local = generate(proc)
        process_level_decl.extend(proc_local)
        inner_procedures_code.extend(proc_code)
552
553
554
555
        if proc.exported:
            # Exported procedures must be declared in the .ads
            pi_header = procedure_header(proc)
            ads_template.append(u'{};'.format(pi_header))
556
            if not proc.external and not generic:
557
558
559
560
                ads_template.append(u'pragma Export'
                                    u'(C, p{sep}{proc_name}, "_{proc_name}");'
                                    .format(sep=UNICODE_SEP,
                                            proc_name=proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
561
562
563
564
565
566
567

    # Generate the code for the process-level variable declarations
    taste_template.extend(process_level_decl)

    # Add the code of the procedures definitions
    taste_template.extend(inner_procedures_code)

568
569
570
571
    # Generate the code of the START procedures of state aggregations
    # XXX to be added to C generator
    taste_template.extend(aggreg_start_proc)

572
573
574
    # Add the code of the DLL interface
    taste_template.extend(dll_api)

Maxime Perrotin's avatar
Maxime Perrotin committed
575
576
577
    # Generate the code for each input signal (provided interface) and timers
    for signal in process.input_signals + [
                        {'name': timer.lower()} for timer in process.timers]:
578
        signame = signal.get('name', u'START')
Maxime Perrotin's avatar
Maxime Perrotin committed
579
        if signame == u'START':
Maxime Perrotin's avatar
Maxime Perrotin committed
580
            continue
581
        pi_header = u'procedure {sig_name}'.format(sig_name=signame)
582
        param_name = signal.get('param_name') \
Maxime Perrotin's avatar
Maxime Perrotin committed
583
                                or u'{}_param'.format(signame)
Maxime Perrotin's avatar
Maxime Perrotin committed
584
585
        # Add (optional) PI parameter (only one is possible in TASTE PI)
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
586
            typename = type_name(signal['type'])
587
            pi_header += u'({pName}: access {sort})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
588
                                        pName=param_name, sort=typename)
Maxime Perrotin's avatar
Maxime Perrotin committed
589
590

        # Add declaration of the provided interface in the .ads file
591
        ads_template.append(u'--  Provided interface "{}"'.format(signame))
Maxime Perrotin's avatar
Maxime Perrotin committed
592
        ads_template.append(pi_header + ';')
593
594
595
        if not generic:
            ads_template.append(u'pragma Export(C, {name}, "{proc}_{name}");'
                                 .format(name=signame, proc=process_name))
596
597
598
599
600

        if simu:
            # Generate code for the mini-cv template
            params = [(param_name, type_name(signal['type'], use_prefix=False),
                      'IN')] if 'type' in signal else []
601
            minicv.append(aadl_template(signame, params, 'RI'))
Maxime Perrotin's avatar
Maxime Perrotin committed
602
603
604
605

        pi_header += ' is'
        taste_template.append(pi_header)
        taste_template.append('begin')
606
607
608
609

        def execute_transition(state):
            ''' Generate the code that triggers the transition for the current
                state/input combination '''
610
            input_def = mapping[signame].get(state)
611
            # Check for nested states to call optional exit procedure
612
            state_tree = state.split(UNICODE_SEP)
Maxime Perrotin's avatar
Maxime Perrotin committed
613
            context = process
614
615
616
617
618
619
            exitlist = []
            current = ''
            trans = input_def and process.transitions[input_def.transition_id]
            while state_tree:
                current = current + state_tree.pop(0)
                for comp in context.composite_states:
620
                    if current.lower() == comp.statename.lower():
621
622
623
                        if comp.exit_procedure:
                            exitlist.append(current)
                        context = comp
624
                        current = current + UNICODE_SEP
625
626
627
628
                        break
            for each in reversed(exitlist):
                if trans and all(each.startswith(trans_st)
                                 for trans_st in trans.possible_states):
629
                    taste_template.append(u'p{sep}{ref}{sep}exit;'
630
                                          .format(ref=each, sep=UNICODE_SEP))
631

Maxime Perrotin's avatar
Maxime Perrotin committed
632
633
634
635
            if input_def:
                for inp in input_def.parameters:
                    # Assign the (optional and unique) parameter
                    # to the corresponding process variable
636
637
                    taste_template.append(u'{ctxt}.{inp} := {tInp}.all;'
                                          .format(ctxt=LPREFIX,
638
639
                                                  inp=inp,
                                                  tInp=param_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
640
641
                # Execute the correponding transition
                if input_def.transition:
Maxime Perrotin's avatar
Maxime Perrotin committed
642
                    taste_template.append(u'runTransition({idx});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
643
644
                        idx=input_def.transition_id))
                else:
Maxime Perrotin's avatar
Maxime Perrotin committed
645
                    taste_template.append('runTransition(CS_Only);')
Maxime Perrotin's avatar
Maxime Perrotin committed
646
            else:
647
                taste_template.append('runTransition(CS_Only);')
648

Maxime Perrotin's avatar
Maxime Perrotin committed
649
650
        if not instance:
            taste_template.append('case {}.state is'.format(LPREFIX))
651
652
653
654
655
656
657

        def case_state(state):
            ''' Recursive function (in case of state aggregation) to generate
                the code that calls the proper transition according
                to the current state
                The input name is in signame
            '''
658
            if state.endswith(u'START'):
659
                return
660
            taste_template.append(u'when {state} =>'.format(state=state))
661
            input_def = mapping[signame].get(state)
662
            if state in aggregates.viewkeys():
663
                # State aggregation:
Maxime Perrotin's avatar
Maxime Perrotin committed
664
665
                # - find which substate manages this input
                # - add a swich case on the corresponding substate
666
667
                taste_template.append(u'-- this is a state aggregation')
                for sub in aggregates[state]:
668
669
670
671
672
673
674
675
                    if [a for a in sub.mapping.viewkeys()
                            if a in mapping[signame].viewkeys()]:
                        taste_template.append(u'case '
                                              u'{ctxt}.{sub}{sep}state is'
                                              .format(ctxt=LPREFIX,
                                                     sub=sub.statename,
                                                     sep=UNICODE_SEP))
                        for par in sub.mapping.viewkeys():
676
                            case_state(par)
677
678
679
680
                        taste_template.append('when others =>')
                        taste_template.append('null;')
                        taste_template.append('end case;')
                        break
681
682
                else:
                    # Input is not managed in the state aggregation
683
684
685
                    if input_def:
                        # check if it is managed one level above
                        execute_transition(state)
686
                    taste_template.append('null;')
Maxime Perrotin's avatar
Maxime Perrotin committed
687
688
            else:
                execute_transition(state)
689

Maxime Perrotin's avatar
Maxime Perrotin committed
690
691
692
693
694
695
696
697
698
699
        if not instance:
            map(case_state, reduced_statelist) # XXX update C generator
            taste_template.append('when others =>')
            taste_template.append('runTransition(CS_Only);')
            taste_template.append('end case;')
        else:
            inst_call = u"{}_Instance.{}".format(process_name, signame)
            if 'type' in signal:
                inst_call += u"({})".format(param_name)
            taste_template.append(inst_call + ";")
700
701

        taste_template.append(u'end {};'.format(signame))
Maxime Perrotin's avatar
Maxime Perrotin committed
702
703
704
705
706
        taste_template.append('\n')

    # for the .ads file, generate the declaration of the required interfaces
    # output signals are the asynchronous RI - only one parameter
    for signal in process.output_signals:
707

708
709
        param_name = signal.get('param_name') \
                                or u'{}_param'.format(signal['name'])
Maxime Perrotin's avatar
Maxime Perrotin committed
710
        # Add (optional) RI parameter
711
712
713
        # Paramless TMs: when targetting simulation, the name of the TM is
        # passed as single parameter. This allows the simualor to handle them
        # dynamically, with a single callback function for all TMs
Maxime Perrotin's avatar
Maxime Perrotin committed
714
        param_spec = '' if not simu else "(tm: chars_ptr)"
Maxime Perrotin's avatar
Maxime Perrotin committed
715
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
716
            typename = type_name(signal['type'])
717
718
719
720
721
            param_spec = u'({pName}: access {sort}{shared})' \
                         .format(pName=param_name,
                                 sort=typename,
                                 shared=u'; Size: Integer'
                                        if SHARED_LIB else '')
722
723
724
725
        if not generic:
            ads_template.append(u'--  {}equired interface "{}"'
                                .format("Paramless r" if not 'type' in signal
                                    else "R", signal['name']))
726
727
728
729
        if simu:
            # When generating a shared library, we need a callback mechanism
            ads_template.append(u'type {}_T is access procedure{};'
                                .format(signal['name'], param_spec))
Maxime Perrotin's avatar
Maxime Perrotin committed
730
731
732
733
734
            ads_template.append(u'pragma Convention(Convention => C,'
                                u' Entity => {}_T);'.format(signal['name']))
            ads_template.append(u'RI{sep}{sig} : {sig}_T;'
                                .format(sep=UNICODE_SEP, sig=signal['name']))
            ads_template.append(u'procedure Register_{sig}(Callback: {sig}_T);'
735
                                .format(sig=signal['name']))
Maxime Perrotin's avatar
Maxime Perrotin committed
736
            ads_template.append(u'pragma Export(C, Register_{sig},'
737
738
                                ' "register_{sig}");'
                                .format(sig=signal['name']))
739
740
741
742

            # Generate code for the mini-cv template
            params = [(param_name, type_name(signal['type'], use_prefix=False),
                      'IN')] if 'type' in signal else []
743
            minicv.append(aadl_template(signal['name'], params, 'PI'))
744

Maxime Perrotin's avatar
Maxime Perrotin committed
745
746
            taste_template.append(u'procedure Register_{sig}'
                                  u'(Callback:{sig}_T) is'
747
                                  .format(sig=signal['name']))
Maxime Perrotin's avatar
Maxime Perrotin committed
748
749
750
751
752
            taste_template.append(u'begin')
            taste_template.append(u'RI{sep}{sig} := Callback;'
                                  .format(sep=UNICODE_SEP, sig=signal['name']))
            taste_template.append(u'end Register_{};'.format(signal['name']))
            taste_template.append(u'')
753
        elif not generic:
Maxime Perrotin's avatar
Maxime Perrotin committed
754
755
756
757
758
759
760
761
762
            ads_template.append(u'procedure RI{}{}{};'
                                .format(UNICODE_SEP,
                                        signal['name'],
                                        param_spec))
            ads_template.append(u'pragma import(C, RI{sep}{sig},'
                                u' "{proc}_RI_{sig}");'
                                .format(sep=UNICODE_SEP,
                                        sig=signal['name'],
                                        proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
763
764

    # for the .ads file, generate the declaration of the external procedures
765
    for proc in (proc for proc in process.procedures if proc.external):
Maxime Perrotin's avatar
Maxime Perrotin committed
766
767
768
        ri_header = u'procedure RI{sep}{sig_name}'.format(
                                                     sep=UNICODE_SEP,
                                                     sig_name=proc.inputString)
Maxime Perrotin's avatar
Maxime Perrotin committed
769
        params = []
770
771
772
773
        params_spec = u""
        if simu:
            # For simulators: add the TM name as first parameter
            params.append("tm: chars_ptr")
Maxime Perrotin's avatar
Maxime Perrotin committed
774
        for param in proc.fpar:
Maxime Perrotin's avatar
Maxime Perrotin committed
775
            typename = type_name(param['type'])
776
            params.append(u'{par[name]}: access {sort}{shared}'
Maxime Perrotin's avatar
Maxime Perrotin committed
777
                          .format(par=param,
778
779
780
781
                                  sort=typename,
                                  shared=u"; {}_Size: Integer"
                                         .format(param['name'])
                                         if SHARED_LIB else ""))
Maxime Perrotin's avatar
Maxime Perrotin committed
782
        if params:
783
784
            params_spec = "({})".format("; ".join(params))
            ri_header += params_spec
785
786
        ads_template.append(u'--  Sync required interface "{}"'
                            .format(proc.inputString))
787
788
789
790
        if simu:
            # As for async TM, generate a callback mechanism
            ads_template.append(u"type {}_T is access procedure{};"
                                .format(proc.inputString, params_spec))
Maxime Perrotin's avatar
Maxime Perrotin committed
791
792
793
794
795
            ads_template.append(u'pragma Convention(Convention => C,'
                                u' Entity => {}_T);'.format(proc.inputString))
            ads_template.append(u'RI{sep}{sig} : {sig}_T;'
                                .format(sep=UNICODE_SEP, sig=proc.inputString))
            ads_template.append(u'procedure Register_{sig}(Callback: {sig}_T);'
796
                                .format(sig=proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
797
798
            ads_template.append(u'pragma Export(C, Register_{sig},'
                                u' "register_{sig}");'
799
                                .format(sig=proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
800
            taste_template.append(u'procedure Register_{sig}'
801
802
                                  '(Callback:{sig}_T) is'
                                  .format(sig=proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
803
804
805
806
807
808
            taste_template.append(u'begin')
            taste_template.append(u'RI{sep}{sig} := Callback;'
                                  .format(sep=UNICODE_SEP,
                                          sig=proc.inputString))
            taste_template.append(u'end Register_{};'.format(proc.inputString))
            taste_template.append(u'')
809

810
        elif not generic:
811
            ads_template.append(ri_header + u';')
Maxime Perrotin's avatar
Maxime Perrotin committed
812
813
814
815
816
            ads_template.append(u'pragma import(C, RI{sep}{sig},'
                                u' "{proc}_RI_{sig}");'
                                .format(sep=UNICODE_SEP,
                                        sig=proc.inputString,
                                        proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
817
818
819

    # for the .ads file, generate the declaration of timers set/reset functions
    for timer in process.timers:
820
821
822
823
824
        ads_template.append(u'--  Timer {} SET and RESET functions'
                            .format(timer))
        if simu:
            # Declare callback registration for the SET and RESET functions
            ads_template.append(u'type SET_{}_T is access procedure'
825
                                 '(name: chars_ptr; duration: Asn1Int);'
826
                                .format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
827
828
            ads_template.append(u'type RESET_{}_T is access procedure'
                                '(name: chars_ptr);'.format(timer))
829
            for each in ('', 'RE'):
830
831
                ads_template.append(u'pragma Convention(Convention => C,'
                                    u' Entity => {re}SET_{t}_T);'
832
                                    .format(re=each, t=timer))
833
                ads_template.append(u'{re}SET_{t} : {re}SET_{t}_T;'
834
                                    .format(re=each, t=timer))
835
836
                ads_template.append(u'procedure Register_{re}SET_{t}'
                                    u'(Callback: {re}SET_{t}_T);'
837
                                    .format(re=each, t=timer))
838
839
                ads_template.append(u'pragma Export(C, Register_{re}SET_{t},'
                                    u' "register_{re}SET_{t}");'
840
841
842
                                    .format(re=each, t=timer))
            # Code for the SET/RESET timer callback registration
            for each in ('', 'RE'):
843
844
                taste_template.append(u'procedure Register_{re}SET_{t}'
                                      u'(Callback:{re}SET_{t}_T) is'
845
                                      .format(re=each, t=timer))
846
847
                taste_template.append(u'begin')
                taste_template.append(u'{re}SET_{t} := Callback;'
848
                                      .format(re=each, t=timer))
849
                taste_template.append(u'end Register_{re}SET_{t};'
850
851
852
853
854
                                      .format(re=each, t=timer))
                taste_template.append('')

        else:
            ads_template.append(u'procedure SET_{}(val: access asn1SccT_UInt32);'
Maxime Perrotin's avatar
Maxime Perrotin committed
855
                .format(timer))
856
857
858
859
            if not generic:
                ads_template.append(
                    u'pragma import(C, SET_{timer}, "{proc}_RI_set_{timer}");'
                    .format(timer=timer, proc=process_name))
860
            ads_template.append(u'procedure RESET_{};'.format(timer))
861
862
863
864
            if not generic:
                ads_template.append(
                 u'pragma import(C, RESET_{timer}, "{proc}_RI_reset_{timer}");'
                 .format(timer=timer, proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
865

866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
    if instance:
        # Instance of a process type, all the RIs (including timers) must
        # be gathered to instantiate the package
        pkg_decl = (u"package {}_Instance is new {}"
                    .format(process_name, process.instance_of_name))
        ri_list = [u"RI{sep}{name}".format(sep=UNICODE_SEP, name=sig['name'])
                   for sig in process.output_signals]
        ri_list.extend ([u"RI{sep}{name}".format(sep=UNICODE_SEP,
                                                 name=proc.inputString)
                        for proc in process.procedures if proc.external])
        ri_list.extend([u"set_{}".format(timer) for timer in process.timers])
        ri_list.extend([u"reset_{}".format(timer) for timer in process.timers])
        ri_inst = [u"{ri} => {ri}".format(ri=ri) for ri in ri_list]
        if ri_inst:
            pkg_decl += u" ({})".format(u", ".join(ri_inst))
        ads_template.append(pkg_decl + u";")

883
884
885
886
887
888
889
890
891
    if simu and process.cs_mapping:
        # Callback registration for Check_Queue
        taste_template.append(u'procedure Register_Check_Queue'
                              u'(Callback: Check_Queue_T) is')
        taste_template.append(u'begin')
        taste_template.append(u'Check_Queue := Callback;')
        taste_template.append(u'end Register_Check_Queue;')
        taste_template.append(u'')

892
893
894
895
896
897
    # If the process has no input, output, procedures, or timers, then Ada
    # will not compile the body - generate a pragma to fix this
    if not process.timers and not process.procedures \
            and not process.input_signals and not process.output_signals:
        ads_template.append('pragma elaborate_body;')

898
899
    # Transform inner labels to floating labels
    Helper.inner_labels_to_floating(process)
Maxime Perrotin's avatar
Maxime Perrotin committed
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915

    # Generate the code for all transitions
    code_transitions = []
    local_decl_transitions = []
    for proc_tr in process.transitions:
        code_tr, tr_local_decl = generate(proc_tr)
        code_transitions.append(code_tr)
        local_decl_transitions.extend(tr_local_decl)

    # Generate code for the floating labels
    code_labels = []
    for label in process.content.floating_labels:
        code_label, label_decl = generate(label)
        local_decl_transitions.extend(label_decl)
        code_labels.extend(code_label)

916
    # Generate the code of the runTransition procedure, if needed
Maxime Perrotin's avatar
Maxime Perrotin committed
917
    if process.transitions and not instance:
918
919
        taste_template.append('procedure runTransition(Id: Integer) is')
        taste_template.append('trId : Integer := Id;')
920
921
        if process.cs_mapping:
            taste_template.append(
922
                              'msgPending : aliased Asn1Boolean := True;')
Maxime Perrotin's avatar
Maxime Perrotin committed
923

924
925
926
        # Declare the local variables needed by the transitions in the template
        taste_template.extend(set(local_decl_transitions))
        taste_template.append('begin')
927

928
929
930
        # Generate a loop that ends when a next state is reached
        # (there can be chained transition when entering a nested state)
        taste_template.append('while (trId /= -1) loop')
Maxime Perrotin's avatar
Maxime Perrotin committed
931

932
933
        # Generate the switch-case on the transition id
        taste_template.append('case trId is')
Maxime Perrotin's avatar
Maxime Perrotin committed
934

935
936
937
938
939
940
941
        for idx, val in enumerate(code_transitions):
            taste_template.append(u'when {idx} =>'.format(idx=idx))
            val = [u'{line}'.format(line=l) for l in val]
            if val:
                taste_template.extend(val)
            else:
                taste_template.append('null;')
Maxime Perrotin's avatar
Maxime Perrotin committed
942

943
944
945
946
        taste_template.append('when CS_Only =>')
        taste_template.append('trId := -1;')
        taste_template.append('goto next_transition;')

947
948
949
950
951
952
953
954
        taste_template.append('when others =>')
        taste_template.append('null;')

        taste_template.append('end case;')
        if code_labels:
            # Due to nested states (chained transitions) jump over label code
            # (NEXTSTATEs do not return from runTransition)
            taste_template.append('goto next_transition;')
Maxime Perrotin's avatar
Maxime Perrotin committed
955

956
957
        # Add the code for the floating labels
        taste_template.extend(code_labels)
Maxime Perrotin's avatar
Maxime Perrotin committed
958

959
        taste_template.append('<<next_transition>>')
960
961
962
963
964

        # After completing active transition(s), check continuous signals:
        #     - Check current state(s)
        #     - For each continuous signal generate code (test+transition)
        # XXX add to C backend
965
        if process.cs_mapping and not simu:
966
            taste_template.append('--  Process continuous signals')
967
            taste_template.append('if {}.initDone then'.format(LPREFIX))
968
969
            taste_template.append("Check_Queue(msgPending'access);")
            taste_template.append('end if;')
970
971
            ads_template.append(
                    u'procedure Check_Queue(res: access Asn1Boolean);')
972
973
974
975
            if not generic:
                ads_template.append(
                    u'pragma import(C, Check_Queue, "{proc}_check_queue");'
                    .format(proc=process_name))
976
977
978
979
980
981
982
983
984
985
986
987
988
989
        elif process.cs_mapping and simu:
            taste_template.append('if {}.initDone then'.format(LPREFIX))
            taste_template.append("Check_Queue(msgPending'access);")
            taste_template.append('end if;')
            # simulation: create a callback registration function
            ads_template.append(u'type Check_Queue_T is access procedure'
                                u'(res: access Asn1Boolean);')
            ads_template.append(u'pragma Convention(Convention => C,'
                                u' Entity => Check_Queue_T);')
            ads_template.append(u'Check_Queue : Check_Queue_T;')
            ads_template.append(u'procedure Register_Check_Queue'
                                u'(Callback: Check_Queue_T);')
            ads_template.append(u'pragma Export(C, Register_Check_Queue,'
                                ' "register_check_queue");')
990
991
992
        else:
            taste_template.append('null;')

993
        # Process the continuous signals in state aggregations first
994
        done = []
995
996
        sep = 'if '
        last = ''
997
998
        # flag indicating there are CS in nested states but not at root
        need_final_endif = False
999
1000
        for cs, agg in product(process.cs_mapping.viewitems(),
                               aggregates.viewitems()):
For faster browsing, not all history is shown. View entire blame