src/vmcore/suck.c

   1 /* src/vmcore/suck.c - functions to read LE ordered types from a buffer
   2
   3    Copyright (C) 1996-2005, 2006, 2007, 2008
   4    CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
   5
   6    This file is part of CACAO.
   7
   8    This program is free software; you can redistribute it and/or
   9    modify it under the terms of the GNU General Public License as
  10    published by the Free Software Foundation; either version 2, or (at
  11    your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23 */
  24
  25
  26 #include "config.h"
  27
  28 #include <assert.h>
  29 #include <stdlib.h>
  30
  31 #include "vm/types.h"
  32
  33 #include "arch.h"
  34
  35 #include "mm/memory.h"
  36
  37 #include "threads/lock-common.h"
  38
  39 #include "toolbox/list.h"
  40 #include "toolbox/logging.h"
  41 #include "toolbox/util.h"
  42
  43 #include "vm/exceptions.hpp"
  44 #include "vm/properties.h"
  45 #include "vm/vm.hpp"
  46
  47 #include "vmcore/loader.h"
  48 #include "vmcore/options.h"
  49 #include "vmcore/suck.h"
  50 #include "vmcore/os.hpp"
  51 #include "vmcore/zip.h"
  52
  53
  54 /* global variables ***********************************************************/
  55
  56 list_t *list_classpath_entries;
  57
  58
  59 /* suck_init *******************************************************************
  60
  61    Initializes the suck subsystem like initializing the classpath
  62    entries list.
  63
  64 *******************************************************************************/
  65
  66 bool suck_init(void)
  67 {
  68         TRACESUBSYSTEMINITIALIZATION("suck_init");
  69
  70         list_classpath_entries = list_create(OFFSET(list_classpath_entry, linkage));
  71
  72         /* everything's ok */
  73
  74         return true;
  75 }
  76
  77
  78 /* scandir_filter **************************************************************
  79
  80    Filters for zip/jar files.
  81
  82 *******************************************************************************/
  83
  84 #if defined(__LINUX__)
  85 static int scandir_filter(const struct dirent *a)
  86 #else
  87 static int scandir_filter(struct dirent *a)
  88 #endif
  89 {
  90         s4 namlen;
  91
  92 #if defined(_DIRENT_HAVE_D_NAMLEN)
  93         namlen = a->d_namlen;
  94 #else
  95         namlen = strlen(a->d_name);
  96 #endif
  97
  98         if ((strncasecmp(a->d_name + namlen - 4, ".zip", 4) == 0) ||
  99                 (strncasecmp(a->d_name + namlen - 4, ".jar", 4) == 0))
 100                 return 1;
 101
 102         return 0;
 103 }
 104
 105
 106 /* suck_add ********************************************************************
 107
 108    Adds a classpath to the global classpath entries list.
 109
 110 *******************************************************************************/
 111
 112 void suck_add(char *classpath)
 113 {
 114         list_classpath_entry *lce;
 115         char                 *start;
 116         char                 *end;
 117         char                 *filename;
 118         s4                    filenamelen;
 119         bool                  is_zip;
 120         char                 *cwd;
 121         s4                    cwdlen;
 122 #if defined(ENABLE_ZLIB)
 123         hashtable            *ht;
 124 #endif
 125
 126         /* parse the classpath string */
 127
 128         for (start = classpath; (*start) != '\0'; ) {
 129
 130                 /* search for ':' delimiter to get the end of the current entry */
 131                 for (end = start; ((*end) != '\0') && ((*end) != ':'); end++);
 132
 133                 if (start != end) {
 134                         is_zip = false;
 135                         filenamelen = end - start;
 136
 137                         if (filenamelen > 4) {
 138                                 if ((strncasecmp(end - 4, ".zip", 4) == 0) ||
 139                                         (strncasecmp(end - 4, ".jar", 4) == 0)) {
 140                                         is_zip = true;
 141                                 }
 142                         }
 143
 144                         /* save classpath entries as absolute pathnames */
 145
 146                         cwd = NULL;
 147                         cwdlen = 0;
 148
 149                         if (*start != '/') {                      /* XXX fix me for win32 */
 150                                 cwd = _Jv_getcwd();
 151                                 cwdlen = strlen(cwd) + strlen("/");
 152                         }
 153
 154                         /* allocate memory for filename and fill it */
 155
 156                         filename = MNEW(char, filenamelen + cwdlen + strlen("/") +
 157                                                         strlen("0"));
 158
 159                         if (cwd) {
 160                                 strcpy(filename, cwd);
 161                                 strcat(filename, "/");
 162                                 strncat(filename, start, filenamelen);
 163
 164                                 /* add cwd length to file length */
 165                                 filenamelen += cwdlen;
 166
 167                         } else {
 168                                 strncpy(filename, start, filenamelen);
 169                                 filename[filenamelen] = '\0';
 170                         }
 171
 172                         lce = NULL;
 173
 174                         if (is_zip) {
 175 #if defined(ENABLE_ZLIB)
 176                                 ht = zip_open(filename);
 177
 178                                 if (ht != NULL) {
 179                                         lce = NEW(list_classpath_entry);
 180
 181                                         lce->type      = CLASSPATH_ARCHIVE;
 182                                         lce->htclasses = ht;
 183                                         lce->path      = filename;
 184                                         lce->pathlen   = filenamelen;
 185
 186                                         /* SUN compatible -verbose:class output */
 187
 188                                         if (opt_verboseclass)
 189                                                 printf("[Opened %s]\n", filename);
 190                                 }
 191
 192 #else
 193                                 vm_abort("suck_add: zip/jar files not supported");
 194 #endif
 195                         }
 196                         else {
 197                                 if (filename[filenamelen - 1] != '/') {/* XXX fixme for win32 */
 198                                         filename[filenamelen] = '/';
 199                                         filename[filenamelen + 1] = '\0';
 200                                         filenamelen++;
 201                                 }
 202
 203                                 lce = NEW(list_classpath_entry);
 204
 205                                 lce->type    = CLASSPATH_PATH;
 206                                 lce->path    = filename;
 207                                 lce->pathlen = filenamelen;
 208                         }
 209
 210                         /* add current classpath entry, if no error */
 211
 212                         if (lce != NULL)
 213                                 list_add_last(list_classpath_entries, lce);
 214                 }
 215
 216                 /* goto next classpath entry, skip ':' delimiter */
 217
 218                 if ((*end) == ':')
 219                         start = end + 1;
 220                 else
 221                         start = end;
 222         }
 223 }
 224
 225
 226 /* suck_add_from_property ******************************************************
 227
 228    Adds a classpath form a property entry to the global classpath
 229    entries list.
 230
 231 *******************************************************************************/
 232
 233 void suck_add_from_property(const char *key)
 234 {
 235         const char     *value;
 236         const char     *start;
 237         const char     *end;
 238         char           *path;
 239         s4              pathlen;
 240         struct dirent **namelist;
 241         s4              n;
 242         s4              i;
 243         s4              namlen;
 244         char           *boot_class_path;
 245         char           *p;
 246
 247         /* get the property value */
 248
 249         value = properties_get(key);
 250
 251         if (value == NULL)
 252                 return;
 253
 254         /* get the directory entries of the property */
 255
 256         for (start = value; (*start) != '\0'; ) {
 257
 258                 /* search for ':' delimiter to get the end of the current entry */
 259
 260                 for (end = start; ((*end) != '\0') && ((*end) != ':'); end++);
 261
 262                 /* found an entry */
 263
 264                 if (start != end) {
 265                         /* allocate memory for the path entry */
 266
 267                         pathlen = end - start;
 268                         path = MNEW(char, pathlen + strlen("0"));
 269
 270                         /* copy and terminate the string */
 271
 272                         strncpy(path, start, pathlen);
 273                         path[pathlen] = '\0';
 274
 275                         /* Reset namelist to NULL for the freeing in an error case
 276                            (see below). */
 277
 278                         namelist = NULL;
 279
 280                         /* scan the directory found for zip/jar files */
 281
 282                         n = os_scandir(path, &namelist, scandir_filter, alphasort);
 283
 284                         /* On error, just continue, this should be ok. */
 285
 286                         if (n > 0) {
 287                                 for (i = 0; i < n; i++) {
 288 #if defined(_DIRENT_HAVE_D_NAMLEN)
 289                                         namlen = namelist[i]->d_namlen;
 290 #else
 291                                         namlen = strlen(namelist[i]->d_name);
 292 #endif
 293
 294                                         /* Allocate memory for bootclasspath. */
 295
 296                                         // FIXME Make boot_class_path const char*.
 297                                         boot_class_path = (char*) properties_get("sun.boot.class.path");
 298
 299                                         p = MNEW(char,
 300                                                          pathlen + strlen("/") + namlen +
 301                                                          strlen(":") +
 302                                                          strlen(boot_class_path) +
 303                                                          strlen("0"));
 304
 305                                         /* Prepend the file found to the bootclasspath. */
 306
 307                                         strcpy(p, path);
 308                                         strcat(p, "/");
 309                                         strcat(p, namelist[i]->d_name);
 310                                         strcat(p, ":");
 311                                         strcat(p, boot_class_path);
 312
 313                                         properties_add("sun.boot.class.path", p);
 314                                         properties_add("java.boot.class.path", p);
 315
 316                                         MFREE(boot_class_path, char, strlen(boot_class_path));
 317
 318                                         /* free the memory allocated by scandir */
 319                                         /* (We use `free` as the memory came from the C library.) */
 320
 321                                         free(namelist[i]);
 322                                 }
 323                         }
 324
 325                         /* On some systems (like Linux) when n == 0, then namelist
 326                            returned from scnadir is NULL, thus we don't have to
 327                            free it.
 328                            (Use `free` as the memory came from the C library.) */
 329
 330                         if (namelist != NULL)
 331                                 free(namelist);
 332
 333                         MFREE(path, char, pathlen + strlen("0"));
 334                 }
 335
 336                 /* goto next entry, skip ':' delimiter */
 337
 338                 if ((*end) == ':')
 339                         start = end + 1;
 340                 else
 341                         start = end;
 342         }
 343 }
 344
 345
 346 /* suck_check_classbuffer_size *************************************************
 347
 348    Assert that at least <len> bytes are left to read <len> is limited
 349    to the range of non-negative s4 values.
 350
 351 *******************************************************************************/
 352
 353 bool suck_check_classbuffer_size(classbuffer *cb, s4 len)
 354 {
 355 #ifdef ENABLE_VERIFIER
 356         if (len < 0 || ((cb->data + cb->size) - cb->pos) < len) {
 357                 exceptions_throw_classformaterror(cb->clazz, "Truncated class file");
 358                 return false;
 359         }
 360 #endif /* ENABLE_VERIFIER */
 361
 362         return true;
 363 }
 364
 365
 366 u1 suck_u1(classbuffer *cb)
 367 {
 368         u1 a;
 369
 370         a = SUCK_BE_U1(cb->pos);
 371         cb->pos++;
 372
 373         return a;
 374 }
 375
 376
 377 u2 suck_u2(classbuffer *cb)
 378 {
 379         u2 a;
 380
 381         a = SUCK_BE_U2(cb->pos);
 382         cb->pos += 2;
 383
 384         return a;
 385 }
 386
 387
 388 u4 suck_u4(classbuffer *cb)
 389 {
 390         u4 a;
 391
 392         a = SUCK_BE_U4(cb->pos);
 393         cb->pos += 4;
 394
 395         return a;
 396 }
 397
 398
 399 u8 suck_u8(classbuffer *cb)
 400 {
 401 #if U8_AVAILABLE == 1
 402         u8 a;
 403
 404         a = SUCK_BE_U8(cb->pos);
 405         cb->pos += 8;
 406
 407         return a;
 408 #else
 409         u8 v;
 410
 411         v.high = suck_u4(cb);
 412         v.low = suck_u4(cb);
 413
 414         return v;
 415 #endif
 416 }
 417
 418
 419 float suck_float(classbuffer *cb)
 420 {
 421         float f;
 422
 423 #if WORDS_BIGENDIAN == 0
 424         u1 buffer[4];
 425         u2 i;
 426
 427         for (i = 0; i < 4; i++)
 428                 buffer[3 - i] = suck_u1(cb);
 429
 430         MCOPY((u1 *) (&f), buffer, u1, 4);
 431 #else
 432         suck_nbytes((u1*) (&f), cb, 4);
 433 #endif
 434
 435         assert(sizeof(float) == 4);
 436
 437         return f;
 438 }
 439
 440
 441 double suck_double(classbuffer *cb)
 442 {
 443         double d;
 444
 445 #if WORDS_BIGENDIAN == 0
 446         u1 buffer[8];
 447         u2 i;
 448
 449 # if defined(__ARM__) && defined(__ARMEL__) && !defined(__VFP_FP__)
 450         /*
 451          * On little endian ARM processors when using FPA, word order
 452          * of doubles is still big endian. So take that into account
 453          * here. When using VFP, word order of doubles follows byte
 454          * order. (michi 2005/07/24)
 455          */
 456         for (i = 0; i < 4; i++)
 457                 buffer[3 - i] = suck_u1(cb);
 458         for (i = 0; i < 4; i++)
 459                 buffer[7 - i] = suck_u1(cb);
 460 # else
 461         for (i = 0; i < 8; i++)
 462                 buffer[7 - i] = suck_u1(cb);
 463 # endif /* defined(__ARM__) && ... */
 464
 465         MCOPY((u1 *) (&d), buffer, u1, 8);
 466 #else
 467         suck_nbytes((u1*) (&d), cb, 8);
 468 #endif
 469
 470         assert(sizeof(double) == 8);
 471
 472         return d;
 473 }
 474
 475
 476 /* suck_nbytes *****************************************************************
 477
 478    Transfer block of classfile data into a buffer.
 479
 480 *******************************************************************************/
 481
 482 void suck_nbytes(u1 *buffer, classbuffer *cb, s4 len)
 483 {
 484         MCOPY(buffer, cb->pos, u1, len);
 485         cb->pos += len;
 486 }
 487
 488
 489 /* suck_skip_nbytes ************************************************************
 490
 491    Skip block of classfile data.
 492
 493 *******************************************************************************/
 494
 495 void suck_skip_nbytes(classbuffer *cb, s4 len)
 496 {
 497         cb->pos += len;
 498 }
 499
 500
 501 /* suck_start ******************************************************************
 502
 503    Returns true if classbuffer is already loaded or a file for the
 504    specified class has succussfully been read in. All directories of
 505    the searchpath are used to find the classfile (<classname>.class).
 506    Returns NULL if no classfile is found and writes an error message.
 507
 508 *******************************************************************************/
 509
 510 classbuffer *suck_start(classinfo *c)
 511 {
 512         list_classpath_entry *lce;
 513         char                 *filename;
 514         s4                    filenamelen;
 515         char                 *path;
 516         FILE                 *classfile;
 517         s4                    len;
 518         struct stat           buffer;
 519         classbuffer          *cb;
 520
 521         /* initialize return value */
 522
 523         cb = NULL;
 524
 525         /* get the classname as char string (do it here for the warning at
 526        the end of the function) */
 527
 528         filenamelen = utf_bytes(c->name) + strlen(".class") + strlen("0");
 529         filename = MNEW(char, filenamelen);
 530
 531         utf_copy(filename, c->name);
 532         strcat(filename, ".class");
 533
 534         /* walk through all classpath entries */
 535
 536         for (lce = list_first(list_classpath_entries); lce != NULL && cb == NULL;
 537                  lce = list_next(list_classpath_entries, lce)) {
 538 #if defined(ENABLE_ZLIB)
 539                 if (lce->type == CLASSPATH_ARCHIVE) {
 540
 541                         /* enter a monitor on zip/jar archives */
 542
 543                         LOCK_MONITOR_ENTER(lce);
 544
 545                         /* try to get the file in current archive */
 546
 547                         cb = zip_get(lce, c);
 548
 549                         /* leave the monitor */
 550
 551                         LOCK_MONITOR_EXIT(lce);
 552
 553                 } else {
 554 #endif /* defined(ENABLE_ZLIB) */
 555                         path = MNEW(char, lce->pathlen + filenamelen);
 556                         strcpy(path, lce->path);
 557                         strcat(path, filename);
 558
 559                         classfile = os_fopen(path, "r");
 560
 561                         if (classfile) {                                   /* file exists */
 562                                 if (!os_stat(path, &buffer)) {     /* read classfile data */
 563                                         cb = NEW(classbuffer);
 564                                         cb->clazz = c;
 565                                         cb->size  = buffer.st_size;
 566                                         cb->data  = MNEW(u1, cb->size);
 567                                         cb->pos   = cb->data;
 568                                         cb->path  = lce->path;
 569
 570                                         /* read class data */
 571
 572                                         len = os_fread((void *) cb->data, 1, cb->size,
 573                                                                            classfile);
 574
 575                                         if (len != buffer.st_size) {
 576                                                 suck_stop(cb);
 577 /*                                              if (ferror(classfile)) { */
 578 /*                                              } */
 579                                         }
 580
 581                                         /* close the class file */
 582
 583                                         os_fclose(classfile);
 584                                 }
 585                         }
 586
 587                         MFREE(path, char, lce->pathlen + filenamelen);
 588 #if defined(ENABLE_ZLIB)
 589                 }
 590 #endif
 591         }
 592
 593         if (opt_verbose)
 594                 if (cb == NULL)
 595                         dolog("Warning: Can not open class file '%s'", filename);
 596
 597         MFREE(filename, char, filenamelen);
 598
 599         return cb;
 600 }
 601
 602
 603 /* suck_stop *******************************************************************
 604
 605    Frees memory for buffer with classfile data.
 606
 607    CAUTION: This function may only be called if buffer has been
 608    allocated by suck_start with reading a file.
 609
 610 *******************************************************************************/
 611
 612 void suck_stop(classbuffer *cb)
 613 {
 614         /* free memory */
 615
 616         MFREE(cb->data, u1, cb->size);
 617         FREE(cb, classbuffer);
 618 }
 619
 620
 621 /*
 622  * These are local overrides for various environment variables in Emacs.
 623  * Please do not remove this and leave it at the end of the file, where
 624  * Emacs will automagically detect them.
 625  * ---------------------------------------------------------------------
 626  * Local variables:
 627  * mode: c
 628  * indent-tabs-mode: t
 629  * c-basic-offset: 4
 630  * tab-width: 4
 631  * End:
 632  */