LlvmGenerator.py 14.4 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
47
48
49
50
51
    # The function optimization passes manager.
    'pass_manager': None,
    # The LLVM execution engine.
    'executor': None
}



Maxime Perrotin's avatar
Maxime Perrotin committed
52
53
54
55
@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
56

Maxime Perrotin's avatar
Maxime Perrotin committed
57
# Processing of the AST
Maxime Perrotin's avatar
Maxime Perrotin committed
58

Maxime Perrotin's avatar
Maxime Perrotin committed
59
60
61
@generate.register(ogAST.Process)
def _process(process):
    ''' Generate LLVM IR code (incomplete) '''
62
    process_name = str(process.processName)
Maxime Perrotin's avatar
Maxime Perrotin committed
63
64
    LOG.info('Generating LLVM IR code for process ' + str(process_name))

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

91
92
93
94
95
96
    # 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

97
    # Generate state var
98
99
    LLVM['module'].add_global_variable(core.Type.int(), 'state')

100
    # Generare process-level vars
dbarbera's avatar
dbarbera committed
101
102
103
    for var_name, (var_asn1_type, def_value) in process.variables.viewitems():
        var_type = _generate_type(find_basic_type(var_asn1_type))
        var_ptr = LLVM['module'].add_global_variable(var_type, str(var_name))
104
        if def_value:
dbarbera's avatar
dbarbera committed
105
            raise NotImplementedError
106

107
    # Generate process functions
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
    runtr_func = _generate_runtr_func(process)
    _generate_startup_func(process, process_name, runtr_func)

    print LLVM['module']


def _generate_runtr_func(process):
    '''Generate code for the run_transition function'''
    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
159
    LLVM['named_values'].clear()
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
    return func


def _generate_startup_func(process, process_name, runtr_func):
    '''Generate code for the startup function'''
    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
175
176
    builder.ret_void()

177
178
    func.verify()
    return func
Maxime Perrotin's avatar
Maxime Perrotin committed
179
180
181
182


def write_statement(param, newline):
    ''' Generate the code for the special "write" operator '''
183
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
184
185
186
187
188

@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 '''
189
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
190
191
192
193
194


@generate.register(ogAST.TaskAssign)
def _task_assign(task):
    ''' A list of assignments in a task symbol '''
195
196
    for expr in task.elems:
        expression(expr)
Maxime Perrotin's avatar
Maxime Perrotin committed
197
198
199
200
201


@generate.register(ogAST.TaskInformalText)
def _task_informal_text(task):
    ''' Generate comments for informal text '''
202
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
203
204
205
206
207
208
209
210
211


@generate.register(ogAST.TaskForLoop)
def _task_forloop(task):
    '''
        Return the code corresponding to a for loop. Two forms are possible:
        for x in range ([start], stop [, step])
        for x in iterable (a SEQUENCE OF)
    '''
212
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
213

Maxime Perrotin's avatar
Maxime Perrotin committed
214
215
216
217
218
219
220
221
222
223
224
225
226
# ------ expressions --------

@singledispatch
def expression(expr):
    ''' Generate the code for Expression-classes, returning 3 things:
        - list of statements
        - useable string corresponding to the evaluation of the expression,
        - list of local declarations
        (API can differ depending on the backend)
    '''
    raise TypeError('Unsupported expression: ' + str(expr))


Maxime Perrotin's avatar
Maxime Perrotin committed
227

Maxime Perrotin's avatar
Maxime Perrotin committed
228
@expression.register(ogAST.PrimVariable)
Maxime Perrotin's avatar
Maxime Perrotin committed
229
230
def _primary_variable(prim):
    ''' Single variable reference '''
231
    return LLVM['module'].get_global_variable_named(str(prim.value[0]))
Maxime Perrotin's avatar
Maxime Perrotin committed
232
233


Maxime Perrotin's avatar
Maxime Perrotin committed
234
@expression.register(ogAST.PrimPath)
Maxime Perrotin's avatar
Maxime Perrotin committed
235
236
237
238
239
240
241
242
243
244
def _prim_path(primaryId):
    '''
        Return the string of an element list (path)
        cases: a => 'l_a' (reference to a variable)
        a_timer => 'a_timer'  (reference to a timer)
        a!b => a.b (field of a structure)
        a!b if a is a CHOICE => TypeOfa_b_get(a)
        a(Expression) => a(ExpressionSolver) (array index)
        Expression can be complex (if-then-else-fi..)
    '''
245
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
246
247


Maxime Perrotin's avatar
Maxime Perrotin committed
248
249
250
251
252
253
254
255
256
257
258
259
@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)
Maxime Perrotin's avatar
Maxime Perrotin committed
260
261
def _basic_operators(expr):
    ''' Expressions with two sides '''
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
    builder = LLVM['builder']
    left = expression(expr.left)
    right = expression(expr.right)

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

    if expr.operand == '+':
        return builder.add(left, right, 'addtmp')
    elif expr.operand == '-':
        return builder.sub(left, right, 'subtmp')
    elif expr.operand == '*':
        return builder.sub(left, right, 'multmp')
    elif expr.operand == '/':
279
        raise NotImplementedError
280
281
282
    elif expr.operand == 'mod':
        return builder.srem(left, right, 'modtmp')
    else:
283
        raise NotImplementedError
284

Maxime Perrotin's avatar
Maxime Perrotin committed
285

286
287
288
289
290
291
292
293
294
295
@expression.register(ogAST.ExprAssign)
def _assign(expr):
    '''Assign expression'''
    builder = LLVM['builder']
    left = expression(expr.left)
    right = expression(expr.right)

    builder.store(right, left)
    return left

Maxime Perrotin's avatar
Maxime Perrotin committed
296

Maxime Perrotin's avatar
Maxime Perrotin committed
297
298
299
@expression.register(ogAST.ExprOr)
@expression.register(ogAST.ExprAnd)
@expression.register(ogAST.ExprXor)
Maxime Perrotin's avatar
Maxime Perrotin committed
300
301
def _bitwise_operators(expr):
    ''' Logical operators '''
302
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
303
304


Maxime Perrotin's avatar
Maxime Perrotin committed
305
@expression.register(ogAST.ExprAppend)
Maxime Perrotin's avatar
Maxime Perrotin committed
306
307
def _append(expr):
    ''' Generate code for the APPEND construct: a // b '''
308
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
309
310


Maxime Perrotin's avatar
Maxime Perrotin committed
311
@expression.register(ogAST.ExprIn)
Maxime Perrotin's avatar
Maxime Perrotin committed
312
313
def _expr_in(expr):
    ''' IN expressions: check if item is in a SEQUENCE OF '''
314
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
315
316


Maxime Perrotin's avatar
Maxime Perrotin committed
317
@expression.register(ogAST.PrimEnumeratedValue)
Maxime Perrotin's avatar
Maxime Perrotin committed
318
319
def _enumerated_value(primary):
    ''' Generate code for an enumerated value '''
320
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
321
322


Maxime Perrotin's avatar
Maxime Perrotin committed
323
@expression.register(ogAST.PrimChoiceDeterminant)
Maxime Perrotin's avatar
Maxime Perrotin committed
324
325
def _choice_determinant(primary):
    ''' Generate code for a choice determinant (enumerated) '''
326
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
327
328


Maxime Perrotin's avatar
Maxime Perrotin committed
329
@expression.register(ogAST.PrimInteger)
330
331
332
333
334
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
335
@expression.register(ogAST.PrimReal)
336
337
def _real(primary):
    ''' Generate code for a raw real value  '''
dbarbera's avatar
dbarbera committed
338
    return core.Constant.real(core.Type.double(), primary.value[0])
339
340


Maxime Perrotin's avatar
Maxime Perrotin committed
341
@expression.register(ogAST.PrimBoolean)
342
343
def _boolean(primary):
    ''' Generate code for a raw boolean value  '''
dbarbera's avatar
dbarbera committed
344
345
346
347
    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
348
349


Maxime Perrotin's avatar
Maxime Perrotin committed
350
@expression.register(ogAST.PrimEmptyString)
Maxime Perrotin's avatar
Maxime Perrotin committed
351
352
def _empty_string(primary):
    ''' Generate code for an empty SEQUENCE OF: {} '''
353
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
354
355


Maxime Perrotin's avatar
Maxime Perrotin committed
356
@expression.register(ogAST.PrimStringLiteral)
Maxime Perrotin's avatar
Maxime Perrotin committed
357
358
def _string_literal(primary):
    ''' Generate code for a string (Octet String) '''
359
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
360
361


Maxime Perrotin's avatar
Maxime Perrotin committed
362
@expression.register(ogAST.PrimConstant)
Maxime Perrotin's avatar
Maxime Perrotin committed
363
364
def _constant(primary):
    ''' Generate code for a reference to an ASN.1 constant '''
365
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
366
367


Maxime Perrotin's avatar
Maxime Perrotin committed
368
@expression.register(ogAST.PrimMantissaBaseExp)
Maxime Perrotin's avatar
Maxime Perrotin committed
369
370
def _mantissa_base_exp(primary):
    ''' Generate code for a Real with Mantissa-base-Exponent representation '''
371
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
372
373


Maxime Perrotin's avatar
Maxime Perrotin committed
374
@expression.register(ogAST.PrimIfThenElse)
Maxime Perrotin's avatar
Maxime Perrotin committed
375
376
def _if_then_else(ifThenElse):
    ''' Return string and statements for ternary operator '''
377
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
378
379


Maxime Perrotin's avatar
Maxime Perrotin committed
380
@expression.register(ogAST.PrimSequence)
Maxime Perrotin's avatar
Maxime Perrotin committed
381
382
def _sequence(seq):
    ''' Return Ada string for an ASN.1 SEQUENCE '''
383
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
384
385


Maxime Perrotin's avatar
Maxime Perrotin committed
386
@expression.register(ogAST.PrimSequenceOf)
Maxime Perrotin's avatar
Maxime Perrotin committed
387
388
def _sequence_of(seqof):
    ''' Return Ada string for an ASN.1 SEQUENCE OF '''
389
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
390
391


Maxime Perrotin's avatar
Maxime Perrotin committed
392
@expression.register(ogAST.PrimChoiceItem)
Maxime Perrotin's avatar
Maxime Perrotin committed
393
394
def _choiceitem(choice):
    ''' Return the Ada code for a CHOICE expression '''
395
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
396
397
398
399
400


@generate.register(ogAST.Decision)
def _decision(dec):
    ''' generate the code for a decision '''
401
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
402
403
404
405
406
407
408


@generate.register(ogAST.Label)
def _label(tr):
    ''' Transition following labels are generated in a separate section
        for visibility reasons (see Ada scope)
    '''
409
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
410
411
412
413
414


@generate.register(ogAST.Transition)
def _transition(tr):
    ''' generate the code for a transition '''
415
416
417
418
419
420
    for action in tr.actions:
        generate(action)
        if isinstance(action, ogAST.Label):
            return
    if tr.terminator:
        _generate_terminator(tr.terminator)
421
422


423
424
425
426
def _generate_terminator(term):
    builder = LLVM['builder']
    id_ptr = LLVM['named_values']['id']
    if term.label:
427
        raise NotImplementedError
428
429
430
431
432
433
434
435
436
437
    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:
438
            raise NotImplementedError
439
    elif term.kind == 'join':
440
        raise NotImplementedError
441
    elif term.kind == 'stop':
442
        raise NotImplementedError
443
    elif term.kind == 'return':
444
        raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
445
446
447
448
449


@generate.register(ogAST.Floating_label)
def _floating_label(label):
    ''' Generate the code for a floating label (Ada label + transition) '''
450
    raise NotImplementedError
Maxime Perrotin's avatar
Maxime Perrotin committed
451
452
453
454
455


@generate.register(ogAST.Procedure)
def _inner_procedure(proc):
    ''' Generate the code for a procedure '''
456
    raise NotImplementedError
dbarbera's avatar
dbarbera committed
457
458
459


def _generate_type(ty):
460
    '''Generate the equivalent LLVM type of a ASN.1 type'''
dbarbera's avatar
dbarbera committed
461
462
463
464
465
466
    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
467
        return core.Type.double()
dbarbera's avatar
dbarbera committed
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
    else:
        raise NotImplementedError


# 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
        for typename in LLVM['types'].viewkeys():
            if typename.lower() == basic_type.ReferencedTypeName.lower():
                basic_type = LLVM['types'][typename].type
                break
    return basic_type