1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2008 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
/*
* This file includes definitions of kernel hook framework components
*/
#ifndef _SYS_HOOK_H
#define _SYS_HOOK_H
#include <sys/queue.h>
#include <sys/netstack.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* Definition exposed to hook provider and consumer
*/
#define HOOK_VERSION 1
typedef uintptr_t hook_data_t;
struct hook_event_int;
typedef struct hook_event_int *hook_event_token_t;
struct hook_int;
typedef struct hook_int *hook_token_t;
typedef int (* hook_func_t)(hook_event_token_t, hook_data_t, void *);
/*
* A hook_notify_cmd_t is given as an argument to functions called as part of
* the notify callbacks that have been registered firing.
*/
typedef enum hook_notify_cmd_e {
HN_NONE = 0,
HN_REGISTER = 1,
HN_UNREGISTER = 2
} hook_notify_cmd_t;
/*
*
*/
typedef enum hook_hint_e {
HH_NONE = 0,
HH_FIRST,
HH_LAST,
HH_BEFORE,
HH_AFTER
} hook_hint_t;
/*
* Hook
*/
typedef struct hook_s {
int h_version;
hook_func_t h_func; /* callback func */
char *h_name; /* name of this hook */
uint_t h_flags; /* extra hook properties */
hook_hint_t h_hint; /* What type of hint is hintvalue */
uintptr_t h_hintvalue;
void *h_arg; /* value to pass back into the hook */
} hook_t;
#define HOOK_INIT(x, fn, r, a) \
do { \
(x) = hook_alloc(HOOK_VERSION); \
(x)->h_func = (fn); \
(x)->h_name = (r); \
(x)->h_flags = 0; \
(x)->h_hint = HH_NONE; \
(x)->h_hintvalue = 0; \
(x)->h_arg = (a); \
_NOTE(CONSTCOND) \
} while (0)
/*
* Family
*/
typedef struct hook_family_s {
int hf_version; /* version number */
char *hf_name; /* family name */
} hook_family_t;
#define HOOK_FAMILY_INIT(x, y) \
do { \
(x)->hf_version = HOOK_VERSION; \
(x)->hf_name = (y); \
_NOTE(CONSTCOND) \
} while (0)
/*
* Event
*/
typedef struct hook_event_s {
int he_version;
char *he_name; /* name of this hook list */
int he_flags; /* 1 = multiple entries allowed */
boolean_t he_interested; /* true if callback exist */
} hook_event_t;
#define HOOK_RDONLY 0x1 /* Callbacks must not change data */
/* Multiple callbacks are allowed */
#define HOOK_EVENT_INIT(x, y) \
do { \
(x)->he_version = HOOK_VERSION; \
(x)->he_name = (y); \
(x)->he_flags = 0; \
(x)->he_interested = B_FALSE; \
_NOTE(CONSTCOND) \
} while (0)
typedef int (* hook_notify_fn_t)(hook_notify_cmd_t, void *, const char *,
const char *, const char *);
extern hook_t *hook_alloc(const int version);
extern void hook_free(hook_t *);
#ifdef __cplusplus
}
#endif
#endif /* _SYS_HOOK_H */
|
