ogParser.py 159 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
21
22
23
24
25
26
27
28
29
30
#!/usr/bin/env python
# -*- coding: utf-8 -*-


"""
    OpenGEODE SDL92 parser

    This library builds the SDL AST (described in ogAST.py)
    The AST can then be used to build SDL backends such as the
    diagram editor (placing symbols in a graphical canvas for editition)
    or code generators, etc.

    The AST build is based on the ANTLR-grammar and generated lexer and parser
    (the grammar is in the file sdl92.g and requires antlr 3.1.3 for Python
    to be compiled and used).

    During the build of the AST this library makes a number of semantic
    checks on the SDL input mode.

    Copyright (c) 2012-2013 European Space Agency

    Designed and implemented by Maxime Perrotin

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

__author__ = 'Maxime Perrotin'

import sys
import os
dbarbera's avatar
dbarbera committed
31
import math
Maxime Perrotin's avatar
Maxime Perrotin committed
32
33
import logging
import traceback
Maxime Perrotin's avatar
Maxime Perrotin committed
34
from itertools import chain, permutations, combinations
35
from collections import defaultdict, Counter
Maxime Perrotin's avatar
Maxime Perrotin committed
36
37
38
39
40
41
42
43
import antlr3
import antlr3.tree

import sdl92Lexer as lexer
from sdl92Parser import sdl92Parser

import samnmax
import ogAST
44
from Asn1scc import parse_asn1, ASN1
Maxime Perrotin's avatar
Maxime Perrotin committed
45
46
47

LOG = logging.getLogger(__name__)

48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
EXPR_NODE = {
    lexer.PLUS: ogAST.ExprPlus,
    lexer.ASTERISK: ogAST.ExprMul,
    lexer.IMPLIES: ogAST.ExprImplies,
    lexer.DASH: ogAST.ExprMinus,
    lexer.OR: ogAST.ExprOr,
    lexer.AND: ogAST.ExprAnd,
    lexer.XOR: ogAST.ExprXor,
    lexer.EQ: ogAST.ExprEq,
    lexer.NEQ: ogAST.ExprNeq,
    lexer.GT: ogAST.ExprGt,
    lexer.GE: ogAST.ExprGe,
    lexer.LT: ogAST.ExprLt,
    lexer.LE: ogAST.ExprLe,
    lexer.DIV: ogAST.ExprDiv,
    lexer.MOD: ogAST.ExprMod,
    lexer.APPEND: ogAST.ExprAppend,
    lexer.IN: ogAST.ExprIn,
    lexer.REM: ogAST.ExprRem,
    lexer.NOT: ogAST.ExprNot,
    lexer.NEG: ogAST.ExprNeg,
    lexer.PRIMARY: ogAST.Primary,
}
Maxime Perrotin's avatar
Maxime Perrotin committed
71
72
73
74
75
76
77
78
79
80
81
82

# Insert current path in the search list for importing modules
sys.path.insert(0, '.')

DV = None

# Code generator backends may need some intemediate variables to process
# expressions. For convenience and to avoid multiple pass parsing, the parser
# tries to guess where they may be useful, and adds a hint in the AST.
TMPVAR = 0

# ASN.1 types used to support the signature of special operators
83
84
85
INTEGER = type('IntegerType', (object,), {'kind': 'IntegerType',
                                          'Min': str(-(2 ** 63)),
                                          'Max': str(2 ** 63 - 1)})
Maxime Perrotin's avatar
Maxime Perrotin committed
86
INT32 = type('Integer32Type', (object,), {'kind': 'Integer32Type',
dbarbera's avatar
dbarbera committed
87
88
                                          'Min': '-2147483648',
                                          'Max': '2147483647'})
Maxime Perrotin's avatar
Maxime Perrotin committed
89
90
NUMERICAL = type('NumericalType', (object,), {'kind': 'Numerical'})
TIMER = type('TimerType', (object,), {'kind': 'TimerType'})
91
92
93
REAL = type('RealType', (object,), {'kind': 'RealType',
                                    'Min': str(1e-308),
                                    'Max': str(1e308)})
Maxime Perrotin's avatar
Maxime Perrotin committed
94
95
96
97
LIST = type('ListType', (object,), {'kind': 'ListType'})
ANY_TYPE = type('AnyType', (object,), {'kind': 'AnyType'})
CHOICE = type('ChoiceType', (object,), {'kind': 'ChoiceType'})
BOOLEAN = type('BooleanType', (object,), {'kind': 'BooleanType'})
98
99
RAWSTRING = type('RawString', (object,), {'kind': 'StandardStringType',
                                          'Min': '0', 'Max': '255'})
100
OCTETSTRING = type('OctetString', (object,), {'kind': 'OctetStringType'})
101
ENUMERATED = type('EnumeratedType', (object,), {'kind': 'EnumeratedType'})
Maxime Perrotin's avatar
Maxime Perrotin committed
102
103
104

UNKNOWN_TYPE = type('UnknownType', (object,), {'kind': 'UnknownType'})

105
SPECIAL_OPERATORS = {
dbarbera's avatar
dbarbera committed
106
107
    'abs': [{'type': NUMERICAL, 'direction': 'in'}],
    'ceil': [{'type': REAL, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
108
    'cos': [{'type': REAL, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
109
110
111
    'fix': [{'type': NUMERICAL, 'direction': 'in'}],
    'float': [{'type': NUMERICAL, 'direction': 'in'}],
    'floor': [{'type': REAL, 'direction': 'in'}],
112
    'length': [{'type': LIST, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
113
    'num': [{'type': ENUMERATED, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
114
115
116
117
    'power': [
        {'type': NUMERICAL, 'direction': 'in'},
        {'type': INTEGER, 'direction': 'in'}
    ],
118
119
    'present': [{'type': CHOICE, 'direction': 'in'}],
    'reset_timer': [{'type': TIMER, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
120
121
122
123
124
125
126
    'round': [{'type': REAL, 'direction': 'in'}],
    'set_timer': [
        {'type': INTEGER, 'direction': 'in'},
        {'type': TIMER, 'direction': 'in'}
    ],
    'sin': [{'type': REAL, 'direction': 'in'}],
    'sqrt': [{'type': REAL, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
127
128
129
    'trunc': [{'type': REAL, 'direction': 'in'}],
    'write': [{'type': ANY_TYPE, 'direction': 'in'}],
    'writeln': [{'type': ANY_TYPE, 'direction': 'in'}],
130
}
Maxime Perrotin's avatar
Maxime Perrotin committed
131
132
133
134

# Container to keep a list of types mapped from ANTLR Tokens
# (Used with singledispatch/visitor pattern)
ANTLR_TOKEN_TYPES = {a: type(a, (antlr3.tree.CommonTree,), {})
135
                    for a, b in lexer.__dict__.viewitems() if type(b) == int}
Maxime Perrotin's avatar
Maxime Perrotin committed
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150


# Shortcut to create a new referenced ASN.1 type
new_ref_type = lambda refname: \
        type(str(refname), (object,),
                {'kind': 'ReferenceType',
                 'ReferencedTypeName': refname.replace('_', '-')})

# Shortcut to return a type name (Reference name or basic type)
type_name = lambda t: \
                t.kind if t.kind != 'ReferenceType' else t.ReferencedTypeName

types = lambda: getattr(DV, 'types', {})


151
152
153
154
155
156
157
158
def substring_range(substring):
    ''' Return the range of a substring '''
    left, right = substring.value[1]['substring']
    left_bty = find_basic_type(left.exprType)
    right_bty = find_basic_type(right.exprType)
    return left_bty.Min, right_bty.Max


dbarbera's avatar
dbarbera committed
159
160
161
162
163
164
165
166
def is_integer(ty):
    ''' Return true if a type is an Integer Type '''
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type'
    )


167
168
169
170
171
def is_real(ty):
    ''' Return true if a type is a Real Type '''
    return find_basic_type(ty).kind == 'RealType'


172
def is_numeric(ty):
dbarbera's avatar
dbarbera committed
173
    ''' Return true if a type is a Numeric Type '''
174
175
176
177
178
179
180
181
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type',
        'Numerical',
        'RealType'
    )


182
183
184
185
186
def is_boolean(ty):
    ''' Return true if a type is a Boolean Type '''
    return find_basic_type(ty).kind == 'BooleanType'


dbarbera's avatar
dbarbera committed
187
188
189
190
def is_string(ty):
    ''' Return true if a type is a String Type '''
    return find_basic_type(ty).kind in (
        'StandardStringType',
191
192
        'OctetStringType',
        'StringType'
dbarbera's avatar
dbarbera committed
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
def is_sequenceof(ty):
    ''' Return true if a type is a SequenceOf Type '''
    return find_basic_type(ty).kind == 'SequenceOfType'


def is_list(ty):
    ''' Return true if a type is a List Type '''
    return is_string(ty) or is_sequenceof(ty) or ty == LIST


def is_enumerated(ty):
    ''' Return true if a type is an Enumerated Type '''
    return find_basic_type(ty).kind == 'EnumeratedType' or ty == ENUMERATED


def is_sequence(ty):
    ''' Return true if a type is a Sequence Type '''
    return find_basic_type(ty).kind == 'SequenceType'


def is_choice(ty):
    ''' Return true if a type is a Choice Type '''
    return find_basic_type(ty).kind == 'ChoiceType' or ty == CHOICE


def is_timer(ty):
    ''' Return true if a type is a Timer Type '''
    return find_basic_type(ty).kind == 'TimerType'


Maxime Perrotin's avatar
Maxime Perrotin committed
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
def sdl_to_asn1(sort):
    '''
        Convert case insensitive type reference to the actual type as found
        in the ASN.1 datamodel
    '''
    for asn1_type in types().viewkeys():
        if sort.replace('_', '-').lower() == asn1_type.lower():
            break
    else:
        raise TypeError('Type {} not found in ASN.1 model'.format(sort))
    return new_ref_type(asn1_type)


def node_filename(node):
    ''' Return the filename associated to the stream of this node '''
    parent = node
    while parent:
        try:
            return parent.getToken().getInputStream().fileName
        except AttributeError:
            parent = parent.getParent()
    return None


def token_stream(node):
    '''
        Return the token stream associated to a tree node
        It is set at the root of the tree by the parser
    '''
    parent = node
    while parent:
        try:
            return parent.token_stream
        except AttributeError:
            parent = parent.getParent()


def signals_in_system(ast):
    ''' Recursively find signal definitions in a nested SDL model '''
    all_signals = []
    for block in ast.blocks:
        all_signals.extend(signals_in_system(block))
    all_signals.extend(ast.signals)
    return all_signals


def find_process_declaration(ast, process_name):
    ''' Recursively search for a process declaration in a nested SDL model '''
    for block in ast.blocks:
        result = find_process_declaration(block, process_name)
        if result:
            return result
    try:
        for process in ast.processes:
            if process.processName == process_name:
                return process
    except AttributeError:
        return None
    return None


def valid_output(scope):
    '''
        Yields the output, procedures, and operators names,
        that is all the elements that can be valid in an OUTPUT symbol
        (does not mean it IS valid - caller still has to check it)
    '''
    for out_sig in scope.output_signals:
        yield out_sig['name'].lower()
    for proc in scope.procedures:
        yield proc.inputString.lower()
    for special_op in SPECIAL_OPERATORS:
        yield special_op.lower()


def get_interfaces(ast, process_name):
    '''
        Search for the list of input and output signals (async PI/RI)
        and procedures (sync RI) of a process in a given top-level AST
    '''
    all_signals = []
    async_signals = []
    system = None

    # Move up to the system level, in case process is nested in a block
    # and not defined at root level as it is the case when it is referenced
    system = ast
    while hasattr(system, 'parent'):
        system = system.parent

    # If we are at AST level, check in all systems, otherwise in current one
    iterator = ast.systems if hasattr(ast, 'systems') else (system,)

    for system in iterator:
        all_signals.extend(signals_in_system(system))
        process_ref = find_process_declaration(system, process_name)
        if process_ref:
323
324
            # Go to the block where the process is defined
            process_parent = process_ref.parent
Maxime Perrotin's avatar
Maxime Perrotin committed
325
326
327
            break
    else:
        if isinstance(ast, ogAST.Block):
328
            process_parent = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
329
330
        else:
            raise TypeError('Process ' + process_name +
331
                        ' is defined but not declared in a system')
Maxime Perrotin's avatar
Maxime Perrotin committed
332
    # Find in and out signals names using the signalroutes
333
334
    for each in process_parent.signalroutes:
        for route in each['routes']:
Maxime Perrotin's avatar
Maxime Perrotin committed
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
            if route['source'] == process_name:
                direction = 'out'
            elif route['dest'] == process_name:
                direction = 'in'
            else:
                continue
            for sig_id in route['signals']:
                # Copy the signal to the result dict
                found, = [dict(sig) for sig in all_signals
                          if sig['name'] == sig_id]
                found['direction'] = direction
                async_signals.append(found)
    return async_signals, system.procedures


def get_input_string(root):
    ''' Return the input string of a tree node '''
    return token_stream(root).toString(root.getTokenStartIndex(),
            root.getTokenStopIndex())


dbarbera's avatar
dbarbera committed
356
357
def error(root, msg):
    ''' Return an error message '''
358
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
359
360
361
362


def warning(root, msg):
    ''' Return a warning message '''
363
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
364
365


dbarbera's avatar
dbarbera committed
366
367
368
369
370
371
372
373
def tmp():
    ''' Return a temporary variable name '''
    global TMPVAR
    varname = TMPVAR
    TMPVAR += 1
    return varname


Maxime Perrotin's avatar
Maxime Perrotin committed
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
def get_state_list(process_root):
    ''' Return the list of states of a process '''
    # 1) get all STATE statements
    states = (child for child in process_root.getChildren()
            if child.type == lexer.STATE)
    # 2) keep only the ones containing a STATELIST token (i.e. no ASTERISK)
    relevant = (child for state in states for child in state.getChildren()
            if child.type == lexer.STATELIST)
    # 3) extract the state list from each of them
    state_list = [s.text.lower() for r in relevant for s in r.getChildren()]
    # state_list.append('START')
    # 4) create a set to remove duplicates
    return set(state_list)


389
def find_basic_type(a_type, pool=None):
Maxime Perrotin's avatar
Maxime Perrotin committed
390
391
    ''' Return the ASN.1 basic type of a_type '''
    basic_type = a_type or UNKNOWN_TYPE
392
    pool = pool or types()
Maxime Perrotin's avatar
Maxime Perrotin committed
393
394
    while basic_type.kind == 'ReferenceType':
        # Find type with proper case in the data view
395
        for typename in pool.viewkeys():
Maxime Perrotin's avatar
Maxime Perrotin committed
396
            if typename.lower() == basic_type.ReferencedTypeName.lower():
397
                basic_type = pool[typename].type
Maxime Perrotin's avatar
Maxime Perrotin committed
398
399
400
401
402
403
404
                break
        else:
            raise TypeError('Type "' + type_name(basic_type) +
                            '" was not found in Dataview')
    return basic_type


405
406
407
408
409
def signature(name, context):
    ''' Return the signature of a procecure/output/operator '''
    name = name.lower()
    if name in SPECIAL_OPERATORS:
        return SPECIAL_OPERATORS[name]
Maxime Perrotin's avatar
Maxime Perrotin committed
410

411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
    for out_sig in context.output_signals:
        if out_sig['name'].lower() == name:
            signature = []
            if out_sig.get('type'):
                # output signals: one single parameter
                signature.append({
                    'type': out_sig.get('type'),
                    'name': out_sig.get('param_name' or ''),
                    'direction': 'in',
                })
            return signature

    for inner_proc in context.procedures:
        proc_name = inner_proc.inputString
        if proc_name.lower() == name:
            return inner_proc.fpar

    raise AttributeError('Operator/output/procedure not found: ' + name)


431
432
433
434
def check_call(name, params, context):
    ''' Check the parameter types of a procedure/output/operator call,
        returning the type of its result '''
    LOG.debug('[check_call] ' + name + ' - ' + str(params))
435

436
    # Special case for write/writeln functions
437
    if name.lower() in ('write', 'writeln'):
438
439
440
441
442
443
        for p in params:
            p_ty = p.exprType
            if is_numeric(p_ty) or is_boolean(p_ty) or is_string(p_ty):
                continue
            raise TypeError('Type {} not supported in call to {}'.
                format(type_name(p.exprType), name))
444
        return
Maxime Perrotin's avatar
Maxime Perrotin committed
445
446
447

    # (1) Find the signature of the function
    # signature will hold the list of parameters for the function
448
    sign = signature(name, context)
Maxime Perrotin's avatar
Maxime Perrotin committed
449
450

    # (2) Check that the number of given parameters matches the signature
451
452
453
    if len(sign) != len(params):
        raise TypeError('Expected {} arguments in call to {} ({} received)'.
            format(len(sign), name, len(params)))
Maxime Perrotin's avatar
Maxime Perrotin committed
454

455
456
    # (3) Check each individual parameter type
    for idx, param in enumerate(params):
Maxime Perrotin's avatar
Maxime Perrotin committed
457
        expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
458
        expr.left = ogAST.PrimVariable()
459
        expr.left.exprType = sign[idx]['type']
Maxime Perrotin's avatar
Maxime Perrotin committed
460
        expr.right = param
461
462
463
464
465
466
467
468
469
470
471

        try:
            fix_expression_types(expr, context)
            params[idx] = expr.right
        except TypeError:
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
            raise TypeError('Expected type {} in call to {} ({} received)'.
                format(expected, name, received))

        if sign[idx].get('direction') != 'in' \
472
473
                and not isinstance(expr.right, ogAST.PrimVariable):
            raise TypeError('OUT parameter "{}" is not a variable'
474
                .format(expr.right.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
475

476
477
478
479
480
481
482
483
484
485
486
487
488
489
    # (4) Compute the type of the result
    param_btys = [find_basic_type(p.exprType) for p in params]
    if name == 'abs':
        return type('Abs', (param_btys[0],), {
            'Min': str(max(float(param_btys[0].Min), 0)),
            'Max': str(max(float(param_btys[0].Max), 0))
        })

    elif name == 'ceil':
        return type('Ceil', (REAL,), {
            'Min': str(math.ceil(float(param_btys[0].Min))),
            'Max': str(math.ceil(float(param_btys[0].Max)))
        })

dbarbera's avatar
dbarbera committed
490
491
492
493
494
495
    elif name == 'cos':
        return type('Cos', (REAL,), {
            'Min': str(-1.0),
            'Max': str(1.0)
        })

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
    elif name == 'fix':
        return type('Fix', (INTEGER,), {
            'Min': param_btys[0].Min,
            'Max': param_btys[0].Max
        })

    elif name == 'float':
        return type('Float', (REAL,), {
            'Min': param_btys[0].Min,
            'Max': param_btys[0].Max
        })

    elif name == 'floor':
        return type('Floor', (REAL,), {
            'Min': str(math.floor(float(param_btys[0].Min))),
            'Max': str(math.floor(float(param_btys[0].Max)))
        })

    elif name == 'length':
        return type('Length', (INTEGER,), {
            'Min': param_btys[0].Min,
            'Max': param_btys[0].Max
        })

    elif name == 'num':
        enum_values = [int(each.IntValue)
                       for each in param_btys[0].EnumValues.viewvalues()]

        return type('Num', (INTEGER,), {
            'Min': str(min(enum_values)),
            'Max': str(max(enum_values))
        })

    elif name == 'power':
        return type('Power', (param_btys[0],), {
            'Min': str(pow(float(param_btys[0].Min),
                           float(param_btys[1].Min))),
            'Max': str(pow(float(param_btys[0].Max),
                           float(param_btys[1].Max)))
        })

    elif name == 'present':
        return type('Present', (object,), {
            'kind': 'ChoiceEnumeratedType',
            'EnumValues': param_btys[0].Children
        })

dbarbera's avatar
dbarbera committed
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
    elif name == 'round':
        return type('Round', (REAL,), {
            'Min': str(round(float(param_btys[0].Min))),
            'Max': str(round(float(param_btys[0].Max)))
        })

    elif name == 'sin':
        return type('Sin', (REAL,), {
            'Min': str(-1.0),
            'Max': str(1.0)
        })

    elif name == 'sqrt':
        return type('Sqrt', (REAL,), {
            'Min': str(0.0),
            'Max': str(math.sqrt(float(param_btys[0].Max)))
        })

561
562
563
564
565
566
567
568
    elif name == 'trunc':
        return type('Trunc', (REAL,), {
            'Min': str(math.trunc(float(param_btys[0].Min))),
            'Max': str(math.trunc(float(param_btys[0].Max)))
        })

    return UNKNOWN_TYPE

Maxime Perrotin's avatar
Maxime Perrotin committed
569

Maxime Perrotin's avatar
Maxime Perrotin committed
570
571
572
def check_range(typeref, type_to_check):
    ''' Verify the that the Min/Max bounds of two types are compatible
        Called to test that assignments are withing allowed range
dbarbera's avatar
dbarbera committed
573
        both types assumed to be basic types
Maxime Perrotin's avatar
Maxime Perrotin committed
574
575
576
577
578
579
580
581
    '''
    try:
        if float(type_to_check.Min) < float(typeref.Min) \
                or float(type_to_check.Max) > float(typeref.Max):
            raise TypeError('Expression evaluation in range [{}..{}], '
                            'outside expected range [{}..{}]'
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
582
    except (AttributeError, ValueError):
Maxime Perrotin's avatar
Maxime Perrotin committed
583
584
585
        raise TypeError('Missing range')


586
def check_type_compatibility(primary, type_ref, context):
Maxime Perrotin's avatar
Maxime Perrotin committed
587
588
    '''
        Check if an ogAST.Primary (raw value, enumerated, ASN.1 Value...)
589
        is compatible with a given type (type_ref is an ASN1Scc type)
Maxime Perrotin's avatar
Maxime Perrotin committed
590
591
        Does not return anything if OK, otherwise raises TypeError
    '''
592
593
    assert type_ref is not None
    if type_ref is UNKNOWN_TYPE:
594
        #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
595
        raise TypeError('Type reference is unknown')
dbarbera's avatar
dbarbera committed
596

597
    basic_type = find_basic_type(type_ref)
Maxime Perrotin's avatar
Maxime Perrotin committed
598
    LOG.debug("[check_type_compatibility] "
599
              "checking if {value} is of type {typeref}"
600
              .format(value=primary.inputString, typeref=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
601
602

    if (isinstance(primary, ogAST.PrimEnumeratedValue)
603
            and basic_type.kind.endswith('EnumeratedType')):
Maxime Perrotin's avatar
Maxime Perrotin committed
604
605
606
607
        # If type ref is an enumeration, check that the value is valid
        # Note, when using the "present" operator of a CHOICE type, the
        # resulting value is actually an EnumeratedType
        enumerant = primary.inputString.replace('_', '-')
608
        corr_type = basic_type.EnumValues.get(enumerant)
Maxime Perrotin's avatar
Maxime Perrotin committed
609
610
611
        if corr_type:
            return
        else:
612
            err = ('Value "' + primary.inputString +
Maxime Perrotin's avatar
Maxime Perrotin committed
613
                   '" not in this enumeration: ' +
614
                   str(basic_type.EnumValues.keys()))
Maxime Perrotin's avatar
Maxime Perrotin committed
615
            raise TypeError(err)
616
617
618
619
620
621
    elif isinstance(primary, ogAST.PrimConditional):
        then_expr = primary.value['then']
        else_expr = primary.value['else']

        for expr in (then_expr, else_expr):
            if expr.is_raw:
622
                check_type_compatibility(expr, type_ref, context)
623
624
625
        return

    elif isinstance(primary, ogAST.PrimVariable):
Maxime Perrotin's avatar
Maxime Perrotin committed
626
        try:
627
            compare_types(primary.exprType, type_ref)
Maxime Perrotin's avatar
Maxime Perrotin committed
628
629
630
        except TypeError as err:
            raise TypeError('{expr} should be of type {ty} - {err}'
                            .format(expr=primary.inputString,
631
                                    ty=type_name(type_ref),
Maxime Perrotin's avatar
Maxime Perrotin committed
632
633
                                    err=str(err)))
        return
634

Maxime Perrotin's avatar
Maxime Perrotin committed
635
    elif isinstance(primary, ogAST.PrimInteger) \
dbarbera's avatar
dbarbera committed
636
            and (is_integer(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
637
        return
Maxime Perrotin's avatar
Maxime Perrotin committed
638

Maxime Perrotin's avatar
Maxime Perrotin committed
639
    elif isinstance(primary, ogAST.PrimReal) \
dbarbera's avatar
dbarbera committed
640
            and (is_real(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
641
        return
Maxime Perrotin's avatar
Maxime Perrotin committed
642

dbarbera's avatar
dbarbera committed
643
    elif isinstance(primary, ogAST.PrimBoolean) and is_boolean(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
644
        return
645

Maxime Perrotin's avatar
Maxime Perrotin committed
646
    elif (isinstance(primary, ogAST.PrimEmptyString) and
647
648
                                         basic_type.kind == 'SequenceOfType'):
        if int(basic_type.Min) == 0:
Maxime Perrotin's avatar
Maxime Perrotin committed
649
650
651
            return
        else:
            raise TypeError('SEQUENCE OF has a minimum size of '
652
                            + basic_type.Min + ')')
Maxime Perrotin's avatar
Maxime Perrotin committed
653
    elif isinstance(primary, ogAST.PrimSequenceOf) \
654
            and basic_type.kind == 'SequenceOfType':
655
656
        if type_ref.__name__ != 'Apnd' and \
                (len(primary.value) < int(basic_type.Min) or
657
                len(primary.value) > int(basic_type.Max)):
Maxime Perrotin's avatar
Maxime Perrotin committed
658
659
            raise TypeError(str(len(primary.value)) +
                      ' elements in SEQUENCE OF, while constraint is [' +
660
                      str(basic_type.Min) + '..' + str(basic_type.Max) + ']')
Maxime Perrotin's avatar
Maxime Perrotin committed
661
        for elem in primary.value:
662
            check_type_compatibility(elem, basic_type.type, context)
Maxime Perrotin's avatar
Maxime Perrotin committed
663
664
        return
    elif isinstance(primary, ogAST.PrimSequence) \
665
            and basic_type.kind == 'SequenceType':
Maxime Perrotin's avatar
Maxime Perrotin committed
666
        user_nb_elem = len(primary.value.keys())
667
        type_nb_elem = len(basic_type.Children.keys())
Maxime Perrotin's avatar
Maxime Perrotin committed
668
669
        if user_nb_elem != type_nb_elem:
            raise TypeError('Wrong number of fields in SEQUENCE of type {}'
670
                            .format(type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
671
        else:
672
            for field, fd_data in basic_type.Children.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
673
674
675
676
677
                ufield = field.replace('-', '_')
                if ufield not in primary.value:
                    raise TypeError('Missing field {field} in SEQUENCE'
                                    ' of type {t1} '
                                    .format(field=ufield,
678
                                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
679
680
681
682
683
684
685
686
                else:
                    # If the user field is a raw value
                    if primary.value[ufield].is_raw:
                        check_type_compatibility(primary.value[ufield],
                                                 fd_data.type, context)
                    else:
                        # Compare the types for semantic equivalence
                        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
687
                            compare_types(
dbarbera's avatar
dbarbera committed
688
                                primary.value[ufield].exprType, fd_data.type)
Maxime Perrotin's avatar
Maxime Perrotin committed
689
690
691
692
693
694
695
                        except TypeError as err:
                            raise TypeError('Field ' + ufield +
                                        ' is not of the proper type, i.e. ' +
                                        type_name(fd_data.type) +
                                        ' - ' + str(err))
        return
    elif isinstance(primary, ogAST.PrimChoiceItem) \
696
697
                              and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.Children.viewitems():
698
699
            if choicekey.lower().replace('-', '_') == \
                    primary.value['choice'].lower().replace('-', '_'):
Maxime Perrotin's avatar
Maxime Perrotin committed
700
701
702
703
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.value['choice'],
704
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
705
        # compare primary.value['value']
706
        # with basic_type['Children'][primary.choiceItem['choice']]
Maxime Perrotin's avatar
Maxime Perrotin committed
707
708
709
710
711
712
713
714
715
716
        value = primary.value['value']
        choice_field_type = choice.type
        # if the user field is a raw value:
        if value.is_raw:
            check_type_compatibility(value, choice_field_type, context)
        # Compare the types for semantic equivalence:
        else:
            try:
                compare_types(value.exprType, choice_field_type)
            except TypeError as err:
Maxime Perrotin's avatar
Maxime Perrotin committed
717
718
                raise TypeError(
                            'Field {field} in CHOICE is not of type {t1} - {e}'
Maxime Perrotin's avatar
Maxime Perrotin committed
719
720
721
722
723
724
                            .format(field=primary.value['choice'],
                                    t1=type_name(choice_field_type),
                                    e=str(err)))
        value.exprType = choice_field_type         # XXX
        return
    elif isinstance(primary, ogAST.PrimChoiceDeterminant) \
725
726
                and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.EnumValues.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
727
            if choicekey.replace('-', '_').lower() == \
dbarbera's avatar
dbarbera committed
728
                    primary.inputString.lower():
Maxime Perrotin's avatar
Maxime Perrotin committed
729
730
731
732
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.inputString,
733
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
734
735
736

    elif isinstance(primary, ogAST.PrimStringLiteral):
        # Octet strings
737
        basic_type = find_basic_type(type_ref)
738
        if basic_type.kind == 'StandardStringType':
Maxime Perrotin's avatar
Maxime Perrotin committed
739
            return
740
741
        elif basic_type.kind.endswith('StringType'):
            if int(basic_type.Min) <= len(
dbarbera's avatar
dbarbera committed
742
                    primary.value[1:-1]) <= int(basic_type.Max):
743
744
745
746
                return
            else:
                raise TypeError('Invalid string literal - check that length is'
                                'within the bound limits {Min}..{Max}'.format
Maxime Perrotin's avatar
Maxime Perrotin committed
747
                            (Min=str(basic_type.Min), Max=str(basic_type.Max)))
748
749
        else:
            raise TypeError('String literal not expected')
Maxime Perrotin's avatar
Maxime Perrotin committed
750
    elif (isinstance(primary, ogAST.PrimMantissaBaseExp) and
751
                                            basic_type.kind == 'RealType'):
Maxime Perrotin's avatar
Maxime Perrotin committed
752
753
754
755
756
757
        LOG.debug('PROBABLY (it is a float but I did not check'
                  'if values are compatible)')
        return
    else:
        raise TypeError('{prim} does not match type {t1}'
                        .format(prim=primary.inputString,
758
                                t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
759

Maxime Perrotin's avatar
Maxime Perrotin committed
760

Maxime Perrotin's avatar
Maxime Perrotin committed
761
762
763
764
765
766
def compare_types(type_a, type_b):
    '''
       Compare two types, return if they are semantically equivalent,
       otherwise raise TypeError
    '''
    LOG.debug('[compare_types]' + str(type_a) + ' and ' + str(type_b) + ': ')
767

Maxime Perrotin's avatar
Maxime Perrotin committed
768
769
    type_a = find_basic_type(type_a)
    type_b = find_basic_type(type_b)
770

Maxime Perrotin's avatar
Maxime Perrotin committed
771
772
    if type_a == type_b:
        return
773
774
775
776
777
778
779
780
781
782
    elif NUMERICAL in (type_a, type_b) and is_numeric(type_a) \
            and is_numeric(type_b):
        return
    elif LIST in (type_a, type_b) and is_list(type_a) and is_list(type_b):
        return
    elif ENUMERATED in (type_a, type_b) and is_enumerated(type_a) \
            and is_enumerated(type_b):
        return
    elif CHOICE in (type_a, type_b) and is_choice(type_a) and is_choice(type_b):
        return
783

Maxime Perrotin's avatar
Maxime Perrotin committed
784
    # Check if both types have basic compatibility
785
786

    if type_a.kind == type_b.kind:
Maxime Perrotin's avatar
Maxime Perrotin committed
787
        if type_a.kind == 'SequenceOfType':
788
789
790
791
792
793
794
795
796
            if type_a.Min == type_a.Max:
                if type_a.Min == type_b.Min == type_b.Max:
                    compare_types(type_a.type, type_b.type)
                    return
                else:
                    raise TypeError('Incompatible sizes - size of {} can vary'
                                    .format(type_name(type_b)))
            elif(int(type_b.Min) >= int(type_a.Min)
                 and int(type_b.Max) <= int(type_a.Max)):
Maxime Perrotin's avatar
Maxime Perrotin committed
797
798
799
                compare_types(type_a.type, type_b.type)
                return
            else:
800
801
                compare_types(type_a.type, type_b.type)
                raise Warning('Size constraints mismatch - risk of overflow')
802
        # TODO: Check that OctetString types have compatible range
Maxime Perrotin's avatar
Maxime Perrotin committed
803
        return
804
    elif is_string(type_a) and is_string(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
805
        return
806
    elif is_integer(type_a) and is_integer(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
807
        return
808
809
    elif is_real(type_a) and is_real(type_b):
        return
810
811
812
813
814
    else:
        raise TypeError('Incompatible types {} and {}'.format(
            type_name(type_a),
            type_name(type_b)
        ))
Maxime Perrotin's avatar
Maxime Perrotin committed
815
816


dbarbera's avatar
dbarbera committed
817
def find_variable_type(var, context):
Maxime Perrotin's avatar
Maxime Perrotin committed
818
819
    ''' Look for a variable name in the context and return its type '''
    LOG.debug('[find_variable] checking if ' + str(var) + ' is defined')
dbarbera's avatar
dbarbera committed
820

Maxime Perrotin's avatar
Maxime Perrotin committed
821
    # all DCL-variables
Maxime Perrotin's avatar
Maxime Perrotin committed
822
823
    all_visible_variables = dict(context.global_variables)
    all_visible_variables.update(context.variables)
dbarbera's avatar
dbarbera committed
824

Maxime Perrotin's avatar
Maxime Perrotin committed
825
826
827
828
829
830
831
832
    # First check locally, i.e. in FPAR
    try:
        for variable in context.fpar:
            if variable['name'].lower() == var.lower():
                return variable['type']
    except AttributeError:
        # No FPAR section
        pass
833

Maxime Perrotin's avatar
Maxime Perrotin committed
834
835
836
    for varname, (vartype, _) in all_visible_variables.viewitems():
        # Case insensitive comparison with variables
        if var.lower() == varname.lower():
837
838
            return vartype

Maxime Perrotin's avatar
Maxime Perrotin committed
839
    for timer in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
840
        if var.lower() == timer.lower():
841
            return TIMER
Maxime Perrotin's avatar
Maxime Perrotin committed
842

dbarbera's avatar
dbarbera committed
843
844
845
846
847
    # check if is a ASN.1 constant
    for varname, vartype in DV.variables.viewitems():
        if var.lower() == varname.lower().replace('-', '_'):
            return vartype.type

Maxime Perrotin's avatar
Maxime Perrotin committed
848
849
850
851
    LOG.debug('[find_variable] result: not found, raising exception')
    raise AttributeError('Variable {var} not defined'.format(var=var))


852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
def fix_enumerated_and_choice(expr_enum, context):
    ''' If left side of the expression is of Enumerated or Choice type,
        check if right side is a literal of that sort, and update type '''
    kind = find_basic_type(expr_enum.left.exprType).kind
    if kind == 'EnumeratedType':
        prim = ogAST.PrimEnumeratedValue(primary=expr_enum.right)
    elif kind == 'ChoiceEnumeratedType':
        prim = ogAST.PrimChoiceDeterminant(primary=expr_enum.right)
    try:
        check_type_compatibility(prim, expr_enum.left.exprType, context)
        expr_enum.right = prim
        expr_enum.right.exprType = expr_enum.left.exprType
    except (UnboundLocalError, AttributeError, TypeError):
        pass
    else:
        LOG.debug('Fixed enumerated/choice: {}'.format(expr_enum.inputString))


870
def fix_expression_types(expr, context):
dbarbera's avatar
dbarbera committed
871
    ''' Check/ensure type consistency in binary expressions '''
872
873
874
875
876
    for _ in range(2):
        # Check if an raw enumerated value is of a reference type
        fix_enumerated_and_choice(expr, context)
        expr.right, expr.left = expr.left, expr.right

877
878
879
880
881
882
883
    for side in (expr.right, expr.left):
        if side.is_raw:
            raw_expr = side
        else:
            typed_expr = side
            ref_type = typed_expr.exprType

884
    # If a side is a raw Sequence Of with unknown type, try to resolve it
885
886
    for side_a, side_b in permutations(('left', 'right')):
        value = getattr(expr, side_a)  # get expr.left then expr.right
887
888
        if not isinstance(value, ogAST.PrimSequenceOf):
            continue
889
        other = getattr(expr, side_b)  # other side
890
891
892
893
894
895
896
        basic = find_basic_type(value.exprType)
        if basic.kind == 'SequenceOfType' and basic.type == UNKNOWN_TYPE:
            asn_type = find_basic_type(other.exprType)
            if asn_type.kind == 'SequenceOfType':
                asn_type = asn_type.type
                for idx, elem in enumerate(value.value):
                    check_expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
897
                    check_expr.left = ogAST.PrimVariable()
898
899
900
901
902
903
904
                    check_expr.left.exprType = asn_type
                    check_expr.right = elem
                    fix_expression_types(check_expr, context)
                    value.value[idx] = check_expr.right
            # the type of the raw PrimSequenceOf can be set now
            value.exprType.type = asn_type

905
906
907
    if isinstance(expr, ogAST.ExprIn):
        return

908
    if not expr.right.is_raw and not expr.left.is_raw:
909
910
911
        unknown = [uk_expr for uk_expr in expr.right, expr.left
                   if uk_expr.exprType == UNKNOWN_TYPE]
        if unknown:
912
            #print traceback.print_stack()
913
914
915
            raise TypeError('Cannot resolve type of "{}"'
                            .format(unknown[0].inputString))

916
    # In Sequence, Choice and SEQUENCE OF expressions,
917
918
919
920
921
922
923
924
925
926
927
    # we must fix missing inner types
    # (due to similarities, the following should be refactored FIXME)
    if isinstance(expr.right, ogAST.PrimSequence):
        # left side must have a known type
        asn_type = find_basic_type(expr.left.exprType)
        if asn_type.kind != 'SequenceType':
            raise TypeError('left side must be a SEQUENCE type')
        for field, fd_expr in expr.right.value.viewitems():
            if fd_expr.exprType == UNKNOWN_TYPE:
                try:
                    expected_type = asn_type.Children.get(
dbarbera's avatar
dbarbera committed
928
                            field.replace('_', '-')).type
929
930
931
                except AttributeError:
                    raise TypeError('Field not found: ' + field)
                check_expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
932
                check_expr.left = ogAST.PrimVariable()
933
934
935
936
937
938
939
940
941
942
943
                check_expr.left.exprType = expected_type
                check_expr.right = fd_expr
                fix_expression_types(check_expr, context)
                # Id of fd_expr may have changed (enumerated, choice)
                expr.right.value[field] = check_expr.right
    elif isinstance(expr.right, ogAST.PrimChoiceItem):
        asn_type = find_basic_type(expr.left.exprType)
        field = expr.right.value['choice'].replace('_', '-')
        if asn_type.kind != 'ChoiceType' \
                or field.lower() not in [key.lower()
                                  for key in asn_type.Children.viewkeys()]:
944
            raise TypeError('Field is not valid in CHOICE:' + field)
945
946
947
948
949
950
951
952
        key, = [key for key in asn_type.Children.viewkeys()
                if key.lower() == field.lower()]
        if expr.right.value['value'].exprType == UNKNOWN_TYPE:
            try:
                expected_type = asn_type.Children.get(key).type
            except AttributeError:
                raise TypeError('Field not found in CHOICE: ' + field)
            check_expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
953
            check_expr.left = ogAST.PrimVariable()
954
955
956
957
            check_expr.left.exprType = expected_type
            check_expr.right = expr.right.value['value']
            fix_expression_types(check_expr, context)
            expr.right.value['value'] = check_expr.right
958
959
960
961
962
963
964
965
966
    elif isinstance(expr.right, ogAST.PrimConditional):
        for det in ('then', 'else'):
            # Recursively fix possibly missing types in the expression
            check_expr = ogAST.ExprAssign()
            check_expr.left = ogAST.PrimVariable()
            check_expr.left.exprType = expr.left.exprType
            check_expr.right = expr.right.value[det]
            fix_expression_types(check_expr, context)
            expr.right.value[det] = check_expr.right
967
968
969

    if expr.right.is_raw != expr.left.is_raw:
        check_type_compatibility(raw_expr, ref_type, context)
970
971
972
973
        if not raw_expr.exprType.kind.startswith(('Integer',
                                                  'Real',
                                                  'SequenceOf',
                                                  'String')):
Maxime Perrotin's avatar
Maxime Perrotin committed
974
975
            # Raw int/real must keep their type because of the range
            # that can be computed
976
977
            # Also true for raw SEQOF and String - Min/Max must not change
            # Substrings: CHECKME XXX
Maxime Perrotin's avatar
Maxime Perrotin committed
978
            raw_expr.exprType = ref_type
979
980
981
    else:
        compare_types(expr.left.exprType, expr.right.exprType)

Maxime Perrotin's avatar
Maxime Perrotin committed
982

Maxime Perrotin's avatar
Maxime Perrotin committed
983
984
985
986
987
988
989
990
991
992
993
994
def expression_list(root, context):
    ''' Parse a list of expression parameters '''
    errors = []
    warnings = []
    result = []
    for param in root.getChildren():
        exp, err, warn = expression(param, context)
        errors.extend(err)
        warnings.extend(warn)
        result.append(exp)
    return result, errors, warnings

Maxime Perrotin's avatar
Maxime Perrotin committed
995

dbarbera's avatar
dbarbera committed
996
997
def primary_variable(root, context):
    ''' Primary Variable analysis '''
998
    name = getattr(root.getChild(0), 'text', 'error')
dbarbera's avatar
dbarbera committed
999
    errors, warnings = [], []
dbarbera's avatar
dbarbera committed
1000

For faster browsing, not all history is shown. View entire blame