1/*
2 * Copyright (c) 2003, 2019, 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_IMPL_H_
26#define _LIBPROC_IMPL_H_
27
28#include <unistd.h>
29#include <limits.h>
30#include "libproc.h"
31#include "symtab.h"
32
33// data structures in this file mimic those of Solaris 8.0 - libproc's Pcontrol.h
34
35#define BUF_SIZE (PATH_MAX + NAME_MAX + 1)
36
37// list of shared objects
38typedef struct lib_info {
39 char name[BUF_SIZE];
40 uintptr_t base;
41 struct symtab* symtab;
42 int fd; // file descriptor for lib
43 struct lib_info* next;
44} lib_info;
45
46// list of threads
47typedef struct thread_info {
48 lwpid_t lwp_id;
49 struct user_regs_struct regs; // not for process, core uses for caching regset
50 struct thread_info* next;
51} thread_info;
52
53// list of virtual memory maps
54typedef struct map_info {
55 int fd; // file descriptor
56 off_t offset; // file offset of this mapping
57 uintptr_t vaddr; // starting virtual address
58 size_t memsz; // size of the mapping
59 struct map_info* next;
60} map_info;
61
62// vtable for ps_prochandle
63typedef struct ps_prochandle_ops {
64 // "derived class" clean-up
65 void (*release)(struct ps_prochandle* ph);
66 // read from debuggee
67 bool (*p_pread)(struct ps_prochandle *ph,
68 uintptr_t addr, char *buf, size_t size);
69 // write into debuggee
70 bool (*p_pwrite)(struct ps_prochandle *ph,
71 uintptr_t addr, const char *buf , size_t size);
72 // get integer regset of a thread
73 bool (*get_lwp_regs)(struct ps_prochandle* ph, lwpid_t lwp_id, struct user_regs_struct* regs);
74} ps_prochandle_ops;
75
76// the ps_prochandle
77
78struct core_data {
79 int core_fd; // file descriptor of core file
80 int exec_fd; // file descriptor of exec file
81 int interp_fd; // file descriptor of interpreter (ld-linux.so.2)
82 // part of the class sharing workaround
83 int classes_jsa_fd; // file descriptor of class share archive
84 uintptr_t dynamic_addr; // address of dynamic section of a.out
85 uintptr_t ld_base_addr; // base address of ld.so
86 size_t num_maps; // number of maps.
87 map_info* maps; // maps in a linked list
88 // part of the class sharing workaround
89 map_info* class_share_maps;// class share maps in a linked list
90 map_info** map_array; // sorted (by vaddr) array of map_info pointers
91};
92
93struct ps_prochandle {
94 ps_prochandle_ops* ops; // vtable ptr
95 pid_t pid;
96 int num_libs;
97 lib_info* libs; // head of lib list
98 lib_info* lib_tail; // tail of lib list - to append at the end
99 int num_threads;
100 thread_info* threads; // head of thread list
101 struct core_data* core; // data only used for core dumps, NULL for process
102};
103
104int pathmap_open(const char* name);
105
106void print_debug(const char* format,...);
107void print_error(const char* format,...);
108bool is_debug();
109
110// deletes a thread from the thread list
111void delete_thread_info(struct ps_prochandle* ph, thread_info* thr);
112
113// adds a new shared object to lib list, returns NULL on failure
114lib_info* add_lib_info(struct ps_prochandle* ph, const char* libname, uintptr_t base);
115
116// adds a new shared object to lib list, supply open lib file descriptor as well
117lib_info* add_lib_info_fd(struct ps_prochandle* ph, const char* libname, int fd,
118 uintptr_t base);
119
120// adds a new thread to threads list, returns NULL on failure
121thread_info* add_thread_info(struct ps_prochandle* ph, lwpid_t lwp_id);
122
123// a test for ELF signature without using libelf
124bool is_elf_file(int fd);
125
126#endif //_LIBPROC_IMPL_H_
127