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