phpspy.h

#ifndef __PHPSPY_H
#define __PHPSPY_H

#ifndef _GNU_SOURCE
#define _GNU_SOURCE
#endif

#include <errno.h>
#include <fcntl.h>
#include <getopt.h>
#include <limits.h>
#include <pthread.h>
#include <signal.h>
#include <stdarg.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/ptrace.h>
#include <sys/select.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <sys/types.h>
#include <sys/uio.h>
#include <sys/wait.h>
#include <sys/syscall.h>
#include <time.h>
#include <unistd.h>
#include <termbox2.h>
#include <regex.h>

#ifdef USE_ZEND
#include <main/php_config.h>
#undef ZEND_DEBUG
#define ZEND_DEBUG 0
#include <main/SAPI.h>
#undef snprintf
#undef vsnprintf
#undef HASH_ADD
#else
#include <php_structs_70.h>
#include <php_structs_71.h>
#include <php_structs_72.h>
#include <php_structs_73.h>
#include <php_structs_74.h>
#include <php_structs_80.h>
#include <php_structs_81.h>
#include <php_structs_82.h>
#include <php_structs_83.h>
#include <php_structs_84.h>
#endif

#ifndef gettid
#define gettid() syscall(SYS_gettid)
#endif

#include <uthash.h>

#define try(__rv, __call)       do { if (((__rv) = (__call)) != 0) return (__rv); } while(0)
#define try_break(__rv, __call) do { if (((__rv) = (__call)) != 0) break;         } while(0)

#define STR1(s) #s
#define STR2(s) STR1(s)

#define PHPSPY_VERSION "0.7.0"
#define PHPSPY_MIN(a, b) ((a) < (b) ? (a) : (b))
#define PHPSPY_MAX(a, b) ((a) > (b) ? (a) : (b))
#define PHPSPY_STR_SIZE 256
#define PHPSPY_MAX_ARRAY_BUCKETS 128
#define PHPSPY_MAX_ARRAY_TABLE_SIZE 512

#define PHPSPY_OK           0
#define PHPSPY_ERR          1
#define PHPSPY_ERR_PID_DEAD 2
#define PHPSPY_ERR_BUF_FULL 4

#define PHPSPY_TRACE_EVENT_INIT        0
#define PHPSPY_TRACE_EVENT_STACK_BEGIN 1
#define PHPSPY_TRACE_EVENT_FRAME       2
#define PHPSPY_TRACE_EVENT_VARPEEK     3
#define PHPSPY_TRACE_EVENT_GLOPEEK     4
#define PHPSPY_TRACE_EVENT_REQUEST     5
#define PHPSPY_TRACE_EVENT_MEM         6
#define PHPSPY_TRACE_EVENT_STACK_END   7
#define PHPSPY_TRACE_EVENT_ERROR       8
#define PHPSPY_TRACE_EVENT_DEINIT      9

#ifndef USE_ZEND
#define IS_UNDEF     0
#define IS_NULL      1
#define IS_FALSE     2
#define IS_TRUE      3
#define IS_LONG      4
#define IS_DOUBLE    5
#define IS_STRING    6
#define IS_ARRAY     7
#define IS_OBJECT    8
#define IS_RESOURCE  9
#define IS_REFERENCE 10
#endif

typedef struct varpeek_var_s {
    char name[PHPSPY_STR_SIZE];
    UT_hash_handle hh;
} varpeek_var_t;

typedef struct varpeek_entry_s {
    char filename_lineno[PHPSPY_STR_SIZE];
    varpeek_var_t *varmap;
    UT_hash_handle hh;
} varpeek_entry_t;

typedef struct glopeek_entry_s {
    char key[PHPSPY_STR_SIZE];
    char gloname[PHPSPY_STR_SIZE]; /* The name of the superglobal array */
    char varname[PHPSPY_STR_SIZE]; /* The name of the global variable within the superglobal array */
    UT_hash_handle hh;
} glopeek_entry_t;

typedef struct trace_loc_s {
    char func[PHPSPY_STR_SIZE];
    char class[PHPSPY_STR_SIZE];
    char file[PHPSPY_STR_SIZE];
    size_t func_len;
    size_t class_len;
    size_t file_len;
    int lineno;
} trace_loc_t;

typedef struct trace_frame_s {
    trace_loc_t loc;
    int depth;
} trace_frame_t;

typedef struct trace_request_s {
    char uri[PHPSPY_STR_SIZE];
    char path[PHPSPY_STR_SIZE];
    char qstring[PHPSPY_STR_SIZE];
    char cookie[PHPSPY_STR_SIZE];
    double ts;
} trace_request_t;

typedef struct trace_mem_s {
    size_t size;
    size_t peak;
} trace_mem_t;

typedef struct trace_varpeek_s {
    varpeek_entry_t *entry;
    varpeek_var_t *var;
    char *zval_str;
} trace_varpeek_t;

typedef struct trace_glopeek_s {
    glopeek_entry_t *gentry;
    char *zval_str;
} trace_glopeek_t;

typedef struct trace_target_s {
    pid_t pid;
    uint64_t executor_globals_addr;
    uint64_t sapi_globals_addr;
    uint64_t alloc_globals_addr;
    uint64_t basic_functions_module_addr;
} trace_target_t;

typedef struct trace_context_s {
    trace_target_t target;
    struct {
        trace_frame_t frame;
        trace_request_t request;
        trace_mem_t mem;
        trace_varpeek_t varpeek;
        trace_glopeek_t glopeek;
    } event;
    void *event_udata;
    int (*event_handler)(struct trace_context_s *context, int event_type);
    const char *event_handler_opts;
    char buf[PHPSPY_STR_SIZE];
    size_t buf_len;
} trace_context_t;

typedef struct addr_memo_s {
    char php_bin_path[PHPSPY_STR_SIZE];
    char php_bin_path_root[PHPSPY_STR_SIZE];
    uint64_t php_base_addr;
} addr_memo_t;

#ifndef USE_ZEND
struct __attribute__((__packed__)) _zend_module_entry {
    uint8_t pad0[88];
    const char *version;
};
#endif

extern char *opt_pgrep_args;
extern int done;
extern int opt_num_workers;
extern pid_t opt_pid;
extern char opt_frame_delim;
extern char opt_trace_delim;
extern char *opt_path_output;
extern regex_t *opt_filter_re;
extern int opt_filter_negate;
extern int opt_verbose_fields_pid;
extern int opt_verbose_fields_ts;
extern int opt_continue_on_error;
extern int opt_fout_buffer_size;
extern long opt_time_limit_ms;
extern char *opt_libname_awk_patt;

extern int main_pgrep();
extern int main_pid(pid_t pid);
extern int main_top(int argc, char **argv);

extern void usage(FILE *fp, int exit_code);
extern int get_symbol_addr(addr_memo_t *memo, pid_t pid, const char *symbol, uint64_t *raddr);
extern int event_handler_fout(struct trace_context_s *context, int event_type);
extern int event_handler_callgrind(struct trace_context_s *context, int event_type);
extern void write_done_pipe();
extern void log_error(const char *fmt, ...);
extern uint64_t phpspy_zend_inline_hash_func(const char *str, size_t len);
extern int shell_escape(const char *arg, char *buf, size_t buf_size, const char *what);

#endif