xref: /titanic_41/usr/src/uts/common/sys/hook_event.h (revision 32af2ca055c988774f07e0a9c733ce69fdf7c5b6)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 /*
27  * This file include definition of message passed from hook provider
28  * to hook consumer.  If necessary, each hook provider can add its
29  * own message definition here.
30  */
31 
32 #ifndef _SYS_HOOK_EVENT_H
33 #define	_SYS_HOOK_EVENT_H
34 
35 #include <sys/neti.h>
36 #include <sys/hook.h>
37 
38 #ifdef	__cplusplus
39 extern "C" {
40 #endif
41 
42 /*
43  * The hook_pkt_event_t structure is supplied with packet events on
44  * associated network interfaces.
45  *
46  * The members of this structure are defined as follows:
47  * hpe_protocol - protocol identifier that indicates which protocol the
48  *                header data is associated with.
49  * hpe_ifp - "in" interface for packets coming into the system or forwarded
50  * hpe_ofp - "out" interface for packets being transmitted or forwarded
51  * hpe_hdr - pointer to protocol header within the packet
52  * hpe_mp  - pointer to the mblk pointer starting the chain for this packet
53  * hpe_mb  - pointer to the mblk that contains hpe_hdr
54  */
55 typedef struct hook_pkt_event {
56 	net_handle_t		hpe_protocol;
57 	phy_if_t		hpe_ifp;
58 	phy_if_t		hpe_ofp;
59 	void			*hpe_hdr;
60 	mblk_t			**hpe_mp;
61 	mblk_t			*hpe_mb;
62 	int			hpe_flags;
63 	void			*hpe_reserved[2];
64 } hook_pkt_event_t;
65 
66 #define	HPE_MULTICAST	0x01
67 #define	HPE_BROADCAST	0x02
68 
69 /*
70  * NIC events hook provider
71  */
72 typedef enum nic_event {
73 	NE_PLUMB = 1,
74 	NE_UNPLUMB,
75 	NE_UP,
76 	NE_DOWN,
77 	NE_ADDRESS_CHANGE,
78 	NE_LIF_UP,
79 	NE_LIF_DOWN,
80 	NE_IFINDEX_CHANGE
81 } nic_event_t;
82 
83 typedef void *nic_event_data_t;
84 
85 /*
86  * The hook_nic_event data structure is provided with all network interface
87  * events.
88  *
89  * hne_protocol- network protocol for events, returned from net_lookup
90  * hne_nic     - physical interface associated with event
91  * hne_lif     - logical interface (if any) associated with event
92  * hne_event   - type of event occuring
93  * hne_data    - pointer to extra data about event or NULL if none
94  * hne_datalen - size of data pointed to by hne_data (can be 0)
95  */
96 typedef struct hook_nic_event {
97 	net_handle_t		hne_protocol;
98 	phy_if_t		hne_nic;
99 	lif_if_t		hne_lif;
100 	nic_event_t		hne_event;
101 	nic_event_data_t	hne_data;
102 	size_t			hne_datalen;
103 } hook_nic_event_t;
104 
105 /*
106  * This structure is used internally by ip to queue events.
107  */
108 struct hook_nic_event_int {
109 	netstackid_t		hnei_stackid;
110 	hook_nic_event_t	hnei_event;
111 };
112 typedef struct hook_nic_event_int hook_nic_event_int_t;
113 
114 /*
115  * This structure holds the data passed back from the ip module to
116  * observability consumers.
117  *
118  * Externally exposed fields, that must match the order and size of
119  * dl_ipnetinfo_t in <sys/dlpi.h> are:
120  * hpo_version    Version number for this header
121  * hpo_family     Address family of the attached packet
122  * hpo_htype      IPobs hook type
123  * hpo_pktlen     Length of the attached packet
124  * hpo_ifindex    Interface index that the packet was received/sent over.
125  *                For local packets, this is the index of the interface
126  *                associated with the local destination address.
127  * hpo_grifindex  IPMP group interface index (zero unless ihd_ifindex
128  *                is an IPMP underlying interface).
129  * hpo_zsrc       Source zoneid; set to ALL_ZONES when unknown.
130  * hpo_zdst       Destination zoneid; set to ALL_ZONES when unknown.
131  *
132  * Fields used internally are:
133  * hpo_pkt        Pointer to the mblk_t containig this structure with
134  *                the real packet found at b_cont
135  */
136 typedef struct hook_pkt_observe_s {
137 	uint8_t		hpo_version;
138 	uint8_t		hpo_family;
139 	uint16_t	hpo_htype;
140 	uint32_t	hpo_pktlen;
141 	uint32_t	hpo_ifindex;
142 	uint32_t	hpo_grifindex;
143 	uint32_t	hpo_zsrc;
144 	uint32_t	hpo_zdst;
145 	/*
146 	 * Fields used internally are below.
147 	 */
148 	mblk_t		*hpo_pkt;
149 	void		*hpo_ctx;
150 } hook_pkt_observe_t;
151 
152 /*
153  * ipobs_hooktype_t describes the hook types supported
154  * by the ip module. IPOBS_HOOK_LOCAL refers to packets
155  * which are looped back internally within the ip module.
156  */
157 
158 typedef enum ipobs_hook_type {
159 	IPOBS_HOOK_INBOUND = 0,
160 	IPOBS_HOOK_OUTBOUND = 1,
161 	IPOBS_HOOK_LOCAL = 2
162 } ipobs_hook_type_t;
163 
164 
165 #ifdef	__cplusplus
166 }
167 #endif
168 
169 #endif /* _SYS_HOOK_EVENT_H */
170