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 buffer * const tb = srv->tmp_buf; 165 plugin *p; 166 int (*init)(plugin *pl); 167 size_t i, j; 168 169 for (i = 0; i < srv->srvconf.modules->used; i++) { 170 data_string *ds = (data_string *)srv->srvconf.modules->data[i]; 171 char *module = ds->value.ptr; 172 173 for (j = 0; j < i; j++) { 174 if (buffer_is_equal(&ds->value, &((data_string *) srv->srvconf.modules->data[j])->value)) { 175 log_error(srv->errh, __FILE__, __LINE__, 176 "Cannot load plugin %s " 177 "more than once, please fix your config (lighttpd may not accept such configs in future releases)", 178 ds->value.ptr); 179 continue; 180 } 181 } 182 183 buffer_copy_buffer(tb, srv->srvconf.modules_dir); 184 185 buffer_append_string_len(tb, CONST_STR_LEN("/")); 186 buffer_append_string(tb, module); 187 #if defined(__WIN32) || defined(__CYGWIN__) 188 buffer_append_string_len(tb, CONST_STR_LEN(".dll")); 189 #else 190 buffer_append_string_len(tb, CONST_STR_LEN(".so")); 191 #endif 192 193 p = plugin_init(); 194 #ifdef __WIN32 195 if (NULL == (p->lib = LoadLibrary(tb->ptr))) { 196 LPVOID lpMsgBuf; 197 FormatMessage( 198 FORMAT_MESSAGE_ALLOCATE_BUFFER | 199 FORMAT_MESSAGE_FROM_SYSTEM, 200 NULL, 201 GetLastError(), 202 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), 203 (LPTSTR) &lpMsgBuf, 204 0, NULL); 205 206 log_error(srv->errh, __FILE__, __LINE__, 207 "LoadLibrary() failed %s %s", lpMsgBuf, tb->ptr); 208 209 plugin_free(p); 210 211 return -1; 212 213 } 214 #else 215 if (NULL == (p->lib = dlopen(tb->ptr, RTLD_NOW|RTLD_GLOBAL))) { 216 log_error(srv->errh, __FILE__, __LINE__, 217 "dlopen() failed for: %s %s", tb->ptr, dlerror()); 218 219 plugin_free(p); 220 221 return -1; 222 } 223 224 #endif 225 buffer_copy_string(tb, module); 226 buffer_append_string_len(tb, CONST_STR_LEN("_plugin_init")); 227 228 #ifdef __WIN32 229 init = GetProcAddress(p->lib, tb->ptr); 230 231 if (init == NULL) { 232 LPVOID lpMsgBuf; 233 FormatMessage( 234 FORMAT_MESSAGE_ALLOCATE_BUFFER | 235 FORMAT_MESSAGE_FROM_SYSTEM, 236 NULL, 237 GetLastError(), 238 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), 239 (LPTSTR) &lpMsgBuf, 240 0, NULL); 241 242 log_error(srv->errh, __FILE__, __LINE__, 243 "getprocaddress failed: %s %s", tb->ptr, lpMsgBuf); 244 245 plugin_free(p); 246 return -1; 247 } 248 249 #else 250 #if 1 251 init = (int (*)(plugin *))(intptr_t)dlsym(p->lib, tb->ptr); 252 #else 253 *(void **)(&init) = dlsym(p->lib, tb->ptr); 254 #endif 255 if (NULL == init) { 256 const char *error = dlerror(); 257 if (error != NULL) { 258 log_error(srv->errh, __FILE__, __LINE__, "dlsym: %s", error); 259 } else { 260 log_error(srv->errh, __FILE__, __LINE__, "dlsym symbol not found: %s", tb->ptr); 261 } 262 263 plugin_free(p); 264 return -1; 265 } 266 267 #endif 268 if ((*init)(p)) { 269 log_error(srv->errh, __FILE__, __LINE__, "%s plugin init failed", module); 270 271 plugin_free(p); 272 return -1; 273 } 274 #if 0 275 log_error(srv->errh, __FILE__, __LINE__, "%s plugin loaded", module); 276 #endif 277 plugins_register(srv, p); 278 } 279 280 return 0; 281 } 282 #endif /* defined(LIGHTTPD_STATIC) */ 283 284 typedef struct { 285 handler_t(*fn)(); 286 plugin_data_base *data; 287 } plugin_fn_data; 288 289 __attribute_hot__ 290 static handler_t plugins_call_fn_con_data(connection * const con, const int e) { 291 const void * const plugin_slots = con->plugin_slots; 292 const uint32_t offset = ((const uint16_t *)plugin_slots)[e]; 293 if (0 == offset) return HANDLER_GO_ON; 294 const plugin_fn_data *plfd = (const plugin_fn_data *) 295 (((uintptr_t)plugin_slots) + offset); 296 handler_t rc = HANDLER_GO_ON; 297 while (plfd->fn && (rc = plfd->fn(con, plfd->data)) == HANDLER_GO_ON) 298 ++plfd; 299 return rc; 300 } 301 302 static handler_t plugins_call_fn_srv_data(server * const srv, const int e) { 303 const uint32_t offset = ((const uint16_t *)srv->plugin_slots)[e]; 304 if (0 == offset) return HANDLER_GO_ON; 305 const plugin_fn_data *plfd = (const plugin_fn_data *) 306 (((uintptr_t)srv->plugin_slots) + offset); 307 handler_t rc = HANDLER_GO_ON; 308 while (plfd->fn && (rc = plfd->fn(srv,plfd->data)) == HANDLER_GO_ON) 309 ++plfd; 310 return rc; 311 } 312 313 static void plugins_call_fn_srv_data_all(server * const srv, const int e) { 314 const uint32_t offset = ((const uint16_t *)srv->plugin_slots)[e]; 315 if (0 == offset) return; 316 const plugin_fn_data *plfd = (const plugin_fn_data *) 317 (((uintptr_t)srv->plugin_slots) + offset); 318 for (; plfd->fn; ++plfd) 319 plfd->fn(srv, plfd->data); 320 } 321 322 /** 323 * plugins that use 324 * 325 * - server *srv 326 * - connection *con 327 * - void *p_d (plugin_data *) 328 */ 329 330 #define PLUGIN_CALL_FN_CON_DATA(x, y) \ 331 handler_t plugins_call_##y(connection *con) {\ 332 return plugins_call_fn_con_data(con, x); \ 333 } 334 335 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_URI_CLEAN, handle_uri_clean) 336 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_URI_RAW, handle_uri_raw) 337 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_REQUEST_ENV, handle_request_env) 338 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_REQUEST_DONE, handle_request_done) 339 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_CONNECTION_ACCEPT, handle_connection_accept) 340 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_CONNECTION_SHUT_WR, handle_connection_shut_wr) 341 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_CONNECTION_CLOSE, handle_connection_close) 342 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_SUBREQUEST, handle_subrequest) 343 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_SUBREQUEST_START, handle_subrequest_start) 344 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_RESPONSE_START, handle_response_start) 345 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_DOCROOT, handle_docroot) 346 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_HANDLE_PHYSICAL, handle_physical) 347 PLUGIN_CALL_FN_CON_DATA(PLUGIN_FUNC_CONNECTION_RESET, connection_reset) 348 349 #undef PLUGIN_CALL_FN_SRV_CON_DATA 350 351 /** 352 * plugins that use 353 * 354 * - server *srv 355 * - void *p_d (plugin_data *) 356 */ 357 358 handler_t plugins_call_set_defaults(server *srv) { 359 return plugins_call_fn_srv_data(srv, PLUGIN_FUNC_SET_DEFAULTS); 360 } 361 362 handler_t plugins_call_worker_init(server *srv) { 363 return plugins_call_fn_srv_data(srv, PLUGIN_FUNC_WORKER_INIT); 364 } 365 366 void plugins_call_handle_trigger(server *srv) { 367 plugins_call_fn_srv_data_all(srv, PLUGIN_FUNC_HANDLE_TRIGGER); 368 } 369 370 void plugins_call_handle_sighup(server *srv) { 371 plugins_call_fn_srv_data_all(srv, PLUGIN_FUNC_HANDLE_SIGHUP); 372 } 373 374 handler_t plugins_call_handle_waitpid(server *srv, pid_t pid, int status) { 375 const uint32_t offset = 376 ((const uint16_t *)srv->plugin_slots)[PLUGIN_FUNC_HANDLE_WAITPID]; 377 if (0 == offset) return HANDLER_GO_ON; 378 const plugin_fn_data *plfd = (const plugin_fn_data *) 379 (((uintptr_t)srv->plugin_slots) + offset); 380 handler_t rc = HANDLER_GO_ON; 381 while (plfd->fn&&(rc=plfd->fn(srv,plfd->data,pid,status))==HANDLER_GO_ON) 382 ++plfd; 383 return rc; 384 } 385 386 static void plugins_call_cleanup(server * const srv) { 387 plugin ** const ps = srv->plugins.ptr; 388 for (uint32_t i = 0; i < srv->plugins.used; ++i) { 389 plugin *p = ps[i]; 390 if (NULL == p) continue; 391 if (NULL != p->data) { 392 plugin_data_base *pd = p->data; 393 if (p->cleanup) 394 p->cleanup(p->data); 395 free(pd->cvlist); 396 free(pd); 397 p->data = NULL; 398 } 399 } 400 } 401 402 /** 403 * 404 * - call init function of all plugins to init the plugin-internals 405 * - added each plugin that supports has callback to the corresponding slot 406 * 407 * - is only called once. 408 */ 409 410 __attribute_cold__ 411 static void plugins_call_init_slot(server *srv, handler_t(*fn)(), void *data, const uint32_t offset) { 412 if (fn) { 413 plugin_fn_data *plfd = (plugin_fn_data *) 414 (((uintptr_t)srv->plugin_slots) + offset); 415 while (plfd->fn) ++plfd; 416 plfd->fn = fn; 417 plfd->data = data; 418 } 419 } 420 421 handler_t plugins_call_init(server *srv) { 422 plugin ** const ps = srv->plugins.ptr; 423 uint16_t offsets[PLUGIN_FUNC_SIZEOF]; 424 memset(offsets, 0, sizeof(offsets)); 425 426 for (uint32_t i = 0; i < srv->plugins.used; ++i) { 427 /* check which calls are supported */ 428 429 plugin *p = ps[i]; 430 431 if (p->init) { 432 if (NULL == (p->data = p->init())) { 433 log_error(srv->errh, __FILE__, __LINE__, 434 "plugin-init failed for module %s", p->name); 435 return HANDLER_ERROR; 436 } 437 438 ((plugin_data_base *)(p->data))->self = p; 439 ((plugin_data_base *)(p->data))->id = i + 1; 440 441 if (p->version != LIGHTTPD_VERSION_ID) { 442 log_error(srv->errh, __FILE__, __LINE__, 443 "plugin-version doesn't match lighttpd-version for %s", p->name); 444 return HANDLER_ERROR; 445 } 446 } 447 448 if (p->priv_defaults && HANDLER_ERROR==p->priv_defaults(srv, p->data)) { 449 return HANDLER_ERROR; 450 } 451 452 if (p->handle_uri_clean) 453 ++offsets[PLUGIN_FUNC_HANDLE_URI_CLEAN]; 454 if (p->handle_uri_raw) 455 ++offsets[PLUGIN_FUNC_HANDLE_URI_RAW]; 456 if (p->handle_request_env) 457 ++offsets[PLUGIN_FUNC_HANDLE_REQUEST_ENV]; 458 if (p->handle_request_done) 459 ++offsets[PLUGIN_FUNC_HANDLE_REQUEST_DONE]; 460 if (p->handle_connection_accept) 461 ++offsets[PLUGIN_FUNC_HANDLE_CONNECTION_ACCEPT]; 462 if (p->handle_connection_shut_wr) 463 ++offsets[PLUGIN_FUNC_HANDLE_CONNECTION_SHUT_WR]; 464 if (p->handle_connection_close) 465 ++offsets[PLUGIN_FUNC_HANDLE_CONNECTION_CLOSE]; 466 if (p->handle_trigger) 467 ++offsets[PLUGIN_FUNC_HANDLE_TRIGGER]; 468 if (p->handle_sighup) 469 ++offsets[PLUGIN_FUNC_HANDLE_SIGHUP]; 470 if (p->handle_waitpid) 471 ++offsets[PLUGIN_FUNC_HANDLE_WAITPID]; 472 if (p->handle_subrequest) 473 ++offsets[PLUGIN_FUNC_HANDLE_SUBREQUEST]; 474 if (p->handle_subrequest_start) 475 ++offsets[PLUGIN_FUNC_HANDLE_SUBREQUEST_START]; 476 if (p->handle_response_start) 477 ++offsets[PLUGIN_FUNC_HANDLE_RESPONSE_START]; 478 if (p->handle_docroot) 479 ++offsets[PLUGIN_FUNC_HANDLE_DOCROOT]; 480 if (p->handle_physical) 481 ++offsets[PLUGIN_FUNC_HANDLE_PHYSICAL]; 482 if (p->connection_reset) 483 ++offsets[PLUGIN_FUNC_CONNECTION_RESET]; 484 if (p->set_defaults) 485 ++offsets[PLUGIN_FUNC_SET_DEFAULTS]; 486 if (p->worker_init) 487 ++offsets[PLUGIN_FUNC_WORKER_INIT]; 488 } 489 490 uint32_t nslots = 491 (sizeof(offsets)+sizeof(plugin_fn_data)-1) / sizeof(plugin_fn_data); 492 for (uint32_t i = 0; i < PLUGIN_FUNC_SIZEOF; ++i) { 493 if (offsets[i]) { 494 uint32_t offset = nslots; 495 nslots += offsets[i]+1; /* +1 to mark end of each list */ 496 force_assert(offset * sizeof(plugin_fn_data) <= USHRT_MAX); 497 offsets[i] = (uint16_t)(offset * sizeof(plugin_fn_data)); 498 } 499 } 500 501 /* allocate and fill slots of two dimensional array */ 502 srv->plugin_slots = calloc(nslots, sizeof(plugin_fn_data)); 503 force_assert(NULL != srv->plugin_slots); 504 memcpy(srv->plugin_slots, offsets, sizeof(offsets)); 505 506 for (uint32_t i = 0; i < srv->plugins.used; ++i) { 507 plugin * const p = ps[i]; 508 509 plugins_call_init_slot(srv, p->handle_uri_clean, p->data, 510 offsets[PLUGIN_FUNC_HANDLE_URI_CLEAN]); 511 plugins_call_init_slot(srv, p->handle_uri_raw, p->data, 512 offsets[PLUGIN_FUNC_HANDLE_URI_RAW]); 513 plugins_call_init_slot(srv, p->handle_request_env, p->data, 514 offsets[PLUGIN_FUNC_HANDLE_REQUEST_ENV]); 515 plugins_call_init_slot(srv, p->handle_request_done, p->data, 516 offsets[PLUGIN_FUNC_HANDLE_REQUEST_DONE]); 517 plugins_call_init_slot(srv, p->handle_connection_accept, p->data, 518 offsets[PLUGIN_FUNC_HANDLE_CONNECTION_ACCEPT]); 519 plugins_call_init_slot(srv, p->handle_connection_shut_wr, p->data, 520 offsets[PLUGIN_FUNC_HANDLE_CONNECTION_SHUT_WR]); 521 plugins_call_init_slot(srv, p->handle_connection_close, p->data, 522 offsets[PLUGIN_FUNC_HANDLE_CONNECTION_CLOSE]); 523 plugins_call_init_slot(srv, p->handle_trigger, p->data, 524 offsets[PLUGIN_FUNC_HANDLE_TRIGGER]); 525 plugins_call_init_slot(srv, p->handle_sighup, p->data, 526 offsets[PLUGIN_FUNC_HANDLE_SIGHUP]); 527 plugins_call_init_slot(srv, p->handle_waitpid, p->data, 528 offsets[PLUGIN_FUNC_HANDLE_WAITPID]); 529 plugins_call_init_slot(srv, p->handle_subrequest, p->data, 530 offsets[PLUGIN_FUNC_HANDLE_SUBREQUEST]); 531 plugins_call_init_slot(srv, p->handle_subrequest_start, p->data, 532 offsets[PLUGIN_FUNC_HANDLE_SUBREQUEST_START]); 533 plugins_call_init_slot(srv, p->handle_response_start, p->data, 534 offsets[PLUGIN_FUNC_HANDLE_RESPONSE_START]); 535 plugins_call_init_slot(srv, p->handle_docroot, p->data, 536 offsets[PLUGIN_FUNC_HANDLE_DOCROOT]); 537 plugins_call_init_slot(srv, p->handle_physical, p->data, 538 offsets[PLUGIN_FUNC_HANDLE_PHYSICAL]); 539 plugins_call_init_slot(srv, p->connection_reset, p->data, 540 offsets[PLUGIN_FUNC_CONNECTION_RESET]); 541 plugins_call_init_slot(srv, p->set_defaults, p->data, 542 offsets[PLUGIN_FUNC_SET_DEFAULTS]); 543 plugins_call_init_slot(srv, p->worker_init, p->data, 544 offsets[PLUGIN_FUNC_WORKER_INIT]); 545 } 546 547 return HANDLER_GO_ON; 548 } 549 550 void plugins_free(server *srv) { 551 if (srv->plugin_slots) { 552 plugins_call_cleanup(srv); 553 free(srv->plugin_slots); 554 srv->plugin_slots = NULL; 555 } 556 557 for (uint32_t i = 0; i < srv->plugins.used; ++i) { 558 plugin_free(((plugin **)srv->plugins.ptr)[i]); 559 } 560 free(srv->plugins.ptr); 561 srv->plugins.ptr = NULL; 562 srv->plugins.used = 0; 563 srv->plugins.size = 0; 564 array_free_data(&plugin_stats); 565 } 566