1 /*
   2  * Copyright (c) 2003, 2015, 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 _LIBPROC_H_
  26 #define _LIBPROC_H_
  27 
  28 #include <jni.h>
  29 #include <unistd.h>
  30 #include <stdint.h>
  31 #include "proc_service.h"
  32 
  33 #ifdef ALT_SASRCDIR
  34 #include "libproc_md.h"
  35 #endif
  36 
  37 #include <sys/ptrace.h>
  38 
  39 /************************************************************************************
  40 
  41 0. This is very minimal subset of Solaris libproc just enough for current application.
  42 Please note that the bulk of the functionality is from proc_service interface. This
  43 adds Pgrab__ and some missing stuff. We hide the difference b/w live process and core
  44 file by this interface.
  45 
  46 1. pthread_id unique in both NPTL & LinuxThreads. We store this in
  47 OSThread::_pthread_id in JVM code.
  48 
  49 2. All threads see the same pid when they call getpid() under NPTL.
  50 Threads receive different pid under LinuxThreads. We used to save the result of
  51 ::getpid() call in OSThread::_thread_id. This way uniqueness of OSThread::_thread_id
  52 was lost under NPTL. Now, we store the result of ::gettid() call in
  53 OSThread::_thread_id. Because gettid returns actual pid of thread (lwp id), this is
  54 unique again. We therefore use OSThread::_thread_id as unique identifier.
  55 
  56 3. There is a unique LWP id under both thread libraries. libthread_db  maps pthread_id
  57 to its underlying lwp_id under both the thread libraries. thread_info.lwp_id stores
  58 lwp_id of the thread. The lwp id is nothing but the actual pid of clone'd processes. But
  59 unfortunately libthread_db does not work very well for core dumps. So, we get pthread_id
  60 only for processes. For core dumps, we don't use libthread_db at all (like gdb).
  61 
  62 4. ptrace operates on this LWP id under both the thread libraries. When we say 'pid' for
  63 ptrace call, we refer to lwp_id of the thread.
  64 
  65 5. for core file, we parse ELF files and read data from them. For processes we  use
  66 combination of ptrace and /proc calls.
  67 
  68 *************************************************************************************/
  69 
  70 
  71 #if defined(sparc) || defined(sparcv9) || defined(ppc64)
  72 #include <asm/ptrace.h>
  73 #define user_regs_struct  pt_regs
  74 #endif
  75 
  76 // This C bool type must be int for compatibility with Linux calls and
  77 // it would be a mistake to equivalence it to C++ bool on many platforms
  78 
  79 typedef int bool;
  80 #define true  1
  81 #define false 0
  82 
  83 struct ps_prochandle;
  84 
  85 // attach to a process
  86 struct ps_prochandle* Pgrab(pid_t pid, char* err_buf, size_t err_buf_len);
  87 
  88 // attach to a core dump
  89 struct ps_prochandle* Pgrab_core(const char* execfile, const char* corefile);
  90 
  91 // release a process or core
  92 void Prelease(struct ps_prochandle* ph);
  93 
  94 // functions not directly available in Solaris libproc
  95 
  96 // initialize libproc (call this only once per app)
  97 // pass true to make library verbose
  98 bool init_libproc(bool verbose);
  99 
 100 // get number of threads
 101 int get_num_threads(struct ps_prochandle* ph);
 102 
 103 // get lwp_id of n'th thread
 104 lwpid_t get_lwp_id(struct ps_prochandle* ph, int index);
 105 
 106 // get regs for a given lwp
 107 bool get_lwp_regs(struct ps_prochandle* ph, lwpid_t lid, struct user_regs_struct* regs);
 108 
 109 // get number of shared objects
 110 int get_num_libs(struct ps_prochandle* ph);
 111 
 112 // get name of n'th lib
 113 const char* get_lib_name(struct ps_prochandle* ph, int index);
 114 
 115 // get base of lib
 116 uintptr_t get_lib_base(struct ps_prochandle* ph, int index);
 117 
 118 // returns true if given library is found in lib list
 119 bool find_lib(struct ps_prochandle* ph, const char *lib_name);
 120 
 121 // symbol lookup
 122 uintptr_t lookup_symbol(struct ps_prochandle* ph,  const char* object_name,
 123                        const char* sym_name);
 124 
 125 // address->nearest symbol lookup. return NULL for no symbol
 126 const char* symbol_for_pc(struct ps_prochandle* ph, uintptr_t addr, uintptr_t* poffset);
 127 
 128 struct ps_prochandle* get_proc_handle(JNIEnv* env, jobject this_obj);
 129 
 130 void throw_new_debugger_exception(JNIEnv* env, const char* errMsg);
 131 
 132 #endif //__LIBPROC_H_