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 /* 23 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _SYS_SYSEVENT_H 28 #define _SYS_SYSEVENT_H 29 30 #include <sys/nvpair.h> 31 32 #ifdef __cplusplus 33 extern "C" { 34 #endif 35 36 #ifndef NULL 37 #if defined(_LP64) && !defined(__cplusplus) 38 #define NULL 0L 39 #else 40 #define NULL 0 41 #endif 42 #endif 43 44 /* Internal registration class and subclass */ 45 #define EC_ALL "register_all_classes" 46 #define EC_SUB_ALL "register_all_subclasses" 47 48 /* 49 * Event allocation/enqueuing sleep/nosleep flags 50 */ 51 #define SE_SLEEP 0 52 #define SE_NOSLEEP 1 53 54 /* Framework error codes */ 55 #define SE_EINVAL 1 /* Invalid argument */ 56 #define SE_ENOMEM 2 /* Unable to allocate memory */ 57 #define SE_EQSIZE 3 /* Maximum event q size exceeded */ 58 #define SE_EFAULT 4 /* Copy fault */ 59 #define SE_NOTFOUND 5 /* Attribute not found */ 60 #define SE_NO_TRANSPORT 6 /* sysevent transport down */ 61 62 /* Internal data types */ 63 64 #define SE_DATA_TYPE_BYTE DATA_TYPE_BYTE 65 #define SE_DATA_TYPE_INT16 DATA_TYPE_INT16 66 #define SE_DATA_TYPE_UINT16 DATA_TYPE_UINT16 67 #define SE_DATA_TYPE_INT32 DATA_TYPE_INT32 68 #define SE_DATA_TYPE_UINT32 DATA_TYPE_UINT32 69 #define SE_DATA_TYPE_INT64 DATA_TYPE_INT64 70 #define SE_DATA_TYPE_UINT64 DATA_TYPE_UINT64 71 #define SE_DATA_TYPE_STRING DATA_TYPE_STRING 72 #define SE_DATA_TYPE_BYTES DATA_TYPE_BYTE_ARRAY 73 #define SE_DATA_TYPE_TIME DATA_TYPE_HRTIME 74 75 #define SE_KERN_PID 0 76 77 #define SUNW_VENDOR "SUNW" 78 #define SE_USR_PUB "usr:" 79 #define SE_KERN_PUB "kern:" 80 #define SUNW_KERN_PUB SUNW_VENDOR":"SE_KERN_PUB 81 #define SUNW_USR_PUB SUNW_VENDOR":"SE_USR_PUB 82 83 /* 84 * Event header and attribute value limits 85 */ 86 #define MAX_ATTR_NAME 1024 87 #define MAX_STRING_SZ 1024 88 #define MAX_BYTE_ARRAY 1024 89 90 #define MAX_CLASS_LEN 64 91 #define MAX_SUBCLASS_LEN 64 92 #define MAX_PUB_LEN 128 93 #define MAX_CHNAME_LEN 128 94 #define MAX_SUBID_LEN 16 95 96 /* 97 * Limit for the event payload size 98 */ 99 #define MAX_EV_SIZE_LEN (SHRT_MAX/4) 100 101 /* Opaque sysevent_t data type */ 102 typedef void *sysevent_t; 103 104 /* Opaque channel bind data type */ 105 typedef void evchan_t; 106 107 /* sysevent attribute list */ 108 typedef nvlist_t sysevent_attr_list_t; 109 110 /* sysevent attribute name-value pair */ 111 typedef nvpair_t sysevent_attr_t; 112 113 /* Unique event identifier */ 114 typedef struct sysevent_id { 115 uint64_t eid_seq; 116 hrtime_t eid_ts; 117 } sysevent_id_t; 118 119 /* Event attribute value structures */ 120 typedef struct sysevent_bytes { 121 int32_t size; 122 uchar_t *data; 123 } sysevent_bytes_t; 124 125 typedef struct sysevent_value { 126 int32_t value_type; /* data type */ 127 union { 128 uchar_t sv_byte; 129 int16_t sv_int16; 130 uint16_t sv_uint16; 131 int32_t sv_int32; 132 uint32_t sv_uint32; 133 int64_t sv_int64; 134 uint64_t sv_uint64; 135 hrtime_t sv_time; 136 char *sv_string; 137 sysevent_bytes_t sv_bytes; 138 } value; 139 } sysevent_value_t; 140 141 /* 142 * The following flags determine the memory allocation semantics to use for 143 * kernel event buffer allocation by userland and kernel versions of 144 * sysevent_evc_publish(). 145 * 146 * EVCH_SLEEP and EVCH_NOSLEEP respectively map to KM_SLEEP and KM_NOSLEEP. 147 * EVCH_TRYHARD is a kernel-only publish flag that allow event allocation 148 * routines to use use alternate kmem caches in situations where free memory 149 * may be low. Kernel callers of sysevent_evc_publish() must set flags to 150 * one of EVCH_SLEEP, EVCH_NOSLEEP or EVCH_TRYHARD. Userland callers of 151 * sysevent_evc_publish() must set flags to one of EVCH_SLEEP or EVCH_NOSLEEP. 152 * 153 * EVCH_QWAIT determines whether or not we should wait for slots in the event 154 * queue at publication time. EVCH_QWAIT may be used by kernel and userland 155 * publishers and must be used in conjunction with any of one of EVCH_SLEEP, 156 * EVCH_NOSLEEP or EVCH_TRYHARD (kernel-only). 157 */ 158 159 #define EVCH_NOSLEEP 0x0001 /* No sleep on kmem_alloc() */ 160 #define EVCH_SLEEP 0x0002 /* Sleep on kmem_alloc() */ 161 #define EVCH_TRYHARD 0x0004 /* May use alternate kmem cache for alloc */ 162 #define EVCH_QWAIT 0x0008 /* Wait for slot in event queue */ 163 164 /* 165 * Meaning of flags for subscribe. Bits 8 to 15 are dedicated to 166 * the consolidation private interface, so flags defined here are restricted 167 * to the LSB. 168 * 169 * EVCH_SUB_KEEP indicates that this subscription should persist even if 170 * this subscriber id should die unexpectedly; matching events will be 171 * queued (up to a limit) and will be delivered if/when we restart again 172 * with the same subscriber id. 173 */ 174 #define EVCH_SUB_KEEP 0x01 175 176 /* 177 * Subscriptions may be wildcarded, but we limit the number of 178 * wildcards permitted. 179 */ 180 #define EVCH_WILDCARD_MAX 10 181 182 /* 183 * Used in unsubscribe to indicate all subscriber ids for a channel. 184 */ 185 #define EVCH_ALLSUB "all_subs" 186 187 /* 188 * Meaning of flags parameter of channel bind function 189 * 190 * EVCH_CREAT indicates to create a channel if not already present. 191 * 192 * EVCH_HOLD_PEND indicates that events should be published to this 193 * channel even if there are no matching subscribers present; when 194 * a subscriber belatedly binds to the channel and registers their 195 * subscriptions they will receive events that predate their bind. 196 * If the channel is closed, however, with no remaining bindings then 197 * the channel is destroyed. 198 * 199 * EVCH_HOLD_PEND_INDEF is a stronger version of EVCH_HOLD_PEND - 200 * even if the channel has no remaining bindings it will not be 201 * destroyed so long as events remain unconsumed. This is suitable for 202 * use with short-lived event producers that may bind to (create) the 203 * channel and exit before the intended consumer has started. 204 */ 205 #define EVCH_CREAT 0x0001 206 #define EVCH_HOLD_PEND 0x0002 207 #define EVCH_HOLD_PEND_INDEF 0x0004 208 #define EVCH_B_FLAGS 0x0007 /* All valid bits */ 209 210 /* 211 * Meaning of commands of evc_control function 212 */ 213 #define EVCH_GET_CHAN_LEN_MAX 1 /* Get event queue length limit */ 214 #define EVCH_GET_CHAN_LEN 2 /* Get event queue length */ 215 #define EVCH_SET_CHAN_LEN 3 /* Set event queue length */ 216 #define EVCH_CMD_LAST EVCH_SET_CHAN_LEN /* Last command */ 217 218 /* 219 * Shared user/kernel event channel interface definitions 220 */ 221 extern int sysevent_evc_bind(const char *, evchan_t **, uint32_t); 222 extern int sysevent_evc_unbind(evchan_t *); 223 extern int sysevent_evc_subscribe(evchan_t *, const char *, const char *, 224 int (*)(sysevent_t *, void *), void *, uint32_t); 225 extern int sysevent_evc_unsubscribe(evchan_t *, const char *); 226 extern int sysevent_evc_publish(evchan_t *, const char *, const char *, 227 const char *, const char *, nvlist_t *, uint32_t); 228 extern int sysevent_evc_control(evchan_t *, int, ...); 229 230 #ifndef _KERNEL 231 232 /* 233 * Userland-only event channel interfaces 234 */ 235 236 #include <door.h> 237 238 typedef struct sysevent_subattr sysevent_subattr_t; 239 240 extern sysevent_subattr_t *sysevent_subattr_alloc(void); 241 extern void sysevent_subattr_free(sysevent_subattr_t *); 242 243 extern void sysevent_subattr_thrattr(sysevent_subattr_t *, pthread_attr_t *); 244 extern void sysevent_subattr_sigmask(sysevent_subattr_t *, sigset_t *); 245 246 extern void sysevent_subattr_thrcreate(sysevent_subattr_t *, 247 door_xcreate_server_func_t *, void *); 248 extern void sysevent_subattr_thrsetup(sysevent_subattr_t *, 249 door_xcreate_thrsetup_func_t *, void *); 250 251 extern int sysevent_evc_xsubscribe(evchan_t *, const char *, const char *, 252 int (*)(sysevent_t *, void *), void *, uint32_t, sysevent_subattr_t *); 253 254 #else 255 256 /* 257 * Kernel log_event interfaces. 258 */ 259 extern int log_sysevent(sysevent_t *, int, sysevent_id_t *); 260 261 extern sysevent_t *sysevent_alloc(char *, char *, char *, int); 262 extern void sysevent_free(sysevent_t *); 263 extern int sysevent_add_attr(sysevent_attr_list_t **, char *, 264 sysevent_value_t *, int); 265 extern void sysevent_free_attr(sysevent_attr_list_t *); 266 extern int sysevent_attach_attributes(sysevent_t *, sysevent_attr_list_t *); 267 extern void sysevent_detach_attributes(sysevent_t *); 268 extern char *sysevent_get_class_name(sysevent_t *); 269 extern char *sysevent_get_subclass_name(sysevent_t *); 270 extern uint64_t sysevent_get_seq(sysevent_t *); 271 extern void sysevent_get_time(sysevent_t *, hrtime_t *); 272 extern size_t sysevent_get_size(sysevent_t *); 273 extern char *sysevent_get_pub(sysevent_t *); 274 extern int sysevent_get_attr_list(sysevent_t *, nvlist_t **); 275 276 #endif /* _KERNEL */ 277 278 #ifdef __cplusplus 279 } 280 #endif 281 282 #endif /* _SYS_SYSEVENT_H */ 283