1 /* 2 * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * - Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 11 * - Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * - Neither the name of Oracle nor the names of its 16 * contributors may be used to endorse or promote products derived 17 * from this software without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS 20 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 26 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 27 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 28 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 #include "jni.h" 33 34 // Opaque reference to a JImage file. 35 class JImageFile; 36 // Opaque reference to an image file resource location. 37 typedef jlong JImageLocationRef; 38 39 // Max path length limit independent of platform. Windows max path is 1024, 40 // other platforms use 4096. 41 #define JIMAGE_MAX_PATH 4096 42 43 // JImage Error Codes 44 45 // Resource was not found 46 #define JIMAGE_NOT_FOUND (0) 47 // The image file is not prefixed with 0xCAFEDADA 48 #define JIMAGE_BAD_MAGIC (-1) 49 // The image file does not have a compatible (translatable) version 50 #define JIMAGE_BAD_VERSION (-2) 51 // The image file content is malformed 52 #define JIMAGE_CORRUPTED (-3) 53 54 /* 55 * JImageOpen - Given the supplied full path file name, open an image file. This 56 * function will also initialize tables and retrieve meta-data necessary to 57 * satisfy other functions in the API. If the image file has been previously 58 * open, a new open request will share memory and resources used by the previous 59 * open. A call to JImageOpen should be balanced by a call to JImageClose, to 60 * release memory and resources used. If the image file is not found or cannot 61 * be open, then NULL is returned and error will contain a reason for the 62 * failure; a positive value for a system error number, negative for a jimage 63 * specific error (see JImage Error Codes.) 64 * 65 * Ex. 66 * jint error; 67 * JImageFile* jimage = (*JImageOpen)(JAVA_HOME "lib/modules", &error); 68 * if (image == NULL) { 69 * tty->print_cr("JImage failed to open: %d", error); 70 * ... 71 * } 72 * ... 73 */ 74 75 extern "C" JImageFile* JIMAGE_Open(const char *name, jint* error); 76 77 typedef JImageFile* (*JImageOpen_t)(const char *name, jint* error); 78 79 /* 80 * JImageClose - Given the supplied open image file (see JImageOpen), release 81 * memory and resources used by the open file and close the file. If the image 82 * file is shared by other uses, release and close is deferred until the last use 83 * is also closed. 84 * 85 * Ex. 86 * (*JImageClose)(image); 87 */ 88 89 extern "C" void JIMAGE_Close(JImageFile* jimage); 90 91 typedef void (*JImageClose_t)(JImageFile* jimage); 92 93 94 /* 95 * JImagePackageToModule - Given an open image file (see JImageOpen) and the name 96 * of a package, return the name of module where the package resides. If the 97 * package does not exist in the image file, the function returns NULL. 98 * The resulting string does/should not have to be released. All strings are 99 * utf-8, zero byte terminated. 100 * 101 * Ex. 102 * const char* package = (*JImagePackageToModule)(image, "java/lang"); 103 * tty->print_cr(package); 104 * -> java.base 105 */ 106 107 extern "C" const char * JIMAGE_PackageToModule(JImageFile* jimage, const char* package_name); 108 109 typedef const char* (*JImagePackageToModule_t)(JImageFile* jimage, const char* package_name); 110 111 112 /* 113 * JImageFindResource - Given an open image file (see JImageOpen), a module 114 * name, a version string and the name of a class/resource, return location 115 * information describing the resource and its size. If no resource is found, the 116 * function returns JIMAGE_NOT_FOUND and the value of size is undefined. 117 * The version number should be "9.0" and is not used in locating the resource. 118 * The resulting location does/should not have to be released. 119 * All strings are utf-8, zero byte terminated. 120 * 121 * Ex. 122 * jlong size; 123 * JImageLocationRef location = (*JImageFindResource)(image, 124 * "java.base", "9.0", "java/lang/String.class", &size); 125 */ 126 extern "C" JImageLocationRef JIMAGE_FindResource(JImageFile* jimage, 127 const char* module_name, const char* version, const char* name, 128 jlong* size); 129 130 typedef JImageLocationRef(*JImageFindResource_t)(JImageFile* jimage, 131 const char* module_name, const char* version, const char* name, 132 jlong* size); 133 134 135 /* 136 * JImageGetResource - Given an open image file (see JImageOpen), a resource's 137 * location information (see JImageFindResource), a buffer of appropriate 138 * size and the size, retrieve the bytes associated with the 139 * resource. If the size is less than the resource size then the read is truncated. 140 * If the size is greater than the resource size then the remainder of the buffer 141 * is zero filled. The function will return the actual size of the resource. 142 * 143 * Ex. 144 * jlong size; 145 * JImageLocationRef location = (*JImageFindResource)(image, 146 * "java.base", "9.0", "java/lang/String.class", &size); 147 * char* buffer = new char[size]; 148 * (*JImageGetResource)(image, location, buffer, size); 149 */ 150 extern "C" jlong JIMAGE_GetResource(JImageFile* jimage, JImageLocationRef location, 151 char* buffer, jlong size); 152 153 typedef jlong(*JImageGetResource_t)(JImageFile* jimage, JImageLocationRef location, 154 char* buffer, jlong size); 155 156 157 /* 158 * JImageResourceIterator - Given an open image file (see JImageOpen), a visitor 159 * function and a visitor argument, iterator through each of the image's resources. 160 * The visitor function is called with the image file, the module name, the 161 * package name, the base name, the extension and the visitor argument. The return 162 * value of the visitor function should be true, unless an early iteration exit is 163 * required. All strings are utf-8, zero byte terminated.file. 164 * 165 * Ex. 166 * bool ctw_visitor(JImageFile* jimage, const char* module_name, const char* version, 167 * const char* package, const char* name, const char* extension, void* arg) { 168 * if (strcmp(extension, "class") == 0) { 169 * char path[JIMAGE_MAX_PATH]; 170 * Thread* THREAD = Thread::current(); 171 * jio_snprintf(path, JIMAGE_MAX_PATH - 1, "/%s/%s", package, name); 172 * ClassLoader::compile_the_world_in(path, (Handle)arg, THREAD); 173 * return !HAS_PENDING_EXCEPTION; 174 * } 175 * return true; 176 * } 177 * (*JImageResourceIterator)(image, ctw_visitor, loader); 178 */ 179 180 typedef bool (*JImageResourceVisitor_t)(JImageFile* jimage, 181 const char* module_name, const char* version, const char* package, 182 const char* name, const char* extension, void* arg); 183 184 extern "C" void JIMAGE_ResourceIterator(JImageFile* jimage, 185 JImageResourceVisitor_t visitor, void *arg); 186 187 typedef void (*JImageResourceIterator_t)(JImageFile* jimage, 188 JImageResourceVisitor_t visitor, void* arg); 189 190 /* 191 * JIMAGE_ResourcePath- Given an open image file, a location reference, a buffer 192 * and a maximum buffer size, copy the path of the resource into the buffer. 193 * Returns false if not a valid location reference. 194 * 195 * Ex. 196 * JImageLocationRef location = ... 197 * char path[JIMAGE_MAX_PATH]; 198 * (*JImageResourcePath)(image, location, path, JIMAGE_MAX_PATH); 199 */ 200 extern "C" bool JIMAGE_ResourcePath(JImageFile* image, JImageLocationRef locationRef, 201 char* path, size_t max); 202 203 typedef bool (*JImage_ResourcePath_t)(JImageFile* jimage, JImageLocationRef location, 204 char* buffer, jlong size);