1/*
2 * Copyright (c) 2015, 2019, 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.
35class JImageFile;
36// Opaque reference to an image file resource location.
37typedef 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
75extern "C" JNIEXPORT JImageFile*
76JIMAGE_Open(const char *name, jint* error);
77
78typedef JImageFile* (*JImageOpen_t)(const char *name, jint* error);
79
80/*
81 * JImageClose - Given the supplied open image file (see JImageOpen), release
82 * memory and resources used by the open file and close the file. If the image
83 * file is shared by other uses, release and close is deferred until the last use
84 * is also closed.
85 *
86 * Ex.
87 * (*JImageClose)(image);
88 */
89
90extern "C" JNIEXPORT void
91JIMAGE_Close(JImageFile* jimage);
92
93typedef void (*JImageClose_t)(JImageFile* jimage);
94
95
96/*
97 * JImagePackageToModule - Given an open image file (see JImageOpen) and the name
98 * of a package, return the name of module where the package resides. If the
99 * package does not exist in the image file, the function returns NULL.
100 * The resulting string does/should not have to be released. All strings are
101 * utf-8, zero byte terminated.
102 *
103 * Ex.
104 * const char* package = (*JImagePackageToModule)(image, "java/lang");
105 * tty->print_cr(package);
106 * -> java.base
107 */
108
109extern "C" JNIEXPORT const char *
110JIMAGE_PackageToModule(JImageFile* jimage, const char* package_name);
111
112typedef const char* (*JImagePackageToModule_t)(JImageFile* jimage, const char* package_name);
113
114
115/*
116 * JImageFindResource - Given an open image file (see JImageOpen), a module
117 * name, a version string and the name of a class/resource, return location
118 * information describing the resource and its size. If no resource is found, the
119 * function returns JIMAGE_NOT_FOUND and the value of size is undefined.
120 * The version number should be "9.0" and is not used in locating the resource.
121 * The resulting location does/should not have to be released.
122 * All strings are utf-8, zero byte terminated.
123 *
124 * Ex.
125 * jlong size;
126 * JImageLocationRef location = (*JImageFindResource)(image,
127 * "java.base", "9.0", "java/lang/String.class", &size);
128 */
129extern "C" JNIEXPORT JImageLocationRef JIMAGE_FindResource(JImageFile* jimage,
130 const char* module_name, const char* version, const char* name,
131 jlong* size);
132
133typedef JImageLocationRef(*JImageFindResource_t)(JImageFile* jimage,
134 const char* module_name, const char* version, const char* name,
135 jlong* size);
136
137
138/*
139 * JImageGetResource - Given an open image file (see JImageOpen), a resource's
140 * location information (see JImageFindResource), a buffer of appropriate
141 * size and the size, retrieve the bytes associated with the
142 * resource. If the size is less than the resource size then the read is truncated.
143 * If the size is greater than the resource size then the remainder of the buffer
144 * is zero filled. The function will return the actual size of the resource.
145 *
146 * Ex.
147 * jlong size;
148 * JImageLocationRef location = (*JImageFindResource)(image,
149 * "java.base", "9.0", "java/lang/String.class", &size);
150 * char* buffer = new char[size];
151 * (*JImageGetResource)(image, location, buffer, size);
152 */
153extern "C" JNIEXPORT jlong
154JIMAGE_GetResource(JImageFile* jimage, JImageLocationRef location,
155 char* buffer, jlong size);
156
157typedef jlong(*JImageGetResource_t)(JImageFile* jimage, JImageLocationRef location,
158 char* buffer, jlong size);
159
160
161/*
162 * JImageResourceIterator - Given an open image file (see JImageOpen), a visitor
163 * function and a visitor argument, iterator through each of the image's resources.
164 * The visitor function is called with the image file, the module name, the
165 * package name, the base name, the extension and the visitor argument. The return
166 * value of the visitor function should be true, unless an early iteration exit is
167 * required. All strings are utf-8, zero byte terminated.file.
168 *
169 * Ex.
170 * bool ctw_visitor(JImageFile* jimage, const char* module_name, const char* version,
171 * const char* package, const char* name, const char* extension, void* arg) {
172 * if (strcmp(extension, "class") == 0) {
173 * char path[JIMAGE_MAX_PATH];
174 * Thread* THREAD = Thread::current();
175 * jio_snprintf(path, JIMAGE_MAX_PATH - 1, "/%s/%s", package, name);
176 * ClassLoader::compile_the_world_in(path, (Handle)arg, THREAD);
177 * return !HAS_PENDING_EXCEPTION;
178 * }
179 * return true;
180 * }
181 * (*JImageResourceIterator)(image, ctw_visitor, loader);
182 */
183
184typedef bool (*JImageResourceVisitor_t)(JImageFile* jimage,
185 const char* module_name, const char* version, const char* package,
186 const char* name, const char* extension, void* arg);
187
188extern "C" JNIEXPORT void
189JIMAGE_ResourceIterator(JImageFile* jimage,
190 JImageResourceVisitor_t visitor, void *arg);
191
192typedef void (*JImageResourceIterator_t)(JImageFile* jimage,
193 JImageResourceVisitor_t visitor, void* arg);
194