2 * libwebsockets - small server side websockets and web server implementation
4 * Copyright (C) 2010-2015 Andy Green <andy@warmcat.com>
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.
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 Street, Fifth Floor, Boston,
22 #include "private-libwebsockets.h"
24 #ifndef LWS_BUILD_HASH
25 #define LWS_BUILD_HASH "unknown-build-hash"
28 static const char *library_version = LWS_LIBRARY_VERSION " " LWS_BUILD_HASH;
31 * lws_get_library_version: get version and git hash library built from
33 * returns a const char * to a string like "1.1 178d78c"
34 * representing the library version followed by the git head hash it
37 LWS_VISIBLE const char *
38 lws_get_library_version(void)
40 return library_version;
43 static const char * const mount_protocols[] = {
54 lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost, const struct lws_protocols *prot,
59 /* allocate the vh priv array only on demand */
60 if (!vhost->protocol_vh_privs) {
61 vhost->protocol_vh_privs = (void **)lws_zalloc(
62 vhost->count_protocols * sizeof(void *));
63 if (!vhost->protocol_vh_privs)
67 while (n < vhost->count_protocols && &vhost->protocols[n] != prot)
70 if (n == vhost->count_protocols) {
72 while (n < vhost->count_protocols &&
73 strcmp(vhost->protocols[n].name, prot->name))
76 if (n == vhost->count_protocols)
80 vhost->protocol_vh_privs[n] = lws_zalloc(size);
81 return vhost->protocol_vh_privs[n];
85 lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot)
89 if (!vhost->protocol_vh_privs)
92 while (n < vhost->count_protocols && &vhost->protocols[n] != prot)
95 if (n == vhost->count_protocols) {
97 while (n < vhost->count_protocols &&
98 strcmp(vhost->protocols[n].name, prot->name))
101 if (n == vhost->count_protocols) {
102 lwsl_err("%s: unknown protocol %p\n", __func__, prot);
107 return vhost->protocol_vh_privs[n];
110 static const struct lws_protocol_vhost_options *
111 lws_vhost_protocol_options(struct lws_vhost *vh, const char *name)
113 const struct lws_protocol_vhost_options *pvo = vh->pvo;
116 // lwsl_notice("%s: '%s' '%s'\n", __func__, pvo->name, name);
117 if (!strcmp(pvo->name, name))
126 * inform every vhost that hasn't already done it, that
127 * his protocols are initializing
130 lws_protocol_init(struct lws_context *context)
132 struct lws_vhost *vh = context->vhost_list;
133 const struct lws_protocol_vhost_options *pvo, *pvo1;
137 memset(&wsi, 0, sizeof(wsi));
138 wsi.context = context;
140 lwsl_info("%s\n", __func__);
145 /* only do the protocol init once for a given vhost */
146 if (vh->created_vhost_protocols)
149 /* initialize supported protocols on this vhost */
151 for (n = 0; n < vh->count_protocols; n++) {
152 wsi.protocol = &vh->protocols[n];
153 if (!vh->protocols[n].name)
155 pvo = lws_vhost_protocol_options(vh,
156 vh->protocols[n].name);
159 * linked list of options specific to
166 lwsl_notice(" vh %s prot %s opt %s\n",
168 vh->protocols[n].name,
171 if (!strcmp(pvo->name, "default")) {
172 lwsl_notice("Setting default "
173 "protocol for vh %s to %s\n",
175 vh->protocols[n].name);
176 vh->default_protocol_index = n;
178 if (!strcmp(pvo->name, "raw")) {
179 lwsl_notice("Setting raw "
180 "protocol for vh %s to %s\n",
182 vh->protocols[n].name);
183 vh->raw_protocol_index = n;
192 * inform all the protocols that they are doing their one-time
193 * initialization if they want to.
195 * NOTE the wsi is all zeros except for the context, vh and
196 * protocol ptrs so lws_get_context(wsi) etc can work
198 if (vh->protocols[n].callback(&wsi,
199 LWS_CALLBACK_PROTOCOL_INIT, NULL,
204 vh->created_vhost_protocols = 1;
209 if (!context->protocol_init_done)
210 lws_finalize_startup(context);
212 context->protocol_init_done = 1;
218 lws_callback_http_dummy(struct lws *wsi, enum lws_callback_reasons reason,
219 void *user, void *in, size_t len)
222 struct lws_cgi_args *args;
224 #if defined(LWS_WITH_CGI) || defined(LWS_WITH_HTTP_PROXY)
231 case LWS_CALLBACK_HTTP:
232 #ifndef LWS_NO_SERVER
233 if (lws_return_http_status(wsi, HTTP_STATUS_NOT_FOUND, NULL))
236 if (lws_http_transaction_completed(wsi))
240 #if !defined(LWS_NO_SERVER)
241 case LWS_CALLBACK_HTTP_FILE_COMPLETION:
242 if (lws_http_transaction_completed(wsi))
247 case LWS_CALLBACK_HTTP_WRITEABLE:
249 if (wsi->reason_bf & 1) {
250 if (lws_cgi_write_split_stdout_headers(wsi) < 0)
253 if (wsi->reason_bf & 8)
254 wsi->reason_bf &= ~8;
256 wsi->reason_bf &= ~1;
260 #if defined(LWS_WITH_HTTP_PROXY)
261 if (wsi->reason_bf & 2) {
262 char *px = buf + LWS_PRE;
263 int lenx = sizeof(buf) - LWS_PRE;
265 * our sink is writeable and our source has something
266 * to read. So read a lump of source material of
267 * suitable size to send or what's available, whichever
272 wsi->reason_bf &= ~2;
273 if (!lws_get_child(wsi))
275 if (lws_http_client_read(lws_get_child(wsi), &px, &lenx) < 0)
282 #if defined(LWS_WITH_HTTP_PROXY)
283 case LWS_CALLBACK_RECEIVE_CLIENT_HTTP:
284 //lwsl_err("LWS_CALLBACK_RECEIVE_CLIENT_HTTP: wsi %p\n", wsi);
285 assert(lws_get_parent(wsi));
286 if (!lws_get_parent(wsi))
288 lws_get_parent(wsi)->reason_bf |= 2;
289 lws_callback_on_writable(lws_get_parent(wsi));
292 case LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ:
293 //lwsl_err("LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ len %d\n", (int)len);
294 assert(lws_get_parent(wsi));
295 n = lws_write(lws_get_parent(wsi), (unsigned char *)in,
296 len, LWS_WRITE_HTTP);
301 case LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP: {
302 unsigned char *p, *end;
303 char ctype[64], ctlen = 0;
305 //lwsl_err("LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP\n");
307 p = (unsigned char *)buf + LWS_PRE;
308 end = p + sizeof(buf) - LWS_PRE;
310 if (lws_add_http_header_status(lws_get_parent(wsi), HTTP_STATUS_OK, &p, end))
312 if (lws_add_http_header_by_token(lws_get_parent(wsi),
313 WSI_TOKEN_HTTP_SERVER,
314 (unsigned char *)"libwebsockets",
318 ctlen = lws_hdr_copy(wsi, ctype, sizeof(ctype), WSI_TOKEN_HTTP_CONTENT_TYPE);
320 if (lws_add_http_header_by_token(lws_get_parent(wsi),
321 WSI_TOKEN_HTTP_CONTENT_TYPE,
322 (unsigned char *)ctype, ctlen, &p, end))
326 if (lws_add_http_header_content_length(lws_get_parent(wsi),
330 if (lws_finalize_http_header(lws_get_parent(wsi), &p, end))
334 // lwsl_info("%s\n", buf + LWS_PRE);
336 n = lws_write(lws_get_parent(wsi), (unsigned char *)buf + LWS_PRE,
337 p - ((unsigned char *)buf + LWS_PRE),
338 LWS_WRITE_HTTP_HEADERS);
347 /* CGI IO events (POLLIN/OUT) appear here, our default policy is:
349 * - POST data goes on subprocess stdin
350 * - subprocess stdout goes on http via writeable callback
351 * - subprocess stderr goes to the logs
353 case LWS_CALLBACK_CGI:
354 args = (struct lws_cgi_args *)in;
355 switch (args->ch) { /* which of stdin/out/err ? */
357 /* TBD stdin rx flow control */
361 /* when writing to MASTER would not block */
362 lws_callback_on_writable(wsi);
365 n = read(lws_get_socket_fd(args->stdwsi[LWS_STDERR]),
366 buf, sizeof(buf) - 2);
368 if (buf[n - 1] != '\n')
371 lwsl_notice("CGI-stderr: %s\n", buf);
377 case LWS_CALLBACK_CGI_TERMINATED:
380 case LWS_CALLBACK_CGI_STDIN_DATA: /* POST body for stdin */
381 args = (struct lws_cgi_args *)in;
382 args->data[args->len] = '\0';
383 n = write(lws_get_socket_fd(args->stdwsi[LWS_STDIN]),
384 args->data, args->len);
386 lwsl_notice("LWS_CALLBACK_CGI_STDIN_DATA: "
387 "sent %d only %d went", n, args->len);
391 case LWS_CALLBACK_SSL_INFO:
393 struct lws_ssl_info *si = in;
396 lwsl_notice("LWS_CALLBACK_SSL_INFO: where: 0x%x, ret: 0x%x\n",
408 /* list of supported protocols and callbacks */
410 static const struct lws_protocols protocols_dummy[] = {
411 /* first protocol must always be HTTP handler */
414 "http-only", /* name */
415 lws_callback_http_dummy, /* callback */
416 0, /* per_session_data_size */
417 0, /* max frame size / rx buffer */
421 * the other protocols are provided by lws plugins
423 { NULL, NULL, 0, 0, 0, NULL, 0} /* terminator */
426 #ifdef LWS_PLAT_OPTEE
427 #undef LWS_HAVE_GETENV
430 LWS_VISIBLE struct lws_vhost *
431 lws_create_vhost(struct lws_context *context,
432 struct lws_context_creation_info *info)
434 struct lws_vhost *vh = lws_zalloc(sizeof(*vh)),
435 **vh1 = &context->vhost_list;
436 const struct lws_http_mount *mounts;
437 const struct lws_protocol_vhost_options *pvo;
438 #ifdef LWS_WITH_PLUGINS
439 struct lws_plugin *plugin = context->plugin_list;
441 struct lws_protocols *lwsp;
442 int m, f = !info->pvo;
443 #ifdef LWS_HAVE_GETENV
451 if (!info->protocols)
452 info->protocols = &protocols_dummy[0];
454 vh->context = context;
455 if (!info->vhost_name)
456 vh->name = "default";
458 vh->name = info->vhost_name;
460 vh->iface = info->iface;
461 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32) && !defined(OPTEE_TA) && !defined(WIN32)
462 vh->bind_iface = info->bind_iface;
465 for (vh->count_protocols = 0;
466 info->protocols[vh->count_protocols].callback;
467 vh->count_protocols++)
470 vh->options = info->options;
472 vh->headers = info->headers;
473 vh->ssl_info_event_mask = info->ssl_info_event_mask;
474 if (info->keepalive_timeout)
475 vh->keepalive_timeout = info->keepalive_timeout;
477 vh->keepalive_timeout = 5;
479 if (info->timeout_secs_ah_idle)
480 vh->timeout_secs_ah_idle = info->timeout_secs_ah_idle;
482 vh->timeout_secs_ah_idle = 10;
485 * give the vhost a unified list of protocols including the
486 * ones that came from plugins
488 lwsp = lws_zalloc(sizeof(struct lws_protocols) *
489 (vh->count_protocols +
490 context->plugin_protocol_count + 1));
496 m = vh->count_protocols;
497 memcpy(lwsp, info->protocols, sizeof(struct lws_protocols) * m);
499 /* for compatibility, all protocols enabled on vhost if only
500 * the default vhost exists. Otherwise only vhosts who ask
501 * for a protocol get it enabled.
504 if (context->options & LWS_SERVER_OPTION_EXPLICIT_VHOSTS)
507 #ifdef LWS_WITH_PLUGINS
511 for (n = 0; n < plugin->caps.count_protocols; n++) {
513 * for compatibility's sake, no pvo implies
514 * allow all protocols
516 if (f || lws_vhost_protocol_options(vh,
517 plugin->caps.protocols[n].name)) {
519 &plugin->caps.protocols[n],
520 sizeof(struct lws_protocols));
522 vh->count_protocols++;
525 plugin = plugin->list;
531 #ifdef LWS_WITH_PLUGINS
532 (context->plugin_list) ||
534 context->options & LWS_SERVER_OPTION_EXPLICIT_VHOSTS)
535 vh->protocols = lwsp;
537 vh->protocols = info->protocols;
541 vh->same_vh_protocol_list = (struct lws **)
542 lws_zalloc(sizeof(struct lws *) * vh->count_protocols);
544 vh->mount_list = info->mounts;
546 #ifdef LWS_USE_UNIX_SOCK
547 if (LWS_UNIX_SOCK_ENABLED(context)) {
548 lwsl_notice("Creating Vhost '%s' path \"%s\", %d protocols\n",
549 vh->name, info->iface, vh->count_protocols);
552 lwsl_notice("Creating Vhost '%s' port %d, %d protocols, IPv6 %s\n",
553 vh->name, info->port, vh->count_protocols, LWS_IPV6_ENABLED(vh) ? "on" : "off");
555 mounts = info->mounts;
557 (void)mount_protocols[0];
558 lwsl_notice(" mounting %s%s to %s\n",
559 mount_protocols[mounts->origin_protocol],
560 mounts->origin, mounts->mountpoint);
562 /* convert interpreter protocol names to pointers */
563 pvo = mounts->interpret;
565 for (n = 0; n < vh->count_protocols; n++)
566 if (!strcmp(pvo->value, vh->protocols[n].name)) {
567 ((struct lws_protocol_vhost_options *)pvo)->value =
568 (const char *)(lws_intptr_t)n;
571 if (n == vh->count_protocols)
572 lwsl_err("ignoring unknown interpret protocol %s\n", pvo->value);
576 mounts = mounts->mount_next;
579 #ifndef LWS_NO_EXTENSIONS
580 #ifdef LWS_WITH_PLUGINS
581 if (context->plugin_extension_count) {
584 while (info->extensions && info->extensions[m].callback)
588 * give the vhost a unified list of extensions including the
589 * ones that came from plugins
591 vh->extensions = lws_zalloc(sizeof(struct lws_extension) *
593 context->plugin_extension_count + 1));
597 memcpy((struct lws_extension *)vh->extensions, info->extensions,
598 sizeof(struct lws_extension) * m);
599 plugin = context->plugin_list;
601 memcpy((struct lws_extension *)&vh->extensions[m],
602 plugin->caps.extensions,
603 sizeof(struct lws_extension) *
604 plugin->caps.count_extensions);
605 m += plugin->caps.count_extensions;
606 plugin = plugin->list;
610 vh->extensions = info->extensions;
613 vh->listen_port = info->port;
614 #if !defined(LWS_WITH_ESP8266)
615 vh->http_proxy_port = 0;
616 vh->http_proxy_address[0] = '\0';
617 #if defined(LWS_WITH_SOCKS5)
618 vh->socks_proxy_port = 0;
619 vh->socks_proxy_address[0] = '\0';
622 /* either use proxy from info, or try get it from env var */
625 if (info->http_proxy_address) {
626 /* override for backwards compatibility */
627 if (info->http_proxy_port)
628 vh->http_proxy_port = info->http_proxy_port;
629 lws_set_proxy(vh, info->http_proxy_address);
631 #ifdef LWS_HAVE_GETENV
632 p = getenv("http_proxy");
634 lws_set_proxy(vh, p);
637 #if defined(LWS_WITH_SOCKS5)
639 if (info->socks_proxy_address) {
640 /* override for backwards compatibility */
641 if (info->socks_proxy_port)
642 vh->socks_proxy_port = info->socks_proxy_port;
643 lws_set_socks(vh, info->socks_proxy_address);
645 #ifdef LWS_HAVE_GETENV
646 p = getenv("socks_proxy");
648 lws_set_socks(vh, p);
654 vh->ka_time = info->ka_time;
655 vh->ka_interval = info->ka_interval;
656 vh->ka_probes = info->ka_probes;
658 if (vh->options & LWS_SERVER_OPTION_STS)
659 lwsl_notice(" STS enabled\n");
661 #ifdef LWS_WITH_ACCESS_LOG
662 if (info->log_filepath) {
663 vh->log_fd = open(info->log_filepath, O_CREAT | O_APPEND | O_RDWR, 0600);
664 if (vh->log_fd == (int)LWS_INVALID_FILE) {
665 lwsl_err("unable to open log filepath %s\n",
670 if (context->uid != -1)
671 if (chown(info->log_filepath, context->uid,
673 lwsl_err("unable to chown log file %s\n",
677 vh->log_fd = (int)LWS_INVALID_FILE;
679 if (lws_context_init_server_ssl(info, vh))
681 if (lws_context_init_client_ssl(info, vh))
683 if (lws_context_init_server(info, vh)) {
684 lwsl_err("init server failed\n");
693 vh1 = &(*vh1)->vhost_next;
695 /* for the case we are adding a vhost much later, after server init */
697 if (context->protocol_init_done)
698 lws_protocol_init(context);
709 lws_init_vhost_client_ssl(const struct lws_context_creation_info *info,
710 struct lws_vhost *vhost)
712 struct lws_context_creation_info i;
714 memcpy(&i, info, sizeof(i));
715 i.port = CONTEXT_PORT_NO_LISTEN;
717 return lws_context_init_client_ssl(&i, vhost);
720 LWS_VISIBLE struct lws_context *
721 lws_create_context(struct lws_context_creation_info *info)
723 struct lws_context *context = NULL;
724 struct lws_plat_file_ops *prev;
725 #ifndef LWS_NO_DAEMONIZE
726 int pid_daemon = get_daemonize_pid();
729 #if defined(__ANDROID__)
733 lwsl_notice("Initial logging level %d\n", log_level);
734 lwsl_notice("Libwebsockets version: %s\n", library_version);
736 lwsl_notice("Compiled with %s\n", GCC_VER);
740 if (!lws_check_opt(info->options, LWS_SERVER_OPTION_DISABLE_IPV6))
741 lwsl_notice("IPV6 compiled in and enabled\n");
743 lwsl_notice("IPV6 compiled in but disabled\n");
745 lwsl_notice("IPV6 not compiled in\n");
747 #if !defined(LWS_PLAT_OPTEE) && !defined(LWS_PLAT_ESP32)
748 lws_feature_status_libev(info);
749 lws_feature_status_libuv(info);
752 lwsl_info(" LWS_DEF_HEADER_LEN : %u\n", LWS_DEF_HEADER_LEN);
753 lwsl_info(" LWS_MAX_PROTOCOLS : %u\n", LWS_MAX_PROTOCOLS);
754 lwsl_info(" LWS_MAX_SMP : %u\n", LWS_MAX_SMP);
755 lwsl_info(" SPEC_LATEST_SUPPORTED : %u\n", SPEC_LATEST_SUPPORTED);
756 lwsl_info(" sizeof (*info) : %ld\n", (long)sizeof(*info));
757 #if defined(LWS_WITH_STATS)
758 lwsl_notice(" LWS_WITH_STATS : on\n");
761 lwsl_info(" SYSTEM_RANDOM_FILEPATH: '%s'\n", SYSTEM_RANDOM_FILEPATH);
763 if (lws_plat_context_early_init())
766 context = lws_zalloc(sizeof(struct lws_context));
768 lwsl_err("No memory for websocket context\n");
771 if (info->pt_serv_buf_size)
772 context->pt_serv_buf_size = info->pt_serv_buf_size;
774 context->pt_serv_buf_size = 4096;
776 /* default to just the platform fops implementation */
778 context->fops_platform.LWS_FOP_OPEN = _lws_plat_file_open;
779 context->fops_platform.LWS_FOP_CLOSE = _lws_plat_file_close;
780 context->fops_platform.LWS_FOP_SEEK_CUR = _lws_plat_file_seek_cur;
781 context->fops_platform.LWS_FOP_READ = _lws_plat_file_read;
782 context->fops_platform.LWS_FOP_WRITE = _lws_plat_file_write;
783 context->fops_platform.fi[0].sig = NULL;
786 * arrange a linear linked-list of fops starting from context->fops
789 * [ -> fops_zip (copied into context so .next settable) ]
793 context->fops = &context->fops_platform;
794 prev = (struct lws_plat_file_ops *)context->fops;
796 #if defined(LWS_WITH_ZIP_FOPS)
797 /* make a soft copy so we can set .next */
798 context->fops_zip = fops_zip;
799 prev->next = &context->fops_zip;
800 prev = (struct lws_plat_file_ops *)prev->next;
803 /* if user provided fops, tack them on the end of the list */
805 prev->next = info->fops;
807 context->reject_service_keywords = info->reject_service_keywords;
808 if (info->external_baggage_free_on_destroy)
809 context->external_baggage_free_on_destroy =
810 info->external_baggage_free_on_destroy;
812 context->time_up = time(NULL);
814 context->simultaneous_ssl_restriction = info->simultaneous_ssl_restriction;
816 #ifndef LWS_NO_DAEMONIZE
818 context->started_with_parent = pid_daemon;
819 lwsl_notice(" Started with daemon pid %d\n", pid_daemon);
822 #if defined(__ANDROID__)
823 n = getrlimit ( RLIMIT_NOFILE,&rt);
825 lwsl_err("Get RLIMIT_NOFILE failed!\n");
828 context->max_fds = rt.rlim_cur;
830 context->max_fds = getdtablesize();
833 if (info->count_threads)
834 context->count_threads = info->count_threads;
836 context->count_threads = 1;
838 if (context->count_threads > LWS_MAX_SMP)
839 context->count_threads = LWS_MAX_SMP;
841 context->token_limits = info->token_limits;
843 context->options = info->options;
845 if (info->timeout_secs)
846 context->timeout_secs = info->timeout_secs;
848 context->timeout_secs = AWAITING_TIMEOUT;
850 context->ws_ping_pong_interval = info->ws_ping_pong_interval;
852 lwsl_info(" default timeout (secs): %u\n", context->timeout_secs);
854 if (info->max_http_header_data)
855 context->max_http_header_data = info->max_http_header_data;
857 if (info->max_http_header_data2)
858 context->max_http_header_data =
859 info->max_http_header_data2;
861 context->max_http_header_data = LWS_DEF_HEADER_LEN;
862 if (info->max_http_header_pool)
863 context->max_http_header_pool = info->max_http_header_pool;
865 context->max_http_header_pool = LWS_DEF_HEADER_POOL;
868 * Allocate the per-thread storage for scratchpad buffers,
869 * and header data pool
871 for (n = 0; n < context->count_threads; n++) {
872 context->pt[n].serv_buf = lws_zalloc(context->pt_serv_buf_size);
873 if (!context->pt[n].serv_buf) {
879 context->pt[n].context = context;
881 context->pt[n].tid = n;
882 context->pt[n].http_header_data = lws_malloc(context->max_http_header_data *
883 context->max_http_header_pool);
884 if (!context->pt[n].http_header_data)
887 context->pt[n].ah_pool = lws_zalloc(sizeof(struct allocated_headers) *
888 context->max_http_header_pool);
889 for (m = 0; m < context->max_http_header_pool; m++)
890 context->pt[n].ah_pool[m].data =
891 (char *)context->pt[n].http_header_data +
892 (m * context->max_http_header_data);
893 if (!context->pt[n].ah_pool)
896 lws_pt_mutex_init(&context->pt[n]);
899 if (info->fd_limit_per_thread)
900 context->fd_limit_per_thread = info->fd_limit_per_thread;
902 context->fd_limit_per_thread = context->max_fds /
903 context->count_threads;
905 lwsl_notice(" Threads: %d each %d fds\n", context->count_threads,
906 context->fd_limit_per_thread);
908 if (!info->ka_interval && info->ka_time > 0) {
909 lwsl_err("info->ka_interval can't be 0 if ka_time used\n");
914 /* (Issue #264) In order to *avoid breaking backwards compatibility*, we
915 * enable libev mediated SIGINT handling with a default handler of
916 * lws_sigint_cb. The handler can be overridden or disabled
917 * by invoking lws_sigint_cfg after creating the context, but
918 * before invoking lws_initloop:
920 context->use_ev_sigint = 1;
921 context->lws_ev_sigint_cb = &lws_ev_sigint_cb;
922 #endif /* LWS_USE_LIBEV */
924 /* (Issue #264) In order to *avoid breaking backwards compatibility*, we
925 * enable libev mediated SIGINT handling with a default handler of
926 * lws_sigint_cb. The handler can be overridden or disabled
927 * by invoking lws_sigint_cfg after creating the context, but
928 * before invoking lws_initloop:
930 context->use_ev_sigint = 1;
931 context->lws_uv_sigint_cb = &lws_uv_sigint_cb;
933 #ifdef LWS_USE_LIBEVENT
934 /* (Issue #264) In order to *avoid breaking backwards compatibility*, we
935 * enable libev mediated SIGINT handling with a default handler of
936 * lws_sigint_cb. The handler can be overridden or disabled
937 * by invoking lws_sigint_cfg after creating the context, but
938 * before invoking lws_initloop:
940 context->use_ev_sigint = 1;
941 context->lws_event_sigint_cb = &lws_event_sigint_cb;
942 #endif /* LWS_USE_LIBEVENT */
944 lwsl_info(" mem: context: %5lu bytes (%ld ctx + (%ld thr x %d))\n",
945 (long)sizeof(struct lws_context) +
946 (context->count_threads * context->pt_serv_buf_size),
947 (long)sizeof(struct lws_context),
948 (long)context->count_threads,
949 context->pt_serv_buf_size);
951 lwsl_info(" mem: http hdr rsvd: %5lu bytes (%u thr x (%u + %lu) x %u))\n",
952 (long)(context->max_http_header_data +
953 sizeof(struct allocated_headers)) *
954 context->max_http_header_pool * context->count_threads,
955 context->count_threads,
956 context->max_http_header_data,
957 (long)sizeof(struct allocated_headers),
958 context->max_http_header_pool);
959 n = sizeof(struct lws_pollfd) * context->count_threads *
960 context->fd_limit_per_thread;
961 context->pt[0].fds = lws_zalloc(n);
962 if (context->pt[0].fds == NULL) {
963 lwsl_err("OOM allocating %d fds\n", context->max_fds);
966 lwsl_info(" mem: pollfd map: %5u\n", n);
968 if (info->server_string) {
969 context->server_string = info->server_string;
970 context->server_string_len = (short)
971 strlen(context->server_string);
975 /* each thread serves his own chunk of fds */
976 for (n = 1; n < (int)info->count_threads; n++)
977 context->pt[n].fds = context->pt[n - 1].fds +
978 context->fd_limit_per_thread;
981 if (lws_plat_init(context, info))
984 lws_context_init_ssl_library(info);
986 context->user_space = info->user;
989 * if he's not saying he'll make his own vhosts later then act
990 * compatibly and make a default vhost using the data in the info
992 if (!lws_check_opt(info->options, LWS_SERVER_OPTION_EXPLICIT_VHOSTS))
993 if (!lws_create_vhost(context, info)) {
994 lwsl_err("Failed to create default vhost\n");
998 lws_context_init_extensions(info, context);
1000 lwsl_notice(" mem: per-conn: %5lu bytes + protocol rx buf\n",
1001 (unsigned long)sizeof(struct lws));
1003 strcpy(context->canonical_hostname, "unknown");
1004 lws_server_get_canonical_hostname(context, info);
1006 context->uid = info->uid;
1007 context->gid = info->gid;
1009 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
1010 memcpy(context->caps, info->caps, sizeof(context->caps));
1011 context->count_caps = info->count_caps;
1015 * drop any root privs for this process
1016 * to listen on port < 1023 we would have needed root, but now we are
1017 * listening, we don't want the power for anything else
1019 if (!lws_check_opt(info->options, LWS_SERVER_OPTION_EXPLICIT_VHOSTS))
1020 lws_plat_drop_app_privileges(info);
1023 * give all extensions a chance to create any per-context
1024 * allocations they need
1026 if (info->port != CONTEXT_PORT_NO_LISTEN) {
1027 if (lws_ext_cb_all_exts(context, NULL,
1028 LWS_EXT_CB_SERVER_CONTEXT_CONSTRUCT, NULL, 0) < 0)
1031 if (lws_ext_cb_all_exts(context, NULL,
1032 LWS_EXT_CB_CLIENT_CONTEXT_CONSTRUCT, NULL, 0) < 0)
1038 lws_context_destroy(context);
1042 LWS_VISIBLE LWS_EXTERN void
1043 lws_context_deprecate(struct lws_context *context, lws_reload_func cb)
1045 struct lws_vhost *vh = context->vhost_list, *vh1;
1049 * "deprecation" means disable the context from accepting any new
1050 * connections and free up listen sockets to be used by a replacement
1053 * Otherwise the deprecated context remains operational, until its
1054 * number of connected sockets falls to zero, when it is deleted.
1057 /* for each vhost, close his listen socket */
1060 wsi = vh->lserv_wsi;
1062 wsi->socket_is_permanently_unusable = 1;
1063 lws_close_free_wsi(wsi, LWS_CLOSE_STATUS_NOSTATUS);
1064 wsi->context->deprecation_pending_listen_close_count++;
1066 * other vhosts can share the listen port, they
1067 * point to the same wsi. So zap those too.
1069 vh1 = context->vhost_list;
1071 if (vh1->lserv_wsi == wsi)
1072 vh1->lserv_wsi = NULL;
1073 vh1 = vh1->vhost_next;
1076 vh = vh->vhost_next;
1079 context->deprecated = 1;
1080 context->deprecation_cb = cb;
1083 LWS_VISIBLE LWS_EXTERN int
1084 lws_context_is_deprecated(struct lws_context *context)
1086 return context->deprecated;
1090 lws_context_destroy2(struct lws_context *context);
1094 lws_vhost_destroy1(struct lws_vhost *vh)
1096 const struct lws_protocols *protocol = NULL;
1097 struct lws_context_per_thread *pt;
1098 int n, m = vh->context->count_threads;
1099 struct lws_context *context = vh->context;
1102 lwsl_notice("%s\n", __func__);
1104 if (vh->being_destroyed)
1107 vh->being_destroyed = 1;
1110 * Are there other vhosts that are piggybacking on our listen socket?
1111 * If so we need to hand the listen socket off to one of the others
1112 * so it will remain open. If not, leave it attached to the closing
1113 * vhost and it will get closed.
1117 lws_start_foreach_ll(struct lws_vhost *, v, context->vhost_list) {
1119 !v->being_destroyed &&
1120 v->listen_port == vh->listen_port &&
1121 ((!v->iface && !vh->iface) ||
1122 (v->iface && vh->iface &&
1123 !strcmp(v->iface, vh->iface)))) {
1125 * this can only be a listen wsi, which is
1126 * restricted... it has no protocol or other
1127 * bindings or states. So we can simply
1128 * swap it to a vhost that has the same
1129 * iface + port, but is not closing.
1131 assert(v->lserv_wsi == NULL);
1132 v->lserv_wsi = vh->lserv_wsi;
1133 vh->lserv_wsi = NULL;
1134 v->lserv_wsi->vhost = v;
1136 lwsl_notice("%s: listen skt from %s to %s\n",
1137 __func__, vh->name, v->name);
1140 } lws_end_foreach_ll(v, vhost_next);
1143 * Forcibly close every wsi assoicated with this vhost. That will
1144 * include the listen socket if it is still associated with the closing
1149 pt = &context->pt[m];
1151 for (n = 0; (unsigned int)n < context->pt[m].fds_count; n++) {
1152 struct lws *wsi = wsi_from_fd(context, pt->fds[n].fd);
1155 if (wsi->vhost != vh)
1158 lws_close_free_wsi(wsi,
1159 LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY
1160 /* no protocol close */);
1166 * let the protocols destroy the per-vhost protocol objects
1169 memset(&wsi, 0, sizeof(wsi));
1170 wsi.context = vh->context;
1172 protocol = vh->protocols;
1175 while (n < vh->count_protocols) {
1176 wsi.protocol = protocol;
1177 protocol->callback(&wsi, LWS_CALLBACK_PROTOCOL_DESTROY,
1185 * remove vhost from context list of vhosts
1188 lws_start_foreach_llp(struct lws_vhost **, pv, context->vhost_list) {
1190 *pv = vh->vhost_next;
1193 } lws_end_foreach_llp(pv, vhost_next);
1195 /* add ourselves to the pending destruction list */
1197 vh->vhost_next = vh->context->vhost_pending_destruction_list;
1198 vh->context->vhost_pending_destruction_list = vh;
1202 lws_vhost_destroy2(struct lws_vhost *vh)
1204 const struct lws_protocols *protocol = NULL;
1205 struct lws_context *context = vh->context;
1206 struct lws_deferred_free *df;
1209 lwsl_notice("%s: %p\n", __func__, vh);
1211 /* if we are still on deferred free list, remove ourselves */
1213 lws_start_foreach_llp(struct lws_deferred_free **, pdf, context->deferred_free_list) {
1214 if ((*pdf)->payload == vh) {
1220 } lws_end_foreach_llp(pdf, next);
1222 /* remove ourselves from the pending destruction list */
1224 lws_start_foreach_llp(struct lws_vhost **, pv, context->vhost_pending_destruction_list) {
1226 *pv = (*pv)->vhost_next;
1229 } lws_end_foreach_llp(pv, vhost_next);
1232 * Free all the allocations associated with the vhost
1235 protocol = vh->protocols;
1238 while (n < vh->count_protocols) {
1239 if (vh->protocol_vh_privs &&
1240 vh->protocol_vh_privs[n]) {
1241 lws_free(vh->protocol_vh_privs[n]);
1242 vh->protocol_vh_privs[n] = NULL;
1248 if (vh->protocol_vh_privs)
1249 lws_free(vh->protocol_vh_privs);
1250 lws_ssl_SSL_CTX_destroy(vh);
1251 lws_free(vh->same_vh_protocol_list);
1252 #ifdef LWS_WITH_PLUGINS
1253 if (LWS_LIBUV_ENABLED(context)) {
1254 if (context->plugin_list)
1255 lws_free((void *)vh->protocols);
1259 if (context->options & LWS_SERVER_OPTION_EXPLICIT_VHOSTS)
1260 lws_free((void *)vh->protocols);
1263 #ifdef LWS_WITH_PLUGINS
1264 #ifndef LWS_NO_EXTENSIONS
1265 if (context->plugin_extension_count)
1266 lws_free((void *)vh->extensions);
1269 #ifdef LWS_WITH_ACCESS_LOG
1270 if (vh->log_fd != (int)LWS_INVALID_FILE)
1275 * although async event callbacks may still come for wsi handles with
1276 * pending close in the case of asycn event library like libuv,
1277 * they do not refer to the vhost. So it's safe to free.
1280 lwsl_notice(" %s: Freeing vhost %p\n", __func__, vh);
1282 memset(vh, 0, sizeof(*vh));
1287 lws_check_deferred_free(struct lws_context *context, int force)
1289 struct lws_deferred_free *df;
1290 time_t now = lws_now_secs();
1292 lws_start_foreach_llp(struct lws_deferred_free **, pdf, context->deferred_free_list) {
1293 if (now > (*pdf)->deadline || force) {
1296 /* finalize vh destruction */
1297 lwsl_notice("doing deferred vh %p destroy\n", df->payload);
1298 lws_vhost_destroy2(df->payload);
1300 continue; /* after deletion we already point to next */
1302 } lws_end_foreach_llp(pdf, next);
1308 lws_vhost_destroy(struct lws_vhost *vh)
1310 struct lws_deferred_free *df = malloc(sizeof(*df));
1315 lws_vhost_destroy1(vh);
1317 /* part 2 is deferred to allow all the handle closes to complete */
1319 df->next = vh->context->deferred_free_list;
1320 df->deadline = lws_now_secs() + 5;
1322 vh->context->deferred_free_list = df;
1326 lws_context_destroy(struct lws_context *context)
1328 struct lws_context_per_thread *pt;
1329 struct lws_vhost *vh = NULL;
1334 lwsl_notice("%s: ctx %p\n", __func__, context);
1337 if (context->being_destroyed1) {
1338 lwsl_notice("%s: ctx %p: already being destroyed\n", __func__, context);
1342 lwsl_notice("%s: ctx %p\n", __func__, context);
1344 m = context->count_threads;
1345 context->being_destroyed = 1;
1346 context->being_destroyed1 = 1;
1348 memset(&wsi, 0, sizeof(wsi));
1349 wsi.context = context;
1352 if (context->worst_latency_info[0])
1353 lwsl_notice("Worst latency: %s\n", context->worst_latency_info);
1357 pt = &context->pt[m];
1359 for (n = 0; (unsigned int)n < context->pt[m].fds_count; n++) {
1360 struct lws *wsi = wsi_from_fd(context, pt->fds[n].fd);
1364 lws_close_free_wsi(wsi,
1365 LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY
1366 /* no protocol close */);
1369 lws_pt_mutex_destroy(pt);
1373 * give all extensions a chance to clean up any per-context
1374 * allocations they might have made
1377 n = lws_ext_cb_all_exts(context, NULL,
1378 LWS_EXT_CB_SERVER_CONTEXT_DESTRUCT, NULL, 0);
1380 n = lws_ext_cb_all_exts(context, NULL,
1381 LWS_EXT_CB_CLIENT_CONTEXT_DESTRUCT, NULL, 0);
1384 * inform all the protocols that they are done and will have no more
1387 * We can't free things until after the event loop shuts down.
1389 if (context->protocol_init_done)
1390 vh = context->vhost_list;
1392 lws_vhost_destroy1(vh);
1393 vh = vh->vhost_next;
1396 for (n = 0; n < context->count_threads; n++) {
1397 pt = &context->pt[n];
1399 lws_libev_destroyloop(context, n);
1400 lws_libuv_destroyloop(context, n);
1401 lws_libevent_destroyloop(context, n);
1403 lws_free_set_NULL(context->pt[n].serv_buf);
1405 lws_free(pt->ah_pool);
1406 if (pt->http_header_data)
1407 lws_free(pt->http_header_data);
1409 lws_plat_context_early_destroy(context);
1411 if (context->pt[0].fds)
1412 lws_free_set_NULL(context->pt[0].fds);
1414 if (!LWS_LIBUV_ENABLED(context))
1415 lws_context_destroy2(context);
1419 * call the second one after the event loop has been shut down cleanly
1423 lws_context_destroy2(struct lws_context *context)
1425 struct lws_vhost *vh = NULL, *vh1;
1427 lwsl_notice("%s: ctx %p\n", __func__, context);
1430 * free all the per-vhost allocations
1433 vh = context->vhost_list;
1435 vh1 = vh->vhost_next;
1436 lws_vhost_destroy2(vh);
1440 /* remove ourselves from the pending destruction list */
1442 while (context->vhost_pending_destruction_list)
1443 /* removes itself from list */
1444 lws_vhost_destroy2(context->vhost_pending_destruction_list);
1447 lws_stats_log_dump(context);
1449 lws_ssl_context_destroy(context);
1450 lws_plat_context_late_destroy(context);
1452 if (context->external_baggage_free_on_destroy)
1453 free(context->external_baggage_free_on_destroy);
1455 lws_check_deferred_free(context, 1);