cppcheck/addons/misra.py

348 lines
9.6 KiB
Python
Raw Normal View History

2017-04-08 16:08:54 +02:00
#/usr/bin/python
#
2017-04-11 14:45:38 +02:00
# MISRA C 2012 checkers
2017-04-08 16:08:54 +02:00
#
# Example usage of this addon (scan a sourcefile main.cpp)
# cppcheck --dump main.cpp
# python misra.py main.cpp.dump
#
# Limitations: This addon is released as open source. Rule texts can't be freely
# distributed. https://www.misra.org.uk/forum/viewtopic.php?f=56&t=1189
#
#
2017-04-08 16:08:54 +02:00
import cppcheckdata
import sys
import re
2017-04-11 22:21:54 +02:00
def reportError(token, num1, num2):
2017-04-08 16:08:54 +02:00
sys.stderr.write(
2017-04-11 22:21:54 +02:00
'[' + token.file + ':' + str(token.linenr) + '] misra ' + str(num1) + '.' + str(num2) + ' violation\n')
2017-04-08 16:08:54 +02:00
2017-04-13 11:05:04 +02:00
# Platform
# TODO get this from dump
CHAR_BITS = 8
SHORT_BITS = 16
INT_BITS = 32
2017-04-13 10:04:50 +02:00
def getEssentialType(expr):
if not expr:
return None
if expr.variable:
typeToken = expr.variable.typeStartToken
while typeToken and typeToken.isName:
if typeToken.str in ['char', 'short', 'int', 'long', 'float', 'double']:
return typeToken.str
typeToken = typeToken.next
return None
def bitsOfEssentialType(expr):
type = getEssentialType(expr)
if type is None:
return 0
# TODO get --platform type sizes
2017-04-13 11:05:04 +02:00
if type == 'char':
return CHAR_BITS
if type == 'short':
return SHORT_BITS
if type == 'int':
return INT_BITS
2017-04-13 10:04:50 +02:00
return 0
2017-04-13 19:38:25 +02:00
def isFunctionCall(expr):
if not expr:
return False
if expr.str != '(' or not expr.astOperand1:
return False
if expr.astOperand1 != expr.previous:
return False
if expr.astOperand1.str in ['sizeof', 'if', 'switch', 'while']:
return False
return True
def countSideEffects(expr):
if not expr or expr.str in [',', ';']:
return 0
ret = 0
if expr.str in ['++', '--', '=']:
ret = 1
elif isFunctionCall(expr):
ret = 1
return ret + countSideEffects(expr.astOperand1) + countSideEffects(expr.astOperand2)
2017-04-13 22:05:27 +02:00
def hasFloatComparison(expr):
if not expr:
return False
if expr.isLogicalOp:
return hasFloatComparison(expr.astOperand1) or hasFloatComparison(expr.astOperand2)
if expr.isComparisonOp:
# TODO: Use ValueType
return cppcheckdata.astIsFloat(expr.astOperand1) or cppcheckdata.astIsFloat(expr.astOperand2)
return False
2017-04-13 19:11:48 +02:00
def hasSideEffectsRecursive(expr):
2017-04-08 16:08:54 +02:00
if not expr:
return False
2017-04-08 19:00:50 +02:00
if expr.str in ['++', '--', '=']:
2017-04-08 16:08:54 +02:00
return True
# Todo: Check function calls
2017-04-13 19:11:48 +02:00
return hasSideEffectsRecursive(expr.astOperand1) or hasSideEffectsRecursive(expr.astOperand2)
2017-04-08 16:08:54 +02:00
2017-04-11 14:45:38 +02:00
def isBoolExpression(expr):
return expr and expr.str in ['!', '==', '!=', '<', '<=', '>', '>=', '&&', '||']
2017-04-13 11:05:04 +02:00
def isConstantExpression(expr):
if expr.isNumber:
return True
if expr.isName:
return False
if expr.astOperand1 and not isConstantExpression(expr.astOperand1):
return False
if expr.astOperand2 and not isConstantExpression(expr.astOperand2):
return False
return True
def isUnsignedInt(expr):
# TODO this function is very incomplete. use ValueType?
if not expr:
return False
if expr.isNumber:
return expr.str.find('u')>0 or expr.str.find('U')>0
if expr.str in ['+','-','*','/','%']:
return isUnsignedInt(expr.astOperand1) or isUnsignedInt(expr.astOperand2)
return False
2017-04-11 22:21:54 +02:00
def getPrecedence(expr):
if not expr:
return 16
if not expr.astOperand1 or not expr.astOperand2:
return 16
if expr.str in ['*', '/', '%']:
return 12
if expr.str in ['+', '-']:
return 11
if expr.str in ['<<', '>>']:
return 10
if expr.str in ['<', '>', '<=', '>=']:
return 9
if expr.str in ['==', '!=']:
return 8
if expr.str == '&':
return 7
if expr.str == '^':
return 6
if expr.str == '|':
return 5
if expr.str == '&&':
return 4
if expr.str == '||':
return 3
if expr.str in ['?',':']:
return 2
if expr.isAssignmentOp:
return 1
if expr.str == ',':
return 0
return -1
def noParentheses(tok1, tok2):
while tok1 and tok1 != tok2:
if tok1.str == '(' or tok1.str == ')':
return False
tok1 = tok1.next
return tok1 == tok2
2017-04-11 14:45:38 +02:00
def misra_5_1(data):
2017-04-08 16:08:54 +02:00
for token in data.tokenlist:
if token.isName and len(token.str) > 31:
2017-04-11 22:21:54 +02:00
reportError(token, 5, 1)
2017-04-08 16:08:54 +02:00
2017-04-11 14:45:38 +02:00
def misra_7_1(rawTokens):
2017-04-09 10:11:54 +02:00
for tok in rawTokens:
2017-04-11 14:45:38 +02:00
if re.match(r'^0[0-7]+$', tok.str):
2017-04-11 22:21:54 +02:00
reportError(tok, 7, 1)
2017-04-08 16:08:54 +02:00
def misra_7_3(rawTokens):
for tok in rawTokens:
2017-04-12 19:07:10 +02:00
if re.match(r'^[0-9]+l', tok.str):
2017-04-11 22:21:54 +02:00
reportError(tok, 7, 3)
2017-04-12 16:19:13 +02:00
def misra_12_1_sizeof(rawTokens):
state = 0
for tok in rawTokens:
if tok.str.startswith('//') or tok.str.startswith('/*'):
continue
if tok.str == 'sizeof':
state = 1
elif state == 1:
if re.match(r'^[a-zA-Z_]',tok.str):
state = 2
else:
state = 0
elif state == 2:
if tok.str in ['+','-','*','/','%']:
reportError(tok, 12, 1)
else:
state = 0
2017-04-11 22:21:54 +02:00
def misra_12_1(data):
for token in data.tokenlist:
p = getPrecedence(token)
if p < 2 or p > 12:
continue
p1 = getPrecedence(token.astOperand1)
if p1 <= 12 and p1 > p and noParentheses(token.astOperand1,token):
reportError(token, 12, 1)
continue
p2 = getPrecedence(token.astOperand2)
if p2 <= 12 and p2 > p and noParentheses(token, token.astOperand2):
reportError(token, 12, 1)
continue
2017-04-13 10:04:50 +02:00
def misra_12_2(data):
for token in data.tokenlist:
if not (token.str in ['<<','>>']):
continue
if (not token.astOperand2) or (not token.astOperand2.values):
continue
maxval = 0
for val in token.astOperand2.values:
if val.intvalue > maxval:
maxval = val.intvalue
if maxval == 0:
continue
sz = bitsOfEssentialType(token.astOperand1)
if sz <= 0:
continue
if maxval >= sz:
reportError(token, 12, 2)
2017-04-12 20:18:54 +02:00
def misra_12_3(data):
for token in data.tokenlist:
if token.str != ',':
continue
if token.astParent and (token.astParent.str in ['(', ',', '{']):
2017-04-12 21:45:39 +02:00
continue
2017-04-12 20:18:54 +02:00
reportError(token, 12, 3)
2017-04-13 11:05:04 +02:00
def misra_12_4(data):
max_uint = 0
if INT_BITS == 16:
max_uint = 0xffff
elif INT_BITS == 32:
max_uint = 0xffffffff
else:
return
for token in data.tokenlist:
if (not isConstantExpression(token)) or (not isUnsignedInt(token)):
continue
if not token.values:
continue
for value in token.values:
if value.intvalue < 0 or value.intvalue > max_uint:
reportError(token, 12, 4)
break
2017-04-13 19:11:48 +02:00
def misra_13_1(data):
for token in data.tokenlist:
if token.str != '=':
continue
init = token.next
if init and init.str == '{' and hasSideEffectsRecursive(init):
reportError(init,13,1)
2017-04-13 19:38:25 +02:00
def misra_13_3(data):
for token in data.tokenlist:
if not token.astOperand1:
continue
if token.astParent and token.astParent.str != ',':
continue
if token.str == ',':
continue
if countSideEffects(token) >= 2:
reportError(token, 13, 3)
2017-04-13 19:43:06 +02:00
def misra_13_4(data):
for token in data.tokenlist:
if token.str != '=':
continue
if not token.astParent:
continue
if not (token.astParent.str in [',', ';']):
reportError(token, 13, 4)
2017-04-11 14:45:38 +02:00
def misra_13_5(data):
2017-04-08 16:08:54 +02:00
for token in data.tokenlist:
2017-04-13 19:11:48 +02:00
if token.isLogicalOp and hasSideEffectsRecursive(token.astOperand2):
2017-04-11 22:21:54 +02:00
reportError(token, 13, 5)
2017-04-08 16:08:54 +02:00
2017-04-13 21:40:59 +02:00
def misra_13_6(data):
for token in data.tokenlist:
if token.str == 'sizeof' and hasSideEffectsRecursive(token.next):
reportError(token, 13, 6)
2017-04-13 22:05:27 +02:00
def misra_14_1(data):
for token in data.tokenlist:
if token.str != 'for':
continue
lpar = token.next
if not lpar or lpar.str != '(':
continue
if not lpar.astOperand2 or lpar.astOperand2.str != ';':
continue
if not lpar.astOperand2.astOperand2 or lpar.astOperand2.astOperand2.str != ';':
continue
expr1 = lpar.astOperand2.astOperand1
expr2 = lpar.astOperand2.astOperand2.astOperand1
expr3 = lpar.astOperand2.astOperand2.astOperand2
if hasFloatComparison(expr2):
reportError(token, 14, 1)
2017-04-11 14:45:38 +02:00
def misra_14_4(data):
2017-04-08 16:08:54 +02:00
for token in data.tokenlist:
2017-04-11 14:45:38 +02:00
if token.str != '(':
2017-04-08 19:00:50 +02:00
continue
2017-04-11 14:45:38 +02:00
if not token.astOperand1 or not (token.astOperand1.str in ['if', 'while']):
continue
if not isBoolExpression(token.astOperand2):
2017-04-11 22:21:54 +02:00
reportError(token, 14, 4)
2017-04-08 16:08:54 +02:00
2017-04-11 14:45:38 +02:00
def misra_15_1(data):
2017-04-08 16:08:54 +02:00
for token in data.tokenlist:
2017-04-08 19:00:50 +02:00
if token.str == "goto":
2017-04-11 22:21:54 +02:00
reportError(token, 15, 1)
2017-04-08 16:08:54 +02:00
for arg in sys.argv[1:]:
print('Checking ' + arg + '...')
data = cppcheckdata.parsedump(arg)
2017-04-09 10:11:54 +02:00
cfgNumber = 0
2017-04-08 16:08:54 +02:00
for cfg in data.configurations:
2017-04-09 10:11:54 +02:00
cfgNumber = cfgNumber + 1
2017-04-08 16:08:54 +02:00
if len(data.configurations) > 1:
print('Checking ' + arg + ', config "' + cfg.name + '"...')
2017-04-11 14:45:38 +02:00
misra_5_1(cfg)
if cfgNumber == 1:
misra_7_1(data.rawTokens)
misra_7_3(data.rawTokens)
2017-04-12 16:19:13 +02:00
misra_12_1_sizeof(data.rawTokens)
2017-04-11 22:21:54 +02:00
misra_12_1(cfg)
2017-04-13 10:04:50 +02:00
misra_12_2(cfg)
2017-04-12 20:18:54 +02:00
misra_12_3(cfg)
2017-04-13 11:05:04 +02:00
misra_12_4(cfg)
2017-04-13 19:11:48 +02:00
misra_13_1(cfg)
2017-04-13 19:38:25 +02:00
misra_13_3(cfg)
2017-04-13 19:43:06 +02:00
misra_13_4(cfg)
2017-04-11 14:45:38 +02:00
misra_13_5(cfg)
2017-04-13 21:40:59 +02:00
misra_13_6(cfg)
2017-04-13 22:05:27 +02:00
misra_14_1(cfg)
2017-04-11 14:45:38 +02:00
misra_14_4(cfg)
misra_15_1(cfg)