passenger 2.1.3 → 2.2.0

data/ext/{apache2 → common}/ApplicationPoolServer.h

@@ -1,21 +1,26 @@
 /*
  *  Phusion Passenger - http://www.modrails.com/
- *  Copyright (C) 2008  Phusion
+ *  Copyright (c) 2008, 2009 Phusion
  *
- *  Phusion Passenger is a trademark of Hongli Lai & Ninh Bui.
+ *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
  *
- *  This program is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; version 2 of the License.
+ *  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:
  *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
  *
- *  You should have received a copy of the GNU General Public License along
- *  with this program; if not, write to the Free Software Foundation, Inc.,
- *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *  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_APPLICATION_POOL_SERVER_H_
 #define _PASSENGER_APPLICATION_POOL_SERVER_H_
@@ -465,7 +470,6 @@ private:
 	string m_logFile;
 	string m_rubyCommand;
 	string m_user;
-	string statusReportFIFO;
 	
 	/**
 	 * The PID of the ApplicationPool server process. If no server process
@@ -502,11 +506,6 @@ private:
 		bool done = false;
 		
 		syscalls::close(serverSocket);
-		if (!statusReportFIFO.empty()) {
-			do {
-				ret = unlink(statusReportFIFO.c_str());
-			} while (ret == -1 && errno == EINTR);
-		}
 		
 		P_TRACE(2, "Waiting for existing ApplicationPoolServerExecutable (PID " <<
 			serverPid << ") to exit...");
@@ -519,7 +518,7 @@ private:
 			 * signal. This must be the same as the oxt/system_calls.hpp interruption
 			 * signal.
 			 */
-			syscalls::kill(serverPid, SIGINT);
+			syscalls::kill(serverPid, oxt::INTERRUPTION_SIGNAL);
 			
 			ret = syscalls::waitpid(serverPid, &status, WNOHANG);
 			done = ret > 0 || ret == -1;
@@ -572,8 +571,6 @@ private:
 			throw SystemException("Cannot create a Unix socket pair", errno);
 		}
 		
-		createStatusReportFIFO();
-		
 		pid = syscalls::fork();
 		if (pid == 0) { // Child process.
 			dup2(STDERR_FILENO, STDOUT_FILENO);  // Redirect stdout to the same channel as stderr.
@@ -597,7 +594,6 @@ private:
 				m_logFile.c_str(),
 				m_rubyCommand.c_str(),
 				m_user.c_str(),
-				statusReportFIFO.c_str(),
 				(char *) 0);
 			int e = errno;
 			fprintf(stderr, "*** Passenger ERROR (%s:%d):\n"
@@ -622,56 +618,6 @@ private:
 			serverPid = pid;
 		}
 	}
-	
-	void createStatusReportFIFO() {
-		TRACE_POINT();
-		char filename[PATH_MAX];
-		int ret;
-		mode_t permissions = S_IRUSR | S_IWUSR;
-		
-		createPassengerTempDir(getSystemTempDir(), m_user.empty(),
-			"nobody", geteuid(), getegid());
-		
-		snprintf(filename, sizeof(filename), "%s/info/status.fifo",
-				getPassengerTempDir().c_str());
-		filename[PATH_MAX - 1] = '\0';
-		do {
-			ret = mkfifo(filename, permissions);
-		} while (ret == -1 && errno == EINTR);
-		if (ret == -1 && errno != EEXIST) {
-			int e = errno;
-			P_WARN("*** WARNING: Could not create FIFO '" << filename <<
-				"': " << strerror(e) << " (" << e << ")" << endl <<
-				"Disabling Passenger ApplicationPool status reporting.");
-			statusReportFIFO = "";
-		} else {
-			statusReportFIFO = filename;
-			
-			// It seems that the permissions passed to mkfifo()
-			// aren't respected, so here we chmod the file.
-			do {
-				ret = chmod(filename, permissions);
-			} while (ret == -1 && errno == EINTR);
-			
-			// Set the FIFO's owner according to whether we're running as root
-			// and whether user switching is enabled.
-			if (geteuid() == 0 && !m_user.empty()) {
-				uid_t uid;
-				gid_t gid;
-				
-				determineLowestUserAndGroup(m_user, uid, gid);
-				do {
-					ret = chown(filename, uid, gid);
-				} while (ret == -1 && errno == EINTR);
-				if (errno == -1) {
-					int e = errno;
-					P_WARN("*** WARNING: Unable to set the FIFO file '" <<
-						filename << "' its owner and group to that of user " <<
-						m_user << ": " << strerror(e) << " (" << e << ")");
-				}
-			}
-		}
-	}
 
 public:
 	/**

data/ext/{apache2 → common}/ApplicationPoolServerExecutable.cpp

@@ -1,21 +1,26 @@
 /*
  *  Phusion Passenger - http://www.modrails.com/
- *  Copyright (C) 2008  Phusion
+ *  Copyright (c) 2008, 2009 Phusion
  *
- *  Phusion Passenger is a trademark of Hongli Lai & Ninh Bui.
+ *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
  *
- *  This program is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; version 2 of the License.
+ *  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:
  *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
  *
- *  You should have received a copy of the GNU General Public License along
- *  with this program; if not, write to the Free Software Foundation, Inc.,
- *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *  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_APPLICATION_POOL_SERVER_EXECUTABLE_H_
 #define _PASSENGER_APPLICATION_POOL_SERVER_EXECUTABLE_H_
@@ -56,6 +61,7 @@
 
 #include "MessageChannel.h"
 #include "StandardApplicationPool.h"
+#include "ApplicationPoolStatusReporter.h"
 #include "Application.h"
 #include "Logging.h"
 #include "Exceptions.h"
@@ -91,72 +97,11 @@ private:
 	friend class Client;
 
 	int serverSocket;
-	StandardApplicationPool pool;
+	StandardApplicationPoolPtr pool;
 	set<ClientPtr> clients;
 	boost::mutex lock;
-	string statusReportFIFO;
-	shared_ptr<oxt::thread> statusReportThread;
 	string user;
-	
-	void statusReportThreadMain() {
-		TRACE_POINT();
-		try {
-			while (!this_thread::interruption_requested()) {
-				struct stat buf;
-				int ret;
-				
-				UPDATE_TRACE_POINT();
-				do {
-					ret = stat(statusReportFIFO.c_str(), &buf);
-				} while (ret == -1 && errno == EINTR);
-				if (ret == -1 || !S_ISFIFO(buf.st_mode)) {
-					// Something bad happened with the status report
-					// FIFO, so we bail out.
-					break;
-				}
-				
-				UPDATE_TRACE_POINT();
-				FILE *f = syscalls::fopen(statusReportFIFO.c_str(), "w");
-				if (f == NULL) {
-					int e = errno;
-					P_ERROR("Cannot open status report FIFO " <<
-						statusReportFIFO << ": " <<
-						strerror(e) << " (" << e << ")");
-					break;
-				}
-				
-				UPDATE_TRACE_POINT();
-				MessageChannel channel(fileno(f));
-				string report;
-				report.append("----------- Backtraces -----------\n");
-				report.append(oxt::thread::all_backtraces());
-				report.append("\n\n");
-				report.append(pool.toString());
-				
-				UPDATE_TRACE_POINT();
-				try {
-					channel.writeScalar(report);
-					channel.writeScalar(pool.toXml());
-				} catch (...) {
-					// Ignore write errors.
-				}
-				syscalls::fclose(f);
-			}
-		} catch (const boost::thread_interrupted &) {
-			P_TRACE(2, "Status report thread interrupted.");
-		}
-	}
-	
-	void deleteStatusReportFIFO() {
-		TRACE_POINT();
-		if (!statusReportFIFO.empty()) {
-			int ret;
-			do {
-				ret = unlink(statusReportFIFO.c_str());
-			} while (ret == -1 && errno == EINTR);
-		}
-	}
-	
+
 	/**
 	 * Lowers this process's privilege to that of <em>username</em>,
 	 * and sets stricter permissions for the Phusion Passenger temp
@@ -254,7 +199,6 @@ private:
 			sigaction(SIGSEGV, &action, NULL);
 			sigaction(SIGALRM, &action, NULL);
 			sigaction(SIGUSR1, &action, NULL);
-			sigaction(SIGUSR2, &action, NULL);
 		}
 	}
 
@@ -264,13 +208,12 @@ public:
 	       const string &spawnServerCommand,
 	       const string &logFile,
 	       const string &rubyCommand,
-	       const string &user,
-	       const string &statusReportFIFO)
-		: pool(spawnServerCommand, logFile, rubyCommand, user) {
-		
+	       const string &user)
+	{
+		pool = ptr(new StandardApplicationPool(spawnServerCommand,
+			logFile, rubyCommand, user));
 		Passenger::setLogLevel(logLevel);
 		this->serverSocket = serverSocket;
-		this->statusReportFIFO = statusReportFIFO;
 		this->user = user;
 		
 		P_TRACE(2, "ApplicationPoolServerExecutable initialized (PID " << getpid() << ")");
@@ -285,11 +228,6 @@ public:
 		
 		syscalls::close(serverSocket);
 		
-		if (statusReportThread != NULL) {
-			UPDATE_TRACE_POINT();
-			statusReportThread->interrupt_and_join();
-		}
-		
 		// Wait for all clients to disconnect.
 		UPDATE_TRACE_POINT();
 		set<ClientPtr> clientsCopy;
@@ -304,7 +242,6 @@ public:
 			clients.clear();
 		}
 		clientsCopy.clear();
-		deleteStatusReportFIFO();
 		
 		P_TRACE(2, "Server shutdown complete.");
 	}
@@ -355,7 +292,7 @@ private:
 		
 		try {
 			PoolOptions options(args, 1);
-			session = server.pool.get(options);
+			session = server.pool->get(options);
 			sessions[lastSessionID] = session;
 			lastSessionID++;
 		} catch (const SpawnException &e) {
@@ -410,37 +347,37 @@ private:
 	
 	void processClear(const vector<string> &args) {
 		TRACE_POINT();
-		server.pool.clear();
+		server.pool->clear();
 	}
 	
 	void processSetMaxIdleTime(const vector<string> &args) {
 		TRACE_POINT();
-		server.pool.setMaxIdleTime(atoi(args[1]));
+		server.pool->setMaxIdleTime(atoi(args[1]));
 	}
 	
 	void processSetMax(const vector<string> &args) {
 		TRACE_POINT();
-		server.pool.setMax(atoi(args[1]));
+		server.pool->setMax(atoi(args[1]));
 	}
 	
 	void processGetActive(const vector<string> &args) {
 		TRACE_POINT();
-		channel.write(toString(server.pool.getActive()).c_str(), NULL);
+		channel.write(toString(server.pool->getActive()).c_str(), NULL);
 	}
 	
 	void processGetCount(const vector<string> &args) {
 		TRACE_POINT();
-		channel.write(toString(server.pool.getCount()).c_str(), NULL);
+		channel.write(toString(server.pool->getCount()).c_str(), NULL);
 	}
 	
 	void processSetMaxPerApp(unsigned int maxPerApp) {
 		TRACE_POINT();
-		server.pool.setMaxPerApp(maxPerApp);
+		server.pool->setMaxPerApp(maxPerApp);
 	}
 	
 	void processGetSpawnServerPid(const vector<string> &args) {
 		TRACE_POINT();
-		channel.write(toString(server.pool.getSpawnServerPid()).c_str(), NULL);
+		channel.write(toString(server.pool->getSpawnServerPid()).c_str(), NULL);
 	}
 	
 	void processUnknownMessage(const vector<string> &args) {
@@ -584,15 +521,19 @@ Server::start() {
 	setup_syscall_interruption_support();
 	
 	try {
-		if (!statusReportFIFO.empty()) {
-			statusReportThread = ptr(
-				new oxt::thread(
-					bind(&Server::statusReportThreadMain, this),
-					"Status report thread",
-					1024 * 128
-				)
-			);
+		uid_t fifoUid;
+		gid_t fifoGid;
+		
+		// Set the FIFO's owner according to whether we're running as root
+		// and whether user switching is enabled.
+		if (geteuid() == 0 && !user.empty()) {
+			determineLowestUserAndGroup(user, fifoUid, fifoGid);
+		} else {
+			fifoUid = (uid_t) -1;
+			fifoGid = (gid_t) -1;
 		}
+		ApplicationPoolStatusReporter reporter(pool, user.empty(),
+			S_IRUSR | S_IWUSR, fifoUid, fifoGid);
 		
 		if (!user.empty()) {
 			lowerPrivilege(user);
@@ -654,7 +595,7 @@ main(int argc, char *argv[]) {
 	try {
 		exeFile = argv[0];
 		Server server(SERVER_SOCKET_FD, atoi(argv[1]),
-			argv[2], argv[3], argv[4], argv[5], argv[6]);
+			argv[2], argv[3], argv[4], argv[5]);
 		return server.start();
 	} catch (const tracable_exception &e) {
 		P_ERROR("*** Fatal error: " << e.what() << "\n" << e.backtrace());

data/ext/common/ApplicationPoolStatusReporter.h

@@ -0,0 +1,212 @@
+/*
+ *  Phusion Passenger - http://www.modrails.com/
+ *  Copyright (c) 2008, 2009 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_APPLICATION_POOL_STATUS_REPORTER_H_
+#define _PASSENGER_APPLICATION_POOL_STATUS_REPORTER_H_
+
+#include <boost/bind.hpp>
+#include <boost/thread.hpp>
+#include <oxt/thread.hpp>
+#include <oxt/backtrace.hpp>
+#include <oxt/system_calls.hpp>
+
+#include <string>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <cstdio>
+#include <unistd.h>
+#include <errno.h>
+
+#include "StandardApplicationPool.h"
+#include "MessageChannel.h"
+#include "Logging.h"
+#include "Utils.h"
+
+namespace Passenger {
+
+using namespace boost;
+using namespace oxt;
+using namespace std;
+
+/**
+ * An ApplicationPoolStatusReporter allows commandline admin tools to inspect
+ * the status of a StandardApplicationPool. It does so by creating a FIFO
+ * in the Passenger temp folder.
+ *
+ * An ApplicationPoolStatusReporter creates a background thread, which
+ * continuously sends new information through the FIFO. This thread will
+ * be automatically cleaned up upon destroying the ApplicationPoolStatusReporter
+ * object.
+ */
+class ApplicationPoolStatusReporter {
+private:
+	/** The application pool to monitor. */
+	StandardApplicationPoolPtr pool;
+	
+	/** The FIFO's filename. */
+	char filename[PATH_MAX];
+	
+	/** The background thread. */
+	oxt::thread *thr;
+	
+	void threadMain() {
+		TRACE_POINT();
+		try {
+			while (!this_thread::interruption_requested()) {
+				struct stat buf;
+				int ret;
+				
+				UPDATE_TRACE_POINT();
+				do {
+					ret = stat(filename, &buf);
+				} while (ret == -1 && errno == EINTR);
+				if (ret == -1 || !S_ISFIFO(buf.st_mode)) {
+					// Something bad happened with the status
+					// report FIFO, so we bail out.
+					break;
+				}
+				
+				UPDATE_TRACE_POINT();
+				FILE *f = syscalls::fopen(filename, "w");
+				if (f == NULL) {
+					int e = errno;
+					P_ERROR("Cannot open status report FIFO " <<
+						filename << ": " <<
+						strerror(e) << " (" << e << ")");
+					break;
+				}
+				
+				UPDATE_TRACE_POINT();
+				MessageChannel channel(fileno(f));
+				string report;
+				report.append("----------- Backtraces -----------\n");
+				report.append(oxt::thread::all_backtraces());
+				report.append("\n\n");
+				report.append(pool->toString());
+				
+				UPDATE_TRACE_POINT();
+				try {
+					channel.writeScalar(report);
+					channel.writeScalar(pool->toXml());
+				} catch (...) {
+					// Ignore write errors.
+				}
+				syscalls::fclose(f);
+			}
+		} catch (const boost::thread_interrupted &) {
+			P_TRACE(2, "Status report thread interrupted.");
+		}
+	}
+
+public:
+	/**
+	 * Creates a new ApplicationPoolStatusReporter.
+	 *
+	 * @param pool The application pool to monitor.
+	 * @param userSwitching Whether user switching is enabled. This is used
+	 *                      for determining the optimal permissions for the
+	 *                      FIFO file and the temp directory that might get
+	 *                      created.
+	 * @param permissions The permissions with which the FIFO should
+	 *                    be created.
+	 * @param uid The UID of the user who should own the FIFO file, or
+	 *            -1 if the current user should be set as owner.
+	 * @param gid The GID of the user who should own the FIFO file, or
+	 *            -1 if the current group should be set as group.
+	 * @throws SystemException An error occurred while creating the FIFO.
+	 * @throws boost::thread_resource_error Something went wrong during
+	 *     creation of the thread.
+	 */
+	ApplicationPoolStatusReporter(StandardApplicationPoolPtr &pool,
+	                              bool userSwitching,
+	                              mode_t permissions = S_IRUSR | S_IWUSR,
+	                              uid_t uid = -1, gid_t gid = -1) {
+		int ret;
+		
+		this->pool = pool;
+		
+		createPassengerTempDir(getSystemTempDir(), userSwitching,
+			"nobody", geteuid(), getegid());
+		
+		snprintf(filename, sizeof(filename) - 1, "%s/info/status.fifo",
+			getPassengerTempDir().c_str());
+		filename[PATH_MAX - 1] = '\0';
+		
+		do {
+			ret = mkfifo(filename, permissions);
+		} while (ret == -1 && errno == EINTR);
+		if (ret == -1 && errno != EEXIST) {
+			int e = errno;
+			string message("Cannot create FIFO '");
+			message.append(filename);
+			message.append("'");
+			throw SystemException(message, e);
+		}
+		
+		// It seems that the permissions passed to mkfifo()
+		// aren't respected, so here we chmod the file.
+		do {
+			ret = chmod(filename, permissions);
+		} while (ret == -1 && errno == EINTR);
+		
+		if (uid != (uid_t) -1 && gid != (gid_t) -1) {
+			do {
+				ret = chown(filename, uid, gid);
+			} while (ret == -1 && errno == EINTR);
+			if (errno == -1) {
+				int e = errno;
+				char message[1024];
+				
+				snprintf(message, sizeof(message) - 1,
+					"Cannot set the FIFO file '%s' its owner to %lld and group to %lld",
+					filename, (long long) uid, (long long) gid);
+				message[sizeof(message) - 1] = '\0';
+				throw SystemException(message, e);
+			}
+		}
+		
+		thr = new oxt::thread(
+			bind(&ApplicationPoolStatusReporter::threadMain, this),
+			"Status report thread",
+			1024 * 128
+		);
+	}
+	
+	~ApplicationPoolStatusReporter() {
+		this_thread::disable_syscall_interruption dsi;
+		this_thread::disable_interruption di;
+		
+		thr->interrupt_and_join();
+		delete thr;
+		
+		int ret;
+		do {
+			ret = unlink(filename);
+		} while (ret == -1 && errno == EINTR);
+	}
+};
+
+} // namespace Passenger
+
+#endif /* _PASSENGER_APPLICATION_POOL_STATUS_REPORTER_H_ */