usr/src/lib/libtnfctl/prb_proc.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License, Version 1.0 only
   6  * (the "License").  You may not use this file except in compliance
   7  * with the License.
   8  *
   9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  10  * or http://www.opensolaris.org/os/licensing.
  11  * See the License for the specific language governing permissions
  12  * and limitations under the License.
  13  *
  14  * When distributing Covered Code, include this CDDL HEADER in each
  15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  16  * If applicable, add the following below this CDDL HEADER, with the
  17  * fields enclosed by brackets "[]" replaced with your own identifying
  18  * information: Portions Copyright [yyyy] [name of copyright owner]
  19  *
  20  * CDDL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 1994, by Sun Microsytems, Inc.
  24  */
  25
  26 #ifndef _PRB_PROC_H
  27 #define _PRB_PROC_H
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /*
  34  * Header file that gives the interfaces to the proc layer.  These are the
  35  * interfaces for "native" /proc i.e. when libtnfctl uses /proc directly
  36  * on the target process (tnfctl_exec_open() and tnfctl_pid_open())
  37  */
  38
  39 /*
  40  * Includes
  41  */
  42
  43 #include <sys/types.h>
  44 #include <sys/syscall.h>
  45 #include <sys/procfs.h>
  46 #include <sys/errno.h>
  47 #include <signal.h>
  48
  49 #include <tnf/probe.h>
  50
  51 /*
  52  * Typedefs
  53  */
  54
  55 typedef enum prb_status {
  56         /* successful status */
  57         PRB_STATUS_OK = 0,
  58
  59         /* errors */
  60         /*
  61          * Status values in the range 1 to -1023 are reserved for mapping
  62          * standard errno values.
  63          */
  64         PRB_STATUS_MINERRNO = 1,        /* minimum errno value */
  65         PRB_STATUS_EAGAIN = EAGAIN,
  66         PRB_STATUS_MAXERRNO = 1023,     /* maximum errno value */
  67
  68         PRB_STATUS_ALLOCFAIL,           /* memory allocation failed */
  69         PRB_STATUS_BADARG,              /* bad input argument */
  70         PRB_STATUS_BADSYNC,             /* couldn't sync with rtld */
  71         PRB_STATUS_BADLMAPSTATE         /* inconsistent link map */
  72 } prb_status_t;
  73
  74 typedef enum prb_syscall_op {
  75         PRB_SYS_ALL,            /* turn on all system calls      */
  76         PRB_SYS_NONE,           /* clears all system calls       */
  77         PRB_SYS_ADD,            /* add a system call             */
  78         PRB_SYS_DEL             /* delete a system call          */
  79 } prb_syscall_op_t;
  80
  81 /*
  82  * status of /proc file descriptor
  83  */
  84 typedef struct prb_proc_state {
  85         boolean_t       ps_isstopped;
  86         boolean_t       ps_isinsys;
  87         boolean_t       ps_isrequested;
  88         boolean_t       ps_issysexit;
  89         boolean_t       ps_issysentry;
  90         boolean_t       ps_isbptfault;
  91         long            ps_syscallnum;
  92 } prb_proc_state_t;
  93
  94 /*
  95  * Opaque /proc handle
  96  */
  97 typedef struct prb_proc_ctl prb_proc_ctl_t;
  98
  99 /*
 100  * prb_dbgaddr() has to be called with the address of DT_DEBUG before
 101  * most other interfaces in the prb layer can be used.
 102  */
 103 void            prb_dbgaddr(prb_proc_ctl_t *proc_p, uintptr_t dbgaddr);
 104
 105 /*
 106  * loadobject iteration callback specification
 107  * WARNING: keep this structure in sync with tnfctl_ind_obj_info_t
 108  */
 109 typedef struct prb_loadobj {
 110         int                     objfd;
 111         uintptr_t               text_base;
 112         uintptr_t               data_base;
 113         const char              *objname;
 114 } prb_loadobj_t;
 115
 116 typedef int prb_loadobj_f(prb_proc_ctl_t *proc_p, const prb_loadobj_t *obj,
 117                                 void *calldata);
 118 prb_status_t    prb_loadobj_iter(prb_proc_ctl_t *, prb_loadobj_f *, void *);
 119 prb_status_t    prb_mainobj_get(prb_proc_ctl_t *proc_p, int *objfd,
 120                                                 uintptr_t *baseaddr);
 121
 122 const char      *prb_status_str(prb_status_t prbstat);
 123
 124 pid_t           prb_proc_pid_get(prb_proc_ctl_t *proc_p);
 125
 126 /* rtld interfaces */
 127 prb_status_t    prb_rtld_sync_if_needed(prb_proc_ctl_t *proc_p);
 128 prb_status_t    prb_rtld_stalk(prb_proc_ctl_t *proc_p);
 129 prb_status_t    prb_rtld_unstalk(prb_proc_ctl_t *proc_p);
 130 prb_status_t    prb_rtld_advance(prb_proc_ctl_t *proc_p);
 131
 132 /* generic /proc wrapper interfaces */
 133 prb_status_t    prb_proc_open(pid_t pid, prb_proc_ctl_t **proc_pp);
 134 prb_status_t    prb_proc_reopen(pid_t pid, prb_proc_ctl_t **proc_pp);
 135 prb_status_t    prb_proc_close(prb_proc_ctl_t *proc_p);
 136 prb_status_t    prb_proc_stop(prb_proc_ctl_t *proc_p);
 137 prb_status_t    prb_proc_wait(prb_proc_ctl_t *proc_p, boolean_t use_sigmask,
 138                                         sigset_t *oldmask);
 139 prb_status_t    prb_proc_cont(prb_proc_ctl_t *proc_p);
 140 prb_status_t    prb_proc_state(prb_proc_ctl_t *proc_p,
 141                                         prb_proc_state_t *state_p);
 142 prb_status_t    prb_proc_setrlc(prb_proc_ctl_t *proc_p, boolean_t rlc);
 143 prb_status_t    prb_proc_setklc(prb_proc_ctl_t *proc_p, boolean_t klc);
 144 prb_status_t    prb_proc_exit(prb_proc_ctl_t *proc_p, uint_t syscall,
 145                                         prb_syscall_op_t op);
 146 prb_status_t    prb_proc_entry(prb_proc_ctl_t *proc_p, uint_t syscall,
 147                                         prb_syscall_op_t op);
 148 prb_status_t    prb_proc_read(prb_proc_ctl_t *proc_p, uintptr_t addr,
 149         void *buf, size_t size);
 150 prb_status_t    prb_proc_write(prb_proc_ctl_t *proc_p, uintptr_t addr,
 151         void *buf, size_t size);
 152 prb_status_t    prb_proc_setfork(prb_proc_ctl_t *proc_p, boolean_t inhfork);
 153 prb_status_t    prb_proc_get_r0_r1(prb_proc_ctl_t *proc_p,
 154     prgreg_t *r0, prgreg_t *r1);
 155
 156 /* exec a child */
 157 prb_status_t    prb_child_create(const char *cmdname, char * const *cmdargs,
 158         const char *loption, const char *libtnfprobe_path,
 159         char * const *envp, prb_proc_ctl_t **ret_val);
 160
 161 #ifdef __cplusplus
 162 }
 163 #endif
 164
 165 #endif  /* _PRB_PROC_H */