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 3188 2005-09-16 11:33:21Z 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 *_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 }
 178
 179 /* exception functions ********************************************************/
 180
 181 /* these should not be called */
 182
 183 void throw_exception(void) { assert(0); }
 184 void throw_exception_exit(void) { assert(0); }
 185
 186 java_objectheader *new_verifyerror(methodinfo *m, const char *message)
 187 {
 188         assert(0);
 189
 190         /* keep compiler happy */
 191
 192         return NULL;
 193 }
 194
 195 java_objectheader *new_exception_throwable(const char *classname, java_lang_Throwable *throwable)
 196 {
 197         assert(0);
 198
 199         /* keep compiler happy */
 200
 201         return NULL;
 202 }
 203
 204
 205 void throw_cacao_exception_exit(const char *exception, const char *message, ...)
 206 {
 207         va_list ap;
 208
 209         fprintf(stderr, "%s: ", exception);
 210
 211         va_start(ap, message);
 212         vfprintf(stderr, message, ap);
 213         va_end(ap);
 214
 215         fputc('\n', stderr);
 216
 217         exit(1);
 218 }
 219
 220
 221 java_objectheader *new_exception(const char *classname)
 222 {
 223         fprintf(stderr, "%s\n", classname);
 224         exit(1);
 225
 226         /* keep compiler happy */
 227
 228         return NULL;
 229 }
 230
 231
 232 java_objectheader *new_exception_message(const char *classname, const char *message)
 233 {
 234         fprintf(stderr, "%s: %s\n", classname, message);
 235         exit(1);
 236
 237         /* keep compiler happy */
 238
 239         return NULL;
 240 }
 241
 242
 243 java_objectheader *new_exception_utfmessage(const char *classname, utf *message)
 244 {
 245         fprintf(stderr, "%s: ", classname);
 246         utf_display(message);
 247         fputc('\n', stderr);
 248
 249         exit(1);
 250
 251         /* keep compiler happy */
 252
 253         return NULL;
 254 }
 255
 256
 257 java_objectheader *new_exception_javastring(const char *classname,
 258                                                                                         java_lang_String *message)
 259 {
 260         fprintf(stderr, "%s: ", classname);
 261         /* TODO print message */
 262         fputc('\n', stderr);
 263
 264         exit(1);
 265
 266         /* keep compiler happy */
 267
 268         return NULL;
 269 }
 270
 271
 272 java_objectheader *new_classformaterror(classinfo *c, const char *message, ...)
 273 {
 274         va_list ap;
 275
 276         utf_display(c->name);
 277         fprintf(stderr, ": ");
 278
 279         va_start(ap, message);
 280         vfprintf(stderr, message, ap);
 281         va_end(ap);
 282
 283         fputc('\n', stderr);
 284
 285         exit(1);
 286
 287         /* keep compiler happy */
 288
 289         return NULL;
 290 }
 291
 292
 293 java_objectheader *new_internalerror(const char *message, ...)
 294 {
 295         va_list ap;
 296
 297         fprintf(stderr, "%s: ", string_java_lang_InternalError);
 298
 299         va_start(ap, message);
 300         vfprintf(stderr, message, ap);
 301         va_end(ap);
 302
 303         exit(1);
 304
 305         /* keep compiler happy */
 306
 307         return NULL;
 308 }
 309
 310
 311 java_objectheader *new_unsupportedclassversionerror(classinfo *c, const char *message, ...)
 312 {
 313         va_list ap;
 314
 315         fprintf(stderr, "%s: ", string_java_lang_UnsupportedClassVersionError);
 316
 317         utf_display(c->name);
 318         fprintf(stderr, ": ");
 319
 320         va_start(ap, message);
 321         vfprintf(stderr, message, ap);
 322         va_end(ap);
 323
 324         exit(1);
 325
 326         /* keep compiler happy */
 327
 328         return NULL;
 329 }
 330
 331
 332 java_objectheader *new_negativearraysizeexception(void)
 333 {
 334         fprintf(stderr, "%s", string_java_lang_NegativeArraySizeException);
 335         exit(1);
 336
 337         /* keep compiler happy */
 338
 339         return NULL;
 340 }
 341
 342
 343 java_objectheader *new_nullpointerexception(void)
 344 {
 345         fprintf(stderr, "%s", string_java_lang_NullPointerException);
 346         exit(1);
 347
 348         /* keep compiler happy */
 349
 350         return NULL;
 351 }
 352
 353
 354 /* machine dependent stuff ****************************************************/
 355
 356 #if defined(USE_THREADS) && defined(NATIVE_THREADS)
 357 threadcritnode asm_criticalsections;
 358 void thread_restartcriticalsection(ucontext_t *uc) {}
 359 #endif
 360
 361 void md_param_alloc(methoddesc *md) {}
 362
 363
 364 /************************ global variables **********************/
 365
 366 chain *nativemethod_chain;              /* chain with native methods          */
 367 chain *nativeclass_chain;               /* chain with processed classes       */
 368 chain *ident_chain;     /* chain with method and field names in current class */
 369 FILE *file = NULL;
 370 static u4 outputsize;
 371 static bool dopadding;
 372
 373
 374 static void printIDpart(int c)
 375 {
 376         if ((c >= 'a' && c <= 'z') ||
 377                 (c >= 'A' && c <= 'Z') ||
 378                 (c >= '0' && c <= '9') ||
 379                 (c == '_'))
 380                 putc(c, file);
 381         else
 382                 putc('_', file);
 383 }
 384
 385
 386 void printID(utf *u)
 387 {
 388         char *utf_ptr = u->text;
 389         int i;
 390
 391         for (i = 0; i < utf_strlen(u); i++)
 392                 printIDpart(utf_nextu2(&utf_ptr));
 393 }
 394
 395
 396 static void addoutputsize (int len)
 397 {
 398         u4 newsize,i;
 399         if (!dopadding) return;
 400
 401         newsize = ALIGN(outputsize, len);
 402
 403         for (i = outputsize; i < newsize; i++) fprintf(file, "   u1 pad%d\n", (int) i);
 404         outputsize = newsize;
 405 }
 406
 407
 408 void printOverloadPart(utf *desc)
 409 {
 410         char *utf_ptr=desc->text;
 411         u2 c;
 412
 413         fprintf(file, "__");
 414
 415         while ((c = utf_nextu2(&utf_ptr)) != ')') {
 416                 switch (c) {
 417                 case 'I':
 418                 case 'S':
 419                 case 'B':
 420                 case 'C':
 421                 case 'Z':
 422                 case 'J':
 423                 case 'F':
 424                 case 'D':
 425                         fprintf(file, "%c", (char) c);
 426                         break;
 427                 case '[':
 428                         fprintf(file, "_3");
 429                         break;
 430                 case 'L':
 431                         putc('L', file);
 432                         while ((c = utf_nextu2(&utf_ptr)) != ';')
 433                                 printIDpart(c);
 434                         fprintf(file, "_2");
 435                         break;
 436                 case '(':
 437                         break;
 438                 default:
 439                         log_text("invalid method descriptor");
 440                         assert(0);
 441                 }
 442         }
 443 }
 444
 445 static char *printtype(char *utf_ptr)
 446 {
 447         u2 c;
 448
 449         switch (utf_nextu2(&utf_ptr)) {
 450         case 'V': fprintf (file, "void");
 451                 break;
 452         case 'I':
 453         case 'S':
 454         case 'B':
 455         case 'C':
 456         case 'Z': addoutputsize (4);
 457                 fprintf (file, "s4");
 458                 break;
 459         case 'J': addoutputsize (8);
 460                 fprintf (file, "s8");
 461                 break;
 462         case 'F': addoutputsize (4);
 463                 fprintf (file, "float");
 464                 break;
 465         case 'D': addoutputsize (8);
 466                 fprintf (file, "double");
 467                 break;
 468         case '[':
 469                 addoutputsize ( sizeof(java_arrayheader*) );
 470                 switch (utf_nextu2(&utf_ptr)) {
 471                 case 'I':  fprintf (file, "java_intarray*"); break;
 472                 case 'J':  fprintf (file, "java_longarray*"); break;
 473                 case 'Z':  fprintf (file, "java_booleanarray*"); break;
 474                 case 'B':  fprintf (file, "java_bytearray*"); break;
 475                 case 'S':  fprintf (file, "java_shortarray*"); break;
 476                 case 'C':  fprintf (file, "java_chararray*"); break;
 477                 case 'F':  fprintf (file, "java_floatarray*"); break;
 478                 case 'D':  fprintf (file, "java_doublearray*"); break;
 479
 480                 case '[': fprintf(file, "java_objectarray*");
 481                         while ((c = utf_nextu2(&utf_ptr)) == '[');
 482                         if (c == 'L')
 483                                 while (utf_nextu2(&utf_ptr) != ';');
 484                         break;
 485
 486                 case 'L':  fprintf(file, "java_objectarray*");
 487                         while (utf_nextu2(&utf_ptr) != ';');
 488                         break;
 489                 default:
 490                         log_text("invalid type descriptor");
 491                         assert(0);
 492                 }
 493                 break;
 494
 495         case 'L':
 496                 addoutputsize ( sizeof(java_objectheader*));
 497                 fprintf (file, "struct ");
 498                 while ( (c = utf_nextu2(&utf_ptr)) != ';' ) printIDpart (c);
 499                 fprintf (file, "*");
 500                 break;
 501
 502         default:
 503                 log_text("Unknown type in field descriptor");
 504                 assert(0);
 505         }
 506
 507         return utf_ptr;
 508 }
 509
 510
 511 /***** determine the number of entries of a utf string in the ident chain *****/
 512
 513 static int searchidentchain_utf(utf *ident)
 514 {
 515         utf *u = chain_first(ident_chain);     /* first element of list */
 516         int count = 0;
 517
 518         while (u) {
 519                 if (u==ident) count++;         /* string found */
 520                 u = chain_next(ident_chain);   /* next element in list */
 521         }
 522
 523         return count;
 524 }
 525
 526
 527 /************** print structure for direct access to objects ******************/
 528
 529 static void printfields(classinfo *c)
 530 {
 531         u4 i;
 532         fieldinfo *f;
 533         int ident_count;
 534
 535         if (!c) {
 536                 addoutputsize(sizeof(java_objectheader));
 537                 fprintf(file, "   java_objectheader header;\n");
 538                 return;
 539         }
 540
 541         printfields(c->super.cls);
 542
 543         for (i = 0; i < c->fieldscount; i++) {
 544                 f = &(c->fields[i]);
 545
 546                 if (!(f->flags & ACC_STATIC)) {
 547                         fprintf(file, "   ");
 548                         printtype(f->descriptor->text);
 549                         fprintf(file, " ");
 550                         utf_fprint(file, f->name);
 551
 552                         /* rename multiple fieldnames */
 553                         if ((ident_count = searchidentchain_utf(f->name)))
 554                                 fprintf(file, "%d", ident_count - 1);
 555                         chain_addlast(ident_chain, f->name);
 556
 557                         fprintf(file, ";\n");
 558                 }
 559         }
 560 }
 561
 562
 563 /***************** store prototype for native method in file ******************/
 564
 565 void printmethod(methodinfo *m)
 566 {
 567         char *utf_ptr;
 568         u2 paramnum = 1;
 569
 570         /* search for return-type in descriptor */
 571         utf_ptr = m->descriptor->text;
 572         while (utf_nextu2(&utf_ptr) != ')');
 573
 574         /* create remarks */
 575         fprintf(file, "\n/*\n * Class:     ");
 576         utf_fprint(file, m->class->name);
 577         fprintf(file, "\n * Method:    ");
 578         utf_fprint(file, m->name);
 579         fprintf(file, "\n * Signature: ");
 580         utf_fprint(file, m->descriptor);
 581         fprintf(file, "\n */\n");
 582
 583         /* create prototype */
 584         fprintf(file, "JNIEXPORT ");
 585         printtype(utf_ptr);
 586         fprintf(file, " JNICALL Java_");
 587         printID(m->class->name);
 588
 589         chain_addlast(ident_chain, m->name);
 590
 591         fprintf(file, "_");
 592         printID(m->name);
 593         if (m->nativelyoverloaded) printOverloadPart(m->descriptor);
 594         fprintf(file, "(JNIEnv *env");
 595
 596         utf_ptr = m->descriptor->text + 1;
 597
 598         if (!(m->flags & ACC_STATIC)) {
 599                 fprintf(file, ", struct ");
 600                 printID(m->class->name);
 601                 fprintf(file, "* this");
 602
 603         } else {
 604                 fprintf(file, ", jclass clazz");
 605         }
 606
 607         if ((*utf_ptr) != ')') fprintf(file, ", ");
 608
 609         while ((*utf_ptr) != ')') {
 610                 utf_ptr = printtype(utf_ptr);
 611                 fprintf(file, " par%d", paramnum++);
 612                 if ((*utf_ptr)!=')') fprintf(file, ", ");
 613         }
 614
 615         fprintf(file, ");\n\n");
 616 }
 617
 618
 619 /******* remove package-name in fully-qualified classname *********************/
 620
 621 void gen_header_filename(char *buffer, utf *u)
 622 {
 623         s4 i;
 624
 625         for (i = 0; i < utf_strlen(u); i++) {
 626                 if ((u->text[i] == '/') || (u->text[i] == '$')) {
 627                         buffer[i] = '_';  /* convert '$' and '/' to '_' */
 628
 629                 } else {
 630                         buffer[i] = u->text[i];
 631                 }
 632         }
 633         buffer[utf_strlen(u)] = '\0';
 634 }
 635
 636
 637 /* create headerfile for classes and store native methods in chain ************/
 638
 639 void headerfile_generate(classinfo *c, char *opt_directory)
 640 {
 641         char header_filename[1024] = "";
 642         char classname[1024];
 643         char uclassname[1024];
 644         u2 i;
 645         methodinfo *m;
 646         u2 i2;
 647         methodinfo *m2;
 648         u2 nativelyoverloaded;
 649
 650         /* store class in chain */
 651         chain_addlast(nativeclass_chain, c);
 652
 653         /* open headerfile for class */
 654         gen_header_filename(classname, c->name);
 655
 656         /* create chain for renaming fields */
 657         ident_chain = chain_new();
 658
 659         if (opt_directory) {
 660                 sprintf(header_filename, "%s/%s.h", opt_directory, classname);
 661
 662         } else {
 663                 sprintf(header_filename, "%s.h", classname);
 664         }
 665
 666         file = fopen(header_filename, "w");
 667         if (!file) {
 668                 log_text("Can not open file to store header information");
 669                 assert(0);
 670         }
 671
 672         fprintf(file, "/* This file is machine generated, don't edit it! */\n\n");
 673
 674         /* convert to uppercase */
 675         for (i = 0; classname[i]; i++) {
 676                 uclassname[i] = toupper(classname[i]);
 677         }
 678         uclassname[i] = '\0';
 679
 680         fprintf(file, "#ifndef _%s_H\n#define _%s_H\n\n", uclassname, uclassname);
 681
 682         /* create structure for direct access to objects */
 683         fprintf(file, "/* Structure information for class: ");
 684         utf_fprint(file, c->name);
 685         fprintf(file, " */\n\n");
 686         fprintf(file, "typedef struct ");
 687         printID(c->name);
 688         fprintf(file, " {\n");
 689         outputsize = 0;
 690         dopadding = true;
 691
 692         printfields(c);
 693
 694         fprintf(file, "} ");
 695         printID(c->name);
 696         fprintf(file, ";\n\n");
 697
 698         /* create chain for renaming overloaded methods */
 699         chain_free(ident_chain);
 700         ident_chain = chain_new();
 701
 702         /* create method-prototypes */
 703
 704         /* find overloaded methods */
 705         for (i = 0; i < c->methodscount; i++) {
 706
 707                 m = &(c->methods[i]);
 708
 709                 if (!(m->flags & ACC_NATIVE)) continue;
 710                 if (!m->nativelyoverloaded) {
 711                         nativelyoverloaded=false;
 712                         for (i2=i+1;i2<c->methodscount; i2++) {
 713                                 m2 = &(c->methods[i2]);
 714                                 if (!(m2->flags & ACC_NATIVE)) continue;
 715                                 if (m->name==m2->name) {
 716                                         m2->nativelyoverloaded=true;
 717                                         nativelyoverloaded=true;
 718                                 }
 719                         }
 720                         m->nativelyoverloaded=nativelyoverloaded;
 721                 }
 722
 723         }
 724
 725         for (i = 0; i < c->methodscount; i++) {
 726
 727                 m = &(c->methods[i]);
 728
 729                 if (m->flags & ACC_NATIVE) {
 730                         chain_addlast(nativemethod_chain, m);
 731                         printmethod(m);
 732                 }
 733         }
 734
 735         chain_free(ident_chain);
 736
 737         fprintf(file, "#endif\n\n");
 738
 739         fclose(file);
 740 }
 741
 742
 743 /******** print classname, '$' used to seperate inner-class name ***********/
 744
 745 void print_classname(classinfo *clazz)
 746 {
 747         utf *u = clazz->name;
 748     char *endpos  = u->text + u->blength;
 749     char *utf_ptr = u->text;
 750         u2 c;
 751
 752     while (utf_ptr < endpos) {
 753                 if ((c = utf_nextu2(&utf_ptr)) == '_')
 754                         putc('$', file);
 755                 else
 756                         putc(c, file);
 757         }
 758 }
 759
 760
 761 /*
 762  * These are local overrides for various environment variables in Emacs.
 763  * Please do not remove this and leave it at the end of the file, where
 764  * Emacs will automagically detect them.
 765  * ---------------------------------------------------------------------
 766  * Local variables:
 767  * mode: c
 768  * indent-tabs-mode: t
 769  * c-basic-offset: 4
 770  * tab-width: 4
 771  * End:
 772  */