os_linux.hpp revision 4240:63e54c37ac64 
1/*
2 * Copyright (c) 1999, 2013, 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/* pthread_getattr_np comes with LinuxThreads-0.9-7 on RedHat 7.1 */
31typedef int (*pthread_getattr_func_type) (pthread_t, pthread_attr_t *);
32
33class Linux {
34  friend class os;
35
36  // For signal-chaining
37#define MAXSIGNUM 32
38  static struct sigaction sigact[MAXSIGNUM]; // saved preinstalled sigactions
39  static unsigned int sigs;             // mask of signals that have
40                                        // preinstalled signal handlers
41  static bool libjsig_is_loaded;        // libjsig that interposes sigaction(),
42                                        // __sigaction(), signal() is loaded
43  static struct sigaction *(*get_signal_action)(int);
44  static struct sigaction *get_preinstalled_handler(int);
45  static void save_preinstalled_handler(int, struct sigaction&);
46
47  static void check_signal_handler(int sig);
48
49  // For signal flags diagnostics
50  static int sigflags[MAXSIGNUM];
51
52  static int (*_clock_gettime)(clockid_t, struct timespec *);
53  static int (*_pthread_getcpuclockid)(pthread_t, clockid_t *);
54
55  static address   _initial_thread_stack_bottom;
56  static uintptr_t _initial_thread_stack_size;
57
58  static const char *_glibc_version;
59  static const char *_libpthread_version;
60
61  static bool _is_floating_stack;
62  static bool _is_NPTL;
63  static bool _supports_fast_thread_cpu_time;
64
65  static GrowableArray<int>* _cpu_to_node;
66
67 protected:
68
69  static julong _physical_memory;
70  static pthread_t _main_thread;
71  static Mutex* _createThread_lock;
72  static int _page_size;
73
74  static julong available_memory();
75  static julong physical_memory() { return _physical_memory; }
76  static void initialize_system_info();
77
78  static void set_glibc_version(const char *s)      { _glibc_version = s; }
79  static void set_libpthread_version(const char *s) { _libpthread_version = s; }
80
81  static bool supports_variable_stack_size();
82
83  static void set_is_NPTL()                   { _is_NPTL = true;  }
84  static void set_is_LinuxThreads()           { _is_NPTL = false; }
85  static void set_is_floating_stack()         { _is_floating_stack = true; }
86
87  static void rebuild_cpu_to_node_map();
88  static GrowableArray<int>* cpu_to_node()    { return _cpu_to_node; }
89
90  static bool hugetlbfs_sanity_check(bool warn, size_t page_size);
91
92  static void print_full_memory_info(outputStream* st);
93  static void print_distro_info(outputStream* st);
94  static void print_libversion_info(outputStream* st);
95
96 public:
97  static void init_thread_fpu_state();
98  static int  get_fpu_control_word();
99  static void set_fpu_control_word(int fpu_control);
100  static pthread_t main_thread(void)                                { return _main_thread; }
101  // returns kernel thread id (similar to LWP id on Solaris), which can be
102  // used to access /proc
103  static pid_t gettid();
104  static void set_createThread_lock(Mutex* lk)                      { _createThread_lock = lk; }
105  static Mutex* createThread_lock(void)                             { return _createThread_lock; }
106  static void hotspot_sigmask(Thread* thread);
107
108  static address   initial_thread_stack_bottom(void)                { return _initial_thread_stack_bottom; }
109  static uintptr_t initial_thread_stack_size(void)                  { return _initial_thread_stack_size; }
110  static bool is_initial_thread(void);
111
112  static int page_size(void)                                        { return _page_size; }
113  static void set_page_size(int val)                                { _page_size = val; }
114
115  static address   ucontext_get_pc(ucontext_t* uc);
116  static intptr_t* ucontext_get_sp(ucontext_t* uc);
117  static intptr_t* ucontext_get_fp(ucontext_t* uc);
118
119  // For Analyzer Forte AsyncGetCallTrace profiling support:
120  //
121  // This interface should be declared in os_linux_i486.hpp, but
122  // that file provides extensions to the os class and not the
123  // Linux class.
124  static ExtendedPC fetch_frame_from_ucontext(Thread* thread, ucontext_t* uc,
125    intptr_t** ret_sp, intptr_t** ret_fp);
126
127  // This boolean allows users to forward their own non-matching signals
128  // to JVM_handle_linux_signal, harmlessly.
129  static bool signal_handlers_are_installed;
130
131  static int get_our_sigflags(int);
132  static void set_our_sigflags(int, int);
133  static void signal_sets_init();
134  static void install_signal_handlers();
135  static void set_signal_handler(int, bool);
136  static bool is_sig_ignored(int sig);
137
138  static sigset_t* unblocked_signals();
139  static sigset_t* vm_signals();
140  static sigset_t* allowdebug_blocked_signals();
141
142  // For signal-chaining
143  static struct sigaction *get_chained_signal_action(int sig);
144  static bool chained_handler(int sig, siginfo_t* siginfo, void* context);
145
146  // GNU libc and libpthread version strings
147  static const char *glibc_version()          { return _glibc_version; }
148  static const char *libpthread_version()     { return _libpthread_version; }
149
150  // NPTL or LinuxThreads?
151  static bool is_LinuxThreads()               { return !_is_NPTL; }
152  static bool is_NPTL()                       { return _is_NPTL;  }
153
154  // NPTL is always floating stack. LinuxThreads could be using floating
155  // stack or fixed stack.
156  static bool is_floating_stack()             { return _is_floating_stack; }
157
158  static void libpthread_init();
159  static bool libnuma_init();
160  static void* libnuma_dlsym(void* handle, const char* name);
161  // Minimum stack size a thread can be created with (allowing
162  // the VM to completely create the thread and enter user code)
163  static size_t min_stack_allowed;
164
165  // Return default stack size or guard size for the specified thread type
166  static size_t default_stack_size(os::ThreadType thr_type);
167  static size_t default_guard_size(os::ThreadType thr_type);
168
169  static void capture_initial_stack(size_t max_size);
170
171  // Stack overflow handling
172  static bool manually_expand_stack(JavaThread * t, address addr);
173  static int max_register_window_saves_before_flushing();
174
175  // Real-time clock functions
176  static void clock_init(void);
177
178  // fast POSIX clocks support
179  static void fast_thread_clock_init(void);
180
181  static inline bool supports_monotonic_clock() {
182    return _clock_gettime != NULL;
183  }
184
185  static int clock_gettime(clockid_t clock_id, struct timespec *tp) {
186    return _clock_gettime ? _clock_gettime(clock_id, tp) : -1;
187  }
188
189  static int pthread_getcpuclockid(pthread_t tid, clockid_t *clock_id) {
190    return _pthread_getcpuclockid ? _pthread_getcpuclockid(tid, clock_id) : -1;
191  }
192
193  static bool supports_fast_thread_cpu_time() {
194    return _supports_fast_thread_cpu_time;
195  }
196
197  static jlong fast_thread_cpu_time(clockid_t clockid);
198
199  // Stack repair handling
200
201  // none present
202
203  // LinuxThreads work-around for 6292965
204  static int safe_cond_timedwait(pthread_cond_t *_cond, pthread_mutex_t *_mutex, const struct timespec *_abstime);
205
206
207  // Linux suspend/resume support - this helper is a shadow of its former
208  // self now that low-level suspension is barely used, and old workarounds
209  // for LinuxThreads are no longer needed.
210  class SuspendResume {
211  private:
212    volatile int  _suspend_action;
213    volatile jint _state;
214  public:
215    // values for suspend_action:
216    enum {
217      SR_NONE              = 0x00,
218      SR_SUSPEND           = 0x01,  // suspend request
219      SR_CONTINUE          = 0x02,  // resume request
220      SR_SUSPENDED         = 0x20   // values for _state: + SR_NONE
221    };
222
223    SuspendResume() { _suspend_action = SR_NONE; _state = SR_NONE; }
224
225    int suspend_action() const     { return _suspend_action; }
226    void set_suspend_action(int x) { _suspend_action = x;    }
227
228    // atomic updates for _state
229    inline void set_suspended();
230    inline void clear_suspended();
231    bool is_suspended()            { return _state & SR_SUSPENDED;       }
232
233  };
234
235private:
236  typedef int (*sched_getcpu_func_t)(void);
237  typedef int (*numa_node_to_cpus_func_t)(int node, unsigned long *buffer, int bufferlen);
238  typedef int (*numa_max_node_func_t)(void);
239  typedef int (*numa_available_func_t)(void);
240  typedef int (*numa_tonode_memory_func_t)(void *start, size_t size, int node);
241  typedef void (*numa_interleave_memory_func_t)(void *start, size_t size, unsigned long *nodemask);
242
243  static sched_getcpu_func_t _sched_getcpu;
244  static numa_node_to_cpus_func_t _numa_node_to_cpus;
245  static numa_max_node_func_t _numa_max_node;
246  static numa_available_func_t _numa_available;
247  static numa_tonode_memory_func_t _numa_tonode_memory;
248  static numa_interleave_memory_func_t _numa_interleave_memory;
249  static unsigned long* _numa_all_nodes;
250
251  static void set_sched_getcpu(sched_getcpu_func_t func) { _sched_getcpu = func; }
252  static void set_numa_node_to_cpus(numa_node_to_cpus_func_t func) { _numa_node_to_cpus = func; }
253  static void set_numa_max_node(numa_max_node_func_t func) { _numa_max_node = func; }
254  static void set_numa_available(numa_available_func_t func) { _numa_available = func; }
255  static void set_numa_tonode_memory(numa_tonode_memory_func_t func) { _numa_tonode_memory = func; }
256  static void set_numa_interleave_memory(numa_interleave_memory_func_t func) { _numa_interleave_memory = func; }
257  static void set_numa_all_nodes(unsigned long* ptr) { _numa_all_nodes = ptr; }
258  static int sched_getcpu_syscall(void);
259public:
260  static int sched_getcpu()  { return _sched_getcpu != NULL ? _sched_getcpu() : -1; }
261  static int numa_node_to_cpus(int node, unsigned long *buffer, int bufferlen) {
262    return _numa_node_to_cpus != NULL ? _numa_node_to_cpus(node, buffer, bufferlen) : -1;
263  }
264  static int numa_max_node() { return _numa_max_node != NULL ? _numa_max_node() : -1; }
265  static int numa_available() { return _numa_available != NULL ? _numa_available() : -1; }
266  static int numa_tonode_memory(void *start, size_t size, int node) {
267    return _numa_tonode_memory != NULL ? _numa_tonode_memory(start, size, node) : -1;
268  }
269  static void numa_interleave_memory(void *start, size_t size) {
270    if (_numa_interleave_memory != NULL && _numa_all_nodes != NULL) {
271      _numa_interleave_memory(start, size, _numa_all_nodes);
272    }
273  }
274  static int get_node_by_cpu(int cpu_id);
275};
276
277
278class PlatformEvent : public CHeapObj<mtInternal> {
279  private:
280    double CachePad [4] ;   // increase odds that _mutex is sole occupant of cache line
281    volatile int _Event ;
282    volatile int _nParked ;
283    pthread_mutex_t _mutex  [1] ;
284    pthread_cond_t  _cond   [1] ;
285    double PostPad  [2] ;
286    Thread * _Assoc ;
287
288  public:       // TODO-FIXME: make dtor private
289    ~PlatformEvent() { guarantee (0, "invariant") ; }
290
291  public:
292    PlatformEvent() {
293      int status;
294      status = pthread_cond_init (_cond, NULL);
295      assert_status(status == 0, status, "cond_init");
296      status = pthread_mutex_init (_mutex, NULL);
297      assert_status(status == 0, status, "mutex_init");
298      _Event   = 0 ;
299      _nParked = 0 ;
300      _Assoc   = NULL ;
301    }
302
303    // Use caution with reset() and fired() -- they may require MEMBARs
304    void reset() { _Event = 0 ; }
305    int  fired() { return _Event; }
306    void park () ;
307    void unpark () ;
308    int  TryPark () ;
309    int  park (jlong millis) ;
310    void SetAssociation (Thread * a) { _Assoc = a ; }
311} ;
312
313class PlatformParker : public CHeapObj<mtInternal> {
314  protected:
315    pthread_mutex_t _mutex [1] ;
316    pthread_cond_t  _cond  [1] ;
317
318  public:       // TODO-FIXME: make dtor private
319    ~PlatformParker() { guarantee (0, "invariant") ; }
320
321  public:
322    PlatformParker() {
323      int status;
324      status = pthread_cond_init (_cond, NULL);
325      assert_status(status == 0, status, "cond_init");
326      status = pthread_mutex_init (_mutex, NULL);
327      assert_status(status == 0, status, "mutex_init");
328    }
329} ;
330
331#endif // OS_LINUX_VM_OS_LINUX_HPP
332