📄 ap_hook.h
字号:
#if 0=cut#endif/* ==================================================================== * Copyright (c) 1998-2000 The Apache Group. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. All advertising materials mentioning features or use of this * software must display the following acknowledgment: * "This product includes software developed by the Apache Group * for use in the Apache HTTP server project (http://www.apache.org/)." * * 4. The names "Apache Server" and "Apache Group" must not be used to * endorse or promote products derived from this software without * prior written permission. For written permission, please contact * apache@apache.org. * * 5. Products derived from this software may not be called "Apache" * nor may "Apache" appear in their names without prior written * permission of the Apache Group. * * 6. Redistributions of any form whatsoever must retain the following * acknowledgment: * "This product includes software developed by the Apache Group * for use in the Apache HTTP server project (http://www.apache.org/)." * * THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE GROUP OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED * OF THE POSSIBILITY OF SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Group and was originally based * on public domain software written at the National Center for * Supercomputing Applications, University of Illinois, Urbana-Champaign. * For more information on the Apache Group and the Apache HTTP server * project, please see <http://www.apache.org/>. * *//*** Implementation of a Generic Hook Interface for Apache** Written by Ralf S. Engelschall <rse@engelschall.com> **** See POD document at end of this file for description.** View it with the command ``pod2man ap_hook.h | nroff -man | more''**** Attention: This header file is a little bit tricky.** It's a combination of a C source and an embedded POD document** The purpose of this is to have both things together at one** place. So you can both pass this file to the C compiler and ** the pod2man translater.*/#ifdef EAPI#ifndef AP_HOOK_H#define AP_HOOK_H/* * Function Signature Specification: * * We encode the complete signature ingredients as a bitfield * stored in a single unsigned long integer value, which can be * constructed with AP_HOOK_SIGx(...) *//* the type of the signature bitfield */typedef unsigned long int ap_hook_sig;/* the mask (bin) 111 (hex 0x7) for the triples in the bitfield */#define AP_HOOK_SIG_TRIPLE_MASK 0x7/* the position of the triple */#define AP_HOOK_SIG_TRIPLE_POS(n) ((n)*3)/* the constructor for triple #n with value v */#define AP_HOOK_SIG_TRIPLE(n,v) \ (((ap_hook_sig)(v))<<((AP_HOOK_##n)*3))/* the check whether triple #n in sig contains value v */#define AP_HOOK_SIG_HAS(sig,n,v) \ ((((ap_hook_sig)(sig))&AP_HOOK_SIG_TRIPLE(n, AP_HOOK_SIG_TRIPLE_MASK)) == (AP_HOOK_##n##_##v))/* utility function to get triple #n in sig */#define AP_HOOK_SIG_TRIPLE_GET(sig,n) \ ((((ap_hook_sig)(sig))>>AP_HOOK_SIG_TRIPLE_POS(n))&(AP_HOOK_SIG_TRIPLE_MASK))/* utility function to set triple #n in sig to value v */#define AP_HOOK_SIG_TRIPLE_SET(sig,n,v) \ ((((ap_hook_sig)(sig))&~(AP_HOOK_SIG_TRIPLE_MASK<<AP_HOOK_SIG_TRIPLE_POS(n)))|((v)<<AP_HOOK_SIG_TRIPLE_POS(n)))/* define the ingredients for the triple #0: id stuff */#define AP_HOOK_ID 0#define AP_HOOK_ID_ok AP_HOOK_SIG_TRIPLE(ID,0)#define AP_HOOK_ID_undef AP_HOOK_SIG_TRIPLE(ID,1)/* define the ingredients for the triple #1: return code */#define AP_HOOK_RC 1#define AP_HOOK_RC_void AP_HOOK_SIG_TRIPLE(RC,0)#define AP_HOOK_RC_char AP_HOOK_SIG_TRIPLE(RC,1)#define AP_HOOK_RC_int AP_HOOK_SIG_TRIPLE(RC,2)#define AP_HOOK_RC_long AP_HOOK_SIG_TRIPLE(RC,3)#define AP_HOOK_RC_float AP_HOOK_SIG_TRIPLE(RC,4)#define AP_HOOK_RC_double AP_HOOK_SIG_TRIPLE(RC,5)#define AP_HOOK_RC_ptr AP_HOOK_SIG_TRIPLE(RC,6)/* define the ingredients for the triple #2: argument 1 */#define AP_HOOK_A1 2#define AP_HOOK_A1_ctx AP_HOOK_SIG_TRIPLE(A1,0)#define AP_HOOK_A1_char AP_HOOK_SIG_TRIPLE(A1,1)#define AP_HOOK_A1_int AP_HOOK_SIG_TRIPLE(A1,2)#define AP_HOOK_A1_long AP_HOOK_SIG_TRIPLE(A1,3)#define AP_HOOK_A1_float AP_HOOK_SIG_TRIPLE(A1,4)#define AP_HOOK_A1_double AP_HOOK_SIG_TRIPLE(A1,5)#define AP_HOOK_A1_ptr AP_HOOK_SIG_TRIPLE(A1,6)/* define the ingredients for the triple #3: argument 2 */#define AP_HOOK_A2 3#define AP_HOOK_A2_ctx AP_HOOK_SIG_TRIPLE(A2,0)#define AP_HOOK_A2_char AP_HOOK_SIG_TRIPLE(A2,1)#define AP_HOOK_A2_int AP_HOOK_SIG_TRIPLE(A2,2)#define AP_HOOK_A2_long AP_HOOK_SIG_TRIPLE(A2,3)#define AP_HOOK_A2_float AP_HOOK_SIG_TRIPLE(A2,4)#define AP_HOOK_A2_double AP_HOOK_SIG_TRIPLE(A2,5)#define AP_HOOK_A2_ptr AP_HOOK_SIG_TRIPLE(A2,6)/* define the ingredients for the triple #4: argument 3 */#define AP_HOOK_A3 4#define AP_HOOK_A3_ctx AP_HOOK_SIG_TRIPLE(A3,0)#define AP_HOOK_A3_char AP_HOOK_SIG_TRIPLE(A3,1)#define AP_HOOK_A3_int AP_HOOK_SIG_TRIPLE(A3,2)#define AP_HOOK_A3_long AP_HOOK_SIG_TRIPLE(A3,3)#define AP_HOOK_A3_float AP_HOOK_SIG_TRIPLE(A3,4)#define AP_HOOK_A3_double AP_HOOK_SIG_TRIPLE(A3,5)#define AP_HOOK_A3_ptr AP_HOOK_SIG_TRIPLE(A3,6)/* define the ingredients for the triple #5: argument 4 */#define AP_HOOK_A4 5#define AP_HOOK_A4_ctx AP_HOOK_SIG_TRIPLE(A4,0)#define AP_HOOK_A4_char AP_HOOK_SIG_TRIPLE(A4,1)#define AP_HOOK_A4_int AP_HOOK_SIG_TRIPLE(A4,2)#define AP_HOOK_A4_long AP_HOOK_SIG_TRIPLE(A4,3)#define AP_HOOK_A4_float AP_HOOK_SIG_TRIPLE(A4,4)#define AP_HOOK_A4_double AP_HOOK_SIG_TRIPLE(A4,5)#define AP_HOOK_A4_ptr AP_HOOK_SIG_TRIPLE(A4,6)/* define the ingredients for the triple #6: argument 5 */#define AP_HOOK_A5 6#define AP_HOOK_A5_ctx AP_HOOK_SIG_TRIPLE(A5,0)#define AP_HOOK_A5_char AP_HOOK_SIG_TRIPLE(A5,1)#define AP_HOOK_A5_int AP_HOOK_SIG_TRIPLE(A5,2)#define AP_HOOK_A5_long AP_HOOK_SIG_TRIPLE(A5,3)#define AP_HOOK_A5_float AP_HOOK_SIG_TRIPLE(A5,4)#define AP_HOOK_A5_double AP_HOOK_SIG_TRIPLE(A5,5)#define AP_HOOK_A5_ptr AP_HOOK_SIG_TRIPLE(A5,6)/* define the ingredients for the triple #7: argument 6 */#define AP_HOOK_A6 7#define AP_HOOK_A6_ctx AP_HOOK_SIG_TRIPLE(A6,0)#define AP_HOOK_A6_char AP_HOOK_SIG_TRIPLE(A6,1)#define AP_HOOK_A6_int AP_HOOK_SIG_TRIPLE(A6,2)#define AP_HOOK_A6_long AP_HOOK_SIG_TRIPLE(A6,3)#define AP_HOOK_A6_float AP_HOOK_SIG_TRIPLE(A6,4)#define AP_HOOK_A6_double AP_HOOK_SIG_TRIPLE(A6,5)#define AP_HOOK_A6_ptr AP_HOOK_SIG_TRIPLE(A6,6)/* define the ingredients for the triple #8: argument 7 */#define AP_HOOK_A7 8#define AP_HOOK_A7_ctx AP_HOOK_SIG_TRIPLE(A7,0)#define AP_HOOK_A7_char AP_HOOK_SIG_TRIPLE(A7,1)#define AP_HOOK_A7_int AP_HOOK_SIG_TRIPLE(A7,2)#define AP_HOOK_A7_long AP_HOOK_SIG_TRIPLE(A7,3)#define AP_HOOK_A7_float AP_HOOK_SIG_TRIPLE(A7,4)#define AP_HOOK_A7_double AP_HOOK_SIG_TRIPLE(A7,5)#define AP_HOOK_A7_ptr AP_HOOK_SIG_TRIPLE(A7,6)/* define the ingredients for the triple #9: argument 8 */#define AP_HOOK_A8 9#define AP_HOOK_A8_ctx AP_HOOK_SIG_TRIPLE(9,0)#define AP_HOOK_A8_char AP_HOOK_SIG_TRIPLE(9,1)#define AP_HOOK_A8_int AP_HOOK_SIG_TRIPLE(9,2)#define AP_HOOK_A8_long AP_HOOK_SIG_TRIPLE(9,3)#define AP_HOOK_A8_float AP_HOOK_SIG_TRIPLE(9,4)#define AP_HOOK_A8_double AP_HOOK_SIG_TRIPLE(9,5)#define AP_HOOK_A8_ptr AP_HOOK_SIG_TRIPLE(9,6) /* the constructor for unknown signatures */#define AP_HOOK_SIG_UNKNOWN AP_HOOK_ID_undef/* the constructor for signatures with 1 type */#define AP_HOOK_SIG1(rc) \ (AP_HOOK_RC_##rc)/* the constructor for signatures with 2 types */#define AP_HOOK_SIG2(rc,a1) \ (AP_HOOK_RC_##rc|AP_HOOK_A1_##a1)/* the constructor for signatures with 3 types */#define AP_HOOK_SIG3(rc,a1,a2) \ (AP_HOOK_RC_##rc|AP_HOOK_A1_##a1|AP_HOOK_A2_##a2)/* the constructor for signatures with 4 types */#define AP_HOOK_SIG4(rc,a1,a2,a3) \ (AP_HOOK_RC_##rc|AP_HOOK_A1_##a1|AP_HOOK_A2_##a2|AP_HOOK_A3_##a3)/* the constructor for signatures with 5 types */#define AP_HOOK_SIG5(rc,a1,a2,a3,a4) \ (AP_HOOK_RC_##rc|AP_HOOK_A1_##a1|AP_HOOK_A2_##a2|AP_HOOK_A3_##a3|AP_HOOK_A4_##a4)/* the constructor for signatures with 6 types */#define AP_HOOK_SIG6(rc,a1,a2,a3,a4,a5) \ (AP_HOOK_RC_##rc|AP_HOOK_A1_##a1|AP_HOOK_A2_##a2|AP_HOOK_A3_##a3|AP_HOOK_A4_##a4|AP_HOOK_A5_##a5)/* the constructor for signatures with 7 types */#define AP_HOOK_SIG7(rc,a1,a2,a3,a4,a5,a6) \ (AP_HOOK_RC_##rc|AP_HOOK_A1_##a1|AP_HOOK_A2_##a2|AP_HOOK_A3_##a3|AP_HOOK_A4_##a4|AP_HOOK_A5_##a5|AP_HOOK_A6_##a6)/* the constructor for signatures with 8 types */#define AP_HOOK_SIG8(rc,a1,a2,a3,a4,a5,a6,a7) \ (AP_HOOK_RC_##rc|AP_HOOK_A1_##a1|AP_HOOK_A2_##a2|AP_HOOK_A3_##a3|AP_HOOK_A4_##a4|AP_HOOK_A5_##a5|AP_HOOK_A6_##a6|AP_HOOK_A7_##a7)/* the constructor for signatures with 9 types */#define AP_HOOK_SIG9(rc,a1,a2,a3,a4,a5,a6,a7,a8) \ (AP_HOOK_RC_##rc|AP_HOOK_A1_##a1|AP_HOOK_A2_##a2|AP_HOOK_A3_##a3|AP_HOOK_A4_##a4|AP_HOOK_A5_##a5|AP_HOOK_A6_##a6|AP_HOOK_A7_##a7|AP_HOOK_A8_##a8)/* * Return Value Mode Identification *//* the type of the return value modes */typedef unsigned int ap_hook_mode;/* the mode of the return value */#define AP_HOOK_MODE_UNKNOWN 0#define AP_HOOK_MODE_TOPMOST 1#define AP_HOOK_MODE_DECLINE 2#define AP_HOOK_MODE_DECLTMP 3#define AP_HOOK_MODE_ALL 4/* the constructors for the return value modes */#define AP_HOOK_TOPMOST AP_HOOK_MODE_TOPMOST#define AP_HOOK_DECLINE(val) AP_HOOK_MODE_DECLINE, (val) #define AP_HOOK_DECLTMP(val) AP_HOOK_MODE_DECLTMP, (val) #define AP_HOOK_ALL AP_HOOK_MODE_ALL/* * Hook State Identification *//* the type of the hook state */typedef unsigned short int ap_hook_state;/* the values of the hook state */#define AP_HOOK_STATE_UNDEF 0#define AP_HOOK_STATE_NOTEXISTANT 1#define AP_HOOK_STATE_ESTABLISHED 2#define AP_HOOK_STATE_CONFIGURED 3#define AP_HOOK_STATE_REGISTERED 4/* * Hook Context Identification * * Notice: Null is ok here, because AP_HOOK_NOCTX is just a dummy argument * because we know from the signature whether the argument is a * context value or just the dummy value. */#define AP_HOOK_NOCTX (void *)(0)#define AP_HOOK_CTX(v) (void *)(v)/* * Internal Hook Record Definition *//* the union holding the arbitrary decline values */typedef union { char v_char; int v_int; long v_long; float v_float; double v_double; void *v_ptr;} ap_hook_value;/* the structure holding one hook function and its context */typedef struct { void *hf_ptr; /* function pointer */ void *hf_ctx; /* function context */} ap_hook_func;/* the structure holding one hook entry with all its registered functions */typedef struct { char *he_hook; /* hook name (=unique id) */ ap_hook_sig he_sig; /* hook signature */ int he_modeid; /* hook mode id */ ap_hook_value he_modeval; /* hook mode value */ ap_hook_func **he_func; /* hook registered funcs */} ap_hook_entry;/* the maximum number of hooks and functions per hook */#define AP_HOOK_MAX_ENTRIES 512#define AP_HOOK_MAX_FUNCS 128/* * Extended Variable Argument (vararg) Support * * In ANSI C varargs exists, but because the prototypes of function with * varargs cannot reflect the types of the varargs, K&R argument passing * conventions have to apply for the compiler. This means mainly a conversion * of shorter type variants to the maximum variant (according to sizeof). The * above va_type() macro provides this mapping from the wanted types to the * physically used ones. *//* the mapping */#define VA_TYPE_char int#define VA_TYPE_short int#define VA_TYPE_int int#define VA_TYPE_long long#define VA_TYPE_float double#define VA_TYPE_double double#define VA_TYPE_ptr void *#define VA_TYPE_ctx void */* the constructor */#ifdef va_type#undef va_type#endif#define va_type(type) VA_TYPE_ ## type/* * Miscellaneous stuff */#ifndef FALSE⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -