Jmaa/infernal-interpreter
1
0
Fork 0
Code Actions Packages

Ruff format

Browse Source
This commit is contained in:
Jon Michael Aanes 2024-07-10 01:15:47 +02:00
parent 51364faba5
commit ab5f4e623b
Signed by: Jmaa
SSH Key Fingerprint: SHA256:Ab0GfHGCblESJx7JRE4fj4bFy/KRpeLhi41y4pF3sNA
8 changed files with 455 additions and 251 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
infernal_interpreter/AsciiPainter.py
View File

@ -1,19 +1,18 @@
import subprocess import subprocess
NORMAL_COLOR = '\033[0m' NORMAL_COLOR = '\033[0m'
REG_STATUS_TO_COLOR = { REG_STATUS_TO_COLOR = {
"insert": '\033[32m', 'insert': '\033[32m',
"change": '\033[33m', 'change': '\033[33m',
"remove": '\033[31m', 'remove': '\033[31m',
"none": '\033[0m', 'none': '\033[0m',
"jump": '\033[36m' 'jump': '\033[36m',
} }
class AsciiPainter:
def __init__ (self, registers=None, max_stack_size=8, stack_draw_mode="up"): class AsciiPainter:
def __init__(self, registers=None, max_stack_size=8, stack_draw_mode='up'):
self.registers = registers if registers else REGISTERS self.registers = registers if registers else REGISTERS
self.states = [] self.states = []
self.max_stack_size = max_stack_size self.max_stack_size = max_stack_size
@ -29,12 +28,14 @@ class AsciiPainter:
for token in signature: for token in signature:
state.append({'state': 'none', 'val': token}) state.append({'state': 'none', 'val': token})
# #
for i in range(3-len(state)): state.append({'state':'none', 'val': ''}) for i in range(3 - len(state)):
for i in range(len(state)-3): state.pop() state.append({'state': 'none', 'val': ''})
for i in range(len(state) - 3):
state.pop()
state.append({'state': 'none', 'val': ''}) state.append({'state': 'none', 'val': ''})
# Write registers to state # Write registers to state
for reg_name in self.registers: for reg_name in self.registers:
if reg_name =="": if reg_name == '':
state.append({'state': 'none', 'val': ''}) state.append({'state': 'none', 'val': ''})
continue continue
reg_state = emu.regState(reg_name) reg_state = emu.regState(reg_name)
@ -42,27 +43,41 @@ class AsciiPainter:
# Write stack to state # Write stack to state
stack_base_pointer = emu.getVal('%rbp') stack_base_pointer = emu.getVal('%rbp')
base_sp = emu.getVal('%rsp') base_sp = emu.getVal('%rsp')
assert(isinstance(emu.getVal('%rsp'), int)) assert isinstance(emu.getVal('%rsp'), int)
state.append({'state': 'none', 'val': ''}) state.append({'state': 'none', 'val': ''})
if emu.regState('m' + str(base_sp - 1)) == 'remove': if emu.regState('m' + str(base_sp - 1)) == 'remove':
state.append({'state': emu.regState('m'+str(base_sp-1)), 'val': emu.stack[base_sp-1]}) state.append(
{
'state': emu.regState('m' + str(base_sp - 1)),
'val': emu.stack[base_sp - 1],
},
)
else: else:
state.append({'state': 'none', 'val': ''}) state.append({'state': 'none', 'val': ''})
for index in range(0, self.max_stack_size): for index in range(0, self.max_stack_size):
stack_i = base_sp + index stack_i = base_sp + index
if stack_i < emu.max_stack_size: if stack_i < emu.max_stack_size:
state.append({ 'state': emu.regState("m"+str(stack_i)), 'val': emu.stack[stack_i] }) state.append(
{
'state': emu.regState('m' + str(stack_i)),
'val': emu.stack[stack_i],
},
)
if stack_base_pointer == index: if stack_base_pointer == index:
stack_base_pointer = emu.stack[base_pointer] stack_base_pointer = emu.stack[base_pointer]
# TODO: Draw stack frame seperators # TODO: Draw stack frame seperators
else: else:
state.append({'state': 'none', 'val': ''}) state.append({'state': 'none', 'val': ''})
def getWidthOfColumns(self, number_states: int, number_states_per_block: int, number_state_vars: int) -> list[int]: def getWidthOfColumns(
self, number_states: int, number_states_per_block: int, number_state_vars: int,
) -> list[int]:
widths = [0 for i in range(0, number_states_per_block)] widths = [0 for i in range(0, number_states_per_block)]
for base_state in range(0, number_states, number_states_per_block): for base_state in range(0, number_states, number_states_per_block):
for var_i in range(0, number_state_vars): for var_i in range(0, number_state_vars):
for state_i in range(0, min(number_states_per_block, number_states - base_state)): for state_i in range(
0, min(number_states_per_block, number_states - base_state),
):
width = len(str(self.states[base_state + state_i][var_i]['val'])) width = len(str(self.states[base_state + state_i][var_i]['val']))
widths[state_i] = max(widths[state_i], width) widths[state_i] = max(widths[state_i], width)
return widths return widths
@ -83,15 +98,26 @@ class AsciiPainter:
output: list[str] = [] output: list[str] = []
name_fmt = '{}{:' + str(self.getWidthOfNameColumn(number_state_vars)) + '} ' name_fmt = '{}{:' + str(self.getWidthOfNameColumn(number_state_vars)) + '} '
column_fmt = ['{}{:>'+str(width)+'} ' for width in self.getWidthOfColumns(number_states, number_states_per_block, number_state_vars)] column_fmt = [
'{}{:>' + str(width) + '} '
for width in self.getWidthOfColumns(
number_states, number_states_per_block, number_state_vars,
)
]
for base_state in range(0, number_states, number_states_per_block): for base_state in range(0, number_states, number_states_per_block):
output.append(separator) output.append(separator)
for var_i in range(0, number_state_vars): for var_i in range(0, number_state_vars):
output.append(name_fmt.format(NORMAL_COLOR, self.nameOfVar(var_i - 4))) output.append(name_fmt.format(NORMAL_COLOR, self.nameOfVar(var_i - 4)))
for state_i in range(0, min(number_states_per_block, number_states - base_state)): for state_i in range(
0, min(number_states_per_block, number_states - base_state),
):
var = self.states[base_state + state_i][var_i] var = self.states[base_state + state_i][var_i]
output.append(column_fmt[state_i].format(REG_STATUS_TO_COLOR[var['state']], var['val'], NORMAL_COLOR)) output.append(
column_fmt[state_i].format(
REG_STATUS_TO_COLOR[var['state']], var['val'], NORMAL_COLOR,
),
)
output.append('\n') output.append('\n')
output.append(separator) output.append(separator)
@ -110,4 +136,3 @@ class AsciiPainter:
def __str__(self): def __str__(self):
return 'AsciiPainter[]' return 'AsciiPainter[]'

86
infernal_interpreter/Emulator.py
View File

@ -1,23 +1,39 @@
import re import re
from . import Junk from . import Junk
from .opcodes import OPCODES from .opcodes import OPCODES
REGISTERS=["%rax", "%rbx", "%rcx", "%rdx", "%rsp", "%rbp", "%rsi", "%rdi", REGISTERS = [
"%r8", "%r9", "%r10", "%r11", "%r12", "%r13", "%r14", "%r15"] '%rax',
'%rbx',
'%rcx',
'%rdx',
'%rsp',
'%rbp',
'%rsi',
'%rdi',
'%r8',
'%r9',
'%r10',
'%r11',
'%r12',
'%r13',
'%r14',
'%r15',
]
class CodeParseException(BaseException): class CodeParseException(BaseException):
def __init__(self, line_nr, string): def __init__(self, line_nr, string):
self.line_nr = line_nr self.line_nr = line_nr
self.string = string self.string = string
class InternalExecutionException(BaseException): class InternalExecutionException(BaseException):
pass pass
class Emulator:
class Emulator:
def __init__(self, source_text, max_stack_size=1000): def __init__(self, source_text, max_stack_size=1000):
self.source = source_text self.source = source_text
self.registers = {} self.registers = {}
@ -37,8 +53,7 @@ class Emulator:
index = self.processSourceLine(line, index) index = self.processSourceLine(line, index)
def setStack(self, *stack_list, **kwargs): def setStack(self, *stack_list, **kwargs):
""" """Sets various stack elements, starting from 0 and going up.
Sets various stack elements, starting from 0 and going up.
Automatically sets rsp. This can be disabled by passing set_rsp=False. Automatically sets rsp. This can be disabled by passing set_rsp=False.
""" """
i = len(self.stack) i = len(self.stack)
@ -50,27 +65,27 @@ class Emulator:
def setRegs(self, **reg_dict): def setRegs(self, **reg_dict):
for reg_name, reg_val in reg_dict.items(): for reg_name, reg_val in reg_dict.items():
assert(reg_name[0] != '%') assert reg_name[0] != '%'
self.registers["%"+reg_name] = reg_val self.registers['%' + reg_name] = reg_val
def getVal(self, val_text): def getVal(self, val_text):
if val_text[0] == "$": if val_text[0] == '$':
return int(val_text[1:]) return int(val_text[1:])
elif val_text[0] == "%": elif val_text[0] == '%':
return self.registers[val_text] return self.registers[val_text]
else: else:
raise ValueError('{} is not an usable value name'.format(val_text)) raise ValueError(f'{val_text} is not an usable value name')
def compareVal(self, valT1, valT2): def compareVal(self, valT1, valT2):
val1 = self.getVal(valT2) val1 = self.getVal(valT2)
val2 = self.getVal(valT1) val2 = self.getVal(valT1)
if isinstance(val1, Junk.Junk) or isinstance(val2, Junk.Junk): if isinstance(val1, Junk.Junk) or isinstance(val2, Junk.Junk):
self.status["i"] = (True,) self.status['i'] = (True,)
return return
self.status["g"] = val1>val2 self.status['g'] = val1 > val2
self.status["l"] = val1<val2 self.status['l'] = val1 < val2
self.status["e"] = val1==val2 self.status['e'] = val1 == val2
self.status["i"] = False self.status['i'] = False
def changedRegisters(self, *args): def changedRegisters(self, *args):
for reg, val in args: for reg, val in args:
@ -84,7 +99,7 @@ class Emulator:
self.labels[tokens[0][:-1]] = index self.labels[tokens[0][:-1]] = index
tokens = tokens[1:] tokens = tokens[1:]
for i in range(len(tokens)): for i in range(len(tokens)):
if tokens[i][0] == "#": if tokens[i][0] == '#':
tokens = tokens[:i] tokens = tokens[:i]
break break
self.code.append(tokens) self.code.append(tokens)
@ -94,25 +109,32 @@ class Emulator:
if reg_name in self.changes: if reg_name in self.changes:
return self.changes[reg_name] return self.changes[reg_name]
else: else:
return "none" return 'none'
def getLineSignature(self, line_nr): def getLineSignature(self, line_nr):
return [ "\\"+token if token[0]=="$" or token[0]=="%" else token for token in self.code[line_nr] ] return [
'\\' + token if token[0] == '$' or token[0] == '%' else token
for token in self.code[line_nr]
]
def pushToStack(self, new_element): def pushToStack(self, new_element):
self.registers['%rsp'] -= 1 self.registers['%rsp'] -= 1
self.stack[self.registers['%rsp']] = new_element self.stack[self.registers['%rsp']] = new_element
self.changedRegisters(('%rsp',"change"), ("m"+str(self.registers['%rsp']),"insert")) self.changedRegisters(
('%rsp', 'change'), ('m' + str(self.registers['%rsp']), 'insert'),
)
self.max_stack_size = max(self.registers['%rsp'], self.max_stack_size) self.max_stack_size = max(self.registers['%rsp'], self.max_stack_size)
def popFromStack(self): def popFromStack(self):
temp = self.stack[self.registers['%rsp']] temp = self.stack[self.registers['%rsp']]
self.changedRegisters(('%rsp',"change"),("m"+str(self.registers['%rsp']),"remove")) self.changedRegisters(
('%rsp', 'change'), ('m' + str(self.registers['%rsp']), 'remove'),
)
self.registers['%rsp'] += 1 self.registers['%rsp'] += 1
return temp return temp
def jump (self, label, cond_op="or", **conditions): def jump(self, label, cond_op='or', **conditions):
if len(conditions)>0 and self.status["i"]: if len(conditions) > 0 and self.status['i']:
raise Junk.JunkComparisonException(*self.status['i']) raise Junk.JunkComparisonException(*self.status['i'])
and_, or_ = True, False and_, or_ = True, False
for cnd_name, cnd_val in conditions.items(): for cnd_name, cnd_val in conditions.items():
@ -120,7 +142,7 @@ class Emulator:
or_ = True or_ = True
else: else:
and_ = False and_ = False
if or_ if cond_op=="or" else and_: if or_ if cond_op == 'or' else and_:
self.registers['%rip'] = self.labels[label] self.registers['%rip'] = self.labels[label]
return True return True
else: else:
@ -132,7 +154,10 @@ class Emulator:
if isinstance(old_rip, Junk.Junk) or old_rip >= len(self.code): if isinstance(old_rip, Junk.Junk) or old_rip >= len(self.code):
return None return None
if not isinstance(self.registers['%rip'], int): if not isinstance(self.registers['%rip'], int):
raise InternalExecutionException("Register %rip should be integer, but was "+str(self.registers['%rip'])) raise InternalExecutionException(
'Register %rip should be integer, but was '
+ str(self.registers['%rip']),
)
instruct = self.code[self.registers['%rip']] instruct = self.code[self.registers['%rip']]
opcode = instruct[0] opcode = instruct[0]
self.changes = {} self.changes = {}
@ -142,7 +167,7 @@ class Emulator:
if self.registers['%rip'] == old_rip: if self.registers['%rip'] == old_rip:
self.registers['%rip'] += 1 self.registers['%rip'] += 1
else: else:
self.changedRegisters(('%rip',"jump")) self.changedRegisters(('%rip', 'jump'))
return old_rip return old_rip
@ -157,5 +182,8 @@ class Emulator:
return output return output
def getUsedRegisters(self): def getUsedRegisters(self):
return [reg_name for reg_name, reg_val in self.registers.items() if not isinstance(reg_val, Junk.Junk)] return [
reg_name
for reg_name, reg_val in self.registers.items()
if not isinstance(reg_val, Junk.Junk)
]

7
infernal_interpreter/Junk.py
View File

@ -1,10 +1,10 @@
import dataclasses import dataclasses
class JunkComparisonException(BaseException):
class JunkComparisonException(BaseException):
def __str__(self): def __str__(self):
return "Attempting to perform calculations involving junk values." return 'Attempting to perform calculations involving junk values.'
@dataclasses.dataclass @dataclasses.dataclass
class Junk: class Junk:
@ -30,4 +30,3 @@ class Junk:
def __rsub__(self, other): def __rsub__(self, other):
return self return self

109
infernal_interpreter/TikzPainter.py
View File

@ -1,21 +1,22 @@
import re import re
REG_STATUS_TO_COLOR = { REG_STATUS_TO_COLOR = {
"insert": "green", 'insert': 'green',
"change": "yellow", 'change': 'yellow',
"remove": "red", 'remove': 'red',
"none": "black", 'none': 'black',
"jump": "orange" 'jump': 'orange',
} }
DEFAULT_OPTIONS = """register_node/.style={rectangle, draw=black!30, DEFAULT_OPTIONS = """register_node/.style={rectangle, draw=black!30,
fill=black!5, very thick, minimum size=0.5, fill=black!5, very thick, minimum size=0.5,
minimum width=20mm}, text_node/.style={}""" minimum width=20mm}, text_node/.style={}"""
class TikzPainter:
def __init__ (self, registers=None, max_stack_size=8, stack_draw_mode="up", options=None): class TikzPainter:
def __init__(
self, registers=None, max_stack_size=8, stack_draw_mode='up', options=None,
):
self.registers = registers if registers else REGISTERS self.registers = registers if registers else REGISTERS
self.text = [] self.text = []
self.pos_x = 0 self.pos_x = 0
@ -24,7 +25,7 @@ class TikzPainter:
self.options = options if options else DEFAULT_OPTIONS self.options = options if options else DEFAULT_OPTIONS
def addText(self, str, *args): def addText(self, str, *args):
text = re.sub(r"[^\\]%", "\\%", str.format(*args)) text = re.sub(r'[^\\]%', '\\%', str.format(*args))
self.text.append(text) self.text.append(text)
def getRegColor(self, reg_state): def getRegColor(self, reg_state):
@ -36,25 +37,42 @@ class TikzPainter:
pos -= 1.5 pos -= 1.5
base_sp = min(emu.last_sp, emu.getVal('%rsp')) base_sp = min(emu.last_sp, emu.getVal('%rsp'))
pos += 0.5 * max(0, emu.getVal('%rsp') - emu.last_sp) pos += 0.5 * max(0, emu.getVal('%rsp') - emu.last_sp)
assert(isinstance(emu.getVal('%rsp'), int)) assert isinstance(emu.getVal('%rsp'), int)
for index in range(base_sp, 3+min(emu.max_stack_size, emu.getVal('%rsp')+self.max_stack_size)): for index in range(
reg_state = emu.regState("m"+str(index)) base_sp,
reg_dect = "register_node, fill="+self.getRegColor(reg_state)+"!10" 3 + min(emu.max_stack_size, emu.getVal('%rsp') + self.max_stack_size),
self.addText("\t\\node[{}]() at ({}, {}){{{}}};\n", ):
reg_dect, x, pos, emu.stack[index]) reg_state = emu.regState('m' + str(index))
reg_dect = 'register_node, fill=' + self.getRegColor(reg_state) + '!10'
self.addText(
'\t\\node[{}]() at ({}, {}){{{}}};\n',
reg_dect,
x,
pos,
emu.stack[index],
)
if base_pointer == index: if base_pointer == index:
self.addText("\t\\draw ({0},{2}) -- ({1},{2});\n",x-1.1,x+1.1,pos-0.25) self.addText(
'\t\\draw ({0},{2}) -- ({1},{2});\n', x - 1.1, x + 1.1, pos - 0.25,
)
base_pointer = emu.stack[base_pointer] base_pointer = emu.stack[base_pointer]
pos -= 0.5 pos -= 0.5
return pos, x return pos, x
def drawStackDownward(self, pos, emu, x): def drawStackDownward(self, pos, emu, x):
pos -= 1 pos -= 1
for index in range(emu.getVal('%rsp')-8, max(emu.last_sp, emu.getVal('%rsp'))): for index in range(
reg_state = emu.regState("m"+str(index)) emu.getVal('%rsp') - 8, max(emu.last_sp, emu.getVal('%rsp')),
reg_dect = "register_node, fill="+self.getRegColor(reg_state)+"!10" ):
self.addText("\t\\node[{}]() at ({}, {}){{{}}};\n", reg_state = emu.regState('m' + str(index))
reg_dect, x, pos, emu.stack[index]) reg_dect = 'register_node, fill=' + self.getRegColor(reg_state) + '!10'
self.addText(
'\t\\node[{}]() at ({}, {}){{{}}};\n',
reg_dect,
x,
pos,
emu.stack[index],
)
pos -= 0.5 pos -= 0.5
return pos, x return pos, x
@ -66,15 +84,20 @@ class TikzPainter:
pos = 0.5 pos = 0.5
for reg_name in self.registers: for reg_name in self.registers:
pos -= 0.5 pos -= 0.5
if reg_name =="": if reg_name == '':
continue continue
reg_state = emu.regState(reg_name) reg_state = emu.regState(reg_name)
reg_dect = "register_node, fill="+self.getRegColor(reg_state)+"!10" reg_dect = 'register_node, fill=' + self.getRegColor(reg_state) + '!10'
self.addText("\t\\node[{}]() at ({}, {}){{{}}};\n", self.addText(
reg_dect, x, pos, emu.getVal(reg_name)) '\t\\node[{}]() at ({}, {}){{{}}};\n',
reg_dect,
x,
pos,
emu.getVal(reg_name),
)
# Draw stack # Draw stack
if self.stack_draw_mode == "up": if self.stack_draw_mode == 'up':
pos, x = self.drawStackUpward(pos, emu, x) pos, x = self.drawStackUpward(pos, emu, x)
else: else:
pos, x = self.drawStackDownward(pos, emu, x) pos, x = self.drawStackDownward(pos, emu, x)
@ -85,45 +108,49 @@ class TikzPainter:
pos = 2 pos = 2
signature = emu.getLineSignature(line_nr) signature = emu.getLineSignature(line_nr)
for token in signature: for token in signature:
self.addText("\t\\node[text_node]() at ({}, {}){{{}}};\n", self.addText(
x-1.25, pos, token) '\t\\node[text_node]() at ({}, {}){{{}}};\n', x - 1.25, pos, token,
)
pos -= 0.5 pos -= 0.5
def drawNames(self, emu): def drawNames(self, emu):
x = 0 x = 0
pos = 0 pos = 0
for reg_name in self.registers: for reg_name in self.registers:
self.addText("\t\\node[text_node]() at ({}, {}){{{}}};\n", self.addText(
x, pos, reg_name[1:]) '\t\\node[text_node]() at ({}, {}){{{}}};\n', x, pos, reg_name[1:],
)
pos -= 0.5 pos -= 0.5
# Draw stack # Draw stack
if self.stack_draw_mode == "up": if self.stack_draw_mode == 'up':
self.drawStackNamesUpward(pos, emu, x) self.drawStackNamesUpward(pos, emu, x)
else: else:
self.drawStackNamesDownward(pos, emu, x) self.drawStackNamesDownward(pos, emu, x)
def drawStackNamesUpward(self, pos, emu, x): def drawStackNamesUpward(self, pos, emu, x):
self.addText("\t\\node[text_node]() at ({}, {}){{TOS+1}};\n", self.addText('\t\\node[text_node]() at ({}, {}){{TOS+1}};\n', x, pos - 0.5)
x, pos-0.5) self.addText('\t\\node[text_node]() at ({}, {}){{TOS}};\n', x, pos - 1.0)
self.addText("\t\\node[text_node]() at ({}, {}){{TOS}};\n",
x, pos-1.0)
pos -= 1 pos -= 1
for index in range(1, self.max_stack_size): for index in range(1, self.max_stack_size):
pos -= 0.5 pos -= 0.5
self.addText("\t\\node[text_node]() at ({}, {}){{TOS-{}}};\n", self.addText(
x, pos, index) '\t\\node[text_node]() at ({}, {}){{TOS-{}}};\n', x, pos, index,
)
def to_string(self, emu): def to_string(self, emu):
PRE = """ \\documentclass{standalone} PRE = (
""" \\documentclass{standalone}
\\usepackage{tikz} \\usepackage{tikz}
\\begin{document} \\begin{document}
\\begin{tikzpicture}["""+self.options+"]" \\begin{tikzpicture}["""
+ self.options
+ ']'
)
POST = """\\end{tikzpicture} POST = """\\end{tikzpicture}
\\end{document}""" \\end{document}"""
self.drawNames(emu) self.drawNames(emu)
return PRE + "".join(self.text) + POST return PRE + ''.join(self.text) + POST
def __str__(self): def __str__(self):
return 'TikzPainter[]' return 'TikzPainter[]'

69
infernal_interpreter/__main__.py
View File

@ -1,31 +1,54 @@
#!/usr/bin/python2 #!/usr/bin/python2
import argparse
import re
import sys import sys
import re
import argparse
from .Emulator import Emulator, REGISTERS
from .TikzPainter import TikzPainter
from .AsciiPainter import AsciiPainter
from . import Junk from . import Junk
from .AsciiPainter import AsciiPainter
from .Emulator import REGISTERS, Emulator
from .TikzPainter import TikzPainter
ARG_DESC = ''' ARG_DESC = """
A silly x86-64 emulator and stack visualizer. A silly x86-64 emulator and stack visualizer.
''' """
PAINTER_ID_TO_CLASS = {'ascii': AsciiPainter, 'tikz': TikzPainter}
PAINTER_ID_TO_CLASS = {
'ascii': AsciiPainter,
'tikz': TikzPainter
}
def parse_args(): def parse_args():
parser = argparse.ArgumentParser(description=ARG_DESC) parser = argparse.ArgumentParser(description=ARG_DESC)
parser.add_argument('-i', '--input-file', default='-', help = 'File to use as input', dest = 'input-file') parser.add_argument(
parser.add_argument('-o', '--output-file', default='-', help = 'File to use as output', dest = 'output-file') '-i',
parser.add_argument('-p', '--painter', default='ascii', help = 'Drawer to use', dest = 'painter-name', choices=PAINTER_ID_TO_CLASS.keys()) '--input-file',
default='-',
help='File to use as input',
dest='input-file',
)
parser.add_argument(
'-o',
'--output-file',
default='-',
help='File to use as output',
dest='output-file',
)
parser.add_argument(
'-p',
'--painter',
default='ascii',
help='Drawer to use',
dest='painter-name',
choices=PAINTER_ID_TO_CLASS.keys(),
)
for register in REGISTERS: for register in REGISTERS:
parser.add_argument('--'+register[1:], nargs = 1, type = int, default = None, dest = register, help = 'the initial value of the register') parser.add_argument(
'--' + register[1:],
nargs=1,
type=int,
default=None,
dest=register,
help='the initial value of the register',
)
args = vars(parser.parse_args()) args = vars(parser.parse_args())
# Determine args # # Determine args #
@ -42,7 +65,7 @@ def parse_args ():
registers_init[register[1:]] = args[register][0] registers_init[register[1:]] = args[register][0]
# #
program = "" program = ''
if args['input-file'] == '-': if args['input-file'] == '-':
program = sys.stdin.read() program = sys.stdin.read()
else: else:
@ -62,20 +85,20 @@ def parse_args ():
## Return ## Return
return (program, registers_init, output_file, painter_class) return (program, registers_init, output_file, painter_class)
def main ():
def main():
(program, registers_init, output_file, painter_class) = parse_args() (program, registers_init, output_file, painter_class) = parse_args()
# Determine registers to display # Determine registers to display
registers_to_draw = ["%rip","%rbp","%rsp", ""] registers_to_draw = ['%rip', '%rbp', '%rsp', '']
for match in re.findall(r"%r[a-z0-9]{1,2}", program): for match in re.findall(r'%r[a-z0-9]{1,2}', program):
if match not in registers_to_draw: if match not in registers_to_draw:
registers_to_draw.append(match) registers_to_draw.append(match)
# Setup emulator and drawer # Setup emulator and drawer
emu = Emulator(program) emu = Emulator(program)
emu.setRegs(**registers_init) emu.setRegs(**registers_init)
emu.setStack(Junk.Junk("junk..."), Junk.Junk("call eip")) emu.setStack(Junk.Junk('junk...'), Junk.Junk('call eip'))
painter = painter_class(registers_to_draw) painter = painter_class(registers_to_draw)
@ -88,6 +111,6 @@ def main ():
output_file.write(painter.to_string(emu)) output_file.write(painter.to_string(emu))
output_file.close() output_file.close()
if __name__ == "__main__":
main()
if __name__ == '__main__':
main()

73
infernal_interpreter/opcodes.py
View File

@ -1,88 +1,109 @@
OPCODES = {} OPCODES = {}
def add_opcode(*opcode_names): def add_opcode(*opcode_names):
def wrapped(func): def wrapped(func):
for name in opcode_names: for name in opcode_names:
OPCODES[name] = func OPCODES[name] = func
return wrapped return wrapped
################################################################################ ################################################################################
# Stack # Stack
@add_opcode("push","pushq")
@add_opcode('push', 'pushq')
def push(emu, value): def push(emu, value):
emu.pushToStack(emu.getVal(value)) emu.pushToStack(emu.getVal(value))
@add_opcode("pop","popq")
@add_opcode('pop', 'popq')
def pop(emu, target_reg): def pop(emu, target_reg):
emu.registers[target_reg] = emu.popFromStack() emu.registers[target_reg] = emu.popFromStack()
emu.changedRegisters((target_reg,"change")) emu.changedRegisters((target_reg, 'change'))
# Arithmetic # Arithmetic
@add_opcode("mov","movq")
@add_opcode('mov', 'movq')
def mov(emu, from_reg, target_reg): def mov(emu, from_reg, target_reg):
emu.registers[target_reg] = emu.getVal(from_reg) emu.registers[target_reg] = emu.getVal(from_reg)
emu.changedRegisters((target_reg,"change")) emu.changedRegisters((target_reg, 'change'))
@add_opcode("add","addq")
@add_opcode('add', 'addq')
def add(emu, add_val, target_reg): def add(emu, add_val, target_reg):
emu.registers[target_reg] += emu.getVal(add_val) emu.registers[target_reg] += emu.getVal(add_val)
emu.changedRegisters((target_reg,"change")) emu.changedRegisters((target_reg, 'change'))
@add_opcode("sub","subq")
@add_opcode('sub', 'subq')
def sub(emu, sub_val, target_reg): def sub(emu, sub_val, target_reg):
emu.registers[target_reg] -= emu.getVal(sub_val) emu.registers[target_reg] -= emu.getVal(sub_val)
emu.changedRegisters((target_reg,"change")) emu.changedRegisters((target_reg, 'change'))
# Comparison and conditional jumping # Comparison and conditional jumping
@add_opcode("cmp","cmpq")
@add_opcode('cmp', 'cmpq')
def comp(emu, val1, val2): def comp(emu, val1, val2):
emu.compareVal(val1, val2) emu.compareVal(val1, val2)
@add_opcode("jg")
@add_opcode('jg')
def jg(emu, label): def jg(emu, label):
emu.jump(label, g=True) emu.jump(label, g=True)
@add_opcode("jl")
@add_opcode('jl')
def jl(emu, label): def jl(emu, label):
emu.jump(label, l=True) emu.jump(label, l=True)
@add_opcode("je")
@add_opcode('je')
def je(emu, label): def je(emu, label):
emu.jump(label, e=True) emu.jump(label, e=True)
@add_opcode("jge")
@add_opcode('jge')
def jge(emu, label): def jge(emu, label):
emu.jump(label, "or", g=True, e=True) emu.jump(label, 'or', g=True, e=True)
@add_opcode("jle")
@add_opcode('jle')
def jle(emu, label): def jle(emu, label):
emu.jump(label, "or", l=True, e=True) emu.jump(label, 'or', l=True, e=True)
@add_opcode("jne")
@add_opcode('jne')
def jne(emu, label): def jne(emu, label):
emu.jump(label, e=False) emu.jump(label, e=False)
# Unconditional Jumping # Unconditional Jumping
@add_opcode("jmp")
@add_opcode('jmp')
def jmp(emu, label): def jmp(emu, label):
emu.registers['%rip'] = emu.labels[label] emu.registers['%rip'] = emu.labels[label]
@add_opcode("call")
@add_opcode('call')
def call(emu, label): def call(emu, label):
emu.pushToStack(emu.registers['%rip'] + 1) emu.pushToStack(emu.registers['%rip'] + 1)
emu.registers['%rip'] = emu.labels[label] emu.registers['%rip'] = emu.labels[label]
@add_opcode("leave")
def leave(emu):
emu.registers["%rsp"] = emu.registers["%rbp"]
emu.registers["%rbp"] = emu.popFromStack()
@add_opcode("ret") @add_opcode('leave')
def leave(emu):
emu.registers['%rsp'] = emu.registers['%rbp']
emu.registers['%rbp'] = emu.popFromStack()
@add_opcode('ret')
def ret(emu): def ret(emu):
emu.registers['%rip'] = emu.popFromStack() emu.registers['%rip'] = emu.popFromStack()

5
setup.py
View File

@ -41,7 +41,10 @@ this stuff is worth it, you can buy me a beer in return.
Jon Michael Aanes Jon Michael Aanes
```""" ```"""
PACKAGE_DESCRIPTION_SHORT='Simple interpreter and stack tracer for the AMD x86-64 ABI.' PACKAGE_DESCRIPTION_SHORT = (
'Simple interpreter and stack tracer for the AMD x86-64 ABI.'
)
def parse_version_file(text: str) -> str: def parse_version_file(text: str) -> str:
match = re.match(r'^__version__\s*=\s*(["\'])([\d\.]+)\1$', text) match = re.match(r'^__version__\s*=\s*(["\'])([\d\.]+)\1$', text)

158
tests/tests.py
View File

@ -1,6 +1,7 @@
import os import os
import sys import sys
import traceback import traceback
sys.path.insert(1, os.path.join(sys.path[0], '..')) sys.path.insert(1, os.path.join(sys.path[0], '..'))
import infernal import infernal
@ -9,14 +10,17 @@ import infernal
tests = [] tests = []
def add_test(name, result, register, code): def add_test(name, result, register, code):
tests.append((name, result, register, code)) tests.append((name, result, register, code))
def printf(str, *args): def printf(str, *args):
print(str.format(*args)) print(str.format(*args))
def execute_tests(): def execute_tests():
print("Executing tests!") print('Executing tests!')
total_tests = 0 total_tests = 0
failed_tests = 0 failed_tests = 0
error_tests = 0 error_tests = 0
@ -25,94 +29,152 @@ def execute_tests():
line_nr = None line_nr = None
try: try:
emu = infernal.Emulator(code) emu = infernal.Emulator(code)
emu.setStack("junk...", "calling eip") emu.setStack('junk...', 'calling eip')
emu.setRegs(rip=0, rbp='old bp') emu.setRegs(rip=0, rbp='old bp')
except infernal.CodeParseException as e: except infernal.CodeParseException as e:
error_tests += 1 error_tests += 1
printf("Encountered error when parsing {}, at line {}: {}", printf(
name, e.line_nr, e.str) 'Encountered error when parsing {}, at line {}: {}',
name,
e.line_nr,
e.str,
)
try: try:
for line_nr in emu: for line_nr in emu:
pass pass
if isinstance(result, BaseException): if isinstance(result, BaseException):
printf("Error should have happened in {}, but did not", name) printf('Error should have happened in {}, but did not', name)
failed_tests += 1 failed_tests += 1
output = emu.getVal(register) output = emu.getVal(register)
if output != result: if output != result:
failed_tests += 1 failed_tests += 1
printf("Failed in {}. {} was {}, should be {}", printf(
name, register, output, result) 'Failed in {}. {} was {}, should be {}',
name,
register,
output,
result,
)
except BaseException as e: except BaseException as e:
print(e) print(e)
if not isinstance(result, BaseException) or not isinstance(e, result): if not isinstance(result, BaseException) or not isinstance(e, result):
error_tests += 1 error_tests += 1
printf("Encountered error in {}, at operation {}: {}", printf(
name, emu.getVal('%rip'), e) 'Encountered error in {}, at operation {}: {}',
name,
emu.getVal('%rip'),
e,
)
traceback.print_exc() traceback.print_exc()
printf("Tests done! {}/{}.", printf('Tests done! {}/{}.', total_tests - failed_tests - error_tests, total_tests)
total_tests - failed_tests - error_tests, total_tests) printf('{} failed, and {} encountered a python error', failed_tests, error_tests)
printf("{} failed, and {} encountered a python error",
failed_tests, error_tests)
################################################################################ ################################################################################
# Arithmetic Operations # Arithmetic Operations
add_test("constant $255", 255, "%rsi", """ add_test(
'constant $255',
255,
'%rsi',
"""
movq $255, %rsi movq $255, %rsi
""") """,
)
add_test("static addition 10+$20", 30, "%rsi", """ add_test(
'static addition 10+$20',
30,
'%rsi',
"""
movq $10, %rsi movq $10, %rsi
addq $20, %rsi addq $20, %rsi
""") """,
)
add_test("register addition 10+20", 30, "%rsi", """ add_test(
'register addition 10+20',
30,
'%rsi',
"""
movq $10, %rsi movq $10, %rsi
movq $20, %rax movq $20, %rax
addq %rax, %rsi addq %rax, %rsi
""") """,
)
add_test("register subtraction 10-20", -10, "%rsi", """ add_test(
'register subtraction 10-20',
-10,
'%rsi',
"""
movq $10, %rsi movq $10, %rsi
movq $20, %rax movq $20, %rax
subq %rax, %rsi subq %rax, %rsi
""") """,
)
################################################################################ ################################################################################
# Branching # Branching
branch_tests = [ branch_tests = [
("jg",10,">",5,0), ("jg",5,">",5,1), ("jg",5,">",10,1), ('jg', 10, '>', 5, 0),
("jl",10,"<",5,1), ("jl",5,"<",5,1), ("jl",5,"<",10,0), ('jg', 5, '>', 5, 1),
("je",10,"==",5,1),("je",5,"==",5,0),("je",5,"==",10,1), ('jg', 5, '>', 10, 1),
("jge",10,">=",5,0),("jge",5,">=",5,0),("jge",5,">=",10,1), ('jl', 10, '<', 5, 1),
("jle",10,"<=",5,1),("jle",5,"<=",5,0),("jle",5,"<=",10,0), ('jl', 5, '<', 5, 1),
("jne",10,"!=",5,0),("jne",5,"!=",5,1),("jne",5,"!=",10,0), ('jl', 5, '<', 10, 0),
('je', 10, '==', 5, 1),
('je', 5, '==', 5, 0),
('je', 5, '==', 10, 1),
('jge', 10, '>=', 5, 0),
('jge', 5, '>=', 5, 0),
('jge', 5, '>=', 10, 1),
('jle', 10, '<=', 5, 1),
('jle', 5, '<=', 5, 0),
('jle', 5, '<=', 10, 0),
('jne', 10, '!=', 5, 0),
('jne', 5, '!=', 5, 1),
('jne', 5, '!=', 10, 0),
] ]
for jump_instruct, a, comp, b, result in branch_tests: for jump_instruct, a, comp, b, result in branch_tests:
add_test("branch {a} {comp} {b}={result}".format(a=a,comp=comp,b=b,result=not result), result, "%rsi", """ add_test(
f'branch {a} {comp} {b}={not result}',
result,
'%rsi',
f"""
start: cmpq ${b}, ${a} start: cmpq ${b}, ${a}
{jump_instruct} true {jump_instruct} true
movq $1, %rsi movq $1, %rsi
jmp return jmp return
true: movq $0, %rsi true: movq $0, %rsi
return: ret return: ret
""".format(a=a,b=b,jump_instruct=jump_instruct)) """,
)
################################################################################ ################################################################################
# Junk Comparisons # Junk Comparisons
add_test("invalid comparison 1", infernal.JunkComparisonException, "None", """ add_test(
'invalid comparison 1',
infernal.JunkComparisonException,
'None',
"""
start: movq $100, %rsp # Set stack pointer to a random position. start: movq $100, %rsp # Set stack pointer to a random position.
popq %rsi # Move a Junk value into %rsi popq %rsi # Move a Junk value into %rsi
cmpq $10, %rsi # Do a Junk comparison, which triggers the `i` comp cmpq $10, %rsi # Do a Junk comparison, which triggers the `i` comp
# virtual register. # virtual register.
jg start # Attempt to do a jump to the start, if (Junk-10)>0, jg start # Attempt to do a jump to the start, if (Junk-10)>0,
# which makes no sense, and thus throws an error. # which makes no sense, and thus throws an error.
""") """,
)
add_test("invalid addition 1", infernal.JunkComparisonException, "None", """ add_test(
'invalid addition 1',
infernal.JunkComparisonException,
'None',
"""
start: movq $100, %rsp # Set stack pointer to a random position. start: movq $100, %rsp # Set stack pointer to a random position.
popq %rsi # Move a Junk value into %rsi popq %rsi # Move a Junk value into %rsi
addq %rsi, %rsp # Adds Junk to 101, which produces Junk. addq %rsi, %rsp # Adds Junk to 101, which produces Junk.
@ -120,9 +182,14 @@ start: movq $100, %rsp # Set stack pointer to a random position.
# virtual register. # virtual register.
jg start # Attempt to do a jump to the start, if (Junk-10)>0, jg start # Attempt to do a jump to the start, if (Junk-10)>0,
# which makes no sense, and thus throws an error. # which makes no sense, and thus throws an error.
""") """,
)
add_test("invalid addition 2", infernal.JunkComparisonException, "None", """ add_test(
'invalid addition 2',
infernal.JunkComparisonException,
'None',
"""
start: movq $100, %rsp # Set stack pointer to a random position. start: movq $100, %rsp # Set stack pointer to a random position.
popq %rsi # Move a Junk value into %rsi popq %rsi # Move a Junk value into %rsi
addq %rsp, %rsi # Adds 101 to Junk, which produces Junk. addq %rsp, %rsi # Adds 101 to Junk, which produces Junk.
@ -130,9 +197,14 @@ start: movq $100, %rsp # Set stack pointer to a random position.
# virtual register. # virtual register.
jg start # Attempt to do a jump to the start, if (Junk-10)>0, jg start # Attempt to do a jump to the start, if (Junk-10)>0,
# which makes no sense, and thus throws an error. # which makes no sense, and thus throws an error.
""") """,
)
add_test("invalid subtraction 1", infernal.JunkComparisonException, "None", """ add_test(
'invalid subtraction 1',
infernal.JunkComparisonException,
'None',
"""
start: movq $100, %rsp # Set stack pointer to a random position. start: movq $100, %rsp # Set stack pointer to a random position.
popq %rsi # Move a Junk value into %rsi popq %rsi # Move a Junk value into %rsi
subq %rsi, %rsp # Adds Junk to 101, which produces Junk. subq %rsi, %rsp # Adds Junk to 101, which produces Junk.
@ -140,9 +212,14 @@ start: movq $100, %rsp # Set stack pointer to a random position.
# virtual register. # virtual register.
jg start # Attempt to do a jump to the start, if (Junk-10)>0, jg start # Attempt to do a jump to the start, if (Junk-10)>0,
# which makes no sense, and thus throws an error. # which makes no sense, and thus throws an error.
""") """,
)
add_test("invalid subtraction 2", infernal.JunkComparisonException, "None", """ add_test(
'invalid subtraction 2',
infernal.JunkComparisonException,
'None',
"""
start: movq $100, %rsp # Set stack pointer to a random position. start: movq $100, %rsp # Set stack pointer to a random position.
popq %rsi # Move a Junk value into %rsi popq %rsi # Move a Junk value into %rsi
subq %rsp, %rsi # Adds 101 to Junk, which produces Junk. subq %rsp, %rsi # Adds 101 to Junk, which produces Junk.
@ -150,9 +227,10 @@ start: movq $100, %rsp # Set stack pointer to a random position.
# virtual register. # virtual register.
jg start # Attempt to do a jump to the start, if (Junk-10)>0, jg start # Attempt to do a jump to the start, if (Junk-10)>0,
# which makes no sense, and thus throws an error. # which makes no sense, and thus throws an error.
""") """,
)
################################################################################ ################################################################################
if __name__ == "__main__": if __name__ == '__main__':
execute_tests() execute_tests()