never@3156: /*
rbackman@4599:  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
never@3156:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
never@3156:  *
never@3156:  * This code is free software; you can redistribute it and/or modify it
never@3156:  * under the terms of the GNU General Public License version 2 only, as
never@3156:  * published by the Free Software Foundation.
never@3156:  *
never@3156:  * This code is distributed in the hope that it will be useful, but WITHOUT
never@3156:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
never@3156:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
never@3156:  * version 2 for more details (a copy is included in the LICENSE file that
never@3156:  * accompanied this code).
never@3156:  *
never@3156:  * You should have received a copy of the GNU General Public License version
never@3156:  * 2 along with this work; if not, write to the Free Software Foundation,
never@3156:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
never@3156:  *
never@3156:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
never@3156:  * or visit www.oracle.com if you need additional information or have any
never@3156:  * questions.
never@3156:  *
never@3156:  */
never@3156: #include <stdarg.h>
never@3156: #include <stdio.h>
never@3156: #include <stdlib.h>
never@3156: #include <string.h>
never@3156: #include <fcntl.h>
never@3156: #include <thread_db.h>
never@3156: #include "libproc_impl.h"
never@3156: 
never@3156: static const char* alt_root = NULL;
never@3156: static int alt_root_len = -1;
never@3156: 
never@3156: #define SA_ALTROOT "SA_ALTROOT"
never@3156: 
never@3156: static void init_alt_root() {
never@3156:    if (alt_root_len == -1) {
never@3156:       alt_root = getenv(SA_ALTROOT);
never@3156:       if (alt_root) {
never@3156:          alt_root_len = strlen(alt_root);
never@3156:       } else {
never@3156:          alt_root_len = 0;
never@3156:       }
never@3156:    }
never@3156: }
never@3156: 
never@3156: int pathmap_open(const char* name) {
never@3156:    int fd;
never@3156:    char alt_path[PATH_MAX + 1];
never@3156: 
never@3156:    init_alt_root();
never@3156:    fd = open(name, O_RDONLY);
never@3156:    if (fd >= 0) {
never@3156:       return fd;
never@3156:    }
never@3156: 
never@3156:    if (alt_root_len > 0) {
never@3156:       strcpy(alt_path, alt_root);
never@3156:       strcat(alt_path, name);
never@3156:       fd = open(alt_path, O_RDONLY);
never@3156:       if (fd >= 0) {
never@3156:          print_debug("path %s substituted for %s\n", alt_path, name);
never@3156:          return fd;
never@3156:       }
never@3156: 
never@3156:       if (strrchr(name, '/')) {
never@3156:          strcpy(alt_path, alt_root);
never@3156:          strcat(alt_path, strrchr(name, '/'));
never@3156:          fd = open(alt_path, O_RDONLY);
never@3156:          if (fd >= 0) {
never@3156:             print_debug("path %s substituted for %s\n", alt_path, name);
never@3156:             return fd;
never@3156:          }
never@3156:       }
never@3156:    }
never@3156: 
never@3156:    return -1;
never@3156: }
never@3156: 
never@3156: static bool _libsaproc_debug;
never@3156: 
never@3156: void print_debug(const char* format,...) {
never@3156:    if (_libsaproc_debug) {
never@3156:      va_list alist;
never@3156: 
never@3156:      va_start(alist, format);
never@3156:      fputs("libsaproc DEBUG: ", stderr);
never@3156:      vfprintf(stderr, format, alist);
never@3156:      va_end(alist);
never@3156:    }
never@3156: }
never@3156: 
rbackman@4599: void print_error(const char* format,...) {
rbackman@4599:   va_list alist;
rbackman@4599:   va_start(alist, format);
rbackman@4599:   fputs("ERROR: ", stderr);
rbackman@4599:   vfprintf(stderr, format, alist);
rbackman@4599:   va_end(alist);
rbackman@4599: }
rbackman@4599: 
never@3156: bool is_debug() {
never@3156:    return _libsaproc_debug;
never@3156: }
never@3156: 
never@3156: // initialize libproc
never@3156: bool init_libproc(bool debug) {
never@3156:    // init debug mode
never@3156:    _libsaproc_debug = debug;
never@3156: 
never@3156:    // initialize the thread_db library
never@3156:    if (td_init() != TD_OK) {
never@3156:      print_debug("libthread_db's td_init failed\n");
never@3156:      return false;
never@3156:    }
never@3156: 
never@3156:    return true;
never@3156: }
never@3156: 
never@3156: static void destroy_lib_info(struct ps_prochandle* ph) {
never@3156:    lib_info* lib = ph->libs;
never@3156:    while (lib) {
never@3156:      lib_info *next = lib->next;
never@3156:      if (lib->symtab) {
never@3156:         destroy_symtab(lib->symtab);
never@3156:      }
never@3156:      free(lib);
never@3156:      lib = next;
never@3156:    }
never@3156: }
never@3156: 
never@3156: static void destroy_thread_info(struct ps_prochandle* ph) {
never@3156:    thread_info* thr = ph->threads;
never@3156:    while (thr) {
never@3156:      thread_info *next = thr->next;
never@3156:      free(thr);
never@3156:      thr = next;
never@3156:    }
never@3156: }
never@3156: 
never@3156: // ps_prochandle cleanup
never@3156: 
never@3156: // ps_prochandle cleanup
never@3156: void Prelease(struct ps_prochandle* ph) {
never@3156:    // do the "derived class" clean-up first
never@3156:    ph->ops->release(ph);
never@3156:    destroy_lib_info(ph);
never@3156:    destroy_thread_info(ph);
never@3156:    free(ph);
never@3156: }
never@3156: 
never@3156: lib_info* add_lib_info(struct ps_prochandle* ph, const char* libname, uintptr_t base) {
never@3156:    return add_lib_info_fd(ph, libname, -1, base);
never@3156: }
never@3156: 
never@3156: lib_info* add_lib_info_fd(struct ps_prochandle* ph, const char* libname, int fd, uintptr_t base) {
never@3156:    lib_info* newlib;
never@3156: 
never@3156:    if ( (newlib = (lib_info*) calloc(1, sizeof(struct lib_info))) == NULL) {
never@3156:       print_debug("can't allocate memory for lib_info\n");
never@3156:       return NULL;
never@3156:    }
never@3156: 
never@3156:    strncpy(newlib->name, libname, sizeof(newlib->name));
never@3156:    newlib->base = base;
never@3156: 
never@3156:    if (fd == -1) {
never@3156:       if ( (newlib->fd = pathmap_open(newlib->name)) < 0) {
never@3156:          print_debug("can't open shared object %s\n", newlib->name);
never@3156:          free(newlib);
never@3156:          return NULL;
never@3156:       }
never@3156:    } else {
never@3156:       newlib->fd = fd;
never@3156:    }
never@3156: 
never@3156:    // check whether we have got an ELF file. /proc/<pid>/map
never@3156:    // gives out all file mappings and not just shared objects
never@3156:    if (is_elf_file(newlib->fd) == false) {
never@3156:       close(newlib->fd);
never@3156:       free(newlib);
never@3156:       return NULL;
never@3156:    }
never@3156: 
never@3156:    newlib->symtab = build_symtab(newlib->fd);
never@3156:    if (newlib->symtab == NULL) {
never@3156:       print_debug("symbol table build failed for %s\n", newlib->name);
never@3156:    }
never@3156:    else {
never@3156:       print_debug("built symbol table for %s\n", newlib->name);
never@3156:    }
never@3156: 
never@3156:    // even if symbol table building fails, we add the lib_info.
never@3156:    // This is because we may need to read from the ELF file for core file
never@3156:    // address read functionality. lookup_symbol checks for NULL symtab.
never@3156:    if (ph->libs) {
never@3156:       ph->lib_tail->next = newlib;
never@3156:       ph->lib_tail = newlib;
never@3156:    }  else {
never@3156:       ph->libs = ph->lib_tail = newlib;
never@3156:    }
never@3156:    ph->num_libs++;
never@3156: 
never@3156:    return newlib;
never@3156: }
never@3156: 
never@3156: // lookup for a specific symbol
never@3156: uintptr_t lookup_symbol(struct ps_prochandle* ph,  const char* object_name,
never@3156:                        const char* sym_name) {
never@3156:    // ignore object_name. search in all libraries
never@3156:    // FIXME: what should we do with object_name?? The library names are obtained
never@3156:    // by parsing /proc/<pid>/maps, which may not be the same as object_name.
never@3156:    // What we need is a utility to map object_name to real file name, something
never@3156:    // dlopen() does by looking at LD_LIBRARY_PATH and /etc/ld.so.cache. For
never@3156:    // now, we just ignore object_name and do a global search for the symbol.
never@3156: 
never@3156:    lib_info* lib = ph->libs;
never@3156:    while (lib) {
never@3156:       if (lib->symtab) {
never@3156:          uintptr_t res = search_symbol(lib->symtab, lib->base, sym_name, NULL);
never@3156:          if (res) return res;
never@3156:       }
never@3156:       lib = lib->next;
never@3156:    }
never@3156: 
never@3156:    print_debug("lookup failed for symbol '%s' in obj '%s'\n",
never@3156:                           sym_name, object_name);
never@3156:    return (uintptr_t) NULL;
never@3156: }
never@3156: 
never@3156: 
never@3156: const char* symbol_for_pc(struct ps_prochandle* ph, uintptr_t addr, uintptr_t* poffset) {
never@3156:    const char* res = NULL;
never@3156:    lib_info* lib = ph->libs;
never@3156:    while (lib) {
never@3156:       if (lib->symtab && addr >= lib->base) {
never@3156:          res = nearest_symbol(lib->symtab, addr - lib->base, poffset);
never@3156:          if (res) return res;
never@3156:       }
never@3156:       lib = lib->next;
never@3156:    }
never@3156:    return NULL;
never@3156: }
never@3156: 
never@3156: // add a thread to ps_prochandle
never@3156: thread_info* add_thread_info(struct ps_prochandle* ph, pthread_t pthread_id, lwpid_t lwp_id) {
never@3156:    thread_info* newthr;
never@3156:    if ( (newthr = (thread_info*) calloc(1, sizeof(thread_info))) == NULL) {
never@3156:       print_debug("can't allocate memory for thread_info\n");
never@3156:       return NULL;
never@3156:    }
never@3156: 
never@3156:    // initialize thread info
never@3156:    newthr->pthread_id = pthread_id;
never@3156:    newthr->lwp_id = lwp_id;
never@3156: 
never@3156:    // add new thread to the list
never@3156:    newthr->next = ph->threads;
never@3156:    ph->threads = newthr;
never@3156:    ph->num_threads++;
never@3156:    return newthr;
never@3156: }
never@3156: 
never@3156: 
never@3156: // struct used for client data from thread_db callback
never@3156: struct thread_db_client_data {
never@3156:    struct ps_prochandle* ph;
never@3156:    thread_info_callback callback;
never@3156: };
never@3156: 
never@3156: // callback function for libthread_db
never@3156: static int thread_db_callback(const td_thrhandle_t *th_p, void *data) {
never@3156:   struct thread_db_client_data* ptr = (struct thread_db_client_data*) data;
never@3156:   td_thrinfo_t ti;
never@3156:   td_err_e err;
never@3156: 
never@3156:   memset(&ti, 0, sizeof(ti));
never@3156:   err = td_thr_get_info(th_p, &ti);
never@3156:   if (err != TD_OK) {
never@3156:     print_debug("libthread_db : td_thr_get_info failed, can't get thread info\n");
never@3156:     return err;
never@3156:   }
never@3156: 
never@3156:   print_debug("thread_db : pthread %d (lwp %d)\n", ti.ti_tid, ti.ti_lid);
never@3156: 
never@3156:   if (ptr->callback(ptr->ph, (pthread_t)ti.ti_tid, ti.ti_lid) != true)
never@3156:     return TD_ERR;
never@3156: 
never@3156:   return TD_OK;
never@3156: }
never@3156: 
never@3156: // read thread_info using libthread_db
never@3156: bool read_thread_info(struct ps_prochandle* ph, thread_info_callback cb) {
never@3156:   struct thread_db_client_data mydata;
never@3156:   td_thragent_t* thread_agent = NULL;
never@3156:   if (td_ta_new(ph, &thread_agent) != TD_OK) {
never@3156:      print_debug("can't create libthread_db agent\n");
never@3156:      return false;
never@3156:   }
never@3156: 
never@3156:   mydata.ph = ph;
never@3156:   mydata.callback = cb;
never@3156: 
never@3156:   // we use libthread_db iterator to iterate thru list of threads.
never@3156:   if (td_ta_thr_iter(thread_agent, thread_db_callback, &mydata,
never@3156:                  TD_THR_ANY_STATE, TD_THR_LOWEST_PRIORITY,
never@3156:                  TD_SIGNO_MASK, TD_THR_ANY_USER_FLAGS) != TD_OK) {
never@3156:      td_ta_delete(thread_agent);
never@3156:      return false;
never@3156:   }
never@3156: 
never@3156:   // delete thread agent
never@3156:   td_ta_delete(thread_agent);
never@3156:   return true;
never@3156: }
never@3156: 
never@3156: 
never@3156: // get number of threads
never@3156: int get_num_threads(struct ps_prochandle* ph) {
never@3156:    return ph->num_threads;
never@3156: }
never@3156: 
never@3156: // get lwp_id of n'th thread
never@3156: lwpid_t get_lwp_id(struct ps_prochandle* ph, int index) {
never@3156:    int count = 0;
never@3156:    thread_info* thr = ph->threads;
never@3156:    while (thr) {
never@3156:       if (count == index) {
never@3156:          return thr->lwp_id;
never@3156:       }
never@3156:       count++;
never@3156:       thr = thr->next;
never@3156:    }
never@3156:    return -1;
never@3156: }
never@3156: 
never@3156: // get regs for a given lwp
never@3156: bool get_lwp_regs(struct ps_prochandle* ph, lwpid_t lwp_id, struct reg* regs) {
never@3156:   return ph->ops->get_lwp_regs(ph, lwp_id, regs);
never@3156: }
never@3156: 
never@3156: // get number of shared objects
never@3156: int get_num_libs(struct ps_prochandle* ph) {
never@3156:    return ph->num_libs;
never@3156: }
never@3156: 
never@3156: // get name of n'th solib
never@3156: const char* get_lib_name(struct ps_prochandle* ph, int index) {
never@3156:    int count = 0;
never@3156:    lib_info* lib = ph->libs;
never@3156:    while (lib) {
never@3156:       if (count == index) {
never@3156:          return lib->name;
never@3156:       }
never@3156:       count++;
never@3156:       lib = lib->next;
never@3156:    }
never@3156:    return NULL;
never@3156: }
never@3156: 
never@3156: // get base address of a lib
never@3156: uintptr_t get_lib_base(struct ps_prochandle* ph, int index) {
never@3156:    int count = 0;
never@3156:    lib_info* lib = ph->libs;
never@3156:    while (lib) {
never@3156:       if (count == index) {
never@3156:          return lib->base;
never@3156:       }
never@3156:       count++;
never@3156:       lib = lib->next;
never@3156:    }
never@3156:    return (uintptr_t)NULL;
never@3156: }
never@3156: 
never@3156: bool find_lib(struct ps_prochandle* ph, const char *lib_name) {
never@3156:   lib_info *p = ph->libs;
never@3156:   while (p) {
never@3156:     if (strcmp(p->name, lib_name) == 0) {
never@3156:       return true;
never@3156:     }
never@3156:     p = p->next;
never@3156:   }
never@3156:   return false;
never@3156: }
never@3156: 
never@3156: //--------------------------------------------------------------------------
never@3156: // proc service functions
never@3156: 
never@3156: // ps_pglobal_lookup() looks up the symbol sym_name in the symbol table
never@3156: // of the load object object_name in the target process identified by ph.
never@3156: // It returns the symbol's value as an address in the target process in
never@3156: // *sym_addr.
never@3156: 
never@3156: ps_err_e ps_pglobal_lookup(struct ps_prochandle *ph, const char *object_name,
never@3156:                     const char *sym_name, psaddr_t *sym_addr) {
never@3156:   *sym_addr = (psaddr_t) lookup_symbol(ph, object_name, sym_name);
never@3156:   return (*sym_addr ? PS_OK : PS_NOSYM);
never@3156: }
never@3156: 
never@3156: // read "size" bytes info "buf" from address "addr"
never@3156: ps_err_e ps_pread(struct ps_prochandle *ph, psaddr_t  addr,
never@3156:                   void *buf, size_t size) {
never@3156:   return ph->ops->p_pread(ph, (uintptr_t) addr, buf, size)? PS_OK: PS_ERR;
never@3156: }
never@3156: 
never@3156: // write "size" bytes of data to debuggee at address "addr"
never@3156: ps_err_e ps_pwrite(struct ps_prochandle *ph, psaddr_t addr,
never@3156:                    const void *buf, size_t size) {
never@3156:   return ph->ops->p_pwrite(ph, (uintptr_t)addr, buf, size)? PS_OK: PS_ERR;
never@3156: }
never@3156: 
never@3156: // fill in ptrace_lwpinfo for lid
never@3156: ps_err_e ps_linfo(struct ps_prochandle *ph, lwpid_t lwp_id, void *linfo) {
never@3156:   return ph->ops->get_lwp_info(ph, lwp_id, linfo)? PS_OK: PS_ERR;
never@3156: }
never@3156: 
never@3156: // needed for when libthread_db is compiled with TD_DEBUG defined
never@3156: void
never@3156: ps_plog (const char *format, ...)
never@3156: {
never@3156:   va_list alist;
never@3156: 
never@3156:   va_start(alist, format);
never@3156:   vfprintf(stderr, format, alist);
never@3156:   va_end(alist);
never@3156: }
never@3156: 
never@3156: // ------------------------------------------------------------------------
never@3156: // Functions below this point are not yet implemented. They are here only
never@3156: // to make the linker happy.
never@3156: 
never@3156: ps_err_e ps_lsetfpregs(struct ps_prochandle *ph, lwpid_t lid, const prfpregset_t *fpregs) {
never@3156:   print_debug("ps_lsetfpregs not implemented\n");
never@3156:   return PS_OK;
never@3156: }
never@3156: 
never@3156: ps_err_e ps_lsetregs(struct ps_prochandle *ph, lwpid_t lid, const prgregset_t gregset) {
never@3156:   print_debug("ps_lsetregs not implemented\n");
never@3156:   return PS_OK;
never@3156: }
never@3156: 
never@3156: ps_err_e  ps_lgetfpregs(struct  ps_prochandle  *ph,  lwpid_t lid, prfpregset_t *fpregs) {
never@3156:   print_debug("ps_lgetfpregs not implemented\n");
never@3156:   return PS_OK;
never@3156: }
never@3156: 
never@3156: ps_err_e ps_lgetregs(struct ps_prochandle *ph, lwpid_t lid, prgregset_t gregset) {
never@3156:   print_debug("ps_lgetfpregs not implemented\n");
never@3156:   return PS_OK;
never@3156: }
never@3156: 
never@3156: ps_err_e ps_lstop(struct ps_prochandle *ph, lwpid_t lid) {
never@3156:   print_debug("ps_lstop not implemented\n");
never@3156:   return PS_OK;
never@3156: }
never@3156: 
never@3156: ps_err_e ps_pcontinue(struct ps_prochandle *ph) {
never@3156:   print_debug("ps_pcontinue not implemented\n");
never@3156:   return PS_OK;
never@3156: }