src/hookmacros.h

   1 /*
   2  * Macros to hook functions.
   3  *
   4  * Copyright (C) 2013  Simon Ruderich
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef MACROS_H
  21 #define MACROS_H 1
  22
  23 /* Hook the function by creating a function with the same name. With
  24  * LD_PRELOAD our function will be preferred. The original function is stored
  25  * in a static variable (real_*). */
  26
  27 #define _HOOK_PRE(type, name) \
  28         int handle; \
  29         int saved_errno = errno; \
  30         DLSYM_FUNCTION(real_ ## name, #name);
  31 #define _HOOK_PRE_FD(type, name, fd) \
  32         type result; \
  33         _HOOK_PRE_FD_(type, name, fd)
  34 #define _HOOK_PRE_FD_(type, name, fd) \
  35         _HOOK_PRE(type, name) \
  36         handle = check_handle_fd(fd); \
  37         if (handle) { \
  38             handle_fd_pre(fd); \
  39         } \
  40         errno = saved_errno;
  41 #define _HOOK_PRE_FILE(type, name, file) \
  42         type result; \
  43         _HOOK_PRE(type, name) \
  44         handle = check_handle_fd(fileno(file)); \
  45         if (handle) { \
  46             handle_file_pre(file); \
  47         } \
  48         errno = saved_errno;
  49 /* Save and restore the errno to make sure we return the errno of the original
  50  * function call. */
  51 #define _HOOK_POST_FD_(fd) \
  52         if (handle) { \
  53             saved_errno = errno; \
  54             handle_fd_post(fd); \
  55             errno = saved_errno; \
  56         }
  57 #define _HOOK_POST_FD(fd) \
  58         _HOOK_POST_FD_(fd) \
  59         return result;
  60 #define _HOOK_POST_FILE(file) \
  61         if (handle) { \
  62             saved_errno = errno; \
  63             handle_file_post(file); \
  64             errno = saved_errno; \
  65         } \
  66         return result;
  67
  68
  69 #define HOOK_VOID1(type, name, fd, type1, arg1) \
  70     static type (*real_ ## name)(type1); \
  71     type name(type1 arg1) { \
  72         _HOOK_PRE_FD_(type, name, fd) \
  73         real_ ## name(arg1); \
  74         _HOOK_POST_FD_(fd) \
  75     }
  76
  77 #define HOOK_FD3(type, name, fd, type1, arg1, type2, arg2, type3, arg3) \
  78     static type (*real_ ## name)(type1, type2, type3); \
  79     type name(type1 arg1, type2 arg2, type3 arg3) { \
  80         _HOOK_PRE_FD(type, name, fd) \
  81         result = real_ ## name(arg1, arg2, arg3); \
  82         _HOOK_POST_FD(fd) \
  83     }
  84
  85 #define HOOK_FILE1(type, name, file, type1, arg1) \
  86     static type (*real_ ## name)(type1); \
  87     type name(type1 arg1) { \
  88         _HOOK_PRE_FILE(type, name, file) \
  89         result = real_ ## name(arg1); \
  90         _HOOK_POST_FILE(file) \
  91     }
  92 #define HOOK_FILE2(type, name, file, type1, arg1, type2, arg2) \
  93     static type (*real_ ## name)(type1, type2); \
  94     type name(type1 arg1, type2 arg2) { \
  95         _HOOK_PRE_FILE(type, name, file) \
  96         result = real_ ## name(arg1, arg2); \
  97         _HOOK_POST_FILE(file) \
  98     }
  99 #define HOOK_FILE3(type, name, file, type1, arg1, type2, arg2, type3, arg3) \
 100     static type (*real_ ## name)(type1, type2, type3); \
 101     type name(type1 arg1, type2 arg2, type3 arg3) { \
 102         _HOOK_PRE_FILE(type, name, file) \
 103         result = real_ ## name(arg1, arg2, arg3); \
 104         _HOOK_POST_FILE(file) \
 105     }
 106 #define HOOK_FILE4(type, name, file, type1, arg1, type2, arg2, type3, arg3, type4, arg4) \
 107     static type (*real_ ## name)(type1, type2, type3, type4); \
 108     type name(type1 arg1, type2 arg2, type3 arg3, type4 arg4) { \
 109         _HOOK_PRE_FILE(type, name, file) \
 110         result = real_ ## name(arg1, arg2, arg3, arg4); \
 111         _HOOK_POST_FILE(file) \
 112     }
 113
 114 #define HOOK_VAR_FILE1(type, name, file, func, type1, arg1) \
 115     static type (*real_ ## func)(type1, va_list); \
 116     type name(type1 arg1, ...) { \
 117         va_list ap; \
 118         _HOOK_PRE_FILE(type, func, file) \
 119         va_start(ap, arg1); \
 120         result = real_ ## func(arg1, ap); \
 121         va_end(ap); \
 122         _HOOK_POST_FILE(file) \
 123     }
 124 #define HOOK_VAR_FILE2(type, name, file, func, type1, arg1, type2, arg2) \
 125     static type (*real_ ## func)(type1, type2, va_list); \
 126     type name(type1 arg1, type2 arg2, ...) { \
 127         va_list ap; \
 128         _HOOK_PRE_FILE(type, func, file) \
 129         va_start(ap, arg2); \
 130         result = real_ ## func(arg1, arg2, ap); \
 131         va_end(ap); \
 132         _HOOK_POST_FILE(file) \
 133     }
 134 #define HOOK_VAR_FILE3(type, name, file, func, type1, arg1, type2, arg2, type3, arg3) \
 135     static type (*real_ ## func)(type1, type2, type3, va_list); \
 136     type name(type1 arg1, type2 arg2, type3 arg3, ...) \
 137     { \
 138         va_list ap; \
 139         _HOOK_PRE_FILE(type, func, file) \
 140         va_start(ap, arg3); \
 141         result = real_ ## func(arg1, arg2, arg3, ap); \
 142         va_end(ap); \
 143         _HOOK_POST_FILE(file) \
 144     }
 145
 146 #endif