xref: /freebsd/lib/libproc/_libproc.h (revision 1c05a6ea6b849ff95e539c31adea887c644a6a01)
1 /*-
2  * Copyright (c) 2008 John Birrell (jb@freebsd.org)
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef __LIBPROC_H_
30 #define	__LIBPROC_H_
31 
32 #include <sys/types.h>
33 #include <sys/ptrace.h>
34 
35 #include <libelf.h>
36 #include <rtld_db.h>
37 
38 #include "libproc.h"
39 
40 struct procstat;
41 
42 struct symtab {
43 	Elf_Data *data;
44 	u_int	nsyms;
45 	u_int	*index;
46 	u_long	stridx;
47 };
48 
49 struct file_info {
50 	Elf	*elf;
51 	int	fd;
52 	u_int	refs;
53 	GElf_Ehdr ehdr;
54 
55 	/* Symbol tables, sorted by value. */
56 	struct symtab dynsymtab;
57 	struct symtab symtab;
58 };
59 
60 struct map_info {
61 	prmap_t	map;
62 	struct file_info *file;
63 };
64 
65 struct proc_handle {
66 	struct proc_handle_public public; /* Public fields. */
67 	int	flags;			/* Process flags. */
68 	int	status;			/* Process status (PS_*). */
69 	int	wstat;			/* Process wait status. */
70 	int	model;			/* Process data model. */
71 	rd_agent_t *rdap;		/* librtld_db agent */
72 	struct map_info *mappings;	/* File mappings for proc. */
73 	size_t	maparrsz;		/* Map array size. */
74 	size_t	nmappings;		/* Number of mappings. */
75 	size_t	exec_map;		/* Executable text mapping index. */
76 	lwpstatus_t lwps;		/* Process status. */
77 	struct procstat *procstat;	/* libprocstat handle. */
78 	char	execpath[PATH_MAX];	/* Path to program executable. */
79 };
80 
81 #ifdef DEBUG
82 #define	DPRINTF(...) 	warn(__VA_ARGS__)
83 #define	DPRINTFX(...)	warnx(__VA_ARGS__)
84 #else
85 #define	DPRINTF(...)    do { } while (0)
86 #define	DPRINTFX(...)   do { } while (0)
87 #endif
88 
89 #endif /* __LIBPROC_H_ */
90