Merge pull request #5714 from alexischr/update_bockbuild
[mono.git] / mono / mini / helpers.c
1 /**
2  * \file
3  * Assorted routines
4  *
5  * (C) 2003 Ximian, Inc.
6  */
7
8 #include <config.h>
9
10 #include "mini.h"
11 #include <ctype.h>
12 #include <mono/metadata/opcodes.h>
13
14 #ifndef HOST_WIN32
15 #include <unistd.h>
16 #endif
17
18 #ifndef DISABLE_JIT
19
20 #ifndef DISABLE_LOGGING
21
22 #ifdef MINI_OP
23 #undef MINI_OP
24 #endif
25 #ifdef MINI_OP3
26 #undef MINI_OP3
27 #endif
28
29 #ifdef HAVE_ARRAY_ELEM_INIT
30 #define MSGSTRFIELD(line) MSGSTRFIELD1(line)
31 #define MSGSTRFIELD1(line) str##line
32 static const struct msgstr_t {
33 #define MINI_OP(a,b,dest,src1,src2) char MSGSTRFIELD(__LINE__) [sizeof (b)];
34 #define MINI_OP3(a,b,dest,src1,src2,src3) char MSGSTRFIELD(__LINE__) [sizeof (b)];
35 #include "mini-ops.h"
36 #undef MINI_OP
37 #undef MINI_OP3
38 } opstr = {
39 #define MINI_OP(a,b,dest,src1,src2) b,
40 #define MINI_OP3(a,b,dest,src1,src2,src3) b,
41 #include "mini-ops.h"
42 #undef MINI_OP
43 #undef MINI_OP3
44 };
45 static const gint16 opidx [] = {
46 #define MINI_OP(a,b,dest,src1,src2) [a - OP_LOAD] = offsetof (struct msgstr_t, MSGSTRFIELD(__LINE__)),
47 #define MINI_OP3(a,b,dest,src1,src2,src3) [a - OP_LOAD] = offsetof (struct msgstr_t, MSGSTRFIELD(__LINE__)),
48 #include "mini-ops.h"
49 #undef MINI_OP
50 #undef MINI_OP3
51 };
52
53 #else
54
55 #define MINI_OP(a,b,dest,src1,src2) b,
56 #define MINI_OP3(a,b,dest,src1,src2,src3) b,
57 /* keep in sync with the enum in mini.h */
58 static const char* const
59 opnames[] = {
60 #include "mini-ops.h"
61 };
62 #undef MINI_OP
63 #undef MINI_OP3
64
65 #endif
66
67 #endif /* DISABLE_LOGGING */
68
69 #if defined(__i386__) || defined(__x86_64__)
70 #if !defined(TARGET_ARM64) && !defined(__APPLE__)
71 #define emit_debug_info  TRUE
72 #else
73 #define emit_debug_info  FALSE
74 #endif
75 #else
76 #define emit_debug_info  FALSE
77 #endif
78
79 /*This enables us to use the right tooling when building the cross compiler for iOS.*/
80 #if defined (__APPLE__) && defined (TARGET_ARM) && (defined(__i386__) || defined(__x86_64__))
81
82 #define ARCH_PREFIX "/Developer/Platforms/iPhoneOS.platform/Developer/usr/bin/"
83
84 #endif
85
86 #define ARCH_PREFIX ""
87 //#define ARCH_PREFIX "powerpc64-linux-gnu-"
88
89 const char*
90 mono_inst_name (int op) {
91 #ifndef DISABLE_LOGGING
92         if (op >= OP_LOAD && op <= OP_LAST)
93 #ifdef HAVE_ARRAY_ELEM_INIT
94                 return (const char*)&opstr + opidx [op - OP_LOAD];
95 #else
96                 return opnames [op - OP_LOAD];
97 #endif
98         if (op < OP_LOAD)
99                 return mono_opcode_name (op);
100         g_error ("unknown opcode name for %d", op);
101         return NULL;
102 #else
103         g_error ("unknown opcode name for %d", op);
104         g_assert_not_reached ();
105 #endif
106 }
107
108 void
109 mono_blockset_print (MonoCompile *cfg, MonoBitSet *set, const char *name, guint idom) 
110 {
111 #ifndef DISABLE_LOGGING
112         int i;
113
114         if (name)
115                 g_print ("%s:", name);
116         
117         mono_bitset_foreach_bit (set, i, cfg->num_bblocks) {
118                 if (idom == i)
119                         g_print (" [BB%d]", cfg->bblocks [i]->block_num);
120                 else
121                         g_print (" BB%d", cfg->bblocks [i]->block_num);
122                 
123         }
124         g_print ("\n");
125 #endif
126 }
127
128 /**
129  * \param cfg compilation context
130  * \param code a pointer to the code
131  * \param size the code size in bytes
132  *
133  * Disassemble to code to stdout.
134  */
135 void
136 mono_disassemble_code (MonoCompile *cfg, guint8 *code, int size, char *id)
137 {
138 #ifndef DISABLE_LOGGING
139         GHashTable *offset_to_bb_hash = NULL;
140         int i, cindex, bb_num;
141         FILE *ofd;
142 #ifdef HOST_WIN32
143         const char *tmp = g_get_tmp_dir ();
144 #endif
145         char *objdump_args = g_getenv ("MONO_OBJDUMP_ARGS");
146         char *as_file;
147         char *o_file;
148         char *cmd;
149         int unused G_GNUC_UNUSED;
150
151 #ifdef HOST_WIN32
152         as_file = g_strdup_printf ("%s/test.s", tmp);    
153
154         if (!(ofd = fopen (as_file, "w")))
155                 g_assert_not_reached ();
156 #else   
157         i = g_file_open_tmp (NULL, &as_file, NULL);
158         ofd = fdopen (i, "w");
159         g_assert (ofd);
160 #endif
161
162         for (i = 0; id [i]; ++i) {
163                 if (i == 0 && isdigit (id [i]))
164                         fprintf (ofd, "_");
165                 else if (!isalnum (id [i]))
166                         fprintf (ofd, "_");
167                 else
168                         fprintf (ofd, "%c", id [i]);
169         }
170         fprintf (ofd, ":\n");
171
172         if (emit_debug_info && cfg != NULL) {
173                 MonoBasicBlock *bb;
174
175                 fprintf (ofd, ".stabs   \"\",100,0,0,.Ltext0\n");
176                 fprintf (ofd, ".stabs   \"<BB>\",100,0,0,.Ltext0\n");
177                 fprintf (ofd, ".Ltext0:\n");
178
179                 offset_to_bb_hash = g_hash_table_new (NULL, NULL);
180                 for (bb = cfg->bb_entry; bb; bb = bb->next_bb) {
181                         g_hash_table_insert (offset_to_bb_hash, GINT_TO_POINTER (bb->native_offset), GINT_TO_POINTER (bb->block_num + 1));
182                 }
183         }
184
185         cindex = 0;
186         for (i = 0; i < size; ++i) {
187                 if (emit_debug_info && cfg != NULL) {
188                         bb_num = GPOINTER_TO_INT (g_hash_table_lookup (offset_to_bb_hash, GINT_TO_POINTER (i)));
189                         if (bb_num) {
190                                 fprintf (ofd, "\n.stabd 68,0,%d\n", bb_num - 1);
191                                 cindex = 0;
192                         }
193                 }
194                 if (cindex == 0) {
195                         fprintf (ofd, "\n.byte %d", (unsigned int) code [i]);
196                 } else {
197                         fprintf (ofd, ",%d", (unsigned int) code [i]);
198                 }
199                 cindex++;
200                 if (cindex == 64)
201                         cindex = 0;
202         }
203         fprintf (ofd, "\n");
204         fclose (ofd);
205
206 #ifdef __APPLE__
207 #ifdef __ppc64__
208 #define DIS_CMD "otool64 -v -t"
209 #else
210 #define DIS_CMD "otool -v -t"
211 #endif
212 #else
213 #if defined(sparc) && !defined(__GNUC__)
214 #define DIS_CMD "dis"
215 #elif defined(TARGET_X86)
216 #define DIS_CMD "objdump -l -d"
217 #elif defined(TARGET_AMD64)
218   #if defined(HOST_WIN32)
219   #define DIS_CMD "x86_64-w64-mingw32-objdump.exe -M x86-64 -d"
220   #else
221   #define DIS_CMD "objdump -l -d"
222   #endif
223 #else
224 #define DIS_CMD "objdump -d"
225 #endif
226 #endif
227
228 #if defined(sparc)
229 #define AS_CMD "as -xarch=v9"
230 #elif defined (TARGET_X86)
231 #  if defined(__APPLE__)
232 #    define AS_CMD "as -arch i386"
233 #  else
234 #    define AS_CMD "as -gstabs"
235 #  endif
236 #elif defined (TARGET_AMD64)
237 #  if defined (__APPLE__)
238 #    define AS_CMD "as -arch x86_64"
239 #  else
240 #    define AS_CMD "as -gstabs"
241 #  endif
242 #elif defined (TARGET_ARM)
243 #  if defined (__APPLE__)
244 #    define AS_CMD "as -arch arm"
245 #  else
246 #    define AS_CMD "as -gstabs"
247 #  endif
248 #elif defined (TARGET_ARM64)
249 #  if defined (__APPLE__)
250 #    define AS_CMD "clang -c -arch arm64 -g -x assembler"
251 #  else
252 #    define AS_CMD "as -gstabs"
253 #  endif
254 #elif defined(__mips__) && (_MIPS_SIM == _ABIO32)
255 #define AS_CMD "as -mips32"
256 #elif defined(__ppc64__)
257 #define AS_CMD "as -arch ppc64"
258 #elif defined(__powerpc64__)
259 #define AS_CMD "as -mppc64"
260 #else
261 #define AS_CMD "as"
262 #endif
263
264 #ifdef HOST_WIN32
265         o_file = g_strdup_printf ("%s/test.o", tmp);
266 #else   
267         i = g_file_open_tmp (NULL, &o_file, NULL);
268         close (i);
269 #endif
270
271 #ifdef HAVE_SYSTEM
272         cmd = g_strdup_printf (ARCH_PREFIX AS_CMD " %s -o %s", as_file, o_file);
273         unused = system (cmd); 
274         g_free (cmd);
275         if (!objdump_args)
276                 objdump_args = g_strdup ("");
277
278         fflush (stdout);
279
280 #ifdef __arm__
281         /* 
282          * The arm assembler inserts ELF directives instructing objdump to display 
283          * everything as data.
284          */
285         cmd = g_strdup_printf (ARCH_PREFIX "strip -x %s", o_file);
286         unused = system (cmd);
287         g_free (cmd);
288 #endif
289
290         cmd = g_strdup_printf (ARCH_PREFIX DIS_CMD " %s %s", objdump_args, o_file);
291         unused = system (cmd);
292         g_free (cmd);
293         g_free (objdump_args);
294 #else
295         g_assert_not_reached ();
296 #endif /* HAVE_SYSTEM */
297
298 #ifndef HOST_WIN32
299         unlink (o_file);
300         unlink (as_file);
301 #endif
302         g_free (o_file);
303         g_free (as_file);
304 #endif
305 }
306
307 #else /* DISABLE_JIT */
308
309 void
310 mono_blockset_print (MonoCompile *cfg, MonoBitSet *set, const char *name, guint idom)
311 {
312 }
313
314 #endif /* DISABLE_JIT */