sim: added list breakpoints
[calu.git] / 3b_sim / sim.cpp
1 #include <iostream>
2 #include <iomanip>
3 #include <fstream>
4 #include <boost/tokenizer.hpp>
5 #include <boost/program_options.hpp>
6 #include <boost/lexical_cast.hpp>
7 #include <string>
8 #include <map>
9 #include <list>
10
11 #include <boost/function.hpp>
12 #include <boost/functional.hpp>
13 #include <boost/tuple/tuple.hpp>
14
15 #include "disasm.h"
16 #include "ccpu.hpp"
17 #include "CInstrFactory.hpp"
18 #include "uint32_from_hex.hpp"
19
20 #include "SReadline/SReadline.h"
21 using namespace swift;
22
23 #define RAM_END (1000)
24 #define PROG_END (1000)
25 #define REG_COUNT (16)
26
27 typedef boost::function<void (const vector<string> &)> Func;
28 typedef boost::tuple<string, Func, string> CompleterElement;
29
30 typedef list<CompleterElement> MyCompleterContainer;
31
32 class LookupFunctor
33 {
34         public:
35                 // Creates a functor and memorises tokens
36                 LookupFunctor(const vector<string>&  tokens) : Tokens(tokens) {}
37
38                 // Compares the first token only
39                 bool operator()(const CompleterElement& ele) const
40                 {
41                         return (strncmp(Tokens.begin()->c_str(), ele.get<0>().c_str(), Tokens.begin()->size()) == 0);
42                 }
43
44         private:
45                 const vector<string> &Tokens;
46 };
47
48
49
50
51 class CHelpExec
52 {
53         private:
54                 const MyCompleterContainer &m_completers;
55
56         public:
57                 CHelpExec(const MyCompleterContainer &cont) : m_completers(cont) {}
58
59                 void operator() (const vector<string>&)
60                 {
61                         cout << "Available commands: " << endl;
62                         for(auto iter = m_completers.begin(); iter != m_completers.end(); ++iter) {
63                                 cout << setw(15) << (*iter).get<0>() << ": " << (*iter).get<2>() << endl;
64                         }
65                 }
66 };
67
68 void close_prog(const std::vector<std::string> &);
69
70 CCpu* Iinstr::m_cpu;
71
72 CCpu* global_cpu = NULL;
73
74 vector<CDat> breakpoints;
75
76 bool ignoreBreak = false;
77
78 void doExit(const vector<string>&)
79 {
80         exit(EXIT_SUCCESS);
81 }
82
83 unsigned int convertStringToNum(const std::string& in)
84 {
85         if(in.substr(0,2) == "0x") {
86                 return lexical_cast<uint32_from_hex>(in);
87         }
88         else {
89                 return lexical_cast<unsigned int>(in);
90         }
91 }
92
93
94 void execStep(const vector<string>& in)
95 {
96         int count = 1;
97         if(in.size() == 2) {
98                 try {
99                         count = convertStringToNum(in.back());
100                 }
101                 catch(bad_cast&) {
102                         cerr << "given parameter to step is not a number" << endl;
103                 }
104         }
105         while(count > 0) {
106                 try {
107                         auto breakp = find(breakpoints.begin(), breakpoints.end(), global_cpu->getNextPC());
108                         if(breakp == breakpoints.end() || ignoreBreak) {
109                                 global_cpu->tick();
110                                 ignoreBreak = false;
111                         }
112                         else {
113                                 ignoreBreak = true;
114                                 cout << "Breakpoint 0x" << std::hex << setw(8) << setfill('0') << *breakp << std::hex << " hit" << endl;
115                                 break;
116                         }
117                 }
118                 catch(std::string& e) {
119                         cerr << e << endl;
120                 }
121                 count--;
122         }
123 }
124
125 void execRun(const vector<string>&)
126 {
127         while(1) {
128                 try {
129                         auto breakp = find(breakpoints.begin(), breakpoints.end(), global_cpu->getNextPC());
130                         if(breakp == breakpoints.end() || ignoreBreak) {
131                                 global_cpu->tick();
132                                 ignoreBreak = false;
133                         }
134                         else {
135                                 ignoreBreak = true;
136                                 cout << "Breakpoint 0x" << std::hex << setw(8) << setfill('0') << *breakp << std::hex << " hit" << endl;
137                                 return;
138                         }
139                 }
140                 catch(std::string& e) {
141                         cerr << e << endl;
142                         return;
143                 }
144         }
145 }
146
147 void setPC(const vector<string>& in)
148 {
149         CDat addr = 0;
150         if(in.size() == 2) {
151                 try {
152                         addr = convertStringToNum(in.back());
153                 }
154                 catch(bad_cast&) {
155                         cerr << "given parameter is not a number" << endl;
156                         return;
157                 }
158         }
159         global_cpu->setNextPC(addr);
160         cout << "Set programcounter to 0x" << std::hex << setw(8) << setfill('0') << addr << std::dec << endl;
161 }
162
163
164 void printReg(const vector<string>& in)
165 {
166         int i, start = 0, end = REG_COUNT-1;
167         /* Todo: 
168          * 1) make 2 columns
169          */
170
171         if(in.size() >= 2) {
172                 try {
173                         start = convertStringToNum(in[1]);
174                         if(start < 0 || start > (REG_COUNT-1)) {
175                                 cerr << "start is out of range" << endl;
176                                 return;
177                         }
178                         end = start;
179                 }
180                 catch(bad_cast&) {
181                         cerr << "given parameter is not a number" << endl;
182                         return;
183                 }
184         }
185
186         if(in.size() >= 3) {
187                 try {
188                         end = convertStringToNum(in[2]);
189                         if(start > end || end > (REG_COUNT-1)) {
190                                 cerr << "end is out of range or smaller than start" << endl;
191                                 return;
192                         }
193                 }
194                 catch(bad_cast&) {
195                         cerr << "given parameter is not a number" << endl;
196                         return;
197                 }
198         }
199         
200         for(i = start; i <= end; i++) {
201                 cout << setw(2) << setfill('0') << i << ": 0x" << std::hex << setw(8) << setfill('0') << global_cpu->getRegister(i) << " " << std::dec << setw(10) << setfill(' ') << global_cpu->getRegister(i) << endl;
202         }
203 }
204
205 void printRAM(const vector<string>& in)
206 {
207         int i, start = 0, end = 15;
208         /* Todo: 
209          * 1) make 2 columns
210          */
211
212         if(in.size() >= 2) {
213                 try {
214                         start = convertStringToNum(in[1]);
215                         if(start < 0 || start > (RAM_END-1)) {
216                                 cerr << "start is out of range" << endl;
217                                 return;
218                         }
219                         start = (start & (~(BYTE_COUNT-1))) / BYTE_COUNT;
220                         end = start;
221                 }
222                 catch(bad_cast&) {
223                         cerr << "given parameter is not a number" << endl;
224                         return;
225                 }
226         }
227
228         if(in.size() >= 3) {
229                 try {
230                         end = convertStringToNum(in[2]);
231                         if(start > end || end > (RAM_END-1)) {
232                                 cerr << "end is out of range or smaller than start" << endl;
233                                 return;
234                         }
235                         if(end % BYTE_COUNT != 0) {
236                                 end = ((end & (~(BYTE_COUNT-1))) / BYTE_COUNT)+1;
237                         }
238                         else {
239                                 end = ((end & (~(BYTE_COUNT-1))) / BYTE_COUNT);
240                         }
241                 }
242                 catch(bad_cast&) {
243                         cerr << "given parameter is not a number" << endl;
244                         return;
245                 }
246         }
247         for(i = start*BYTE_COUNT; i <= end*BYTE_COUNT; i += BYTE_COUNT) {
248                 cout << std::hex << "0x" << setw(8) << setfill('0') << i << ": 0x" << std::hex << setw(8) << setfill('0') << global_cpu->getRAM(i) << " " << std::dec << setw(10) << setfill(' ') << global_cpu->getRAM(i) << endl;
249         }
250 }
251
252 void printPROG(const vector<string>& in)
253 {
254         int i, start = 0, end = 15;
255         /* Todo: 
256          * 1) make 2 columns
257          */
258
259         if(in.size() >= 2) {
260                 try {
261                         start = convertStringToNum(in[1]);
262                         if(start < 0 || start > (PROG_END-1)) {
263                                 cerr << "start is out of range" << endl;
264                                 return;
265                         }
266                         start = (start & (~(BYTE_COUNT-1))) / BYTE_COUNT;
267                         end = start;
268                 }
269                 catch(bad_cast&) {
270                         cerr << "given parameter is not a number" << endl;
271                         return;
272                 }
273         }
274
275         if(in.size() >= 3) {
276                 try {
277                         end = convertStringToNum(in[2]);
278                         if(start > end || end > (PROG_END-1)) {
279                                 cerr << "end is out of range or smaller than start" << endl;
280                                 return;
281                         }
282                         if(end % BYTE_COUNT != 0) {
283                                 end = ((end & (~(BYTE_COUNT-1))) / BYTE_COUNT)+1;
284                         }
285                         else {
286                                 end = ((end & (~(BYTE_COUNT-1))) / BYTE_COUNT);
287                         }
288
289                 }
290                 catch(bad_cast&) {
291                         cerr << "given parameter is not a number" << endl;
292                         return;
293                 }
294         }
295         
296         for(i = start*BYTE_COUNT; i <= end*BYTE_COUNT; i += BYTE_COUNT) {
297                 Iinstr* pi = global_cpu->getProg(i);
298                 if(pi == NULL) {
299                         cout << std::hex << "0x" << setw(8) << setfill('0') << i << ": NOP" << endl;
300                 }
301                 else {
302                         cout << std::hex << "0x" << setw(8) << setfill('0') << i << ": " << std::dec << pi->toString() << endl;
303                 }
304         }
305 }
306
307 void setBreak(const vector<string>& in)
308 {
309         unsigned int addr = 0;
310         if(in.size() == 2) {
311                 try {
312                         addr = convertStringToNum(in.back());
313                         breakpoints.push_back(addr);
314                         cout << "Breakpoint 0x" << std::hex << setw(8) << setfill('0') << addr << std::dec << " set" << endl;
315                 }
316                 catch(bad_cast&) {
317                         cerr << "Given parameter is not a valid address" << endl;
318                 }
319         }
320         else {
321                 cerr << "Invalid parameter count!" << endl;
322         }
323 }
324
325 void listBreaks(const vector<string>&)
326 {
327         for(auto iter = breakpoints.begin(); iter != breakpoints.end(); ++iter) {
328                 cout << "Breakpoint at 0x" << std::hex << setw(8) << setfill('0') << *iter << std::dec << endl;
329         }
330 }
331
332 void printStatus(const vector<string>&)
333 {
334         CDat stackp = global_cpu->getStack();
335         CDat stackd = global_cpu->getRAM(stackp);
336         cout << "Stack pointer: " << stackp << " @stackpointer: " << stackd << endl;
337         cout << "PSW: 0x" << std::hex << setw(8) << setfill('0') << global_cpu->getFlags() << std::dec << endl;
338         cout << "cur PC: 0x" << std::hex << setw(8) << setfill('0') << global_cpu->getCurPC() << " next PC: 0x" << setw(8) << setfill('0') << global_cpu->getNextPC() << std::dec << endl;
339
340 }
341
342 using boost::lexical_cast;
343 using boost::bad_lexical_cast;
344
345 using namespace std;
346
347 using namespace boost::program_options;
348 namespace po = boost::program_options;
349
350 std::string progName;
351
352 int main(int argc, char* argv[])
353 {
354         progName = argv[0];
355         ifstream inFile;
356         try {
357                 po::options_description desc("Allowed options");
358                 desc.add_options()
359                 ("help,h","produce help message")
360                 ("file,f",value<string>(), "input file")
361                 ;
362
363                 po::positional_options_description p;
364                 p.add("file",1);
365
366                 po::variables_map vm;
367                 po::store(po::command_line_parser(argc, argv).options(desc).positional(p).run(), vm);
368                 po::notify(vm);
369
370                 if(vm.count("help")) {
371                         cout << desc << endl;
372                         return EXIT_FAILURE;
373                 }
374
375                 if(vm.count("file")) {
376 #ifdef DEBUG 
377                         cout << "going to open file " << vm["file"].as<string>() << endl;
378 #endif
379                         inFile.open(vm["file"].as<string>(), ios::in);
380                         if(!inFile) {
381                                 cerr << "Error opening file " << vm["file"].as<string>() << endl;
382                                 return EXIT_FAILURE;
383                         }
384                 }
385                 else {
386                         cout << "not input file given!" << endl << endl;
387                         cout << desc << endl;
388                         return EXIT_FAILURE;
389                 }
390         }
391         catch(std::exception& ex) {
392                 cout << ex.what() << endl;
393         }
394
395
396         string dir = "./instr/";
397
398         map<short, Iinstr*> instr;
399
400         CInstrFactory instrFab;
401         try {
402                 instrFab.loadLibsIntoMap(instr, dir);
403         }
404         catch(std::bad_alloc& e) {
405                 cerr << progName << ": bad_alloc caught " << e.what() << endl;
406                 exit(EXIT_FAILURE); 
407         }
408         catch(std::string& s) {
409                 cerr << progName << ": " << s << endl;
410                 exit(EXIT_FAILURE);
411         }
412
413         CCpu cpu(REG_COUNT, RAM_END, PROG_END);
414
415         global_cpu = &cpu;
416
417         Iinstr::setCPU(&cpu);
418
419
420         std::string str = "";
421         int addr = 0;
422         boost::char_separator<char> sep(";", "", boost::keep_empty_tokens);
423         boost::tokenizer<boost::char_separator<char> > tokens(str, sep);
424         disasm disasm(instr);
425         while(getline(inFile, str)) {
426                 int count = 0;
427                 tokens.assign(str);
428                 stringstream out;
429                 int type = 0;
430                 for(auto tok_iter = tokens.begin(); tok_iter != tokens.end(); ++tok_iter) {
431                         if(tok_iter == tokens.begin()) {
432                                 try {
433                                         type = lexical_cast<int>(*tok_iter);
434                                         count++;
435                                         continue;
436                                 }
437                                 catch(bad_lexical_cast &) {
438                                         break;
439                                 }
440                                 cout << endl;
441                         }
442                         switch(type) {
443                                 case 0:
444                                         if(count == 1) {
445                                                 try {
446                                                         addr = lexical_cast<uint32_from_hex>(*tok_iter);
447                                                 }
448                                                 catch(bad_lexical_cast& e) {
449                                                         cerr << e.what() << endl;
450                                                         exit(EXIT_FAILURE);
451                                                 }
452                                         }
453                                         else if(count == 2) {
454                                                 try {
455                                                         CDat data = lexical_cast<uint32_from_hex>(*tok_iter);
456                                                         cpu.setRAM(addr, data);
457                                                 }
458                                                 catch(bad_lexical_cast& e) {
459                                                         cerr << e.what() << endl;
460                                                         exit(EXIT_FAILURE);
461                                                 }
462                                         }
463                                         break;
464                                 case 1:
465                                         if(count == 1) {
466                                                 try {
467                                                         addr = lexical_cast<uint32_from_hex>(*tok_iter);
468                                                 }
469                                                 catch(bad_lexical_cast& e) {
470                                                         cerr << e.what() << endl;
471                                                         exit(EXIT_FAILURE);
472                                                 }
473                                         }
474                                         else if(count == 2) {
475                                                 Iinstr *pi = disasm.decode(*tok_iter);
476                                                 cpu.setProg(addr, pi);
477                                         }
478                                         break;
479                                 case 2:
480                                 case 3:
481                                         cerr << "ignoring labels and comments for now" << endl;
482                                         break;
483                                 default:
484                                         cerr << "i was to lazy to implement the other format types for now" << endl;
485                         }
486                         count++;
487                 }
488         }
489         inFile.close();
490
491         cout << endl;
492
493 /*
494         for(int i = 0; i <= 32; i += 4) {
495                 Iinstr *pinstr = cpu.getProg(i);
496                 if(pinstr != NULL) {
497                         cout << i << " : " << std::hex << i << std::dec << " " << pinstr->toString() << endl;
498                 }
499                 else {
500                         cout << "Null at " << i << " : " << std::hex << i << endl;
501                 }
502         }
503
504         for(int i = 0; i <= 32; i += 4) {
505                 CDat data = cpu.getRAM(i);
506                 cout << i << " : " << std::hex << i << std::dec << " " << data << endl;
507         }
508 */
509         cpu.setRegister(1, 4);
510         cpu.setRegister(2, 0);
511         cpu.setRAM(0,5);
512         cpu.setRAM(4,50);
513         cpu.setRAM(8,32);
514         cpu.setRAM(12,45);
515
516         // following: job of the bootloader
517         //set stackpointer
518         cpu.setStack(500);
519         //set return to nowhere for ret
520         cpu.setRAM(500,50);
521
522         SReadline Reader;
523
524         MyCompleterContainer Completers;
525
526         CHelpExec HelpExec(Completers);
527
528         Completers.push_back(CompleterElement("help", boost::bind1st( boost::mem_fun( &CHelpExec::operator()), &HelpExec), "Prints this message"));
529         Completers.push_back(CompleterElement("quit", &doExit, "Exits program"));
530         Completers.push_back(CompleterElement("exit", &doExit, "Exits program"));
531         Completers.push_back(CompleterElement("step [count]",&execStep, "Runs [count] ticks. if count is not given one tick is executed."));
532         Completers.push_back(CompleterElement("dreg [s] [e]",&printReg, "Prints registers. if s is given, only register s is printed. if s and e are given the registers from s to e are printed. if omitted all registers a printed."));
533         Completers.push_back(CompleterElement("ddata [s] [e]",&printRAM, "Prints RAM. if s is given, only RAM-Addr. s is printed. if s and e are given the RAM-Addrs from s to e are printed. if omitted the first 16 RAM-Addrs are printed."));
534         Completers.push_back(CompleterElement("dprog [s] [e]",&printPROG, "Prints program. if s is given, only Prog-Addr. s is printed. if s and e are given the Prog-Addrs from s to e are printed. if omitted the first 16 Prog-Addrs are printed."));
535         Completers.push_back(CompleterElement("break addr",&setBreak, "Sets a breakpoint for address addr."));
536         Completers.push_back(CompleterElement("listbreaks",&listBreaks, "Lists all breakpoints."));
537         Completers.push_back(CompleterElement("run",&execRun, "Runs till next breakpoint or end of program."));
538         Completers.push_back(CompleterElement("setpc [num]",&setPC, "Sets PC to num. if num is omitted 0 is used."));
539         Completers.push_back(CompleterElement("status",&printStatus, "Prints status of CPU."));
540
541         Reader.RegisterCompletions(Completers);
542
543         string UserInput;
544         vector<string> Tokens, lastTokens;
545         bool EndOfInput = false;
546
547         auto Found(Completers.end());
548
549         Func lastFunc = NULL;
550
551
552         while(1) {
553                 UserInput = Reader.GetLine("> ", Tokens, EndOfInput);
554                 if(EndOfInput) {
555                         break;
556                 }
557
558                 if(!Tokens.empty()) {
559                         Found = find_if(Completers.begin(), Completers.end(), LookupFunctor(Tokens));
560
561                         if(Found != Completers.end()) {
562                                 if((*Found).get<1>() != 0) {
563                                         lastFunc = (*Found).get<1>();
564                                         lastFunc(Tokens);
565                                         lastTokens = Tokens;
566                                         //(*Found).get<1>()(Tokens);
567                                 }
568                         }
569                         else {
570                                 lastFunc = NULL;
571                                 cout << "Unknown command. 'help' displays help" << endl;
572                         }
573                 }
574                 else {
575                         if(lastFunc != NULL) {
576                                 lastFunc(lastTokens);
577                         }
578                         else {
579                                 cout << "Unknown command. 'help' displays help" << endl;
580                         }
581                 }
582         }
583
584
585 /*
586         for(int i = 0; ; i++) {
587                 try {
588                         cpu.tick();
589                         cout << " reg0: " << cpu.getRegister(0) <<  " reg1: " << cpu.getRegister(1);
590                         cout << " reg2: " << cpu.getRegister(2) <<  " reg3: " << cpu.getRegister(3);
591                         cout << " reg4: " << cpu.getRegister(4) <<  " reg5: " << cpu.getRegister(5);
592                         cout << endl << endl;
593
594                 }
595                 catch(string& e) {
596                         cerr << e << endl;
597                         break;
598                 }
599         }
600 */
601         return EXIT_SUCCESS;
602 }