passenger 5.1.7 → 5.1.8

data/src/cxx_supportlib/LoggingKit/Logging.h

@@ -0,0 +1,204 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2010-2017 Phusion Holding B.V.
+ *
+ *  "Passenger", "Phusion Passenger" and "Union Station" are registered
+ *  trademarks of Phusion Holding B.V.
+ *
+ *  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_LOGGING_KIT_LOGGING_H_
+#define _PASSENGER_LOGGING_KIT_LOGGING_H_
+
+#include <oxt/macros.hpp>
+#include <LoggingKit/Forward.h>
+#include <Utils/FastStringStream.h>
+
+namespace Passenger {
+namespace LoggingKit {
+
+
+/*
+ * The P_LOG family of macros write the given expression to the log
+ * output stream if the log level is sufficiently high.
+ */
+
+#define P_LOG(context, level, file, line, expr) \
+	do { \
+		const Passenger::LoggingKit::ConfigRealization *_configRlz; \
+		if (Passenger::LoggingKit::_passesLogLevel((context), (level), &_configRlz)) { \
+			Passenger::FastStringStream<> _ostream; \
+			Passenger::LoggingKit::_prepareLogEntry(_ostream, (level), (file), (line)); \
+			_ostream << expr << "\n"; \
+			Passenger::LoggingKit::_writeLogEntry(_configRlz, _ostream.data(), _ostream.size()); \
+		} \
+	} while (false)
+
+#define P_LOG_UNLIKELY(context, level, file, line, expr) \
+	do { \
+		const Passenger::LoggingKit::ConfigRealization *_configRlz; \
+		if (OXT_UNLIKELY(Passenger::LoggingKit::_passesLogLevel((context), (level), &_configRlz))) { \
+			Passenger::FastStringStream<> _ostream; \
+			Passenger::LoggingKit::_prepareLogEntry(_ostream, (level), (file), (line)); \
+			_ostream << expr << "\n"; \
+			Passenger::LoggingKit::_writeLogEntry(_configRlz, _ostream.data(), _ostream.size()); \
+		} \
+	} while (false)
+
+
+/*
+ * P_CRITICAL, P_ERROR, P_WARN, P_NOTICE, P_INFO and P_DEBUG write
+ * the given expression to the log output stream if the log level is
+ * sufficiently high.
+ *
+ * The _WITH_POS variant of these macros allow you to specify which file
+ * and line it should report as the origin of the log message.
+ */
+
+#define P_CRITICAL(expr) P_LOG(Passenger::LoggingKit::context, \
+	Passenger::LoggingKit::CRIT, __FILE__, __LINE__, expr)
+#define P_CRITICAL_WITH_POS(expr, file, line) P_LOG(Passenger::LoggingKit::context, \
+	Passenger::LoggingKit::CRIT, file, line, expr)
+
+#define P_ERROR(expr) P_LOG(Passenger::LoggingKit::context, \
+	Passenger::LoggingKit::ERROR, __FILE__, __LINE__, expr)
+#define P_ERROR_WITH_POS(file, line, expr) P_LOG(Passenger::LoggingKit::context, \
+	Passenger::LoggingKit::ERROR, file, line, expr)
+
+#define P_WARN(expr) P_LOG(Passenger::LoggingKit::context, \
+	Passenger::LoggingKit::WARN, __FILE__, __LINE__, expr)
+#define P_WARN_WITH_POS(file, line, expr) P_LOG(Passenger::LoggingKit::context, \
+	Passenger::LoggingKit::WARN, file, line, expr)
+
+#define P_NOTICE(expr) P_LOG(Passenger::LoggingKit::context, \
+	Passenger::LoggingKit::NOTICE, __FILE__, __LINE__, expr)
+#define P_NOTICE_WITH_POS(file, line, expr) P_LOG(Passenger::LoggingKit::context, \
+	Passenger::LoggingKit::NOTICE, file, line, expr)
+
+#define P_INFO(expr) P_LOG(Passenger::LoggingKit::context, \
+	Passenger::LoggingKit::INFO, __FILE__, __LINE__, expr)
+#define P_INFO_WITH_POS(file, line, expr) P_LOG(Passenger::LoggingKit::context, \
+	Passenger::LoggingKit::INFO, file, line, expr)
+
+#define P_DEBUG(expr) P_TRACE(1, expr)
+#define P_DEBUG_WITH_POS(file, line, expr) P_TRACE_WITH_POS(1, file, line, expr)
+
+
+/*
+ * The P_TRACE family of macros are like P_DEBUG, but allow you to set the debugging
+ * level.
+ *
+ * Level = 1: debug
+ * Level = 2: debug2
+ * Level = 3: debug3
+ */
+
+#ifdef PASSENGER_DEBUG
+	#define P_TRACE(level, expr) P_LOG_UNLIKELY(Passenger::LoggingKit::context, \
+		Passenger::LoggingKit::Level(int(Passenger::LoggingKit::INFO) + level), \
+		__FILE__, __LINE__, expr)
+	#define P_TRACE_WITH_POS(level, file, line, expr) P_LOG_UNLIKELY(Passenger::LoggingKit::context, \
+		Passenger::LoggingKit::Level(int(Passenger::LoggingKit::INFO) + level), \
+		file, line, expr)
+#else
+	#define P_TRACE(level, expr) do { /* nothing */ } while (false)
+	#define P_TRACE_WITH_POS(level, file, line, expr) do { /* nothing */ } while (false)
+#endif
+
+
+/**
+ * Log the fact that a file descriptor has been opened.
+ */
+#define P_LOG_FILE_DESCRIPTOR_OPEN(fd) \
+	P_LOG_FILE_DESCRIPTOR_OPEN3(fd, __FILE__, __LINE__)
+#define P_LOG_FILE_DESCRIPTOR_OPEN2(fd, expr) \
+	P_LOG_FILE_DESCRIPTOR_OPEN4(fd, __FILE__, __LINE__, expr)
+#define P_LOG_FILE_DESCRIPTOR_OPEN3(fd, file, line) \
+	do { \
+		const Passenger::LoggingKit::ConfigRealization *_configRlz; \
+		if (Passenger::LoggingKit::_shouldLogFileDescriptors(Passenger::LoggingKit::context, \
+			&_configRlz)) \
+		{ \
+			Passenger::FastStringStream<> _ostream; \
+			Passenger::LoggingKit::_prepareLogEntry(_ostream, \
+				Passenger::LoggingKit::DEBUG, file, line); \
+			_ostream << "File descriptor opened: " << fd << "\n"; \
+			Passenger::LoggingKit::_writeFileDescriptorLogEntry(_configRlz, \
+				_ostream.data(), _ostream.size()); \
+		} \
+	} while (false)
+#define P_LOG_FILE_DESCRIPTOR_OPEN4(fd, file, line, expr) \
+	do { \
+		P_LOG_FILE_DESCRIPTOR_OPEN3(fd, file, line); \
+		P_LOG_FILE_DESCRIPTOR_PURPOSE(fd, expr); \
+	} while (false)
+
+/**
+ * Log the purpose of a file descriptor that was recently logged with
+ * P_LOG_FILE_DESCRIPTOR_OPEN(). You should include information that
+ * allows a reader to find out what a file descriptor is for.
+ */
+#define P_LOG_FILE_DESCRIPTOR_PURPOSE(fd, expr) \
+	do { \
+		const Passenger::LoggingKit::ConfigRealization *_configRlz; \
+		if (Passenger::LoggingKit::_shouldLogFileDescriptors(Passenger::LoggingKit::context, \
+			&_configRlz)) \
+		{ \
+			Passenger::FastStringStream<> _ostream; \
+			Passenger::LoggingKit::_prepareLogEntry(_ostream, \
+				Passenger::LoggingKit::DEBUG, __FILE__, __LINE__); \
+			_ostream << "File descriptor purpose: " << fd << ": " << expr << "\n"; \
+			Passenger::LoggingKit::_writeFileDescriptorLogEntry(_configRlz, \
+				_ostream.data(), _ostream.size()); \
+		} \
+	} while (false)
+
+/**
+ * Log the fact that a file descriptor has been closed.
+ */
+#define P_LOG_FILE_DESCRIPTOR_CLOSE(fd) \
+	do { \
+		const Passenger::LoggingKit::ConfigRealization *_configRlz; \
+		if (Passenger::LoggingKit::_shouldLogFileDescriptors(Passenger::LoggingKit::context, \
+			&_configRlz)) \
+		{ \
+			Passenger::FastStringStream<> _ostream; \
+			Passenger::LoggingKit::_prepareLogEntry(_ostream, \
+				Passenger::LoggingKit::DEBUG, __FILE__, __LINE__); \
+			_ostream << "File descriptor closed: " << fd << "\n"; \
+			Passenger::LoggingKit::_writeFileDescriptorLogEntry(_configRlz, \
+				_ostream.data(), _ostream.size()); \
+		} \
+	} while (false)
+
+
+/**
+ * Logs a message that was received from an application's stdout/stderr.
+ *
+ * @param pid The application's PID.
+ * @param channelName "stdout" or "stderr".
+ * @param message The message that was received.
+ */
+void logAppOutput(pid_t pid, const char *channelName, const char *message, unsigned int size);
+
+
+} // namespace LoggingKit
+} // namespace Passenger
+
+#endif /* _PASSENGER_LOGGING_KIT_LOGGING_H_ */

data/src/cxx_supportlib/LoggingKit/LoggingKit.h

@@ -0,0 +1,33 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2017 Phusion Holding B.V.
+ *
+ *  "Passenger", "Phusion Passenger" and "Union Station" are registered
+ *  trademarks of Phusion Holding B.V.
+ *
+ *  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_LOGGING_KIT_H_
+#define _PASSENGER_LOGGING_KIT_H_
+
+#include <LoggingKit/Forward.h>
+#include <LoggingKit/Logging.h>
+#include <LoggingKit/Assert.h>
+
+#endif /* _PASSENGER_LOGGING_KIT_H_ */

data/src/cxx_supportlib/LveLoggingDecorator.h

@@ -26,7 +26,7 @@
 #ifndef _PASSENGER_LVE_LOGGING_DECORATOR_H_
 #define _PASSENGER_LVE_LOGGING_DECORATOR_H_
 
-#include <Logging.h>
+#include <LoggingKit/LoggingKit.h>
 #include <adhoc_lve.h>
 #include <string>
 #include <sys/types.h>

data/src/cxx_supportlib/MemoryKit/mbuf.cpp

@@ -24,7 +24,7 @@
 #include <algorithm>
 #include <ostream>
 #include <MemoryKit/mbuf.h>
-#include <Logging.h>
+#include <LoggingKit/LoggingKit.h>
 #include <StaticString.h>
 #include <Utils/StrIntUtils.h>
 

data/src/cxx_supportlib/RandomGenerator.h

@@ -32,7 +32,7 @@
 #include <boost/shared_ptr.hpp>
 #include <oxt/system_calls.hpp>
 
-#include <Logging.h>
+#include <LoggingKit/LoggingKit.h>
 #include <StaticString.h>
 #include <Exceptions.h>
 #include <Utils/StrIntUtils.h>

data/src/cxx_supportlib/SafeLibev.h

@@ -36,7 +36,7 @@
 #include <boost/function.hpp>
 #include <boost/bind.hpp>
 #include <oxt/thread.hpp>
-#include <Logging.h>
+#include <LoggingKit/LoggingKit.h>
 
 namespace Passenger {
 

data/src/cxx_supportlib/ServerKit/AcceptLoadBalancer.h

@@ -42,7 +42,7 @@
 #include <poll.h>
 
 #include <Constants.h>
-#include <Logging.h>
+#include <LoggingKit/LoggingKit.h>
 #include <Utils.h>
 #include <Utils/IOUtils.h>
 

data/src/cxx_supportlib/ServerKit/Channel.h

@@ -36,7 +36,7 @@
 #include <ServerKit/Context.h>
 #include <ServerKit/Hooks.h>
 #include <MemoryKit/mbuf.h>
-#include <Logging.h>
+#include <LoggingKit/LoggingKit.h>
 #include <Utils/StrIntUtils.h>
 
 namespace Passenger {

data/src/cxx_supportlib/ServerKit/FileBufferedChannel.h

@@ -41,7 +41,7 @@
 #include <utility>
 #include <string>
 #include <deque>
-#include <Logging.h>
+#include <LoggingKit/LoggingKit.h>
 #include <ServerKit/Context.h>
 #include <ServerKit/Errors.h>
 #include <ServerKit/Channel.h>

data/src/cxx_supportlib/ServerKit/FileBufferedFdSinkChannel.h

@@ -29,7 +29,7 @@
 #include <oxt/macros.hpp>
 #include <sys/types.h>
 #include <unistd.h>
-#include <Logging.h>
+#include <LoggingKit/LoggingKit.h>
 #include <MemoryKit/mbuf.h>
 #include <ServerKit/FileBufferedChannel.h>
 

data/src/cxx_supportlib/ServerKit/HttpChunkedBodyParser.h

@@ -42,7 +42,7 @@ using namespace std;
 
 #define CBP_DEBUG(expr) \
 	do { \
-		if (OXT_UNLIKELY(Passenger::getLogLevel() >= LVL_DEBUG3)) { \
+		if (OXT_UNLIKELY(Passenger::LoggingKit::getLevel() >= Passenger::LoggingKit::DEBUG3)) { \
 			char _buf[256]; \
 			unsigned int size = loggingPrefixFormatter(_buf, sizeof(_buf), userData); \
 			P_TRACE(3, StaticString(_buf, size) << expr); \

data/src/cxx_supportlib/ServerKit/HttpHeaderParser.h

@@ -37,7 +37,7 @@
 #include <ServerKit/HttpHeaderParserState.h>
 #include <DataStructures/LString.h>
 #include <DataStructures/HashedStaticString.h>
-#include <Logging.h>
+#include <LoggingKit/LoggingKit.h>
 #include <Utils/StrIntUtils.h>
 #include <Utils/Hasher.h>
 

data/src/cxx_supportlib/ServerKit/HttpServer.h

@@ -35,7 +35,7 @@
 #include <cmath>
 #include <cassert>
 #include <pthread.h>
-#include <Logging.h>
+#include <LoggingKit/LoggingKit.h>
 #include <ServerKit/Server.h>
 #include <ServerKit/HttpClient.h>
 #include <ServerKit/HttpRequest.h>
@@ -83,6 +83,23 @@ public:
 	}
 };
 
+struct HttpServerConfigRealization {
+	unsigned int requestFreelistLimit;
+
+	HttpServerConfigRealization(const ConfigKit::Store &config)
+		: requestFreelistLimit(config["request_freelist_limit"].asUInt())
+		{ }
+
+	void swap(HttpServerConfigRealization &other) BOOST_NOEXCEPT_OR_NOTHROW {
+		std::swap(requestFreelistLimit, other.requestFreelistLimit);
+	}
+};
+
+struct HttpServerConfigChangeRequest {
+	BaseServerConfigChangeRequest forParent;
+	boost::scoped_ptr<HttpServerConfigRealization> configRlz;
+};
+
 
 template< typename DerivedServer, typename Client = HttpClient<HttpRequest> >
 class HttpServer: public BaseServer<DerivedServer, Client> {
@@ -91,8 +108,10 @@ public:
 	typedef HttpRequestRef<DerivedServer, Request> RequestRef;
 	STAILQ_HEAD(FreeRequestList, Request);
 
+	typedef HttpServerConfigChangeRequest ConfigChangeRequest;
+
 	FreeRequestList freeRequests;
-	unsigned int freeRequestCount, requestFreelistLimit;
+	unsigned int freeRequestCount;
 	unsigned long totalRequestsBegun, lastTotalRequestsBegun;
 	double requestBeginSpeed1m, requestBeginSpeed1h;
 
@@ -126,6 +145,11 @@ private:
 	friend class RequestHooksImpl;
 
 
+	/***** Configuration *****/
+
+	HttpServerConfigRealization configRlz;
+
+
 	/***** Working state *****/
 
 	RequestHooksImpl requestHooksImpl;
@@ -196,7 +220,7 @@ private:
 	}
 
 	bool addRequestToFreelist(Request *request) {
-		if (freeRequestCount < requestFreelistLimit) {
+		if (freeRequestCount < configRlz.requestFreelistLimit) {
 			STAILQ_INSERT_HEAD(&freeRequests, request, nextRequest.freeRequest);
 			freeRequestCount++;
 			request->refcount.store(1, boost::memory_order_relaxed);
@@ -856,13 +880,13 @@ protected:
 		return false;
 	}
 
-	virtual PassengerLogLevel getClientOutputErrorDisconnectionLogLevel(
+	virtual LoggingKit::Level getClientOutputErrorDisconnectionLogLevel(
 		Client *client, int errcode) const
 	{
 		if (errcode == EPIPE || errcode == ECONNRESET) {
-			return LVL_INFO;
+			return LoggingKit::INFO;
 		} else {
-			return LVL_WARN;
+			return LoggingKit::WARN;
 		}
 	}
 
@@ -941,13 +965,6 @@ protected:
 		req->bodyChannel.deinitialize();
 	}
 
-	virtual void onConfigChange(const ConfigKit::Store *oldConfig) {
-		ParentClass::onConfigChange(oldConfig);
-		const ConfigKit::Store &config = this->config;
-
-		requestFreelistLimit = config["request_freelist_limit"].asUInt();
-	}
-
 
 	/***** Misc *****/
 
@@ -961,11 +978,11 @@ public:
 		const Json::Value &initialConfig = Json::Value())
 		: ParentClass(context, schema, initialConfig),
 		  freeRequestCount(0),
-		  requestFreelistLimit(1024),
 		  totalRequestsBegun(0),
 		  lastTotalRequestsBegun(0),
 		  requestBeginSpeed1m(-1),
 		  requestBeginSpeed1h(-1),
+		  configRlz(ParentClass::config),
 		  headerParserStatePool(16, 256)
 	{
 		STAILQ_INIT(&freeRequests);
@@ -974,7 +991,7 @@ public:
 
 	/***** Server management *****/
 
-	virtual void compact(int logLevel = LVL_NOTICE) {
+	virtual void compact(LoggingKit::Level logLevel = LoggingKit::NOTICE) {
 		ParentClass::compact();
 		unsigned int count = freeRequestCount;
 
@@ -1210,6 +1227,22 @@ public:
 
 	/***** Configuration and introspection *****/
 
+	bool prepareConfigChange(const Json::Value &updates,
+		vector<ConfigKit::Error> &errors, HttpServerConfigChangeRequest &req)
+	{
+		if (ParentClass::prepareConfigChange(updates, errors, req.forParent)) {
+			req.configRlz.reset(new HttpServerConfigRealization(*req.forParent.config));
+		}
+		return errors.empty();
+	}
+
+	void commitConfigChange(HttpServerConfigChangeRequest &req)
+		BOOST_NOEXCEPT_OR_NOTHROW
+	{
+		ParentClass::commitConfigChange(req.forParent);
+		configRlz.swap(*req.configRlz);
+	}
+
 	virtual Json::Value inspectStateAsJson() const {
 		Json::Value doc = ParentClass::inspectStateAsJson();
 		doc["free_request_count"] = freeRequestCount;