* stacktrace_print_trace: Added.
[cacao.git] / src / cacaoh / headers.c
1 /* src/cacaoh/headers.c - functions for header generation
2
3    Copyright (C) 1996-2005 R. Grafl, A. Krall, C. Kruegel, C. Oates,
4    R. Obermaisser, M. Platter, M. Probst, S. Ring, E. Steiner,
5    C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich, J. Wenninger,
6    Institut f. Computersprachen - TU Wien
7
8    This file is part of CACAO.
9
10    This program is free software; you can redistribute it and/or
11    modify it under the terms of the GNU General Public License as
12    published by the Free Software Foundation; either version 2, or (at
13    your option) any later version.
14
15    This program is distributed in the hope that it will be useful, but
16    WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18    General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with this program; if not, write to the Free Software
22    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
23    02111-1307, USA.
24
25    Contact: cacao@complang.tuwien.ac.at
26
27    Authors: Reinhard Grafl
28
29    Changes: Mark Probst
30             Philipp Tomsich
31             Christian Thalinger
32
33    $Id: headers.c 3413 2005-10-12 13:06:22Z twisti $
34
35 */
36
37
38 #include <assert.h>
39 #include <ctype.h>
40 #include <stdarg.h>
41 #include <stdlib.h>
42 #include <string.h>
43
44 #include "config.h"
45
46 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
47 # if defined(__DARWIN__)
48 #  include <signal.h>
49 # endif
50 # include <ucontext.h>
51 #endif
52
53 #include "mm/boehm.h"
54 #include "mm/memory.h"
55 #include "native/include/java_lang_String.h"
56 #include "native/include/java_lang_Throwable.h"
57 #include "toolbox/chain.h"
58 #include "toolbox/logging.h"
59 #include "vm/builtin.h"
60 #include "vm/class.h"
61 #include "vm/global.h"
62 #include "vm/method.h"
63 #include "vm/tables.h"
64 #include "vm/loader.h"
65 #include "vm/options.h"
66 #include "vm/stringlocal.h"
67 #include "vm/jit/asmpart.h"
68
69
70 #if defined(ENABLE_INTRP)
71 /* dummy interpreter stack to keep the compiler happy */
72
73 u1 intrp_main_stack[1];
74 #endif
75
76
77 /* for raising exceptions from native methods *********************************/
78
79 #if !defined(USE_THREADS) || !defined(NATIVE_THREADS)
80 java_objectheader *_no_threads_exceptionptr = NULL;
81 #endif
82
83
84 /* replace some non-vmcore functions ******************************************/
85
86 functionptr native_findfunction(utf *cname, utf *mname, utf *desc,
87                                                                 bool isstatic)
88 {
89         /* return something different than NULL, otherwise we get an exception */
90
91         return (functionptr) 1;
92 }
93
94 java_objectheader *native_new_and_init(classinfo *c) { return NULL; }
95 java_objectheader *native_new_and_init_string(classinfo *c, java_lang_String *s) { return NULL; }
96 java_objectheader *native_new_and_init_int(classinfo *c, s4 i) { return NULL; }
97 java_objectheader *native_new_and_init_throwable(classinfo *c, java_lang_Throwable *t) { return NULL; }
98
99
100 java_objectheader *asm_calljavafunction(methodinfo *m, void *arg1, void *arg2,
101                                                                                 void *arg3, void *arg4) { return NULL; }
102
103 void asm_call_jit_compiler(void) {}
104
105 /* code patching functions */
106 void patcher_builtin_new(u1 *sp) {}
107 void patcher_builtin_newarray(u1 *sp) {}
108 void patcher_builtin_arraycheckcast(u1 *sp) {}
109 void patcher_builtin_arrayinstanceof(u1 *sp) {}
110
111 s4 asm_builtin_idiv(s4 a, s4 b) { return 0; }
112 s4 asm_builtin_irem(s4 a, s4 b) { return 0; }
113 s8 asm_builtin_ldiv(s8 a, s8 b) { return 0; }
114 s8 asm_builtin_lrem(s8 a, s8 b) { return 0; }
115
116 s4 asm_builtin_f2i(float a) { return 0; }
117 s8 asm_builtin_f2l(float a) { return 0; }
118 s4 asm_builtin_d2i(double a) { return 0; }
119 s8 asm_builtin_d2l(double a) { return 0; }
120
121 void use_class_as_object(void) {}
122 void asm_builtin_monitorenter(java_objectheader *o) {}
123 void *asm_builtin_monitorexit(java_objectheader *o) { return NULL; }
124
125 s4 asm_builtin_arraycheckcast(java_objectheader *obj, vftbl_t *target)
126 {
127         return 0;
128 }
129
130 #if defined(__MIPS__)
131 long compare_and_swap(long *p, long oldval, long newval)
132 {
133         if (*p == oldval) {
134                 *p = newval;
135                 return oldval;
136         } else
137                 return *p;
138 }
139 #endif
140
141
142 void asm_builtin_aastore(java_objectarray *a, s4 index, java_objectheader *o) {}
143
144 functionptr createcompilerstub(methodinfo *m) { return NULL; }
145 functionptr codegen_createnativestub(functionptr f, methodinfo *m) { return NULL; }
146
147 void removecompilerstub(functionptr stub) {}
148 void removenativestub(functionptr stub) {}
149
150 void asm_perform_threadswitch(u1 **from, u1 **to, u1 **stackTop) {}
151 u1* asm_initialize_thread_stack(void *func, u1 *stack) { return NULL; }
152
153 void *asm_switchstackandcall(void *stack, void *func, void **stacktopsave, void * p) { return NULL; }
154
155 void asm_handle_builtin_exception(classinfo *c) {}
156 void asm_getclassvalues_atomic(vftbl_t *super, vftbl_t *sub, castinfo *out) {}
157
158
159 void setVMClassField(classinfo *c) {}
160 void *Java_java_lang_VMObject_clone(void *env, void *clazz, void * this)
161 {
162         return NULL;
163 }
164
165 typecheck_result typeinfo_is_assignable_to_class(typeinfo *value,classref_or_classinfo dest)
166 {
167         return typecheck_TRUE;
168 }
169
170 bool typeinfo_init_class(typeinfo *info,classref_or_classinfo c)
171 {
172         return true;
173 }
174
175 void typeinfo_print(FILE *file,typeinfo *info,int indent) {}
176
177 void stacktrace_print_trace(stackTraceBuffer *stb) {}
178
179
180 /* exception functions ********************************************************/
181
182 /* these should not be called */
183
184 void throw_exception(void) { assert(0); }
185 void throw_exception_exit(void) { assert(0); }
186
187 java_objectheader *new_verifyerror(methodinfo *m, const char *message)
188 {
189         assert(0);
190
191         /* keep compiler happy */
192
193         return NULL;
194 }
195
196 java_objectheader *new_exception_throwable(const char *classname, java_lang_Throwable *throwable)
197 {
198         assert(0);
199
200         /* keep compiler happy */
201
202         return NULL;
203 }
204
205
206 void throw_cacao_exception_exit(const char *exception, const char *message, ...)
207 {
208         va_list ap;
209
210         fprintf(stderr, "%s: ", exception);
211
212         va_start(ap, message);
213         vfprintf(stderr, message, ap);
214         va_end(ap);
215
216         fputc('\n', stderr);
217
218         exit(1);
219 }
220
221
222 java_objectheader *new_exception(const char *classname)
223 {
224         fprintf(stderr, "%s\n", classname);
225         exit(1);
226
227         /* keep compiler happy */
228
229         return NULL;
230 }
231
232
233 java_objectheader *new_exception_message(const char *classname, const char *message)
234 {
235         fprintf(stderr, "%s: %s\n", classname, message);
236         exit(1);
237
238         /* keep compiler happy */
239
240         return NULL;
241 }
242
243
244 java_objectheader *new_exception_utfmessage(const char *classname, utf *message)
245 {
246         fprintf(stderr, "%s: ", classname);
247         utf_display(message);
248         fputc('\n', stderr);
249
250         exit(1);
251
252         /* keep compiler happy */
253
254         return NULL;
255 }
256
257
258 java_objectheader *new_exception_javastring(const char *classname,
259                                                                                         java_lang_String *message)
260 {
261         fprintf(stderr, "%s: ", classname);
262         /* TODO print message */
263         fputc('\n', stderr);
264
265         exit(1);
266
267         /* keep compiler happy */
268
269         return NULL;
270 }
271
272
273 java_objectheader *new_classformaterror(classinfo *c, const char *message, ...)
274 {
275         va_list ap;
276
277         utf_display(c->name);
278         fprintf(stderr, ": ");
279
280         va_start(ap, message);
281         vfprintf(stderr, message, ap);
282         va_end(ap);
283
284         fputc('\n', stderr);
285
286         exit(1);
287
288         /* keep compiler happy */
289
290         return NULL;
291 }
292
293
294 java_objectheader *new_classnotfoundexception(classinfo *c)
295 {
296         fprintf(stderr, "java.lang.ClassNotFoundException: ");
297         utf_fprint(stderr, c->name);
298         fputc('\n', stderr);
299
300         exit(1);
301
302         /* keep compiler happy */
303
304         return NULL;
305 }
306
307
308 java_objectheader *new_internalerror(const char *message, ...)
309 {
310         va_list ap;
311
312         fprintf(stderr, "%s: ", string_java_lang_InternalError);
313
314         va_start(ap, message);
315         vfprintf(stderr, message, ap);
316         va_end(ap);
317
318         exit(1);
319
320         /* keep compiler happy */
321
322         return NULL;
323 }
324
325
326 java_objectheader *new_unsupportedclassversionerror(classinfo *c, const char *message, ...)
327 {
328         va_list ap;
329
330         fprintf(stderr, "%s: ", string_java_lang_UnsupportedClassVersionError);
331
332         utf_display(c->name);
333         fprintf(stderr, ": ");
334
335         va_start(ap, message);
336         vfprintf(stderr, message, ap);
337         va_end(ap);
338
339         exit(1);
340
341         /* keep compiler happy */
342
343         return NULL;
344 }
345
346
347 java_objectheader *new_negativearraysizeexception(void)
348 {
349         fprintf(stderr, "%s", string_java_lang_NegativeArraySizeException);
350         exit(1);
351
352         /* keep compiler happy */
353
354         return NULL;
355 }
356
357
358 java_objectheader *new_nullpointerexception(void)
359 {
360         fprintf(stderr, "%s", string_java_lang_NullPointerException);
361         exit(1);
362
363         /* keep compiler happy */
364
365         return NULL;
366 }
367
368
369 /* machine dependent stuff ****************************************************/
370
371 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
372 threadcritnode asm_criticalsections;
373 void thread_restartcriticalsection(ucontext_t *uc) {}
374 #endif
375
376 void md_param_alloc(methoddesc *md) {}
377
378
379 /************************ global variables **********************/
380
381 chain *nativemethod_chain;              /* chain with native methods          */
382 chain *nativeclass_chain;               /* chain with processed classes       */
383 chain *ident_chain;     /* chain with method and field names in current class */
384 FILE *file = NULL;
385 static u4 outputsize;
386 static bool dopadding;
387
388
389 static void printIDpart(int c)
390 {
391         if ((c >= 'a' && c <= 'z') ||
392                 (c >= 'A' && c <= 'Z') ||
393                 (c >= '0' && c <= '9') ||
394                 (c == '_'))
395                 putc(c, file);
396         else
397                 putc('_', file);
398 }
399
400
401 void printID(utf *u)
402 {
403         char *utf_ptr = u->text;
404         int i;
405
406         for (i = 0; i < utf_strlen(u); i++) 
407                 printIDpart(utf_nextu2(&utf_ptr));
408 }
409
410
411 static void addoutputsize (int len)
412 {
413         u4 newsize,i;
414         if (!dopadding) return;
415
416         newsize = ALIGN(outputsize, len);
417         
418         for (i = outputsize; i < newsize; i++) fprintf(file, "   u1 pad%d\n", (int) i);
419         outputsize = newsize;
420 }
421
422
423 void printOverloadPart(utf *desc)
424 {
425         char *utf_ptr=desc->text;
426         u2 c;
427
428         fprintf(file, "__");
429
430         while ((c = utf_nextu2(&utf_ptr)) != ')') {
431                 switch (c) {
432                 case 'I':
433                 case 'S':
434                 case 'B':
435                 case 'C':
436                 case 'Z':
437                 case 'J':
438                 case 'F':
439                 case 'D': 
440                         fprintf(file, "%c", (char) c);
441                         break;
442                 case '[':
443                         fprintf(file, "_3");
444                         break;
445                 case 'L':
446                         putc('L', file);
447                         while ((c = utf_nextu2(&utf_ptr)) != ';')
448                                 printIDpart(c);
449                         fprintf(file, "_2");
450                         break;
451                 case '(':
452                         break;
453                 default: 
454                         log_text("invalid method descriptor");
455                         assert(0);
456                 }
457         }
458 }
459
460 static char *printtype(char *utf_ptr)
461 {
462         u2 c;
463
464         switch (utf_nextu2(&utf_ptr)) {
465         case 'V': fprintf (file, "void");
466                 break;
467         case 'I':
468         case 'S':
469         case 'B':
470         case 'C':
471         case 'Z': addoutputsize (4);
472                 fprintf (file, "s4");
473                 break;
474         case 'J': addoutputsize (8);
475                 fprintf (file, "s8");
476                 break;
477         case 'F': addoutputsize (4);
478                 fprintf (file, "float");
479                 break;
480         case 'D': addoutputsize (8);
481                 fprintf (file, "double");
482                 break;
483         case '[':
484                 addoutputsize ( sizeof(java_arrayheader*) ); 
485                 switch (utf_nextu2(&utf_ptr)) {
486                 case 'I':  fprintf (file, "java_intarray*"); break;
487                 case 'J':  fprintf (file, "java_longarray*"); break;
488                 case 'Z':  fprintf (file, "java_booleanarray*"); break;
489                 case 'B':  fprintf (file, "java_bytearray*"); break;
490                 case 'S':  fprintf (file, "java_shortarray*"); break;
491                 case 'C':  fprintf (file, "java_chararray*"); break;
492                 case 'F':  fprintf (file, "java_floatarray*"); break;
493                 case 'D':  fprintf (file, "java_doublearray*"); break;
494                                 
495                 case '[': fprintf(file, "java_objectarray*");
496                         while ((c = utf_nextu2(&utf_ptr)) == '[');
497                         if (c == 'L')
498                                 while (utf_nextu2(&utf_ptr) != ';');
499                         break;
500                            
501                 case 'L':  fprintf(file, "java_objectarray*");
502                         while (utf_nextu2(&utf_ptr) != ';');
503                         break;
504                 default:
505                         log_text("invalid type descriptor");
506                         assert(0);
507                 }
508                 break;
509                 
510         case 'L': 
511                 addoutputsize ( sizeof(java_objectheader*));
512                 fprintf (file, "struct ");
513                 while ( (c = utf_nextu2(&utf_ptr)) != ';' ) printIDpart (c);     
514                 fprintf (file, "*");
515                 break;
516                                         
517         default:
518                 log_text("Unknown type in field descriptor");
519                 assert(0);
520         }
521         
522         return utf_ptr;
523 }
524
525
526 /***** determine the number of entries of a utf string in the ident chain *****/
527
528 static int searchidentchain_utf(utf *ident) 
529 {
530         utf *u = chain_first(ident_chain);     /* first element of list */
531         int count = 0;
532
533         while (u) {
534                 if (u==ident) count++;         /* string found */
535                 u = chain_next(ident_chain);   /* next element in list */ 
536         }
537
538         return count;
539 }
540
541
542 /************** print structure for direct access to objects ******************/
543
544 static void printfields(classinfo *c)
545 {
546         u4 i;
547         fieldinfo *f;
548         int ident_count;
549         
550         if (!c) {
551                 addoutputsize(sizeof(java_objectheader));
552                 fprintf(file, "   java_objectheader header;\n");
553                 return;
554         }
555                 
556         printfields(c->super.cls);
557         
558         for (i = 0; i < c->fieldscount; i++) {
559                 f = &(c->fields[i]);
560                 
561                 if (!(f->flags & ACC_STATIC)) {
562                         fprintf(file, "   ");
563                         printtype(f->descriptor->text);
564                         fprintf(file, " ");
565                         utf_fprint(file, f->name);
566
567                         /* rename multiple fieldnames */
568                         if ((ident_count = searchidentchain_utf(f->name)))
569                                 fprintf(file, "%d", ident_count - 1);
570                         chain_addlast(ident_chain, f->name);    
571
572                         fprintf(file, ";\n");
573                 }
574         }
575 }
576
577
578 /***************** store prototype for native method in file ******************/
579
580 void printmethod(methodinfo *m)
581 {
582         char *utf_ptr;
583         u2 paramnum = 1;
584
585         /* search for return-type in descriptor */      
586         utf_ptr = m->descriptor->text;
587         while (utf_nextu2(&utf_ptr) != ')');
588
589         /* create remarks */
590         fprintf(file, "\n/*\n * Class:     ");
591         utf_fprint(file, m->class->name);
592         fprintf(file, "\n * Method:    ");
593         utf_fprint(file, m->name);
594         fprintf(file, "\n * Signature: ");
595         utf_fprint(file, m->descriptor);
596         fprintf(file, "\n */\n");
597
598         /* create prototype */                  
599         fprintf(file, "JNIEXPORT ");
600         printtype(utf_ptr);
601         fprintf(file, " JNICALL Java_");
602         printID(m->class->name);
603
604         chain_addlast(ident_chain, m->name);
605
606         fprintf(file, "_");
607         printID(m->name);
608         if (m->nativelyoverloaded) printOverloadPart(m->descriptor);
609         fprintf(file, "(JNIEnv *env");
610         
611         utf_ptr = m->descriptor->text + 1;
612                         
613         if (!(m->flags & ACC_STATIC)) {
614                 fprintf(file, ", struct ");
615                 printID(m->class->name);
616                 fprintf(file, "* this");
617
618         } else {
619                 fprintf(file, ", jclass clazz");
620         }
621
622         if ((*utf_ptr) != ')') fprintf(file, ", ");
623                         
624         while ((*utf_ptr) != ')') {
625                 utf_ptr = printtype(utf_ptr);
626                 fprintf(file, " par%d", paramnum++);
627                 if ((*utf_ptr)!=')') fprintf(file, ", ");
628         }
629                         
630         fprintf(file, ");\n\n");
631 }
632
633
634 /******* remove package-name in fully-qualified classname *********************/
635
636 void gen_header_filename(char *buffer, utf *u)
637 {
638         s4 i;
639   
640         for (i = 0; i < utf_strlen(u); i++) {
641                 if ((u->text[i] == '/') || (u->text[i] == '$')) {
642                         buffer[i] = '_';  /* convert '$' and '/' to '_' */
643
644                 } else {
645                         buffer[i] = u->text[i];
646                 }
647         }
648         buffer[utf_strlen(u)] = '\0';
649 }
650
651
652 /* create headerfile for classes and store native methods in chain ************/
653
654 void headerfile_generate(classinfo *c, char *opt_directory)
655 {
656         char header_filename[1024] = "";
657         char classname[1024]; 
658         char uclassname[1024];
659         u2 i;
660         methodinfo *m;                  
661         u2 i2;
662         methodinfo *m2;
663         u2 nativelyoverloaded;                  
664                       
665         /* store class in chain */                    
666         chain_addlast(nativeclass_chain, c);
667                                 
668         /* open headerfile for class */
669         gen_header_filename(classname, c->name);
670
671         /* create chain for renaming fields */
672         ident_chain = chain_new();
673         
674         if (opt_directory) {
675                 sprintf(header_filename, "%s/%s.h", opt_directory, classname);
676
677         } else {
678                 sprintf(header_filename, "%s.h", classname);
679         }
680
681         file = fopen(header_filename, "w");
682         if (!file) {
683                 log_text("Can not open file to store header information");
684                 assert(0);
685         }
686
687         fprintf(file, "/* This file is machine generated, don't edit it! */\n\n");
688
689         /* convert to uppercase */
690         for (i = 0; classname[i]; i++) {
691                 uclassname[i] = toupper(classname[i]);
692         }
693         uclassname[i] = '\0';
694
695         fprintf(file, "#ifndef _%s_H\n#define _%s_H\n\n", uclassname, uclassname);
696
697         /* create structure for direct access to objects */     
698         fprintf(file, "/* Structure information for class: ");
699         utf_fprint(file, c->name);
700         fprintf(file, " */\n\n");
701         fprintf(file, "typedef struct ");
702         printID(c->name);                                                       
703         fprintf(file, " {\n");
704         outputsize = 0;
705         dopadding = true;
706
707         printfields(c);
708
709         fprintf(file, "} ");
710         printID(c->name);
711         fprintf(file, ";\n\n");
712
713         /* create chain for renaming overloaded methods */
714         chain_free(ident_chain);
715         ident_chain = chain_new();
716
717         /* create method-prototypes */
718                                 
719         /* find overloaded methods */
720         for (i = 0; i < c->methodscount; i++) {
721
722                 m = &(c->methods[i]);
723
724                 if (!(m->flags & ACC_NATIVE)) continue;
725                 if (!m->nativelyoverloaded) {
726                         nativelyoverloaded=false;
727                         for (i2=i+1;i2<c->methodscount; i2++) {
728                                 m2 = &(c->methods[i2]);
729                                 if (!(m2->flags & ACC_NATIVE)) continue;
730                                 if (m->name==m2->name) {
731                                         m2->nativelyoverloaded=true;
732                                         nativelyoverloaded=true;
733                                 }
734                         }
735                         m->nativelyoverloaded=nativelyoverloaded;
736                 }
737
738         }
739
740         for (i = 0; i < c->methodscount; i++) {
741
742                 m = &(c->methods[i]);
743
744                 if (m->flags & ACC_NATIVE) {
745                         chain_addlast(nativemethod_chain, m);
746                         printmethod(m);
747                 }
748         }
749
750         chain_free(ident_chain);
751
752         fprintf(file, "#endif\n\n");
753
754         fclose(file);
755 }
756
757
758 /******** print classname, '$' used to seperate inner-class name ***********/
759
760 void print_classname(classinfo *clazz)
761 {
762         utf *u = clazz->name;
763     char *endpos  = u->text + u->blength;
764     char *utf_ptr = u->text; 
765         u2 c;
766
767     while (utf_ptr < endpos) {
768                 if ((c = utf_nextu2(&utf_ptr)) == '_')
769                         putc('$', file);
770                 else
771                         putc(c, file);
772         }
773
774
775
776 /*
777  * These are local overrides for various environment variables in Emacs.
778  * Please do not remove this and leave it at the end of the file, where
779  * Emacs will automagically detect them.
780  * ---------------------------------------------------------------------
781  * Local variables:
782  * mode: c
783  * indent-tabs-mode: t
784  * c-basic-offset: 4
785  * tab-width: 4
786  * End:
787  */