1 #ifndef _PLUGIN_H_ 2 #define _PLUGIN_H_ 3 #include "first.h" 4 5 #include "base_decls.h" 6 #include "buffer.h" 7 #include "array.h" 8 #include "plugin_config.h" 9 10 11 /** 12 * The status array can carry all the status information you want 13 * the key to the array is <module-prefix>.<name> 14 * and the values are counters 15 * 16 * example: 17 * fastcgi.backends = 10 18 * fastcgi.active-backends = 6 19 * fastcgi.backend.<key>.load = 24 20 * fastcgi.backend.<key>.... 21 * 22 * fastcgi.backend.<key>.disconnects = ... 23 */ 24 extern array plugin_stats; 25 26 27 #define SERVER_FUNC(x) \ 28 static handler_t x(server *srv, void *p_d) 29 30 #define CONNECTION_FUNC(x) \ 31 static handler_t x(connection *con, void *p_d) 32 33 #define REQUEST_FUNC(x) \ 34 static handler_t x(request_st *r, void *p_d) 35 36 #define INIT_FUNC(x) \ 37 __attribute_cold__ \ 38 static void *x(void) 39 40 #define FREE_FUNC(x) \ 41 __attribute_cold__ \ 42 static void x(void *p_d) 43 44 #define SETDEFAULTS_FUNC __attribute_cold__ SERVER_FUNC 45 #define SIGHUP_FUNC __attribute_cold__ SERVER_FUNC 46 #define TRIGGER_FUNC SERVER_FUNC 47 48 #define SUBREQUEST_FUNC REQUEST_FUNC 49 #define PHYSICALPATH_FUNC REQUEST_FUNC 50 #define REQUESTDONE_FUNC REQUEST_FUNC 51 #define URIHANDLER_FUNC REQUEST_FUNC 52 53 #define PLUGIN_DATA int id; \ 54 int nconfig; \ 55 config_plugin_value_t *cvlist; \ 56 struct plugin *self 57 58 typedef struct { 59 PLUGIN_DATA; 60 } plugin_data_base; 61 62 struct plugin { 63 void *data; 64 /* is called ... */ 65 handler_t (* handle_uri_raw) (request_st *r, void *p_d); /* after uri_raw is set */ 66 handler_t (* handle_uri_clean) (request_st *r, void *p_d); /* after uri is set */ 67 handler_t (* handle_docroot) (request_st *r, void *p_d); /* getting the document-root */ 68 handler_t (* handle_physical) (request_st *r, void *p_d); /* mapping url to physical path */ 69 handler_t (* handle_request_env) (request_st *r, void *p_d); /* (deferred env populate) */ 70 handler_t (* handle_request_done) (request_st *r, void *p_d); /* at the end of a request */ 71 handler_t (* handle_subrequest_start) (request_st *r, void *p_d); /* when handler for request not found yet */ 72 handler_t (* handle_subrequest) (request_st *r, void *p_d); /* handler for request (max one per request) */ 73 handler_t (* handle_response_start) (request_st *r, void *p_d); /* before response headers are written */ 74 handler_t (* handle_request_reset) (request_st *r, void *p_d); /* after request done or request abort */ 75 76 handler_t (* handle_connection_accept) (connection *con, void *p_d); /* after accept() socket */ 77 handler_t (* handle_connection_shut_wr)(connection *con, void *p_d); /* done writing to socket */ 78 handler_t (* handle_connection_close) (connection *con, void *p_d); /* before close() of socket */ 79 80 handler_t (* handle_trigger) (server *srv, void *p_d); /* once a second */ 81 handler_t (* handle_sighup) (server *srv, void *p_d); /* at a sighup */ 82 handler_t (* handle_waitpid) (server *srv, void *p_d, pid_t pid, int status); /* upon a child process exit */ 83 84 void *(* init) (); 85 handler_t (* priv_defaults) (server *srv, void *p_d); 86 handler_t (* set_defaults) (server *srv, void *p_d); 87 handler_t (* worker_init) (server *srv, void *p_d); /* at server startup (each worker after fork()) */ 88 void (* cleanup) (void *p_d); 89 90 const char *name;/* name of the plugin */ 91 size_t version; 92 void *lib; /* dlopen handle */ 93 }; 94 95 __attribute_cold__ 96 int plugins_load(server *srv); 97 98 __attribute_cold__ 99 void plugins_free(server *srv); 100 101 handler_t plugins_call_handle_uri_clean(request_st *r); 102 handler_t plugins_call_handle_subrequest_start(request_st *r); 103 handler_t plugins_call_handle_response_start(request_st *r); 104 handler_t plugins_call_handle_request_env(request_st *r); 105 handler_t plugins_call_handle_request_done(request_st *r); 106 handler_t plugins_call_handle_docroot(request_st *r); 107 handler_t plugins_call_handle_physical(request_st *r); 108 handler_t plugins_call_handle_request_reset(request_st *r); 109 110 handler_t plugins_call_handle_connection_accept(connection *con); 111 handler_t plugins_call_handle_connection_shut_wr(connection *con); 112 handler_t plugins_call_handle_connection_close(connection *con); 113 114 void plugins_call_handle_trigger(server *srv); 115 handler_t plugins_call_handle_waitpid(server *srv, pid_t pid, int status); 116 117 __attribute_cold__ 118 void plugins_call_handle_sighup(server *srv); 119 120 __attribute_cold__ 121 handler_t plugins_call_init(server *srv); 122 123 __attribute_cold__ 124 handler_t plugins_call_set_defaults(server *srv); 125 126 __attribute_cold__ 127 handler_t plugins_call_worker_init(server *srv); 128 129 #endif 130