fastcgi.h

Go to the documentation of this file.

/*
   +----------------------------------------------------------------------+
   | Copyright (c) The PHP Group                                          |
   +----------------------------------------------------------------------+
   | This source file is subject to version 3.01 of the PHP license,      |
   | that is bundled with this package in the file LICENSE, and is        |
   | available through the world-wide-web at the following url:           |
   | https://www.php.net/license/3_01.txt                                 |
   | If you did not receive a copy of the PHP license and are unable to   |
   | obtain it through the world-wide-web, please send a note to          |
   | license@php.net so we can mail you a copy immediately.               |
   +----------------------------------------------------------------------+
   | Authors: Dmitry Stogov <dmitry@php.net>                              |
   +----------------------------------------------------------------------+
*/
 
/* FastCGI protocol */
 
#define FCGI_VERSION_1 1
 
#define FCGI_MAX_LENGTH 0xffff
 
#define FCGI_KEEP_CONN  1
 
/* this is near the perfect hash function for most useful FastCGI variables
 * which combines efficiency and minimal hash collisions
 */
 
#define FCGI_HASH_FUNC(var, var_len) \
    (UNEXPECTED(var_len < 3) ? (unsigned int)var_len : \
        (((unsigned int)var[3]) << 2) + \
        (((unsigned int)var[var_len-2]) << 4) + \
        (((unsigned int)var[var_len-1]) << 2) + \
        var_len)
 
#define FCGI_GETENV(request, name) \
    fcgi_quick_getenv(request, name, sizeof(name)-1, FCGI_HASH_FUNC(name, sizeof(name)-1))
 
#define FCGI_PUTENV(request, name, value) \
    fcgi_quick_putenv(request, name, sizeof(name)-1, FCGI_HASH_FUNC(name, sizeof(name)-1), value)
 
typedef enum _fcgi_role {
    FCGI_RESPONDER    = 1,
    FCGI_AUTHORIZER  = 2,
    FCGI_FILTER      = 3
} fcgi_role;
 
enum {
    FCGI_DEBUG        = 1,
    FCGI_NOTICE      = 2,
    FCGI_WARNING    = 3,
    FCGI_ERROR        = 4,
    FCGI_ALERT        = 5,
};
 
typedef enum _fcgi_request_type {
    FCGI_BEGIN_REQUEST        =  1, /* [in]                              */
    FCGI_ABORT_REQUEST        =  2, /* [in]  (not supported)             */
    FCGI_END_REQUEST        =  3, /* [out]                             */
    FCGI_PARAMS              =  4, /* [in]  environment variables       */
    FCGI_STDIN                =  5, /* [in]  post data                   */
    FCGI_STDOUT              =  6, /* [out] response                    */
    FCGI_STDERR              =  7, /* [out] errors                      */
    FCGI_DATA              =  8, /* [in]  filter data (not supported) */
    FCGI_GET_VALUES          =  9, /* [in]                              */
    FCGI_GET_VALUES_RESULT    = 10  /* [out]                             */
} fcgi_request_type;
 
typedef enum _fcgi_protocol_status {
    FCGI_REQUEST_COMPLETE  = 0,
    FCGI_CANT_MPX_CONN        = 1,
    FCGI_OVERLOADED          = 2,
    FCGI_UNKNOWN_ROLE      = 3
} dcgi_protocol_status;
 
/* FastCGI client API */
 
typedef void (*fcgi_apply_func)(const char *var, unsigned int var_len, char *val, unsigned int val_len, void *arg);
 
#define FCGI_HASH_TABLE_SIZE 128
#define FCGI_HASH_TABLE_MASK (FCGI_HASH_TABLE_SIZE - 1)
#define FCGI_HASH_SEG_SIZE   4096
 
typedef struct _fcgi_request fcgi_request;
 
int fcgi_init(void);
void fcgi_shutdown(void);
int fcgi_is_fastcgi(void);
int fcgi_is_closed(fcgi_request *req);
void fcgi_close(fcgi_request *req, int force, int destroy);
int fcgi_in_shutdown(void);
void fcgi_terminate(void);
int fcgi_listen(const char *path, int backlog);
fcgi_request* fcgi_init_request(int listen_socket, void(*on_accept)(void), void(*on_read)(void), void(*on_close)(void));
void fcgi_destroy_request(fcgi_request *req);
void fcgi_set_allowed_clients(char *ip);
int fcgi_accept_request(fcgi_request *req);
int fcgi_finish_request(fcgi_request *req, int force_close);
const char *fcgi_get_last_client_ip(void);
void fcgi_set_in_shutdown(int new_value);
void fcgi_request_set_keep(fcgi_request *req, int new_value);
 
#ifndef HAVE_ATTRIBUTE_WEAK
typedef void (*fcgi_logger)(int type, const char *fmt, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3);
void fcgi_set_logger(fcgi_logger lg);
#endif
 
int   fcgi_has_env(fcgi_request *req);
char* fcgi_getenv(fcgi_request *req, const char* var, int var_len);
char* fcgi_putenv(fcgi_request *req, char* var, int var_len, char* val);
char* fcgi_quick_getenv(fcgi_request *req, const char* var, int var_len, unsigned int hash_value);
char* fcgi_quick_putenv(fcgi_request *req, char* var, int var_len, unsigned int hash_value, char* val);
void  fcgi_loadenv(fcgi_request *req, fcgi_apply_func load_func, zval *array);
 
int fcgi_read(fcgi_request *req, char *str, int len);
 
int fcgi_write(fcgi_request *req, fcgi_request_type type, const char *str, int len);
int fcgi_flush(fcgi_request *req, int end);
int fcgi_end(fcgi_request *req);
 
#ifdef PHP_WIN32
void fcgi_impersonate(void);
#endif
 
void fcgi_set_mgmt_var(const char * name, size_t name_len, const char * value, size_t value_len);
void fcgi_free_mgmt_var_cb(zval *zv);