1 /*
2 * Copyright (c) 2015, 2024, 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 <string.h>
33
34 #include "jimage.hpp"
35
36 #include "imageFile.hpp"
37
38 #include "jni_util.h"
39
40 /*
41 * Declare jimage library specific JNI_Onload entry for static build.
42 */
43 extern "C" {
44 DEF_STATIC_JNI_OnLoad
45 }
46
47 /*
48 * JImageOpen - Given the supplied full path file name, open an image file. This
49 * function will also initialize tables and retrieve meta-data necessary to
50 * satisfy other functions in the API. If the image file has been previously
51 * open, a new open request will share memory and resources used by the previous
52 * open. A call to JImageOpen should be balanced by a call to JImageClose, to
53 * release memory and resources used. If the image file is not found or cannot
54 * be open, then NULL is returned and error will contain a reason for the
55 * failure; a positive value for a system error number, negative for a jimage
56 * specific error (see JImage Error Codes.)
57 *
58 * Ex.
59 * jint error;
60 * JImageFile* jimage = (*JImageOpen)(JAVA_HOME "lib/modules", &error);
61 * if (image == NULL) {
62 * tty->print_cr("JImage failed to open: %d", error);
63 * ...
64 * }
65 * ...
66 */
67 extern "C" JNIEXPORT JImageFile*
68 JIMAGE_Open(const char *name, jint* error) {
69 // TODO - return a meaningful error code
70 *error = 0;
71 ImageFileReader* jfile = ImageFileReader::open(name);
72 return (JImageFile*) jfile;
73 }
74
75 /*
76 * JImageClose - Given the supplied open image file (see JImageOpen), release
77 * memory and resources used by the open file and close the file. If the image
78 * file is shared by other uses, release and close is deferred until the last use
79 * is also closed.
80 *
81 * Ex.
82 * (*JImageClose)(image);
83 */
84 extern "C" JNIEXPORT void
85 JIMAGE_Close(JImageFile* image) {
86 ImageFileReader::close((ImageFileReader*) image);
87 }
88
89 /*
90 * JImagePackageToModule - Given an open image file (see JImageOpen) and the name
91 * of a package, return the name of module where the package resides. If the
92 * package does not exist in the image file, the function returns NULL.
93 * The resulting string does/should not have to be released. All strings are
94 * utf-8, zero byte terminated.
95 *
96 * Ex.
97 * const char* package = (*JImagePackageToModule)(image, "java/lang");
98 * tty->print_cr(package);
99 * -> java.base
100 */
101 extern "C" JNIEXPORT const char*
102 JIMAGE_PackageToModule(JImageFile* image, const char* package_name) {
103 return ((ImageFileReader*) image)->get_image_module_data()->package_to_module(package_name);
104 }
105
106 /*
107 * JImageFindResource - Given an open image file (see JImageOpen), a module
108 * name, a version string and the name of a class/resource, return location
109 * information describing the resource and its size. If no resource is found, the
110 * function returns JIMAGE_NOT_FOUND and the value of size is undefined.
111 * The version number should be "9.0" and is not used in locating the resource.
112 * The resulting location does/should not have to be released.
113 * All strings are utf-8, zero byte terminated.
114 *
115 * Ex.
116 * jlong size;
117 * JImageLocationRef location = (*JImageFindResource)(image,
118 * "java.base", "9.0", "java/lang/String.class", &size);
119 */
120 extern "C" JNIEXPORT JImageLocationRef
121 JIMAGE_FindResource(JImageFile* image,
122 const char* module_name, const char* version, const char* name,
123 jlong* size) {
124 // Concatenate to get full path
125 char fullpath[IMAGE_MAX_PATH];
126 size_t moduleNameLen = strlen(module_name);
127 size_t nameLen = strlen(name);
128 size_t index;
129
130 // TBD: assert(moduleNameLen > 0 && "module name must be non-empty");
131 assert(nameLen > 0 && "name must non-empty");
132
133 // If the concatenated string is too long for the buffer, return not found
134 if (1 + moduleNameLen + 1 + nameLen + 1 > IMAGE_MAX_PATH) {
135 return 0L;
136 }
137
138 index = 0;
139 fullpath[index++] = '/';
140 memcpy(&fullpath[index], module_name, moduleNameLen);
141 index += moduleNameLen;
142 fullpath[index++] = '/';
143 memcpy(&fullpath[index], name, nameLen);
144 index += nameLen;
145 fullpath[index++] = '\0';
146
147 JImageLocationRef loc =
148 (JImageLocationRef) ((ImageFileReader*) image)->find_location_index(fullpath, (u8*) size);
149 return loc;
150 }
151
152 /*
153 * JImageGetResource - Given an open image file (see JImageOpen), a resource's
154 * location information (see JImageFindResource), a buffer of appropriate
155 * size and the size, retrieve the bytes associated with the
156 * resource. If the size is less than the resource size then the read is truncated.
157 * If the size is greater than the resource size then the remainder of the buffer
158 * is zero filled. The function will return the actual size of the resource.
159 *
160 * Ex.
161 * jlong size;
162 * JImageLocationRef location = (*JImageFindResource)(image,
163 * "java.base", "9.0", "java/lang/String.class", &size);
164 * char* buffer = new char[size];
165 * (*JImageGetResource)(image, location, buffer, size);
166 */
167 extern "C" JNIEXPORT jlong
168 JIMAGE_GetResource(JImageFile* image, JImageLocationRef location,
169 char* buffer, jlong size) {
170 ((ImageFileReader*) image)->get_resource((u4) location, (u1*) buffer);
171 return size;
172 }
173
174 /*
175 * JImageResourceIterator - Given an open image file (see JImageOpen), a visitor
176 * function and a visitor argument, iterator through each of the image's resources.
177 * The visitor function is called with the image file, the module name, the
178 * package name, the base name, the extension and the visitor argument. The return
179 * value of the visitor function should be true, unless an early iteration exit is
180 * required. All strings are utf-8, zero byte terminated.file.
181 *
182 * Ex.
183 * bool ctw_visitor(JImageFile* jimage, const char* module_name, const char* version,
184 * const char* package, const char* name, const char* extension, void* arg) {
185 * if (strcmp(extension, "class") == 0) {
186 * char path[JIMAGE_MAX_PATH];
187 * Thread* THREAD = Thread::current();
188 * jio_snprintf(path, JIMAGE_MAX_PATH - 1, "/%s/%s", package, name);
189 * ClassLoader::compile_the_world_in(path, (Handle)arg, THREAD);
190 * return !HAS_PENDING_EXCEPTION;
191 * }
192 * return true;
193 * }
194 * (*JImageResourceIterator)(image, ctw_visitor, loader);
195 */
196 extern "C" JNIEXPORT void
197 JIMAGE_ResourceIterator(JImageFile* image,
198 JImageResourceVisitor_t visitor, void* arg) {
199 ImageFileReader* imageFile = (ImageFileReader*) image;
200 u4 nEntries = imageFile->table_length();
201 const ImageStrings strings = imageFile->get_strings();
202 for (u4 i = 0; i < nEntries; i++) {
203 ImageLocation location(imageFile->get_location_data(i));
204
205 u4 moduleOffset = (u4) location.get_attribute(ImageLocation::ATTRIBUTE_MODULE);
206 if (moduleOffset == 0) {
207 continue; // skip non-modules
208 }
209 const char *module = strings.get(moduleOffset);
210 if (strcmp(module, "modules") == 0
211 || strcmp(module, "packages") == 0) {
212 continue; // always skip
213 }
214
215 u4 parentOffset = (u4) location.get_attribute(ImageLocation::ATTRIBUTE_PARENT);
216 const char *parent = strings.get(parentOffset);
217 u4 baseOffset = (u4) location.get_attribute(ImageLocation::ATTRIBUTE_BASE);
218 const char *base = strings.get(baseOffset);
219 u4 extOffset = (u4) location.get_attribute(ImageLocation::ATTRIBUTE_EXTENSION);
220 const char *extension = strings.get(extOffset);
221
222 if (!(*visitor)(image, module, "9", parent, base, extension, arg)) {
223 break;
224 }
225 }
226 }