passenger 5.0.4 → 5.0.5

data/ext/common/Logging.h

@@ -1,6 +1,6 @@
 /*
  *  Phusion Passenger - https://www.phusionpassenger.com/
- *  Copyright (c) 2010-2014 Phusion
+ *  Copyright (c) 2010-2015 Phusion
  *
  *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
  *
@@ -46,6 +46,7 @@
 #include <ctime>
 #include <cerrno>
 #include <csignal>
+#include <Utils/FastStringStream.h>
 
 
 namespace Passenger {
@@ -55,8 +56,6 @@ using namespace boost;
 using namespace oxt;
 
 
-/********** Debug logging facilities **********/
-
 struct AssertionFailureInfo {
 	const char *filename;
 	const char *function; // May be NULL.
@@ -68,18 +67,83 @@ extern volatile sig_atomic_t _logLevel;
 // If assert() or similar fails, we attempt to store its information here.
 extern AssertionFailureInfo lastAssertionFailure;
 
+/**
+ * Returns the current log level. This method is thread-safe.
+ */
 inline OXT_FORCE_INLINE int
 getLogLevel() {
 	return (int) _logLevel;
 }
 
+/**
+ * Sets the log level. This method is thread-safe.
+ */
 void setLogLevel(int value);
-bool setLogFile(const char *path); // Sets errno on error
+
+/**
+ * Returns the general log file that we're using, or the empty string
+ * if we're not using a log file.
+ *
+ * This method is NOT thread-safe.
+ */
 string getLogFile();
-void _prepareLogEntry(std::stringstream &sstream, const char *file, unsigned int line);
-void _writeLogEntry(const std::string &str);
+
+/**
+ * Sets the general log file. This method is thread-safe.
+ * Returns whether the new log file can be opened. If not,
+ * errcode (if non-NULL) is set to the relevant filesystem
+ * error code.
+ */
+bool setLogFile(const string &path, int *errcode = NULL);
+
+/**
+ * Returns whether we're using a separate log file for logging file
+ * descriptor opening and closing.
+ *
+ * See `getFileDescriptorLogFile()` for thread-safety notes.
+ */
+bool hasFileDescriptorLogFile();
+
+/**
+ * Returns the file that we're using for logging file descriptor
+ * opening and closing, or the empty string if we're not using a
+ * separate log file.
+ *
+ * This method is only thread-safe if `setFileDescriptorLogFile()`
+ * was called before any threads were made, and at the same time
+ * `setFileDescriptorLogFile()` is never called again with a different
+ * argument. In other words, only reopening the same log file is
+ * thread-safe.
+ */
+string getFileDescriptorLogFile();
+
+/**
+ * Returns the file descriptor of the log file that we're using for
+ * logging file descriptor opening and closing, or -1 if we're not using a
+ * separate log file.
+ *
+ * See `getFileDescriptorLogFile()` for thread-safety notes.
+ */
+int getFileDescriptorLogFileFd();
+
+/**
+ * Sets the log file to use specifically for logging file descriptor
+ * opening and closing.
+ *
+ * This method is only thread-safe if you `path` equals what
+ * `getFileDescriptorLogFile()` returns. In other words, when
+ * you're reopening the log file.
+ *
+ * Returns whether the new log file can be opened. If not,
+ * errcode (if non-NULL) is set to the relevant filesystem
+ * error code.
+ */
+bool setFileDescriptorLogFile(const string &path, int *errcode = NULL);
+
+void _prepareLogEntry(FastStringStream<> &sstream, const char *file, unsigned int line);
 void _writeLogEntry(const char *str, unsigned int size);
-const char *_strdupStringStream(const std::stringstream &stream);
+void _writeFileDescriptorLogEntry(const char *str, unsigned int size);
+const char *_strdupFastStringStream(const FastStringStream<> &stream);
 
 
 enum PassengerLogLevel {
@@ -99,20 +163,20 @@ enum PassengerLogLevel {
 #define P_LOG(level, file, line, expr) \
 	do { \
 		if (Passenger::getLogLevel() >= (level)) { \
-			std::stringstream sstream; \
-			Passenger::_prepareLogEntry(sstream, file, line); \
-			sstream << expr << "\n"; \
-			Passenger::_writeLogEntry(sstream.str()); \
+			Passenger::FastStringStream<> _ostream; \
+			Passenger::_prepareLogEntry(_ostream, file, line); \
+			_ostream << expr << "\n"; \
+			Passenger::_writeLogEntry(_ostream.data(), _ostream.size()); \
 		} \
 	} while (false)
 
 #define P_LOG_UNLIKELY(level, file, line, expr) \
 	do { \
 		if (OXT_UNLIKELY(Passenger::getLogLevel() >= (level))) { \
-			std::stringstream sstream; \
-			Passenger::_prepareLogEntry(sstream, file, line); \
-			sstream << expr << "\n"; \
-			Passenger::_writeLogEntry(sstream.str()); \
+			Passenger::FastStringStream<> _ostream; \
+			Passenger::_prepareLogEntry(_ostream, file, line); \
+			_ostream << expr << "\n"; \
+			Passenger::_writeLogEntry(_ostream.data(), _ostream.size()); \
 		} \
 	} while (false)
 
@@ -166,6 +230,69 @@ enum PassengerLogLevel {
 	#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 { \
+		if (Passenger::hasFileDescriptorLogFile() || Passenger::getLogLevel() >= Passenger::LVL_DEBUG) { \
+			Passenger::FastStringStream<> _ostream; \
+			Passenger::_prepareLogEntry(_ostream, file, line); \
+			_ostream << "File descriptor opened: " << fd << "\n"; \
+			if (hasFileDescriptorLogFile()) { \
+				Passenger::_writeFileDescriptorLogEntry(_ostream.data(), _ostream.size()); \
+			} else { \
+				Passenger::_writeLogEntry(_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 { \
+		if (Passenger::hasFileDescriptorLogFile() || Passenger::getLogLevel() >= Passenger::LVL_DEBUG) { \
+			Passenger::FastStringStream<> _ostream; \
+			Passenger::_prepareLogEntry(_ostream, __FILE__, __LINE__); \
+			_ostream << "File descriptor purpose: " << fd << ": " << expr << "\n"; \
+			if (hasFileDescriptorLogFile()) { \
+				Passenger::_writeFileDescriptorLogEntry(_ostream.data(), _ostream.size()); \
+			} else { \
+				Passenger::_writeLogEntry(_ostream.data(), _ostream.size()); \
+			} \
+		} \
+	} while (false)
+
+/**
+ * Log the fact that a file descriptor has been closed.
+ */
+#define P_LOG_FILE_DESCRIPTOR_CLOSE(fd) \
+	do { \
+		if (Passenger::hasFileDescriptorLogFile() || Passenger::getLogLevel() >= Passenger::LVL_DEBUG) { \
+			Passenger::FastStringStream<> _ostream; \
+			Passenger::_prepareLogEntry(_ostream, __FILE__, __LINE__); \
+			_ostream << "File descriptor closed: " << fd << "\n"; \
+			if (hasFileDescriptorLogFile()) { \
+				Passenger::_writeFileDescriptorLogEntry(_ostream.data(), _ostream.size()); \
+			} else { \
+				Passenger::_writeLogEntry(_ostream.data(), _ostream.size()); \
+			} \
+		} \
+	} while (false)
+
 /**
  * Print a message that was received from an application's stdout/stderr.
  *
@@ -192,9 +319,9 @@ void setPrintAppOutputAsDebuggingMessages(bool enabled);
 	do { \
 		TRACE_POINT(); \
 		const char *_exprStr; \
-		std::stringstream sstream; \
+		Passenger::FastStringStream<> sstream; \
 		sstream << expr; \
-		_exprStr = Passenger::_strdupStringStream(sstream); \
+		_exprStr = Passenger::_strdupFastStringStream(sstream); \
 		Passenger::lastAssertionFailure.filename = __FILE__; \
 		Passenger::lastAssertionFailure.line = __LINE__; \
 		Passenger::lastAssertionFailure.function = __PRETTY_FUNCTION__; \
@@ -207,9 +334,9 @@ void setPrintAppOutputAsDebuggingMessages(bool enabled);
 	do { \
 		UPDATE_TRACE_POINT(); \
 		const char *_exprStr; \
-		std::stringstream sstream; \
+		Passenger::FastStringStream<> sstream; \
 		sstream << expr; \
-		_exprStr = Passenger::_strdupStringStream(sstream); \
+		_exprStr = Passenger::_strdupFastStringStream(sstream); \
 		Passenger::lastAssertionFailure.filename = __FILE__; \
 		Passenger::lastAssertionFailure.line = __LINE__; \
 		Passenger::lastAssertionFailure.function = __PRETTY_FUNCTION__; \

data/ext/common/MessageClient.h

@@ -1,6 +1,6 @@
 /*
  *  Phusion Passenger - https://www.phusionpassenger.com/
- *  Copyright (c) 2010-2014 Phusion
+ *  Copyright (c) 2010-2015 Phusion
  *
  *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
  *
@@ -135,7 +135,7 @@ public:
 		TRACE_POINT();
 		ScopeGuard g(boost::bind(&MessageClient::autoDisconnect, this));
 
-		fd = connectToServer(serverAddress.c_str());
+		fd.assign(connectToServer(serverAddress.c_str(), __FILE__, __LINE__), NULL, 0);
 
 		vector<string> args;
 		if (!readArrayMessage(fd, args)) {

data/ext/common/MessageServer.h

@@ -1,6 +1,6 @@
 /*
  *  Phusion Passenger - https://www.phusionpassenger.com/
- *  Copyright (c) 2010, 2011, 2012 Phusion
+ *  Copyright (c) 2010-2015 Phusion
  *
  *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
  *
@@ -578,7 +578,8 @@ public:
 			FileDescriptor fd;
 
 			UPDATE_TRACE_POINT();
-			fd = syscalls::accept(serverFd, (struct sockaddr *) &addr, &len);
+			fd.assign(syscalls::accept(serverFd, (struct sockaddr *) &addr, &len),
+				__FILE__, __LINE__);
 			if (fd == -1) {
 				throw SystemException("Unable to accept a new client", errno);
 			}

data/ext/common/RandomGenerator.h

@@ -1,6 +1,6 @@
 /*
  *  Phusion Passenger - https://www.phusionpassenger.com/
- *  Copyright (c) 2010-2013 Phusion
+ *  Copyright (c) 2010-2015 Phusion
  *
  *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
  *
@@ -31,14 +31,12 @@
 #include <boost/shared_ptr.hpp>
 #include <oxt/system_calls.hpp>
 
-#include "StaticString.h"
-#include "Exceptions.h"
-#include "Utils/StrIntUtils.h"
+#include <Logging.h>
+#include <StaticString.h>
+#include <Exceptions.h>
+#include <Utils/StrIntUtils.h>
 
 
-/**
- * A random
- */
 namespace Passenger {
 
 using namespace std;
@@ -81,10 +79,13 @@ public:
 			throw FileSystemException("Cannot open /dev/urandom",
 				errno, "/dev/urandom");
 		}
+		P_LOG_FILE_DESCRIPTOR_OPEN4(fileno(handle), __FILE__, __LINE__,
+			"RandomGenerator");
 	}
 
 	void close() {
 		if (handle != NULL) {
+			P_LOG_FILE_DESCRIPTOR_CLOSE(fileno(handle));
 			syscalls::fclose(handle);
 			handle = NULL;
 		}

data/ext/common/SafeLibev.h

@@ -1,6 +1,6 @@
 /*
  *  Phusion Passenger - https://www.phusionpassenger.com/
- *  Copyright (c) 2010-2014 Phusion
+ *  Copyright (c) 2010-2015 Phusion
  *
  *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
  *
@@ -34,6 +34,7 @@
 #include <boost/function.hpp>
 #include <boost/bind.hpp>
 #include <oxt/thread.hpp>
+#include <Logging.h>
 
 namespace Passenger {
 
@@ -144,6 +145,9 @@ public:
 
 	~SafeLibev() {
 		destroy();
+		P_LOG_FILE_DESCRIPTOR_CLOSE(ev_loop_get_pipe(loop, 0));
+		P_LOG_FILE_DESCRIPTOR_CLOSE(ev_loop_get_pipe(loop, 1));
+		P_LOG_FILE_DESCRIPTOR_CLOSE(ev_backend_fd(loop));
 		ev_loop_destroy(loop);
 	}
 

data/ext/common/ServerKit/AcceptLoadBalancer.h

@@ -159,7 +159,7 @@ private:
 
 		for (i = 0; i < newClientCount; i++) {
 			ServerKit::Context *ctx = servers[nextServer]->getContext();
-			P_TRACE(2, "Feeding client to server thread " << nextServer <<
+			P_TRACE(2, "Feeding client to server thread " << (int) nextServer <<
 				": file descriptor " << newClients[i]);
 			ctx->libev->runLater(boost::bind(feedNewClient, servers[nextServer],
 				newClients[i]));
@@ -190,13 +190,14 @@ private:
 				accept4Available = false;
 				return acceptNonBlockingSocket(serverFd);
 			} else {
+				P_LOG_FILE_DESCRIPTOR_OPEN(fd);
 				return fd;
 			}
 		} else {
 			int fd = syscalls::accept(serverFd,
 				(struct sockaddr *) &u,
 				&addrlen);
-			FdGuard guard(fd);
+			FdGuard guard(fd, __FILE__, __LINE__);
 			if (fd == -1) {
 				return -1;
 			} else {
@@ -254,8 +255,10 @@ public:
 			int e = errno;
 			throw SystemException("Cannot create pipe", e);
 		}
-		FdGuard guard1(exitPipe[0]);
-		FdGuard guard2(exitPipe[1]);
+		FdGuard guard1(exitPipe[0], __FILE__, __LINE__);
+		FdGuard guard2(exitPipe[1], __FILE__, __LINE__);
+		P_LOG_FILE_DESCRIPTOR_PURPOSE(exitPipe[0], "AcceptLoadBalancer: exitPipe[0]");
+		P_LOG_FILE_DESCRIPTOR_PURPOSE(exitPipe[1], "AcceptLoadBalancer: exitPipe[1]");
 		setNonBlocking(exitPipe[0]);
 		setNonBlocking(exitPipe[1]);
 		guard1.clear();
@@ -266,6 +269,8 @@ public:
 		shutdown();
 		close(exitPipe[0]);
 		close(exitPipe[1]);
+		P_LOG_FILE_DESCRIPTOR_CLOSE(exitPipe[0]);
+		P_LOG_FILE_DESCRIPTOR_CLOSE(exitPipe[1]);
 	}
 
 	void listen(int fd) {

data/ext/common/ServerKit/FdSinkChannel.h

@@ -86,6 +86,7 @@ private:
 
 	void initialize() {
 		dataCallback = _onData;
+		watcher.active = false;
 		watcher.fd = -1;
 		watcher.data = this;
 	}
@@ -102,7 +103,7 @@ public:
 	}
 
 	~FdSinkChannel() {
-		if (ctx != NULL) {
+		if (ctx != NULL && ev_is_active(&watcher)) {
 			ev_io_stop(ctx->libev->getLoop(), &watcher);
 		}
 	}
@@ -119,7 +120,9 @@ public:
 	}
 
 	void deinitialize() {
-		ev_io_stop(ctx->libev->getLoop(), &watcher);
+		if (ev_is_active(&watcher)) {
+			ev_io_stop(ctx->libev->getLoop(), &watcher);
+		}
 		watcher.fd = -1;
 		Channel::deinitialize();
 	}

data/ext/common/ServerKit/FdSourceChannel.h

@@ -134,6 +134,7 @@ private:
 
 	void initialize() {
 		burstReadCount = 1;
+		watcher.active = false;
 		watcher.fd = -1;
 		watcher.data = this;
 	}
@@ -152,7 +153,7 @@ public:
 	}
 
 	~FdSourceChannel() {
-		if (ctx != NULL) {
+		if (ctx != NULL && ev_is_active(&watcher)) {
 			ev_io_stop(ctx->libev->getLoop(), &watcher);
 		}
 	}
@@ -170,7 +171,9 @@ public:
 
 	void deinitialize() {
 		buffer = MemoryKit::mbuf();
-		ev_io_stop(ctx->libev->getLoop(), &watcher);
+		if (ev_is_active(&watcher)) {
+			ev_io_stop(ctx->libev->getLoop(), &watcher);
+		}
 		watcher.fd = -1;
 		consumedCallback = NULL;
 		Channel::deinitialize();

data/ext/common/ServerKit/FileBufferedChannel.h

@@ -344,6 +344,7 @@ private:
 			P_ASSERT_EQ(readRequest, 0);
 			P_ASSERT_EQ(writerRequest, 0);
 			if (fd != -1) {
+				P_LOG_FILE_DESCRIPTOR_CLOSE(fd);
 				eio_close(fd, 0, NULL, NULL);
 			}
 		}
@@ -951,6 +952,7 @@ private:
 
 		if (fd != -1) {
 			FBC_DEBUG("Writer: file created. Deleting file in the background");
+			P_LOG_FILE_DESCRIPTOR_OPEN4(fd, __FILE__, __LINE__, "FileBufferedChannel buffer file");
 			eio_unlink(fcContext->path.c_str(), 0, bufferFileUnlinked, fcContext);
 			inFileMode->fd = fd;
 			moveNextBufferToFile();