mono/mini/genmdesc.c

   1 /*
   2  * genmdesc: Generates the machine description
   3  *
   4  * Authors:
   5  *   Paolo Molaro (lupus@ximian.com)
   6  *
   7  * (C) 2003 Ximian, Inc.
   8  */
   9 #include "mini.h"
  10 #include <ctype.h>
  11 #include <string.h>
  12 #include <mono/metadata/opcodes.h>
  13
  14 #if defined(__native_client__) || defined(__native_client_codegen__)
  15 volatile int __nacl_thread_suspension_needed = 0;
  16 void __nacl_suspend_thread_if_needed() {}
  17 #endif
  18
  19 #define MINI_OP(a,b,dest,src1,src2) b,
  20 #define MINI_OP3(a,b,dest,src1,src2,src3) b,
  21 /* keep in sync with the enum in mini.h */
  22 static const char* const
  23 opnames[] = {
  24 #include "mini-ops.h"
  25 };
  26 #undef MINI_OP
  27 #undef MINI_OP3
  28
  29 /*
  30  * Duplicate this from helpers.c, so the opcode name array can be omitted when
  31  * DISABLE_JIT is set.
  32  */
  33 static const char*
  34 inst_name (int op) {
  35         if (op >= OP_LOAD && op <= OP_LAST)
  36                 return opnames [op - OP_LOAD];
  37         if (op < OP_LOAD)
  38                 return mono_opcode_name (op);
  39         g_error ("unknown opcode name for %d", op);
  40         return NULL;
  41 }
  42
  43 typedef struct {
  44         int num;
  45         const char *name;
  46         char *desc;
  47         char *comment;
  48         char spec [MONO_INST_MAX];
  49 } OpDesc;
  50
  51 static int nacl = 0;
  52 static GHashTable *table;
  53 static GHashTable *template_table;
  54
  55 #define eat_whitespace(s) while (*(s) && isspace (*(s))) s++;
  56
  57 static int
  58 load_file (const char *name) {
  59         FILE *f;
  60         char buf [256];
  61         char *str, *p;
  62         int line;
  63         OpDesc *desc;
  64         GString *comment;
  65
  66         if (!(f = fopen (name, "r")))
  67                 g_error ("Cannot open file '%s'", name);
  68
  69         comment = g_string_new ("");
  70         /*
  71          * The format of the lines are:
  72          * # comment
  73          * opcode: [dest:format] [src1:format] [src2:format] [flags:format] [clob:format]
  74          *      [cost:num] [res:format] [delay:num] [len:num] [nacl:num]
  75          * format is a single letter that depends on the field
  76          * NOTE: no space between the field name and the ':'
  77          *
  78          * len: maximum instruction length
  79          */
  80         line = 0;
  81         while ((str = fgets (buf, sizeof (buf), f))) {
  82                 gboolean is_template = FALSE;
  83                 gboolean nacl_length_set = FALSE;
  84
  85                 ++line;
  86                 eat_whitespace (str);
  87                 if (!str [0])
  88                         continue;
  89                 if (str [0] == '#') {
  90                         g_string_append (comment, str);
  91                         continue;
  92                 }
  93                 p = strchr (str, ':');
  94                 if (!p)
  95                         g_error ("Invalid format at line %d in %s\n", line, name);
  96                 *p++ = 0;
  97                 eat_whitespace (p);
  98                 if (strcmp (str, "template") == 0) {
  99                         is_template = TRUE;
 100                         desc = g_new0 (OpDesc, 1);
 101                 } else {
 102                         desc = g_hash_table_lookup (table, str);
 103                         if (!desc)
 104                                 g_error ("Invalid opcode '%s' at line %d in %s\n", str, line, name);
 105                         if (desc->desc)
 106                                 g_error ("Duplicated opcode %s at line %d in %s\n", str, line, name);
 107                 }
 108                 desc->desc = g_strdup (p);
 109                 desc->comment = g_strdup (comment->str);
 110                 g_string_truncate (comment, 0);
 111                 while (*p) {
 112                         if (strncmp (p, "dest:", 5) == 0) {
 113                                 desc->spec [MONO_INST_DEST] = p [5];
 114                                 p += 6;
 115                         } else if (strncmp (p, "src1:", 5) == 0) {
 116                                 desc->spec [MONO_INST_SRC1] = p [5];
 117                                 p += 6;
 118                         } else if (strncmp (p, "src2:", 5) == 0) {
 119                                 desc->spec [MONO_INST_SRC2] = p [5];
 120                                 p += 6;
 121                         } else if (strncmp (p, "src3:", 5) == 0) {
 122                                 desc->spec [MONO_INST_SRC3] = p [5];
 123                                 p += 6;
 124                         } else if (strncmp (p, "clob:", 5) == 0) {
 125                                 desc->spec [MONO_INST_CLOB] = p [5];
 126                                 p += 6;
 127                                 /* Currently unused fields
 128                         } else if (strncmp (p, "cost:", 5) == 0) {
 129                                 desc->spec [MONO_INST_COST] = p [5];
 130                                 p += 6;
 131                         } else if (strncmp (p, "res:", 4) == 0) {
 132                                 desc->spec [MONO_INST_RES] = p [4];
 133                                 p += 5;
 134                         } else if (strncmp (p, "flags:", 6) == 0) {
 135                                 desc->spec [MONO_INST_FLAGS] = p [6];
 136                                 p += 7;
 137                         } else if (strncmp (p, "delay:", 6) == 0) {
 138                                 desc->spec [MONO_INST_DELAY] = p [6];
 139                                 p += 7;
 140                                 */
 141                         } else if (strncmp (p, "len:", 4) == 0) {
 142                                 unsigned long size;
 143                                 p += 4;
 144                                 size = strtoul (p, &p, 10);
 145                                 if (!nacl_length_set) {
 146                                         desc->spec [MONO_INST_LEN] = size;
 147                                 }
 148                         } else if (strncmp (p, "nacl:", 5) == 0) {
 149                                 unsigned long size;
 150                                 p += 5;
 151                                 size = strtoul (p, &p, 10);
 152                                 if (nacl) {
 153                                         desc->spec [MONO_INST_LEN] = size;
 154                                         nacl_length_set = TRUE;
 155                                 }
 156                         } else if (strncmp (p, "template:", 9) == 0) {
 157                                 char *tname;
 158                                 int i;
 159                                 OpDesc *tdesc;
 160                                 p += 9;
 161                                 tname = p;
 162                                 while (*p && isalnum (*p)) ++p;
 163                                 *p++ = 0;
 164                                 tdesc = g_hash_table_lookup (template_table, tname);
 165                                 if (!tdesc)
 166                                         g_error ("Invalid template name %s at '%s' at line %d in %s\n", tname, p, line, name);
 167                                 for (i = 0; i < MONO_INST_MAX; ++i) {
 168                                         if (desc->spec [i])
 169                                                 g_error ("The template overrides any previous value set at line %d in %s\n", line, name);
 170                                 }
 171                                 memcpy (desc->spec, tdesc->spec, sizeof (desc->spec));
 172                         } else if (strncmp (p, "name:", 5) == 0) {
 173                                 char *tname;
 174                                 if (!is_template)
 175                                         g_error ("name tag only valid in templates at '%s' at line %d in %s\n", p, line, name);
 176                                 if (desc->name)
 177                                         g_error ("Duplicated name tag in template %s at '%s' at line %d in %s\n", desc->name, p, line, name);
 178                                 p += 5;
 179                                 tname = p;
 180                                 while (*p && isalnum (*p)) ++p;
 181                                 *p++ = 0;
 182                                 if (g_hash_table_lookup (template_table, tname))
 183                                         g_error ("Duplicated template %s at line %d in %s\n", tname, line, name);
 184                                 desc->name = g_strdup (tname);
 185                                 g_hash_table_insert (template_table, (void*)desc->name, desc);
 186                         } else {
 187                                 g_error ("Parse error at '%s' at line %d in %s\n", p, line, name);
 188                         }
 189                         eat_whitespace (p);
 190                 }
 191                 if (is_template && !desc->name)
 192                         g_error ("Template without name at line %d in %s\n", line, name);
 193         }
 194         fclose (f);
 195         return 0;
 196 }
 197
 198 static OpDesc *opcodes = NULL;
 199
 200 static void
 201 init_table (void) {
 202         int i;
 203         OpDesc *desc;
 204
 205         template_table = g_hash_table_new (g_str_hash, g_str_equal);
 206         table = g_hash_table_new (g_str_hash, g_str_equal);
 207
 208         opcodes = g_new0 (OpDesc, OP_LAST);
 209         for (i = OP_LOAD; i < OP_LAST; ++i) {
 210                 desc = opcodes + i;
 211                 desc->num = i;
 212                 desc->name = inst_name (i);
 213                 g_hash_table_insert (table, (char *)desc->name, desc);
 214         }
 215 }
 216
 217 static void
 218 output_char (FILE *f, char c) {
 219         if (isalnum (c))
 220                 fprintf (f, "%c", c);
 221         else
 222                 fprintf (f, "\\x%x\" \"", c);
 223 }
 224
 225 static void
 226 build_table (const char *fname, const char *name) {
 227         FILE *f;
 228         int i, j, idx;
 229         OpDesc *desc;
 230         GString *idx_array =  g_string_new ("");
 231         /* use this to remove duplicates */
 232         GHashTable *desc_ht = g_hash_table_new (g_str_hash, g_str_equal);
 233
 234         if (!(f = fopen (fname, "w")))
 235                 g_error ("Cannot open file '%s'", fname);
 236         fprintf (f, "/* File automatically generated by genmdesc, don't change */\n\n");
 237         fprintf (f, "const char %s [] = {\n", name);
 238         fprintf (f, "\t\"");
 239         for (j = 0; j < MONO_INST_MAX; ++j)
 240                 fprintf (f, "\\x0");
 241         fprintf (f, "\"\t/* null entry */\n");
 242         idx = 1;
 243         g_string_append_printf (idx_array, "const guint16 %s_idx [] = {\n", name);
 244
 245         for (i = OP_LOAD; i < OP_LAST; ++i) {
 246                 desc = opcodes + i;
 247                 if (!desc->desc)
 248                         g_string_append_printf (idx_array, "\t0,\t/* %s */\n", desc->name ? desc->name : "");
 249                 else {
 250                         fprintf (f, "\t\"");
 251                         for (j = 0; j < MONO_INST_MAX; ++j)
 252                                 output_char (f, desc->spec [j]);
 253                         fprintf (f, "\"\t/* %s */\n", desc->name);
 254                         g_string_append_printf (idx_array, "\t%d,\t/* %s */\n", idx * MONO_INST_MAX, desc->name);
 255                         ++idx;
 256                 }
 257         }
 258         fprintf (f, "};\n\n");
 259         fprintf (f, "%s};\n\n", idx_array->str);
 260         fclose (f);
 261         g_string_free (idx_array, TRUE);
 262         g_hash_table_destroy (desc_ht);
 263 }
 264
 265 static void
 266 dump (void) {
 267         int i;
 268         OpDesc *desc;
 269
 270         for (i = 0; i < MONO_CEE_LAST; ++i) {
 271                 desc = opcodes + i;
 272                 if (desc->comment)
 273                         g_print ("%s", desc->comment);
 274                 if (!desc->desc)
 275                         g_print ("%s:\n", desc->name);
 276                 else {
 277                         g_print ("%s: %s", desc->name, desc->desc);
 278                         if (!strchr (desc->desc, '\n'))
 279                                 g_print ("\n");
 280                 }
 281         }
 282         for (i = OP_LOAD; i < OP_LAST; ++i) {
 283                 desc = opcodes + i;
 284                 if (!desc->desc)
 285                         g_print ("%s:\n", desc->name);
 286                 else {
 287                         g_print ("%s: %s", desc->name, desc->desc);
 288                         if (!strchr (desc->desc, '\n'))
 289                                 g_print ("\n");
 290                 }
 291         }
 292 }
 293
 294 /*
 295  * TODO: output the table (possibly merged), in the input format
 296  */
 297 int
 298 main (int argc, char* argv [])
 299 {
 300         init_table ();
 301         if (argc == 2) {
 302                 /* useful to get a new file when some opcodes are added: looses the comments, though */
 303                 load_file (argv [1]);
 304                 dump ();
 305         } else if (argc < 4) {
 306                 g_print ("Usage: genmdesc arguments\n");
 307                 g_print ("\tgenmdesc desc     Output to stdout the description file.\n");
 308                 g_print ("\tgenmdesc [--nacl] output name desc [desc1...]\n"
 309                         "                     Write to output the description in a table named 'name',\n"
 310                         "                     use --nacl to generate Google NativeClient code\n");
 311                 return 1;
 312         } else {
 313                 int i = 3;
 314                 if (strcmp (argv [1], "--nacl") == 0) {
 315                         nacl = 1;
 316                         i++;
 317                 }
 318
 319                 for (; i < argc; ++i)
 320                         load_file (argv [i]);
 321
 322                 build_table (argv [1 + nacl], argv [2 + nacl]);
 323         }
 324         return 0;
 325 }
 326