xref: /titanic_41/usr/src/uts/common/sys/hook_event.h (revision 2654012f83cec5dc15b61dfe3e4a4915f186e7a6)
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 2008 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 } nic_event_t;
79 
80 typedef void *nic_event_data_t;
81 
82 /*
83  * The hook_nic_event data structure is provided with all network interface
84  * events.
85  *
86  * hne_protocol- network protocol for events, returned from net_lookup
87  * hne_nic     - physical interface associated with event
88  * hne_lif     - logical interface (if any) associated with event
89  * hne_event   - type of event occuring
90  * hne_data    - pointer to extra data about event or NULL if none
91  * hne_datalen - size of data pointed to by hne_data (can be 0)
92  */
93 typedef struct hook_nic_event {
94 	net_handle_t		hne_protocol;
95 	phy_if_t		hne_nic;
96 	lif_if_t		hne_lif;
97 	nic_event_t		hne_event;
98 	nic_event_data_t	hne_data;
99 	size_t			hne_datalen;
100 } hook_nic_event_t;
101 
102 /*
103  * This structure is used internally by ip to queue events.
104  */
105 struct hook_nic_event_int {
106 	netstackid_t		hnei_stackid;
107 	hook_nic_event_t	hnei_event;
108 };
109 typedef struct hook_nic_event_int hook_nic_event_int_t;
110 
111 #ifdef	__cplusplus
112 }
113 #endif
114 
115 #endif /* _SYS_HOOK_EVENT_H */
116