2 * Server-side socket management
4 * Copyright (C) 1999 Marcus Meissner, Ove Kåven
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * FIXME: we use read|write access in all cases. Shouldn't we depend that
21 * on the access of the current handle?
32 #ifdef HAVE_SYS_ERRNO_H
33 # include <sys/errno.h>
36 #include <sys/types.h>
37 #ifdef HAVE_SYS_SOCKET_H
38 # include <sys/socket.h>
40 #include <sys/ioctl.h>
41 #ifdef HAVE_SYS_FILIO_H
42 # include <sys/filio.h>
55 /* To avoid conflicts with the Unix socket headers. Plus we only need a few
63 struct object obj; /* object header */
64 unsigned int state; /* status bits */
65 unsigned int mask; /* event mask */
66 unsigned int hmask; /* held (blocked) events */
67 unsigned int pmask; /* pending events */
68 unsigned int flags; /* socket flags */
69 struct event *event; /* event object */
70 int errors[FD_MAX_EVENTS]; /* event errors */
71 struct async_queue read_q; /* Queue for asynchronous reads */
72 struct async_queue write_q; /* Queue for asynchronous writes */
75 static void sock_dump( struct object *obj, int verbose );
76 static int sock_signaled( struct object *obj, struct thread *thread );
77 static int sock_get_poll_events( struct object *obj );
78 static void sock_poll_event( struct object *obj, int event );
79 static int sock_get_fd( struct object *obj );
80 static int sock_get_info( struct object *obj, struct get_file_info_reply *reply, int *flags );
81 static void sock_destroy( struct object *obj );
82 static int sock_get_error( int err );
83 static void sock_set_error(void);
85 static const struct object_ops sock_ops =
87 sizeof(struct sock), /* size */
89 add_queue, /* add_queue */
90 remove_queue, /* remove_queue */
91 sock_signaled, /* signaled */
92 no_satisfied, /* satisfied */
93 sock_get_poll_events, /* get_poll_events */
94 sock_poll_event, /* poll_event */
95 sock_get_fd, /* get_fd */
97 sock_get_info, /* get_file_info */
98 NULL, /* queue_async */
99 sock_destroy /* destroy */
102 static void sock_reselect( struct sock *sock )
104 int ev = sock_get_poll_events( &sock->obj );
108 fprintf(stderr,"sock_reselect(%d): new mask %x\n", sock->obj.fd, ev);
110 if (sock->obj.select == -1) {
111 /* previously unconnected socket, is this reselect supposed to connect it? */
112 if (!(sock->state & ~FD_WINE_NONBLOCKING)) return;
113 /* ok, it is, attach it to the wineserver's main poll loop */
114 add_select_user( &sock->obj );
116 /* update condition mask */
117 set_select_events( &sock->obj, ev );
119 /* check whether condition is satisfied already */
120 pfd.fd = sock->obj.fd;
125 sock_poll_event( &sock->obj, pfd.revents);
128 inline static int sock_error(int s)
130 unsigned int optval = 0, optlen;
132 optlen = sizeof(optval);
133 getsockopt(s, SOL_SOCKET, SO_ERROR, (void *) &optval, &optlen);
134 return optval ? sock_get_error(optval) : 0;
137 static void sock_poll_event( struct object *obj, int event )
139 struct sock *sock = (struct sock *)obj;
141 assert( sock->obj.ops == &sock_ops );
143 fprintf(stderr, "socket %d select event: %x\n", sock->obj.fd, event);
144 if (sock->state & FD_CONNECT)
149 /* we got connected */
150 sock->state |= FD_WINE_CONNECTED|FD_READ|FD_WRITE;
151 sock->state &= ~FD_CONNECT;
152 sock->pmask |= FD_CONNECT;
153 sock->errors[FD_CONNECT_BIT] = 0;
155 fprintf(stderr, "socket %d connection success\n", sock->obj.fd);
157 else if (event & (POLLERR|POLLHUP))
159 /* we didn't get connected? */
160 sock->state &= ~FD_CONNECT;
161 sock->pmask |= FD_CONNECT;
162 sock->errors[FD_CONNECT_BIT] = sock_error( sock->obj.fd );
164 fprintf(stderr, "socket %d connection failure\n", sock->obj.fd);
167 if (sock->state & FD_WINE_LISTENING)
172 /* incoming connection */
173 sock->pmask |= FD_ACCEPT;
174 sock->errors[FD_ACCEPT_BIT] = 0;
175 sock->hmask |= FD_ACCEPT;
177 else if (event & (POLLERR|POLLHUP))
179 /* failed incoming connection? */
180 sock->pmask |= FD_ACCEPT;
181 sock->errors[FD_ACCEPT_BIT] = sock_error( sock->obj.fd );
182 sock->hmask |= FD_ACCEPT;
186 /* normal data flow */
191 /* Linux 2.4 doesn't report POLLHUP if only one side of the socket
192 * has been closed, so we need to check for it explicitly here */
193 if (!recv( sock->obj.fd, &dummy, 1, MSG_PEEK )) event = POLLHUP;
197 sock->pmask |= FD_READ;
198 sock->hmask |= FD_READ;
199 sock->errors[FD_READ_BIT] = 0;
201 fprintf(stderr, "socket %d is readable\n", sock->obj.fd );
206 sock->pmask |= FD_WRITE;
207 sock->hmask |= FD_WRITE;
208 sock->errors[FD_WRITE_BIT] = 0;
210 fprintf(stderr, "socket %d is writable\n", sock->obj.fd);
214 sock->pmask |= FD_OOB;
215 sock->hmask |= FD_OOB;
216 sock->errors[FD_OOB_BIT] = 0;
218 fprintf(stderr, "socket %d got OOB data\n", sock->obj.fd);
220 if (((event & POLLERR) || ((event & (POLLIN|POLLHUP)) == POLLHUP))
221 && (sock->state & (FD_READ|FD_WRITE))) {
223 sock->errors[FD_CLOSE_BIT] = sock_error( sock->obj.fd );
224 sock->state &= ~(FD_WINE_CONNECTED|FD_READ|FD_WRITE);
225 sock->pmask |= FD_CLOSE;
227 fprintf(stderr, "socket %d aborted by error %d\n",
228 sock->obj.fd, sock->errors[FD_CLOSE_BIT]);
232 if (event & (POLLERR|POLLHUP))
233 set_select_events( &sock->obj, -1 );
235 sock_reselect( sock );
236 /* wake up anyone waiting for whatever just happened */
237 emask = sock->pmask & sock->mask;
238 if (debug_level && emask)
239 fprintf(stderr, "socket %d pending events: %x\n", sock->obj.fd, emask);
240 if (emask && sock->event) {
241 if (debug_level) fprintf(stderr, "signalling event ptr %p\n", sock->event);
242 set_event(sock->event);
245 /* if anyone is stupid enough to wait on the socket object itself,
246 * maybe we should wake them up too, just in case? */
247 wake_up( &sock->obj, 0 );
250 static void sock_dump( struct object *obj, int verbose )
252 struct sock *sock = (struct sock *)obj;
253 assert( obj->ops == &sock_ops );
254 printf( "Socket fd=%d, state=%x, mask=%x, pending=%x, held=%x\n",
255 sock->obj.fd, sock->state,
256 sock->mask, sock->pmask, sock->hmask );
259 static int sock_signaled( struct object *obj, struct thread *thread )
261 struct sock *sock = (struct sock *)obj;
262 assert( obj->ops == &sock_ops );
264 return check_select_events( sock->obj.fd, sock_get_poll_events( &sock->obj ) );
267 static int sock_get_poll_events( struct object *obj )
269 struct sock *sock = (struct sock *)obj;
270 unsigned int mask = sock->mask & sock->state & ~sock->hmask;
273 assert( obj->ops == &sock_ops );
275 if (sock->state & FD_CONNECT)
276 /* connecting, wait for writable */
278 if (sock->state & FD_WINE_LISTENING)
279 /* listening, wait for readable */
280 return (sock->hmask & FD_ACCEPT) ? 0 : POLLIN;
282 if (mask & FD_READ) ev |= POLLIN | POLLPRI;
283 if (mask & FD_WRITE) ev |= POLLOUT;
287 static int sock_get_fd( struct object *obj )
289 struct sock *sock = (struct sock *)obj;
290 assert( obj->ops == &sock_ops );
294 static int sock_get_info( struct object *obj, struct get_file_info_reply *reply, int *flags )
296 struct sock *sock = (struct sock*) obj;
297 assert ( obj->ops == &sock_ops );
301 reply->type = FILE_TYPE_PIPE;
303 reply->access_time = 0;
304 reply->write_time = 0;
305 reply->size_high = 0;
308 reply->index_high = 0;
309 reply->index_low = 0;
313 if (sock->flags & WSA_FLAG_OVERLAPPED) *flags |= FD_FLAG_OVERLAPPED;
314 return FD_TYPE_DEFAULT;
317 static void sock_destroy( struct object *obj )
319 struct sock *sock = (struct sock *)obj;
320 assert( obj->ops == &sock_ops );
322 /* FIXME: special socket shutdown stuff? */
324 if ( sock->flags & WSA_FLAG_OVERLAPPED )
326 destroy_async_queue ( &sock->read_q );
327 destroy_async_queue ( &sock->write_q );
332 /* if the service thread was waiting for the event object,
333 * we should now signal it, to let the service thread
334 * object detect that it is now orphaned... */
335 if (sock->mask & FD_WINE_SERVEVENT)
336 set_event( sock->event );
337 /* we're through with it */
338 release_object( sock->event );
342 /* create a new and unconnected socket */
343 static struct object *create_socket( int family, int type, int protocol, unsigned int flags )
348 sockfd = socket( family, type, protocol );
350 fprintf(stderr,"socket(%d,%d,%d)=%d\n",family,type,protocol,sockfd);
355 fcntl(sockfd, F_SETFL, O_NONBLOCK); /* make socket nonblocking */
356 if (!(sock = alloc_object( &sock_ops, -1 ))) return NULL;
357 sock->obj.fd = sockfd;
358 sock->state = (type != SOCK_STREAM) ? (FD_READ|FD_WRITE) : 0;
364 sock_reselect( sock );
366 if (sock->flags & WSA_FLAG_OVERLAPPED)
368 init_async_queue (&sock->read_q);
369 init_async_queue (&sock->write_q);
374 /* accept a socket (creates a new fd) */
375 static struct object *accept_socket( handle_t handle )
377 struct sock *acceptsock;
380 struct sockaddr saddr;
383 sock=(struct sock*)get_handle_obj(current->process,handle,
384 GENERIC_READ|GENERIC_WRITE|SYNCHRONIZE,&sock_ops);
387 /* Try to accept(2). We can't be safe that this an already connected socket
388 * or that accept() is allowed on it. In those cases we will get -1/errno
391 slen = sizeof(saddr);
392 acceptfd = accept(sock->obj.fd,&saddr,&slen);
395 release_object( sock );
398 if (!(acceptsock = alloc_object( &sock_ops, -1 )))
400 release_object( sock );
404 /* newly created socket gets the same properties of the listening socket */
405 fcntl(acceptfd, F_SETFL, O_NONBLOCK); /* make socket nonblocking */
406 acceptsock->obj.fd = acceptfd;
407 acceptsock->state = FD_WINE_CONNECTED|FD_READ|FD_WRITE;
408 if (sock->state & FD_WINE_NONBLOCKING)
409 acceptsock->state |= FD_WINE_NONBLOCKING;
410 acceptsock->mask = sock->mask;
411 acceptsock->hmask = 0;
412 acceptsock->pmask = 0;
413 acceptsock->event = NULL;
414 if (sock->event && !(sock->mask & FD_WINE_SERVEVENT))
415 acceptsock->event = (struct event *)grab_object( sock->event );
416 acceptsock->flags = sock->flags;
417 if ( acceptsock->flags & WSA_FLAG_OVERLAPPED )
419 init_async_queue ( &acceptsock->read_q );
420 init_async_queue ( &acceptsock->write_q );
423 sock_reselect( acceptsock );
425 sock->pmask &= ~FD_ACCEPT;
426 sock->hmask &= ~FD_ACCEPT;
427 sock_reselect( sock );
428 release_object( sock );
429 return &acceptsock->obj;
432 /* set the last error depending on errno */
433 static int sock_get_error( int err )
437 case EINTR: return WSAEINTR; break;
438 case EBADF: return WSAEBADF; break;
440 case EACCES: return WSAEACCES; break;
441 case EFAULT: return WSAEFAULT; break;
442 case EINVAL: return WSAEINVAL; break;
443 case EMFILE: return WSAEMFILE; break;
444 case EWOULDBLOCK: return WSAEWOULDBLOCK; break;
445 case EINPROGRESS: return WSAEINPROGRESS; break;
446 case EALREADY: return WSAEALREADY; break;
447 case ENOTSOCK: return WSAENOTSOCK; break;
448 case EDESTADDRREQ: return WSAEDESTADDRREQ; break;
449 case EMSGSIZE: return WSAEMSGSIZE; break;
450 case EPROTOTYPE: return WSAEPROTOTYPE; break;
451 case ENOPROTOOPT: return WSAENOPROTOOPT; break;
452 case EPROTONOSUPPORT: return WSAEPROTONOSUPPORT; break;
453 case ESOCKTNOSUPPORT: return WSAESOCKTNOSUPPORT; break;
454 case EOPNOTSUPP: return WSAEOPNOTSUPP; break;
455 case EPFNOSUPPORT: return WSAEPFNOSUPPORT; break;
456 case EAFNOSUPPORT: return WSAEAFNOSUPPORT; break;
457 case EADDRINUSE: return WSAEADDRINUSE; break;
458 case EADDRNOTAVAIL: return WSAEADDRNOTAVAIL; break;
459 case ENETDOWN: return WSAENETDOWN; break;
460 case ENETUNREACH: return WSAENETUNREACH; break;
461 case ENETRESET: return WSAENETRESET; break;
462 case ECONNABORTED: return WSAECONNABORTED; break;
464 case ECONNRESET: return WSAECONNRESET; break;
465 case ENOBUFS: return WSAENOBUFS; break;
466 case EISCONN: return WSAEISCONN; break;
467 case ENOTCONN: return WSAENOTCONN; break;
468 case ESHUTDOWN: return WSAESHUTDOWN; break;
469 case ETOOMANYREFS: return WSAETOOMANYREFS; break;
470 case ETIMEDOUT: return WSAETIMEDOUT; break;
471 case ECONNREFUSED: return WSAECONNREFUSED; break;
472 case ELOOP: return WSAELOOP; break;
473 case ENAMETOOLONG: return WSAENAMETOOLONG; break;
474 case EHOSTDOWN: return WSAEHOSTDOWN; break;
475 case EHOSTUNREACH: return WSAEHOSTUNREACH; break;
476 case ENOTEMPTY: return WSAENOTEMPTY; break;
478 case EPROCLIM: return WSAEPROCLIM; break;
481 case EUSERS: return WSAEUSERS; break;
484 case EDQUOT: return WSAEDQUOT; break;
487 case ESTALE: return WSAESTALE; break;
490 case EREMOTE: return WSAEREMOTE; break;
492 default: errno=err; perror("sock_set_error"); return ERROR_UNKNOWN; break;
496 /* set the last error depending on errno */
497 static void sock_set_error(void)
499 set_error( sock_get_error( errno ) );
502 /* create a socket */
503 DECL_HANDLER(create_socket)
508 if ((obj = create_socket( req->family, req->type, req->protocol, req->flags )) != NULL)
510 reply->handle = alloc_handle( current->process, obj, req->access, req->inherit );
511 release_object( obj );
515 /* accept a socket */
516 DECL_HANDLER(accept_socket)
521 if ((obj = accept_socket( req->lhandle )) != NULL)
523 reply->handle = alloc_handle( current->process, obj, req->access, req->inherit );
524 release_object( obj );
528 /* set socket event parameters */
529 DECL_HANDLER(set_socket_event)
532 struct event *oevent;
535 sock=(struct sock*)get_handle_obj(current->process,req->handle,GENERIC_READ|GENERIC_WRITE|SYNCHRONIZE,&sock_ops);
538 oevent = sock->event;
540 sock->mask = req->mask;
541 sock->event = get_event_obj( current->process, req->event, EVENT_MODIFY_STATE );
542 if (debug_level && sock->event) fprintf(stderr, "event ptr: %p\n", sock->event);
543 sock_reselect( sock );
545 sock->state |= FD_WINE_NONBLOCKING;
547 /* if a network event is pending, signal the event object
548 it is possible that FD_CONNECT or FD_ACCEPT network events has happened
549 before a WSAEventSelect() was done on it.
550 (when dealing with Asynchronous socket) */
551 if (sock->pmask & sock->mask)
552 set_event(sock->event);
556 if ((oevent != sock->event) && (omask & FD_WINE_SERVEVENT))
557 /* if the service thread was waiting for the old event object,
558 * we should now signal it, to let the service thread
559 * object detect that it is now orphaned... */
561 /* we're through with it */
562 release_object( oevent );
564 release_object( &sock->obj );
567 /* get socket event parameters */
568 DECL_HANDLER(get_socket_event)
572 sock=(struct sock*)get_handle_obj(current->process,req->handle,GENERIC_READ|GENERIC_WRITE|SYNCHRONIZE,&sock_ops);
578 set_error( WSAENOTSOCK );
581 reply->mask = sock->mask;
582 reply->pmask = sock->pmask;
583 reply->state = sock->state;
584 set_reply_data( sock->errors, min( get_reply_max_size(), sizeof(sock->errors) ));
588 handle_t s_event = req->s_event;
591 struct event *sevent = get_event_obj(current->process, req->s_event, 0);
592 if (sevent == sock->event) s_event = 0;
593 release_object( sevent );
599 struct event *cevent = get_event_obj(current->process, req->c_event, EVENT_MODIFY_STATE);
600 reset_event( cevent );
601 release_object( cevent );
604 sock_reselect( sock );
606 else set_error(WSAEINVAL);
608 release_object( &sock->obj );
611 /* re-enable pending socket events */
612 DECL_HANDLER(enable_socket_event)
616 sock=(struct sock*)get_handle_obj(current->process,req->handle,GENERIC_READ|GENERIC_WRITE|SYNCHRONIZE,&sock_ops);
619 sock->pmask &= ~req->mask; /* is this safe? */
620 sock->hmask &= ~req->mask;
621 sock->state |= req->sstate;
622 sock->state &= ~req->cstate;
623 sock_reselect( sock );
625 /* service trigger */
626 if (req->mask & FD_WINE_SERVEVENT)
628 sock->pmask |= FD_WINE_SERVEVENT;
630 if (debug_level) fprintf(stderr, "signalling service event ptr %p\n", sock->event);
631 set_event(sock->event);
635 release_object( &sock->obj );