include/struct.h

   1 #ifndef YACASL2_CASL2_INCLUDED
   2 #define YACASL2_CASL2_INCLUDED
   3
   4 #include <stdio.h>
   5 #include <assert.h>
   6 #include <string.h>
   7 #include <time.h>
   8 #include "word.h"
   9 #include "cmem.h"
  10 #include "hash.h"
  11
  12 /**
  13  * @brief COMET IIの規格値
  14  */
  15 enum {
  16     CMDSIZE = 4,              /**<命令の最大文字数 */
  17     GRSIZE = 8,               /**<汎用レジスタの数。COMET II規格では、8（0から7） */
  18     DEFAULT_MEMSIZE = 512,    /**<デフォルトのメモリ容量。COMET II規格では、65535語（word） */
  19     DEFAULT_CLOCKS = 5000000, /**<デフォルトのクロック周波数。COMET II規格では、未定義 */
  20 };
  21
  22 /**
  23  * @brief COMET II フラグのマスク値
  24  */
  25 enum {
  26     OF = 0x4,    /**<Overflow Flag */
  27     SF = 0x2,    /**<Sign Flag */
  28     ZF = 0x1,    /**<Zero Flag */
  29 };
  30
  31 /**
  32  * @brief COMET IIのCPUを表すデータ型
  33  */
  34 typedef struct {
  35     WORD gr[GRSIZE]; /**<汎用レジスタ */
  36     WORD sp;         /**<スタックポインタ */
  37     WORD pr;         /**<プログラムレジスタ */
  38     WORD fr;         /**<フラグレジスタ */
  39 } CPU;
  40
  41 /**
  42  * @brief COMET IIの仮想実行マシンシステムを表すデータ型
  43  */
  44 typedef struct {
  45     CPU *cpu;        /**<CPU */
  46     WORD *memory;    /**<メモリ */
  47     int memsize;     /**<メモリサイズ */
  48     clock_t clocks;  /**<クロック周波数 */
  49 } SYSTEM;
  50
  51 /**
  52  * @brief COMET IIの仮想実行マシンシステム
  53  */
  54 extern SYSTEM *sys;
  55
  56 /**
  57  * 命令ハッシュ表のハッシュの種類
  58  */
  59 typedef enum {
  60     HASH_CMDTYPE = 0,
  61     HASH_CODE = 1,
  62 } CMDTAB_HASH;
  63
  64 /**
  65  * COMET II 命令
  66  * 命令タイプは、オペランドにより5種類に分類
  67  */
  68 typedef enum {
  69     /**
  70      *  オペランド数2または3
  71      *  - 第1オペランド: 汎用レジスタ。必須
  72      *  - 第2オペランド: アドレス。必須
  73      *  - 第3オペランド: 指標レジスタとして用いる汎用レジスタ。任意
  74      */
  75     R_ADR_X = 01,
  76     /**
  77      *  オペランド数2
  78      *  - 第1オペランド: 汎用レジスタ。必須
  79      *  - 第2オペランド: 汎用レジスタ。必須
  80      */
  81     R1_R2 = 02,
  82     /**
  83      * オペランド数1または2
  84      * - 第1オペランド: アドレス。必須
  85      * - 第2オペランド: 指標レジスタとして用いる汎用レジスタ。任意
  86      */
  87     ADR_X = 03,
  88     /**
  89      * オペランド数1
  90      * - 第1オペランド: 汎用レジスタ。必須
  91      */
  92     R_ = 04,
  93     /**
  94      * オペランドなし
  95      */
  96     NONE = 0,
  97 } CMDTYPE;
  98
  99 /**
 100  * 命令コード表の項目
 101  */
 102 typedef struct {
 103     char *name;                 /**<命令名 */
 104     const void (*ptr);          /**<命令の関数ポインタ */
 105 } CMD;
 106
 107 /**
 108  * COMET II命令コード表の項目
 109  */
 110 typedef struct {
 111     char *name;                 /**<命令名 */
 112     CMDTYPE type;               /**<命令タイプ */
 113     WORD code;                  /**<命令コード */
 114     const void (*ptr);          /**<命令の関数ポインタ */
 115 } COMET2CMD;
 116
 117 /**
 118  * 命令コードのハッシュ表
 119  */
 120 typedef struct _CMDTAB {
 121     struct _CMDTAB *next;       /**<リスト次項目へのポインタ */
 122     const COMET2CMD *cmd;       /**<命令コード表の項目 */
 123 } CMDTAB;
 124
 125 /**
 126  * プログラム実行時の開始と終了のアドレス
 127  */
 128 typedef struct {
 129     WORD start;   /**<開始アドレス */
 130     WORD end;     /**<終了アドレス */
 131     bool stop;    /**<終了フラグ */
 132 } EXECPTR;
 133
 134 extern EXECPTR *execptr;
 135
 136 /**
 137  * @brief 汎用レジスタの番号からレジスタを表す文字列を返す
 138  *
 139  * @return 汎用レジスタを表す文字列。「GR0」「GR1」・・・「GR7」のいずれか
 140  *
 141  * @param word レジスタ番号[0-7]を表すWORD値
 142  */
 143 char *grstr(WORD word);
 144
 145 /**
 146  * COMET II仮想マシンのリセット
 147  */
 148 void reset(int memsize, int clocks);
 149
 150 /**
 151  * COMET II仮想マシンのシャットダウン
 152  */
 153 void shutdown();
 154
 155 /**
 156  * @brief 命令ハッシュ表を作成する
 157  *
 158  * @return なし
 159  *
 160  * @param hash ハッシュ値
 161  */
 162 bool create_cmdtable(CMDTAB_HASH hash);
 163
 164 /**
 165  * 命令の名前とタイプから、命令コードを返す
 166  * 無効な場合は0xFFFFを返す
 167  */
 168 WORD getcmdcode(const char *cmd, CMDTYPE type);
 169
 170 /**
 171  * 命令ハッシュ表を解放する
 172  */
 173 void free_cmdtable();
 174
 175 /**
 176  * コードがキーの命令ハッシュ表を作成する
 177  */
 178 bool create_code_cmdtype();
 179
 180 /**
 181  * 命令コードから命令の関数ポインタを返す
 182  */
 183 const void (*getcmdptr(WORD code));
 184
 185 /**
 186  * 命令コードから命令のタイプを返す
 187  */
 188 CMDTYPE getcmdtype(WORD code);
 189
 190 /**
 191  * 命令コードから命令の名前を返す
 192  */
 193 char *getcmdname(WORD code);
 194
 195 #endif            /* YACASL2_CASL2_INCLUDEDの終端 */