remove all support for pre v13 protocols
[profile/ivi/libwebsockets.git] / lib / libwebsockets.c
1 /*
2  * libwebsockets - small server side websockets and web server implementation
3  *
4  * Copyright (C) 2010 Andy Green <andy@warmcat.com>
5  *
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:
9  *  version 2.1 of the License.
10  *
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.
15  *
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 Street, Fifth Floor, Boston,
19  *  MA  02110-1301  USA
20  */
21
22 #include "private-libwebsockets.h"
23 #include <syslog.h>
24
25 #ifdef WIN32
26 #include <tchar.h>
27 #include <io.h>
28 #else
29 #ifdef LWS_BUILTIN_GETIFADDRS
30 #include <getifaddrs.h>
31 #else
32 #include <ifaddrs.h>
33 #endif
34 #include <sys/un.h>
35 #include <sys/socket.h>
36 #include <netdb.h>
37 #endif
38
39 #ifdef LWS_OPENSSL_SUPPORT
40 int openssl_websocket_private_data_index;
41 #endif
42
43 #ifdef __MINGW32__
44 #include "../win32port/win32helpers/websock-w32.c"
45 #else
46 #ifdef __MINGW64__
47 #include "../win32port/win32helpers/websock-w32.c"
48 #endif
49 #endif
50
51
52 static int log_level = LLL_ERR | LLL_WARN | LLL_NOTICE;
53 static void lwsl_emit_stderr(int level, const char *line);
54 static void (*lwsl_emit)(int level, const char *line) = lwsl_emit_stderr;
55
56 static const char *log_level_names[] = {
57         "ERR",
58         "WARN",
59         "NOTICE",
60         "INFO",
61         "DEBUG",
62         "PARSER",
63         "HEADER",
64         "EXTENSION",
65         "CLIENT",
66 };
67
68 int
69 insert_wsi_socket_into_fds(struct libwebsocket_context *context, struct libwebsocket *wsi)
70 {
71         if (context->fds_count >= context->max_fds) {
72                 lwsl_err("Reached limit of fds tracking (%d)\n", context->max_fds);
73                 return 1;
74         }
75
76         if (wsi->sock > context->max_fds) {
77                 lwsl_err("Socket fd %d is beyond what we can index (%d)\n", wsi->sock, context->max_fds);
78                 return 1;
79         }
80
81         assert(wsi);
82         assert(wsi->sock);
83
84         lwsl_info("insert_wsi_socket_into_fds: wsi=%p, sock=%d, fds pos=%d\n", wsi, wsi->sock, context->fds_count);
85
86         context->lws_lookup[wsi->sock] = wsi;
87         wsi->position_in_fds_table = context->fds_count;
88         context->fds[context->fds_count].fd = wsi->sock;
89         context->fds[context->fds_count].events = POLLIN;
90         context->fds[context->fds_count++].revents = 0;
91
92         /* external POLL support via protocol 0 */
93         context->protocols[0].callback(context, wsi,
94                 LWS_CALLBACK_ADD_POLL_FD,
95                 (void *)(long)wsi->sock, NULL, POLLIN);
96
97         return 0;
98 }
99
100 static int
101 remove_wsi_socket_from_fds(struct libwebsocket_context *context, struct libwebsocket *wsi)
102 {
103         int m;
104
105         if (!--context->fds_count)
106                 goto do_ext;
107
108         if (wsi->sock > context->max_fds) {
109                 lwsl_err("Socket fd %d is beyond what we can index (%d)\n", wsi->sock, context->max_fds);
110                 return 1;
111         }
112
113         lwsl_info("remove_wsi_socket_from_fds: wsi=%p, sock=%d, fds pos=%d\n", wsi, wsi->sock, wsi->position_in_fds_table);
114
115         m = wsi->position_in_fds_table; /* replace the contents for this */
116
117         /* have the last guy take up the vacant slot */
118         context->fds[m] = context->fds[context->fds_count]; /* vacant fds slot filled with end one */
119         /* end guy's fds_lookup entry remains unchanged (still same fd pointing to same wsi) */
120         /* end guy's "position in fds table" changed */
121         context->lws_lookup[context->fds[context->fds_count].fd]->position_in_fds_table = m;
122         /* deletion guy's lws_lookup entry needs nuking */
123         context->lws_lookup[wsi->sock] = NULL; /* no WSI for the socket of the wsi being removed*/
124         wsi->position_in_fds_table = -1; /* removed wsi has no position any more */
125
126 do_ext:
127         /* remove also from external POLL support via protocol 0 */
128         if (wsi->sock)
129                 context->protocols[0].callback(context, wsi,
130                     LWS_CALLBACK_DEL_POLL_FD, (void *)(long)wsi->sock, NULL, 0);
131
132         return 0;
133 }
134
135
136 void
137 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
138                          struct libwebsocket *wsi, enum lws_close_status reason)
139 {
140         int n;
141         int old_state;
142         unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
143                                                   LWS_SEND_BUFFER_POST_PADDING];
144 #ifndef LWS_NO_EXTENSIONS
145         int ret;
146         int m;
147         struct lws_tokens eff_buf;
148         struct libwebsocket_extension *ext;
149 #endif
150
151         if (!wsi)
152                 return;
153
154         old_state = wsi->state;
155
156         if (old_state == WSI_STATE_DEAD_SOCKET)
157                 return;
158
159         wsi->close_reason = reason;
160
161 #ifndef LWS_NO_EXTENSIONS
162         /*
163          * are his extensions okay with him closing?  Eg he might be a mux
164          * parent and just his ch1 aspect is closing?
165          */
166
167         for (n = 0; n < wsi->count_active_extensions; n++) {
168                 if (!wsi->active_extensions[n]->callback)
169                         continue;
170
171                 m = wsi->active_extensions[n]->callback(context,
172                         wsi->active_extensions[n], wsi,
173                         LWS_EXT_CALLBACK_CHECK_OK_TO_REALLY_CLOSE,
174                                        wsi->active_extensions_user[n], NULL, 0);
175
176                 /*
177                  * if somebody vetoed actually closing him at this time....
178                  * up to the extension to track the attempted close, let's
179                  * just bail
180                  */
181
182                 if (m) {
183                         lwsl_ext("extension vetoed close\n");
184                         return;
185                 }
186         }
187
188         /*
189          * flush any tx pending from extensions, since we may send close packet
190          * if there are problems with send, just nuke the connection
191          */
192
193         ret = 1;
194         while (ret == 1) {
195
196                 /* default to nobody has more to spill */
197
198                 ret = 0;
199                 eff_buf.token = NULL;
200                 eff_buf.token_len = 0;
201
202                 /* show every extension the new incoming data */
203
204                 for (n = 0; n < wsi->count_active_extensions; n++) {
205                         m = wsi->active_extensions[n]->callback(
206                                         wsi->protocol->owning_server,
207                                         wsi->active_extensions[n], wsi,
208                                         LWS_EXT_CALLBACK_FLUSH_PENDING_TX,
209                                    wsi->active_extensions_user[n], &eff_buf, 0);
210                         if (m < 0) {
211                                 lwsl_ext("Extension reports fatal error\n");
212                                 goto just_kill_connection;
213                         }
214                         if (m)
215                                 /*
216                                  * at least one extension told us he has more
217                                  * to spill, so we will go around again after
218                                  */
219                                 ret = 1;
220                 }
221
222                 /* assuming they left us something to send, send it */
223
224                 if (eff_buf.token_len)
225                         if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
226                                                              eff_buf.token_len)) {
227                                 lwsl_debug("close: sending final extension spill had problems\n");
228                                 goto just_kill_connection;
229                         }
230         }
231 #endif
232
233         /*
234          * signal we are closing, libsocket_write will
235          * add any necessary version-specific stuff.  If the write fails,
236          * no worries we are closing anyway.  If we didn't initiate this
237          * close, then our state has been changed to
238          * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
239          *
240          * Likewise if it's a second call to close this connection after we
241          * sent the close indication to the peer already, we are in state
242          * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
243          */
244
245         if (old_state == WSI_STATE_ESTABLISHED &&
246                                           reason != LWS_CLOSE_STATUS_NOSTATUS) {
247
248                 lwsl_debug("sending close indication...\n");
249
250                 n = libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING],
251                                                             0, LWS_WRITE_CLOSE);
252                 if (!n) {
253                         /*
254                          * we have sent a nice protocol level indication we
255                          * now wish to close, we should not send anything more
256                          */
257
258                         wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
259
260                         /* and we should wait for a reply for a bit out of politeness */
261
262                         libwebsocket_set_timeout(wsi,
263                                                   PENDING_TIMEOUT_CLOSE_ACK, 1);
264
265                         lwsl_debug("sent close indication, awaiting ack\n");
266
267                         return;
268                 }
269
270                 lwsl_info("close: sending the close packet failed, hanging up\n");
271
272                 /* else, the send failed and we should just hang up */
273         }
274
275 #ifndef LWS_NO_EXTENSIONS
276 just_kill_connection:
277 #endif
278
279         lwsl_debug("libwebsocket_close_and_free_session: just_kill_connection\n");
280
281         /*
282          * we won't be servicing or receiving anything further from this guy
283          * delete socket from the internal poll list if still present
284          */
285
286         remove_wsi_socket_from_fds(context, wsi);
287
288         wsi->state = WSI_STATE_DEAD_SOCKET;
289
290         /* tell the user it's all over for this guy */
291
292         if (wsi->protocol && wsi->protocol->callback &&
293                         ((old_state == WSI_STATE_ESTABLISHED) ||
294                          (old_state == WSI_STATE_RETURNED_CLOSE_ALREADY) ||
295                          (old_state == WSI_STATE_AWAITING_CLOSE_ACK))) {
296                 lwsl_debug("calling back CLOSED\n");
297                 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
298                                                       wsi->user_space, NULL, 0);
299         } else
300                 lwsl_debug("not calling back closed, old_state=%d\n", old_state);
301
302 #ifndef LWS_NO_EXTENSIONS
303         /* deallocate any active extension contexts */
304
305         for (n = 0; n < wsi->count_active_extensions; n++) {
306                 if (!wsi->active_extensions[n]->callback)
307                         continue;
308
309                 wsi->active_extensions[n]->callback(context,
310                         wsi->active_extensions[n], wsi,
311                                 LWS_EXT_CALLBACK_DESTROY,
312                                        wsi->active_extensions_user[n], NULL, 0);
313
314                 free(wsi->active_extensions_user[n]);
315         }
316
317         /*
318          * inform all extensions in case they tracked this guy out of band
319          * even though not active on him specifically
320          */
321
322         ext = context->extensions;
323         while (ext && ext->callback) {
324                 ext->callback(context, ext, wsi,
325                                 LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING,
326                                        NULL, NULL, 0);
327                 ext++;
328         }
329 #endif
330
331         /* free up his parsing allocations */
332
333         for (n = 0; n < WSI_TOKEN_COUNT; n++)
334                 if (wsi->utf8_token[n].token)
335                         free(wsi->utf8_token[n].token);
336 #ifndef LWS_NO_CLIENT
337         if (wsi->c_address)
338                 free(wsi->c_address);
339 #endif
340         if (wsi->rxflow_buffer)
341                 free(wsi->rxflow_buffer);
342
343 /*      lwsl_info("closing fd=%d\n", wsi->sock); */
344
345 #ifdef LWS_OPENSSL_SUPPORT
346         if (wsi->ssl) {
347                 n = SSL_get_fd(wsi->ssl);
348                 SSL_shutdown(wsi->ssl);
349                 compatible_close(n);
350                 SSL_free(wsi->ssl);
351         } else {
352 #endif
353                 if (wsi->sock) {
354                         n = shutdown(wsi->sock, SHUT_RDWR);
355                         if (n)
356                                 lwsl_debug("closing: shutdown returned %d\n", errno);
357
358                         n = compatible_close(wsi->sock);
359                         if (n)
360                                 lwsl_debug("closing: close returned %d\n", errno);
361                 }
362 #ifdef LWS_OPENSSL_SUPPORT
363         }
364 #endif
365         if (wsi->protocol && wsi->protocol->per_session_data_size && wsi->user_space) /* user code may own */
366                 free(wsi->user_space);
367
368         free(wsi);
369 }
370
371 /**
372  * libwebsockets_hangup_on_client() - Server calls to terminate client
373  *                                      connection
374  * @context:    libwebsockets context
375  * @fd:         Connection socket descriptor
376  */
377
378 void
379 libwebsockets_hangup_on_client(struct libwebsocket_context *context, int fd)
380 {
381         struct libwebsocket *wsi = context->lws_lookup[fd];
382
383         if (wsi) {
384                 libwebsocket_close_and_free_session(context,
385                         wsi, LWS_CLOSE_STATUS_NOSTATUS);
386         } else
387                 close(fd);
388 }
389
390
391 /**
392  * libwebsockets_get_peer_addresses() - Get client address information
393  * @fd:         Connection socket descriptor
394  * @name:       Buffer to take client address name
395  * @name_len:   Length of client address name buffer
396  * @rip:        Buffer to take client address IP qotted quad
397  * @rip_len:    Length of client address IP buffer
398  *
399  *      This function fills in @name and @rip with the name and IP of
400  *      the client connected with socket descriptor @fd.  Names may be
401  *      truncated if there is not enough room.  If either cannot be
402  *      determined, they will be returned as valid zero-length strings.
403  */
404
405 void
406 libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
407                                         char *rip, int rip_len)
408 {
409         unsigned int len;
410         struct sockaddr_in sin;
411         struct hostent *host;
412         struct hostent *host1;
413         char ip[128];
414         unsigned char *p;
415         int n;
416 #ifdef AF_LOCAL
417     struct sockaddr_un *un;
418 #endif
419
420         rip[0] = '\0';
421         name[0] = '\0';
422
423         len = sizeof sin;
424         if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
425                 perror("getpeername");
426                 return;
427         }
428
429         host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
430                                                                        AF_INET);
431         if (host == NULL) {
432                 perror("gethostbyaddr");
433                 return;
434         }
435
436         strncpy(name, host->h_name, name_len);
437         name[name_len - 1] = '\0';
438
439         host1 = gethostbyname(host->h_name);
440         if (host1 == NULL)
441                 return;
442         p = (unsigned char *)host1;
443         n = 0;
444         while (p != NULL) {
445                 p = (unsigned char *)host1->h_addr_list[n++];
446                 if (p == NULL)
447                         continue;
448                 if ((host1->h_addrtype != AF_INET)
449 #ifdef AF_LOCAL
450                         && (host1->h_addrtype != AF_LOCAL)
451 #endif
452                         )
453                         continue;
454
455                 if (host1->h_addrtype == AF_INET)
456                         sprintf(ip, "%u.%u.%u.%u", p[0], p[1], p[2], p[3]);
457 #ifdef AF_LOCAL
458                 else {
459                         un = (struct sockaddr_un *)p;
460                         strncpy(ip, un->sun_path, sizeof(ip) - 1);
461                         ip[sizeof(ip) - 1] = '\0';
462                 }
463 #endif
464                 p = NULL;
465                 strncpy(rip, ip, rip_len);
466                 rip[rip_len - 1] = '\0';
467         }
468 }
469
470 int libwebsockets_get_random(struct libwebsocket_context *context,
471                                                              void *buf, int len)
472 {
473         int n;
474         char *p = (char *)buf;
475
476 #ifdef WIN32
477         for (n = 0; n < len; n++)
478                 p[n] = (unsigned char)rand();
479 #else
480         n = read(context->fd_random, p, len);
481 #endif
482
483         return n;
484 }
485
486 int lws_send_pipe_choked(struct libwebsocket *wsi)
487 {
488         struct pollfd fds;
489
490         fds.fd = wsi->sock;
491         fds.events = POLLOUT;
492         fds.revents = 0;
493
494         if (poll(&fds, 1, 0) != 1)
495                 return 1;
496
497         if ((fds.revents & POLLOUT) == 0)
498                 return 1;
499
500         /* okay to send another packet without blocking */
501
502         return 0;
503 }
504
505 int
506 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
507                                 struct libwebsocket *wsi, struct pollfd *pollfd)
508 {
509         int n;
510 #ifndef LWS_NO_EXTENSIONS
511         struct lws_tokens eff_buf;
512         int ret;
513         int m;
514         int handled = 0;
515
516         for (n = 0; n < wsi->count_active_extensions; n++) {
517                 if (!wsi->active_extensions[n]->callback)
518                         continue;
519
520                 m = wsi->active_extensions[n]->callback(context,
521                         wsi->active_extensions[n], wsi,
522                         LWS_EXT_CALLBACK_IS_WRITEABLE,
523                                        wsi->active_extensions_user[n], NULL, 0);
524                 if (m > handled)
525                         handled = m;
526         }
527
528         if (handled == 1)
529                 goto notify_action;
530
531         if (!wsi->extension_data_pending || handled == 2)
532                 goto user_service;
533
534         /*
535          * check in on the active extensions, see if they
536          * had pending stuff to spill... they need to get the
537          * first look-in otherwise sequence will be disordered
538          *
539          * NULL, zero-length eff_buf means just spill pending
540          */
541
542         ret = 1;
543         while (ret == 1) {
544
545                 /* default to nobody has more to spill */
546
547                 ret = 0;
548                 eff_buf.token = NULL;
549                 eff_buf.token_len = 0;
550
551                 /* give every extension a chance to spill */
552
553                 for (n = 0; n < wsi->count_active_extensions; n++) {
554                         m = wsi->active_extensions[n]->callback(
555                                 wsi->protocol->owning_server,
556                                 wsi->active_extensions[n], wsi,
557                                         LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
558                                    wsi->active_extensions_user[n], &eff_buf, 0);
559                         if (m < 0) {
560                                 lwsl_err("ext reports fatal error\n");
561                                 return -1;
562                         }
563                         if (m)
564                                 /*
565                                  * at least one extension told us he has more
566                                  * to spill, so we will go around again after
567                                  */
568                                 ret = 1;
569                 }
570
571                 /* assuming they gave us something to send, send it */
572
573                 if (eff_buf.token_len) {
574                         if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
575                                                              eff_buf.token_len))
576                                 return -1;
577                 } else
578                         continue;
579
580                 /* no extension has more to spill */
581
582                 if (!ret)
583                         continue;
584
585                 /*
586                  * There's more to spill from an extension, but we just sent
587                  * something... did that leave the pipe choked?
588                  */
589
590                 if (!lws_send_pipe_choked(wsi))
591                         /* no we could add more */
592                         continue;
593
594                 lwsl_info("choked in POLLOUT service\n");
595
596                 /*
597                  * Yes, he's choked.  Leave the POLLOUT masked on so we will
598                  * come back here when he is unchoked.  Don't call the user
599                  * callback to enforce ordering of spilling, he'll get called
600                  * when we come back here and there's nothing more to spill.
601                  */
602
603                 return 0;
604         }
605
606         wsi->extension_data_pending = 0;
607
608 user_service:
609 #endif
610         /* one shot */
611
612         if (pollfd) {
613                 pollfd->events &= ~POLLOUT;
614
615                 /* external POLL support via protocol 0 */
616                 context->protocols[0].callback(context, wsi,
617                         LWS_CALLBACK_CLEAR_MODE_POLL_FD,
618                         (void *)(long)wsi->sock, NULL, POLLOUT);
619         }
620 #ifndef LWS_NO_EXTENSIONS
621 notify_action:
622 #endif
623
624         if (wsi->mode == LWS_CONNMODE_WS_CLIENT)
625                 n = LWS_CALLBACK_CLIENT_WRITEABLE;
626         else
627                 n = LWS_CALLBACK_SERVER_WRITEABLE;
628
629         user_callback_handle_rxflow(wsi->protocol->callback, context,
630                 wsi, (enum libwebsocket_callback_reasons) n, wsi->user_space, NULL, 0);
631
632         return 0;
633 }
634
635
636
637 void
638 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
639                                      struct libwebsocket *wsi, unsigned int sec)
640 {
641 #ifndef LWS_NO_EXTENSIONS
642         int n;
643
644         /*
645          * if extensions want in on it (eg, we are a mux parent)
646          * give them a chance to service child timeouts
647          */
648
649         for (n = 0; n < wsi->count_active_extensions; n++)
650                 wsi->active_extensions[n]->callback(
651                                     context, wsi->active_extensions[n],
652                                     wsi, LWS_EXT_CALLBACK_1HZ,
653                                     wsi->active_extensions_user[n], NULL, sec);
654
655 #endif
656         if (!wsi->pending_timeout)
657                 return;
658
659         /*
660          * if we went beyond the allowed time, kill the
661          * connection
662          */
663
664         if (sec > wsi->pending_timeout_limit) {
665                 lwsl_info("TIMEDOUT WAITING\n");
666                 libwebsocket_close_and_free_session(context,
667                                 wsi, LWS_CLOSE_STATUS_NOSTATUS);
668         }
669 }
670
671 /**
672  * libwebsocket_service_fd() - Service polled socket with something waiting
673  * @context:    Websocket context
674  * @pollfd:     The pollfd entry describing the socket fd and which events
675  *              happened.
676  *
677  *      This function closes any active connections and then frees the
678  *      context.  After calling this, any further use of the context is
679  *      undefined.
680  */
681
682 int
683 libwebsocket_service_fd(struct libwebsocket_context *context,
684                                                           struct pollfd *pollfd)
685 {
686         struct libwebsocket *wsi;
687         unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 +
688                          MAX_BROADCAST_PAYLOAD + LWS_SEND_BUFFER_POST_PADDING];
689         int n;
690         int m;
691         struct timeval tv;
692 #ifndef LWS_NO_EXTENSIONS
693         int more = 1;
694 #endif
695         struct lws_tokens eff_buf;
696 #ifndef LWS_NO_CLIENT
697         extern int lws_client_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
698 #endif
699 #ifndef LWS_NO_SERVER
700         extern int lws_server_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
701 #endif
702         /*
703          * you can call us with pollfd = NULL to just allow the once-per-second
704          * global timeout checks; if less than a second since the last check
705          * it returns immediately then.
706          */
707
708         gettimeofday(&tv, NULL);
709
710         if (context->last_timeout_check_s != tv.tv_sec) {
711                 context->last_timeout_check_s = tv.tv_sec;
712
713                 /* if our parent went down, don't linger around */
714                 if (context->started_with_parent && kill(context->started_with_parent, 0) < 0)
715                         kill(getpid(), SIGTERM);
716
717                 /* global timeout check once per second */
718
719                 for (n = 0; n < context->fds_count; n++) {
720                         struct libwebsocket *new_wsi = context->lws_lookup[context->fds[n].fd];
721                         if (!new_wsi)
722                                 continue;
723                         libwebsocket_service_timeout_check(context,
724                                 new_wsi, tv.tv_sec);
725                 }
726         }
727
728         /* just here for timeout management? */
729
730         if (pollfd == NULL)
731                 return 0;
732
733         /* no, here to service a socket descriptor */
734
735         /*
736          * deal with listen service piggybacking
737          * every listen_service_modulo services of other fds, we
738          * sneak one in to service the listen socket if there's anything waiting
739          *
740          * To handle connection storms, as found in ab, if we previously saw a
741          * pending connection here, it causes us to check again next time.
742          */
743
744         if (context->listen_service_fd && pollfd->fd != context->listen_service_fd) {
745                 context->listen_service_count++;
746                 if (context->listen_service_extraseen ||
747                                 context->listen_service_count == context->listen_service_modulo) {
748                         context->listen_service_count = 0;
749                         m = 1;
750                         if (context->listen_service_extraseen > 5)
751                                 m = 2;
752                         while (m--) {
753                                 /* even with extpoll, we prepared this internal fds for listen */
754                                 n = poll(&context->fds[0], 1, 0);
755                                 if (n > 0) { /* there's a connection waiting for us */
756                                         libwebsocket_service_fd(context, &context->fds[0]);
757                                         context->listen_service_extraseen++;
758                                 } else {
759                                         if (context->listen_service_extraseen)
760                                                 context->listen_service_extraseen--;
761                                         break;
762                                 }
763                         }
764                 }
765
766         }
767
768         /* okay, what we came here to do... */
769
770         wsi = context->lws_lookup[pollfd->fd];
771         if (wsi == NULL) {
772                 if (pollfd->fd > 11)
773                         lwsl_err("unexpected NULL wsi fd=%d fds_count=%d\n", pollfd->fd, context->fds_count);
774                 return 0;
775         }
776
777         switch (wsi->mode) {
778
779 #ifndef LWS_NO_SERVER
780         case LWS_CONNMODE_HTTP_SERVING:
781         case LWS_CONNMODE_SERVER_LISTENER:
782         case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
783         case LWS_CONNMODE_BROADCAST_PROXY:
784                 return lws_server_socket_service(context, wsi, pollfd);
785 #endif
786
787         case LWS_CONNMODE_WS_SERVING:
788         case LWS_CONNMODE_WS_CLIENT:
789
790                 /* handle session socket closed */
791
792                 if (pollfd->revents & (POLLERR | POLLHUP)) {
793
794                         lwsl_debug("Session Socket %p (fd=%d) dead\n",
795                                 (void *)wsi, pollfd->fd);
796
797                         libwebsocket_close_and_free_session(context, wsi,
798                                                      LWS_CLOSE_STATUS_NOSTATUS);
799                         return 0;
800                 }
801
802                 /* the guy requested a callback when it was OK to write */
803
804                 if ((pollfd->revents & POLLOUT) &&
805                                             wsi->state == WSI_STATE_ESTABLISHED)
806                         if (lws_handle_POLLOUT_event(context, wsi,
807                                                                   pollfd) < 0) {
808                                 libwebsocket_close_and_free_session(
809                                          context, wsi, LWS_CLOSE_STATUS_NORMAL);
810                                 return 0;
811                         }
812
813
814                 /* any incoming data ready? */
815
816                 if (!(pollfd->revents & POLLIN))
817                         break;
818
819 #ifdef LWS_OPENSSL_SUPPORT
820 read_pending:
821                 if (wsi->ssl)
822                         eff_buf.token_len = SSL_read(wsi->ssl, buf, sizeof buf);
823                 else
824 #endif
825                         eff_buf.token_len =
826                                            recv(pollfd->fd, buf, sizeof buf, 0);
827
828                 if (eff_buf.token_len < 0) {
829                         lwsl_debug("Socket read returned %d\n",
830                                                             eff_buf.token_len);
831                         if (errno != EINTR && errno != EAGAIN)
832                                 libwebsocket_close_and_free_session(context,
833                                                wsi, LWS_CLOSE_STATUS_NOSTATUS);
834                         return 0;
835                 }
836                 if (!eff_buf.token_len) {
837                         libwebsocket_close_and_free_session(context, wsi,
838                                                     LWS_CLOSE_STATUS_NOSTATUS);
839                         return 0;
840                 }
841
842                 /*
843                  * give any active extensions a chance to munge the buffer
844                  * before parse.  We pass in a pointer to an lws_tokens struct
845                  * prepared with the default buffer and content length that's in
846                  * there.  Rather than rewrite the default buffer, extensions
847                  * that expect to grow the buffer can adapt .token to
848                  * point to their own per-connection buffer in the extension
849                  * user allocation.  By default with no extensions or no
850                  * extension callback handling, just the normal input buffer is
851                  * used then so it is efficient.
852                  */
853
854                 eff_buf.token = (char *)buf;
855 #ifndef LWS_NO_EXTENSIONS
856                 more = 1;
857                 while (more) {
858
859                         more = 0;
860
861                         for (n = 0; n < wsi->count_active_extensions; n++) {
862                                 m = wsi->active_extensions[n]->callback(context,
863                                         wsi->active_extensions[n], wsi,
864                                         LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
865                                         wsi->active_extensions_user[n],
866                                                                    &eff_buf, 0);
867                                 if (m < 0) {
868                                         lwsl_ext(
869                                             "Extension reports fatal error\n");
870                                         libwebsocket_close_and_free_session(
871                                                 context, wsi,
872                                                     LWS_CLOSE_STATUS_NOSTATUS);
873                                         return 0;
874                                 }
875                                 if (m)
876                                         more = 1;
877                         }
878 #endif
879                         /* service incoming data */
880
881                         if (eff_buf.token_len) {
882                                 n = libwebsocket_read(context, wsi,
883                                         (unsigned char *)eff_buf.token,
884                                                             eff_buf.token_len);
885                                 if (n < 0)
886                                         /* we closed wsi */
887                                         return 0;
888                         }
889 #ifndef LWS_NO_EXTENSIONS
890                         eff_buf.token = NULL;
891                         eff_buf.token_len = 0;
892                 }
893 #endif
894
895 #ifdef LWS_OPENSSL_SUPPORT
896                 if (wsi->ssl && SSL_pending(wsi->ssl))
897                         goto read_pending;
898 #endif
899                 break;
900
901         default:
902 #ifdef LWS_NO_CLIENT
903                 break;
904 #else
905                 return  lws_client_socket_service(context, wsi, pollfd);
906 #endif
907         }
908
909         return 0;
910 }
911
912
913 /**
914  * libwebsocket_context_destroy() - Destroy the websocket context
915  * @context:    Websocket context
916  *
917  *      This function closes any active connections and then frees the
918  *      context.  After calling this, any further use of the context is
919  *      undefined.
920  */
921 void
922 libwebsocket_context_destroy(struct libwebsocket_context *context)
923 {
924 #ifndef LWS_NO_EXTENSIONS
925         int n;
926         int m;
927         struct libwebsocket_extension *ext;
928
929         for (n = 0; n < context->fds_count; n++) {
930                 struct libwebsocket *wsi = context->lws_lookup[context->fds[n].fd];
931                 libwebsocket_close_and_free_session(context,
932                         wsi, LWS_CLOSE_STATUS_GOINGAWAY);
933         }
934
935         /*
936          * give all extensions a chance to clean up any per-context
937          * allocations they might have made
938          */
939
940         ext = context->extensions;
941         m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_DESTRUCT;
942         if (context->listen_port)
943                 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_DESTRUCT;
944         while (ext && ext->callback) {
945                 ext->callback(context, ext, NULL, (enum libwebsocket_extension_callback_reasons)m, NULL, NULL, 0);
946                 ext++;
947         }
948 #endif
949
950 #ifdef WIN32
951 #else
952         close(context->fd_random);
953 #endif
954
955 #ifdef LWS_OPENSSL_SUPPORT
956         if (context->ssl_ctx)
957                 SSL_CTX_free(context->ssl_ctx);
958         if (context->ssl_client_ctx)
959                 SSL_CTX_free(context->ssl_client_ctx);
960 #endif
961
962         free(context);
963
964 #ifdef WIN32
965         WSACleanup();
966 #endif
967 }
968
969 LWS_EXTERN void *
970 libwebsocket_context_user(struct libwebsocket_context *context)
971 {
972     return context->user_space;
973 }
974
975 /**
976  * libwebsocket_service() - Service any pending websocket activity
977  * @context:    Websocket context
978  * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
979  *              service otherwise block and service immediately, returning
980  *              after the timeout if nothing needed service.
981  *
982  *      This function deals with any pending websocket traffic, for three
983  *      kinds of event.  It handles these events on both server and client
984  *      types of connection the same.
985  *
986  *      1) Accept new connections to our context's server
987  *
988  *      2) Perform pending broadcast writes initiated from other forked
989  *         processes (effectively serializing asynchronous broadcasts)
990  *
991  *      3) Call the receive callback for incoming frame data received by
992  *          server or client connections.
993  *
994  *      You need to call this service function periodically to all the above
995  *      functions to happen; if your application is single-threaded you can
996  *      just call it in your main event loop.
997  *
998  *      Alternatively you can fork a new process that asynchronously handles
999  *      calling this service in a loop.  In that case you are happy if this
1000  *      call blocks your thread until it needs to take care of something and
1001  *      would call it with a large nonzero timeout.  Your loop then takes no
1002  *      CPU while there is nothing happening.
1003  *
1004  *      If you are calling it in a single-threaded app, you don't want it to
1005  *      wait around blocking other things in your loop from happening, so you
1006  *      would call it with a timeout_ms of 0, so it returns immediately if
1007  *      nothing is pending, or as soon as it services whatever was pending.
1008  */
1009
1010
1011 int
1012 libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
1013 {
1014         int n;
1015
1016         /* stay dead once we are dead */
1017
1018         if (context == NULL)
1019                 return 1;
1020
1021         /* wait for something to need service */
1022
1023         n = poll(context->fds, context->fds_count, timeout_ms);
1024         if (n == 0) /* poll timeout */
1025                 return 0;
1026
1027         if (n < 0)
1028                 return -1;
1029
1030         /* any socket with events to service? */
1031
1032         for (n = 0; n < context->fds_count; n++)
1033                 if (context->fds[n].revents)
1034                         if (libwebsocket_service_fd(context,
1035                                                         &context->fds[n]) < 0)
1036                                 return -1;
1037         return 0;
1038 }
1039
1040 #ifndef LWS_NO_EXTENSIONS
1041 int
1042 lws_any_extension_handled(struct libwebsocket_context *context,
1043                           struct libwebsocket *wsi,
1044                           enum libwebsocket_extension_callback_reasons r,
1045                                                        void *v, size_t len)
1046 {
1047         int n;
1048         int handled = 0;
1049
1050         /* maybe an extension will take care of it for us */
1051
1052         for (n = 0; n < wsi->count_active_extensions && !handled; n++) {
1053                 if (!wsi->active_extensions[n]->callback)
1054                         continue;
1055
1056                 handled |= wsi->active_extensions[n]->callback(context,
1057                         wsi->active_extensions[n], wsi,
1058                         r, wsi->active_extensions_user[n], v, len);
1059         }
1060
1061         return handled;
1062 }
1063
1064
1065 void *
1066 lws_get_extension_user_matching_ext(struct libwebsocket *wsi,
1067                                            struct libwebsocket_extension *ext)
1068 {
1069         int n = 0;
1070
1071         if (wsi == NULL)
1072                 return NULL;
1073
1074         while (n < wsi->count_active_extensions) {
1075                 if (wsi->active_extensions[n] != ext) {
1076                         n++;
1077                         continue;
1078                 }
1079                 return wsi->active_extensions_user[n];
1080         }
1081
1082         return NULL;
1083 }
1084 #endif
1085
1086 /**
1087  * libwebsocket_callback_on_writable() - Request a callback when this socket
1088  *                                       becomes able to be written to without
1089  *                                       blocking
1090  *
1091  * @context:    libwebsockets context
1092  * @wsi:        Websocket connection instance to get callback for
1093  */
1094
1095 int
1096 libwebsocket_callback_on_writable(struct libwebsocket_context *context,
1097                                                       struct libwebsocket *wsi)
1098 {
1099 #ifndef LWS_NO_EXTENSIONS
1100         int n;
1101         int handled = 0;
1102
1103         /* maybe an extension will take care of it for us */
1104
1105         for (n = 0; n < wsi->count_active_extensions; n++) {
1106                 if (!wsi->active_extensions[n]->callback)
1107                         continue;
1108
1109                 handled |= wsi->active_extensions[n]->callback(context,
1110                         wsi->active_extensions[n], wsi,
1111                         LWS_EXT_CALLBACK_REQUEST_ON_WRITEABLE,
1112                                        wsi->active_extensions_user[n], NULL, 0);
1113         }
1114
1115         if (handled)
1116                 return 1;
1117 #endif
1118         if (wsi->position_in_fds_table < 0) {
1119                 lwsl_err("libwebsocket_callback_on_writable: "
1120                                       "failed to find socket %d\n", wsi->sock);
1121                 return -1;
1122         }
1123
1124         context->fds[wsi->position_in_fds_table].events |= POLLOUT;
1125
1126         /* external POLL support via protocol 0 */
1127         context->protocols[0].callback(context, wsi,
1128                 LWS_CALLBACK_SET_MODE_POLL_FD,
1129                 (void *)(long)wsi->sock, NULL, POLLOUT);
1130
1131         return 1;
1132 }
1133
1134 /**
1135  * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
1136  *                      all connections using the given protocol when it
1137  *                      becomes possible to write to each socket without
1138  *                      blocking in turn.
1139  *
1140  * @protocol:   Protocol whose connections will get callbacks
1141  */
1142
1143 int
1144 libwebsocket_callback_on_writable_all_protocol(
1145                                   const struct libwebsocket_protocols *protocol)
1146 {
1147         struct libwebsocket_context *context = protocol->owning_server;
1148         int n;
1149         struct libwebsocket *wsi;
1150
1151         for (n = 0; n < context->fds_count; n++) {
1152                 wsi = context->lws_lookup[context->fds[n].fd];
1153                 if (!wsi)
1154                         continue;
1155                 if (wsi->protocol == protocol)
1156                         libwebsocket_callback_on_writable(context, wsi);
1157         }
1158
1159         return 0;
1160 }
1161
1162 /**
1163  * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
1164  *
1165  * You will not need this unless you are doing something special
1166  *
1167  * @wsi:        Websocket connection instance
1168  * @reason:     timeout reason
1169  * @secs:       how many seconds
1170  */
1171
1172 void
1173 libwebsocket_set_timeout(struct libwebsocket *wsi,
1174                                           enum pending_timeout reason, int secs)
1175 {
1176         struct timeval tv;
1177
1178         gettimeofday(&tv, NULL);
1179
1180         wsi->pending_timeout_limit = tv.tv_sec + secs;
1181         wsi->pending_timeout = reason;
1182 }
1183
1184
1185 /**
1186  * libwebsocket_get_socket_fd() - returns the socket file descriptor
1187  *
1188  * You will not need this unless you are doing something special
1189  *
1190  * @wsi:        Websocket connection instance
1191  */
1192
1193 int
1194 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
1195 {
1196         return wsi->sock;
1197 }
1198
1199 #ifdef LWS_NO_SERVER
1200 int
1201 _libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1202 {
1203         return 0;
1204 }
1205 #else
1206 int
1207 _libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1208 {
1209         struct libwebsocket_context *context = wsi->protocol->owning_server;
1210         int n;
1211
1212         if (!(wsi->rxflow_change_to & 2))
1213                 return 0;
1214
1215         wsi->rxflow_change_to &= ~2;
1216
1217         lwsl_info("rxflow: wsi %p change_to %d\n", wsi, wsi->rxflow_change_to);
1218
1219         /* if we're letting it come again, did we interrupt anything? */
1220         if ((wsi->rxflow_change_to & 1) && wsi->rxflow_buffer) {
1221                 n = libwebsocket_interpret_incoming_packet(wsi, NULL, 0);
1222                 if (n < 0) {
1223                         libwebsocket_close_and_free_session(context, wsi, LWS_CLOSE_STATUS_NOSTATUS);
1224                         return -1;
1225                 }
1226                 if (n)
1227                         /* oh he stuck again, do nothing */
1228                         return 0;
1229         }
1230
1231         if (wsi->rxflow_change_to & 1)
1232                 context->fds[wsi->position_in_fds_table].events |= POLLIN;
1233         else
1234                 context->fds[wsi->position_in_fds_table].events &= ~POLLIN;
1235
1236         if (wsi->rxflow_change_to & 1)
1237                 /* external POLL support via protocol 0 */
1238                 context->protocols[0].callback(context, wsi,
1239                         LWS_CALLBACK_SET_MODE_POLL_FD,
1240                         (void *)(long)wsi->sock, NULL, POLLIN);
1241         else
1242                 /* external POLL support via protocol 0 */
1243                 context->protocols[0].callback(context, wsi,
1244                         LWS_CALLBACK_CLEAR_MODE_POLL_FD,
1245                         (void *)(long)wsi->sock, NULL, POLLIN);
1246
1247         return 1;
1248 }
1249 #endif
1250
1251 /**
1252  * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
1253  *                              receieved packets.
1254  *
1255  * If the output side of a server process becomes choked, this allows flow
1256  * control for the input side.
1257  *
1258  * @wsi:        Websocket connection instance to get callback for
1259  * @enable:     0 = disable read servicing for this connection, 1 = enable
1260  */
1261
1262 int
1263 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
1264 {
1265         wsi->rxflow_change_to = 2 | !!enable;
1266
1267         return 0;
1268 }
1269
1270
1271 /**
1272  * libwebsocket_canonical_hostname() - returns this host's hostname
1273  *
1274  * This is typically used by client code to fill in the host parameter
1275  * when making a client connection.  You can only call it after the context
1276  * has been created.
1277  *
1278  * @context:    Websocket context
1279  */
1280
1281
1282 extern const char *
1283 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
1284 {
1285         return (const char *)context->canonical_hostname;
1286 }
1287
1288
1289 static void sigpipe_handler(int x)
1290 {
1291 }
1292
1293 #ifdef LWS_OPENSSL_SUPPORT
1294 static int
1295 OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
1296 {
1297
1298         SSL *ssl;
1299         int n;
1300         struct libwebsocket_context *context;
1301
1302         ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
1303                 SSL_get_ex_data_X509_STORE_CTX_idx());
1304
1305         /*
1306          * !!! nasty openssl requires the index to come as a library-scope
1307          * static
1308          */
1309         context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
1310
1311         n = context->protocols[0].callback(NULL, NULL,
1312                 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
1313                                                    x509_ctx, ssl, preverify_ok);
1314
1315         /* convert return code from 0 = OK to 1 = OK */
1316
1317         if (!n)
1318                 n = 1;
1319         else
1320                 n = 0;
1321
1322         return n;
1323 }
1324 #endif
1325
1326 int user_callback_handle_rxflow(callback_function callback_function,
1327                 struct libwebsocket_context * context,
1328                         struct libwebsocket *wsi,
1329                          enum libwebsocket_callback_reasons reason, void *user,
1330                                                           void *in, size_t len)
1331 {
1332         int n;
1333
1334         n = callback_function(context, wsi, reason, user, in, len);
1335         if (n < 0)
1336                 return n;
1337
1338         _libwebsocket_rx_flow_control(wsi);
1339
1340         return 0;
1341 }
1342
1343
1344 /**
1345  * libwebsocket_create_context() - Create the websocket handler
1346  * @port:       Port to listen on... you can use 0 to suppress listening on
1347  *              any port, that's what you want if you are not running a
1348  *              websocket server at all but just using it as a client
1349  * @interf:  NULL to bind the listen socket to all interfaces, or the
1350  *              interface name, eg, "eth2"
1351  * @protocols:  Array of structures listing supported protocols and a protocol-
1352  *              specific callback for each one.  The list is ended with an
1353  *              entry that has a NULL callback pointer.
1354  *              It's not const because we write the owning_server member
1355  * @extensions: NULL or array of libwebsocket_extension structs listing the
1356  *              extensions this context supports.  If you configured with
1357  *              --without-extensions, you should give NULL here.
1358  * @ssl_cert_filepath:  If libwebsockets was compiled to use ssl, and you want
1359  *                      to listen using SSL, set to the filepath to fetch the
1360  *                      server cert from, otherwise NULL for unencrypted
1361  * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
1362  *                      else ignored
1363  * @ssl_ca_filepath: CA certificate filepath or NULL
1364  * @gid:        group id to change to after setting listen socket, or -1.
1365  * @uid:        user id to change to after setting listen socket, or -1.
1366  * @options:    0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
1367  * @user:       optional user pointer that can be recovered via the context
1368  *              pointer using libwebsocket_context_user 
1369  *
1370  *      This function creates the listening socket and takes care
1371  *      of all initialization in one step.
1372  *
1373  *      After initialization, it returns a struct libwebsocket_context * that
1374  *      represents this server.  After calling, user code needs to take care
1375  *      of calling libwebsocket_service() with the context pointer to get the
1376  *      server's sockets serviced.  This can be done in the same process context
1377  *      or a forked process, or another thread,
1378  *
1379  *      The protocol callback functions are called for a handful of events
1380  *      including http requests coming in, websocket connections becoming
1381  *      established, and data arriving; it's also called periodically to allow
1382  *      async transmission.
1383  *
1384  *      HTTP requests are sent always to the FIRST protocol in @protocol, since
1385  *      at that time websocket protocol has not been negotiated.  Other
1386  *      protocols after the first one never see any HTTP callack activity.
1387  *
1388  *      The server created is a simple http server by default; part of the
1389  *      websocket standard is upgrading this http connection to a websocket one.
1390  *
1391  *      This allows the same server to provide files like scripts and favicon /
1392  *      images or whatever over http and dynamic data over websockets all in
1393  *      one place; they're all handled in the user callback.
1394  */
1395
1396 struct libwebsocket_context *
1397 libwebsocket_create_context(int port, const char *interf,
1398                                struct libwebsocket_protocols *protocols,
1399                                struct libwebsocket_extension *extensions,
1400                                const char *ssl_cert_filepath,
1401                                const char *ssl_private_key_filepath,
1402                                const char *ssl_ca_filepath,
1403                                int gid, int uid, unsigned int options,
1404                                void *user)
1405 {
1406         int n;
1407         struct sockaddr_in serv_addr;
1408         int opt = 1;
1409         struct libwebsocket_context *context = NULL;
1410 #ifndef LWS_NO_FORK
1411         unsigned int slen;
1412         struct sockaddr_in cli_addr;
1413         int fd;
1414 #endif
1415         char *p;
1416         struct libwebsocket *wsi;
1417 #ifndef LWS_NO_EXTENSIONS
1418         int m;
1419 #endif
1420
1421 #ifdef LWS_OPENSSL_SUPPORT
1422         SSL_METHOD *method;
1423         char ssl_err_buf[512];
1424 #endif
1425
1426         lwsl_notice("Initial logging level %d\n", log_level);
1427         lwsl_info(" LWS_MAX_HEADER_NAME_LENGTH: %u\n", LWS_MAX_HEADER_NAME_LENGTH);
1428         lwsl_info(" LWS_MAX_HEADER_LEN: %u\n", LWS_MAX_HEADER_LEN);
1429         lwsl_info(" LWS_INITIAL_HDR_ALLOC: %u\n", LWS_INITIAL_HDR_ALLOC);
1430         lwsl_info(" LWS_ADDITIONAL_HDR_ALLOC: %u\n", LWS_ADDITIONAL_HDR_ALLOC);
1431         lwsl_info(" MAX_USER_RX_BUFFER: %u\n", MAX_USER_RX_BUFFER);
1432         lwsl_info(" MAX_BROADCAST_PAYLOAD: %u\n", MAX_BROADCAST_PAYLOAD);
1433         lwsl_info(" LWS_MAX_PROTOCOLS: %u\n", LWS_MAX_PROTOCOLS);
1434 #ifndef LWS_NO_EXTENSIONS
1435         lwsl_info(" LWS_MAX_EXTENSIONS_ACTIVE: %u\n", LWS_MAX_EXTENSIONS_ACTIVE);
1436 #else
1437         lwsl_notice(" Configured without extension support\n");
1438 #endif
1439         lwsl_info(" SPEC_LATEST_SUPPORTED: %u\n", SPEC_LATEST_SUPPORTED);
1440         lwsl_info(" AWAITING_TIMEOUT: %u\n", AWAITING_TIMEOUT);
1441         lwsl_info(" CIPHERS_LIST_STRING: '%s'\n", CIPHERS_LIST_STRING);
1442         lwsl_info(" SYSTEM_RANDOM_FILEPATH: '%s'\n", SYSTEM_RANDOM_FILEPATH);
1443         lwsl_info(" LWS_MAX_ZLIB_CONN_BUFFER: %u\n", LWS_MAX_ZLIB_CONN_BUFFER);
1444
1445 #ifdef _WIN32
1446         {
1447                 WORD wVersionRequested;
1448                 WSADATA wsaData;
1449                 int err;
1450                 HMODULE wsdll;
1451
1452                 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
1453                 wVersionRequested = MAKEWORD(2, 2);
1454
1455                 err = WSAStartup(wVersionRequested, &wsaData);
1456                 if (err != 0) {
1457                         /* Tell the user that we could not find a usable */
1458                         /* Winsock DLL.                                  */
1459                         lwsl_err("WSAStartup failed with error: %d\n", err);
1460                         return NULL;
1461                 }
1462
1463                 /* default to a poll() made out of select() */
1464                 poll = emulated_poll;
1465
1466                 /* if windows socket lib available, use his WSAPoll */
1467                 wsdll = GetModuleHandle(_T("Ws2_32.dll"));
1468                 if (wsdll)
1469                         poll = (PFNWSAPOLL)GetProcAddress(wsdll, "WSAPoll");
1470         }
1471 #endif
1472
1473         context = (struct libwebsocket_context *) malloc(sizeof(struct libwebsocket_context));
1474         if (!context) {
1475                 lwsl_err("No memory for websocket context\n");
1476                 return NULL;
1477         }
1478 #ifndef NO_DAEMONIZE
1479         extern int pid_daemon;
1480         context->started_with_parent = pid_daemon;
1481         lwsl_notice(" Started with daemon pid %d\n", pid_daemon);
1482 #endif
1483
1484         context->protocols = protocols;
1485         context->listen_port = port;
1486         context->http_proxy_port = 0;
1487         context->http_proxy_address[0] = '\0';
1488         context->options = options;
1489         /* to reduce this allocation, */
1490         context->max_fds = getdtablesize();
1491         lwsl_notice(" max fd tracked: %u\n", context->max_fds);
1492         lwsl_notice(" static allocation: %u bytes\n",
1493                 (sizeof(struct pollfd) * context->max_fds) +
1494                 (sizeof(struct libwebsocket *) * context->max_fds));
1495
1496         context->fds = (struct pollfd *)malloc(sizeof(struct pollfd) * context->max_fds);
1497         if (context->fds == NULL) {
1498                 lwsl_err("Unable to allocate fds array for %d connections\n", context->max_fds);
1499                 free(context);
1500                 return NULL;
1501         }
1502         context->lws_lookup = (struct libwebsocket **)malloc(sizeof(struct libwebsocket *) * context->max_fds);
1503         if (context->lws_lookup == NULL) {
1504                 lwsl_err("Unable to allocate lws_lookup array for %d connections\n", context->max_fds);
1505                 free(context->fds);
1506                 free(context);
1507                 return NULL;
1508         }
1509
1510         context->fds_count = 0;
1511 #ifndef LWS_NO_EXTENSIONS
1512         context->extensions = extensions;
1513 #endif
1514         context->last_timeout_check_s = 0;
1515         context->user_space = user;
1516
1517 #ifdef WIN32
1518         context->fd_random = 0;
1519 #else
1520         context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
1521         if (context->fd_random < 0) {
1522                 free(context);
1523                 lwsl_err("Unable to open random device %s %d\n",
1524                                     SYSTEM_RANDOM_FILEPATH, context->fd_random);
1525                 return NULL;
1526         }
1527 #endif
1528
1529 #ifdef LWS_OPENSSL_SUPPORT
1530         context->use_ssl = 0;
1531         context->ssl_ctx = NULL;
1532         context->ssl_client_ctx = NULL;
1533         openssl_websocket_private_data_index = 0;
1534 #endif
1535
1536         strcpy(context->canonical_hostname, "unknown");
1537
1538 #ifndef LWS_NO_SERVER
1539         if (!(options & LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME)) {
1540                 struct sockaddr sa;
1541                 char hostname[1024] = "";
1542
1543                 /* find canonical hostname */
1544
1545                 hostname[(sizeof hostname) - 1] = '\0';
1546                 memset(&sa, 0, sizeof(sa));
1547                 sa.sa_family = AF_INET;
1548                 sa.sa_data[(sizeof sa.sa_data) - 1] = '\0';
1549                 gethostname(hostname, (sizeof hostname) - 1);
1550
1551                 n = 0;
1552
1553                 if (strlen(hostname) < sizeof(sa.sa_data) - 1) {
1554                         strcpy(sa.sa_data, hostname);
1555         //              lwsl_debug("my host name is %s\n", sa.sa_data);
1556                         n = getnameinfo(&sa, sizeof(sa), hostname,
1557                                 (sizeof hostname) - 1, NULL, 0, 0);
1558                 }
1559
1560                 if (!n) {
1561                         strncpy(context->canonical_hostname, hostname,
1562                                                 sizeof context->canonical_hostname - 1);
1563                         context->canonical_hostname[
1564                                         sizeof context->canonical_hostname - 1] = '\0';
1565                 } else
1566                         strncpy(context->canonical_hostname, hostname,
1567                                                 sizeof context->canonical_hostname - 1);
1568
1569                 lwsl_notice(" canonical_hostname = %s\n", context->canonical_hostname);
1570         }
1571 #endif
1572
1573         /* split the proxy ads:port if given */
1574
1575         p = getenv("http_proxy");
1576         if (p) {
1577                 strncpy(context->http_proxy_address, p,
1578                                        sizeof context->http_proxy_address - 1);
1579                 context->http_proxy_address[
1580                                  sizeof context->http_proxy_address - 1] = '\0';
1581
1582                 p = strchr(context->http_proxy_address, ':');
1583                 if (p == NULL) {
1584                         lwsl_err("http_proxy needs to be ads:port\n");
1585                         return NULL;
1586                 }
1587                 *p = '\0';
1588                 context->http_proxy_port = atoi(p + 1);
1589
1590                 lwsl_notice(" Proxy %s:%u\n",
1591                                 context->http_proxy_address,
1592                                                       context->http_proxy_port);
1593         }
1594
1595 #ifndef LWS_NO_SERVER
1596         if (port) {
1597
1598 #ifdef LWS_OPENSSL_SUPPORT
1599                 context->use_ssl = ssl_cert_filepath != NULL &&
1600                                                ssl_private_key_filepath != NULL;
1601                 if (context->use_ssl)
1602                         lwsl_notice(" Compiled with SSL support, using it\n");
1603                 else
1604                         lwsl_notice(" Compiled with SSL support, not using it\n");
1605
1606 #else
1607                 if (ssl_cert_filepath != NULL &&
1608                                              ssl_private_key_filepath != NULL) {
1609                         lwsl_notice(" Not compiled for OpenSSl support!\n");
1610                         return NULL;
1611                 }
1612                 lwsl_notice(" Compiled without SSL support, "
1613                                                        "serving unencrypted\n");
1614 #endif
1615
1616                 lwsl_notice(" per-connection allocation: %u + headers\n", sizeof(struct libwebsocket));
1617         }
1618 #endif
1619
1620         /* ignore SIGPIPE */
1621 #ifdef WIN32
1622 #else
1623         signal(SIGPIPE, sigpipe_handler);
1624 #endif
1625
1626
1627 #ifdef LWS_OPENSSL_SUPPORT
1628
1629         /* basic openssl init */
1630
1631         SSL_library_init();
1632
1633         OpenSSL_add_all_algorithms();
1634         SSL_load_error_strings();
1635
1636         openssl_websocket_private_data_index =
1637                 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
1638
1639         /*
1640          * Firefox insists on SSLv23 not SSLv3
1641          * Konq disables SSLv2 by default now, SSLv23 works
1642          */
1643
1644         method = (SSL_METHOD *)SSLv23_server_method();
1645         if (!method) {
1646                 lwsl_err("problem creating ssl method: %s\n",
1647                         ERR_error_string(ERR_get_error(), ssl_err_buf));
1648                 return NULL;
1649         }
1650         context->ssl_ctx = SSL_CTX_new(method); /* create context */
1651         if (!context->ssl_ctx) {
1652                 lwsl_err("problem creating ssl context: %s\n",
1653                         ERR_error_string(ERR_get_error(), ssl_err_buf));
1654                 return NULL;
1655         }
1656
1657 #ifdef SSL_OP_NO_COMPRESSION
1658         SSL_CTX_set_options(context->ssl_ctx, SSL_OP_NO_COMPRESSION);
1659 #endif
1660         SSL_CTX_set_options(context->ssl_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
1661         SSL_CTX_set_cipher_list(context->ssl_ctx, CIPHERS_LIST_STRING);
1662
1663 #ifndef LWS_NO_CLIENT
1664
1665         /* client context */
1666
1667         if (port == CONTEXT_PORT_NO_LISTEN) {
1668                 method = (SSL_METHOD *)SSLv23_client_method();
1669                 if (!method) {
1670                         lwsl_err("problem creating ssl method: %s\n",
1671                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
1672                         return NULL;
1673                 }
1674                 /* create context */
1675                 context->ssl_client_ctx = SSL_CTX_new(method);
1676                 if (!context->ssl_client_ctx) {
1677                         lwsl_err("problem creating ssl context: %s\n",
1678                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
1679                         return NULL;
1680                 }
1681
1682 #ifdef SSL_OP_NO_COMPRESSION
1683                 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_NO_COMPRESSION);
1684 #endif
1685                 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
1686                 SSL_CTX_set_cipher_list(context->ssl_client_ctx, CIPHERS_LIST_STRING);
1687
1688                 /* openssl init for cert verification (for client sockets) */
1689                 if (!ssl_ca_filepath) {
1690                         if (!SSL_CTX_load_verify_locations(
1691                                 context->ssl_client_ctx, NULL,
1692                                                      LWS_OPENSSL_CLIENT_CERTS))
1693                                 lwsl_err(
1694                                         "Unable to load SSL Client certs from %s "
1695                                         "(set by --with-client-cert-dir= in configure) -- "
1696                                         " client ssl isn't going to work",
1697                                                      LWS_OPENSSL_CLIENT_CERTS);
1698                 } else
1699                         if (!SSL_CTX_load_verify_locations(
1700                                 context->ssl_client_ctx, ssl_ca_filepath,
1701                                                                   NULL))
1702                                 lwsl_err(
1703                                         "Unable to load SSL Client certs "
1704                                         "file from %s -- client ssl isn't "
1705                                         "going to work", ssl_ca_filepath);
1706
1707                 /*
1708                  * callback allowing user code to load extra verification certs
1709                  * helping the client to verify server identity
1710                  */
1711
1712                 context->protocols[0].callback(context, NULL,
1713                         LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
1714                         context->ssl_client_ctx, NULL, 0);
1715         }
1716 #endif
1717
1718         /* as a server, are we requiring clients to identify themselves? */
1719
1720         if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
1721
1722                 /* absolutely require the client cert */
1723
1724                 SSL_CTX_set_verify(context->ssl_ctx,
1725                        SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
1726                                                        OpenSSL_verify_callback);
1727
1728                 /*
1729                  * give user code a chance to load certs into the server
1730                  * allowing it to verify incoming client certs
1731                  */
1732
1733                 context->protocols[0].callback(context, NULL,
1734                         LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
1735                                                      context->ssl_ctx, NULL, 0);
1736         }
1737
1738         if (context->use_ssl) {
1739
1740                 /* openssl init for server sockets */
1741
1742                 /* set the local certificate from CertFile */
1743                 n = SSL_CTX_use_certificate_chain_file(context->ssl_ctx,
1744                                         ssl_cert_filepath);
1745                 if (n != 1) {
1746                         lwsl_err("problem getting cert '%s': %s\n",
1747                                 ssl_cert_filepath,
1748                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
1749                         return NULL;
1750                 }
1751                 /* set the private key from KeyFile */
1752                 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
1753                              ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
1754                         lwsl_err("ssl problem getting key '%s': %s\n",
1755                                                 ssl_private_key_filepath,
1756                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
1757                         return NULL;
1758                 }
1759                 /* verify private key */
1760                 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
1761                         lwsl_err("Private SSL key doesn't match cert\n");
1762                         return NULL;
1763                 }
1764
1765                 /* SSL is happy and has a cert it's content with */
1766         }
1767 #endif
1768
1769         /* selftest */
1770
1771         if (lws_b64_selftest())
1772                 return NULL;
1773
1774 #ifndef LWS_NO_SERVER
1775         /* set up our external listening socket we serve on */
1776
1777         if (port) {
1778                 extern int interface_to_sa(const char *ifname, struct sockaddr_in *addr, size_t addrlen);
1779                 int sockfd;
1780
1781                 sockfd = socket(AF_INET, SOCK_STREAM, 0);
1782                 if (sockfd < 0) {
1783                         lwsl_err("ERROR opening socket\n");
1784                         return NULL;
1785                 }
1786
1787                 /* allow us to restart even if old sockets in TIME_WAIT */
1788                 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR,
1789                                               (const void *)&opt, sizeof(opt));
1790
1791                 /* Disable Nagle */
1792                 opt = 1;
1793                 setsockopt(sockfd, IPPROTO_TCP, TCP_NODELAY,
1794                                               (const void *)&opt, sizeof(opt));
1795
1796                 bzero((char *) &serv_addr, sizeof(serv_addr));
1797                 serv_addr.sin_family = AF_INET;
1798                 if (interf == NULL)
1799                         serv_addr.sin_addr.s_addr = INADDR_ANY;
1800                 else
1801                         interface_to_sa(interf, &serv_addr,
1802                                                 sizeof(serv_addr));
1803                 serv_addr.sin_port = htons(port);
1804
1805                 n = bind(sockfd, (struct sockaddr *) &serv_addr,
1806                                                              sizeof(serv_addr));
1807                 if (n < 0) {
1808                         lwsl_err("ERROR on binding to port %d (%d %d)\n",
1809                                                                 port, n, errno);
1810                         close(sockfd);
1811                         return NULL;
1812                 }
1813
1814                 wsi = (struct libwebsocket *)malloc(sizeof(struct libwebsocket));
1815                 if (wsi == NULL) {
1816                         lwsl_err("Out of mem\n");
1817                         close(sockfd);
1818                         return NULL;
1819                 }
1820                 memset(wsi, 0, sizeof (struct libwebsocket));
1821                 wsi->sock = sockfd;
1822 #ifndef LWS_NO_EXTENSIONS
1823                 wsi->count_active_extensions = 0;
1824 #endif
1825                 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
1826
1827                 insert_wsi_socket_into_fds(context, wsi);
1828
1829                 context->listen_service_modulo = LWS_LISTEN_SERVICE_MODULO;
1830                 context->listen_service_count = 0;
1831                 context->listen_service_fd = sockfd;
1832
1833                 listen(sockfd, LWS_SOMAXCONN);
1834                 lwsl_notice(" Listening on port %d\n", port);
1835         }
1836 #endif
1837
1838         /*
1839          * drop any root privs for this process
1840          * to listen on port < 1023 we would have needed root, but now we are
1841          * listening, we don't want the power for anything else
1842          */
1843 #ifdef WIN32
1844 #else
1845         if (gid != -1)
1846                 if (setgid(gid))
1847                         lwsl_warn("setgid: %s\n", strerror(errno));
1848         if (uid != -1)
1849                 if (setuid(uid))
1850                         lwsl_warn("setuid: %s\n", strerror(errno));
1851 #endif
1852
1853         /* set up our internal broadcast trigger sockets per-protocol */
1854
1855         for (context->count_protocols = 0;
1856                         protocols[context->count_protocols].callback;
1857                                                    context->count_protocols++) {
1858
1859                 lwsl_parser("  Protocol: %s\n",
1860                                 protocols[context->count_protocols].name);
1861
1862                 protocols[context->count_protocols].owning_server = context;
1863                 protocols[context->count_protocols].protocol_index =
1864                                                        context->count_protocols;
1865
1866 #ifndef LWS_NO_FORK
1867                 fd = socket(AF_INET, SOCK_STREAM, 0);
1868                 if (fd < 0) {
1869                         lwsl_err("ERROR opening socket\n");
1870                         return NULL;
1871                 }
1872
1873                 /* allow us to restart even if old sockets in TIME_WAIT */
1874                 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (const void *)&opt,
1875                                                                   sizeof(opt));
1876
1877                 bzero((char *) &serv_addr, sizeof(serv_addr));
1878                 serv_addr.sin_family = AF_INET;
1879                 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
1880                 serv_addr.sin_port = 0; /* pick the port for us */
1881
1882                 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
1883                 if (n < 0) {
1884                         lwsl_err("ERROR on binding to port %d (%d %d)\n",
1885                                                                 port, n, errno);
1886                         return NULL;
1887                 }
1888
1889                 slen = sizeof cli_addr;
1890                 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
1891                 if (n < 0) {
1892                         lwsl_err("getsockname failed\n");
1893                         return NULL;
1894                 }
1895                 protocols[context->count_protocols].broadcast_socket_port =
1896                                                        ntohs(cli_addr.sin_port);
1897                 listen(fd, 5);
1898
1899                 lwsl_debug("  Protocol %s broadcast socket %d\n",
1900                                 protocols[context->count_protocols].name,
1901                                                       ntohs(cli_addr.sin_port));
1902
1903                 /* dummy wsi per broadcast proxy socket */
1904
1905                 wsi = (struct libwebsocket *)malloc(sizeof(struct libwebsocket));
1906                 if (wsi == NULL) {
1907                         lwsl_err("Out of mem\n");
1908                         close(fd);
1909                         return NULL;
1910                 }
1911                 memset(wsi, 0, sizeof (struct libwebsocket));
1912                 wsi->sock = fd;
1913                 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
1914 #ifndef LWS_NO_EXTENSIONS
1915                 wsi->count_active_extensions = 0;
1916 #endif
1917                 /* note which protocol we are proxying */
1918                 wsi->protocol_index_for_broadcast_proxy =
1919                                                        context->count_protocols;
1920
1921                 insert_wsi_socket_into_fds(context, wsi);
1922 #endif
1923         }
1924
1925 #ifndef LWS_NO_EXTENSIONS
1926         /*
1927          * give all extensions a chance to create any per-context
1928          * allocations they need
1929          */
1930
1931         m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_CONSTRUCT;
1932         if (port)
1933                 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_CONSTRUCT;
1934         
1935         if (extensions) {
1936             while (extensions->callback) {
1937                     lwsl_ext("  Extension: %s\n", extensions->name);
1938                     extensions->callback(context, extensions, NULL,
1939                         (enum libwebsocket_extension_callback_reasons)m,
1940                                                                 NULL, NULL, 0);
1941                     extensions++;
1942             }
1943         }
1944 #endif
1945         return context;
1946 }
1947
1948
1949 #ifndef LWS_NO_FORK
1950
1951 /**
1952  * libwebsockets_fork_service_loop() - Optional helper function forks off
1953  *                                a process for the websocket server loop.
1954  *                              You don't have to use this but if not, you
1955  *                              have to make sure you are calling
1956  *                              libwebsocket_service periodically to service
1957  *                              the websocket traffic
1958  * @context:    server context returned by creation function
1959  */
1960
1961 int
1962 libwebsockets_fork_service_loop(struct libwebsocket_context *context)
1963 {
1964         int fd;
1965         struct sockaddr_in cli_addr;
1966         int n;
1967         int p;
1968
1969         n = fork();
1970         if (n < 0)
1971                 return n;
1972
1973         if (n) {
1974
1975                 /* main process context */
1976
1977                 /*
1978                  * set up the proxy sockets to allow broadcast from
1979                  * service process context
1980                  */
1981
1982                 for (p = 0; p < context->count_protocols; p++) {
1983                         fd = socket(AF_INET, SOCK_STREAM, 0);
1984                         if (fd < 0) {
1985                                 lwsl_err("Unable to create socket\n");
1986                                 return -1;
1987                         }
1988                         cli_addr.sin_family = AF_INET;
1989                         cli_addr.sin_port = htons(
1990                              context->protocols[p].broadcast_socket_port);
1991                         cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
1992                         n = connect(fd, (struct sockaddr *)&cli_addr,
1993                                                                sizeof cli_addr);
1994                         if (n < 0) {
1995                                 lwsl_err("Unable to connect to "
1996                                                 "broadcast socket %d, %s\n",
1997                                                 n, strerror(errno));
1998                                 return -1;
1999                         }
2000
2001                         context->protocols[p].broadcast_socket_user_fd = fd;
2002                 }
2003
2004                 return 0;
2005         }
2006
2007 #ifdef HAVE_SYS_PRCTL_H
2008         /* we want a SIGHUP when our parent goes down */
2009         signal(SIGHUP, SIG_DFL);
2010         prctl(PR_SET_PDEATHSIG, SIGHUP);
2011 #endif
2012
2013         /* in this forked process, sit and service websocket connections */
2014
2015         while (1) {
2016                 if (libwebsocket_service(context, 1000))
2017                         break;
2018 //#ifndef HAVE_SYS_PRCTL_H
2019 /*
2020  * on systems without prctl() (i.e. anything but linux) we can notice that our
2021  * parent is dead if getppid() returns 1. FIXME apparently this is not true for
2022  * solaris, could remember ppid right after fork and wait for it to change.
2023  */
2024
2025                 /* if our parent went down, don't linger around */
2026                 if (context->started_with_parent && kill(context->started_with_parent, 0) < 0)
2027                         kill(getpid(), SIGTERM);
2028
2029                 if (getppid() == 1)
2030                     break;
2031 //#endif
2032         }
2033
2034
2035         return 1;
2036 }
2037
2038 #endif
2039
2040 /**
2041  * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
2042  *                                connection.
2043  * @wsi:        pointer to struct websocket you want to know the protocol of
2044  *
2045  *
2046  *      This is useful to get the protocol to broadcast back to from inside
2047  * the callback.
2048  */
2049
2050 const struct libwebsocket_protocols *
2051 libwebsockets_get_protocol(struct libwebsocket *wsi)
2052 {
2053         return wsi->protocol;
2054 }
2055
2056 /**
2057  * libwebsockets_broadcast() - Sends a buffer to the callback for all active
2058  *                                connections of the given protocol.
2059  * @protocol:   pointer to the protocol you will broadcast to all members of
2060  * @buf:  buffer containing the data to be broadcase.  NOTE: this has to be
2061  *              allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
2062  *              the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
2063  *              case you are calling this function from callback context.
2064  * @len:        length of payload data in buf, starting from buf.
2065  *
2066  *      This function allows bulk sending of a packet to every connection using
2067  * the given protocol.  It does not send the data directly; instead it calls
2068  * the callback with a reason type of LWS_CALLBACK_BROADCAST.  If the callback
2069  * wants to actually send the data for that connection, the callback itself
2070  * should call libwebsocket_write().
2071  *
2072  * libwebsockets_broadcast() can be called from another fork context without
2073  * having to take any care about data visibility between the processes, it'll
2074  * "just work".
2075  */
2076
2077
2078 int
2079 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
2080                                                  unsigned char *buf, size_t len)
2081 {
2082         struct libwebsocket_context *context = protocol->owning_server;
2083         int n;
2084         struct libwebsocket *wsi;
2085
2086         if (!context)
2087                 return 1;
2088
2089 #ifndef LWS_NO_FORK
2090         if (!protocol->broadcast_socket_user_fd) {
2091 #endif
2092                 /*
2093                  * We are either running unforked / flat, or we are being
2094                  * called from poll thread context
2095                  * eg, from a callback.  In that case don't use sockets for
2096                  * broadcast IPC (since we can't open a socket connection to
2097                  * a socket listening on our own thread) but directly do the
2098                  * send action.
2099                  *
2100                  * Locking is not needed because we are by definition being
2101                  * called in the poll thread context and are serialized.
2102                  */
2103
2104                 for (n = 0; n < context->fds_count; n++) {
2105
2106                         wsi = context->lws_lookup[context->fds[n].fd];
2107                         if (!wsi)
2108                                 continue;
2109
2110                         if (wsi->mode != LWS_CONNMODE_WS_SERVING)
2111                                 continue;
2112
2113                         /*
2114                          * never broadcast to non-established connections
2115                          */
2116                         if (wsi->state != WSI_STATE_ESTABLISHED)
2117                                 continue;
2118
2119                         /* only broadcast to guys using
2120                          * requested protocol
2121                          */
2122                         if (wsi->protocol != protocol)
2123                                 continue;
2124
2125                         user_callback_handle_rxflow(wsi->protocol->callback,
2126                                  context, wsi,
2127                                  LWS_CALLBACK_BROADCAST,
2128                                  wsi->user_space,
2129                                  buf, len);
2130                 }
2131
2132                 return 0;
2133 #ifndef LWS_NO_FORK
2134         }
2135
2136         /*
2137          * We're being called from a different process context than the server
2138          * loop.  Instead of broadcasting directly, we send our
2139          * payload on a socket to do the IPC; the server process will serialize
2140          * the broadcast action in its main poll() loop.
2141          *
2142          * There's one broadcast socket listening for each protocol supported
2143          * set up when the websocket server initializes
2144          */
2145
2146         n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);
2147
2148         return n;
2149 #endif
2150 }
2151
2152 int
2153 libwebsocket_is_final_fragment(struct libwebsocket *wsi)
2154 {
2155         return wsi->final;
2156 }
2157
2158 unsigned char
2159 libwebsocket_get_reserved_bits(struct libwebsocket *wsi)
2160 {
2161         return wsi->rsv;
2162 }
2163
2164 void *
2165 libwebsocket_ensure_user_space(struct libwebsocket *wsi)
2166 {
2167         /* allocate the per-connection user memory (if any) */
2168
2169         if (wsi->protocol->per_session_data_size && !wsi->user_space) {
2170                 wsi->user_space = malloc(
2171                                   wsi->protocol->per_session_data_size);
2172                 if (wsi->user_space  == NULL) {
2173                         lwsl_err("Out of memory for conn user space\n");
2174                         return NULL;
2175                 }
2176                 memset(wsi->user_space, 0,
2177                                          wsi->protocol->per_session_data_size);
2178         }
2179         return wsi->user_space;
2180 }
2181
2182 /**
2183  * lws_confirm_legit_wsi: returns nonzero if the wsi looks bad
2184  *
2185  * @wsi: struct libwebsocket to assess
2186  *
2187  * Performs consistecy checks on what the wsi claims and what the
2188  * polling arrays hold.  This'll catch a closed wsi still in use.
2189  * Don't try to use on the listen (nonconnection) wsi as it will
2190  * fail it.  Otherwise 0 return == wsi seems consistent.
2191  */
2192
2193 int lws_confirm_legit_wsi(struct libwebsocket *wsi)
2194 {
2195         struct libwebsocket_context *context;
2196
2197         if (!(wsi && wsi->protocol && wsi->protocol->owning_server))
2198                 return 1;
2199
2200         context = wsi->protocol->owning_server;
2201
2202         if (!context)
2203                 return 2;
2204
2205         if (!wsi->position_in_fds_table)
2206                 return 3; /* position in fds table looks bad */
2207         if (context->fds[wsi->position_in_fds_table].fd != wsi->sock)
2208                 return 4; /* pollfd entry does not wait on our socket descriptor */
2209         if (context->lws_lookup[wsi->sock] != wsi)
2210                 return 5; /* lookup table does not agree with wsi */
2211
2212         return 0;
2213 }
2214
2215 static void lwsl_emit_stderr(int level, const char *line)
2216 {
2217         char buf[300];
2218         struct timeval tv;
2219         int n;
2220
2221         gettimeofday(&tv, NULL);
2222
2223         buf[0] = '\0';
2224         for (n = 0; n < LLL_COUNT; n++)
2225                 if (level == (1 << n)) {
2226                         sprintf(buf, "[%ld:%04d] %s: ", tv.tv_sec,
2227                                         (int)(tv.tv_usec / 100), log_level_names[n]);
2228                         break;
2229                 }
2230         
2231         fprintf(stderr, "%s%s", buf, line);
2232 }
2233
2234 void lwsl_emit_syslog(int level, const char *line)
2235 {
2236         int syslog_level = LOG_DEBUG;
2237
2238         switch (level) {
2239         case LLL_ERR:
2240                 syslog_level = LOG_ERR;
2241                 break;
2242         case LLL_WARN:
2243                 syslog_level = LOG_WARNING;
2244                 break;
2245         case LLL_NOTICE:
2246                 syslog_level = LOG_NOTICE;
2247                 break;
2248         case LLL_INFO:
2249                 syslog_level = LOG_INFO;
2250                 break;
2251         }
2252         syslog(syslog_level, "%s", line);
2253 }
2254
2255 void _lws_log(int filter, const char *format, ...)
2256 {
2257         char buf[256];
2258         va_list ap;
2259
2260         if (!(log_level & filter))
2261                 return;
2262
2263         va_start(ap, format);
2264         vsnprintf(buf, (sizeof buf), format, ap);
2265         buf[(sizeof buf) - 1] = '\0';
2266         va_end(ap);
2267
2268         lwsl_emit(filter, buf);
2269 }
2270
2271 /**
2272  * lws_set_log_level() - Set the logging bitfield
2273  * @level:      OR together the LLL_ debug contexts you want output from
2274  * @log_emit_function:  NULL to leave it as it is, or a user-supplied
2275  *                      function to perform log string emission instead of
2276  *                      the default stderr one.
2277  *
2278  *      log level defaults to "err" and "warn" contexts enabled only and
2279  *      emission on stderr.
2280  */
2281
2282 void lws_set_log_level(int level, void (*log_emit_function)(int level, const char *line))
2283 {
2284         log_level = level;
2285         if (log_emit_function)
2286                 lwsl_emit = log_emit_function;
2287 }