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 2008 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 /* Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T */ 28 /* All Rights Reserved */ 29 30 /* 31 * University Copyright- Copyright (c) 1982, 1986, 1988 32 * The Regents of the University of California 33 * All Rights Reserved 34 * 35 * University Acknowledgment- Portions of this document are derived from 36 * software developed by the University of California, Berkeley, and its 37 * contributors. 38 */ 39 40 #ifndef _SYS_SOCKETVAR_H 41 #define _SYS_SOCKETVAR_H 42 43 #include <sys/types.h> 44 #include <sys/stream.h> 45 #include <sys/t_lock.h> 46 #include <sys/cred.h> 47 #include <sys/vnode.h> 48 #include <sys/file.h> 49 #include <sys/param.h> 50 #include <sys/zone.h> 51 #include <sys/sdt.h> 52 #include <sys/modctl.h> 53 #include <sys/atomic.h> 54 #include <sys/socket.h> 55 #include <sys/ksocket.h> 56 #include <sys/sodirect.h> 57 58 #ifdef __cplusplus 59 extern "C" { 60 #endif 61 62 /* 63 * Internal representation of the address used to represent addresses 64 * in the loopback transport for AF_UNIX. While the sockaddr_un is used 65 * as the sockfs layer address for AF_UNIX the pathnames contained in 66 * these addresses are not unique (due to relative pathnames) thus can not 67 * be used in the transport. 68 * 69 * The transport level address consists of a magic number (used to separate the 70 * name space for specific and implicit binds). For a specific bind 71 * this is followed by a "vnode *" which ensures that all specific binds 72 * have a unique transport level address. For implicit binds the latter 73 * part of the address is a byte string (of the same length as a pointer) 74 * that is assigned by the loopback transport. 75 * 76 * The uniqueness assumes that the loopback transport has a separate namespace 77 * for sockets in order to avoid name conflicts with e.g. TLI use of the 78 * same transport. 79 */ 80 struct so_ux_addr { 81 void *soua_vp; /* vnode pointer or assigned by tl */ 82 uint_t soua_magic; /* See below */ 83 }; 84 85 #define SOU_MAGIC_EXPLICIT 0x75787670 /* "uxvp" */ 86 #define SOU_MAGIC_IMPLICIT 0x616e6f6e /* "anon" */ 87 88 struct sockaddr_ux { 89 sa_family_t sou_family; /* AF_UNIX */ 90 struct so_ux_addr sou_addr; 91 }; 92 93 #if defined(_KERNEL) || defined(_KMEMUSER) 94 95 #include <sys/socket_proto.h> 96 97 typedef struct sonodeops sonodeops_t; 98 typedef struct sonode sonode_t; 99 100 /* 101 * The sonode represents a socket. A sonode never exist in the file system 102 * name space and can not be opened using open() - only the socket, socketpair 103 * and accept calls create sonodes. 104 * 105 * The locking of sockfs uses the so_lock mutex plus the SOLOCKED and 106 * SOREADLOCKED flags in so_flag. The mutex protects all the state in the 107 * sonode. It is expected that the underlying transport protocol serializes 108 * socket operations, so sockfs will not normally not single-thread 109 * operations. However, certain sockets, including TPI based ones, can only 110 * handle one control operation at a time. The SOLOCKED flag is used to 111 * single-thread operations from sockfs users to prevent e.g. multiple bind() 112 * calls to operate on the same sonode concurrently. The SOREADLOCKED flag is 113 * used to ensure that only one thread sleeps in kstrgetmsg for a given 114 * sonode. This is needed to ensure atomic operation for things like 115 * MSG_WAITALL. 116 * 117 * The so_fallback_rwlock is used to ensure that for sockets that can 118 * fall back to TPI, the fallback is not initiated until all pending 119 * operations have completed. 120 * 121 * Note that so_lock is sometimes held across calls that might go to sleep 122 * (kmem_alloc and soallocproto*). This implies that no other lock in 123 * the system should be held when calling into sockfs; from the system call 124 * side or from strrput (in case of TPI based sockets). If locks are held 125 * while calling into sockfs the system might hang when running low on memory. 126 */ 127 struct sonode { 128 struct vnode *so_vnode; /* vnode associated with this sonode */ 129 130 sonodeops_t *so_ops; /* operations vector for this sonode */ 131 void *so_priv; /* sonode private data */ 132 133 krwlock_t so_fallback_rwlock; 134 kmutex_t so_lock; /* protects sonode fields */ 135 136 kcondvar_t so_state_cv; /* synchronize state changes */ 137 kcondvar_t so_want_cv; /* wait due to SOLOCKED */ 138 139 /* These fields are protected by so_lock */ 140 141 uint_t so_state; /* internal state flags SS_*, below */ 142 uint_t so_mode; /* characteristics on socket. SM_* */ 143 ushort_t so_flag; /* flags, see below */ 144 int so_count; /* count of opened references */ 145 146 sock_connid_t so_proto_connid; /* protocol generation number */ 147 148 ushort_t so_error; /* error affecting connection */ 149 150 struct sockparams *so_sockparams; /* vnode or socket module */ 151 /* Needed to recreate the same socket for accept */ 152 short so_family; 153 short so_type; 154 short so_protocol; 155 short so_version; /* From so_socket call */ 156 157 /* Accept queue */ 158 kmutex_t so_acceptq_lock; /* protects accept queue */ 159 struct sonode *so_acceptq_next; /* acceptq list node */ 160 struct sonode *so_acceptq_head; 161 struct sonode **so_acceptq_tail; 162 unsigned int so_acceptq_len; 163 unsigned int so_backlog; /* Listen backlog */ 164 kcondvar_t so_acceptq_cv; /* wait for new conn. */ 165 166 /* Options */ 167 short so_options; /* From socket call, see socket.h */ 168 struct linger so_linger; /* SO_LINGER value */ 169 #define so_sndbuf so_proto_props.sopp_txhiwat /* SO_SNDBUF value */ 170 #define so_sndlowat so_proto_props.sopp_txlowat /* tx low water mark */ 171 #define so_rcvbuf so_proto_props.sopp_rxhiwat /* SO_RCVBUF value */ 172 #define so_rcvlowat so_proto_props.sopp_rxlowat /* rx low water mark */ 173 #define so_max_addr_len so_proto_props.sopp_maxaddrlen 174 #define so_minpsz so_proto_props.sopp_minpsz 175 #define so_maxpsz so_proto_props.sopp_maxpsz 176 177 clock_t so_sndtimeo; /* send timeout */ 178 clock_t so_rcvtimeo; /* recv timeout */ 179 180 mblk_t *so_oobmsg; /* outofline oob data */ 181 ssize_t so_oobmark; /* offset of the oob data */ 182 183 pid_t so_pgrp; /* pgrp for signals */ 184 185 cred_t *so_peercred; /* connected socket peer cred */ 186 pid_t so_cpid; /* connected socket peer cached pid */ 187 zoneid_t so_zoneid; /* opener's zoneid */ 188 189 struct pollhead so_poll_list; /* common pollhead */ 190 short so_pollev; /* events that should be generated */ 191 192 /* Receive */ 193 unsigned int so_rcv_queued; 194 mblk_t *so_rcv_q_head; 195 mblk_t *so_rcv_q_last_head; 196 mblk_t *so_rcv_head; /* 1st mblk in the list */ 197 mblk_t *so_rcv_last_head; /* last mblk in b_next chain */ 198 kcondvar_t so_rcv_cv; 199 uint_t so_rcv_wanted; /* # of bytes wanted by app */ 200 timeout_id_t so_rcv_timer_tid; 201 202 #define so_rcv_thresh so_proto_props.sopp_rcvthresh 203 #define so_rcv_timer_interval so_proto_props.sopp_rcvtimer 204 205 /* Send */ 206 boolean_t so_snd_qfull; /* Transmit full */ 207 kcondvar_t so_snd_cv; 208 209 boolean_t so_rcv_wakeup; 210 boolean_t so_snd_wakeup; 211 212 /* Communication channel with protocol */ 213 sock_lower_handle_t so_proto_handle; 214 sock_downcalls_t *so_downcalls; 215 216 struct sock_proto_props so_proto_props; /* protocol settings */ 217 boolean_t so_flowctrld; /* Flow controlled */ 218 uint_t so_copyflag; /* Copy related flag */ 219 kcondvar_t so_copy_cv; /* Copy cond variable */ 220 221 /* kernel sockets */ 222 ksocket_callbacks_t so_ksock_callbacks; 223 void *so_ksock_cb_arg; /* callback argument */ 224 kcondvar_t so_closing_cv; 225 226 /* != NULL for sodirect_t enabled socket */ 227 sodirect_t *so_direct; 228 }; 229 230 /* 231 * We do an initial check for events without holding locks. However, 232 * if there are no event available, then we redo the check for POLLIN 233 * events under the lock. 234 */ 235 #define SO_HAVE_DATA(so) \ 236 ((so)->so_rcv_timer_tid == 0 && (so->so_rcv_queued > 0)) || \ 237 ((so)->so_rcv_queued > (so)->so_rcv_thresh) || \ 238 ((so)->so_state & SS_CANTRCVMORE) 239 240 /* 241 * Events handled by the protocol (in case sd_poll is set) 242 */ 243 #define SO_PROTO_POLLEV (POLLIN|POLLRDNORM|POLLRDBAND) 244 245 246 #endif /* _KERNEL || _KMEMUSER */ 247 248 /* flags */ 249 #define SOMOD 0x0001 /* update socket modification time */ 250 #define SOACC 0x0002 /* update socket access time */ 251 252 #define SOLOCKED 0x0010 /* use to serialize open/closes */ 253 #define SOREADLOCKED 0x0020 /* serialize kstrgetmsg calls */ 254 #define SOWANT 0x0040 /* some process waiting on lock */ 255 #define SOCLONE 0x0080 /* child of clone driver */ 256 #define SOASYNC_UNBIND 0x0100 /* wait for ACK of async unbind */ 257 258 #define SOCK_IS_NONSTR(so) ((so)->so_vnode->v_stream == NULL) 259 260 /* 261 * Socket state bits. 262 */ 263 #define SS_ISCONNECTED 0x00000001 /* socket connected to a peer */ 264 #define SS_ISCONNECTING 0x00000002 /* in process, connecting to peer */ 265 #define SS_ISDISCONNECTING 0x00000004 /* in process of disconnecting */ 266 #define SS_CANTSENDMORE 0x00000008 /* can't send more data to peer */ 267 268 #define SS_CANTRCVMORE 0x00000010 /* can't receive more data */ 269 #define SS_ISBOUND 0x00000020 /* socket is bound */ 270 #define SS_NDELAY 0x00000040 /* FNDELAY non-blocking */ 271 #define SS_NONBLOCK 0x00000080 /* O_NONBLOCK non-blocking */ 272 273 #define SS_ASYNC 0x00000100 /* async i/o notify */ 274 #define SS_ACCEPTCONN 0x00000200 /* listen done */ 275 /* unused 0x00000400 */ /* was SS_HASCONNIND */ 276 #define SS_SAVEDEOR 0x00000800 /* Saved MSG_EOR rcv side state */ 277 278 #define SS_RCVATMARK 0x00001000 /* at mark on input */ 279 #define SS_OOBPEND 0x00002000 /* OOB pending or present - poll */ 280 #define SS_HAVEOOBDATA 0x00004000 /* OOB data present */ 281 #define SS_HADOOBDATA 0x00008000 /* OOB data consumed */ 282 #define SS_CLOSING 0x00010000 /* in process of closing */ 283 284 /* unused 0x00020000 */ /* was SS_FADDR_NOXLATE */ 285 /* unused 0x00040000 */ /* was SS_HASDATA */ 286 /* unused 0x00080000 */ /* was SS_DONEREAD */ 287 /* unused 0x00100000 */ /* was SS_MOREDATA */ 288 /* unused 0x00200000 */ /* was SS_DIRECT */ 289 290 #define SS_SODIRECT 0x00400000 /* transport supports sodirect */ 291 292 /* unused 0x01000000 */ /* was SS_LADDR_VALID */ 293 /* unused 0x02000000 */ /* was SS_FADDR_VALID */ 294 295 #define SS_SENTLASTREADSIG 0x10000000 /* last rx signal has been sent */ 296 #define SS_SENTLASTWRITESIG 0x20000000 /* last tx signal has been sent */ 297 298 #define SS_FALLBACK_PENDING 0x40000000 299 #define SS_FALLBACK_COMP 0x80000000 300 301 302 /* Set of states when the socket can't be rebound */ 303 #define SS_CANTREBIND (SS_ISCONNECTED|SS_ISCONNECTING|SS_ISDISCONNECTING|\ 304 SS_CANTSENDMORE|SS_CANTRCVMORE|SS_ACCEPTCONN) 305 306 /* 307 * Sockets that can fall back to TPI must ensure that fall back is not 308 * initiated while a thread is using a socket. 309 */ 310 #define SO_BLOCK_FALLBACK(so, fn) { \ 311 ASSERT(MUTEX_NOT_HELD(&(so)->so_lock)); \ 312 rw_enter(&(so)->so_fallback_rwlock, RW_READER); \ 313 if ((so)->so_state & SS_FALLBACK_COMP) { \ 314 rw_exit(&(so)->so_fallback_rwlock); \ 315 return (fn); \ 316 } \ 317 } 318 319 #define SO_UNBLOCK_FALLBACK(so) { \ 320 rw_exit(&(so)->so_fallback_rwlock); \ 321 } 322 323 /* Poll events */ 324 #define SO_POLLEV_IN 0x1 /* POLLIN wakeup needed */ 325 #define SO_POLLEV_ALWAYS 0x2 /* wakeups */ 326 327 /* 328 * Characteristics of sockets. Not changed after the socket is created. 329 */ 330 #define SM_PRIV 0x001 /* privileged for broadcast, raw... */ 331 #define SM_ATOMIC 0x002 /* atomic data transmission */ 332 #define SM_ADDR 0x004 /* addresses given with messages */ 333 #define SM_CONNREQUIRED 0x008 /* connection required by protocol */ 334 335 #define SM_FDPASSING 0x010 /* passes file descriptors */ 336 #define SM_EXDATA 0x020 /* Can handle T_EXDATA_REQ */ 337 #define SM_OPTDATA 0x040 /* Can handle T_OPTDATA_REQ */ 338 #define SM_BYTESTREAM 0x080 /* Byte stream - can use M_DATA */ 339 340 #define SM_ACCEPTOR_ID 0x100 /* so_acceptor_id is valid */ 341 342 #define SM_KERNEL 0x200 /* kernel socket */ 343 344 #define SM_ACCEPTSUPP 0x400 /* can handle accept() */ 345 346 /* 347 * Socket versions. Used by the socket library when calling _so_socket(). 348 */ 349 #define SOV_STREAM 0 /* Not a socket - just a stream */ 350 #define SOV_DEFAULT 1 /* Select based on so_default_version */ 351 #define SOV_SOCKSTREAM 2 /* Socket plus streams operations */ 352 #define SOV_SOCKBSD 3 /* Socket with no streams operations */ 353 #define SOV_XPG4_2 4 /* Xnet socket */ 354 355 #if defined(_KERNEL) || defined(_KMEMUSER) 356 357 /* 358 * sonode create and destroy functions. 359 */ 360 typedef struct sonode *(*so_create_func_t)(struct sockparams *, 361 int, int, int, int, int, int *, cred_t *); 362 typedef void (*so_destroy_func_t)(struct sonode *); 363 364 /* STREAM device information */ 365 typedef struct sdev_info { 366 char *sd_devpath; 367 int sd_devpathlen; /* Is 0 if sp_devpath is a static string */ 368 vnode_t *sd_vnode; 369 } sdev_info_t; 370 371 #define SOCKMOD_VERSION 1 372 /* name of the TPI pseudo socket module */ 373 #define SOTPI_SMOD_NAME "socktpi" 374 375 typedef struct __smod_priv_s { 376 so_create_func_t smodp_sock_create_func; 377 so_destroy_func_t smodp_sock_destroy_func; 378 so_proto_fallback_func_t smodp_proto_fallback_func; 379 } __smod_priv_t; 380 381 /* 382 * Socket module register information 383 */ 384 typedef struct smod_reg_s { 385 int smod_version; 386 char *smod_name; 387 size_t smod_uc_version; 388 size_t smod_dc_version; 389 so_proto_create_func_t smod_proto_create_func; 390 391 /* __smod_priv_data must be NULL */ 392 __smod_priv_t *__smod_priv; 393 } smod_reg_t; 394 395 /* 396 * Socket module information 397 */ 398 typedef struct smod_info { 399 int smod_version; 400 char *smod_name; 401 uint_t smod_refcnt; /* # of entries */ 402 size_t smod_uc_version; /* upcall version */ 403 size_t smod_dc_version; /* down call version */ 404 so_proto_create_func_t smod_proto_create_func; 405 so_proto_fallback_func_t smod_proto_fallback_func; 406 so_create_func_t smod_sock_create_func; 407 so_destroy_func_t smod_sock_destroy_func; 408 list_node_t smod_node; 409 } smod_info_t; 410 411 /* 412 * sockparams 413 * 414 * Used for mapping family/type/protocol to module 415 */ 416 struct sockparams { 417 /* 418 * The family, type, protocol, sdev_info and smod_info are 419 * set when the entry is created, and they will never change 420 * thereafter. 421 */ 422 int sp_family; 423 int sp_type; 424 int sp_protocol; 425 426 sdev_info_t sp_sdev_info; /* STREAM device */ 427 char *sp_smod_name; /* socket module name */ 428 smod_info_t *sp_smod_info; /* socket module */ 429 430 kmutex_t sp_lock; /* lock for refcnt */ 431 uint64_t sp_refcnt; /* entry reference count */ 432 433 /* 434 * The entries below are only modified while holding 435 * splist_lock as a writer. 436 */ 437 int sp_flags; /* see below */ 438 list_node_t sp_node; 439 }; 440 441 442 /* 443 * sockparams flags 444 */ 445 #define SOCKPARAMS_EPHEMERAL 0x1 /* temp. entry, not on global list */ 446 447 extern void sockparams_init(void); 448 extern struct sockparams *sockparams_hold_ephemeral_bydev(int, int, int, 449 const char *, int, int *); 450 extern struct sockparams *sockparams_hold_ephemeral_bymod(int, int, int, 451 const char *, int, int *); 452 extern void sockparams_ephemeral_drop_last_ref(struct sockparams *); 453 454 extern void smod_init(void); 455 extern void smod_add(smod_info_t *); 456 extern int smod_register(const smod_reg_t *); 457 extern int smod_unregister(const char *); 458 extern smod_info_t *smod_lookup_byname(const char *); 459 460 #define SOCKPARAMS_HAS_DEVICE(sp) \ 461 ((sp)->sp_sdev_info.sd_devpath != NULL) 462 463 /* Increase the smod_info_t reference count */ 464 #define SMOD_INC_REF(smodp) { \ 465 ASSERT((smodp) != NULL); \ 466 DTRACE_PROBE1(smodinfo__inc__ref, struct smod_info *, (smodp)); \ 467 atomic_inc_uint(&(smodp)->smod_refcnt); \ 468 } 469 470 /* 471 * Decreace the socket module entry reference count. 472 * When no one mapping to the entry, we try to unload the module from the 473 * kernel. If the module can't unload, just leave the module entry with 474 * a zero refcnt. 475 */ 476 #define SMOD_DEC_REF(sp, smodp) { \ 477 ASSERT((smodp) != NULL); \ 478 ASSERT((smodp)->smod_refcnt != 0); \ 479 atomic_dec_uint(&(smodp)->smod_refcnt); \ 480 /* \ 481 * No need to atomically check the return value because the \ 482 * socket module framework will verify that no one is using \ 483 * the module before unloading. Worst thing that can happen \ 484 * here is multiple calls to mod_remove_by_name(), which is OK. \ 485 */ \ 486 if ((smodp)->smod_refcnt == 0) \ 487 (void) mod_remove_by_name((sp)->sp_smod_name); \ 488 } 489 490 /* Increase the reference count */ 491 #define SOCKPARAMS_INC_REF(sp) { \ 492 ASSERT((sp) != NULL); \ 493 DTRACE_PROBE1(sockparams__inc__ref, struct sockparams *, (sp)); \ 494 mutex_enter(&(sp)->sp_lock); \ 495 (sp)->sp_refcnt++; \ 496 ASSERT((sp)->sp_refcnt != 0); \ 497 mutex_exit(&(sp)->sp_lock); \ 498 } 499 500 /* 501 * Decrease the reference count. 502 * 503 * If the sockparams is ephemeral, then the thread dropping the last ref 504 * count will destroy the entry. 505 */ 506 #define SOCKPARAMS_DEC_REF(sp) { \ 507 ASSERT((sp) != NULL); \ 508 DTRACE_PROBE1(sockparams__dec__ref, struct sockparams *, (sp)); \ 509 mutex_enter(&(sp)->sp_lock); \ 510 ASSERT((sp)->sp_refcnt > 0); \ 511 if ((sp)->sp_refcnt == 1) { \ 512 if ((sp)->sp_flags & SOCKPARAMS_EPHEMERAL) { \ 513 mutex_exit(&(sp)->sp_lock); \ 514 sockparams_ephemeral_drop_last_ref((sp)); \ 515 } else { \ 516 (sp)->sp_refcnt--; \ 517 if ((sp)->sp_smod_info != NULL) \ 518 SMOD_DEC_REF(sp, (sp)->sp_smod_info); \ 519 (sp)->sp_smod_info = NULL; \ 520 mutex_exit(&(sp)->sp_lock); \ 521 } \ 522 } else { \ 523 (sp)->sp_refcnt--; \ 524 mutex_exit(&(sp)->sp_lock); \ 525 } \ 526 } 527 528 /* 529 * Used to traverse the list of AF_UNIX sockets to construct the kstat 530 * for netstat(1m). 531 */ 532 struct socklist { 533 kmutex_t sl_lock; 534 struct sonode *sl_list; 535 }; 536 537 extern struct socklist socklist; 538 /* 539 * ss_full_waits is the number of times the reader thread 540 * waits when the queue is full and ss_empty_waits is the number 541 * of times the consumer thread waits when the queue is empty. 542 * No locks for these as they are just indicators of whether 543 * disk or network or both is slow or fast. 544 */ 545 struct sendfile_stats { 546 uint32_t ss_file_cached; 547 uint32_t ss_file_not_cached; 548 uint32_t ss_full_waits; 549 uint32_t ss_empty_waits; 550 uint32_t ss_file_segmap; 551 }; 552 553 /* 554 * A single sendfile request is represented by snf_req. 555 */ 556 typedef struct snf_req { 557 struct snf_req *sr_next; 558 mblk_t *sr_mp_head; 559 mblk_t *sr_mp_tail; 560 kmutex_t sr_lock; 561 kcondvar_t sr_cv; 562 uint_t sr_qlen; 563 int sr_hiwat; 564 int sr_lowat; 565 int sr_operation; 566 struct vnode *sr_vp; 567 file_t *sr_fp; 568 ssize_t sr_maxpsz; 569 u_offset_t sr_file_off; 570 u_offset_t sr_file_size; 571 #define SR_READ_DONE 0x80000000 572 int sr_read_error; 573 int sr_write_error; 574 } snf_req_t; 575 576 /* A queue of sendfile requests */ 577 struct sendfile_queue { 578 snf_req_t *snfq_req_head; 579 snf_req_t *snfq_req_tail; 580 kmutex_t snfq_lock; 581 kcondvar_t snfq_cv; 582 int snfq_svc_threads; /* # of service threads */ 583 int snfq_idle_cnt; /* # of idling threads */ 584 int snfq_max_threads; 585 int snfq_req_cnt; /* Number of requests */ 586 }; 587 588 #define READ_OP 1 589 #define SNFQ_TIMEOUT (60 * 5 * hz) /* 5 minutes */ 590 591 /* Socket network operations switch */ 592 struct sonodeops { 593 int (*sop_init)(struct sonode *, struct sonode *, cred_t *, 594 int); 595 int (*sop_accept)(struct sonode *, int, cred_t *, struct sonode **); 596 int (*sop_bind)(struct sonode *, struct sockaddr *, socklen_t, 597 int, cred_t *); 598 int (*sop_listen)(struct sonode *, int, cred_t *); 599 int (*sop_connect)(struct sonode *, const struct sockaddr *, 600 socklen_t, int, int, cred_t *); 601 int (*sop_recvmsg)(struct sonode *, struct msghdr *, 602 struct uio *, cred_t *); 603 int (*sop_sendmsg)(struct sonode *, struct msghdr *, 604 struct uio *, cred_t *); 605 int (*sop_sendmblk)(struct sonode *, struct msghdr *, int, 606 cred_t *, mblk_t **); 607 int (*sop_getpeername)(struct sonode *, struct sockaddr *, 608 socklen_t *, boolean_t, cred_t *); 609 int (*sop_getsockname)(struct sonode *, struct sockaddr *, 610 socklen_t *, cred_t *); 611 int (*sop_shutdown)(struct sonode *, int, cred_t *); 612 int (*sop_getsockopt)(struct sonode *, int, int, void *, 613 socklen_t *, int, cred_t *); 614 int (*sop_setsockopt)(struct sonode *, int, int, const void *, 615 socklen_t, cred_t *); 616 int (*sop_ioctl)(struct sonode *, int, intptr_t, int, 617 cred_t *, int32_t *); 618 int (*sop_poll)(struct sonode *, short, int, short *, 619 struct pollhead **); 620 int (*sop_close)(struct sonode *, int, cred_t *); 621 }; 622 623 #define SOP_INIT(so, flag, cr, flags) \ 624 ((so)->so_ops->sop_init((so), (flag), (cr), (flags))) 625 #define SOP_ACCEPT(so, fflag, cr, nsop) \ 626 ((so)->so_ops->sop_accept((so), (fflag), (cr), (nsop))) 627 #define SOP_BIND(so, name, namelen, flags, cr) \ 628 ((so)->so_ops->sop_bind((so), (name), (namelen), (flags), (cr))) 629 #define SOP_LISTEN(so, backlog, cr) \ 630 ((so)->so_ops->sop_listen((so), (backlog), (cr))) 631 #define SOP_CONNECT(so, name, namelen, fflag, flags, cr) \ 632 ((so)->so_ops->sop_connect((so), (name), (namelen), (fflag), (flags), \ 633 (cr))) 634 #define SOP_RECVMSG(so, msg, uiop, cr) \ 635 ((so)->so_ops->sop_recvmsg((so), (msg), (uiop), (cr))) 636 #define SOP_SENDMSG(so, msg, uiop, cr) \ 637 ((so)->so_ops->sop_sendmsg((so), (msg), (uiop), (cr))) 638 #define SOP_SENDMBLK(so, msg, size, cr, mpp) \ 639 ((so)->so_ops->sop_sendmblk((so), (msg), (size), (cr), (mpp))) 640 #define SOP_GETPEERNAME(so, addr, addrlen, accept, cr) \ 641 ((so)->so_ops->sop_getpeername((so), (addr), (addrlen), (accept), (cr))) 642 #define SOP_GETSOCKNAME(so, addr, addrlen, cr) \ 643 ((so)->so_ops->sop_getsockname((so), (addr), (addrlen), (cr))) 644 #define SOP_SHUTDOWN(so, how, cr) \ 645 ((so)->so_ops->sop_shutdown((so), (how), (cr))) 646 #define SOP_GETSOCKOPT(so, level, optionname, optval, optlenp, flags, cr) \ 647 ((so)->so_ops->sop_getsockopt((so), (level), (optionname), \ 648 (optval), (optlenp), (flags), (cr))) 649 #define SOP_SETSOCKOPT(so, level, optionname, optval, optlen, cr) \ 650 ((so)->so_ops->sop_setsockopt((so), (level), (optionname), \ 651 (optval), (optlen), (cr))) 652 #define SOP_IOCTL(so, cmd, arg, mode, cr, rvalp) \ 653 ((so)->so_ops->sop_ioctl((so), (cmd), (arg), (mode), (cr), (rvalp))) 654 #define SOP_POLL(so, events, anyyet, reventsp, phpp) \ 655 ((so)->so_ops->sop_poll((so), (events), (anyyet), (reventsp), (phpp))) 656 #define SOP_CLOSE(so, flag, cr) \ 657 ((so)->so_ops->sop_close((so), (flag), (cr))) 658 659 #endif /* defined(_KERNEL) || defined(_KMEMUSER) */ 660 661 #ifdef _KERNEL 662 663 #define ISALIGNED_cmsghdr(addr) \ 664 (((uintptr_t)(addr) & (_CMSG_HDR_ALIGNMENT - 1)) == 0) 665 666 #define ROUNDUP_cmsglen(len) \ 667 (((len) + _CMSG_HDR_ALIGNMENT - 1) & ~(_CMSG_HDR_ALIGNMENT - 1)) 668 669 #define IS_NON_STREAM_SOCK(vp) \ 670 ((vp)->v_type == VSOCK && (vp)->v_stream == NULL) 671 /* 672 * Macros that operate on struct cmsghdr. 673 * Used in parsing msg_control. 674 * The CMSG_VALID macro does not assume that the last option buffer is padded. 675 */ 676 #define CMSG_NEXT(cmsg) \ 677 (struct cmsghdr *)((uintptr_t)(cmsg) + \ 678 ROUNDUP_cmsglen((cmsg)->cmsg_len)) 679 #define CMSG_CONTENT(cmsg) (&((cmsg)[1])) 680 #define CMSG_CONTENTLEN(cmsg) ((cmsg)->cmsg_len - sizeof (struct cmsghdr)) 681 #define CMSG_VALID(cmsg, start, end) \ 682 (ISALIGNED_cmsghdr(cmsg) && \ 683 ((uintptr_t)(cmsg) >= (uintptr_t)(start)) && \ 684 ((uintptr_t)(cmsg) < (uintptr_t)(end)) && \ 685 ((ssize_t)(cmsg)->cmsg_len >= sizeof (struct cmsghdr)) && \ 686 ((uintptr_t)(cmsg) + (cmsg)->cmsg_len <= (uintptr_t)(end))) 687 688 /* 689 * Maximum size of any argument that is copied in (addresses, options, 690 * access rights). MUST be at least MAXPATHLEN + 3. 691 * BSD and SunOS 4.X limited this to MLEN or MCLBYTES. 692 */ 693 #define SO_MAXARGSIZE 8192 694 695 /* 696 * Convert between vnode and sonode 697 */ 698 #define VTOSO(vp) ((struct sonode *)((vp)->v_data)) 699 #define SOTOV(sp) ((sp)->so_vnode) 700 701 /* 702 * Internal flags for sobind() 703 */ 704 #define _SOBIND_REBIND 0x01 /* Bind to existing local address */ 705 #define _SOBIND_UNSPEC 0x02 /* Bind to unspecified address */ 706 #define _SOBIND_LOCK_HELD 0x04 /* so_excl_lock held by caller */ 707 #define _SOBIND_NOXLATE 0x08 /* No addr translation for AF_UNIX */ 708 #define _SOBIND_XPG4_2 0x10 /* xpg4.2 semantics */ 709 #define _SOBIND_SOCKBSD 0x20 /* BSD semantics */ 710 #define _SOBIND_LISTEN 0x40 /* Make into SS_ACCEPTCONN */ 711 #define _SOBIND_SOCKETPAIR 0x80 /* Internal flag for so_socketpair() */ 712 /* to enable listen with backlog = 1 */ 713 714 /* 715 * Internal flags for sounbind() 716 */ 717 #define _SOUNBIND_REBIND 0x01 /* Don't clear fields - will rebind */ 718 719 /* 720 * Internal flags for soconnect() 721 */ 722 #define _SOCONNECT_NOXLATE 0x01 /* No addr translation for AF_UNIX */ 723 #define _SOCONNECT_DID_BIND 0x02 /* Unbind when connect fails */ 724 #define _SOCONNECT_XPG4_2 0x04 /* xpg4.2 semantics */ 725 726 /* 727 * Internal flags for sodisconnect() 728 */ 729 #define _SODISCONNECT_LOCK_HELD 0x01 /* so_excl_lock held by caller */ 730 731 /* 732 * Internal flags for sotpi_getsockopt(). 733 */ 734 #define _SOGETSOCKOPT_XPG4_2 0x01 /* xpg4.2 semantics */ 735 736 /* 737 * Internal flags for soallocproto*() 738 */ 739 #define _ALLOC_NOSLEEP 0 /* Don't sleep for memory */ 740 #define _ALLOC_INTR 1 /* Sleep until interrupt */ 741 #define _ALLOC_SLEEP 2 /* Sleep forever */ 742 743 /* 744 * Internal structure for handling AF_UNIX file descriptor passing 745 */ 746 struct fdbuf { 747 int fd_size; /* In bytes, for kmem_free */ 748 int fd_numfd; /* Number of elements below */ 749 char *fd_ebuf; /* Extra buffer to free */ 750 int fd_ebuflen; 751 frtn_t fd_frtn; 752 struct file *fd_fds[1]; /* One or more */ 753 }; 754 #define FDBUF_HDRSIZE (sizeof (struct fdbuf) - sizeof (struct file *)) 755 756 /* 757 * Variable that can be patched to set what version of socket socket() 758 * will create. 759 */ 760 extern int so_default_version; 761 762 #ifdef DEBUG 763 /* Turn on extra testing capabilities */ 764 #define SOCK_TEST 765 #endif /* DEBUG */ 766 767 #ifdef DEBUG 768 char *pr_state(uint_t, uint_t); 769 char *pr_addr(int, struct sockaddr *, t_uscalar_t); 770 int so_verify_oobstate(struct sonode *); 771 #endif /* DEBUG */ 772 773 /* 774 * DEBUG macros 775 */ 776 #if defined(DEBUG) 777 #define SOCK_DEBUG 778 779 extern int sockdebug; 780 extern int sockprinterr; 781 782 #define eprint(args) printf args 783 #define eprintso(so, args) \ 784 { if (sockprinterr && ((so)->so_options & SO_DEBUG)) printf args; } 785 #define eprintline(error) \ 786 { \ 787 if (error != EINTR && (sockprinterr || sockdebug > 0)) \ 788 printf("socket error %d: line %d file %s\n", \ 789 (error), __LINE__, __FILE__); \ 790 } 791 792 #define eprintsoline(so, error) \ 793 { if (sockprinterr && ((so)->so_options & SO_DEBUG)) \ 794 printf("socket(%p) error %d: line %d file %s\n", \ 795 (void *)(so), (error), __LINE__, __FILE__); \ 796 } 797 #define dprint(level, args) { if (sockdebug > (level)) printf args; } 798 #define dprintso(so, level, args) \ 799 { if (sockdebug > (level) && ((so)->so_options & SO_DEBUG)) printf args; } 800 801 #else /* define(DEBUG) */ 802 803 #define eprint(args) {} 804 #define eprintso(so, args) {} 805 #define eprintline(error) {} 806 #define eprintsoline(so, error) {} 807 #define dprint(level, args) {} 808 #define dprintso(so, level, args) {} 809 810 #endif /* defined(DEBUG) */ 811 812 extern struct vfsops sock_vfsops; 813 extern struct vnodeops *socket_vnodeops; 814 extern const struct fs_operation_def socket_vnodeops_template[]; 815 816 extern dev_t sockdev; 817 818 /* 819 * sockfs functions 820 */ 821 extern int sock_getmsg(vnode_t *, struct strbuf *, struct strbuf *, 822 uchar_t *, int *, int, rval_t *); 823 extern int sock_putmsg(vnode_t *, struct strbuf *, struct strbuf *, 824 uchar_t, int, int); 825 extern int sogetvp(char *, vnode_t **, int); 826 extern int sockinit(int, char *); 827 extern int soconfig(int, int, int, char *, int, char *); 828 extern int solookup(int, int, int, struct sockparams **); 829 extern void so_lock_single(struct sonode *); 830 extern void so_unlock_single(struct sonode *, int); 831 extern int so_lock_read(struct sonode *, int); 832 extern int so_lock_read_intr(struct sonode *, int); 833 extern void so_unlock_read(struct sonode *); 834 extern void *sogetoff(mblk_t *, t_uscalar_t, t_uscalar_t, uint_t); 835 extern void so_getopt_srcaddr(void *, t_uscalar_t, 836 void **, t_uscalar_t *); 837 extern int so_getopt_unix_close(void *, t_uscalar_t); 838 extern void fdbuf_free(struct fdbuf *); 839 extern mblk_t *fdbuf_allocmsg(int, struct fdbuf *); 840 extern int fdbuf_create(void *, int, struct fdbuf **); 841 extern void so_closefds(void *, t_uscalar_t, int, int); 842 extern int so_getfdopt(void *, t_uscalar_t, int, void **, int *); 843 t_uscalar_t so_optlen(void *, t_uscalar_t, int); 844 extern void so_cmsg2opt(void *, t_uscalar_t, int, mblk_t *); 845 extern t_uscalar_t 846 so_cmsglen(mblk_t *, void *, t_uscalar_t, int); 847 extern int so_opt2cmsg(mblk_t *, void *, t_uscalar_t, int, 848 void *, t_uscalar_t); 849 extern void soisconnecting(struct sonode *); 850 extern void soisconnected(struct sonode *); 851 extern void soisdisconnected(struct sonode *, int); 852 extern void socantsendmore(struct sonode *); 853 extern void socantrcvmore(struct sonode *); 854 extern void soseterror(struct sonode *, int); 855 extern int sogeterr(struct sonode *, boolean_t); 856 extern int sowaitconnected(struct sonode *, int, int); 857 858 extern ssize_t soreadfile(file_t *, uchar_t *, u_offset_t, int *, size_t); 859 extern void *sock_kstat_init(zoneid_t); 860 extern void sock_kstat_fini(zoneid_t, void *); 861 extern struct sonode *getsonode(int, int *, file_t **); 862 /* 863 * Function wrappers (mostly around the sonode switch) for 864 * backward compatibility. 865 */ 866 extern int soaccept(struct sonode *, int, struct sonode **); 867 extern int sobind(struct sonode *, struct sockaddr *, socklen_t, 868 int, int); 869 extern int solisten(struct sonode *, int); 870 extern int soconnect(struct sonode *, const struct sockaddr *, socklen_t, 871 int, int); 872 extern int sorecvmsg(struct sonode *, struct nmsghdr *, struct uio *); 873 extern int sosendmsg(struct sonode *, struct nmsghdr *, struct uio *); 874 extern int soshutdown(struct sonode *, int); 875 extern int sogetsockopt(struct sonode *, int, int, void *, socklen_t *, 876 int); 877 extern int sosetsockopt(struct sonode *, int, int, const void *, 878 t_uscalar_t); 879 880 extern struct sonode *socreate(struct sockparams *, int, int, int, int, 881 int *); 882 883 extern int so_copyin(const void *, void *, size_t, int); 884 extern int so_copyout(const void *, void *, size_t, int); 885 886 #endif 887 888 /* 889 * Internal structure for obtaining sonode information from the socklist. 890 * These types match those corresponding in the sonode structure. 891 * This is not a published interface, and may change at any time. 892 */ 893 struct sockinfo { 894 uint_t si_size; /* real length of this struct */ 895 short si_family; 896 short si_type; 897 ushort_t si_flag; 898 uint_t si_state; 899 uint_t si_ux_laddr_sou_magic; 900 uint_t si_ux_faddr_sou_magic; 901 t_scalar_t si_serv_type; 902 t_uscalar_t si_laddr_soa_len; 903 t_uscalar_t si_faddr_soa_len; 904 uint16_t si_laddr_family; 905 uint16_t si_faddr_family; 906 char si_laddr_sun_path[MAXPATHLEN + 1]; /* NULL terminated */ 907 char si_faddr_sun_path[MAXPATHLEN + 1]; 908 boolean_t si_faddr_noxlate; 909 zoneid_t si_szoneid; 910 }; 911 912 #define SOCKMOD_PATH "socketmod" /* dir where sockmods are stored */ 913 914 #ifdef __cplusplus 915 } 916 #endif 917 918 #endif /* _SYS_SOCKETVAR_H */ 919