LlvmGenerator.py 23 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
70
    LOG.info('Generating LLVM IR code for process ' + str(process_name))

    # Initialise LLVM global structure
71
    LLVM['module'] = core.Module.new(process_name)
Maxime Perrotin's avatar
Maxime Perrotin committed
72
73
    LLVM['pass_manager'] = passes.FunctionPassManager.new(LLVM['module'])
    LLVM['executor'] = ee.ExecutionEngine.new(LLVM['module'])
74
    LLVM['dataview'] = process.dataview
Maxime Perrotin's avatar
Maxime Perrotin committed
75
76
77
    # Set up the optimizer pipeline.
    # Start with registering info about how the
    # target lays out data structures.
dbarbera's avatar
dbarbera committed
78
79
80
81
82
83
84
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()

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

dbarbera's avatar
dbarbera committed
105
106
107
108
109
110
111
112
113
114
115
116
    # Initialize output signals
    for signal in process.output_signals:
        param_tys = [core.Type.pointer(_generate_type(signal['type']))]
        func_ty = core.Type.function(core.Type.void(), param_tys)
        core.Function.new(LLVM['module'], func_ty, str(signal['name']))

    # Initialize external procedures
    for proc in [proc for proc in process.procedures if proc.external]:
        param_tys = [core.Type.pointer(_generate_type(p['type'])) for p in proc.fpar]
        func_ty = core.Type.function(core.Type.void(), param_tys)
        core.Function.new(LLVM['module'], func_ty, str(proc.inputString))

117
    # Generare process-level vars
dbarbera's avatar
dbarbera committed
118
    for var_name, (var_asn1_type, def_value) in process.variables.viewitems():
119
        var_type = _generate_type(var_asn1_type)
dbarbera's avatar
dbarbera committed
120
        LLVM['module'].add_global_variable(var_type, str(var_name))
121
        if def_value:
dbarbera's avatar
dbarbera committed
122
            raise NotImplementedError
123

124
    # Generate process functions
125
126
127
    runtr_func = _generate_runtr_func(process)
    _generate_startup_func(process, process_name, runtr_func)

128
129
130
131
    # Generate input signals
    for signal in process.input_signals:
        _generate_input_signal(signal, mapping[signal['name']])

132
133
134
135
    print LLVM['module']


def _generate_runtr_func(process):
dbarbera's avatar
dbarbera committed
136
    ''' Generate code for the run_transition function '''
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
168
169
170
171
172
173
174
175
176
177
178
179
    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
180
    LLVM['named_values'].clear()
181
182
183
184
    return func


def _generate_startup_func(process, process_name, runtr_func):
dbarbera's avatar
dbarbera committed
185
    ''' Generate code for the startup function '''
186
187
188
189
190
191
192
193
194
195
    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
196
197
    builder.ret_void()

198
199
    func.verify()
    return func
Maxime Perrotin's avatar
Maxime Perrotin committed
200
201


202
def _generate_input_signal(signal, inputs):
dbarbera's avatar
dbarbera committed
203
    ''' Generate code for an input signal '''
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
    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
240
241
242
243
@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 '''
dbarbera's avatar
dbarbera committed
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273

    for out in output.output:
        name = out['outputName'].lower()

        if name in ('write', 'writeln'):
            _generate_write(out['params'])
            continue
        elif name == 'reset_timer':
            _generate_reset_timer(out['params'])
            continue
        elif name == 'set_timer':
            _generate_set_timer(out['params'])
            continue

        func = LLVM['module'].get_function_named(str(name))
        LLVM['builder'].call(func, [expression(p) for p in out.get('params', [])])


def _generate_write(params):
    ''' Generate the code for the write operator '''
    raise NotImplementedError


def _generate_reset_timer(params):
    ''' Generate the code for the reset timer operator '''
    raise NotImplementedError


def _generate_set_timer(params):
    ''' Generate the code for the set timer operator '''
274
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
275
276
277
278


@generate.register(ogAST.TaskAssign)
def _task_assign(task):
dbarbera's avatar
dbarbera committed
279
    ''' Generate the code of a list of assignments '''
280
281
    for expr in task.elems:
        expression(expr)
Maxime Perrotin's avatar
Maxime Perrotin committed
282
283
284
285
286


@generate.register(ogAST.TaskInformalText)
def _task_informal_text(task):
    ''' Generate comments for informal text '''
287
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
288
289
290
291


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

dbarbera's avatar
dbarbera committed
295

Maxime Perrotin's avatar
Maxime Perrotin committed
296
297
298
299
# ------ expressions --------

@singledispatch
def expression(expr):
dbarbera's avatar
dbarbera committed
300
    ''' Generate the code for Expression-classes '''
Maxime Perrotin's avatar
Maxime Perrotin committed
301
302
303
304
    raise TypeError('Unsupported expression: ' + str(expr))


@expression.register(ogAST.PrimVariable)
Maxime Perrotin's avatar
Maxime Perrotin committed
305
def _primary_variable(prim):
dbarbera's avatar
dbarbera committed
306
    ''' Generate the code for a single variable reference '''
307
    return LLVM['module'].get_global_variable_named(str(prim.value[0]))
Maxime Perrotin's avatar
Maxime Perrotin committed
308
309


Maxime Perrotin's avatar
Maxime Perrotin committed
310
@expression.register(ogAST.PrimPath)
dbarbera's avatar
dbarbera committed
311
def _prim_path(primary_id):
dbarbera's avatar
dbarbera committed
312
    ''' Generate the code for an of an element list (path) '''
313
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
314
315


Maxime Perrotin's avatar
Maxime Perrotin committed
316
317
318
319
320
321
322
323
324
325
326
327
@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
328
329
def _basic(expr):
    ''' Generate the code for an arithmetic of relational expression '''
330
    builder = LLVM['builder']
331
332
    lefttmp = expression(expr.left)
    righttmp = expression(expr.right)
333
334

    # load the value of the expression if it is a pointer
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
    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':
353
354
355
356
357
358
            # 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')
359
360
361
362
363
364
365
366
367
368
369
370
        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')
371
372
373
374
375
376
377
378
379
380
381
382
        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':
383
384
385
386
387
388
            # 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')
389
390
391
392
393
394
395
396
397
398
399
400
        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')
401
402
        else:
            raise NotImplementedError
403
    else:
404
        raise NotImplementedError
405

Maxime Perrotin's avatar
Maxime Perrotin committed
406

407
408
@expression.register(ogAST.ExprAssign)
def _assign(expr):
dbarbera's avatar
dbarbera committed
409
    ''' Generate the code for an assign expression '''
410
    builder = LLVM['builder']
411

412
413
414
    left = expression(expr.left)
    right = expression(expr.right)

415
416
417
418
419
420
421
422
423
424
425
426
427
    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
428

429
430
    return left

Maxime Perrotin's avatar
Maxime Perrotin committed
431

Maxime Perrotin's avatar
Maxime Perrotin committed
432
433
434
@expression.register(ogAST.ExprOr)
@expression.register(ogAST.ExprAnd)
@expression.register(ogAST.ExprXor)
dbarbera's avatar
dbarbera committed
435
436
def _logical(expr):
    ''' Generate the code for a logical expression '''
dbarbera's avatar
dbarbera committed
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
    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
459

Maxime Perrotin's avatar
Maxime Perrotin committed
460
@expression.register(ogAST.ExprAppend)
Maxime Perrotin's avatar
Maxime Perrotin committed
461
462
def _append(expr):
    ''' Generate code for the APPEND construct: a // b '''
463
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
464
465


Maxime Perrotin's avatar
Maxime Perrotin committed
466
@expression.register(ogAST.ExprIn)
Maxime Perrotin's avatar
Maxime Perrotin committed
467
def _expr_in(expr):
dbarbera's avatar
dbarbera committed
468
    ''' Generate the code for an in expression '''
469
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
470
471


Maxime Perrotin's avatar
Maxime Perrotin committed
472
@expression.register(ogAST.PrimEnumeratedValue)
Maxime Perrotin's avatar
Maxime Perrotin committed
473
474
def _enumerated_value(primary):
    ''' Generate code for an enumerated value '''
475
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
476
477


Maxime Perrotin's avatar
Maxime Perrotin committed
478
@expression.register(ogAST.PrimChoiceDeterminant)
Maxime Perrotin's avatar
Maxime Perrotin committed
479
480
def _choice_determinant(primary):
    ''' Generate code for a choice determinant (enumerated) '''
481
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
482
483


Maxime Perrotin's avatar
Maxime Perrotin committed
484
@expression.register(ogAST.PrimInteger)
485
486
487
488
489
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
490
@expression.register(ogAST.PrimReal)
491
492
def _real(primary):
    ''' Generate code for a raw real value  '''
dbarbera's avatar
dbarbera committed
493
    return core.Constant.real(core.Type.double(), primary.value[0])
494
495


Maxime Perrotin's avatar
Maxime Perrotin committed
496
@expression.register(ogAST.PrimBoolean)
497
498
def _boolean(primary):
    ''' Generate code for a raw boolean value  '''
dbarbera's avatar
dbarbera committed
499
500
501
502
    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
503
504


Maxime Perrotin's avatar
Maxime Perrotin committed
505
@expression.register(ogAST.PrimEmptyString)
Maxime Perrotin's avatar
Maxime Perrotin committed
506
507
def _empty_string(primary):
    ''' Generate code for an empty SEQUENCE OF: {} '''
508
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
509
510


Maxime Perrotin's avatar
Maxime Perrotin committed
511
@expression.register(ogAST.PrimStringLiteral)
Maxime Perrotin's avatar
Maxime Perrotin committed
512
513
def _string_literal(primary):
    ''' Generate code for a string (Octet String) '''
514
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
515
516


Maxime Perrotin's avatar
Maxime Perrotin committed
517
@expression.register(ogAST.PrimConstant)
Maxime Perrotin's avatar
Maxime Perrotin committed
518
519
def _constant(primary):
    ''' Generate code for a reference to an ASN.1 constant '''
520
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
521
522


Maxime Perrotin's avatar
Maxime Perrotin committed
523
@expression.register(ogAST.PrimMantissaBaseExp)
Maxime Perrotin's avatar
Maxime Perrotin committed
524
525
def _mantissa_base_exp(primary):
    ''' Generate code for a Real with Mantissa-base-Exponent representation '''
526
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
527
528


Maxime Perrotin's avatar
Maxime Perrotin committed
529
@expression.register(ogAST.PrimIfThenElse)
dbarbera's avatar
dbarbera committed
530
def _if_then_else(ifthen):
dbarbera's avatar
dbarbera committed
531
    ''' Generate the code for ternary operator '''
532
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
533
534


Maxime Perrotin's avatar
Maxime Perrotin committed
535
@expression.register(ogAST.PrimSequence)
Maxime Perrotin's avatar
Maxime Perrotin committed
536
def _sequence(seq):
dbarbera's avatar
dbarbera committed
537
    ''' Generate the code for an ASN.1 SEQUENCE '''
538
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
539
540


Maxime Perrotin's avatar
Maxime Perrotin committed
541
@expression.register(ogAST.PrimSequenceOf)
Maxime Perrotin's avatar
Maxime Perrotin committed
542
def _sequence_of(seqof):
dbarbera's avatar
dbarbera committed
543
    ''' Generate the code for an ASN.1 SEQUENCE OF '''
544
545
546
547
548
549
550
551
552
553
554
555
556
557
    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
558
559


Maxime Perrotin's avatar
Maxime Perrotin committed
560
@expression.register(ogAST.PrimChoiceItem)
Maxime Perrotin's avatar
Maxime Perrotin committed
561
def _choiceitem(choice):
dbarbera's avatar
dbarbera committed
562
    ''' Generate the code for a CHOICE expression '''
563
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
564
565
566
567


@generate.register(ogAST.Decision)
def _decision(dec):
dbarbera's avatar
dbarbera committed
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
    ''' 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
608
609
610
611


@generate.register(ogAST.Label)
def _label(tr):
dbarbera's avatar
dbarbera committed
612
    ''' TGenerate the code for a Label '''
613
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
614
615
616
617


@generate.register(ogAST.Transition)
def _transition(tr):
dbarbera's avatar
dbarbera committed
618
    ''' Generate the code for a transition '''
619
620
621
622
623
624
    for action in tr.actions:
        generate(action)
        if isinstance(action, ogAST.Label):
            return
    if tr.terminator:
        _generate_terminator(tr.terminator)
625
626


627
def _generate_terminator(term):
dbarbera's avatar
dbarbera committed
628
    ''' Generate the code for a transition termiantor '''
629
630
631
    builder = LLVM['builder']
    id_ptr = LLVM['named_values']['id']
    if term.label:
632
        raise NotImplementedError
633
634
635
636
637
638
639
640
641
642
    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:
643
            raise NotImplementedError
644
    elif term.kind == 'join':
645
        raise NotImplementedError
646
    elif term.kind == 'stop':
647
        raise NotImplementedError
648
    elif term.kind == 'return':
649
        raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
650
651
652
653


@generate.register(ogAST.Floating_label)
def _floating_label(label):
dbarbera's avatar
dbarbera committed
654
    ''' Generate the code for a floating label '''
655
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
656
657
658
659
660


@generate.register(ogAST.Procedure)
def _inner_procedure(proc):
    ''' Generate the code for a procedure '''
661
    raise NotImplementedError
dbarbera's avatar
dbarbera committed
662
663
664


def _generate_type(ty):
665
    ''' Generate the equivalent LLVM type of a ASN.1 type '''
dbarbera's avatar
dbarbera committed
666
667
668
669
670
671
    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
672
        return core.Type.double()
673
674
675
676
677
678
679
680
681
682
683
684
685
686
    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
687
688
689
690
    else:
        raise NotImplementedError


691
def _get_memcpy_intrinsic():
dbarbera's avatar
dbarbera committed
692
    ''' Return the LLVM Memcpy Intrinsic '''
693
694
695
696
697
698
699
700
    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
701
702
703
704
705
706
# 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
707
        for typename in LLVM['dataview'].viewkeys():
dbarbera's avatar
dbarbera committed
708
            if typename.lower() == basic_type.ReferencedTypeName.lower():
709
                basic_type = LLVM['dataview'][typename].type
dbarbera's avatar
dbarbera committed
710
711
                break
    return basic_type