LlvmGenerator.py 21.7 KB
Newer Older
Maxime Perrotin's avatar
Maxime Perrotin committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
    OpenGEODE - A tiny SDL Editor for TASTE

    This module generates LLVM IR code from SDL process models, allowing
    generation of a binary application without an intermediate language.
    LLVM also allows for various code verification, analysis, and optimization.

    The design is based on the Ada code generator. Check it for details.

    Copyright (c) 2012-2013 European Space Agency

    Designed and implemented by Maxime Perrotin

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

import logging
Maxime Perrotin's avatar
Maxime Perrotin committed
21
from singledispatch import singledispatch
Maxime Perrotin's avatar
Maxime Perrotin committed
22
23
24
from llvm import core, passes, ee

import ogAST
Maxime Perrotin's avatar
Maxime Perrotin committed
25
import Helper
Maxime Perrotin's avatar
Maxime Perrotin committed
26
27
28

LOG = logging.getLogger(__name__)

Maxime Perrotin's avatar
Maxime Perrotin committed
29
30
__all__ = ['generate']

Maxime Perrotin's avatar
Maxime Perrotin committed
31
32
33
34
35
36
37
38

# LLVM Global variable - Initialized when the generator is invoked
LLVM = {
    # The LLVM module, which holds all the IR code.
    'module': None,
    # Dictionary that keeps track of which values are defined in the current
    # scope and what their LLVM representation is.
    'named_values': {},
39
40
41
    # Dictionary that keeps track of the defined states and its integer
    # constant representation
    'states': {},
42
43
    # The builder used for the current function generation.
    'builder': None,
Maxime Perrotin's avatar
Maxime Perrotin committed
44
45
46
    # The function optimization passes manager.
    'pass_manager': None,
    # The LLVM execution engine.
47
48
49
50
51
    'executor': None,
    # ASN.1 data view
    'dataview': None,
    # Generated types
    'types': {}
Maxime Perrotin's avatar
Maxime Perrotin committed
52
53
}

dbarbera's avatar
dbarbera committed
54

Maxime Perrotin's avatar
Maxime Perrotin committed
55
56
57
58
@singledispatch
def generate(ast):
    ''' Generate the code for an item of the AST '''
    raise TypeError('[Backend] Unsupported AST construct')
Maxime Perrotin's avatar
Maxime Perrotin committed
59

dbarbera's avatar
dbarbera committed
60

Maxime Perrotin's avatar
Maxime Perrotin committed
61
# Processing of the AST
Maxime Perrotin's avatar
Maxime Perrotin committed
62

Maxime Perrotin's avatar
Maxime Perrotin committed
63
64
@generate.register(ogAST.Process)
def _process(process):
dbarbera's avatar
dbarbera committed
65
    ''' Generate LLVM IR code '''
66

67
    process_name = str(process.processName)
Maxime Perrotin's avatar
Maxime Perrotin committed
68
69
    LOG.info('Generating LLVM IR code for process ' + str(process_name))

Maxime Perrotin's avatar
Maxime Perrotin committed
70
71
72
73
74
75
76
    # In case model has nested states, flatten everything
    Helper.flatten(process)

    # 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
77
    # Initialise LLVM global structure
78
    LLVM['module'] = core.Module.new(process_name)
Maxime Perrotin's avatar
Maxime Perrotin committed
79
80
    LLVM['pass_manager'] = passes.FunctionPassManager.new(LLVM['module'])
    LLVM['executor'] = ee.ExecutionEngine.new(LLVM['module'])
81
    LLVM['dataview'] = process.dataview
Maxime Perrotin's avatar
Maxime Perrotin committed
82
83
84
    # Set up the optimizer pipeline.
    # Start with registering info about how the
    # target lays out data structures.
85
86
87
88
89
90
91
92
93
94
#   LLVM['pass_manager'].add(LLVM['executor'].target_data)
#   # Do simple "peephole" optimizations and bit-twiddling optzns.
#   LLVM['pass_manager'].add(passes.PASS_INSTRUCTION_COMBINING)
#   # Reassociate expressions.
#   LLVM['pass_manager'].add(passes.PASS_REASSOCIATE)
#   # Eliminate Common SubExpressions.
#   LLVM['pass_manager'].add(passes.PASS_GVN)
#   # Simplify the control flow graph (deleting unreachable blocks, etc).
#   LLVM['pass_manager'].add(passes.PASS_CFG_SIMPLIFICATION)
#   LLVM['pass_manager'].initialize()
Maxime Perrotin's avatar
Maxime Perrotin committed
95

96
97
98
99
100
101
    # Initialize states enum
    for name in process.mapping.iterkeys():
        if not name.endswith('START'):
            cons = core.Constant.int(core.Type.int(), len(LLVM['states']))
            LLVM['states'][name] = cons

102
    # Generate state var
103
104
    LLVM['module'].add_global_variable(core.Type.int(), 'state')

105
    # Generare process-level vars
dbarbera's avatar
dbarbera committed
106
    for var_name, (var_asn1_type, def_value) in process.variables.viewitems():
107
        var_type = _generate_type(var_asn1_type)
dbarbera's avatar
dbarbera committed
108
        LLVM['module'].add_global_variable(var_type, str(var_name))
109
        if def_value:
dbarbera's avatar
dbarbera committed
110
            raise NotImplementedError
111

112
    # Generate process functions
113
114
115
    runtr_func = _generate_runtr_func(process)
    _generate_startup_func(process, process_name, runtr_func)

116
117
118
119
    # Generate input signals
    for signal in process.input_signals:
        _generate_input_signal(signal, mapping[signal['name']])

120
121
122
123
    print LLVM['module']


def _generate_runtr_func(process):
dbarbera's avatar
dbarbera committed
124
    ''' Generate code for the run_transition function '''
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
    func_name = 'run_transition'
    func_type = core.Type.function(core.Type.void(), [core.Type.int()])
    func = core.Function.new(LLVM['module'], func_type, func_name)

    entry_block = func.append_basic_block('entry')
    cond_block = func.append_basic_block('cond')
    body_block = func.append_basic_block('body')
    exit_block = func.append_basic_block('exit')

    builder = core.Builder.new(entry_block)
    LLVM['builder'] = builder

    # entry
    id_ptr = builder.alloca(core.Type.int(), None, 'id')
    LLVM['named_values']['id'] = id_ptr
    builder.store(func.args[0], id_ptr)
    builder.branch(cond_block)

    # cond
    builder.position_at_end(cond_block)
    id_ptr = func.args[0]
    no_tr_cons = core.Constant.int(core.Type.int(), -1)
    cond_val = builder.icmp(core.ICMP_NE, id_ptr, no_tr_cons, 'cond')
    builder.cbranch(cond_val, body_block, exit_block)

    # body
    builder.position_at_end(body_block)
    switch = builder.switch(func.args[0], exit_block)

    # transitions
    for idx, tr in enumerate(process.transitions):
        tr_block = func.append_basic_block('tr%d' % idx)
        const = core.Constant.int(core.Type.int(), idx)
        switch.add_case(const, tr_block)
        builder.position_at_end(tr_block)
        generate(tr)
        builder.branch(cond_block)

    # exit
    builder.position_at_end(exit_block)
    builder.ret_void()

    func.verify()
Maxime Perrotin's avatar
Maxime Perrotin committed
168
    LLVM['named_values'].clear()
169
170
171
172
    return func


def _generate_startup_func(process, process_name, runtr_func):
dbarbera's avatar
dbarbera committed
173
    ''' Generate code for the startup function '''
174
175
176
177
178
179
180
181
182
183
    func_name = process_name + '_startup'
    func_type = core.Type.function(core.Type.void(), [])
    func = core.Function.new(LLVM['module'], func_type, func_name)

    entry_block = func.append_basic_block('entry')
    builder = core.Builder.new(entry_block)
    LLVM['builder'] = builder

    # entry
    builder.call(runtr_func, [core.Constant.int(core.Type.int(), 0)])
Maxime Perrotin's avatar
Maxime Perrotin committed
184
185
    builder.ret_void()

186
187
    func.verify()
    return func
Maxime Perrotin's avatar
Maxime Perrotin committed
188
189


190
def _generate_input_signal(signal, inputs):
dbarbera's avatar
dbarbera committed
191
    ''' Generate code for an input signal '''
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
    func_name = str(signal['name'])
    func_type = core.Type.function(core.Type.void(), [])
    func = core.Function.new(LLVM['module'], func_type, func_name)

    entry_block = func.append_basic_block('entry')
    exit_block = func.append_basic_block('exit')
    builder = core.Builder.new(entry_block)

    runtr_func = LLVM['module'].get_function_named('run_transition')

    g_state_val = builder.load(LLVM['module'].get_global_variable_named('state'))
    switch = builder.switch(g_state_val, exit_block)

    for state_name, state_id in LLVM['states'].iteritems():
        state_block = func.append_basic_block('state_%s' % str(state_name))
        switch.add_case(state_id, state_block)
        builder.position_at_end(state_block)

        # TODO: Nested states

        inputdef = inputs.get(state_name)
        if inputdef:
            for param in inputdef.parameters:
                raise NotImplementedError
            if inputdef.transition:
                id_val = core.Constant.int(core.Type.int(), inputdef.transition_id)
                builder.call(runtr_func, [id_val])

        builder.ret_void()

    builder.position_at_end(exit_block)
    builder.ret_void()

    func.verify()


Maxime Perrotin's avatar
Maxime Perrotin committed
228
229
def write_statement(param, newline):
    ''' Generate the code for the special "write" operator '''
230
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
231

232

Maxime Perrotin's avatar
Maxime Perrotin committed
233
234
235
236
@generate.register(ogAST.Output)
@generate.register(ogAST.ProcedureCall)
def _call_external_function(output):
    ''' Generate the code of a set of output or procedure call statement '''
237
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
238
239
240
241


@generate.register(ogAST.TaskAssign)
def _task_assign(task):
dbarbera's avatar
dbarbera committed
242
    ''' Generate the code of a list of assignments '''
243
244
    for expr in task.elems:
        expression(expr)
Maxime Perrotin's avatar
Maxime Perrotin committed
245
246
247
248
249


@generate.register(ogAST.TaskInformalText)
def _task_informal_text(task):
    ''' Generate comments for informal text '''
250
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
251
252
253
254


@generate.register(ogAST.TaskForLoop)
def _task_forloop(task):
dbarbera's avatar
dbarbera committed
255
    ''' Generate the code for a for loop '''
256
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
257

dbarbera's avatar
dbarbera committed
258

Maxime Perrotin's avatar
Maxime Perrotin committed
259
260
261
262
# ------ expressions --------

@singledispatch
def expression(expr):
dbarbera's avatar
dbarbera committed
263
    ''' Generate the code for Expression-classes '''
Maxime Perrotin's avatar
Maxime Perrotin committed
264
265
266
267
    raise TypeError('Unsupported expression: ' + str(expr))


@expression.register(ogAST.PrimVariable)
Maxime Perrotin's avatar
Maxime Perrotin committed
268
def _primary_variable(prim):
dbarbera's avatar
dbarbera committed
269
    ''' Generate the code for a single variable reference '''
270
    return LLVM['module'].get_global_variable_named(str(prim.value[0]))
Maxime Perrotin's avatar
Maxime Perrotin committed
271
272


Maxime Perrotin's avatar
Maxime Perrotin committed
273
@expression.register(ogAST.PrimPath)
dbarbera's avatar
dbarbera committed
274
def _prim_path(primary_id):
dbarbera's avatar
dbarbera committed
275
    ''' Generate the code for an of an element list (path) '''
276
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
277
278


Maxime Perrotin's avatar
Maxime Perrotin committed
279
280
281
282
283
284
285
286
287
288
289
290
@expression.register(ogAST.ExprPlus)
@expression.register(ogAST.ExprMul)
@expression.register(ogAST.ExprMinus)
@expression.register(ogAST.ExprEq)
@expression.register(ogAST.ExprNeq)
@expression.register(ogAST.ExprGt)
@expression.register(ogAST.ExprGe)
@expression.register(ogAST.ExprLt)
@expression.register(ogAST.ExprLe)
@expression.register(ogAST.ExprDiv)
@expression.register(ogAST.ExprMod)
@expression.register(ogAST.ExprRem)
dbarbera's avatar
dbarbera committed
291
292
def _basic(expr):
    ''' Generate the code for an arithmetic of relational expression '''
293
    builder = LLVM['builder']
294
295
    lefttmp = expression(expr.left)
    righttmp = expression(expr.right)
296
297

    # load the value of the expression if it is a pointer
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
    if lefttmp.type.kind == core.TYPE_POINTER:
        lefttmp = builder.load(lefttmp, 'lefttmp')
    if righttmp.type.kind == core.TYPE_POINTER:
        righttmp = builder.load(righttmp, 'lefttmp')

    if lefttmp.type.kind != righttmp.type.kind:
        raise NotImplementedError

    if lefttmp.type.kind == core.TYPE_INTEGER:
        if expr.operand == '+':
            return builder.add(lefttmp, righttmp, 'addtmp')
        elif expr.operand == '-':
            return builder.sub(lefttmp, righttmp, 'subtmp')
        elif expr.operand == '*':
            return builder.mul(lefttmp, righttmp, 'multmp')
        elif expr.operand == '/':
            return builder.sdiv(lefttmp, righttmp, 'divtmp')
        elif expr.operand == 'mod':
316
317
318
319
320
321
            # l mod r == (((l rem r) + r) rem r)
            remtmp = builder.srem(lefttmp, righttmp)
            addtmp = builder.add(remtmp, righttmp)
            return builder.srem(addtmp, righttmp, 'modtmp')
        elif expr.operand == 'rem':
            return builder.srem(lefttmp, righttmp, 'remtmp')
322
323
324
325
326
327
328
329
330
331
332
333
        elif expr.operand == '<':
            return builder.icmp(core.ICMP_SLT, lefttmp, righttmp, 'lttmp')
        elif expr.operand == '<=':
            return builder.icmp(core.ICMP_SLE, lefttmp, righttmp, 'letmp')
        elif expr.operand == '=':
            return builder.icmp(core.ICMP_EQ, lefttmp, righttmp, 'eqtmp')
        elif expr.operand == '/=':
            return builder.icmp(core.ICMP_NE, lefttmp, righttmp, 'netmp')
        elif expr.operand == '>=':
            return builder.icmp(core.ICMP_SGE, lefttmp, righttmp, 'getmp')
        elif expr.operand == '>':
            return builder.icmp(core.ICMP_SGT, lefttmp, righttmp, 'gttmp')
334
335
336
337
338
339
340
341
342
343
344
345
        else:
            raise NotImplementedError
    elif lefttmp.type.kind == core.TYPE_DOUBLE:
        if expr.operand == '+':
            return builder.fadd(lefttmp, righttmp, 'addtmp')
        elif expr.operand == '-':
            return builder.fsub(lefttmp, righttmp, 'subtmp')
        elif expr.operand == '*':
            return builder.fmul(lefttmp, righttmp, 'multmp')
        elif expr.operand == '/':
            return builder.fdiv(lefttmp, righttmp, 'divtmp')
        elif expr.operand == 'mod':
346
347
348
349
350
351
            # l mod r == (((l rem r) + r) rem r)
            remtmp = builder.frem(lefttmp, righttmp)
            addtmp = builder.fadd(remtmp, righttmp)
            return builder.frem(addtmp, righttmp, 'modtmp')
        elif expr.operand == 'rem':
            return builder.frem(lefttmp, righttmp, 'remtmp')
352
353
354
355
356
357
358
359
360
361
362
363
        elif expr.operand == '<':
            return builder.icmp(core.FCMP_OLT, lefttmp, righttmp, 'lttmp')
        elif expr.operand == '<=':
            return builder.icmp(core.FCMP_OLE, lefttmp, righttmp, 'letmp')
        elif expr.operand == '=':
            return builder.icmp(core.FCMP_OEQ, lefttmp, righttmp, 'eqtmp')
        elif expr.operand == '/=':
            return builder.icmp(core.FCMP_ONE, lefttmp, righttmp, 'netmp')
        elif expr.operand == '>=':
            return builder.icmp(core.FCMP_OGE, lefttmp, righttmp, 'getmp')
        elif expr.operand == '>':
            return builder.icmp(core.FCMP_OGT, lefttmp, righttmp, 'gttmp')
364
365
        else:
            raise NotImplementedError
366
    else:
367
        raise NotImplementedError
368

Maxime Perrotin's avatar
Maxime Perrotin committed
369

370
371
@expression.register(ogAST.ExprAssign)
def _assign(expr):
dbarbera's avatar
dbarbera committed
372
    ''' Generate the code for an assign expression '''
373
    builder = LLVM['builder']
374

375
376
377
    left = expression(expr.left)
    right = expression(expr.right)

378
379
380
381
382
383
384
385
386
387
388
389
390
    if left.type.kind == core.TYPE_POINTER and left.type.pointee.kind == core.TYPE_STRUCT:
        memcpy = _get_memcpy_intrinsic()

        size = core.Constant.int(core.Type.int(64), 2)
        align = core.Constant.int(core.Type.int(32), 1)
        volatile = core.Constant.int(core.Type.int(1), 0)

        right_ptr = builder.bitcast(right, core.Type.pointer(core.Type.int(8)))
        left_ptr = builder.bitcast(left, core.Type.pointer(core.Type.int(8)))

        builder.call(memcpy, [left_ptr, right_ptr, size, align, volatile])
    else:
        builder.store(right, left)
dbarbera's avatar
dbarbera committed
391

392
393
    return left

Maxime Perrotin's avatar
Maxime Perrotin committed
394

Maxime Perrotin's avatar
Maxime Perrotin committed
395
396
397
@expression.register(ogAST.ExprOr)
@expression.register(ogAST.ExprAnd)
@expression.register(ogAST.ExprXor)
dbarbera's avatar
dbarbera committed
398
399
def _logical(expr):
    ''' Generate the code for a logical expression '''
dbarbera's avatar
dbarbera committed
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
    builder = LLVM['builder']

    lefttmp = expression(expr.left)
    righttmp = expression(expr.right)

    ty = find_basic_type(expr.exprType)
    if ty.kind != 'BooleanType':
        raise NotImplementedError

    # load the value of the expression if it is a pointer
    if lefttmp.type.kind == core.TYPE_POINTER:
        lefttmp = builder.load(lefttmp, 'lefttmp')
    if righttmp.type.kind == core.TYPE_POINTER:
        righttmp = builder.load(righttmp, 'lefttmp')

    if expr.operand == '&&':
        return builder.and_(lefttmp, righttmp, 'ortmp')
    elif expr.operand == '||':
        return builder.or_(lefttmp, righttmp, 'ortmp')
    else:
        return builder.xor(lefttmp, righttmp, 'xortmp')

Maxime Perrotin's avatar
Maxime Perrotin committed
422

Maxime Perrotin's avatar
Maxime Perrotin committed
423
@expression.register(ogAST.ExprAppend)
Maxime Perrotin's avatar
Maxime Perrotin committed
424
425
def _append(expr):
    ''' Generate code for the APPEND construct: a // b '''
426
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
427
428


Maxime Perrotin's avatar
Maxime Perrotin committed
429
@expression.register(ogAST.ExprIn)
Maxime Perrotin's avatar
Maxime Perrotin committed
430
def _expr_in(expr):
dbarbera's avatar
dbarbera committed
431
    ''' Generate the code for an in expression '''
432
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
433
434


Maxime Perrotin's avatar
Maxime Perrotin committed
435
@expression.register(ogAST.PrimEnumeratedValue)
Maxime Perrotin's avatar
Maxime Perrotin committed
436
437
def _enumerated_value(primary):
    ''' Generate code for an enumerated value '''
438
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
439
440


Maxime Perrotin's avatar
Maxime Perrotin committed
441
@expression.register(ogAST.PrimChoiceDeterminant)
Maxime Perrotin's avatar
Maxime Perrotin committed
442
443
def _choice_determinant(primary):
    ''' Generate code for a choice determinant (enumerated) '''
444
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
445
446


Maxime Perrotin's avatar
Maxime Perrotin committed
447
@expression.register(ogAST.PrimInteger)
448
449
450
451
452
def _integer(primary):
    ''' Generate code for a raw integer value  '''
    return core.Constant.int(core.Type.int(), primary.value[0])


Maxime Perrotin's avatar
Maxime Perrotin committed
453
@expression.register(ogAST.PrimReal)
454
455
def _real(primary):
    ''' Generate code for a raw real value  '''
dbarbera's avatar
dbarbera committed
456
    return core.Constant.real(core.Type.double(), primary.value[0])
457
458


Maxime Perrotin's avatar
Maxime Perrotin committed
459
@expression.register(ogAST.PrimBoolean)
460
461
def _boolean(primary):
    ''' Generate code for a raw boolean value  '''
dbarbera's avatar
dbarbera committed
462
463
464
465
    if primary.value[0].lower() == 'true':
        return core.Constant.int(core.Type.int(1), 1)
    else:
        return core.Constant.int(core.Type.int(1), 0)
Maxime Perrotin's avatar
Maxime Perrotin committed
466
467


Maxime Perrotin's avatar
Maxime Perrotin committed
468
@expression.register(ogAST.PrimEmptyString)
Maxime Perrotin's avatar
Maxime Perrotin committed
469
470
def _empty_string(primary):
    ''' Generate code for an empty SEQUENCE OF: {} '''
471
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
472
473


Maxime Perrotin's avatar
Maxime Perrotin committed
474
@expression.register(ogAST.PrimStringLiteral)
Maxime Perrotin's avatar
Maxime Perrotin committed
475
476
def _string_literal(primary):
    ''' Generate code for a string (Octet String) '''
477
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
478
479


Maxime Perrotin's avatar
Maxime Perrotin committed
480
@expression.register(ogAST.PrimConstant)
Maxime Perrotin's avatar
Maxime Perrotin committed
481
482
def _constant(primary):
    ''' Generate code for a reference to an ASN.1 constant '''
483
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
484
485


Maxime Perrotin's avatar
Maxime Perrotin committed
486
@expression.register(ogAST.PrimMantissaBaseExp)
Maxime Perrotin's avatar
Maxime Perrotin committed
487
488
def _mantissa_base_exp(primary):
    ''' Generate code for a Real with Mantissa-base-Exponent representation '''
489
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
490
491


Maxime Perrotin's avatar
Maxime Perrotin committed
492
@expression.register(ogAST.PrimIfThenElse)
dbarbera's avatar
dbarbera committed
493
def _if_then_else(ifthen):
dbarbera's avatar
dbarbera committed
494
    ''' Generate the code for ternary operator '''
495
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
496
497


Maxime Perrotin's avatar
Maxime Perrotin committed
498
@expression.register(ogAST.PrimSequence)
Maxime Perrotin's avatar
Maxime Perrotin committed
499
def _sequence(seq):
dbarbera's avatar
dbarbera committed
500
    ''' Generate the code for an ASN.1 SEQUENCE '''
501
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
502
503


Maxime Perrotin's avatar
Maxime Perrotin committed
504
@expression.register(ogAST.PrimSequenceOf)
Maxime Perrotin's avatar
Maxime Perrotin committed
505
def _sequence_of(seqof):
dbarbera's avatar
dbarbera committed
506
    ''' Generate the code for an ASN.1 SEQUENCE OF '''
507
508
509
510
511
512
513
514
515
516
517
518
519
520
    builder = LLVM['builder']

    ty = _generate_type(seqof.exprType)
    struct_ptr = builder.alloca(ty)
    zero_cons = core.Constant.int(core.Type.int(), 0)
    array_ptr = builder.gep(struct_ptr, [zero_cons, zero_cons])

    for idx, expr in enumerate(seqof.value):
        idx_cons = core.Constant.int(core.Type.int(), idx)
        expr_val = expression(expr)
        pos_ptr = builder.gep(array_ptr, [zero_cons, idx_cons])
        builder.store(expr_val, pos_ptr)

    return struct_ptr
Maxime Perrotin's avatar
Maxime Perrotin committed
521
522


Maxime Perrotin's avatar
Maxime Perrotin committed
523
@expression.register(ogAST.PrimChoiceItem)
Maxime Perrotin's avatar
Maxime Perrotin committed
524
def _choiceitem(choice):
dbarbera's avatar
dbarbera committed
525
    ''' Generate the code for a CHOICE expression '''
526
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
527
528
529
530


@generate.register(ogAST.Decision)
def _decision(dec):
dbarbera's avatar
dbarbera committed
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
    ''' Generate the code for a decision '''
    builder = LLVM['builder']
    func = builder.basic_block.function

    ans_cond_blocks = [func.append_basic_block('ans_cond') for ans in dec.answers]
    end_block = func.append_basic_block('end')

    builder.branch(ans_cond_blocks[0])

    for idx, ans in enumerate(dec.answers):
        ans_cond_block = ans_cond_blocks[idx]
        if ans.transition:
            ans_tr_block = func.append_basic_block('ans_tr')
        builder.position_at_end(ans_cond_block)

        if ans.kind == 'constant':
            next_block = ans_cond_blocks[idx+1] if idx < len(ans_cond_blocks) else end_block

            expr = ans.openRangeOp()
            expr.left = dec.question
            expr.right = ans.constant
            expr_val = expression(expr)

            true_cons = core.Constant.int(core.Type.int(1), 1)
            cond_val = builder.icmp(core.ICMP_EQ, expr_val, true_cons)
            builder.cbranch(cond_val, ans_tr_block if ans.transition else end_block, next_block)
        elif ans.kind == 'else':
            if ans.transition:
                builder.branch(ans_tr_block)
            else:
                builder.branch(end_block)
        else:
            raise NotImplementedError

        if ans.transition:
            builder.position_at_end(ans_tr_block)
            generate(ans.transition)
            builder.branch(end_block)

    builder.position_at_end(end_block)
Maxime Perrotin's avatar
Maxime Perrotin committed
571
572
573
574


@generate.register(ogAST.Label)
def _label(tr):
dbarbera's avatar
dbarbera committed
575
    ''' TGenerate the code for a Label '''
576
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
577
578
579
580


@generate.register(ogAST.Transition)
def _transition(tr):
dbarbera's avatar
dbarbera committed
581
    ''' Generate the code for a transition '''
582
583
584
585
586
587
    for action in tr.actions:
        generate(action)
        if isinstance(action, ogAST.Label):
            return
    if tr.terminator:
        _generate_terminator(tr.terminator)
588
589


590
def _generate_terminator(term):
dbarbera's avatar
dbarbera committed
591
    ''' Generate the code for a transition termiantor '''
592
593
594
    builder = LLVM['builder']
    id_ptr = LLVM['named_values']['id']
    if term.label:
595
        raise NotImplementedError
596
597
598
599
600
601
602
603
604
605
    if term.kind == 'next_state':
        state = term.inputString.lower()
        if state.strip() != '-':
            next_id_cons = core.Constant.int(core.Type.int(), term.next_id)
            builder.store(next_id_cons, id_ptr)
            if term.next_id == -1:
                state_ptr = LLVM['module'].get_global_variable_named('state')
                state_id_cons = LLVM['states'][state]
                builder.store(state_id_cons, state_ptr)
        else:
606
            raise NotImplementedError
607
    elif term.kind == 'join':
608
        raise NotImplementedError
609
    elif term.kind == 'stop':
610
        raise NotImplementedError
611
    elif term.kind == 'return':
612
        raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
613
614
615
616


@generate.register(ogAST.Floating_label)
def _floating_label(label):
dbarbera's avatar
dbarbera committed
617
    ''' Generate the code for a floating label '''
618
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
619
620
621
622
623


@generate.register(ogAST.Procedure)
def _inner_procedure(proc):
    ''' Generate the code for a procedure '''
624
    raise NotImplementedError
dbarbera's avatar
dbarbera committed
625
626
627


def _generate_type(ty):
628
    ''' Generate the equivalent LLVM type of a ASN.1 type '''
dbarbera's avatar
dbarbera committed
629
630
631
632
633
634
    basic_ty = find_basic_type(ty)
    if basic_ty.kind == 'IntegerType':
        return core.Type.int()
    elif basic_ty.kind == 'BooleanType':
        return core.Type.int(1)
    elif basic_ty.kind == 'RealType':
dbarbera's avatar
dbarbera committed
635
        return core.Type.double()
636
637
638
639
640
641
642
643
644
645
646
647
648
649
    elif basic_ty.kind == 'SequenceOfType':
        if ty.ReferencedTypeName in LLVM['types']:
            return LLVM['types'][ty.ReferencedTypeName]

        min_size = int(basic_ty.Max)
        max_size = int(basic_ty.Min)
        if min_size != max_size:
            raise NotImplementedError

        elem_ty = _generate_type(basic_ty.type)
        array_ty = core.Type.array(elem_ty, max_size)
        struct_ty = core.Type.struct([array_ty], ty.ReferencedTypeName)
        LLVM['types'][ty.ReferencedTypeName] = struct_ty
        return struct_ty
dbarbera's avatar
dbarbera committed
650
651
652
653
    else:
        raise NotImplementedError


654
def _get_memcpy_intrinsic():
dbarbera's avatar
dbarbera committed
655
    ''' Return the LLVM Memcpy Intrinsic '''
656
657
658
659
660
661
662
663
    arg_tys = [
        core.Type.pointer(core.Type.int(8)),
        core.Type.pointer(core.Type.int(8)),
        core.Type.int(64)
    ]
    return core.Function.intrinsic(LLVM['module'], core.INTR_MEMCPY, arg_tys)


dbarbera's avatar
dbarbera committed
664
665
666
667
668
669
# TODO: Refactor this into the helper module
def find_basic_type(a_type):
    ''' Return the ASN.1 basic type of a_type '''
    basic_type = a_type
    while basic_type.kind == 'ReferenceType':
        # Find type with proper case in the data view
670
        for typename in LLVM['dataview'].viewkeys():
dbarbera's avatar
dbarbera committed
671
            if typename.lower() == basic_type.ReferencedTypeName.lower():
672
                basic_type = LLVM['dataview'][typename].type
dbarbera's avatar
dbarbera committed
673
674
                break
    return basic_type