passenger 4.0.60 → 5.0.0.beta1

data/ext/common/ServerKit/Client.h

@@ -0,0 +1,166 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2014 Phusion
+ *
+ *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ *  THE SOFTWARE.
+ */
+#ifndef _PASSENGER_SERVER_KIT_CLIENT_H_
+#define _PASSENGER_SERVER_KIT_CLIENT_H_
+
+#include <Utils/sysqueue.h>
+#include <boost/atomic.hpp>
+#include <boost/cstdint.hpp>
+#include <ServerKit/Hooks.h>
+#include <ServerKit/FdSourceChannel.h>
+#include <ServerKit/FileBufferedFdSinkChannel.h>
+
+namespace Passenger {
+namespace ServerKit {
+
+using namespace std;
+using namespace boost;
+
+
+class BaseClient {
+private:
+	/** Reference to the Server that this Client belongs to.
+	 * It's a tagged pointer, with the lower 2 bits containing
+	 * the connection state. Phusion Passenger is never going
+	 * to be used on 16-bit systems anyway.
+	 */
+	void *server;
+
+public:
+	enum ConnState {
+		/** Client object is in the server's freelist. No file descriptor
+		 * is associated and no I/O operations are possible. From this state,
+		 * it can transition to ACTIVE.
+		 *
+		 * @invariant
+		 *     fd == -1
+		 */
+		IN_FREELIST,
+
+		/** Client object is actively being used. There's a file descriptor
+		 * associated and no I/O operations are possible. From this state,
+		 * it can transition to either DISCONNECTED or IN_FREELIST.
+		 *
+		 * @invariant
+		 *      fd != -1
+		 *      fdnum != -1
+		 */
+		ACTIVE,
+
+		/** Client object is disconnected, but isn't yet put in the freelist,
+		 * because there are still references to the client object. No file
+		 * descriptor is associated and no I/O operations are possible. The
+		 * original file descriptor number is stored in fdnum for debugging
+		 * purposes, but it does not refer to a valid file descriptor.
+		 *
+		 * @invariant
+		 *      fd == -1
+		 *      fdnum != -1
+		 */
+		DISCONNECTED
+	};
+
+	boost::atomic<int> refcount;
+	Hooks hooks;
+	FdSourceChannel input;
+	FileBufferedFdSinkChannel output;
+
+	BaseClient(void *_server)
+		: server(_server),
+		  refcount(2)
+	{
+		setConnState(DISCONNECTED);
+	}
+
+	virtual ~BaseClient() { }
+
+	OXT_FORCE_INLINE
+	int getFd() const {
+		return input.getFd();
+	}
+
+	OXT_FORCE_INLINE
+	bool connected() const {
+		return getConnState() == ACTIVE;
+	}
+
+	OXT_FORCE_INLINE
+	ConnState getConnState() const {
+		return (ConnState) ((uintptr_t) server & 0x3);
+	}
+
+	const char *getConnStateString() const {
+		switch (getConnState()) {
+		case IN_FREELIST:
+			return "IN_FREELIST";
+		case ACTIVE:
+			return "ACTIVE";
+		case DISCONNECTED:
+			return "DISCONNECTED";
+		default:
+			return "UNKNOWN";
+		}
+	}
+
+	OXT_FORCE_INLINE
+	void setConnState(ConnState state) {
+		server = (void *) ((uintptr_t) getServerBaseClassPointer() | (uintptr_t) state);
+	}
+
+	/**
+	 * Returns a pointer to the BaseServer base class object. Using it is dangerous.
+	 * You should use BaseServer::getServerFromClient() instead, which provides
+	 * better type-safety and which allows safe recasting.
+	 */
+	OXT_FORCE_INLINE
+	void *getServerBaseClassPointer() {
+		return (void *) ((uintptr_t) server & ~((uintptr_t) 0x3));
+	}
+};
+
+
+#define DEFINE_SERVER_KIT_BASE_CLIENT_FOOTER(ClientType) \
+	public: \
+	union { \
+		STAILQ_ENTRY(ClientType) freeClient; \
+		TAILQ_ENTRY(ClientType) activeOrDisconnectedClient; \
+	} nextClient; \
+	unsigned int number
+
+
+class Client: public BaseClient {
+public:
+	Client(void *server)
+		: BaseClient(server)
+		{ }
+
+	DEFINE_SERVER_KIT_BASE_CLIENT_FOOTER(Client);
+};
+
+
+} // namespace ServerKit
+} // namespace Passenger
+
+#endif /* _PASSENGER_SERVER_KIT_CLIENT_H_ */

data/ext/common/ServerKit/ClientRef.h

@@ -0,0 +1,130 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2014 Phusion
+ *
+ *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ *  THE SOFTWARE.
+ */
+#ifndef _PASSENGER_SERVER_KIT_CLIENT_REF_H_
+#define _PASSENGER_SERVER_KIT_CLIENT_REF_H_
+
+#include <boost/move/core.hpp>
+
+namespace Passenger {
+namespace ServerKit {
+
+
+template<typename Server, typename Client>
+class ClientRef {
+private:
+	BOOST_COPYABLE_AND_MOVABLE(ClientRef);
+	Client *client;
+	const char *file;
+	unsigned int line;
+
+	static Server *getServer(Client *client) {
+		return static_cast<Server *>(
+			static_cast<typename Server::BaseClass *>(client->getServerBaseClassPointer())
+		);
+	}
+
+public:
+	explicit
+	ClientRef(Client *_client, const char *_file, unsigned int _line)
+		: client(_client),
+		  file(_file),
+		  line(_line)
+	{
+		if (_client != NULL) {
+			getServer(_client)->_refClient(_client, _file, _line);
+		}
+	}
+
+	ClientRef(const ClientRef &ref)
+		: client(ref.client),
+		  file(ref.file),
+		  line(ref.line)
+	{
+		if (ref.client != NULL) {
+			getServer(ref.client)->_refClient(ref.client, ref.file, ref.line);
+		}
+	}
+
+	ClientRef(const ClientRef &ref, const char *_file, unsigned int _line)
+		: client(ref.client),
+		  file(_file),
+		  line(_line)
+	{
+		if (ref.client != NULL) {
+			getServer(ref.client)->_refClient(ref.client, _file, _line);
+		}
+	}
+
+	explicit
+	ClientRef(BOOST_RV_REF(ClientRef) ref)
+		: client(ref.client)
+	{
+		ref.client = NULL;
+	}
+
+	~ClientRef() {
+		if (client != NULL) {
+			getServer(client)->_unrefClient(client, file, line);
+		}
+	}
+
+	Client *get() const {
+		return client;
+	}
+
+	ClientRef &operator=(BOOST_COPY_ASSIGN_REF(ClientRef) ref) {
+		if (client == ref.client) {
+			Client *oldClient = client;
+			const char *oldFile = file;
+			unsigned int oldLine = line;
+			client = ref.client;
+			file = ref.file;
+			line = ref.line;
+			if (client != NULL) {
+				getServer(client)->_refClient(ref.client, ref.file, ref.line);
+			}
+			if (oldClient != NULL) {
+				getServer(oldClient)->_unrefClient(oldClient, oldFile, oldLine);
+			}
+		}
+		return *this;
+	}
+
+	ClientRef &operator=(BOOST_RV_REF(ClientRef) ref) {
+		Client *oldClient = client;
+		client = ref.client;
+		ref.client = NULL;
+		if (oldClient != NULL) {
+			getServer(oldClient)->_unrefClient(oldClient, file, line);
+		}
+		return *this;
+	}
+};
+
+
+} // namespace ServerKit
+} // namespace Passenger
+
+#endif /* _PASSENGER_SERVER_KIT_CLIENT_REF_H_ */

data/ext/common/ServerKit/Context.h

@@ -0,0 +1,129 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2014 Phusion
+ *
+ *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ *  THE SOFTWARE.
+ */
+#ifndef _PASSENGER_SERVER_KIT_CONTEXT_H_
+#define _PASSENGER_SERVER_KIT_CONTEXT_H_
+
+#include <boost/make_shared.hpp>
+#include <string>
+#include <cstddef>
+#include <MemoryKit/mbuf.h>
+#include <SafeLibev.h>
+#include <Constants.h>
+#include <Utils/StrIntUtils.h>
+#include <Utils/json.h>
+
+namespace Passenger {
+namespace ServerKit {
+
+
+struct FileBufferedChannelConfig {
+	string bufferDir;
+	unsigned int threshold;
+	unsigned int delayInFileModeSwitching;
+	bool autoTruncateFile;
+	bool autoStartMover;
+
+	FileBufferedChannelConfig()
+		: bufferDir("/tmp"),
+		  threshold(1024 * 128),
+		  delayInFileModeSwitching(0),
+		  autoTruncateFile(true),
+		  autoStartMover(true)
+		{ }
+};
+
+class Context {
+private:
+	void initialize() {
+		mbuf_pool.mbuf_block_chunk_size = DEFAULT_MBUF_CHUNK_SIZE;
+		MemoryKit::mbuf_pool_init(&mbuf_pool);
+	}
+
+	string formatFloat(double val) const {
+		char buf[64];
+		int size = snprintf(buf, sizeof(buf), "%.1f", val);
+		return string(buf, size);
+	}
+
+	Json::Value
+	byteSizeToJson(size_t size) const {
+		Json::Value doc;
+		doc["bytes"] = (Json::UInt64) size;
+		if (size < 1024) {
+			doc["human_readable"] = toString(size) + " bytes";
+		} else if (size < 1024 * 1024) {
+			doc["human_readable"] = formatFloat(size / 1024.0) + " KB";
+		} else {
+			doc["human_readable"] = formatFloat(size / 1024.0 / 1024.0) + " MB";
+		}
+		return doc;
+	}
+
+public:
+	SafeLibevPtr libev;
+	struct MemoryKit::mbuf_pool mbuf_pool;
+	string secureModePassword;
+	FileBufferedChannelConfig defaultFileBufferedChannelConfig;
+
+	Context(const SafeLibevPtr &_libev)
+		: libev(_libev)
+	{
+		initialize();
+	}
+
+	Context(struct ev_loop *loop)
+		: libev(boost::make_shared<SafeLibev>(loop))
+	{
+		initialize();
+	}
+
+	~Context() {
+		MemoryKit::mbuf_pool_deinit(&mbuf_pool);
+	}
+
+	Json::Value inspectStateAsJson() const {
+		Json::Value doc;
+		Json::Value mbufDoc;
+
+		mbufDoc["free_blocks"] = (Json::UInt) mbuf_pool.nfree_mbuf_blockq;
+		mbufDoc["active_blocks"] = (Json::UInt) mbuf_pool.nactive_mbuf_blockq;
+		mbufDoc["chunk_size"] = (Json::UInt) mbuf_pool.mbuf_block_chunk_size;
+		mbufDoc["offset"] = (Json::UInt) mbuf_pool.mbuf_block_offset;
+		mbufDoc["spare_memory"] = byteSizeToJson(mbuf_pool.nfree_mbuf_blockq
+			* mbuf_pool.mbuf_block_chunk_size);
+		mbufDoc["active_memory"] = byteSizeToJson(mbuf_pool.nactive_mbuf_blockq
+			* mbuf_pool.mbuf_block_chunk_size);
+
+		doc["mbuf_pool"] = mbufDoc;
+
+		return doc;
+	}
+};
+
+
+} // namespace ServerKit
+} // namespace Passenger
+
+#endif /* _PASSENGER_SERVER_KIT_CONTEXT_H_ */

data/ext/common/ServerKit/Errors.h

@@ -0,0 +1,103 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2012-2014 Phusion
+ *
+ *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ *  THE SOFTWARE.
+ */
+#ifndef _PASSENGER_SERVER_KIT_ERRORS_H_
+#define _PASSENGER_SERVER_KIT_ERRORS_H_
+
+#include <cstring>
+#include <ServerKit/http_parser.h>
+
+namespace Passenger {
+namespace ServerKit {
+
+
+enum Error {
+	// HttpChunkedBodyParser errors
+	CHUNK_SIZE_TOO_LARGE        = -1000,
+	CHUNK_SIZE_PARSE_ERROR      = -1001,
+	CHUNK_FOOTER_PARSE_ERROR    = -1002,
+	CHUNK_FINALIZER_PARSE_ERROR = -1003,
+	UNEXPECTED_EOF              = -1004,
+
+	// HttpHeaderParser errors
+	HTTP_VERSION_NOT_SUPPORTED                             = -1010,
+	REQUEST_CONTAINS_CONTENT_LENGTH_AND_TRANSFER_ENCODING  = -1011,
+	UPGRADE_NOT_ALLOWED_WHEN_REQUEST_BODY_EXISTS           = -1012,
+	UPGRADE_NOT_ALLOWED_FOR_HEAD_REQUESTS                  = -1013,
+	RESPONSE_CONTAINS_CONTENT_LENGTH_AND_TRANSFER_ENCODING = -1014,
+	SECURITY_PASSWORD_MISMATCH                             = -1015,
+	SECURITY_PASSWORD_DUPLICATE                            = -1016,
+	ERROR_SECURE_HEADER_NOT_ALLOWED                        = -1017,
+	NORMAL_HEADER_NOT_ALLOWED_AFTER_SECURITY_PASSWORD      = -1018,
+
+	// Error codes below -2000 are http_parser errors
+	HTTP_PARSER_ERRNO_BEGIN     = -2000,
+};
+
+inline const char *
+getErrorDesc(int errcode) {
+	switch (errcode) {
+	case CHUNK_SIZE_TOO_LARGE:
+		return "Chunked encoding size too large";
+	case CHUNK_SIZE_PARSE_ERROR:
+		return "Chunked encoding size string parse error";
+	case CHUNK_FOOTER_PARSE_ERROR:
+		return "Chunked encoding footer parse error";
+	case CHUNK_FINALIZER_PARSE_ERROR:
+		return "Chunked encoding final chunk parse error";
+	case UNEXPECTED_EOF:
+		return "Unexpected end-of-stream";
+	case HTTP_VERSION_NOT_SUPPORTED:
+		return "HTTP Version Not Supported";
+	case REQUEST_CONTAINS_CONTENT_LENGTH_AND_TRANSFER_ENCODING:
+		return "Bad request (request may not contain both Content-Length and Transfer-Encoding)";
+	case UPGRADE_NOT_ALLOWED_WHEN_REQUEST_BODY_EXISTS:
+		return "Bad request (Connection upgrading is only allowed for requests without request body)";
+	case UPGRADE_NOT_ALLOWED_FOR_HEAD_REQUESTS:
+		return "Bad request (Connection upgrading is not allowed for HEAD requests)";
+	case RESPONSE_CONTAINS_CONTENT_LENGTH_AND_TRANSFER_ENCODING:
+		return "Response may not contain both Content-Length and Transfer-Encoding";
+	case SECURITY_PASSWORD_MISMATCH:
+		return "Security password mismatch";
+	case SECURITY_PASSWORD_DUPLICATE:
+		return "A duplicate security password header was encountered";
+	case ERROR_SECURE_HEADER_NOT_ALLOWED:
+		return "A secure header was provided, but no security password was provided";
+	case NORMAL_HEADER_NOT_ALLOWED_AFTER_SECURITY_PASSWORD:
+		return "A normal header was encountered after the security password header";
+	default:
+		if (errcode <= HTTP_PARSER_ERRNO_BEGIN) {
+			return http_errno_description((enum http_errno)
+				(-errcode + HTTP_PARSER_ERRNO_BEGIN));
+		} else {
+			return std::strerror(errcode);
+		}
+	}
+}
+
+
+} // namespace ServerKit
+} // namespace Passenger
+
+#endif /* _PASSENGER_SERVER_KIT_ERRORS_H_ */