1 /*
2 * Copyright (c) 1999, 2018, 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 #ifndef OS_LINUX_VM_OS_LINUX_HPP
26 #define OS_LINUX_VM_OS_LINUX_HPP
27
28 // Linux_OS defines the interface to Linux operating systems
29
30 // Information about the protection of the page at address '0' on this os.
31 static bool zero_page_read_protected() { return true; }
32
33 class Linux {
34 friend class os;
35 friend class OSContainer;
36 friend class TestReserveMemorySpecial;
37
38 static bool libjsig_is_loaded; // libjsig that interposes sigaction(),
39 // __sigaction(), signal() is loaded
40 static struct sigaction *(*get_signal_action)(int);
41 static struct sigaction *get_preinstalled_handler(int);
42 static void save_preinstalled_handler(int, struct sigaction&);
43
44 static void check_signal_handler(int sig);
45
46 static int (*_clock_gettime)(clockid_t, struct timespec *);
47 static int (*_pthread_getcpuclockid)(pthread_t, clockid_t *);
48 static int (*_pthread_setname_np)(pthread_t, const char*);
49
50 static address _initial_thread_stack_bottom;
51 static uintptr_t _initial_thread_stack_size;
52
53 static const char *_glibc_version;
54 static const char *_libpthread_version;
55
56 static bool _supports_fast_thread_cpu_time;
57
58 static GrowableArray<int>* _cpu_to_node;
59 static GrowableArray<int>* _nindex_to_node;
60
61 // 0x00000000 = uninitialized,
62 // 0x01000000 = kernel version unknown,
63 // otherwise a 32-bit number:
64 // Ox00AABBCC
65 // AA, Major Version
66 // BB, Minor Version
67 // CC, Fix Version
68 static uint32_t _os_version;
69
70 protected:
71
72 static julong _physical_memory;
73 static pthread_t _main_thread;
74 static Mutex* _createThread_lock;
75 static int _page_size;
76
77 static julong available_memory();
78 static julong physical_memory() { return _physical_memory; }
79 static void set_physical_memory(julong phys_mem) { _physical_memory = phys_mem; }
80 static int active_processor_count();
81
82 static void initialize_system_info();
83
84 static int commit_memory_impl(char* addr, size_t bytes, bool exec);
85 static int commit_memory_impl(char* addr, size_t bytes,
86 size_t alignment_hint, bool exec);
87
88 static void set_glibc_version(const char *s) { _glibc_version = s; }
89 static void set_libpthread_version(const char *s) { _libpthread_version = s; }
90
91 static void rebuild_cpu_to_node_map();
92 static void rebuild_nindex_to_node_map();
93 static GrowableArray<int>* cpu_to_node() { return _cpu_to_node; }
94 static GrowableArray<int>* nindex_to_node() { return _nindex_to_node; }
95
96 static size_t find_large_page_size();
97 static size_t setup_large_page_size();
98
99 static bool setup_large_page_type(size_t page_size);
100 static bool transparent_huge_pages_sanity_check(bool warn, size_t pages_size);
101 static bool hugetlbfs_sanity_check(bool warn, size_t page_size);
102
103 static char* reserve_memory_special_shm(size_t bytes, size_t alignment, char* req_addr, bool exec);
104 static char* reserve_memory_special_huge_tlbfs(size_t bytes, size_t alignment, char* req_addr, bool exec);
105 static char* reserve_memory_special_huge_tlbfs_only(size_t bytes, char* req_addr, bool exec);
106 static char* reserve_memory_special_huge_tlbfs_mixed(size_t bytes, size_t alignment, char* req_addr, bool exec);
107
108 static bool release_memory_special_impl(char* base, size_t bytes);
109 static bool release_memory_special_shm(char* base, size_t bytes);
110 static bool release_memory_special_huge_tlbfs(char* base, size_t bytes);
111
112 static void print_full_memory_info(outputStream* st);
113 static void print_container_info(outputStream* st);
114 static void print_distro_info(outputStream* st);
115 static void print_libversion_info(outputStream* st);
116 static void print_proc_sys_info(outputStream* st);
117 static void print_ld_preload_file(outputStream* st);
118
119 public:
120 static bool _stack_is_executable;
121 static void *dlopen_helper(const char *name, char *ebuf, int ebuflen);
122 static void *dll_load_in_vmthread(const char *name, char *ebuf, int ebuflen);
123
124 static void init_thread_fpu_state();
125 static int get_fpu_control_word();
126 static void set_fpu_control_word(int fpu_control);
127 static pthread_t main_thread(void) { return _main_thread; }
128 // returns kernel thread id (similar to LWP id on Solaris), which can be
129 // used to access /proc
130 static pid_t gettid();
131 static void set_createThread_lock(Mutex* lk) { _createThread_lock = lk; }
132 static Mutex* createThread_lock(void) { return _createThread_lock; }
133 static void hotspot_sigmask(Thread* thread);
134
135 static address initial_thread_stack_bottom(void) { return _initial_thread_stack_bottom; }
136 static uintptr_t initial_thread_stack_size(void) { return _initial_thread_stack_size; }
137
138 static int page_size(void) { return _page_size; }
139 static void set_page_size(int val) { _page_size = val; }
140
141 static address ucontext_get_pc(const ucontext_t* uc);
142 static void ucontext_set_pc(ucontext_t* uc, address pc);
143 static intptr_t* ucontext_get_sp(const ucontext_t* uc);
144 static intptr_t* ucontext_get_fp(const ucontext_t* uc);
145
146 // For Analyzer Forte AsyncGetCallTrace profiling support:
147 //
148 // This interface should be declared in os_linux_i486.hpp, but
149 // that file provides extensions to the os class and not the
150 // Linux class.
151 static ExtendedPC fetch_frame_from_ucontext(Thread* thread, const ucontext_t* uc,
152 intptr_t** ret_sp, intptr_t** ret_fp);
153
154 static bool get_frame_at_stack_banging_point(JavaThread* thread, ucontext_t* uc, frame* fr);
155
156 // This boolean allows users to forward their own non-matching signals
157 // to JVM_handle_linux_signal, harmlessly.
158 static bool signal_handlers_are_installed;
159
160 static int get_our_sigflags(int);
161 static void set_our_sigflags(int, int);
162 static void signal_sets_init();
163 static void install_signal_handlers();
164 static void set_signal_handler(int, bool);
165
166 static sigset_t* unblocked_signals();
167 static sigset_t* vm_signals();
168
169 // For signal-chaining
170 static struct sigaction *get_chained_signal_action(int sig);
171 static bool chained_handler(int sig, siginfo_t* siginfo, void* context);
172
173 // GNU libc and libpthread version strings
174 static const char *glibc_version() { return _glibc_version; }
175 static const char *libpthread_version() { return _libpthread_version; }
176
177 static void libpthread_init();
178 static void sched_getcpu_init();
179 static bool libnuma_init();
180 static void* libnuma_dlsym(void* handle, const char* name);
181 // libnuma v2 (libnuma_1.2) symbols
182 static void* libnuma_v2_dlsym(void* handle, const char* name);
183
184 // Return default guard size for the specified thread type
185 static size_t default_guard_size(os::ThreadType thr_type);
186
187 static void capture_initial_stack(size_t max_size);
188
189 // Stack overflow handling
190 static bool manually_expand_stack(JavaThread * t, address addr);
191 static int max_register_window_saves_before_flushing();
192
193 // Real-time clock functions
194 static void clock_init(void);
195
196 // fast POSIX clocks support
197 static void fast_thread_clock_init(void);
198
199 static int clock_gettime(clockid_t clock_id, struct timespec *tp) {
200 return _clock_gettime ? _clock_gettime(clock_id, tp) : -1;
201 }
202
203 static int pthread_getcpuclockid(pthread_t tid, clockid_t *clock_id) {
204 return _pthread_getcpuclockid ? _pthread_getcpuclockid(tid, clock_id) : -1;
205 }
206
207 static bool supports_fast_thread_cpu_time() {
208 return _supports_fast_thread_cpu_time;
209 }
210
211 static jlong fast_thread_cpu_time(clockid_t clockid);
212
213 static void initialize_os_info();
214 static bool os_version_is_known();
215 static uint32_t os_version();
216
217 // Stack repair handling
218
219 // none present
220
221 private:
222 static void expand_stack_to(address bottom);
223
224 typedef int (*sched_getcpu_func_t)(void);
225 typedef int (*numa_node_to_cpus_func_t)(int node, unsigned long *buffer, int bufferlen);
226 typedef int (*numa_max_node_func_t)(void);
227 typedef int (*numa_num_configured_nodes_func_t)(void);
228 typedef int (*numa_available_func_t)(void);
229 typedef int (*numa_tonode_memory_func_t)(void *start, size_t size, int node);
230 typedef void (*numa_interleave_memory_func_t)(void *start, size_t size, unsigned long *nodemask);
231 typedef void (*numa_interleave_memory_v2_func_t)(void *start, size_t size, struct bitmask* mask);
232 typedef struct bitmask* (*numa_get_membind_func_t)(void);
233
234 typedef void (*numa_set_bind_policy_func_t)(int policy);
235 typedef int (*numa_bitmask_isbitset_func_t)(struct bitmask *bmp, unsigned int n);
236 typedef int (*numa_distance_func_t)(int node1, int node2);
237
238 static sched_getcpu_func_t _sched_getcpu;
239 static numa_node_to_cpus_func_t _numa_node_to_cpus;
240 static numa_max_node_func_t _numa_max_node;
241 static numa_num_configured_nodes_func_t _numa_num_configured_nodes;
242 static numa_available_func_t _numa_available;
243 static numa_tonode_memory_func_t _numa_tonode_memory;
244 static numa_interleave_memory_func_t _numa_interleave_memory;
245 static numa_interleave_memory_v2_func_t _numa_interleave_memory_v2;
246 static numa_set_bind_policy_func_t _numa_set_bind_policy;
247 static numa_bitmask_isbitset_func_t _numa_bitmask_isbitset;
248 static numa_distance_func_t _numa_distance;
249 static numa_get_membind_func_t _numa_get_membind;
250 static unsigned long* _numa_all_nodes;
251 static struct bitmask* _numa_all_nodes_ptr;
252 static struct bitmask* _numa_nodes_ptr;
253
254 static void set_sched_getcpu(sched_getcpu_func_t func) { _sched_getcpu = func; }
255 static void set_numa_node_to_cpus(numa_node_to_cpus_func_t func) { _numa_node_to_cpus = func; }
256 static void set_numa_max_node(numa_max_node_func_t func) { _numa_max_node = func; }
257 static void set_numa_num_configured_nodes(numa_num_configured_nodes_func_t func) { _numa_num_configured_nodes = func; }
258 static void set_numa_available(numa_available_func_t func) { _numa_available = func; }
259 static void set_numa_tonode_memory(numa_tonode_memory_func_t func) { _numa_tonode_memory = func; }
260 static void set_numa_interleave_memory(numa_interleave_memory_func_t func) { _numa_interleave_memory = func; }
261 static void set_numa_interleave_memory_v2(numa_interleave_memory_v2_func_t func) { _numa_interleave_memory_v2 = func; }
262 static void set_numa_set_bind_policy(numa_set_bind_policy_func_t func) { _numa_set_bind_policy = func; }
263 static void set_numa_bitmask_isbitset(numa_bitmask_isbitset_func_t func) { _numa_bitmask_isbitset = func; }
264 static void set_numa_distance(numa_distance_func_t func) { _numa_distance = func; }
265 static void set_numa_get_membind(numa_get_membind_func_t func) { _numa_get_membind = func; }
266 static void set_numa_all_nodes(unsigned long* ptr) { _numa_all_nodes = ptr; }
267 static void set_numa_all_nodes_ptr(struct bitmask **ptr) { _numa_all_nodes_ptr = (ptr == NULL ? NULL : *ptr); }
268 static void set_numa_nodes_ptr(struct bitmask **ptr) { _numa_nodes_ptr = (ptr == NULL ? NULL : *ptr); }
269 static int sched_getcpu_syscall(void);
270 public:
271 static int sched_getcpu() { return _sched_getcpu != NULL ? _sched_getcpu() : -1; }
272 static int numa_node_to_cpus(int node, unsigned long *buffer, int bufferlen) {
273 return _numa_node_to_cpus != NULL ? _numa_node_to_cpus(node, buffer, bufferlen) : -1;
274 }
275 static int numa_max_node() { return _numa_max_node != NULL ? _numa_max_node() : -1; }
276 static int numa_num_configured_nodes() {
277 return _numa_num_configured_nodes != NULL ? _numa_num_configured_nodes() : -1;
278 }
279 static int numa_available() { return _numa_available != NULL ? _numa_available() : -1; }
280 static int numa_tonode_memory(void *start, size_t size, int node) {
281 return _numa_tonode_memory != NULL ? _numa_tonode_memory(start, size, node) : -1;
282 }
283 static void numa_interleave_memory(void *start, size_t size) {
284 // Use v2 api if available
285 if (_numa_interleave_memory_v2 != NULL && _numa_all_nodes_ptr != NULL) {
286 _numa_interleave_memory_v2(start, size, _numa_all_nodes_ptr);
287 } else if (_numa_interleave_memory != NULL && _numa_all_nodes != NULL) {
288 _numa_interleave_memory(start, size, _numa_all_nodes);
289 }
290 }
291 static void numa_set_bind_policy(int policy) {
292 if (_numa_set_bind_policy != NULL) {
293 _numa_set_bind_policy(policy);
294 }
295 }
296 static int numa_distance(int node1, int node2) {
297 return _numa_distance != NULL ? _numa_distance(node1, node2) : -1;
298 }
299 static int get_node_by_cpu(int cpu_id);
300 static int get_existing_num_nodes();
301 // Check if numa node is configured (non-zero memory node).
302 static bool isnode_in_configured_nodes(unsigned int n) {
303 if (_numa_bitmask_isbitset != NULL && _numa_all_nodes_ptr != NULL) {
304 return _numa_bitmask_isbitset(_numa_all_nodes_ptr, n);
305 } else
306 return false;
307 }
308 // Check if numa node exists in the system (including zero memory nodes).
309 static bool isnode_in_existing_nodes(unsigned int n) {
310 if (_numa_bitmask_isbitset != NULL && _numa_nodes_ptr != NULL) {
311 return _numa_bitmask_isbitset(_numa_nodes_ptr, n);
312 } else if (_numa_bitmask_isbitset != NULL && _numa_all_nodes_ptr != NULL) {
313 // Not all libnuma API v2 implement numa_nodes_ptr, so it's not possible
314 // to trust the API version for checking its absence. On the other hand,
315 // numa_nodes_ptr found in libnuma 2.0.9 and above is the only way to get
316 // a complete view of all numa nodes in the system, hence numa_nodes_ptr
317 // is used to handle CPU and nodes on architectures (like PowerPC) where
318 // there can exist nodes with CPUs but no memory or vice-versa and the
319 // nodes may be non-contiguous. For most of the architectures, like
320 // x86_64, numa_node_ptr presents the same node set as found in
321 // numa_all_nodes_ptr so it's possible to use numa_all_nodes_ptr as a
322 // substitute.
323 return _numa_bitmask_isbitset(_numa_all_nodes_ptr, n);
324 } else
325 return false;
326 }
327 // Check if node is in bound node set.
328 static bool isnode_in_bound_nodes(int node) {
329 if (_numa_get_membind != NULL && _numa_bitmask_isbitset != NULL) {
330 return _numa_bitmask_isbitset(_numa_get_membind(), node);
331 } else {
332 return false;
333 }
334 }
335 // Check if bound to only one numa node.
336 // Returns true if bound to a single numa node, otherwise returns false.
337 static bool isbound_to_single_node() {
338 int nodes = 0;
339 struct bitmask* bmp = NULL;
340 unsigned int node = 0;
341 unsigned int highest_node_number = 0;
342
343 if (_numa_get_membind != NULL && _numa_max_node != NULL && _numa_bitmask_isbitset != NULL) {
344 bmp = _numa_get_membind();
345 highest_node_number = _numa_max_node();
346 } else {
347 return false;
348 }
349
350 for (node = 0; node <= highest_node_number; node++) {
351 if (_numa_bitmask_isbitset(bmp, node)) {
352 nodes++;
353 }
354 }
355
356 if (nodes == 1) {
357 return true;
358 } else {
359 return false;
360 }
361 }
362 };
363
364 #endif // OS_LINUX_VM_OS_LINUX_HPP