1 /*
2 * Copyright (c) 2023, 2024, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #include "precompiled.hpp"
26 #include "jvm_io.h"
27 #include "runtime/arguments.hpp"
28 #include "runtime/interfaceSupport.inline.hpp"
29 #include "runtime/os.inline.hpp"
30 #include "runtime/semaphore.inline.hpp"
31 #include "runtime/thread.inline.hpp"
32 #include "utilities/zipLibrary.hpp"
33
34 // Entry points in zip.dll for loading zip/jar file entries
35 typedef void**(*ZIP_Open_t)(const char* name, char** pmsg);
36 typedef void(*ZIP_Close_t)(jzfile* zip);
37 typedef jzentry* (*ZIP_FindEntry_t)(jzfile* zip, const char* name, jint* sizeP, jint* nameLen);
38 typedef jboolean(*ZIP_ReadEntry_t)(jzfile* zip, jzentry* entry, unsigned char* buf, char* namebuf);
39 typedef void(*ZIP_FreeEntry_t)(jzfile *zip, jzentry *entry);
40 typedef jint(*ZIP_CRC32_t)(jint crc, const jbyte* buf, jint len);
41 typedef const char* (*ZIP_GZip_InitParams_t)(size_t, size_t*, size_t*, int);
42 typedef size_t(*ZIP_GZip_Fully_t)(char*, size_t, char*, size_t, char*, size_t, int, char*, char const**);
43
44 static ZIP_Open_t ZIP_Open = nullptr;
45 static ZIP_Close_t ZIP_Close = nullptr;
46 static ZIP_FindEntry_t ZIP_FindEntry = nullptr;
47 static ZIP_ReadEntry_t ZIP_ReadEntry = nullptr;
48 static ZIP_FreeEntry_t ZIP_FreeEntry = nullptr;
49 static ZIP_CRC32_t ZIP_CRC32 = nullptr;
50 static ZIP_GZip_InitParams_t ZIP_GZip_InitParams = nullptr;
51 static ZIP_GZip_Fully_t ZIP_GZip_Fully = nullptr;
52
53 static void* _zip_handle = nullptr;
54 static bool _loaded = false;
55
56 static inline bool is_loaded() {
57 return Atomic::load_acquire(&_loaded);
58 }
59
60 static inline bool not_loaded() {
61 return !is_loaded();
62 }
63
64 static void* dll_lookup(const char* name, const char* path, bool vm_exit_on_failure) {
65 if (is_vm_statically_linked()) {
66 return os::lookup_function(name);
67 }
68
69 assert(_zip_handle != nullptr, "invariant");
70 void* func = os::dll_lookup(_zip_handle, name);
71 if (func == nullptr && vm_exit_on_failure) {
72 char msg[256] = "";
73 jio_snprintf(&msg[0], sizeof msg, "Could not resolve \"%s\"", name);
74 vm_exit_during_initialization(&msg[0], path);
75 }
76 return func;
77 }
78
79 static void store_function_pointers(const char* path, bool vm_exit_on_failure) {
80 assert(_zip_handle != nullptr, "invariant");
81 ZIP_Open = CAST_TO_FN_PTR(ZIP_Open_t, dll_lookup("ZIP_Open", path, vm_exit_on_failure));
82 ZIP_Close = CAST_TO_FN_PTR(ZIP_Close_t, dll_lookup("ZIP_Close", path, vm_exit_on_failure));
83 ZIP_FindEntry = CAST_TO_FN_PTR(ZIP_FindEntry_t, dll_lookup("ZIP_FindEntry", path, vm_exit_on_failure));
84 ZIP_ReadEntry = CAST_TO_FN_PTR(ZIP_ReadEntry_t, dll_lookup("ZIP_ReadEntry", path, vm_exit_on_failure));
85 ZIP_FreeEntry = CAST_TO_FN_PTR(ZIP_FreeEntry_t, dll_lookup("ZIP_FreeEntry", path, vm_exit_on_failure));
86 ZIP_CRC32 = CAST_TO_FN_PTR(ZIP_CRC32_t, dll_lookup("ZIP_CRC32", path, vm_exit_on_failure));
87 // The following entry points are most likely optional from a zip library implementation perspective.
88 // Hence no vm_exit on a resolution failure. Further refactorings should investigate this,
89 // and if possible, streamline setting all entry points consistently.
90 ZIP_GZip_InitParams = CAST_TO_FN_PTR(ZIP_GZip_InitParams_t, dll_lookup("ZIP_GZip_InitParams", path, false));
91 ZIP_GZip_Fully = CAST_TO_FN_PTR(ZIP_GZip_Fully_t, dll_lookup("ZIP_GZip_Fully", path, false));
92 }
93
94 static void load_zip_library(bool vm_exit_on_failure) {
95 assert(!is_loaded(), "should not load zip library twice");
96 char path[JVM_MAXPATHLEN];
97
98 if (is_vm_statically_linked()) {
99 _zip_handle = os::get_default_process_handle();
100 } else {
101 // Load the libzip shared library and lookup the needed functions.
102 if (os::dll_locate_lib(&path[0], sizeof path, Arguments::get_dll_dir(), "zip")) {
103 char ebuf[1024];
104 _zip_handle = os::dll_load(&path[0], &ebuf[0], sizeof ebuf);
105 }
106 if (_zip_handle == nullptr) {
107 if (vm_exit_on_failure) {
108 vm_exit_during_initialization("Unable to load zip library", &path[0]);
109 }
110 return;
111 }
112 }
113
114 store_function_pointers(&path[0], vm_exit_on_failure);
115 Atomic::release_store(&_loaded, true);
116 assert(is_loaded(), "invariant");
117 }
118
119 //
120 // Helper mutex class that also ensures that java threads
121 // are in _thread_in_native when loading the zip library.
122 //
123 class ZipLibraryLoaderLock : public StackObj {
124 private:
125 static Semaphore _lock;
126 JavaThread* _jt;
127 public:
128 ZipLibraryLoaderLock() : _jt(nullptr) {
129 Thread* thread = Thread::current_or_null();
130 if (thread != nullptr && thread->is_Java_thread()) {
131 JavaThread* const jt = JavaThread::cast(thread);
132 if (jt->thread_state() != _thread_in_native) {
133 _jt = jt;
134 ThreadStateTransition::transition_from_vm(jt, _thread_in_native, false);
135 }
136 }
137 _lock.wait();
138 }
139 ~ZipLibraryLoaderLock() {
140 _lock.signal();
141 if (_jt != nullptr) {
142 ThreadStateTransition::transition_from_native(_jt, _thread_in_vm, false);
143 }
144 }
145 };
146
147 Semaphore ZipLibraryLoaderLock::_lock(1);
148
149 static void initialize(bool vm_exit_on_failure = true) {
150 if (is_loaded()) {
151 return;
152 }
153 ZipLibraryLoaderLock lock;
154 if (not_loaded()) {
155 load_zip_library(vm_exit_on_failure);
156 }
157 }
158
159 void** ZipLibrary::open(const char* name, char** pmsg) {
160 initialize();
161 assert(ZIP_Open != nullptr, "invariant");
162 return ZIP_Open(name, pmsg);
163 }
164
165 void ZipLibrary::close(jzfile* zip) {
166 assert(is_loaded(), "invariant");
167 assert(ZIP_Close != nullptr, "invariant");
168 ZIP_Close(zip);
169 }
170
171 jzentry* ZipLibrary::find_entry(jzfile* zip, const char* name, jint* sizeP, jint* nameLen) {
172 initialize();
173 assert(ZIP_FindEntry != nullptr, "invariant");
174 return ZIP_FindEntry(zip, name, sizeP, nameLen);
175 }
176
177 jboolean ZipLibrary::read_entry(jzfile* zip, jzentry* entry, unsigned char* buf, char* namebuf) {
178 initialize();
179 assert(ZIP_ReadEntry != nullptr, "invariant");
180 return ZIP_ReadEntry(zip, entry, buf, namebuf);
181 }
182
183 void ZipLibrary::free_entry(jzfile* zip, jzentry* entry) {
184 initialize();
185 assert(ZIP_FreeEntry != nullptr, "invariant");
186 ZIP_FreeEntry(zip, entry);
187 }
188
189 jint ZipLibrary::crc32(jint crc, const jbyte* buf, jint len) {
190 initialize();
191 assert(ZIP_CRC32 != nullptr, "invariant");
192 return ZIP_CRC32(crc, buf, len);
193 }
194
195 const char* ZipLibrary::init_params(size_t block_size, size_t* needed_out_size, size_t* needed_tmp_size, int level) {
196 initialize(false);
197 if (ZIP_GZip_InitParams == nullptr) {
198 return "Cannot get ZIP_GZip_InitParams function";
199 }
200 return ZIP_GZip_InitParams(block_size, needed_out_size, needed_tmp_size, level);
201 }
202
203 size_t ZipLibrary::compress(char* in, size_t in_size, char* out, size_t out_size, char* tmp, size_t tmp_size, int level, char* buf, const char** pmsg) {
204 initialize(false);
205 if (ZIP_GZip_Fully == nullptr) {
206 *pmsg = "Cannot get ZIP_GZip_Fully function";
207 return 0;
208 }
209 return ZIP_GZip_Fully(in, in_size, out, out_size, tmp, tmp_size, level, buf, pmsg);
210 }
211
212 void* ZipLibrary::handle() {
213 initialize();
214 assert(is_loaded(), "invariant");
215 assert(_zip_handle != nullptr, "invariant");
216 return _zip_handle;
217 }