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