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 #ifndef _SOCKCOMMON_H_ 28 #define _SOCKCOMMON_H_ 29 30 #pragma ident "@(#)sockcommon.h 1.1 07/06/14 SMI" 31 32 #ifdef __cplusplus 33 extern "C" { 34 #endif 35 36 #include <sys/filio.h> 37 #include <sys/socket_proto.h> 38 39 struct sonode; 40 41 extern kmem_cache_t *socket_cache; 42 43 /* 44 * Socket access functions 45 * 46 * The following functions should only be used by sockfs, and are common 47 * functions that can be used both by kernel sockets (i.e., no file 48 * descriptors should ever be expected, or created), and to implement 49 * the socket system calls. 50 */ 51 extern struct sonode *socket_create(int, int, int, char *, char *, int, int, 52 struct cred *, int *); 53 extern struct sonode *socket_newconn(struct sonode *, sock_lower_handle_t, 54 sock_downcalls_t *, int, int *); 55 extern int socket_bind(struct sonode *, struct sockaddr *, socklen_t, int, 56 struct cred *); 57 extern int socket_accept(struct sonode *, int, struct cred *, struct sonode **); 58 extern int socket_listen(struct sonode *, int, struct cred *); 59 extern int socket_connect(struct sonode *, const struct sockaddr *, 60 socklen_t, int, int, struct cred *); 61 extern int socket_getpeername(struct sonode *, struct sockaddr *, socklen_t *, 62 boolean_t, struct cred *); 63 extern int socket_getsockname(struct sonode *, struct sockaddr *, socklen_t *, 64 struct cred *); 65 extern int socket_shutdown(struct sonode *, int, struct cred *); 66 extern int socket_getsockopt(struct sonode *, int, int, void *, socklen_t *, 67 int, struct cred *); 68 extern int socket_setsockopt(struct sonode *, int, int, const void *, 69 socklen_t, struct cred *); 70 extern int socket_recvmsg(struct sonode *, struct nmsghdr *, struct uio *, 71 struct cred *); 72 extern int socket_sendmsg(struct sonode *, struct nmsghdr *, struct uio *, 73 struct cred *); 74 extern int socket_sendmblk(struct sonode *, struct nmsghdr *, int, 75 struct cred *, mblk_t **); 76 extern int socket_ioctl(struct sonode *, int, intptr_t, int, struct cred *, 77 int32_t *); 78 extern int socket_poll(struct sonode *, short, int, short *, 79 struct pollhead **); 80 extern int socket_close(struct sonode *, int, struct cred *); 81 extern void socket_destroy(struct sonode *); 82 83 /* 84 * Cancel the socket push timer. 85 */ 86 #define SOCKET_TIMER_CANCEL(so) { \ 87 timeout_id_t tid; \ 88 \ 89 ASSERT(MUTEX_HELD(&(so)->so_lock)); \ 90 if ((so)->so_rcv_timer_tid != 0) { \ 91 tid = (so)->so_rcv_timer_tid; \ 92 (so)->so_rcv_timer_tid = 0; \ 93 mutex_exit(&(so)->so_lock); \ 94 \ 95 (void) untimeout(tid); \ 96 \ 97 mutex_enter(&(so)->so_lock); \ 98 } \ 99 } 100 101 #define SOCKET_TIMER_START(so) { \ 102 ASSERT(MUTEX_HELD(&(so)->so_lock)); \ 103 if ((so)->so_rcv_timer_interval != SOCKET_NO_RCVTIMER) { \ 104 (so)->so_rcv_timer_tid = timeout(so_timer_callback, \ 105 (so), MSEC_TO_TICK((so)->so_rcv_timer_interval)); \ 106 } \ 107 } 108 109 /* Common sonode ops not support */ 110 extern int so_listen_notsupp(struct sonode *, int, struct cred *); 111 extern int so_accept_notsupp(struct sonode *, int, struct cred *, 112 struct sonode **); 113 extern int so_getpeername_notsupp(struct sonode *, struct sockaddr *, 114 socklen_t *, boolean_t, struct cred *); 115 extern int so_shutdown_notsupp(struct sonode *, int, struct cred *); 116 extern int so_sendmblk_notsupp(struct sonode *, struct nmsghdr *, 117 int, struct cred *, mblk_t **); 118 119 /* Common sonode ops */ 120 extern int so_init(struct sonode *, struct sonode *, struct cred *, int); 121 extern int so_accept(struct sonode *, int, struct cred *, struct sonode **); 122 extern int so_bind(struct sonode *, struct sockaddr *, socklen_t, int, 123 struct cred *); 124 extern int so_listen(struct sonode *, int, struct cred *); 125 extern int so_connect(struct sonode *, const struct sockaddr *, 126 socklen_t, int, int, struct cred *); 127 extern int so_getsockopt(struct sonode *, int, int, void *, 128 socklen_t *, int, struct cred *); 129 extern int so_setsockopt(struct sonode *, int, int, const void *, 130 socklen_t, struct cred *); 131 extern int so_getpeername(struct sonode *, struct sockaddr *, 132 socklen_t *, boolean_t, struct cred *); 133 extern int so_getsockname(struct sonode *, struct sockaddr *, 134 socklen_t *, struct cred *); 135 extern int so_ioctl(struct sonode *, int, intptr_t, int, struct cred *, 136 int32_t *); 137 extern int so_poll(struct sonode *, short, int, short *, 138 struct pollhead **); 139 extern int so_sendmsg(struct sonode *, struct nmsghdr *, struct uio *, 140 struct cred *); 141 extern int so_sendmblk(struct sonode *, struct nmsghdr *, int, 142 struct cred *, mblk_t **); 143 extern int so_recvmsg(struct sonode *, struct nmsghdr *, struct uio *, 144 struct cred *); 145 extern int so_shutdown(struct sonode *, int, struct cred *); 146 extern int so_close(struct sonode *, int, struct cred *); 147 148 extern int so_tpi_fallback(struct sonode *, struct cred *); 149 150 /* Common upcalls */ 151 extern sock_upper_handle_t so_newconn(sock_upper_handle_t, 152 sock_lower_handle_t, sock_downcalls_t *, struct cred *, pid_t, 153 sock_upcalls_t **); 154 extern void so_set_prop(sock_upper_handle_t, 155 struct sock_proto_props *); 156 extern ssize_t so_queue_msg(sock_upper_handle_t, mblk_t *, size_t, int, 157 int *, boolean_t *); 158 extern void so_signal_oob(sock_upper_handle_t, ssize_t); 159 160 extern void so_connected(sock_upper_handle_t, sock_connid_t, struct cred *, 161 pid_t); 162 extern int so_disconnected(sock_upper_handle_t, sock_connid_t, int); 163 extern void so_txq_full(sock_upper_handle_t, boolean_t); 164 extern void so_opctl(sock_upper_handle_t, sock_opctl_action_t, uintptr_t); 165 /* Common misc. functions */ 166 167 /* accept queue */ 168 extern int so_acceptq_enqueue(struct sonode *, struct sonode *); 169 extern int so_acceptq_enqueue_locked(struct sonode *, struct sonode *); 170 extern int so_acceptq_dequeue(struct sonode *, boolean_t, 171 struct sonode **); 172 extern void so_acceptq_flush(struct sonode *); 173 174 /* connect */ 175 extern int so_wait_connected(struct sonode *, boolean_t, sock_connid_t); 176 177 /* send */ 178 extern int so_snd_wait_qnotfull(struct sonode *, boolean_t); 179 extern void so_snd_qfull(struct sonode *so); 180 extern void so_snd_qnotfull(struct sonode *so); 181 182 extern int socket_chgpgrp(struct sonode *, pid_t); 183 extern void socket_sendsig(struct sonode *, int); 184 extern int so_dequeue_msg(struct sonode *, mblk_t **, struct uio *, 185 rval_t *, int); 186 extern void so_enqueue_msg(struct sonode *, mblk_t *, size_t); 187 188 extern mblk_t *socopyinuio(uio_t *, ssize_t, size_t, ssize_t, size_t, int *); 189 extern mblk_t *socopyoutuio(mblk_t *, struct uio *, ssize_t, int *); 190 191 extern boolean_t somsghasdata(mblk_t *); 192 extern void so_rcv_flush(struct sonode *); 193 extern int sorecvoob(struct sonode *, struct nmsghdr *, struct uio *, 194 int, boolean_t); 195 196 extern void so_timer_callback(void *); 197 198 extern struct sonode *socket_sonode_create(struct sockparams *, int, int, int, 199 int, int, int *, struct cred *); 200 201 extern void socket_sonode_destroy(struct sonode *); 202 extern int socket_init_common(struct sonode *, struct sonode *, int flags, 203 struct cred *); 204 extern int socket_getopt_common(struct sonode *, int, int, void *, socklen_t *); 205 extern int socket_ioctl_common(struct sonode *, int, intptr_t, int, 206 struct cred *, int32_t *); 207 extern int socket_strioc_common(struct sonode *, int, intptr_t, int, 208 struct cred *, int32_t *); 209 210 extern int so_zcopy_wait(struct sonode *); 211 extern int so_get_mod_version(struct sockparams *); 212 213 /* Notification functions */ 214 extern void so_notify_connected(struct sonode *); 215 extern void so_notify_disconnecting(struct sonode *); 216 extern void so_notify_disconnected(struct sonode *, int); 217 extern void so_notify_writable(struct sonode *); 218 extern void so_notify_data(struct sonode *, size_t); 219 extern void so_notify_oobsig(struct sonode *); 220 extern void so_notify_oobdata(struct sonode *, boolean_t); 221 extern void so_notify_eof(struct sonode *); 222 extern void so_notify_newconn(struct sonode *); 223 extern void so_notify_shutdown(struct sonode *); 224 extern void so_notify_error(struct sonode *); 225 226 /* Common sonode functions */ 227 extern int sonode_constructor(void *, void *, int); 228 extern void sonode_destructor(void *, void *); 229 extern void sonode_init(struct sonode *, struct sockparams *, 230 int, int, int, sonodeops_t *); 231 extern void sonode_fini(struct sonode *); 232 233 /* 234 * Event flags to socket_sendsig(). 235 */ 236 #define SOCKETSIG_WRITE 0x1 237 #define SOCKETSIG_READ 0x2 238 #define SOCKETSIG_URG 0x4 239 240 extern sonodeops_t so_sonodeops; 241 extern sock_upcalls_t so_upcalls; 242 243 #ifdef __cplusplus 244 } 245 #endif 246 #endif /* _SOCKCOMMON_H_ */ 247