今天早上早些時候,在我的Planet Python源中,我讀到了一篇有趣的文章"開發CARDIAC:紙板電腦(Developing upwards: CARDIAC: The Cardboard Computer)",它是關於名為Cardiac的紙板電腦的.我的一些追隨者和讀者應該知道,我有一個名為簡單CPU(simple-cpu)的項目,過去的數月我一直工作於此,並且已經發布了原始碼.我真的應該給這個項目提供一個合適的許可證,這樣,其他人可能更感興趣,並在他們自己的項目中使用.不管怎樣,但願在這發布之後,我可以完成這件事.
在讀完了這篇文章以及它連結的頁面後,我受到了一些啟發,決定為它編寫我自己的模擬器,因為我有編寫位元組碼引擎的經驗.我計划著跟隨這篇文章繼續往前,先寫一篇關於彙編器的文章,接下來是關於編譯器的文章.這樣,通過這些文章,你基本上可以學到,如何用Python為Cardiac建立編譯工具集. 在簡單CPU(simple-cpu)項目中,我已經編寫了一個完整的可工作的彙編器.在內建的遊戲中,已經有了可工作的編譯器的最初步驟.我也選擇Cardiac作為一個驗證機器是因為它絕對的簡單.不需要複雜的記憶,每個作業碼只接受單一的參數,所以它是絕好的學習工具.此外,所有的資料參數都是相同的,不需要檢測程式是需要一個寄存器,字串或者還是記憶體位址.實際上,只有一個寄存器,累加器.因此,讓我們開始吧!我們將基於類來建立,這樣包含範圍.如果你想嘗試的話,你可以簡單通過子類來增加新的作業碼.首先,我們將集中於初始化常式.這個CPU非常簡單,所以我們只需要初始化下面的內容: CPU寄存器, 作業碼, 記憶體空間, 讀卡機/輸入, 和 列印/tty/輸出.
class Cardiac(object): """ This class is the cardiac "CPU". """ def __init__(self): self.init_cpu() self.reset() self.init_mem() self.init_reader() self.init_output() def reset(self): """ This method resets the CPU's registers to their defaults. """ self.pc = 0 #: Program Counter self.ir = 0 #: Instruction Register self.acc = 0 #: Accumulator self.running = False #: Are we running? def init_cpu(self): """ This fancy method will automatically build a list of our opcodes into a hash. This enables us to build a typical case/select system in Python and also keeps things more DRY. We could have also used the getattr during the process() method before, and wrapped it around a try/except block, but that looks a bit messy. This keeps things clean and simple with a nice one-to-one call-map. """ self.__opcodes = {} classes = [self.__class__] #: This holds all the classes and base classes. while classes: cls = classes.pop() # Pop the classes stack and being if cls.__bases__: # Does this class have any base classes? classes = classes + list(cls.__bases__) for name in dir(cls): # Lets iterate through the names. if name[:7] == 'opcode_': # We only want opcodes here. try: opcode = int(name[7:]) except ValueError: raise NameError('Opcodes must be numeric, invalid opcode: %s' % name[7:]) self.__opcodes.update({opcode:getattr(self, 'opcode_%s' % opcode)}) def init_mem(self): """ This method resets the Cardiac's memory space to all blank strings, as per Cardiac specs. """ self.mem = ['' for i in range(0,100)] self.mem[0] = '001' #: The Cardiac bootstrap operation. def init_reader(self): """ This method initializes the input reader. """ self.reader = [] #: This variable can be accessed after initializing the class to provide input data. def init_output(self): """ This method initializes the output deck/paper/printer/teletype/etc... """ self.output = []
但願我寫的注釋能讓你們看明白代碼的各部分功能. 也許你已經發現這段代碼處理指示集的方法(method)跟 simple-cpu 項目有所不同. 由於它能讓開發人員根據自己的需求輕鬆的擴充類庫, 我打算在後續的項目中繼續使用這種處理方式. 隨著我對各部分功能原理的深入理解, 項目也在不斷的發展變化. 其實吧, 做這樣一個項目真的能讓人學到不少東西. 對於精通電腦的人來說 , CPU 的工作原理啦, 指令集是怎麼處理的啦, 都不是問題啦 . 關鍵是, 能夠按照自己的想法去實現這樣一個 CPU 模擬器, 真的很好玩. 根據自己想象中的樣子, 親手打造出這樣一台模擬器, 然後看著它屁顛屁顛的運行著, 那叫一個有成就感.
接下來, 我們講下工具函數(utility functions), 這些函數在很多地方都會用到, 而且允許在子類(subclasses)中重寫:
def read_deck(self, fname): """ 將指令讀到 reader 中. """ self.reader = [s.rstrip('\n') for s in open(fname, 'r').readlines()] self.reader.reverse() def fetch(self): """ 根據指令指標(program pointer) 從記憶體中讀出指令, 然後將指令指標加1. """ self.ir = int(self.mem[self.pc]) self.pc +=1 def get_memint(self, data): """ 由於我們是以字串形式(*string* based)儲存記憶體資料的, 要模擬 Cardiac, 就要將字串轉化成整數. 如果是其他儲存形式的記憶體, 如 mmap, 可以根據需要重寫本函數. """ return int(self.mem[data]) def pad(self, data, length=3): """ 本函數的功能是像 Cardiac 那樣, 在數位前面補0. """ orig = int(data) padding = '0'*length data = '%s%s' % (padding, abs(data)) if orig < 0: return '-'+data[-length:] return data[-length:]
本文後面我會另外給大家一段能結合 Mixin classes 使用的代碼, 靈活性(pluggable)更強些. 最後就剩下這個處理指示集的方法了:
def process(self): """ 本函數只處理一條指令. 預設情況下, 從迴圈代碼(running loop)中調用, 你也可以自己寫代碼, 以單步調試的方式調用它, 或者使用 time.sleep() 降低執行的速度. 如果想用 TK/GTK/Qt/curses 做的前端介面(frontend), 在另外一個線程中操作, 也可以調用本函數. """ self.fetch() opcode, data = int(math.floor(self.ir / 100)), self.ir % 100 self.__opcodes[opcode](data) def opcode_0(self, data): """ 輸入指令 """ self.mem[data] = self.reader.pop() def opcode_1(self, data): """ 清除指令 """ self.acc = self.get_memint(data) def opcode_2(self, data): """ 加法指令 """ self.acc += self.get_memint(data) def opcode_3(self, data): """ 測試累加器內容指令 """ if self.acc < 0: self.pc = data def opcode_4(self, data): """ 位移指令 """ x,y = int(math.floor(data / 10)), int(data % 10) for i in range(0,x): self.acc = (self.acc * 10) % 10000 for i in range(0,y): self.acc = int(math.floor(self.acc / 10)) def opcode_5(self, data): """ 輸出指令 """ self.output.append(self.mem[data]) def opcode_6(self, data): """ 儲存指令 """ self.mem[data] = self.pad(self.acc) def opcode_7(self, data): """ 減法指令 """ self.acc -= self.get_memint(data) def opcode_8(self, data): """ 無條件跳轉指令 """ self.pc = data def opcode_9(self, data): """ 終止, 複位指令 """ self.reset() def run(self, pc=None): """ 這段代碼一直執行到遇到 終止/複位 指令為止. """ if pc: self.pc = pc self.running = True while self.running: self.process() print "Output:\n%s" % '\n'.join(self.output) self.init_output()if __name__ == '__main__': c = Cardiac() c.read_deck('deck1.txt') try: c.run() except: print "IR: %s\nPC: %s\nOutput: %s\n" % (c.ir, c.pc, '\n'.join(c.output)) raise
這段是上面提到的, 能在 Mixin 中使用的代碼, 我重構過後, 代碼如下 :
class Memory(object): """ 本類實現模擬器的虛擬記憶體空間的各種功能 """ def init_mem(self): """ 用空白字串清除 Cardiac 系統記憶體中的所有資料 """ self.mem = ['' for i in range(0,100)] self.mem[0] = '001' #: 啟動 Cardiac 系統. def get_memint(self, data): """ 由於我們是以字串形式(*string* based)儲存記憶體資料的, 要模擬 Cardiac, 就要將字串轉化成整數. 如果是其他儲存形式的記憶體, 如 mmap, 可以根據需要重寫本函數. """ return int(self.mem[data]) def pad(self, data, length=3): """ 在數字前面補0 """ orig = int(data) padding = '0'*length data = '%s%s' % (padding, abs(data)) if orig < 0: return '-'+data[-length:] return data[-length:]class IO(object): """ 本類實現模擬器的 I/O 功能. To enable alternate methods of input and output, swap this. """ def init_reader(self): """ 初始化 reader. """ self.reader = [] #: 此變數在類初始化後, 可以用來讀取輸入的資料. def init_output(self): """ 初始化諸如: deck/paper/printer/teletype/ 之類的輸出功能... """ self.output = [] def read_deck(self, fname): """ 將指令讀到 reader 中. """ self.reader = [s.rstrip('\n') for s in open(fname, 'r').readlines()] self.reader.reverse() def format_output(self): """ 格式化虛擬 I/O 裝置的輸出(output) """ return '\n'.join(self.output) def get_input(self): """ 擷取 IO 的輸入(input), 也就是說用 reader 讀取資料, 代替原來的 raw_input() . """ try: return self.reader.pop() except IndexError: # 如果 reader 遇到檔案結束標誌(EOF) 就用 raw_input() 代替 reader. return raw_input('INP: ')[:3] def stdout(self, data): self.output.append(data)class CPU(object): """ 本類類比 cardiac CPU. """ def __init__(self): self.init_cpu() self.reset() try: self.init_mem() except AttributeError: raise NotImplementedError('You need to Mixin a memory-enabled class.') try: self.init_reader() self.init_output() except AttributeError: raise NotImplementedError('You need to Mixin a IO-enabled class.') def reset(self): """ 用預設值重設 CPU 的寄存器 """ self.pc = 0 #: 指令指標 self.ir = 0 #: 指令寄存器 self.acc = 0 #: 累加器 self.running = False #: 模擬器的運行狀態? def init_cpu(self): """ 本函數自動在雜湊表中建立指令集. 這樣我們就可以使用 case/select 方式調用指令, 同時保持代碼簡潔. 當然, 在 process() 中使用 getattr 然後用 try/except 捕捉異常也是可以的, 但是代碼看起來就沒那麼簡潔了. """ self.__opcodes = {} classes = [self.__class__] #: 擷取全部類, 包含基類. while classes: cls = classes.pop() # 把堆棧中的類彈出來 if cls.__bases__: # 判斷有沒有基類 classes = classes + list(cls.__bases__) for name in dir(cls): # 遍曆名稱. if name[:7] == 'opcode_': # 只需要把指令讀出來即可 try: opcode = int(name[7:]) except ValueError: raise NameError('Opcodes must be numeric, invalid opcode: %s' % name[7:]) self.__opcodes.update({opcode:getattr(self, 'opcode_%s' % opcode)}) def fetch(self): """ 根據指令指標(program pointer) 從記憶體中讀取指令, 然後指令指標加 1. """ self.ir = self.get_memint(self.pc) self.pc +=1 def process(self): """ 處理當前指令, 只處理一條. 預設情況下是在迴圈代碼中調用(running loop), 也可以自己寫代碼, 以單步調試方式調用, 或者利用 time.sleep() 降低執行速度. 在 TK/GTK/Qt/curses 做的介面的線程中調用本函數也是可以的. """ self.fetch() opcode, data = int(math.floor(self.ir / 100)), self.ir % 100 self.__opcodes[opcode](data) def opcode_0(self, data): """ 輸入指令 """ self.mem[data] = self.get_input() def opcode_1(self, data): """ 清除累加器指令 """ self.acc = self.get_memint(data) def opcode_2(self, data): """ 加法指令 """ self.acc += self.get_memint(data) def opcode_3(self, data): """ 測試累加器內容指令 """ if self.acc < 0: self.pc = data def opcode_4(self, data): """ 位移指令 """ x,y = int(math.floor(data / 10)), int(data % 10) for i in range(0,x): self.acc = (self.acc * 10) % 10000 for i in range(0,y): self.acc = int(math.floor(self.acc / 10)) def opcode_5(self, data): """ 輸出指令 """ self.stdout(self.mem[data]) def opcode_6(self, data): """ 儲存指令 """ self.mem[data] = self.pad(self.acc) def opcode_7(self, data): """ 減法指令 """ self.acc -= self.get_memint(data) def opcode_8(self, data): """ 無條件跳轉指令 """ self.pc = data def opcode_9(self, data): """ 停止/複位指令""" self.reset() def run(self, pc=None): """ 這段代碼會一直運行, 直到遇到 halt/reset 指令才停止. """ if pc: self.pc = pc self.running = True while self.running: self.process() print "Output:\n%s" % self.format_output() self.init_output()class Cardiac(CPU, Memory, IO): passif __name__ == '__main__': c = Cardiac() c.read_deck('deck1.txt') try: c.run() except: print "IR: %s\nPC: %s\nOutput: %s\n" % (c.ir, c.pc, c.format_output()) raise
大家可以從 Developing Upwards: CARDIAC: The Cardboard Computer 中找到本文使用的 deck1.txt .
希望本文能啟發大家, 怎麼去設計基於類的模組, 插拔性強(pluggable)的 Paython 代碼, 以及如何開發 CPU 模擬器. 至於本文 CPU 用到的彙編編譯器(assembler) , 會在下一篇文章中教大家.
這段是上面提到的, 能在 Mixin 中使用的代碼, 我重構過後, 代碼如下 :
class Memory(object): """ 本類實現模擬器的虛擬記憶體空間的各種功能 """ def init_mem(self): """ 用空白字串清除 Cardiac 系統記憶體中的所有資料 """ self.mem = ['' for i in range(0,100)] self.mem[0] = '001' #: 啟動 Cardiac 系統. def get_memint(self, data): """ 由於我們是以字串形式(*string* based)儲存記憶體資料的, 要模擬 Cardiac, 就要將字串轉化成整數. 如果是其他儲存形式的記憶體, 如 mmap, 可以根據需要重寫本函數. """ return int(self.mem[data]) def pad(self, data, length=3): """ 在數字前面補0 """ orig = int(data) padding = '0'*length data = '%s%s' % (padding, abs(data)) if orig < 0: return '-'+data[-length:] return data[-length:]class IO(object): """ 本類實現模擬器的 I/O 功能. To enable alternate methods of input and output, swap this. """ def init_reader(self): """ 初始化 reader. """ self.reader = [] #: 此變數在類初始化後, 可以用來讀取輸入的資料. def init_output(self): """ 初始化諸如: deck/paper/printer/teletype/ 之類的輸出功能... """ self.output = [] def read_deck(self, fname): """ 將指令讀到 reader 中. """ self.reader = [s.rstrip('\n') for s in open(fname, 'r').readlines()] self.reader.reverse() def format_output(self): """ 格式化虛擬 I/O 裝置的輸出(output) """ return '\n'.join(self.output) def get_input(self): """ 擷取 IO 的輸入(input), 也就是說用 reader 讀取資料, 代替原來的 raw_input() . """ try: return self.reader.pop() except IndexError: # 如果 reader 遇到檔案結束標誌(EOF) 就用 raw_input() 代替 reader. return raw_input('INP: ')[:3] def stdout(self, data): self.output.append(data)class CPU(object): """ 本類類比 cardiac CPU. """ def __init__(self): self.init_cpu() self.reset() try: self.init_mem() except AttributeError: raise NotImplementedError('You need to Mixin a memory-enabled class.') try: self.init_reader() self.init_output() except AttributeError: raise NotImplementedError('You need to Mixin a IO-enabled class.') def reset(self): """ 用預設值重設 CPU 的寄存器 """ self.pc = 0 #: 指令指標 self.ir = 0 #: 指令寄存器 self.acc = 0 #: 累加器 self.running = False #: 模擬器的運行狀態? def init_cpu(self): """ 本函數自動在雜湊表中建立指令集. 這樣我們就可以使用 case/select 方式調用指令, 同時保持代碼簡潔. 當然, 在 process() 中使用 getattr 然後用 try/except 捕捉異常也是可以的, 但是代碼看起來就沒那麼簡潔了. """ self.__opcodes = {} classes = [self.__class__] #: 擷取全部類, 包含基類. while classes: cls = classes.pop() # 把堆棧中的類彈出來 if cls.__bases__: # 判斷有沒有基類 classes = classes + list(cls.__bases__) for name in dir(cls): # 遍曆名稱. if name[:7] == 'opcode_': # 只需要把指令讀出來即可 try: opcode = int(name[7:]) except ValueError: raise NameError('Opcodes must be numeric, invalid opcode: %s' % name[7:]) self.__opcodes.update({opcode:getattr(self, 'opcode_%s' % opcode)}) def fetch(self): """ 根據指令指標(program pointer) 從記憶體中讀取指令, 然後指令指標加 1. """ self.ir = self.get_memint(self.pc) self.pc +=1 def process(self): """ 處理當前指令, 只處理一條. 預設情況下是在迴圈代碼中調用(running loop), 也可以自己寫代碼, 以單步調試方式調用, 或者利用 time.sleep() 降低執行速度. 在 TK/GTK/Qt/curses 做的介面的線程中調用本函數也是可以的. """ self.fetch() opcode, data = int(math.floor(self.ir / 100)), self.ir % 100 self.__opcodes[opcode](data) def opcode_0(self, data): """ 輸入指令 """ self.mem[data] = self.get_input() def opcode_1(self, data): """ 清除累加器指令 """ self.acc = self.get_memint(data) def opcode_2(self, data): """ 加法指令 """ self.acc += self.get_memint(data) def opcode_3(self, data): """ 測試累加器內容指令 """ if self.acc < 0: self.pc = data def opcode_4(self, data): """ 位移指令 """ x,y = int(math.floor(data / 10)), int(data % 10) for i in range(0,x): self.acc = (self.acc * 10) % 10000 for i in range(0,y): self.acc = int(math.floor(self.acc / 10)) def opcode_5(self, data): """ 輸出指令 """ self.stdout(self.mem[data]) def opcode_6(self, data): """ 儲存指令 """ self.mem[data] = self.pad(self.acc) def opcode_7(self, data): """ 減法指令 """ self.acc -= self.get_memint(data) def opcode_8(self, data): """ 無條件跳轉指令 """ self.pc = data def opcode_9(self, data): """ 停止/複位指令""" self.reset() def run(self, pc=None): """ 這段代碼會一直運行, 直到遇到 halt/reset 指令才停止. """ if pc: self.pc = pc self.running = True while self.running: self.process() print "Output:\n%s" % self.format_output() self.init_output()class Cardiac(CPU, Memory, IO): passif __name__ == '__main__': c = Cardiac() c.read_deck('deck1.txt') try: c.run() except: print "IR: %s\nPC: %s\nOutput: %s\n" % (c.ir, c.pc, c.format_output()) raise
大家可以從Developing Upwards: CARDIAC: The Cardboard Computer 中找到本文使用的 deck1.txt 的代碼, 我用的是 從 1 計數到 10 的那個例子 .