1 #include "first.h" 2 3 #include "plugin.h" 4 #include "base.h" 5 #include "array.h" 6 #include "log.h" 7 8 #include <string.h> 9 #include <stdlib.h> 10 11 array plugin_stats; /* global */ 12 13 #ifdef HAVE_VALGRIND_VALGRIND_H 14 # include <valgrind/valgrind.h> 15 #endif 16 17 #if !defined(__WIN32) && !defined(LIGHTTPD_STATIC) 18 # include <dlfcn.h> 19 #endif 20 /* 21 * 22 * if you change this enum to add a new callback, be sure 23 * - that PLUGIN_FUNC_SIZEOF is the last entry 24 * - that you add: 25 * 1. PLUGIN_CALL_... as callback-dispatcher 26 * 2. count and assignment in plugins_call_init() 27 * 28 */ 29 30 typedef enum { 31 PLUGIN_FUNC_HANDLE_URI_CLEAN, 32 PLUGIN_FUNC_HANDLE_URI_RAW, 33 PLUGIN_FUNC_HANDLE_REQUEST_ENV, 34 PLUGIN_FUNC_HANDLE_REQUEST_DONE, 35 PLUGIN_FUNC_HANDLE_CONNECTION_ACCEPT, 36 PLUGIN_FUNC_HANDLE_CONNECTION_SHUT_WR, 37 PLUGIN_FUNC_HANDLE_CONNECTION_CLOSE, 38 PLUGIN_FUNC_HANDLE_TRIGGER, 39 PLUGIN_FUNC_HANDLE_SIGHUP, 40 PLUGIN_FUNC_HANDLE_WAITPID, 41 PLUGIN_FUNC_HANDLE_SUBREQUEST, 42 PLUGIN_FUNC_HANDLE_SUBREQUEST_START, 43 PLUGIN_FUNC_HANDLE_RESPONSE_START, 44 PLUGIN_FUNC_HANDLE_DOCROOT, 45 PLUGIN_FUNC_HANDLE_PHYSICAL, 46 PLUGIN_FUNC_CONNECTION_RESET, 47 /* PLUGIN_FUNC_INIT, *//* handled here in plugin.c */ 48 /* PLUGIN_FUNC_CLEANUP, *//* handled here in plugin.c */ 49 PLUGIN_FUNC_SET_DEFAULTS, 50 PLUGIN_FUNC_WORKER_INIT, 51 52 PLUGIN_FUNC_SIZEOF 53 } plugin_t; 54 55 static plugin *plugin_init(void) { 56 plugin *p; 57 58 p = calloc(1, sizeof(*p)); 59 force_assert(NULL != p); 60 61 return p; 62 } 63 64 static void plugin_free(plugin *p) { 65 #if !defined(LIGHTTPD_STATIC) 66 if (p->lib) { 67 #if defined(HAVE_VALGRIND_VALGRIND_H) 68 /*if (!RUNNING_ON_VALGRIND) */ 69 #endif 70 #if defined(__WIN32) 71 FreeLibrary(p->lib); 72 #else 73 dlclose(p->lib); 74 #endif 75 } 76 #endif 77 78 free(p); 79 } 80 81 static void plugins_register(server *srv, plugin *p) { 82 plugin **ps; 83 if (srv->plugins.used == srv->plugins.size) { 84 srv->plugins.size += 4; 85 srv->plugins.ptr = realloc(srv->plugins.ptr, srv->plugins.size * sizeof(*ps)); 86 force_assert(NULL != srv->plugins.ptr); 87 } 88 89 ps = srv->plugins.ptr; 90 ps[srv->plugins.used++] = p; 91 } 92 93 /** 94 * 95 * 96 * 97 */ 98 99 #if defined(LIGHTTPD_STATIC) 100 101 /* pre-declare functions, as there is no header for them */ 102 #define PLUGIN_INIT(x)\ 103 int x ## _plugin_init(plugin *p); 104 105 #include "plugin-static.h" 106 107 #undef PLUGIN_INIT 108 109 /* build NULL-terminated table of name + init-function */ 110 111 typedef struct { 112 const char* name; 113 int (*plugin_init)(plugin *p); 114 } plugin_load_functions; 115 116 static const plugin_load_functions load_functions[] = { 117 #define PLUGIN_INIT(x) \ 118 { #x, &x ## _plugin_init }, 119 120 #include "plugin-static.h" 121 122 { NULL, NULL } 123 #undef PLUGIN_INIT 124 }; 125 126 int plugins_load(server *srv) { 127 for (uint32_t i = 0; i < srv->srvconf.modules->used; ++i) { 128 data_string *ds = (data_string *)srv->srvconf.modules->data[i]; 129 char *module = ds->value.ptr; 130 131 uint32_t j; 132 for (j = 0; j < i; ++j) { 133 if (buffer_is_equal(&ds->value, &((data_string *) srv->srvconf.modules->data[j])->value)) { 134 log_error(srv->errh, __FILE__, __LINE__, 135 "Cannot load plugin %s " 136 "more than once, please fix your config (lighttpd may not accept such configs in future releases)", 137 ds->value.ptr); 138 continue; 139 } 140 } 141 142 for (j = 0; load_functions[j].name; ++j) { 143 if (0 == strcmp(load_functions[j].name, module)) { 144 plugin * const p = plugin_init(); 145 if ((*load_functions[j].plugin_init)(p)) { 146 log_error(srv->errh, __FILE__, __LINE__, "%s plugin init failed", module); 147 plugin_free(p); 148 return -1; 149 } 150 plugins_register(srv, p); 151 break; 152 } 153 } 154 if (!load_functions[j].name) { 155 log_error(srv->errh, __FILE__, __LINE__, "%s plugin not found", module); 156 return -1; 157 } 158 } 159 160 return 0; 161 } 162 #else /* defined(LIGHTTPD_STATIC) */ 163 int plugins_load(server *srv) { 164 plugin *p; 165 int (*init)(plugin *pl); 166 size_t i, j; 167 168 for (i = 0; i < srv->srvconf.modules->used; i++) { 169 data_string *ds = (data_string *)srv->srvconf.modules->data[i]; 170 char *module = ds->value.ptr; 171 172 for (j = 0; j < i; j++) { 173 if (buffer_is_equal(&ds->value, &((data_string *) srv->srvconf.modules->data[j])->value)) { 174 log_error(srv->errh, __FILE__, __LINE__, 175 "Cannot load plugin %s " 176 "more than once, please fix your config (lighttpd may not accept such configs in future releases)", 177 ds->value.ptr); 178 continue; 179 } 180 } 181 182 buffer_copy_buffer(srv->tmp_buf, srv->srvconf.modules_dir); 183 184 buffer_append_string_len(srv->tmp_buf, CONST_STR_LEN("/")); 185 buffer_append_string(srv->tmp_buf, module); 186 #if defined(__WIN32) || defined(__CYGWIN__) 187 buffer_append_string_len(srv->tmp_buf, CONST_STR_LEN(".dll")); 188 #else 189 buffer_append_string_len(srv->tmp_buf, CONST_STR_LEN(".so")); 190 #endif 191 192 p = plugin_init(); 193 #ifdef __WIN32 194 if (NULL == (p->lib = LoadLibrary(srv->tmp_buf->ptr))) { 195 LPVOID lpMsgBuf; 196 FormatMessage( 197 FORMAT_MESSAGE_ALLOCATE_BUFFER | 198 FORMAT_MESSAGE_FROM_SYSTEM, 199 NULL, 200 GetLastError(), 201 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), 202 (LPTSTR) &lpMsgBuf, 203 0, NULL); 204 205 log_error(srv->errh, __FILE__, __LINE__, 206 "LoadLibrary() failed %s %s", lpMsgBuf, srv->tmp_buf->ptr); 207 208 plugin_free(p); 209 210 return -1; 211 212 } 213 #else 214 if (NULL == (p->lib = dlopen(srv->tmp_buf->ptr, RTLD_NOW|RTLD_GLOBAL))) { 215 log_error(srv->errh, __FILE__, __LINE__, 216 "dlopen() failed for: %s %s", srv->tmp_buf->ptr, dlerror()); 217 218 plugin_free(p); 219 220 return -1; 221 } 222 223 #endif 224 buffer_copy_string(srv->tmp_buf, module); 225 buffer_append_string_len(srv->tmp_buf, CONST_STR_LEN("_plugin_init")); 226 227 #ifdef __WIN32 228 init = GetProcAddress(p->lib, srv->tmp_buf->ptr); 229 230 if (init == NULL) { 231 LPVOID lpMsgBuf; 232 FormatMessage( 233 FORMAT_MESSAGE_ALLOCATE_BUFFER | 234 FORMAT_MESSAGE_FROM_SYSTEM, 235 NULL, 236 GetLastError(), 237 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), 238 (LPTSTR) &lpMsgBuf, 239 0, NULL); 240 241 log_error(srv->errh, __FILE__, __LINE__, 242 "getprocaddress failed: %s %s", srv->tmp_buf->ptr, lpMsgBuf); 243 244 plugin_free(p); 245 return -1; 246 } 247 248 #else 249 #if 1 250 init = (int (*)(plugin *))(intptr_t)dlsym(p->lib, srv->tmp_buf->ptr); 251 #else 252 *(void **)(&init) = dlsym(p->lib, srv->tmp_buf->ptr); 253 #endif 254 if (NULL == init) { 255 const char *error = dlerror(); 256 if (error != NULL) { 257 log_error(srv->errh, __FILE__, __LINE__, "dlsym: %s", error); 258 } else { 259 log_error(srv->errh, __FILE__, __LINE__, "dlsym symbol not found: %s", srv->tmp_buf->ptr); 260 } 261 262 plugin_free(p); 263 return -1; 264 } 265 266 #endif 267 if ((*init)(p)) { 268 log_error(srv->errh, __FILE__, __LINE__, "%s plugin init failed", module); 269 270 plugin_free(p); 271 return -1; 272 } 273 #if 0 274 log_error(srv->errh, __FILE__, __LINE__, "%s plugin loaded", module); 275 #endif 276 plugins_register(srv, p); 277 } 278 279 return 0; 280 } 281 #endif /* defined(LIGHTTPD_STATIC) */ 282 283 typedef struct { 284 handler_t(*fn)(); 285 plugin_data_base *data; 286 } plugin_fn_data; 287 288 __attribute_hot__ 289 static handler_t plugins_call_fn_con_data(connection * const con, const int e) { 290 const void * const plugin_slots = con->plugin_slots; 291 const uint32_t offset = ((const uint16_t *)plugin_slots)[e]; 292 if (0 == offset) return HANDLER_GO_ON; 293 const plugin_fn_data *plfd = (const plugin_fn_data *) 294 (((uintptr_t)plugin_slots) + offset); 295 handler_t rc = HANDLER_GO_ON; 296 while (plfd->fn && (rc = plfd->fn(con, plfd->data)) == HANDLER_GO_ON) 297 ++plfd; 298 return rc; 299 } 300 301 static handler_t plugins_call_fn_srv_data(server * const srv, const int e) { 302 const uint32_t offset = ((const uint16_t *)srv->plugin_slots)[e]; 303 if (0 == offset) return HANDLER_GO_ON; 304 const plugin_fn_data *plfd = (const plugin_fn_data *) 305 (((uintptr_t)srv->plugin_slots) + offset); 306 handler_t rc = HANDLER_GO_ON; 307 while (plfd->fn && (rc = plfd->fn(srv,plfd->data)) == HANDLER_GO_ON) 308 ++plfd; 309 return rc; 310 } 311 312 static void plugins_call_fn_srv_data_all(server * const srv, const int e) { 313 const uint32_t offset = ((const uint16_t *)srv->plugin_slots)[e]; 314 if (0 == offset) return; 315 const plugin_fn_data *plfd = (const plugin_fn_data *) 316 (((uintptr_t)srv->plugin_slots) + offset); 317 for (; plfd->fn; ++plfd) 318 plfd->fn(srv, plfd->data); 319 } 320 321 /** 322 * plugins that use 323 * 324 * - server *srv 325 * - connection *con 326 * - void *p_d (plugin_data *) 327 */ 328 329 #define PLUGIN_CALL_FN_CON_DATA(x, y) \ 330 handler_t plugins_call_##y(connection *con) {\ 331 return plugins_call_fn_con_data(con, x); \ 332 } 333 334 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_URI_CLEAN, handle_uri_clean) 335 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_URI_RAW, handle_uri_raw) 336 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_REQUEST_ENV, handle_request_env) 337 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_REQUEST_DONE, handle_request_done) 338 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_CONNECTION_ACCEPT, handle_connection_accept) 339 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_CONNECTION_SHUT_WR, handle_connection_shut_wr) 340 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_CONNECTION_CLOSE, handle_connection_close) 341 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_SUBREQUEST, handle_subrequest) 342 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_SUBREQUEST_START, handle_subrequest_start) 343 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_RESPONSE_START, handle_response_start) 344 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_DOCROOT, handle_docroot) 345 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_PHYSICAL, handle_physical) 346 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_CONNECTION_RESET, connection_reset) 347 348 #undef PLUGIN_CALL_FN_SRV_CON_DATA 349 350 /** 351 * plugins that use 352 * 353 * - server *srv 354 * - void *p_d (plugin_data *) 355 */ 356 357 handler_t plugins_call_set_defaults(server *srv) { 358 return plugins_call_fn_srv_data(srv, PLUGIN_FUNC_SET_DEFAULTS); 359 } 360 361 handler_t plugins_call_worker_init(server *srv) { 362 return plugins_call_fn_srv_data(srv, PLUGIN_FUNC_WORKER_INIT); 363 } 364 365 void plugins_call_handle_trigger(server *srv) { 366 plugins_call_fn_srv_data_all(srv, PLUGIN_FUNC_HANDLE_TRIGGER); 367 } 368 369 void plugins_call_handle_sighup(server *srv) { 370 plugins_call_fn_srv_data_all(srv, PLUGIN_FUNC_HANDLE_SIGHUP); 371 } 372 373 handler_t plugins_call_handle_waitpid(server *srv, pid_t pid, int status) { 374 const uint32_t offset = 375 ((const uint16_t *)srv->plugin_slots)[PLUGIN_FUNC_HANDLE_WAITPID]; 376 if (0 == offset) return HANDLER_GO_ON; 377 const plugin_fn_data *plfd = (const plugin_fn_data *) 378 (((uintptr_t)srv->plugin_slots) + offset); 379 handler_t rc = HANDLER_GO_ON; 380 while (plfd->fn&&(rc=plfd->fn(srv,plfd->data,pid,status))==HANDLER_GO_ON) 381 ++plfd; 382 return rc; 383 } 384 385 static void plugins_call_cleanup(server * const srv) { 386 plugin ** const ps = srv->plugins.ptr; 387 for (uint32_t i = 0; i < srv->plugins.used; ++i) { 388 plugin *p = ps[i]; 389 if (NULL == p) continue; 390 if (NULL != p->data) { 391 plugin_data_base *pd = p->data; 392 if (p->cleanup) 393 p->cleanup(p->data); 394 free(pd->cvlist); 395 free(pd); 396 p->data = NULL; 397 } 398 } 399 } 400 401 /** 402 * 403 * - call init function of all plugins to init the plugin-internals 404 * - added each plugin that supports has callback to the corresponding slot 405 * 406 * - is only called once. 407 */ 408 409 __attribute_cold__ 410 static void plugins_call_init_slot(server *srv, handler_t(*fn)(), void *data, const uint32_t offset) { 411 if (fn) { 412 plugin_fn_data *plfd = (plugin_fn_data *) 413 (((uintptr_t)srv->plugin_slots) + offset); 414 while (plfd->fn) ++plfd; 415 plfd->fn = fn; 416 plfd->data = data; 417 } 418 } 419 420 handler_t plugins_call_init(server *srv) { 421 plugin ** const ps = srv->plugins.ptr; 422 uint16_t offsets[PLUGIN_FUNC_SIZEOF]; 423 memset(offsets, 0, sizeof(offsets)); 424 425 for (uint32_t i = 0; i < srv->plugins.used; ++i) { 426 /* check which calls are supported */ 427 428 plugin *p = ps[i]; 429 430 if (p->init) { 431 if (NULL == (p->data = p->init())) { 432 log_error(srv->errh, __FILE__, __LINE__, 433 "plugin-init failed for module %s", p->name); 434 return HANDLER_ERROR; 435 } 436 437 /* used for con->mode, DIRECT == 0, plugins above that */ 438 ((plugin_data_base *)(p->data))->id = i + 1; 439 440 if (p->version != LIGHTTPD_VERSION_ID) { 441 log_error(srv->errh, __FILE__, __LINE__, 442 "plugin-version doesn't match lighttpd-version for %s", p->name); 443 return HANDLER_ERROR; 444 } 445 } 446 447 if (p->priv_defaults && HANDLER_ERROR==p->priv_defaults(srv, p->data)) { 448 return HANDLER_ERROR; 449 } 450 451 if (p->handle_uri_clean) 452 ++offsets[PLUGIN_FUNC_HANDLE_URI_CLEAN]; 453 if (p->handle_uri_raw) 454 ++offsets[PLUGIN_FUNC_HANDLE_URI_RAW]; 455 if (p->handle_request_env) 456 ++offsets[PLUGIN_FUNC_HANDLE_REQUEST_ENV]; 457 if (p->handle_request_done) 458 ++offsets[PLUGIN_FUNC_HANDLE_REQUEST_DONE]; 459 if (p->handle_connection_accept) 460 ++offsets[PLUGIN_FUNC_HANDLE_CONNECTION_ACCEPT]; 461 if (p->handle_connection_shut_wr) 462 ++offsets[PLUGIN_FUNC_HANDLE_CONNECTION_SHUT_WR]; 463 if (p->handle_connection_close) 464 ++offsets[PLUGIN_FUNC_HANDLE_CONNECTION_CLOSE]; 465 if (p->handle_trigger) 466 ++offsets[PLUGIN_FUNC_HANDLE_TRIGGER]; 467 if (p->handle_sighup) 468 ++offsets[PLUGIN_FUNC_HANDLE_SIGHUP]; 469 if (p->handle_waitpid) 470 ++offsets[PLUGIN_FUNC_HANDLE_WAITPID]; 471 if (p->handle_subrequest) 472 ++offsets[PLUGIN_FUNC_HANDLE_SUBREQUEST]; 473 if (p->handle_subrequest_start) 474 ++offsets[PLUGIN_FUNC_HANDLE_SUBREQUEST_START]; 475 if (p->handle_response_start) 476 ++offsets[PLUGIN_FUNC_HANDLE_RESPONSE_START]; 477 if (p->handle_docroot) 478 ++offsets[PLUGIN_FUNC_HANDLE_DOCROOT]; 479 if (p->handle_physical) 480 ++offsets[PLUGIN_FUNC_HANDLE_PHYSICAL]; 481 if (p->connection_reset) 482 ++offsets[PLUGIN_FUNC_CONNECTION_RESET]; 483 if (p->set_defaults) 484 ++offsets[PLUGIN_FUNC_SET_DEFAULTS]; 485 if (p->worker_init) 486 ++offsets[PLUGIN_FUNC_WORKER_INIT]; 487 } 488 489 uint32_t nslots = 490 (sizeof(offsets)+sizeof(plugin_fn_data)-1) / sizeof(plugin_fn_data); 491 for (uint32_t i = 0; i < PLUGIN_FUNC_SIZEOF; ++i) { 492 if (offsets[i]) { 493 uint32_t offset = nslots; 494 nslots += offsets[i]+1; /* +1 to mark end of each list */ 495 force_assert(offset * sizeof(plugin_fn_data) <= USHRT_MAX); 496 offsets[i] = (uint16_t)(offset * sizeof(plugin_fn_data)); 497 } 498 } 499 500 /* allocate and fill slots of two dimensional array */ 501 srv->plugin_slots = calloc(nslots, sizeof(plugin_fn_data)); 502 force_assert(NULL != srv->plugin_slots); 503 memcpy(srv->plugin_slots, offsets, sizeof(offsets)); 504 505 for (uint32_t i = 0; i < srv->plugins.used; ++i) { 506 plugin * const p = ps[i]; 507 508 plugins_call_init_slot(srv, p->handle_uri_clean, p->data, 509 offsets[PLUGIN_FUNC_HANDLE_URI_CLEAN]); 510 plugins_call_init_slot(srv, p->handle_uri_raw, p->data, 511 offsets[PLUGIN_FUNC_HANDLE_URI_RAW]); 512 plugins_call_init_slot(srv, p->handle_request_env, p->data, 513 offsets[PLUGIN_FUNC_HANDLE_REQUEST_ENV]); 514 plugins_call_init_slot(srv, p->handle_request_done, p->data, 515 offsets[PLUGIN_FUNC_HANDLE_REQUEST_DONE]); 516 plugins_call_init_slot(srv, p->handle_connection_accept, p->data, 517 offsets[PLUGIN_FUNC_HANDLE_CONNECTION_ACCEPT]); 518 plugins_call_init_slot(srv, p->handle_connection_shut_wr, p->data, 519 offsets[PLUGIN_FUNC_HANDLE_CONNECTION_SHUT_WR]); 520 plugins_call_init_slot(srv, p->handle_connection_close, p->data, 521 offsets[PLUGIN_FUNC_HANDLE_CONNECTION_CLOSE]); 522 plugins_call_init_slot(srv, p->handle_trigger, p->data, 523 offsets[PLUGIN_FUNC_HANDLE_TRIGGER]); 524 plugins_call_init_slot(srv, p->handle_sighup, p->data, 525 offsets[PLUGIN_FUNC_HANDLE_SIGHUP]); 526 plugins_call_init_slot(srv, p->handle_waitpid, p->data, 527 offsets[PLUGIN_FUNC_HANDLE_WAITPID]); 528 plugins_call_init_slot(srv, p->handle_subrequest, p->data, 529 offsets[PLUGIN_FUNC_HANDLE_SUBREQUEST]); 530 plugins_call_init_slot(srv, p->handle_subrequest_start, p->data, 531 offsets[PLUGIN_FUNC_HANDLE_SUBREQUEST_START]); 532 plugins_call_init_slot(srv, p->handle_response_start, p->data, 533 offsets[PLUGIN_FUNC_HANDLE_RESPONSE_START]); 534 plugins_call_init_slot(srv, p->handle_docroot, p->data, 535 offsets[PLUGIN_FUNC_HANDLE_DOCROOT]); 536 plugins_call_init_slot(srv, p->handle_physical, p->data, 537 offsets[PLUGIN_FUNC_HANDLE_PHYSICAL]); 538 plugins_call_init_slot(srv, p->connection_reset, p->data, 539 offsets[PLUGIN_FUNC_CONNECTION_RESET]); 540 plugins_call_init_slot(srv, p->set_defaults, p->data, 541 offsets[PLUGIN_FUNC_SET_DEFAULTS]); 542 plugins_call_init_slot(srv, p->worker_init, p->data, 543 offsets[PLUGIN_FUNC_WORKER_INIT]); 544 } 545 546 return HANDLER_GO_ON; 547 } 548 549 void plugins_free(server *srv) { 550 if (srv->plugin_slots) { 551 plugins_call_cleanup(srv); 552 free(srv->plugin_slots); 553 srv->plugin_slots = NULL; 554 } 555 556 for (uint32_t i = 0; i < srv->plugins.used; ++i) { 557 plugin_free(((plugin **)srv->plugins.ptr)[i]); 558 } 559 free(srv->plugins.ptr); 560 srv->plugins.ptr = NULL; 561 srv->plugins.used = 0; 562 srv->plugins.size = 0; 563 array_free_data(&plugin_stats); 564 } 565