annotate agent/src/os/bsd/libproc_impl.h @ 3960:f08d439fab8c

7089790: integrate bsd-port changes Reviewed-by: kvn, twisti, jrose Contributed-by: Kurt Miller <kurt@intricatesoftware.com>, Greg Lewis <glewis@eyesbeyond.com>, Jung-uk Kim <jkim@freebsd.org>, Christos Zoulas <christos@zoulas.com>, Landon Fuller <landonf@plausible.coop>, The FreeBSD Foundation <board@freebsdfoundation.org>, Michael Franz <mvfranz@gmail.com>, Roger Hoover <rhoover@apple.com>, Alexander Strange <astrange@apple.com>
author never
date Sun, 25 Sep 2011 16:03:29 -0700
parents
children 2394a89e89f4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3960
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
1 /*
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
2 * Copyright (c) 2003, 2005, Oracle and/or its affiliates. All rights reserved.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
4 *
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
7 * published by the Free Software Foundation.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
8 *
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
13 * accompanied this code).
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
14 *
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
18 *
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
21 * questions.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
22 *
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
23 */
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
24
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
25 #ifndef _LIBPROC_IMPL_H_
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
26 #define _LIBPROC_IMPL_H_
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
27
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
28 #include <unistd.h>
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
29 #include <limits.h>
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
30 #include "libproc.h"
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
31 #include "symtab.h"
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
32
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
33 // data structures in this file mimic those of Solaris 8.0 - libproc's Pcontrol.h
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
34
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
35 #define BUF_SIZE (PATH_MAX + NAME_MAX + 1)
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
36
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
37 // list of shared objects
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
38 typedef struct lib_info {
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
39 char name[BUF_SIZE];
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
40 uintptr_t base;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
41 struct symtab* symtab;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
42 int fd; // file descriptor for lib
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
43 struct lib_info* next;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
44 } lib_info;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
45
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
46 // list of threads
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
47 typedef struct thread_info {
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
48 lwpid_t lwp_id;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
49 pthread_t pthread_id; // not used cores, always -1
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
50 struct reg regs; // not for process, core uses for caching regset
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
51 struct thread_info* next;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
52 } thread_info;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
53
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
54 // list of virtual memory maps
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
55 typedef struct map_info {
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
56 int fd; // file descriptor
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
57 off_t offset; // file offset of this mapping
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
58 uintptr_t vaddr; // starting virtual address
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
59 size_t memsz; // size of the mapping
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
60 struct map_info* next;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
61 } map_info;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
62
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
63 // vtable for ps_prochandle
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
64 typedef struct ps_prochandle_ops {
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
65 // "derived class" clean-up
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
66 void (*release)(struct ps_prochandle* ph);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
67 // read from debuggee
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
68 bool (*p_pread)(struct ps_prochandle *ph,
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
69 uintptr_t addr, char *buf, size_t size);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
70 // write into debuggee
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
71 bool (*p_pwrite)(struct ps_prochandle *ph,
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
72 uintptr_t addr, const char *buf , size_t size);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
73 // get integer regset of a thread
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
74 bool (*get_lwp_regs)(struct ps_prochandle* ph, lwpid_t lwp_id, struct reg* regs);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
75 // get info on thread
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
76 bool (*get_lwp_info)(struct ps_prochandle *ph, lwpid_t lwp_id, void *linfo);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
77 } ps_prochandle_ops;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
78
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
79 // the ps_prochandle
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
80
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
81 struct core_data {
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
82 int core_fd; // file descriptor of core file
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
83 int exec_fd; // file descriptor of exec file
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
84 int interp_fd; // file descriptor of interpreter (ld-elf.so.1)
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
85 // part of the class sharing workaround
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
86 int classes_jsa_fd; // file descriptor of class share archive
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
87 uintptr_t dynamic_addr; // address of dynamic section of a.out
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
88 uintptr_t ld_base_addr; // base address of ld.so
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
89 size_t num_maps; // number of maps.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
90 map_info* maps; // maps in a linked list
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
91 // part of the class sharing workaround
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
92 map_info* class_share_maps;// class share maps in a linked list
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
93 map_info** map_array; // sorted (by vaddr) array of map_info pointers
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
94 };
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
95
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
96 struct ps_prochandle {
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
97 ps_prochandle_ops* ops; // vtable ptr
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
98 pid_t pid;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
99 int num_libs;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
100 lib_info* libs; // head of lib list
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
101 lib_info* lib_tail; // tail of lib list - to append at the end
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
102 int num_threads;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
103 thread_info* threads; // head of thread list
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
104 struct core_data* core; // data only used for core dumps, NULL for process
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
105 };
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
106
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
107 int pathmap_open(const char* name);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
108
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
109 void print_debug(const char* format,...);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
110 bool is_debug();
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
111
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
112 typedef bool (*thread_info_callback)(struct ps_prochandle* ph, pthread_t pid, lwpid_t lwpid);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
113
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
114 // reads thread info using libthread_db and calls above callback for each thread
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
115 bool read_thread_info(struct ps_prochandle* ph, thread_info_callback cb);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
116
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
117 // adds a new shared object to lib list, returns NULL on failure
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
118 lib_info* add_lib_info(struct ps_prochandle* ph, const char* libname, uintptr_t base);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
119
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
120 // adds a new shared object to lib list, supply open lib file descriptor as well
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
121 lib_info* add_lib_info_fd(struct ps_prochandle* ph, const char* libname, int fd,
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
122 uintptr_t base);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
123
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
124 // adds a new thread to threads list, returns NULL on failure
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
125 thread_info* add_thread_info(struct ps_prochandle* ph, pthread_t pthread_id, lwpid_t lwp_id);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
126
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
127 // a test for ELF signature without using libelf
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
128 bool is_elf_file(int fd);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
129
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
130 #endif //_LIBPROC_IMPL_H_