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