lib/libproc/libproc.h

   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 <gelf.h>
  33
  34 struct proc_handle;
  35
  36 typedef void (*proc_child_func)(void *);
  37
  38 /* Values returned by proc_state(). */
  39 #define PS_IDLE         1
  40 #define PS_STOP         2
  41 #define PS_RUN          3
  42 #define PS_UNDEAD       4
  43 #define PS_DEAD         5
  44 #define PS_LOST         6
  45
  46 typedef struct prmap {
  47         uintptr_t       pr_vaddr;       /* Virtual address. */
  48 } prmap_t;
  49
  50 /* Function prototype definitions. */
  51 __BEGIN_DECLS
  52
  53 const prmap_t *proc_addr2map(struct proc_handle *, uintptr_t);
  54 const prmap_t *proc_name2map(struct proc_handle *, const char *);
  55 char    *proc_objname(struct proc_handle *, uintptr_t, char *, size_t);
  56 int     proc_addr2sym(struct proc_handle *, uintptr_t, char *, size_t, GElf_Sym *);
  57 int     proc_attach(pid_t pid, int flags, struct proc_handle **pphdl);
  58 int     proc_continue(struct proc_handle *);
  59 int     proc_clearflags(struct proc_handle *, int);
  60 int     proc_create(const char *, char * const *, proc_child_func *, void *,
  61             struct proc_handle **);
  62 int     proc_detach(struct proc_handle *);
  63 int     proc_getflags(struct proc_handle *);
  64 int     proc_name2sym(struct proc_handle *, const char *, const char *, GElf_Sym *);
  65 int     proc_setflags(struct proc_handle *, int);
  66 int     proc_state(struct proc_handle *);
  67 int     proc_wait(struct proc_handle *);
  68 pid_t   proc_getpid(struct proc_handle *);
  69 void    proc_free(struct proc_handle *);
  70
  71 __END_DECLS
  72
  73 #endif /* !_LIBPROC_H_ */