AdaGenerator.py 108 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

@singledispatch
101
def generate(*args, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
102 103
    ''' Generate the code for an item of the AST '''
    raise TypeError('[AdaGenerator] Unsupported AST construct')
104
    return [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
105 106


Maxime Perrotin's avatar
Maxime Perrotin committed
107
# Processing of the AST
Maxime Perrotin's avatar
Maxime Perrotin committed
108
@generate.register(ogAST.Process)
109
def _process(process, simu=False, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
110 111 112 113 114 115 116 117
    ''' Generate the code for a complete process (AST Top level) '''
    process_name = process.processName
    global TYPES
    TYPES = process.dataview
    del OUT_SIGNALS[:]
    del PROCEDURES[:]
    OUT_SIGNALS.extend(process.output_signals)
    PROCEDURES.extend(process.procedures)
118
    global SHARED_LIB
119
    global LPREFIX
120 121
    if simu:
        SHARED_LIB = True
122
        LPREFIX = process_name + u'_ctxt'
Maxime Perrotin's avatar
Maxime Perrotin committed
123

124 125 126 127 128 129 130 131 132 133 134
    # 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 = []
135 136 137 138 139
        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 ''
140 141 142 143 144 145
        # 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} '
146 147 148
                          '{{encoding=>Native;}};'.format(pname=param_name,
                                                          sort=sort,
                                                          io=direction))
149 150 151 152 153 154 155 156 157
        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)

158
    # bash script to simulate the system (TEMPORARY)
159 160 161 162 163 164 165 166 167 168 169 170 171 172

    # 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)
    pr_path = ' '.join(parent.pr_files)
    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)

173
    simu_script = '''#!/bin/bash -e
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
rm -rf {pr}_simu
mkdir -p {pr}_simu
cp {pr_path} {asn1} {pr}_simu
cd {pr}_simu
opengeode {pr_names} --shared
cat *.asn > dataview-uniq.asn '''.format(pr=process_name,
                                         asn1=asn1_filenames,
                                         pr_path=pr_path,
                                         pr_names=pr_names)

    if asn1_filenames:
        simu_script += '''
asn1.exe -Ada -typePrefix asn1Scc -equal {asn1}
asn1.exe -c -typePrefix asn1Scc -equal {asn1}'''.format(asn1=asn1_filenames)

    simu_script += '''
190 191 192
gnatmake -gnat2012 -c *.adb
gnatbind -n -Llib{pr} {pr}
gnatmake -c -gnat2012 b~{pr}.adb
193 194
gcc -shared -fPIC -o lib{pr}.so b~{pr}.o {pr}.o {asn1_mod} adaasn1rtl.o -lgnat
asn2aadlPlus dataview-uniq.asn DataView.aadl
195 196 197 198
aadl2glueC DataView.aadl {pr}_interface.aadl
asn2dataModel -toPython dataview-uniq.asn
make -f Makefile.python
echo "errCodes=$(taste-asn1-errCodes ./dataview-uniq.h)" >>datamodel.py
199 200 201 202
LD_LIBRARY_PATH=. opengeode-simulator
'''.format(pr=process_name,
           asn1_files=asn1_filenames,
           asn1_mod=' '.join(asn1_modules))
203

204

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

207
    # In case model has nested states, flatten everything
208
    Helper.flatten(process, sep=UNICODE_SEP)
209

210
    # Process State aggregations (Parallel states) XXX Add to C backend
211

212 213
    # Find recursively in the AST all state aggregations
    # Format: {'aggregation_name' : [list of ogAST.CompositeState]
214
    aggregates = Helper.state_aggregations(process)
215

216 217 218
    # 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)
219

Maxime Perrotin's avatar
Maxime Perrotin committed
220 221 222 223
    # 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
224 225 226
    VARIABLES.update(process.variables)

    process_level_decl = []
227

228
    # Establish the list of states (excluding START states) XXX update C backend
229
    full_statelist = set(chain(aggregates.viewkeys(),
230 231
                               (name for name in process.mapping.iterkeys()
                                    if not name.endswith(u'START'))))
232
    reduced_statelist = {s for s in full_statelist if s not in parallel_states}
Maxime Perrotin's avatar
Maxime Perrotin committed
233
    if aggregates:
234 235
        # Parallel states in a state aggregation may terminate
        full_statelist.add(u'{}finished'.format(UNICODE_SEP))
236 237 238 239

    if full_statelist:
        process_level_decl.append(u'type States is ({});'
                            .format(u', '.join(full_statelist) or u'No_State'))
240 241 242 243

    # Generate the code to declare process-level context
    process_level_decl.extend(['type {}_Ty is'.format(LPREFIX), 'record'])

244
    if full_statelist:
245 246
        process_level_decl.append('state : States;')

Maxime Perrotin's avatar
Maxime Perrotin committed
247
    # State aggregation: add list of substates (XXX to be added in C generator)
248 249 250
    for substates in aggregates.viewvalues():
        for each in substates:
            process_level_decl.append(u'{}{}state: States;'
251
                                      .format(each.statename, UNICODE_SEP))
Maxime Perrotin's avatar
Maxime Perrotin committed
252

Maxime Perrotin's avatar
Maxime Perrotin committed
253 254 255 256
    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
257
            dst, dstr, dlocal = expression(def_value)
258 259 260
            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
261 262
            assert not dst and not dlocal, 'DCL: Expecting a ground expression'
        process_level_decl.append(
263 264
                        u'{n} : aliased {sort}{default};'
                        .format(n=var_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
265 266
                                sort=type_name(var_type),
                                default=u' := ' + dstr if def_value else u''))
Maxime Perrotin's avatar
Maxime Perrotin committed
267

268 269 270
    process_level_decl.append('end record;'.format(LPREFIX))
    process_level_decl.append('{ctxt}: {ctxt}_Ty;'.format(ctxt=LPREFIX))

Maxime Perrotin's avatar
Maxime Perrotin committed
271

272
    for name, val in process.mapping.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
273 274
        if name.endswith(u'START') and name != u'START':
            process_level_decl.append(u'{name} : constant := {val};'
275 276
                                      .format(name=name, val=str(val)))

277
    # Declare start procedure for aggregate states XXX add in C generator
278 279 280 281 282 283 284 285
    # should create one START per "via" clause, TODO later
    aggreg_start_proc = []
    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);'
286 287
                                 .format(sub=subname.statename,
                                         sep=UNICODE_SEP)
288 289 290 291
                                 for subname in substates)
        aggreg_start_proc.extend([u'end {}{}START;'
                                 .format(name, UNICODE_SEP),
                                 '\n'])
292

293 294 295
    # Add the declaration of the runTransition procedure, if needed
    if process.transitions:
        process_level_decl.append('procedure runTransition(Id: Integer);')
Maxime Perrotin's avatar
Maxime Perrotin committed
296

297
    # Generate the code of the start transition (if process not empty)
298
    start_transition = ['begin',
299
                        'runTransition(0);'] if process.transitions else []
300

Maxime Perrotin's avatar
Maxime Perrotin committed
301 302 303 304 305
    # Generate the TASTE template
    try:
        asn1_modules = '\n'.join(['with {dv};\nuse {dv};'.format(
            dv=dv.replace('-', '_'))
            for dv in process.asn1Modules])
306
        asn1_modules += '\nwith adaasn1rtl;\nuse adaasn1rtl;'
Maxime Perrotin's avatar
Maxime Perrotin committed
307 308 309 310 311 312 313 314
    except TypeError:
        asn1_modules = '--  No ASN.1 data types are used in this model'
    taste_template = ['''\
-- This file was generated automatically: DO NOT MODIFY IT !

with System.IO;
use System.IO;

315
with Ada.Unchecked_Conversion;
316
with Ada.Numerics.Generic_Elementary_Functions;
317

Maxime Perrotin's avatar
Maxime Perrotin committed
318 319 320 321
{dataview}

with Interfaces;
use Interfaces;
322
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
323
package body {process_name} is'''.format(process_name=process_name,
324 325 326 327
                                         dataview=asn1_modules,
                                         C='with Interfaces.C.Strings;\n'
                                           'use Interfaces.C.Strings;'
                                            if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
328 329 330 331 332 333

    # Generate the source file (.ads) header
    ads_template = ['''\
-- This file was generated automatically: DO NOT MODIFY IT !

{dataview}
Maxime Perrotin's avatar
Maxime Perrotin committed
334
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
335 336

package {process_name} is'''.format(process_name=process_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
337 338 339 340
                                    dataview=asn1_modules,
                                    C='with Interfaces.C.Strings;\n'
                                      'use Interfaces.C.Strings;'
                                        if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
341

Maxime Perrotin's avatar
Maxime Perrotin committed
342
    dll_api = []
343 344
    if simu:
        ads_template.append('--  DLL Interface')
345
        dll_api.append('-- DLL Interface to remotely change internal data')
346 347
        # Add function allowing to trace current state as a string
        process_level_decl.append("function get_state return chars_ptr "
348 349 350 351
                                  "is (New_String(states'Image({ctxt}.state)))"
                                  " with Export, Convention => C, "
                                  'Link_Name => "{name}_state";'
                                  .format(name=process_name, ctxt=LPREFIX))
352 353
        set_state_decl = "procedure set_state(new_state: chars_ptr)"
        ads_template.append("{};".format(set_state_decl))
354
        ads_template.append('pragma export(C, set_state, "_set_state");')
355 356
        dll_api.append("{} is".format(set_state_decl))
        dll_api.append("begin")
357 358
        dll_api.append("{}.state := States'Value(Value(new_state));"
                       .format(LPREFIX))
359 360 361
        dll_api.append("end set_state;")
        dll_api.append("")

362 363 364 365 366 367 368 369 370 371 372
        # 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))

373 374 375 376
        # Functions to get gobal variables (length and value)
        for var_name, (var_type, _) in process.variables.viewitems():
            # Getters for local variables
            process_level_decl.append("function l_{name}_size return integer "
377 378 379 380
                                     "is ({prefix}.{name}'Size/8) with Export,"
                                     " Convention => C,"
                                     ' Link_Name => "{name}_size";'
                                     .format(prefix=LPREFIX, name=var_name))
381
            process_level_decl.append("function l_{name}_value"
382 383 384 385 386
                                     " return access {sort} "
                                     "is ({prefix}.{name}'access) with Export,"
                                     " Convention => C,"
                                     ' Link_Name => "{name}_value";'
                                     .format(prefix=LPREFIX, name=var_name,
387 388 389 390 391
                                              sort=type_name(var_type)))
            # Setters for local variables
            setter_decl = "procedure dll_set_l_{name}(value: access {sort})"\
                          .format(name=var_name, sort=type_name(var_type))
            ads_template.append('{};'.format(setter_decl))
392 393
            ads_template.append('pragma export(C, dll_set_l_{name},'
                                ' "_set_{name}");'.format(name=var_name))
394 395
            dll_api.append('{} is'.format(setter_decl))
            dll_api.append('begin')
396
            dll_api.append('{}.{} := value.all;'.format(LPREFIX, var_name))
397 398 399
            dll_api.append('end dll_set_l_{};'.format(var_name))
            dll_api.append('')

Maxime Perrotin's avatar
Maxime Perrotin committed
400 401 402 403 404 405 406 407 408 409 410 411 412
    # 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)

    # 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)

413 414 415 416
    # Generate the code of the START procedures of state aggregations
    # XXX to be added to C generator
    taste_template.extend(aggreg_start_proc)

417 418 419
    # Add the code of the DLL interface
    taste_template.extend(dll_api)

Maxime Perrotin's avatar
Maxime Perrotin committed
420 421 422
    # 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]:
423
        signame = signal.get('name', u'START')
Maxime Perrotin's avatar
Maxime Perrotin committed
424
        if signame == u'START':
Maxime Perrotin's avatar
Maxime Perrotin committed
425
            continue
426
        pi_header = u'procedure {sig_name}'.format(sig_name=signame)
427
        param_name = signal.get('param_name') \
Maxime Perrotin's avatar
Maxime Perrotin committed
428
                                or u'{}_param'.format(signame)
Maxime Perrotin's avatar
Maxime Perrotin committed
429 430
        # Add (optional) PI parameter (only one is possible in TASTE PI)
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
431
            typename = type_name(signal['type'])
432
            pi_header += u'({pName}: access {sort})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
433
                                        pName=param_name, sort=typename)
Maxime Perrotin's avatar
Maxime Perrotin committed
434 435

        # Add declaration of the provided interface in the .ads file
436
        ads_template.append(u'--  Provided interface "{}"'.format(signame))
Maxime Perrotin's avatar
Maxime Perrotin committed
437
        ads_template.append(pi_header + ';')
438
        ads_template.append(u'pragma export(C, {name}, "{proc}_{name}");'
439
                             .format(name=signame, proc=process_name))
440 441 442 443 444

        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 []
445
            minicv.append(aadl_template(signame, params, 'RI'))
Maxime Perrotin's avatar
Maxime Perrotin committed
446 447 448 449

        pi_header += ' is'
        taste_template.append(pi_header)
        taste_template.append('begin')
450 451 452 453

        def execute_transition(state):
            ''' Generate the code that triggers the transition for the current
                state/input combination '''
454
            input_def = mapping[signame].get(state)
455
            # Check for nested states to call optional exit procedure
456
            state_tree = state.split(UNICODE_SEP)
Maxime Perrotin's avatar
Maxime Perrotin committed
457
            context = process
458 459 460 461 462 463
            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:
464
                    if current.lower() == comp.statename.lower():
465 466 467
                        if comp.exit_procedure:
                            exitlist.append(current)
                        context = comp
468
                        current = current + UNICODE_SEP
469 470 471 472
                        break
            for each in reversed(exitlist):
                if trans and all(each.startswith(trans_st)
                                 for trans_st in trans.possible_states):
473
                    taste_template.append(u'p{sep}{ref}{sep}exit;'
474
                                          .format(ref=each, sep=UNICODE_SEP))
475

Maxime Perrotin's avatar
Maxime Perrotin committed
476 477 478 479
            if input_def:
                for inp in input_def.parameters:
                    # Assign the (optional and unique) parameter
                    # to the corresponding process variable
480 481
                    taste_template.append(u'{ctxt}.{inp} := {tInp}.all;'
                                          .format(ctxt=LPREFIX,
482 483
                                                  inp=inp,
                                                  tInp=param_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
484 485
                # Execute the correponding transition
                if input_def.transition:
Maxime Perrotin's avatar
Maxime Perrotin committed
486
                    taste_template.append(u'runTransition({idx});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
487 488 489 490 491
                        idx=input_def.transition_id))
                else:
                    taste_template.append('null;')
            else:
                taste_template.append('null;')
492

493
        taste_template.append('case {}.state is'.format(LPREFIX))
494 495 496 497 498 499 500

        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
            '''
501
            if state.endswith(u'START'):
502
                return
503
            taste_template.append(u'when {state} =>'.format(state=state))
504
            input_def = mapping[signame].get(state)
505
            if state in aggregates.viewkeys():
506
                # State aggregation:
Maxime Perrotin's avatar
Maxime Perrotin committed
507 508
                # - find which substate manages this input
                # - add a swich case on the corresponding substate
509 510
                taste_template.append(u'-- this is a state aggregation')
                for sub in aggregates[state]:
511 512 513 514 515 516 517 518
                    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():
519
                            case_state(par)
520 521 522 523
                        taste_template.append('when others =>')
                        taste_template.append('null;')
                        taste_template.append('end case;')
                        break
524 525
                else:
                    # Input is not managed in the state aggregation
526 527 528
                    if input_def:
                        # check if it is managed one level above
                        execute_transition(state)
529
                    taste_template.append('null;')
Maxime Perrotin's avatar
Maxime Perrotin committed
530 531
            else:
                execute_transition(state)
532

533 534
        map(case_state, reduced_statelist) # XXX update C generator

Maxime Perrotin's avatar
Maxime Perrotin committed
535 536 537
        taste_template.append('when others =>')
        taste_template.append('null;')
        taste_template.append('end case;')
538
        taste_template.append(u'end {};'.format(signame))
Maxime Perrotin's avatar
Maxime Perrotin committed
539 540 541 542 543
        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:
544

545 546
        param_name = signal.get('param_name') \
                                or u'{}_param'.format(signal['name'])
Maxime Perrotin's avatar
Maxime Perrotin committed
547
        # Add (optional) RI parameter
548 549 550
        # 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
551
        param_spec = '' if not simu else "(tm: chars_ptr)"
Maxime Perrotin's avatar
Maxime Perrotin committed
552
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
553
            typename = type_name(signal['type'])
554 555 556 557 558
            param_spec = u'({pName}: access {sort}{shared})' \
                         .format(pName=param_name,
                                 sort=typename,
                                 shared=u'; Size: Integer'
                                        if SHARED_LIB else '')
559 560 561
        ads_template.append(u'--  {}equired interface "{}"'
                            .format("Paramless r" if not 'type' in signal
                                else "R", signal['name']))
562 563 564 565 566 567
        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))
            ads_template.append('pragma Convention(Convention => C,'
                                ' Entity => {}_T);'.format(signal['name']))
568
            ads_template.append('{sig} : {sig}_T;'
569
                                .format(sig=signal['name']))
570 571 572 573 574
            ads_template.append('procedure Register_{sig}(Callback: {sig}_T);'
                                .format(sig=signal['name']))
            ads_template.append('pragma Export(C, Register_{sig},'
                                ' "register_{sig}");'
                                .format(sig=signal['name']))
575 576 577 578

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

581 582 583 584 585 586 587
            taste_template.append('procedure Register_{sig}'
                                  '(Callback:{sig}_T) is'
                                  .format(sig=signal['name']))
            taste_template.append('begin')
            taste_template.append('{} := Callback;'.format(signal['name']))
            taste_template.append('end Register_{};'.format(signal['name']))
            taste_template.append('')
588 589 590 591 592
        else:
            ads_template.append(u'procedure {}{};'
                                .format(signal['name'], param_spec))
            ads_template.append(u'pragma import(C, {sig}, "{proc}_RI_{sig}");'
                                .format(sig=signal['name'], proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
593 594

    # for the .ads file, generate the declaration of the external procedures
595 596
    for proc in (proc for proc in process.procedures if proc.external):
        ri_header = u'procedure {sig_name}'.format(sig_name=proc.inputString)
Maxime Perrotin's avatar
Maxime Perrotin committed
597
        params = []
598 599 600 601
        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
602
        for param in proc.fpar:
Maxime Perrotin's avatar
Maxime Perrotin committed
603
            typename = type_name(param['type'])
604
            params.append(u'{par[name]}: access {sort}{shared}'
Maxime Perrotin's avatar
Maxime Perrotin committed
605
                          .format(par=param,
606 607 608 609
                                  sort=typename,
                                  shared=u"; {}_Size: Integer"
                                         .format(param['name'])
                                         if SHARED_LIB else ""))
Maxime Perrotin's avatar
Maxime Perrotin committed
610
        if params:
611 612
            params_spec = "({})".format("; ".join(params))
            ri_header += params_spec
613 614
        ads_template.append(u'--  Sync required interface "{}"'
                            .format(proc.inputString))
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
        if simu:
            # As for async TM, generate a callback mechanism
            ads_template.append(u"type {}_T is access procedure{};"
                                .format(proc.inputString, params_spec))
            ads_template.append('pragma Convention(Convention => C,'
                                ' Entity => {}_T);'.format(proc.inputString))
            ads_template.append('{sig} : {sig}_T;'
                                .format(sig=proc.inputString))
            ads_template.append('procedure Register_{sig}(Callback: {sig}_T);'
                                .format(sig=proc.inputString))
            ads_template.append('pragma Export(C, Register_{sig},'
                                ' "register_{sig}");'
                                .format(sig=proc.inputString))
            taste_template.append('procedure Register_{sig}'
                                  '(Callback:{sig}_T) is'
                                  .format(sig=proc.inputString))
            taste_template.append('begin')
            taste_template.append('{} := Callback;'.format(proc.inputString))
            taste_template.append('end Register_{};'.format(proc.inputString))
            taste_template.append('')

        else:
            ads_template.append(ri_header + u';')
            ads_template.append(u'pragma import(C, {sig}, "{proc}_RI_{sig}");'
                    .format(sig=proc.inputString, proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
640 641 642

    # for the .ads file, generate the declaration of timers set/reset functions
    for timer in process.timers:
643 644 645 646 647
        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'
Maxime Perrotin's avatar
Maxime Perrotin committed
648
                                 '(name: chars_ptr; duration: Integer);'
649
                                .format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
650 651
            ads_template.append(u'type RESET_{}_T is access procedure'
                                '(name: chars_ptr);'.format(timer))
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
            for each in ('', 'RE'):
                ads_template.append('pragma Convention(Convention => C,'
                                    ' Entity => {re}SET_{t}_T);'
                                    .format(re=each, t=timer))
                ads_template.append('{re}SET_{t} : {re}SET_{t}_T;'
                                    .format(re=each, t=timer))
                ads_template.append('procedure Register_{re}SET_{t}'
                                    '(Callback: {re}SET_{t}_T);'
                                    .format(re=each, t=timer))
                ads_template.append('pragma Export(C, Register_{re}SET_{t},'
                                    ' "register_{re}SET_{t}");'
                                    .format(re=each, t=timer))
            # Code for the SET/RESET timer callback registration
            for each in ('', 'RE'):
                taste_template.append('procedure Register_{re}SET_{t}'
                                      '(Callback:{re}SET_{t}_T) is'
                                      .format(re=each, t=timer))
                taste_template.append('begin')
                taste_template.append('{re}SET_{t} := Callback;'
                                      .format(re=each, t=timer))
                taste_template.append('end Register_{re}SET_{t};'
                                      .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
678
                .format(timer))
679
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
680
                u'pragma import(C, SET_{timer}, "{proc}_RI_set_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
681
                .format(timer=timer, proc=process_name))
682 683
            ads_template.append(u'procedure RESET_{};'.format(timer))
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
684
                u'pragma import(C, RESET_{timer}, "{proc}_RI_reset_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
685 686
                .format(timer=timer, proc=process_name))

687 688 689 690 691 692
    # 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;')

693 694
    # Transform inner labels to floating labels
    Helper.inner_labels_to_floating(process)
Maxime Perrotin's avatar
Maxime Perrotin committed
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710

    # 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)

711 712 713 714
    # Generate the code of the runTransition procedure, if needed
    if process.transitions:
        taste_template.append('procedure runTransition(Id: Integer) is')
        taste_template.append('trId : Integer := Id;')
Maxime Perrotin's avatar
Maxime Perrotin committed
715

716 717 718
        # Declare the local variables needed by the transitions in the template
        taste_template.extend(set(local_decl_transitions))
        taste_template.append('begin')
719

720 721 722
        # 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
723

724 725
        # Generate the switch-case on the transition id
        taste_template.append('case trId is')
Maxime Perrotin's avatar
Maxime Perrotin committed
726

727 728 729 730 731 732 733
        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
734

735 736 737 738 739 740 741 742
        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
743

744 745
        # Add the code for the floating labels
        taste_template.extend(code_labels)
Maxime Perrotin's avatar
Maxime Perrotin committed
746

747
        taste_template.append('<<next_transition>>')
748 749 750 751 752 753 754 755 756 757 758 759

        # 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
        if process.cs_mapping:
            taste_template.append('--  Process continuous signals')
        else:
            taste_template.append('null;')

        # Process the continuous states in state aggregations first
        done = []
760 761
        sep = 'if '
        last = ''
762 763 764 765 766 767 768 769 770 771 772
        for cs, agg in product(process.cs_mapping.viewitems(),
                               aggregates.viewitems()):
            (statename, cs_item), (agg_name, substates) = cs, agg
            for each in substates:
                if statename in each.mapping.viewkeys():
                    taste_template.append(u'{first}if trId = -1 and '
                            u'{ctxt}.state = {s1} and '
                            u'{ctxt}.{s2}{sep}state = {s3} then'
                            .format(ctxt=LPREFIX, s1=agg_name,
                                s2=each.statename, sep=UNICODE_SEP,
                                s3=statename, first='els' if done else ''))
773 774 775 776
                    for provided_clause in cs_item:
                        trId = process.transitions.index\
                                            (provided_clause.transition)
                        code, loc = generate(provided_clause.trigger,
777 778 779
                                             branch_to=trId,
                                             sep=sep, last=last)
                        sep='elsif '
780
                        taste_template.extend(code)
781
                    done.append(statename)
782 783
                    taste_template.append(u'end if;')
                    sep = 'if '
784 785 786 787 788
                    break
        for statename in process.cs_mapping.viewkeys() - done:
            cs_item = process.cs_mapping[statename]
            taste_template.append(u'{first}if trId = -1 and {}.state = {} then'
                    .format(LPREFIX, statename, first='els' if done else ''))
789 790 791
            for provided_clause in cs_item:
                trId = process.transitions.index(provided_clause.transition)
                code, loc = generate(provided_clause.trigger,
792 793
                                     branch_to=trId, sep=sep, last=last)
                sep='elsif '
794
                taste_template.extend(code)
795 796
        if process.cs_mapping:
            taste_template.append(u'end if;')
797
            taste_template.append(u'end if;')
798

799 800 801
        taste_template.append('end loop;')
        taste_template.append('end runTransition;')
        taste_template.append('\n')
Maxime Perrotin's avatar
Maxime Perrotin committed
802

803
    # Add code of the package elaboration
Maxime Perrotin's avatar
Maxime Perrotin committed
804 805 806 807 808 809 810
    taste_template.extend(start_transition)
    taste_template.append('end {process_name};'
            .format(process_name=process_name))

    ads_template.append('end {process_name};'
            .format(process_name=process_name))

811
    with open(process_name.lower() + os.extsep + 'adb', 'w') as ada_file:
Maxime Perrotin's avatar
Maxime Perrotin committed
812 813
        ada_file.write(
                u'\n'.join(format_ada_code(taste_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
814

815
    with open(process_name.lower() + os.extsep + 'ads', 'w') as ada_file:
Maxime Perrotin's avatar
Maxime Perrotin committed
816 817
        ada_file.write(
                u'\n'.join(format_ada_code(ads_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
818

819 820 821
    if simu:
        with open(u'{}_interface.aadl'.format(process_name), 'w') as aadl:
            aadl.write(u'\n'.join(minicv).encode('latin1'))
822 823
        script = '{}_simu.sh'.format(process_name)
        with open(script, 'w') as bash_script:
824
            bash_script.write(simu_script)
825
        os.chmod(script, os.stat(script).st_mode | stat.S_IXUSR)
826

Maxime Perrotin's avatar
Maxime Perrotin committed
827 828 829 830 831 832 833 834

def write_statement(param, newline):
    ''' Generate the code for the special "write" operator '''
    code = []
    string = ''
    local = []
    basic_type = find_basic_type(param.exprType) or {}
    type_kind = basic_type.kind
835 836 837 838 839 840 841 842 843
    if isinstance(param, ogAST.ExprAppend):
        # Append: call Put_Line separately for each side of the expression
        st1, _, lcl1= write_statement(param.left, newline = False)
        st2, _, lcl2 = write_statement(param.right, newline = False)
        code.extend(st1)
        code.extend(st2)
        local.extend(lcl1)
        local.extend(lcl2)
    elif type_kind.endswith('StringType'):
Maxime Perrotin's avatar
Maxime Perrotin committed
844 845
        if isinstance(param, ogAST.PrimStringLiteral):
            # Raw string
846 847
            code.append(u'Put("{}");'
                        .format(param.value[1:-1].replace('"', "'")))
Maxime Perrotin's avatar
Maxime Perrotin committed
848
        else:
Maxime Perrotin's avatar
Maxime Perrotin committed
849
            code, string, local = expression(param)
850 851
            if type_kind == 'OctetStringType':
                # Octet string -> convert to Ada string
852
                last_it = u""
853 854
                if isinstance(param, ogAST.PrimSubstring):
                    range_str = u"{}'Range".format(string)
855
                    iterator = u"i - {}'First + 1".format(string)
856 857 858
                elif basic_type.Min == basic_type.Max:
                    range_str = u"{}.Data'Range".format(string)
                    string += u".Data"
859
                    iterator = u"i"
860 861 862
                else:
                    range_str = u"1 .. {}.Length".format(string)
                    string += u".Data"
863 864
                    iterator = u"i"
                    last_it = u"({})".format(range_str)
865
                code.extend([u"for i in {} loop".format(range_str),
866
                             u"Put(Character'Val({st}(i)));"
867
                             .format(st=string),
868
                             u"end loop;"])
869 870
            else:
                code.append("Put({});".format(string))
Maxime Perrotin's avatar
Maxime Perrotin committed
871 872
    elif type_kind in ('IntegerType', 'RealType',
                       'BooleanType', 'Integer32Type'):
Maxime Perrotin's avatar
Maxime Perrotin committed
873
        code, string, local = expression(param)
874
        if type_kind == 'IntegerType':
875
            cast = "Asn1Int"
876
        elif type_kind == 'Integer32Type':
877
            cast = "Integer"
Maxime Perrotin's avatar
Maxime Perrotin committed
878 879 880 881
        elif type_kind == 'RealType':
            cast = 'Long_Float'
        elif type_kind == 'BooleanType':
            cast = 'Boolean'
882
        code.append(u"Put({cast}'Image({s}));".format(cast=cast, s=string))
883 884 885 886
    elif type_kind == 'EnumeratedType':
        code, string, local = expression(param)
        code.append(u"Put({}'Image({}));".format(type_name(param.exprType),
                                                 string))
Maxime Perrotin's avatar
Maxime Perrotin committed
887
    else:
888
        error = (u'Unsupported parameter in write call ' +
Maxime Perrotin's avatar
Maxime Perrotin committed
889 890 891
                param.inputString)
        LOG.error(error)
        raise TypeError(error)
892 893
    if newline:
        code.append(u"New_Line;")
Maxime Perrotin's avatar
Maxime Perrotin committed
894 895 896 897 898
    return code, string, local


@generate.register(ogAST.Output)
@generate.register(ogAST.ProcedureCall)
899
def _call_external_function(output, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
900 901 902 903 904 905 906 907 908
    ''' Generate the code of a set of output or procedure call statement '''
    code = []
    local_decl = []

    # Add the traceability information
    code.extend(traceability(output))

    for out in output.output:
        signal_name = out['outputName']
909
        list_of_params = []
Maxime Perrotin's avatar
Maxime Perrotin committed
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928

        if signal_name.lower() in ('write', 'writeln'):
            # special built-in SDL procedure for printing strings
            # supports printing of native types (int, real, bool)
            # but not yet complex ASN.1 structures (sequence/seqof/choice)
            for param in out['params'][:-1]:
                stmts, _, local = write_statement(param, newline=False)
                code.extend(stmts)
                local_decl.extend(local)
            for param in out['params'][-1:]:
                # Last parameter - add newline if necessary
                stmts, _, local = write_statement(param, newline=True if
                        signal_name.lower() == 'writeln' else False)
                code.extend(stmts)
                local_decl.extend(local)
            continue
        elif signal_name.lower() == 'reset_timer':
            # built-in operator for resetting timers. param = timer name
            param, = out['params']
Maxime Perrotin's avatar
Maxime Perrotin committed
929
            p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
930 931
            code.extend(p_code)
            local_decl.extend(p_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
932 933 934 935
            if not SHARED_LIB:
                code.append('RESET_{};'.format(p_id))
            else:
                code.append('RESET_{t}(New_String("{t}"));'.format(t=p_id))
Maxime Perrotin's avatar
Maxime Perrotin committed
936 937 938 939
            continue
        elif signal_name.lower() == 'set_timer':
            # built-in operator for setting a timer: SET(1000, timer_name)
            timer_value, timer_id = out['params']
Maxime Perrotin's avatar
Maxime Perrotin committed
940 941
            t_code, t_val, t_local = expression(timer_value)
            p_code, p_id, p_local = expression(timer_id)
Maxime Perrotin's avatar
Maxime Perrotin committed
942 943 944 945
            code.extend(t_code)
            code.extend(p_code)
            local_decl.extend(t_local)
            local_decl.extend(p_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
946 947 948 949 950 951 952 953 954 955 956
            if not SHARED_LIB:
                # Use a temporary variable to store the timer value
                tmp_id = 'tmp' + str(out['tmpVars'][0])
                local_decl.append('{} : aliased asn1SccT_UInt32;'
                                  .format(tmp_id))
                code.append('{tmp} := {val};'.format(tmp=tmp_id, val=t_val))
                code.append("SET_{timer}({value}'access);"
                            .format(timer=p_id, value=tmp_id))
            else:
                code.append('SET_{t}(New_String("{t}"), {val});'
                            .format(t=p_id, val=t_val))
Maxime Perrotin's avatar
Maxime Perrotin committed
957 958
            continue
        proc, out_sig = None, None
959
        is_out_sig = False
Maxime Perrotin's avatar
Maxime Perrotin committed
960 961 962
        try:
            out_sig, = [sig for sig in OUT_SIGNALS
                        if sig['name'].lower() == signal_name.lower()]
963
            is_out_sig = True if SHARED_LIB else False
Maxime Perrotin's avatar
Maxime Perrotin committed
964
        except ValueError:
965
            # Not an output, try if it is an external or inner procedure
Maxime Perrotin's avatar
Maxime Perrotin committed
966
            try:
967
                proc, = [sig for sig in PROCEDURES
Maxime Perrotin's avatar
Maxime Perrotin committed
968
                            if sig.inputString.lower() == signal_name.lower()]
969 970
                if proc.external:
                    out_sig = proc
971 972 973 974
                    if SHARED_LIB:
                        is_out_sig = True
                        list_of_params = ['New_String("{}")'
                                              .format(out['outputName'])]
Maxime Perrotin's avatar
Maxime Perrotin committed
975
            except ValueError:
976
                # Not there? Impossible, the parser would have barked
977
                raise ValueError(u'Probably a bug - please report')