include: New ddk/hidtypes.h include file.
[wine.git] / server / sock.c
blob67d6416e5993f906754f7aa002d1922ace2cb799
1 /*
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * FIXME: we use read|write access in all cases. Shouldn't we depend that
21 * on the access of the current handle?
24 #include "config.h"
26 #include <assert.h>
27 #include <fcntl.h>
28 #include <stdarg.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <stdlib.h>
32 #include <errno.h>
33 #ifdef HAVE_POLL_H
34 # include <poll.h>
35 #endif
36 #include <sys/time.h>
37 #include <sys/types.h>
38 #ifdef HAVE_SYS_SOCKET_H
39 # include <sys/socket.h>
40 #endif
41 #ifdef HAVE_SYS_IOCTL_H
42 #include <sys/ioctl.h>
43 #endif
44 #ifdef HAVE_SYS_FILIO_H
45 # include <sys/filio.h>
46 #endif
47 #include <time.h>
48 #include <unistd.h>
49 #include <limits.h>
50 #ifdef HAVE_LINUX_RTNETLINK_H
51 # include <linux/rtnetlink.h>
52 #endif
54 #include "ntstatus.h"
55 #define WIN32_NO_STATUS
56 #include "windef.h"
57 #include "winternl.h"
58 #include "winerror.h"
59 #define USE_WS_PREFIX
60 #include "winsock2.h"
62 #include "process.h"
63 #include "file.h"
64 #include "handle.h"
65 #include "thread.h"
66 #include "request.h"
67 #include "user.h"
69 /* From winsock.h */
70 #define FD_MAX_EVENTS 10
71 #define FD_READ_BIT 0
72 #define FD_WRITE_BIT 1
73 #define FD_OOB_BIT 2
74 #define FD_ACCEPT_BIT 3
75 #define FD_CONNECT_BIT 4
76 #define FD_CLOSE_BIT 5
79 * Define flags to be used with the WSAAsyncSelect() call.
81 #define FD_READ 0x00000001
82 #define FD_WRITE 0x00000002
83 #define FD_OOB 0x00000004
84 #define FD_ACCEPT 0x00000008
85 #define FD_CONNECT 0x00000010
86 #define FD_CLOSE 0x00000020
88 /* internal per-socket flags */
89 #define FD_WINE_LISTENING 0x10000000
90 #define FD_WINE_NONBLOCKING 0x20000000
91 #define FD_WINE_CONNECTED 0x40000000
92 #define FD_WINE_RAW 0x80000000
93 #define FD_WINE_INTERNAL 0xFFFF0000
95 struct sock
97 struct object obj; /* object header */
98 struct fd *fd; /* socket file descriptor */
99 unsigned int state; /* status bits */
100 unsigned int mask; /* event mask */
101 unsigned int hmask; /* held (blocked) events */
102 unsigned int pmask; /* pending events */
103 unsigned int flags; /* socket flags */
104 int polling; /* is socket being polled? */
105 unsigned short proto; /* socket protocol */
106 unsigned short type; /* socket type */
107 unsigned short family; /* socket family */
108 struct event *event; /* event object */
109 user_handle_t window; /* window to send the message to */
110 unsigned int message; /* message to send */
111 obj_handle_t wparam; /* message wparam (socket handle) */
112 int errors[FD_MAX_EVENTS]; /* event errors */
113 timeout_t connect_time;/* time the socket was connected */
114 struct sock *deferred; /* socket that waits for a deferred accept */
115 struct async_queue *read_q; /* queue for asynchronous reads */
116 struct async_queue *write_q; /* queue for asynchronous writes */
117 struct async_queue *ifchange_q; /* queue for interface change notifications */
118 struct object *ifchange_obj; /* the interface change notification object */
119 struct list ifchange_entry; /* entry in ifchange notification list */
122 static void sock_dump( struct object *obj, int verbose );
123 static int sock_signaled( struct object *obj, struct wait_queue_entry *entry );
124 static struct fd *sock_get_fd( struct object *obj );
125 static void sock_destroy( struct object *obj );
126 static struct async_queue *sock_get_ifchange_q( struct sock *sock );
127 static void sock_destroy_ifchange_q( struct sock *sock );
129 static int sock_get_poll_events( struct fd *fd );
130 static void sock_poll_event( struct fd *fd, int event );
131 static enum server_fd_type sock_get_fd_type( struct fd *fd );
132 static obj_handle_t sock_ioctl( struct fd *fd, ioctl_code_t code, const async_data_t *async, int blocking );
133 static void sock_queue_async( struct fd *fd, const async_data_t *data, int type, int count );
134 static void sock_reselect_async( struct fd *fd, struct async_queue *queue );
135 static int sock_cancel_async( struct fd *fd, struct process *process, struct thread *thread, client_ptr_t iosb );
137 static int sock_get_ntstatus( int err );
138 static int sock_get_error( int err );
139 static void sock_set_error(void);
141 static const struct object_ops sock_ops =
143 sizeof(struct sock), /* size */
144 sock_dump, /* dump */
145 no_get_type, /* get_type */
146 add_queue, /* add_queue */
147 remove_queue, /* remove_queue */
148 sock_signaled, /* signaled */
149 no_satisfied, /* satisfied */
150 no_signal, /* signal */
151 sock_get_fd, /* get_fd */
152 default_fd_map_access, /* map_access */
153 default_get_sd, /* get_sd */
154 default_set_sd, /* set_sd */
155 no_lookup_name, /* lookup_name */
156 no_open_file, /* open_file */
157 fd_close_handle, /* close_handle */
158 sock_destroy /* destroy */
161 static const struct fd_ops sock_fd_ops =
163 sock_get_poll_events, /* get_poll_events */
164 sock_poll_event, /* poll_event */
165 sock_get_fd_type, /* get_fd_type */
166 no_fd_read, /* read */
167 no_fd_write, /* write */
168 no_fd_flush, /* flush */
169 sock_ioctl, /* ioctl */
170 sock_queue_async, /* queue_async */
171 sock_reselect_async, /* reselect_async */
172 sock_cancel_async /* cancel_async */
176 /* Permutation of 0..FD_MAX_EVENTS - 1 representing the order in which
177 * we post messages if there are multiple events. Used to send
178 * messages. The problem is if there is both a FD_CONNECT event and,
179 * say, an FD_READ event available on the same socket, we want to
180 * notify the app of the connect event first. Otherwise it may
181 * discard the read event because it thinks it hasn't connected yet.
183 static const int event_bitorder[FD_MAX_EVENTS] =
185 FD_CONNECT_BIT,
186 FD_ACCEPT_BIT,
187 FD_OOB_BIT,
188 FD_WRITE_BIT,
189 FD_READ_BIT,
190 FD_CLOSE_BIT,
191 6, 7, 8, 9 /* leftovers */
194 /* Flags that make sense only for SOCK_STREAM sockets */
195 #define STREAM_FLAG_MASK ((unsigned int) (FD_CONNECT | FD_ACCEPT | FD_WINE_LISTENING | FD_WINE_CONNECTED))
197 typedef enum {
198 SOCK_SHUTDOWN_ERROR = -1,
199 SOCK_SHUTDOWN_EOF = 0,
200 SOCK_SHUTDOWN_POLLHUP = 1
201 } sock_shutdown_t;
203 static sock_shutdown_t sock_shutdown_type = SOCK_SHUTDOWN_ERROR;
205 static sock_shutdown_t sock_check_pollhup(void)
207 sock_shutdown_t ret = SOCK_SHUTDOWN_ERROR;
208 int fd[2], n;
209 struct pollfd pfd;
210 char dummy;
212 if ( socketpair( AF_UNIX, SOCK_STREAM, 0, fd ) ) return ret;
213 if ( shutdown( fd[0], 1 ) ) goto out;
215 pfd.fd = fd[1];
216 pfd.events = POLLIN;
217 pfd.revents = 0;
219 /* Solaris' poll() sometimes returns nothing if given a 0ms timeout here */
220 n = poll( &pfd, 1, 1 );
221 if ( n != 1 ) goto out; /* error or timeout */
222 if ( pfd.revents & POLLHUP )
223 ret = SOCK_SHUTDOWN_POLLHUP;
224 else if ( pfd.revents & POLLIN &&
225 read( fd[1], &dummy, 1 ) == 0 )
226 ret = SOCK_SHUTDOWN_EOF;
228 out:
229 close( fd[0] );
230 close( fd[1] );
231 return ret;
234 void sock_init(void)
236 sock_shutdown_type = sock_check_pollhup();
238 switch ( sock_shutdown_type )
240 case SOCK_SHUTDOWN_EOF:
241 if (debug_level) fprintf( stderr, "sock_init: shutdown() causes EOF\n" );
242 break;
243 case SOCK_SHUTDOWN_POLLHUP:
244 if (debug_level) fprintf( stderr, "sock_init: shutdown() causes POLLHUP\n" );
245 break;
246 default:
247 fprintf( stderr, "sock_init: ERROR in sock_check_pollhup()\n" );
248 sock_shutdown_type = SOCK_SHUTDOWN_EOF;
252 static int sock_reselect( struct sock *sock )
254 int ev = sock_get_poll_events( sock->fd );
256 if (debug_level)
257 fprintf(stderr,"sock_reselect(%p): new mask %x\n", sock, ev);
259 if (!sock->polling) /* FIXME: should find a better way to do this */
261 /* previously unconnected socket, is this reselect supposed to connect it? */
262 if (!(sock->state & ~FD_WINE_NONBLOCKING)) return 0;
263 /* ok, it is, attach it to the wineserver's main poll loop */
264 sock->polling = 1;
265 allow_fd_caching( sock->fd );
267 /* update condition mask */
268 set_fd_events( sock->fd, ev );
269 return ev;
272 /* wake anybody waiting on the socket event or send the associated message */
273 static void sock_wake_up( struct sock *sock )
275 unsigned int events = sock->pmask & sock->mask;
276 int i;
278 if ( !events ) return;
280 if (sock->event)
282 if (debug_level) fprintf(stderr, "signalling events %x ptr %p\n", events, sock->event );
283 set_event( sock->event );
285 if (sock->window)
287 if (debug_level) fprintf(stderr, "signalling events %x win %08x\n", events, sock->window );
288 for (i = 0; i < FD_MAX_EVENTS; i++)
290 int event = event_bitorder[i];
291 if (sock->pmask & (1 << event))
293 lparam_t lparam = (1 << event) | (sock_get_error(sock->errors[event]) << 16);
294 post_message( sock->window, sock->message, sock->wparam, lparam );
297 sock->pmask = 0;
298 sock_reselect( sock );
302 static inline int sock_error( struct fd *fd )
304 unsigned int optval = 0;
305 socklen_t optlen = sizeof(optval);
307 getsockopt( get_unix_fd(fd), SOL_SOCKET, SO_ERROR, (void *) &optval, &optlen);
308 return optval;
311 static int sock_dispatch_asyncs( struct sock *sock, int event, int error )
313 if ( sock->flags & WSA_FLAG_OVERLAPPED )
315 if ( event & (POLLIN|POLLPRI) && async_waiting( sock->read_q ) )
317 if (debug_level) fprintf( stderr, "activating read queue for socket %p\n", sock );
318 async_wake_up( sock->read_q, STATUS_ALERTED );
319 event &= ~(POLLIN|POLLPRI);
321 if ( event & POLLOUT && async_waiting( sock->write_q ) )
323 if (debug_level) fprintf( stderr, "activating write queue for socket %p\n", sock );
324 async_wake_up( sock->write_q, STATUS_ALERTED );
325 event &= ~POLLOUT;
327 if ( event & (POLLERR|POLLHUP) )
329 int status = sock_get_ntstatus( error );
331 if ( !(sock->state & FD_READ) )
332 async_wake_up( sock->read_q, status );
333 if ( !(sock->state & FD_WRITE) )
334 async_wake_up( sock->write_q, status );
337 return event;
340 static void sock_dispatch_events( struct sock *sock, int prevstate, int event, int error )
342 if (prevstate & FD_CONNECT)
344 sock->pmask |= FD_CONNECT;
345 sock->hmask |= FD_CONNECT;
346 sock->errors[FD_CONNECT_BIT] = error;
347 goto end;
349 if (prevstate & FD_WINE_LISTENING)
351 sock->pmask |= FD_ACCEPT;
352 sock->hmask |= FD_ACCEPT;
353 sock->errors[FD_ACCEPT_BIT] = error;
354 goto end;
357 if (event & POLLIN)
359 sock->pmask |= FD_READ;
360 sock->hmask |= FD_READ;
361 sock->errors[FD_READ_BIT] = 0;
364 if (event & POLLOUT)
366 sock->pmask |= FD_WRITE;
367 sock->hmask |= FD_WRITE;
368 sock->errors[FD_WRITE_BIT] = 0;
371 if (event & POLLPRI)
373 sock->pmask |= FD_OOB;
374 sock->hmask |= FD_OOB;
375 sock->errors[FD_OOB_BIT] = 0;
378 if (event & (POLLERR|POLLHUP))
380 sock->pmask |= FD_CLOSE;
381 sock->hmask |= FD_CLOSE;
382 sock->errors[FD_CLOSE_BIT] = error;
384 end:
385 sock_wake_up( sock );
388 static void sock_poll_event( struct fd *fd, int event )
390 struct sock *sock = get_fd_user( fd );
391 int hangup_seen = 0;
392 int prevstate = sock->state;
393 int error = 0;
395 assert( sock->obj.ops == &sock_ops );
396 if (debug_level)
397 fprintf(stderr, "socket %p select event: %x\n", sock, event);
399 /* we may change event later, remove from loop here */
400 if (event & (POLLERR|POLLHUP)) set_fd_events( sock->fd, -1 );
402 if (sock->state & FD_CONNECT)
404 if (event & (POLLERR|POLLHUP))
406 /* we didn't get connected? */
407 sock->state &= ~FD_CONNECT;
408 event &= ~POLLOUT;
409 error = sock_error( fd );
411 else if (event & POLLOUT)
413 /* we got connected */
414 sock->state |= FD_WINE_CONNECTED|FD_READ|FD_WRITE;
415 sock->state &= ~FD_CONNECT;
416 sock->connect_time = current_time;
419 else if (sock->state & FD_WINE_LISTENING)
421 /* listening */
422 if (event & (POLLERR|POLLHUP))
423 error = sock_error( fd );
425 else
427 /* normal data flow */
428 if ( sock->type == SOCK_STREAM && ( event & POLLIN ) )
430 char dummy;
431 int nr;
433 /* Linux 2.4 doesn't report POLLHUP if only one side of the socket
434 * has been closed, so we need to check for it explicitly here */
435 nr = recv( get_unix_fd( fd ), &dummy, 1, MSG_PEEK );
436 if ( nr == 0 )
438 hangup_seen = 1;
439 event &= ~POLLIN;
441 else if ( nr < 0 )
443 event &= ~POLLIN;
444 /* EAGAIN can happen if an async recv() falls between the server's poll()
445 call and the invocation of this routine */
446 if ( errno != EAGAIN )
448 error = errno;
449 event |= POLLERR;
450 if ( debug_level )
451 fprintf( stderr, "recv error on socket %p: %d\n", sock, errno );
456 if ( (hangup_seen || event & (POLLHUP|POLLERR)) && (sock->state & (FD_READ|FD_WRITE)) )
458 error = error ? error : sock_error( fd );
459 if ( (event & POLLERR) || ( sock_shutdown_type == SOCK_SHUTDOWN_EOF && (event & POLLHUP) ))
460 sock->state &= ~FD_WRITE;
461 sock->state &= ~FD_READ;
463 if (debug_level)
464 fprintf(stderr, "socket %p aborted by error %d, event: %x\n", sock, error, event);
467 if (hangup_seen)
468 event |= POLLHUP;
471 event = sock_dispatch_asyncs( sock, event, error );
472 sock_dispatch_events( sock, prevstate, event, error );
474 /* if anyone is stupid enough to wait on the socket object itself,
475 * maybe we should wake them up too, just in case? */
476 wake_up( &sock->obj, 0 );
478 sock_reselect( sock );
481 static void sock_dump( struct object *obj, int verbose )
483 struct sock *sock = (struct sock *)obj;
484 assert( obj->ops == &sock_ops );
485 fprintf( stderr, "Socket fd=%p, state=%x, mask=%x, pending=%x, held=%x\n",
486 sock->fd, sock->state,
487 sock->mask, sock->pmask, sock->hmask );
490 static int sock_signaled( struct object *obj, struct wait_queue_entry *entry )
492 struct sock *sock = (struct sock *)obj;
493 assert( obj->ops == &sock_ops );
495 return check_fd_events( sock->fd, sock_get_poll_events( sock->fd ) ) != 0;
498 static int sock_get_poll_events( struct fd *fd )
500 struct sock *sock = get_fd_user( fd );
501 unsigned int mask = sock->mask & ~sock->hmask;
502 unsigned int smask = sock->state & mask;
503 int ev = 0;
505 assert( sock->obj.ops == &sock_ops );
507 if (sock->state & FD_CONNECT)
508 /* connecting, wait for writable */
509 return POLLOUT;
511 if ( async_queued( sock->read_q ) )
513 if ( async_waiting( sock->read_q ) ) ev |= POLLIN | POLLPRI;
515 else if (smask & FD_READ || (sock->state & FD_WINE_LISTENING && mask & FD_ACCEPT))
516 ev |= POLLIN | POLLPRI;
517 /* We use POLLIN with 0 bytes recv() as FD_CLOSE indication for stream sockets. */
518 else if ( sock->type == SOCK_STREAM && sock->state & FD_READ && mask & FD_CLOSE &&
519 !(sock->hmask & FD_READ) )
520 ev |= POLLIN;
522 if ( async_queued( sock->write_q ) )
524 if ( async_waiting( sock->write_q ) ) ev |= POLLOUT;
526 else if (smask & FD_WRITE)
527 ev |= POLLOUT;
529 return ev;
532 static enum server_fd_type sock_get_fd_type( struct fd *fd )
534 return FD_TYPE_SOCKET;
537 obj_handle_t sock_ioctl( struct fd *fd, ioctl_code_t code, const async_data_t *async_data, int blocking )
539 struct sock *sock = get_fd_user( fd );
540 obj_handle_t wait_handle = 0;
541 struct async_queue *ifchange_q;
542 struct async *async;
544 assert( sock->obj.ops == &sock_ops );
546 switch(code)
548 case WS_SIO_ADDRESS_LIST_CHANGE:
549 if (!(ifchange_q = sock_get_ifchange_q( sock ))) return 0;
550 if (!(async = create_async( current, ifchange_q, async_data ))) return 0;
551 if (blocking) wait_handle = alloc_handle( current->process, async, SYNCHRONIZE, 0 );
552 release_object( async );
553 set_error( STATUS_PENDING );
554 return wait_handle;
555 default:
556 set_error( STATUS_NOT_SUPPORTED );
557 return 0;
561 static void sock_queue_async( struct fd *fd, const async_data_t *data, int type, int count )
563 struct sock *sock = get_fd_user( fd );
564 struct async *async;
565 struct async_queue *queue;
567 assert( sock->obj.ops == &sock_ops );
569 switch (type)
571 case ASYNC_TYPE_READ:
572 if (!sock->read_q && !(sock->read_q = create_async_queue( sock->fd ))) return;
573 queue = sock->read_q;
574 break;
575 case ASYNC_TYPE_WRITE:
576 if (!sock->write_q && !(sock->write_q = create_async_queue( sock->fd ))) return;
577 queue = sock->write_q;
578 break;
579 default:
580 set_error( STATUS_INVALID_PARAMETER );
581 return;
584 if ( ( !( sock->state & (FD_READ|FD_CONNECT|FD_WINE_LISTENING) ) && type == ASYNC_TYPE_READ ) ||
585 ( !( sock->state & (FD_WRITE|FD_CONNECT) ) && type == ASYNC_TYPE_WRITE ) )
587 set_error( STATUS_PIPE_DISCONNECTED );
588 return;
591 if (!(async = create_async( current, queue, data ))) return;
592 release_object( async );
594 sock_reselect( sock );
596 set_error( STATUS_PENDING );
599 static void sock_reselect_async( struct fd *fd, struct async_queue *queue )
601 struct sock *sock = get_fd_user( fd );
602 sock_reselect( sock );
605 static int sock_cancel_async( struct fd *fd, struct process *process, struct thread *thread, client_ptr_t iosb )
607 struct sock *sock = get_fd_user( fd );
608 int n = 0;
610 assert( sock->obj.ops == &sock_ops );
612 n += async_wake_up_by( sock->read_q, process, thread, iosb, STATUS_CANCELLED );
613 n += async_wake_up_by( sock->write_q, process, thread, iosb, STATUS_CANCELLED );
614 n += async_wake_up_by( sock->ifchange_q, process, thread, iosb, STATUS_CANCELLED );
615 return n;
618 static struct fd *sock_get_fd( struct object *obj )
620 struct sock *sock = (struct sock *)obj;
621 return (struct fd *)grab_object( sock->fd );
624 static void sock_destroy( struct object *obj )
626 struct sock *sock = (struct sock *)obj;
627 assert( obj->ops == &sock_ops );
629 /* FIXME: special socket shutdown stuff? */
631 if ( sock->deferred )
632 release_object( sock->deferred );
634 free_async_queue( sock->read_q );
635 free_async_queue( sock->write_q );
636 sock_destroy_ifchange_q( sock );
637 if (sock->event) release_object( sock->event );
638 if (sock->fd)
640 /* shut the socket down to force pending poll() calls in the client to return */
641 shutdown( get_unix_fd(sock->fd), SHUT_RDWR );
642 release_object( sock->fd );
646 static void init_sock(struct sock *sock)
648 sock->state = 0;
649 sock->mask = 0;
650 sock->hmask = 0;
651 sock->pmask = 0;
652 sock->polling = 0;
653 sock->flags = 0;
654 sock->type = 0;
655 sock->family = 0;
656 sock->event = NULL;
657 sock->window = 0;
658 sock->message = 0;
659 sock->wparam = 0;
660 sock->connect_time = 0;
661 sock->deferred = NULL;
662 sock->read_q = NULL;
663 sock->write_q = NULL;
664 sock->ifchange_q = NULL;
665 sock->ifchange_obj = NULL;
666 memset( sock->errors, 0, sizeof(sock->errors) );
669 /* create a new and unconnected socket */
670 static struct object *create_socket( int family, int type, int protocol, unsigned int flags )
672 struct sock *sock;
673 int sockfd;
675 sockfd = socket( family, type, protocol );
676 if (debug_level)
677 fprintf(stderr,"socket(%d,%d,%d)=%d\n",family,type,protocol,sockfd);
678 if (sockfd == -1)
680 sock_set_error();
681 return NULL;
683 fcntl(sockfd, F_SETFL, O_NONBLOCK); /* make socket nonblocking */
684 if (!(sock = alloc_object( &sock_ops )))
686 close( sockfd );
687 return NULL;
689 init_sock( sock );
690 sock->state = (type != SOCK_STREAM) ? (FD_READ|FD_WRITE) : 0;
691 sock->flags = flags;
692 sock->proto = protocol;
693 sock->type = type;
694 sock->family = family;
696 if (!(sock->fd = create_anonymous_fd( &sock_fd_ops, sockfd, &sock->obj,
697 (flags & WSA_FLAG_OVERLAPPED) ? 0 : FILE_SYNCHRONOUS_IO_NONALERT )))
699 release_object( sock );
700 return NULL;
702 sock_reselect( sock );
703 clear_error();
704 return &sock->obj;
707 /* accepts a socket and inits it */
708 static int accept_new_fd( struct sock *sock )
711 /* Try to accept(2). We can't be safe that this an already connected socket
712 * or that accept() is allowed on it. In those cases we will get -1/errno
713 * return.
715 int acceptfd;
716 struct sockaddr saddr;
717 socklen_t slen = sizeof(saddr);
718 acceptfd = accept( get_unix_fd(sock->fd), &saddr, &slen);
719 if (acceptfd == -1)
721 sock_set_error();
722 return acceptfd;
725 fcntl(acceptfd, F_SETFL, O_NONBLOCK); /* make socket nonblocking */
726 return acceptfd;
729 /* accept a socket (creates a new fd) */
730 static struct sock *accept_socket( obj_handle_t handle )
732 struct sock *acceptsock;
733 struct sock *sock;
734 int acceptfd;
736 sock = (struct sock *)get_handle_obj( current->process, handle, FILE_READ_DATA, &sock_ops );
737 if (!sock)
738 return NULL;
740 if ( sock->deferred )
742 acceptsock = sock->deferred;
743 sock->deferred = NULL;
745 else
747 if ((acceptfd = accept_new_fd( sock )) == -1)
749 release_object( sock );
750 return NULL;
752 if (!(acceptsock = alloc_object( &sock_ops )))
754 close( acceptfd );
755 release_object( sock );
756 return NULL;
759 init_sock( acceptsock );
760 /* newly created socket gets the same properties of the listening socket */
761 acceptsock->state = FD_WINE_CONNECTED|FD_READ|FD_WRITE;
762 if (sock->state & FD_WINE_NONBLOCKING)
763 acceptsock->state |= FD_WINE_NONBLOCKING;
764 acceptsock->mask = sock->mask;
765 acceptsock->proto = sock->proto;
766 acceptsock->type = sock->type;
767 acceptsock->family = sock->family;
768 acceptsock->window = sock->window;
769 acceptsock->message = sock->message;
770 acceptsock->connect_time = current_time;
771 if (sock->event) acceptsock->event = (struct event *)grab_object( sock->event );
772 acceptsock->flags = sock->flags;
773 if (!(acceptsock->fd = create_anonymous_fd( &sock_fd_ops, acceptfd, &acceptsock->obj,
774 get_fd_options( sock->fd ) )))
776 release_object( acceptsock );
777 release_object( sock );
778 return NULL;
781 clear_error();
782 sock->pmask &= ~FD_ACCEPT;
783 sock->hmask &= ~FD_ACCEPT;
784 sock_reselect( sock );
785 release_object( sock );
786 return acceptsock;
789 static int accept_into_socket( struct sock *sock, struct sock *acceptsock )
791 int acceptfd;
792 struct fd *newfd;
793 if ( sock->deferred )
795 newfd = dup_fd_object( sock->deferred->fd, 0, 0,
796 get_fd_options( acceptsock->fd ) );
797 if ( !newfd )
798 return FALSE;
800 set_fd_user( newfd, &sock_fd_ops, &acceptsock->obj );
802 release_object( sock->deferred );
803 sock->deferred = NULL;
805 else
807 if ((acceptfd = accept_new_fd( sock )) == -1)
808 return FALSE;
810 if (!(newfd = create_anonymous_fd( &sock_fd_ops, acceptfd, &acceptsock->obj,
811 get_fd_options( acceptsock->fd ) )))
812 return FALSE;
815 acceptsock->state |= FD_WINE_CONNECTED|FD_READ|FD_WRITE;
816 acceptsock->hmask = 0;
817 acceptsock->pmask = 0;
818 acceptsock->polling = 0;
819 acceptsock->proto = sock->proto;
820 acceptsock->type = sock->type;
821 acceptsock->family = sock->family;
822 acceptsock->wparam = 0;
823 acceptsock->deferred = NULL;
824 acceptsock->connect_time = current_time;
825 fd_copy_completion( acceptsock->fd, newfd );
826 release_object( acceptsock->fd );
827 acceptsock->fd = newfd;
829 clear_error();
830 sock->pmask &= ~FD_ACCEPT;
831 sock->hmask &= ~FD_ACCEPT;
832 sock_reselect( sock );
834 return TRUE;
837 /* return an errno value mapped to a WSA error */
838 static int sock_get_error( int err )
840 switch (err)
842 case EINTR: return WSAEINTR;
843 case EBADF: return WSAEBADF;
844 case EPERM:
845 case EACCES: return WSAEACCES;
846 case EFAULT: return WSAEFAULT;
847 case EINVAL: return WSAEINVAL;
848 case EMFILE: return WSAEMFILE;
849 case EWOULDBLOCK: return WSAEWOULDBLOCK;
850 case EINPROGRESS: return WSAEINPROGRESS;
851 case EALREADY: return WSAEALREADY;
852 case ENOTSOCK: return WSAENOTSOCK;
853 case EDESTADDRREQ: return WSAEDESTADDRREQ;
854 case EMSGSIZE: return WSAEMSGSIZE;
855 case EPROTOTYPE: return WSAEPROTOTYPE;
856 case ENOPROTOOPT: return WSAENOPROTOOPT;
857 case EPROTONOSUPPORT: return WSAEPROTONOSUPPORT;
858 case ESOCKTNOSUPPORT: return WSAESOCKTNOSUPPORT;
859 case EOPNOTSUPP: return WSAEOPNOTSUPP;
860 case EPFNOSUPPORT: return WSAEPFNOSUPPORT;
861 case EAFNOSUPPORT: return WSAEAFNOSUPPORT;
862 case EADDRINUSE: return WSAEADDRINUSE;
863 case EADDRNOTAVAIL: return WSAEADDRNOTAVAIL;
864 case ENETDOWN: return WSAENETDOWN;
865 case ENETUNREACH: return WSAENETUNREACH;
866 case ENETRESET: return WSAENETRESET;
867 case ECONNABORTED: return WSAECONNABORTED;
868 case EPIPE:
869 case ECONNRESET: return WSAECONNRESET;
870 case ENOBUFS: return WSAENOBUFS;
871 case EISCONN: return WSAEISCONN;
872 case ENOTCONN: return WSAENOTCONN;
873 case ESHUTDOWN: return WSAESHUTDOWN;
874 case ETOOMANYREFS: return WSAETOOMANYREFS;
875 case ETIMEDOUT: return WSAETIMEDOUT;
876 case ECONNREFUSED: return WSAECONNREFUSED;
877 case ELOOP: return WSAELOOP;
878 case ENAMETOOLONG: return WSAENAMETOOLONG;
879 case EHOSTDOWN: return WSAEHOSTDOWN;
880 case EHOSTUNREACH: return WSAEHOSTUNREACH;
881 case ENOTEMPTY: return WSAENOTEMPTY;
882 #ifdef EPROCLIM
883 case EPROCLIM: return WSAEPROCLIM;
884 #endif
885 #ifdef EUSERS
886 case EUSERS: return WSAEUSERS;
887 #endif
888 #ifdef EDQUOT
889 case EDQUOT: return WSAEDQUOT;
890 #endif
891 #ifdef ESTALE
892 case ESTALE: return WSAESTALE;
893 #endif
894 #ifdef EREMOTE
895 case EREMOTE: return WSAEREMOTE;
896 #endif
898 case 0: return 0;
899 default:
900 errno = err;
901 perror("wineserver: sock_get_error() can't map error");
902 return WSAEFAULT;
906 static int sock_get_ntstatus( int err )
908 switch ( err )
910 case EBADF: return STATUS_INVALID_HANDLE;
911 case EBUSY: return STATUS_DEVICE_BUSY;
912 case EPERM:
913 case EACCES: return STATUS_ACCESS_DENIED;
914 case EFAULT: return STATUS_NO_MEMORY;
915 case EINVAL: return STATUS_INVALID_PARAMETER;
916 case ENFILE:
917 case EMFILE: return STATUS_TOO_MANY_OPENED_FILES;
918 case EWOULDBLOCK: return STATUS_CANT_WAIT;
919 case EINPROGRESS: return STATUS_PENDING;
920 case EALREADY: return STATUS_NETWORK_BUSY;
921 case ENOTSOCK: return STATUS_OBJECT_TYPE_MISMATCH;
922 case EDESTADDRREQ: return STATUS_INVALID_PARAMETER;
923 case EMSGSIZE: return STATUS_BUFFER_OVERFLOW;
924 case EPROTONOSUPPORT:
925 case ESOCKTNOSUPPORT:
926 case EPFNOSUPPORT:
927 case EAFNOSUPPORT:
928 case EPROTOTYPE: return STATUS_NOT_SUPPORTED;
929 case ENOPROTOOPT: return STATUS_INVALID_PARAMETER;
930 case EOPNOTSUPP: return STATUS_NOT_SUPPORTED;
931 case EADDRINUSE: return STATUS_ADDRESS_ALREADY_ASSOCIATED;
932 case EADDRNOTAVAIL: return STATUS_INVALID_PARAMETER;
933 case ECONNREFUSED: return STATUS_CONNECTION_REFUSED;
934 case ESHUTDOWN: return STATUS_PIPE_DISCONNECTED;
935 case ENOTCONN: return STATUS_CONNECTION_DISCONNECTED;
936 case ETIMEDOUT: return STATUS_IO_TIMEOUT;
937 case ENETUNREACH: return STATUS_NETWORK_UNREACHABLE;
938 case EHOSTUNREACH: return STATUS_HOST_UNREACHABLE;
939 case ENETDOWN: return STATUS_NETWORK_BUSY;
940 case EPIPE:
941 case ECONNRESET: return STATUS_CONNECTION_RESET;
942 case ECONNABORTED: return STATUS_CONNECTION_ABORTED;
944 case 0: return STATUS_SUCCESS;
945 default:
946 errno = err;
947 perror("wineserver: sock_get_ntstatus() can't map error");
948 return STATUS_UNSUCCESSFUL;
952 /* set the last error depending on errno */
953 static void sock_set_error(void)
955 set_error( sock_get_ntstatus( errno ) );
958 #ifdef HAVE_LINUX_RTNETLINK_H
960 /* only keep one ifchange object around, all sockets waiting for wakeups will look to it */
961 static struct object *ifchange_object;
963 static void ifchange_dump( struct object *obj, int verbose );
964 static struct fd *ifchange_get_fd( struct object *obj );
965 static void ifchange_destroy( struct object *obj );
967 static int ifchange_get_poll_events( struct fd *fd );
968 static void ifchange_poll_event( struct fd *fd, int event );
969 static void ifchange_reselect_async( struct fd *fd, struct async_queue *queue );
971 struct ifchange
973 struct object obj; /* object header */
974 struct fd *fd; /* interface change file descriptor */
975 struct list sockets; /* list of sockets to send interface change notifications */
978 static const struct object_ops ifchange_ops =
980 sizeof(struct ifchange), /* size */
981 ifchange_dump, /* dump */
982 no_get_type, /* get_type */
983 add_queue, /* add_queue */
984 NULL, /* remove_queue */
985 NULL, /* signaled */
986 no_satisfied, /* satisfied */
987 no_signal, /* signal */
988 ifchange_get_fd, /* get_fd */
989 default_fd_map_access, /* map_access */
990 default_get_sd, /* get_sd */
991 default_set_sd, /* set_sd */
992 no_lookup_name, /* lookup_name */
993 no_open_file, /* open_file */
994 no_close_handle, /* close_handle */
995 ifchange_destroy /* destroy */
998 static const struct fd_ops ifchange_fd_ops =
1000 ifchange_get_poll_events, /* get_poll_events */
1001 ifchange_poll_event, /* poll_event */
1002 NULL, /* get_fd_type */
1003 no_fd_read, /* read */
1004 no_fd_write, /* write */
1005 no_fd_flush, /* flush */
1006 no_fd_ioctl, /* ioctl */
1007 NULL, /* queue_async */
1008 ifchange_reselect_async, /* reselect_async */
1009 NULL /* cancel_async */
1012 static void ifchange_dump( struct object *obj, int verbose )
1014 assert( obj->ops == &ifchange_ops );
1015 fprintf( stderr, "Interface change\n" );
1018 static struct fd *ifchange_get_fd( struct object *obj )
1020 struct ifchange *ifchange = (struct ifchange *)obj;
1021 return (struct fd *)grab_object( ifchange->fd );
1024 static void ifchange_destroy( struct object *obj )
1026 struct ifchange *ifchange = (struct ifchange *)obj;
1027 assert( obj->ops == &ifchange_ops );
1029 release_object( ifchange->fd );
1031 /* reset the global ifchange object so that it will be recreated if it is needed again */
1032 assert( obj == ifchange_object );
1033 ifchange_object = NULL;
1036 static int ifchange_get_poll_events( struct fd *fd )
1038 return POLLIN;
1041 /* wake up all the sockets waiting for a change notification event */
1042 static void ifchange_wake_up( struct object *obj, unsigned int status )
1044 struct ifchange *ifchange = (struct ifchange *)obj;
1045 struct list *ptr, *next;
1046 assert( obj->ops == &ifchange_ops );
1047 assert( obj == ifchange_object );
1049 LIST_FOR_EACH_SAFE( ptr, next, &ifchange->sockets )
1051 struct sock *sock = LIST_ENTRY( ptr, struct sock, ifchange_entry );
1053 assert( sock->ifchange_q );
1054 async_wake_up( sock->ifchange_q, status ); /* issue ifchange notification for the socket */
1055 sock_destroy_ifchange_q( sock ); /* remove socket from list and decrement ifchange refcount */
1059 static void ifchange_poll_event( struct fd *fd, int event )
1061 struct object *ifchange = get_fd_user( fd );
1062 unsigned int status = STATUS_PENDING;
1063 char buffer[PIPE_BUF];
1064 int r;
1066 r = recv( get_unix_fd(fd), buffer, sizeof(buffer), MSG_DONTWAIT );
1067 if (r < 0)
1069 if (errno == EWOULDBLOCK || errno == EAGAIN)
1070 return; /* retry when poll() says the socket is ready */
1071 status = sock_get_ntstatus( errno );
1073 else if (r > 0)
1075 struct nlmsghdr *nlh;
1077 for (nlh = (struct nlmsghdr *)buffer; NLMSG_OK(nlh, r); nlh = NLMSG_NEXT(nlh, r))
1079 if (nlh->nlmsg_type == NLMSG_DONE)
1080 break;
1081 if (nlh->nlmsg_type == RTM_NEWADDR || nlh->nlmsg_type == RTM_DELADDR)
1082 status = STATUS_SUCCESS;
1085 else status = STATUS_CANCELLED;
1087 if (status != STATUS_PENDING) ifchange_wake_up( ifchange, status );
1090 static void ifchange_reselect_async( struct fd *fd, struct async_queue *queue )
1092 /* do nothing, this object is about to disappear */
1095 #endif
1097 /* we only need one of these interface notification objects, all of the sockets dependent upon
1098 * it will wake up when a notification event occurs */
1099 static struct object *get_ifchange( void )
1101 #ifdef HAVE_LINUX_RTNETLINK_H
1102 struct ifchange *ifchange;
1103 struct sockaddr_nl addr;
1104 int unix_fd;
1106 if (ifchange_object)
1108 /* increment the refcount for each socket that uses the ifchange object */
1109 return grab_object( ifchange_object );
1112 /* create the socket we need for processing interface change notifications */
1113 unix_fd = socket( PF_NETLINK, SOCK_RAW, NETLINK_ROUTE );
1114 if (unix_fd == -1)
1116 sock_set_error();
1117 return NULL;
1119 fcntl( unix_fd, F_SETFL, O_NONBLOCK ); /* make socket nonblocking */
1120 memset( &addr, 0, sizeof(addr) );
1121 addr.nl_family = AF_NETLINK;
1122 addr.nl_groups = RTMGRP_IPV4_IFADDR;
1123 /* bind the socket to the special netlink kernel interface */
1124 if (bind( unix_fd, (struct sockaddr *)&addr, sizeof(addr) ) == -1)
1126 close( unix_fd );
1127 sock_set_error();
1128 return NULL;
1130 if (!(ifchange = alloc_object( &ifchange_ops )))
1132 close( unix_fd );
1133 set_error( STATUS_NO_MEMORY );
1134 return NULL;
1136 list_init( &ifchange->sockets );
1137 if (!(ifchange->fd = create_anonymous_fd( &ifchange_fd_ops, unix_fd, &ifchange->obj, 0 )))
1139 release_object( ifchange );
1140 set_error( STATUS_NO_MEMORY );
1141 return NULL;
1143 set_fd_events( ifchange->fd, POLLIN ); /* enable read wakeup on the file descriptor */
1145 /* the ifchange object is now successfully configured */
1146 ifchange_object = &ifchange->obj;
1147 return &ifchange->obj;
1148 #else
1149 set_error( STATUS_NOT_SUPPORTED );
1150 return NULL;
1151 #endif
1154 /* add the socket to the interface change notification list */
1155 static void ifchange_add_sock( struct object *obj, struct sock *sock )
1157 #ifdef HAVE_LINUX_RTNETLINK_H
1158 struct ifchange *ifchange = (struct ifchange *)obj;
1160 list_add_tail( &ifchange->sockets, &sock->ifchange_entry );
1161 #endif
1164 /* create a new ifchange queue for a specific socket or, if one already exists, reuse the existing one */
1165 static struct async_queue *sock_get_ifchange_q( struct sock *sock )
1167 struct object *ifchange;
1168 struct fd *fd;
1170 if (sock->ifchange_q) /* reuse existing ifchange_q for this socket */
1171 return sock->ifchange_q;
1173 if (!(ifchange = get_ifchange()))
1174 return NULL;
1176 /* create the ifchange notification queue */
1177 fd = get_obj_fd( ifchange );
1178 sock->ifchange_q = create_async_queue( fd );
1179 release_object( fd );
1180 if (!sock->ifchange_q)
1182 release_object( ifchange );
1183 set_error( STATUS_NO_MEMORY );
1184 return NULL;
1187 /* add the socket to the ifchange notification list */
1188 ifchange_add_sock( ifchange, sock );
1189 sock->ifchange_obj = ifchange;
1190 return sock->ifchange_q;
1193 /* destroy an existing ifchange queue for a specific socket */
1194 static void sock_destroy_ifchange_q( struct sock *sock )
1196 if (sock->ifchange_q)
1198 list_remove( &sock->ifchange_entry );
1199 free_async_queue( sock->ifchange_q );
1200 sock->ifchange_q = NULL;
1201 release_object( sock->ifchange_obj );
1205 /* create a socket */
1206 DECL_HANDLER(create_socket)
1208 struct object *obj;
1210 reply->handle = 0;
1211 if ((obj = create_socket( req->family, req->type, req->protocol, req->flags )) != NULL)
1213 reply->handle = alloc_handle( current->process, obj, req->access, req->attributes );
1214 release_object( obj );
1218 /* accept a socket */
1219 DECL_HANDLER(accept_socket)
1221 struct sock *sock;
1223 reply->handle = 0;
1224 if ((sock = accept_socket( req->lhandle )) != NULL)
1226 reply->handle = alloc_handle( current->process, &sock->obj, req->access, req->attributes );
1227 sock->wparam = reply->handle; /* wparam for message is the socket handle */
1228 sock_reselect( sock );
1229 release_object( &sock->obj );
1233 /* accept a socket into an initialized socket */
1234 DECL_HANDLER(accept_into_socket)
1236 struct sock *sock, *acceptsock;
1237 const int all_attributes = FILE_READ_ATTRIBUTES|FILE_WRITE_ATTRIBUTES|FILE_READ_DATA;
1239 if (!(sock = (struct sock *)get_handle_obj( current->process, req->lhandle,
1240 all_attributes, &sock_ops)))
1241 return;
1243 if (!(acceptsock = (struct sock *)get_handle_obj( current->process, req->ahandle,
1244 all_attributes, &sock_ops)))
1246 release_object( sock );
1247 return;
1250 if (accept_into_socket( sock, acceptsock ))
1252 acceptsock->wparam = req->ahandle; /* wparam for message is the socket handle */
1253 sock_reselect( acceptsock );
1255 release_object( acceptsock );
1256 release_object( sock );
1259 /* set socket event parameters */
1260 DECL_HANDLER(set_socket_event)
1262 struct sock *sock;
1263 struct event *old_event;
1265 if (!(sock = (struct sock *)get_handle_obj( current->process, req->handle,
1266 FILE_WRITE_ATTRIBUTES, &sock_ops))) return;
1267 old_event = sock->event;
1268 sock->mask = req->mask;
1269 sock->hmask &= ~req->mask; /* re-enable held events */
1270 sock->event = NULL;
1271 sock->window = req->window;
1272 sock->message = req->msg;
1273 sock->wparam = req->handle; /* wparam is the socket handle */
1274 if (req->event) sock->event = get_event_obj( current->process, req->event, EVENT_MODIFY_STATE );
1276 if (debug_level && sock->event) fprintf(stderr, "event ptr: %p\n", sock->event);
1278 sock_reselect( sock );
1280 sock->state |= FD_WINE_NONBLOCKING;
1282 /* if a network event is pending, signal the event object
1283 it is possible that FD_CONNECT or FD_ACCEPT network events has happened
1284 before a WSAEventSelect() was done on it.
1285 (when dealing with Asynchronous socket) */
1286 sock_wake_up( sock );
1288 if (old_event) release_object( old_event ); /* we're through with it */
1289 release_object( &sock->obj );
1292 /* get socket event parameters */
1293 DECL_HANDLER(get_socket_event)
1295 struct sock *sock;
1296 int i;
1297 int errors[FD_MAX_EVENTS];
1299 sock = (struct sock *)get_handle_obj( current->process, req->handle, FILE_READ_ATTRIBUTES, &sock_ops );
1300 if (!sock)
1302 reply->mask = 0;
1303 reply->pmask = 0;
1304 reply->state = 0;
1305 return;
1307 reply->mask = sock->mask;
1308 reply->pmask = sock->pmask;
1309 reply->state = sock->state;
1310 for (i = 0; i < FD_MAX_EVENTS; i++)
1311 errors[i] = sock_get_ntstatus(sock->errors[i]);
1313 set_reply_data( errors, min( get_reply_max_size(), sizeof(errors) ));
1315 if (req->service)
1317 if (req->c_event)
1319 struct event *cevent = get_event_obj( current->process, req->c_event,
1320 EVENT_MODIFY_STATE );
1321 if (cevent)
1323 reset_event( cevent );
1324 release_object( cevent );
1327 sock->pmask = 0;
1328 sock_reselect( sock );
1330 release_object( &sock->obj );
1333 /* re-enable pending socket events */
1334 DECL_HANDLER(enable_socket_event)
1336 struct sock *sock;
1338 if (!(sock = (struct sock*)get_handle_obj( current->process, req->handle,
1339 FILE_WRITE_ATTRIBUTES, &sock_ops)))
1340 return;
1342 /* for event-based notification, windows erases stale events */
1343 sock->pmask &= ~req->mask;
1345 sock->hmask &= ~req->mask;
1346 sock->state |= req->sstate;
1347 sock->state &= ~req->cstate;
1348 if ( sock->type != SOCK_STREAM ) sock->state &= ~STREAM_FLAG_MASK;
1350 sock_reselect( sock );
1352 release_object( &sock->obj );
1355 DECL_HANDLER(set_socket_deferred)
1357 struct sock *sock, *acceptsock;
1359 sock=(struct sock *)get_handle_obj( current->process, req->handle, FILE_WRITE_ATTRIBUTES, &sock_ops );
1360 if ( !sock )
1361 return;
1363 acceptsock = (struct sock *)get_handle_obj( current->process, req->deferred, 0, &sock_ops );
1364 if ( !acceptsock )
1366 release_object( sock );
1367 return;
1369 sock->deferred = acceptsock;
1370 release_object( sock );
1373 DECL_HANDLER(get_socket_info)
1375 struct sock *sock;
1377 sock = (struct sock *)get_handle_obj( current->process, req->handle, FILE_READ_ATTRIBUTES, &sock_ops );
1378 if (!sock) return;
1380 reply->family = sock->family;
1381 reply->type = sock->type;
1382 reply->protocol = sock->proto;
1384 release_object( &sock->obj );