def find_function_body(inputFile="Do_Not_Know", functionName="some_function"):
#filename="/home/parallels/Downloads/ctags-5.8/readtags.c"
cmd = "ctags -x --c-kinds=f " + inputFile + " | grep \'^" + functionName + " \' | awk '{ print $3 }'"
print 'INSTRU-DEBUG:: cmd = ', cmd
function_line = subprocess.check_output(cmd, shell=True)
print 'INSTRU-DEBUG:: function definationLine = ' + function_line + ' for function = ' + functionName
#Searching for openning brace
try:
cmd = "awk -v s=" + chomp(
function_line
) + " 'NR>=s && /{/ {c++} NR>=s && /{/ && c && !--c {print NR; exit}' " + inputFile
beginning_line = subprocess.check_output(cmd, shell=True)
except:
#THIS IS A HACK AND WILL FIX WHEN WE ADD FUNCTIONALITY FOR C++ FUNCTION OVER LOADING
#Write an entry in a result log that this function was not fully processed
function_lines = function_line.split('\n')
cmd = "awk -v s=" + chomp(
function_line[0]
) + " 'NR>=s && /{/ {c++} NR>=s && /{/ && c && !--c {print NR; exit}' " + inputFile
beginning_line = subprocess.check_output(cmd, shell=True)
print 'INSTRU-DEBUG:: function body beginningLine = ' + beginning_line + ' for function = ' + functionName
#Searching for closing brace
cmd = "awk -v s=" + chomp(
beginning_line
) + " 'NR>=s && /{/ {c++} NR>=s && /}/ && c && !--c {print NR; exit}' " + inputFile
ending_line = subprocess.check_output(cmd, shell=True)
print 'INSTRU-DEBUG:: function endingLine = ', ending_line
return (beginning_line, ending_line)
def deep_file_instrument(fileName="Do_Not_Know", startLine=0, endLine='EOF'):
lineNumber = 0
line_offset = []
readinFile, resultFile = create_outputfile(fileName)
print resultFile
# First pass only if we don't know the end point for processing this instrumentation
if endLine == 'EOF':
# To collect a start point of first function
cmd = "ctags -x --c-kinds=f " + fileName + " | awk '{ print $3 }'"
lineNumberList = subprocess.check_output(cmd, shell=True).split('\n')
startLine = min(lineNumberList)
if startLine == '':
lineNumberList.remove(startLine)
startLine = min(lineNumberList)
with open(fileName, 'r') as inputFile:
#To process EOF we have to read the file once any way so building a
#line_offset data structure out of entire file
offset = 0
for line in inputFile:
line_offset.append(offset)
offset += len(line)
inputFile.seek(0)
endLine = line_offset[-1]
with open(readinFile, 'r') as inputFile, open(resultFile,
'a+') as outputFile:
for line in inputFile:
content = line
lineNumber += 1
#print ("line = {}, lineNumber = {}, startLine = {} and endLine = {}".format(line, lineNumber, startLine, endLine))
if int(lineNumber) > int(startLine) and int(lineNumber) <= int(
endLine):
#print ("came in instrumentation block");
if content.isspace() != True and chomp(content)[-1] == ';':
#print ("last character in line = {}".format(line[-1]))
outputFile.write(
'printf("INSTRUMENTATION_TOOL::In file %s: in function %s, at line number %d \\n", __FILE__, __func__, __LINE__);\n'
)
outputFile.write(content)
else:
#print (content)
outputFile.write(content)
else:
#print (content)
outputFile.write(content)
post_instrumentation_fileops(fileName, readinFile, resultFile)
return
def real_function_instrument(fileName="Do_Not_Know",startLine=0, endLine='EOF'):
lineNumber = 0
line_offset = []
resultFile = create_outputfile(fileName)
print resultFile
# First pass only if we don't know the end point for processing this instrumentation
#inputFile = fileName
if endLine == 'EOF':
#To process EOF we have to read the file once any way so building a
#line_offset data structure out of entire file
offset = 0
for line in inputFile:
line_offset.append(offset)
offset += len(line)
inputFile.seek(0)
endLine = line_offset[-1]
with open(fileName,'r') as inputFile, open(resultFile, 'a+') as outputFile:
for line in inputFile:
content = line
lineNumber += 1
#print ("line = {}, lineNumber = {}, startLine = {} and endLine = {}".format(line, lineNumber, startLine, endLine))
if int(lineNumber) > int(startLine) and int(lineNumber) <= int(endLine):
#print ("came in instrumentation block");
if content.isspace() != True and chomp(content)[-1] == ';' :
#print ("last character in line = {}".format(line[-1]))
outputFile.write('printf("INSTRUMENTATION_TOOL::In file %s: in function %s, at line number %d \\n", __FILE__, __func__, __LINE__);\n')
outputFile.write(content);
else:
#print (content)
outputFile.write(content);
else:
#print (content)
outputFile.write(content);
return
def shallow_file_instrument(fileName="Do_Not_Know",
startLine=0,
endLine='EOF'):
#get all the function names and line numbers for a given file
#ctags -x --c-kinds=f readtags.c
cmd = "ctags -x --c-kinds=f " + fileName + " | awk '{ print $1 }'"
functionNameList = subprocess.check_output(cmd, shell=True).split('\n')
cmd = "ctags -x --c-kinds=f " + fileName + " | awk '{ print $3 }'"
lineNumberList = subprocess.check_output(cmd, shell=True).split('\n')
lineNumberList.remove('')
lineNumberList = map(int, lineNumberList)
#print 'INSTRU-DEBUG:: functionNameList = {} and lineNumberList = {} '.format(functionNameList, lineNumberList)
if not functionNameList or not lineNumberList:
#Write an entry in a result log that this file was not processed
return
#This is for output file
readinFile, resultFile = create_outputfile(fileName)
print resultFile
lineNumber = 0
sorted_function_list = sorted(zip(lineNumberList, functionNameList))
element = 0
current_item = sorted_function_list[element]
#print current_item
#print sorted_function_list
if current_item[0] == '':
element += 1
current_item = sorted_function_list[element]
startLine, endLine = find_function_body(fileName, current_item[1])
while chomp(startLine) == '' or chomp(endLine) == '':
print 'came in endline is empty block'
if len(sorted_function_list) > (element + 1):
#Add entry in a file showing this file has issue
element += 1
current_item = sorted_function_list[element]
startLine, endLine = find_function_body(fileName, current_item[1])
else:
#Add entry in a file showing this file has issue
return
enter_instrument = int(startLine) + 1
exit_instrument = int(endLine)
#if (int(startLine) + 2) < (int(endLine) -1) :
# exit_instrument = int(endLine) - 1
#else:
# exit_instrument = int(endLine)
print 'INSTRU-DEBUG:: function {}, startLine = {}, endLine = {}, enter_instrument = {} and exit_instrument = {}'.format(
current_item[1], startLine[:-1], endLine[:-1], enter_instrument,
exit_instrument)
inputFile = fileName
with open(readinFile, 'r') as input, open(resultFile, 'a+') as outputFile:
input.seek(0)
for line in input:
#print 'INSTRU-DEBUG:: function {}, startLine = {}, endLine = {}, enter_instrument = {} and exit_instrument = {}'.format(current_item[1], startLine[:-1], endLine[:-1], enter_instrument, exit_instrument)
content = line
lineNumber += 1
#print ("line = {}, lineNumber = {} and endLine = {}".format(line, lineNumber, endLine))
if lineNumber == enter_instrument:
outputFile.write(
'printf("INSTRUMENTATION_TOOL::Entered into file %s: in function %s, at line number %d \\n", __FILE__, __func__, __LINE__);\n'
)
outputFile.write(content)
elif lineNumber == exit_instrument:
#print (content)
# A case where a line above } is return statement
if content.isspace() == False and (
content.split()[0] == 'return'
or content.split()[0] == 'return;'):
outputFile.write(
'printf("INSTRUMENTATION_TOOL::Exiting function %s, at line number %d from file %s \\n", __func__, __LINE__, __FILE__);\n'
)
outputFile.write(content)
else: # A case where a line above } is not a return statement
outputFile.write(
'printf("INSTRUMENTATION_TOOL::Exiting function %s, at line number %d from file %s \\n", __func__, __LINE__, __FILE__);\n'
)
outputFile.write(content)
if element < len(sorted_function_list) - 1:
element += 1
current_item = sorted_function_list[element]
#print 'INSTRU-DEBUG:: functionName = ', current_item[1]
startLine, endLine = find_function_body(
fileName, current_item[1])
while chomp(startLine) == '' or chomp(
endLine) == '' or not isinstance(
endLine, (int, long)):
if len(sorted_function_list) > (element + 1):
#Add entry in a file showing this file has issue
element += 1
current_item = sorted_function_list[element]
startLine, endLine = find_function_body(
fileName, current_item[1])
else:
#Add entry in a file showing this file has issue
return
#if chomp(startLine) == '' or chomp(endLine) == '' or not isinstance(endLine, (int, long)):
# continue;
#else:
enter_instrument = int(startLine) + 1
exit_instrument = int(endLine)
else:
if content.isspace() == False and (
content.split()[0] == 'return'
or content.split()[0] == 'return;'):
outputFile.write(
'printf("INSTRUMENTATION_TOOL::Exiting function %s, at line number %d from file %s \\n", __func__, __LINE__, __FILE__);\n'
)
outputFile.write(content)
else:
#print (content)
outputFile.write(content)
print 'INSTRU-DEBUG:: filename = {}, readinFile = {}, resultFile = {}'.format(
fileName, readinFile, resultFile)
post_instrumentation_fileops(fileName, readinFile, resultFile)
return