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 2007 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _SYS_PORT_IMPL_H 28 #define _SYS_PORT_IMPL_H 29 30 #pragma ident "%Z%%M% %I% %E% SMI" 31 32 #ifdef __cplusplus 33 extern "C" { 34 #endif 35 36 /* 37 * Note: 38 * The contents of this file are private to the implementation of the 39 * Solaris system and event ports subsystem and are subject to change 40 * at any time without notice. 41 */ 42 43 #include <sys/poll_impl.h> 44 #include <sys/port.h> 45 #include <sys/port_kernel.h> 46 #include <sys/vnode.h> 47 #include <sys/fem.h> 48 49 /* 50 * port system call codes 51 */ 52 #define PORT_CREATE 0 /* create a port */ 53 #define PORT_ASSOCIATE 1 /* register object or object list */ 54 #define PORT_DISSOCIATE 2 /* remove object association */ 55 #define PORT_SEND 3 /* send user-defined event to a port */ 56 #define PORT_SENDN 4 /* send user-defined event to a list of ports */ 57 #define PORT_GET 5 /* receive object with events */ 58 #define PORT_GETN 6 /* receive list of objects with events */ 59 #define PORT_ALERT 7 /* set port in alert mode */ 60 #define PORT_DISPATCH 8 /* dispatch object with events */ 61 62 #define PORT_SYS_NOPORT 0x100 /* system call without port-id */ 63 #define PORT_SYS_NOSHARE 0x200 /* non shareable event */ 64 #define PORT_CODE_MASK 0xff 65 66 /* port_dispatch() flags */ 67 #define PORT_SHARE_EVENT 0x01 /* event can be shared between procs */ 68 69 /* port limits */ 70 #define PORT_MAX_LIST 8192 /* max. # of list ent. per syscall */ 71 72 #ifdef _KERNEL 73 74 #define PORT_SCACHE_SIZE 16 /* start source cache size */ 75 #define PORT_SHASH(cookie) (cookie & (PORT_SCACHE_SIZE-1)) 76 77 /* portkev_flags masks */ 78 #define PORT_CLEANUP_DONE (PORT_KEV_FREE|PORT_KEV_DONEQ) 79 #define PORT_KEV_CACHE (PORT_KEV_CACHED|PORT_KEV_SCACHED) 80 #define PORT_KEV_WIRED (PORT_KEV_PRIVATE|PORT_KEV_CACHE) 81 82 #define PORT_FREE_EVENT(pev) (((pev)->portkev_flags & PORT_KEV_CACHE) == 0) 83 84 typedef struct port_alert { 85 int portal_events; /* passed to alert event */ 86 pid_t portal_pid; /* owner of the alert mode */ 87 uintptr_t portal_object; /* passed to alert event */ 88 void *portal_user; /* passed to alert event */ 89 } port_alert_t; 90 91 /* 92 * The port_queue_t structure is responsible for the management of all 93 * event activities within a port. 94 */ 95 typedef struct port_queue { 96 kmutex_t portq_mutex; 97 kcondvar_t portq_closecv; 98 kcondvar_t portq_block_cv; 99 int portq_flags; 100 uint_t portq_nent; /* number of events in the queue */ 101 uint_t portq_nget; /* events required for waiting thread */ 102 uint_t portq_tnent; /* number of events in the temp queue */ 103 int portq_thrcnt; /* # of threads waiting for events */ 104 int portq_getn; /* # of threads retrieving events */ 105 struct portget *portq_thread; /* queue of waiting threads */ 106 struct port_fdcache *portq_pcp; /* fd cache */ 107 list_t portq_list; /* port event list */ 108 list_t portq_get_list; /* port event list for port_get(n) */ 109 kmutex_t portq_source_mutex; 110 port_source_t **portq_scache; 111 port_alert_t portq_alert; /* alert event data */ 112 } port_queue_t; 113 114 /* defines for portq_flags */ 115 #define PORTQ_ALERT 0x01 /* port in alert state */ 116 #define PORTQ_CLOSE 0x02 /* closing port */ 117 #define PORTQ_WAIT_EVENTS 0x04 /* waiting for new events */ 118 #define PORTQ_POLLIN 0x08 /* events available in the event queue */ 119 #define PORTQ_POLLOUT 0x10 /* space available for new events */ 120 #define PORTQ_BLOCKED 0x20 /* port is blocked by port_getn() */ 121 #define PORTQ_POLLWK_PEND 0x40 /* pollwakeup is pending, blocks port close */ 122 123 #define VTOEP(v) ((struct port *)(v->v_data)) 124 #define EPTOV(ep) ((struct vnode *)(ep)->port_vnode) 125 126 127 typedef struct port { 128 vnode_t *port_vnode; 129 kmutex_t port_mutex; 130 kcondvar_t port_cv; /* resource control */ 131 uint_t port_flags; 132 pid_t port_pid; 133 int port_fd; 134 uint_t port_max_events; /* max. number of event per port */ 135 uint_t port_max_list; /* max. number of list structs */ 136 uint_t port_curr; /* current number of event structs */ 137 pollhead_t port_pollhd; 138 timespec_t port_ctime; 139 uid_t port_uid; 140 gid_t port_gid; 141 port_queue_t port_queue; /* global queue */ 142 } port_t; 143 144 /* defines for port_flags */ 145 #define PORT_INIT 0x01 /* port initialized */ 146 #define PORT_CLOSED 0x02 /* owner closed the port */ 147 #define PORT_EVENTS 0x04 /* waiting for event resources */ 148 149 /* 150 * global control structure of port framework 151 */ 152 typedef struct port_control { 153 kmutex_t pc_mutex; 154 uint_t pc_nents; /* ports currently allocated */ 155 struct kmem_cache *pc_cache; /* port event structures */ 156 } port_control_t; 157 158 159 /* 160 * Every thread waiting on an object will use this structure to store 161 * all dependencies (flags, counters, events) before it awakes with 162 * some events/transactions completed 163 */ 164 typedef struct portget { 165 int portget_state; 166 uint_t portget_nget; /* number of expected events */ 167 pid_t portget_pid; 168 kcondvar_t portget_cv; 169 port_alert_t portget_alert; 170 struct portget *portget_next; 171 struct portget *portget_prev; 172 } portget_t; 173 174 /* defines for portget_state */ 175 #define PORTGET_ALERT 0x01 /* wake up and return alert event */ 176 177 extern port_control_t port_control; 178 extern uint_t port_max_list; 179 180 /* 181 * port_getn() needs this structure to manage inter-process event delivery. 182 */ 183 typedef struct port_gettimer { 184 ushort_t pgt_flags; 185 ushort_t pgt_loop; 186 int pgt_timecheck; 187 timespec_t pgt_rqtime; 188 timespec_t *pgt_rqtp; 189 struct timespec *pgt_timeout; 190 } port_gettimer_t; 191 192 /* pgt_flags */ 193 #define PORTGET_ONE 0x01 /* return only 1 object */ 194 #define PORTGET_WAIT_EVENTS 0x02 /* thread is waiting for new events */ 195 196 /* 197 * portfd_t is required to synchronize the association of fds with a port 198 * and the per-process list of open files. 199 * There is a pointer to a portfd structure in uf_entry_t. 200 * If a fd is closed then closeandsetf() is able to detect the association of 201 * the fd with a port or with a list of ports. closeandsetf() will dissociate 202 * the fd from the port(s). 203 */ 204 typedef struct portfd { 205 struct polldat pfd_pd; 206 struct portfd *pfd_next; 207 struct portfd *pfd_prev; 208 } portfd_t; 209 210 #define PFTOD(pfd) (&(pfd)->pfd_pd) 211 #define PDTOF(pdp) ((struct portfd *)(pdp)) 212 #define PORT_FD_BUCKET(pcp, fd) \ 213 (&(pcp)->pc_hash[((fd) % (pcp)->pc_hashsize)]) 214 215 /* 216 * PORT_SOURCE_FILE -- File Events Notification sources 217 */ 218 #define PORT_FOP_BUCKET(pcp, id) \ 219 (portfop_t **)(&(pcp)->pfc_hash[(((ulong_t)id >> 8) & \ 220 (PORTFOP_HASHSIZE - 1))]) 221 222 /* 223 * This structure is used to register a file object to be watched. 224 * 225 * The pfop_flags are protected by the vnode's pvp_mutex lock. 226 * The pfop list (vnode's list) is protected by the pvp_mutex when it is on 227 * the vnode's list. 228 * 229 * All the rest of the fields are protected by the port's source cache lock 230 * pfcp_lock. 231 */ 232 typedef struct portfop { 233 int pfop_events; 234 int pfop_flags; /* above flags. */ 235 uintptr_t pfop_object; /* object address */ 236 vnode_t *pfop_vp; 237 vnode_t *pfop_dvp; 238 port_t *pfop_pp; 239 fem_t *pfop_fem; 240 list_node_t pfop_node; /* list of pfop's per vnode */ 241 struct portfop *pfop_hashnext; /* hash list */ 242 pid_t pfop_pid; /* owner of portfop */ 243 struct portfop_cache *pfop_pcache; 244 port_kevent_t *pfop_pev; /* event pointers */ 245 char *pfop_cname; /* file component name */ 246 int pfop_clen; 247 } portfop_t; 248 249 /* 250 * pfop_flags 251 */ 252 #define PORT_FOP_ACTIVE 0x1 253 #define PORT_FOP_REMOVING 0x2 254 #define PORT_FOP_KEV_ONQ 0x4 255 256 typedef struct portfop_vfs { 257 vfs_t *pvfs; 258 int pvfs_unmount; /* 1 if unmount in progress */ 259 list_t pvfs_pvplist; /* list of vnodes from */ 260 fsem_t *pvfs_fsemp; 261 struct portfop_vfs *pvfs_next; /* hash list */ 262 } portfop_vfs_t; 263 264 typedef struct portfop_vfs_hash { 265 kmutex_t pvfshash_mutex; 266 struct portfop_vfs *pvfshash_pvfsp; 267 } portfop_vfs_hash_t; 268 269 typedef struct portfop_vp { 270 vnode_t *pvp_vp; 271 kmutex_t pvp_mutex; 272 int pvp_cnt; /* number of watches */ 273 list_t pvp_pfoplist; 274 list_node_t pvp_pvfsnode; 275 struct portfop *pvp_lpfop; /* oldest pfop */ 276 fem_t *pvp_femp; 277 struct portfop_vfs *pvp_pvfsp; 278 } portfop_vp_t; 279 280 #define PORTFOP_PVFSHASH_SZ 256 281 #define PORTFOP_PVFSHASH(vfsp) (((uintptr_t)(vfsp) >> 4) % PORTFOP_PVFSHASH_SZ) 282 283 /* 284 * file operations flag. 285 */ 286 287 /* 288 * PORT_SOURCE_FILE - vnode operations 289 */ 290 291 #define FOP_FILE_OPEN 0x00000001 292 #define FOP_FILE_READ 0x00000002 293 #define FOP_FILE_WRITE 0x00000004 294 #define FOP_FILE_MAP 0x00000008 295 #define FOP_FILE_IOCTL 0x00000010 296 #define FOP_FILE_CREATE 0x00000020 297 #define FOP_FILE_MKDIR 0x00000040 298 #define FOP_FILE_SYMLINK 0x00000080 299 #define FOP_FILE_LINK 0x00000100 300 #define FOP_FILE_RENAME 0x00000200 301 #define FOP_FILE_REMOVE 0x00000400 302 #define FOP_FILE_RMDIR 0x00000800 303 #define FOP_FILE_READDIR 0x00001000 304 #define FOP_FILE_RENAMESRC 0x00002000 305 #define FOP_FILE_RENAMEDST 0x00004000 306 #define FOP_FILE_REMOVEFILE 0x00008000 307 #define FOP_FILE_REMOVEDIR 0x00010000 308 #define FOP_FILE_SETSECATTR 0x00020000 309 #define FOP_FILE_SETATTR_ATIME 0x00040000 310 #define FOP_FILE_SETATTR_MTIME 0x00080000 311 #define FOP_FILE_SETATTR_CTIME 0x00100000 312 #define FOP_FILE_LINK_SRC 0x00200000 313 314 /* 315 * File modification event. 316 */ 317 #define FOP_MODIFIED_MASK (FOP_FILE_WRITE|FOP_FILE_CREATE \ 318 |FOP_FILE_REMOVE|FOP_FILE_LINK \ 319 |FOP_FILE_RENAMESRC|FOP_FILE_RENAMEDST \ 320 |FOP_FILE_MKDIR|FOP_FILE_RMDIR \ 321 |FOP_FILE_SYMLINK|FOP_FILE_SETATTR_MTIME) 322 323 /* 324 * File access event 325 */ 326 #define FOP_ACCESS_MASK (FOP_FILE_READ|FOP_FILE_READDIR \ 327 |FOP_FILE_MAP|FOP_FILE_SETATTR_ATIME) 328 329 /* 330 * File attrib event 331 */ 332 #define FOP_ATTRIB_MASK (FOP_FILE_WRITE|FOP_FILE_CREATE \ 333 |FOP_FILE_REMOVE|FOP_FILE_LINK \ 334 |FOP_FILE_RENAMESRC|FOP_FILE_RENAMEDST \ 335 |FOP_FILE_MKDIR|FOP_FILE_RMDIR \ 336 |FOP_FILE_SYMLINK|FOP_FILE_SETATTR_CTIME \ 337 |FOP_FILE_LINK_SRC|FOP_FILE_SETSECATTR) 338 339 340 /* 341 * valid watchable events 342 */ 343 #define FILE_EVENTS_MASK (FILE_ACCESS|FILE_MODIFIED|FILE_ATTRIB \ 344 |FILE_NOFOLLOW) 345 /* --- End file events --- */ 346 347 /* 348 * port_kstat_t contains the event port kernel values which are 349 * exported to kstat. 350 * Currently only the number of active ports is exported. 351 */ 352 typedef struct port_kstat { 353 kstat_named_t pks_ports; 354 } port_kstat_t; 355 356 /* misc functions */ 357 int port_alloc_event_block(port_t *, int, int, struct port_kevent **); 358 void port_push_eventq(port_queue_t *); 359 int port_remove_done_event(struct port_kevent *); 360 struct port_kevent *port_get_kevent(list_t *, struct port_kevent *); 361 void port_block(port_queue_t *); 362 void port_unblock(port_queue_t *); 363 364 /* PORT_SOURCE_FD cache management */ 365 void port_pcache_remove_fd(port_fdcache_t *, portfd_t *); 366 int port_remove_fd_object(portfd_t *, struct port *, port_fdcache_t *); 367 368 /* file close management */ 369 extern void addfd_port(int, portfd_t *); 370 extern void delfd_port(int, portfd_t *); 371 372 #endif /* _KERNEL */ 373 374 #ifdef __cplusplus 375 } 376 #endif 377 378 #endif /* _SYS_PORT_IMPL_H */ 379