colouringcode-passenger 0.1

data/ext/common/CachedFileStat.hpp

@@ -0,0 +1,243 @@
+/*
+ *  Phusion Passenger - http://www.modrails.com/
+ *  Copyright (c) 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_CACHED_FILE_STAT_HPP_
+#define _PASSENGER_CACHED_FILE_STAT_HPP_
+
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <time.h>
+
+#include <cerrno>
+#include <cassert>
+#include <string>
+#include <boost/shared_ptr.hpp>
+#include <oxt/system_calls.hpp>
+
+#include "SystemTime.h"
+
+namespace Passenger {
+
+using namespace std;
+using namespace oxt;
+using namespace boost;
+
+/**
+ * CachedFileStat allows one to stat() files at a throttled rate, in order
+ * to minimize stress on the filesystem. It does this by caching the old stat
+ * data for a specified amount of time.
+ *
+ * The cache has a maximum size, which may be altered during runtime. If a
+ * file that wasn't in the cache is being stat()ed, and the cache is full,
+ * then the oldest cache entry will be removed.
+ *
+ * This class is fully thread-safe.
+ */
+class CachedFileStat {
+public:
+	/** Represents a cached file stat entry. */
+	class Entry {
+	private:
+		/** The last return value of stat(). */
+		int last_result;
+		
+		/** The errno set by the last stat() call. */
+		int last_errno;
+		
+		/** The last time a stat() was performed. */
+		time_t last_time;
+		
+		/**
+		 * Checks whether <em>interval</em> seconds have elapsed since <em>begin</em>
+		 * The current time is returned via the <tt>currentTime</tt> argument,
+		 * so that the caller doesn't have to call time() again if it needs the current
+		 * time.
+		 *
+		 * @pre begin <= time(NULL)
+		 * @return Whether <tt>interval</tt> seconds have elapsed since <tt>begin</tt>.
+		 * @throws TimeRetrievalException Something went wrong while retrieving the time.
+		 * @throws boost::thread_interrupted
+		 */
+		bool expired(time_t begin, unsigned int interval, time_t &currentTime) {
+			currentTime = SystemTime::get();
+			return (unsigned int) (currentTime - begin) >= interval;
+		}
+		
+	public:
+		/** The cached stat info. */
+		struct stat info;
+		
+		/** This entry's filename. */
+		string filename;
+		
+		/**
+		 * Creates a new Entry object. The file will not be
+		 * stat()ted until you call refresh().
+		 *
+		 * @param filename The file to stat.
+		 */
+		Entry(const string &filename) {
+			memset(&info, 0, sizeof(struct stat));
+			this->filename = filename;
+			last_result = -1;
+			last_errno = 0;
+			last_time = 0;
+		}
+		
+		/**
+		 * Re-stat() the file, if necessary. If <tt>throttleRate</tt> seconds have
+		 * passed since the last time stat() was called, then the file will be
+		 * re-stat()ted.
+		 *
+		 * The stat information, which may either be the result of a new stat() call
+		 * or just the old cached information, is be available in the <tt>info</tt>
+		 * member.
+		 *
+		 * @return 0 if the stat() call succeeded or if no stat() was performed,
+		 *         -1 if something went wrong while statting the file. In the latter
+		 *         case, <tt>errno</tt> will be populated with an appropriate error code.
+		 * @throws TimeRetrievalException Something went wrong while retrieving the
+		 *         system time.
+		 * @throws boost::thread_interrupted
+		 */
+		int refresh(unsigned int throttleRate) {
+			time_t currentTime;
+
+			if (expired(last_time, throttleRate, currentTime)) {
+				last_result = syscalls::stat(filename.c_str(), &info);
+				last_errno = errno;
+				last_time = currentTime;
+				return last_result;
+			} else {
+				errno = last_errno;
+				return last_result;
+			}
+		}
+	};
+	
+	typedef shared_ptr<Entry> EntryPtr;
+	typedef list<EntryPtr> EntryList;
+	typedef map<string, EntryList::iterator> EntryMap;
+	
+	unsigned int maxSize;
+	EntryList entries;
+	EntryMap cache;
+	mutable boost::mutex lock;
+	
+	/**
+	 * Creates a new CachedFileStat object.
+	 *
+	 * @param maxSize The maximum cache size. A size of 0 means unlimited.
+	 */
+	CachedFileStat(unsigned int maxSize = 0) {
+		this->maxSize = maxSize;
+	}
+	
+	/**
+	 * Stats the given file. If <tt>throttleRate</tt> seconds have passed since
+	 * the last time stat() was called on this file, then the file will be
+	 * re-stat()ted, otherwise the cached stat information will be returned.
+	 *
+	 * @param filename The file to stat.
+	 * @param stat A pointer to a stat struct; the retrieved stat information
+	 *             will be stored here.
+	 * @param throttleRate Tells this CachedFileStat that the file may only
+	 *        be statted at most every <tt>throttleRate</tt> seconds.
+	 * @return 0 if the stat() call succeeded or if the cached stat information was used;
+	 *         -1 if something went wrong while statting the file. In the latter
+	 *         case, <tt>errno</tt> will be populated with an appropriate error code.
+	 * @throws SystemException Something went wrong while retrieving the
+	 *         system time. stat() errors will <em>not</em> result in
+	 *         SystemException being thrown.
+	 * @throws boost::thread_interrupted
+	 */
+	int stat(const string &filename, struct stat *buf, unsigned int throttleRate = 0) {
+		boost::unique_lock<boost::mutex> l(lock);
+		EntryMap::iterator it(cache.find(filename));
+		EntryPtr entry;
+		int ret;
+		
+		if (it == cache.end()) {
+			// Filename not in cache.
+			// If cache is full, remove the least recently used
+			// cache entry.
+			if (maxSize != 0 && cache.size() == maxSize) {
+				EntryList::iterator listEnd(entries.end());
+				listEnd--;
+				string filename((*listEnd)->filename);
+				entries.pop_back();
+				cache.erase(filename);
+			}
+			
+			// Add to cache as most recently used.
+			entry = EntryPtr(new Entry(filename));
+			entries.push_front(entry);
+			cache[filename] = entries.begin();
+		} else {
+			// Cache hit.
+			entry = *it->second;
+			
+			// Mark this cache item as most recently used.
+			entries.erase(it->second);
+			entries.push_front(entry);
+			cache[filename] = entries.begin();
+		}
+		ret = entry->refresh(throttleRate);
+		*buf = entry->info;
+		return ret;
+	}
+	
+	/**
+	 * Change the maximum size of the cache. If the new size is larger
+	 * than the old size, then the oldest entries in the cache are
+	 * removed.
+	 *
+	 * A size of 0 means unlimited.
+	 */
+	void setMaxSize(unsigned int maxSize) {
+		boost::unique_lock<boost::mutex> l(lock);
+		if (maxSize != 0) {
+			int toRemove = cache.size() - maxSize;
+			for (int i = 0; i < toRemove; i++) {
+				string filename(entries.back()->filename);
+				entries.pop_back();
+				cache.erase(filename);
+			}
+		}
+		this->maxSize = maxSize;
+	}
+	
+	/**
+	 * Returns whether <tt>filename</tt> is in the cache.
+	 */
+	bool knows(const string &filename) const {
+		boost::unique_lock<boost::mutex> l(lock);
+		return cache.find(filename) != cache.end();
+	}
+};
+
+} // namespace Passenger
+
+#endif /* _PASSENGER_CACHED_FILE_STAT_HPP_ */

data/ext/common/DummySpawnManager.h

@@ -0,0 +1,108 @@
+/*
+ *  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_DUMMY_SPAWN_MANAGER_H_
+#define _PASSENGER_DUMMY_SPAWN_MANAGER_H_
+
+// TODO: make this path not hardcoded
+#define DUMMY_REQUEST_HANDLER_EXECUTABLE "/home/hongli/Projects/passenger/benchmark/DummyRequestHandler"
+
+#include <string>
+
+#include <sys/types.h>
+#include <sys/wait.h>
+#include <cstdio>
+#include <unistd.h>
+#include <errno.h>
+
+#include "Application.h"
+#include "Exceptions.h"
+
+namespace Passenger {
+
+using namespace std;
+
+/**
+ * A dummy SpawnManager replacement for testing/debugging purposes.
+ *
+ * This class implements a dummy spawn manager, and is 100% interface-compatible with
+ * SpawnManager. This spawn manager will spawn <tt>benchmark/DummyRequestHandler</tt>,
+ * which is probably the fastest possible implementation of a request handler. The purpose
+ * of this class to benchmark the performance of the Apache module (i.e. not benchmarking
+ * the Ruby request handler or Rails itself).
+ *
+ * This header file is not used by default. Define the macro <tt>PASSENGER_USE_DUMMY_SPAWN_MANAGER</tt>
+ * to make ApplicationPool use DummySpawnManager instead of SpawnManager.
+ *
+ * Of course, don't forget to compile benchmark/DummyRequestHandler!
+ *
+ * @ingroup Support
+ */
+class DummySpawnManager {
+public:
+	ApplicationPtr spawn(const string &appRoot, const string &user = "", const string &group = "") {
+		int fds[2];
+		pid_t pid;
+		
+		if(socketpair(AF_UNIX, SOCK_STREAM, 0, fds) == -1) {
+			throw SystemException("Cannot create a Unix socket", errno);
+		}
+		pid = fork();
+		if (pid == 0) {
+			pid = fork();
+			if (pid == 0) {
+				dup2(fds[0], STDIN_FILENO);
+				close(fds[0]);
+				close(fds[1]);
+				execlp(DUMMY_REQUEST_HANDLER_EXECUTABLE, DUMMY_REQUEST_HANDLER_EXECUTABLE, NULL);
+				int e = errno;
+				fprintf(stderr, "Unable to run %s: %s\n", DUMMY_REQUEST_HANDLER_EXECUTABLE, strerror(e));
+				fflush(stderr);
+				_exit(1);
+			} else if (pid == -1) {
+				perror("Cannot fork a new process");
+				fflush(stderr);
+				_exit(1);
+			} else {
+				_exit(0);
+			}
+		} else if (pid == -1) {
+			close(fds[0]);
+			close(fds[1]);
+			throw SystemException("Cannot fork a new process", errno);
+		} else {
+			close(fds[0]);
+			waitpid(pid, NULL, 0);
+			return ApplicationPtr(new Application(appRoot, pid, fds[1]));
+		}
+	}
+	
+	pid_t getServerPid() const {
+		return 0;
+	}
+};
+
+} // namespace Passenger
+
+#endif /* _PASSENGER_DUMMY_SPAWN_MANAGER_H_ */

data/ext/common/Exceptions.h

@@ -0,0 +1,258 @@
+/*
+ *  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_EXCEPTIONS_H_
+#define _PASSENGER_EXCEPTIONS_H_
+
+#include <oxt/tracable_exception.hpp>
+#include <string>
+#include <sstream>
+#include <cstring>
+
+/**
+ * @defgroup Exceptions Exceptions
+ */
+
+namespace Passenger {
+
+using namespace std;
+
+/**
+ * Represents an error returned by a system call or a standard library call.
+ *
+ * Use the code() method to find out the value of <tt>errno</tt> at the time
+ * the error occured.
+ *
+ * @ingroup Exceptions
+ */
+class SystemException: public oxt::tracable_exception {
+private:
+	string briefMessage;
+	string systemMessage;
+	string fullMessage;
+	int m_code;
+public:
+	/**
+	 * Create a new SystemException.
+	 *
+	 * @param briefMessage A brief message describing the error.
+	 * @param errorCode The error code, i.e. the value of errno right after the error occured.
+	 * @note A system description of the error will be appended to the given message.
+	 *    For example, if <tt>errorCode</tt> is <tt>EBADF</tt>, and <tt>briefMessage</tt>
+	 *    is <em>"Something happened"</em>, then what() will return <em>"Something happened: Bad
+	 *    file descriptor (10)"</em> (if 10 is the number for EBADF).
+	 * @post code() == errorCode
+	 * @post brief() == briefMessage
+	 */
+	SystemException(const string &briefMessage, int errorCode) {
+		stringstream str;
+		
+		str << strerror(errorCode) << " (" << errorCode << ")";
+		systemMessage = str.str();
+		
+		setBriefMessage(briefMessage);
+		m_code = errorCode;
+	}
+	
+	virtual ~SystemException() throw() {}
+	
+	virtual const char *what() const throw() {
+		return fullMessage.c_str();
+	}
+	
+	void setBriefMessage(const string &message) {
+		briefMessage = message;
+		fullMessage = briefMessage + ": " + systemMessage;
+	}
+	
+	/**
+	 * The value of <tt>errno</tt> at the time the error occured.
+	 */
+	int code() const throw() {
+		return m_code;
+	}
+	
+	/**
+	 * Returns a brief version of the exception message. This message does
+	 * not include the system error description, and is equivalent to the
+	 * value of the <tt>message</tt> parameter as passed to the constructor.
+	 */
+	string brief() const throw() {
+		return briefMessage;
+	}
+	
+	/**
+	 * Returns the system's error message. This message contains both the
+	 * content of <tt>strerror(errno)</tt> and the errno number itself.
+	 */
+	string sys() const throw() {
+		return systemMessage;
+	}
+};
+
+/**
+ * A filesystem error, as returned by the operating system. This may include,
+ * for example, permission errors.
+ *
+ * @ingroup Exceptions
+ */
+class FileSystemException: public SystemException {
+private:
+	string m_filename;
+public:
+	FileSystemException(const string &message, int errorCode,
+		const string &filename)
+		: SystemException(message, errorCode),
+		  m_filename(filename) {}
+	
+	virtual ~FileSystemException() throw() {}
+	
+	/**
+	 * The filename that's associated to the error.
+	 */
+	string filename() const throw() {
+		return m_filename;
+	}
+};
+
+/**
+ * Unable to retrieve the system time using <tt>time()</tt>.
+ *
+ * @ingroup Exceptions
+ */
+class TimeRetrievalException: public SystemException {
+public:
+	TimeRetrievalException(const string &message, int errorCode)
+		: SystemException(message, errorCode)
+		{}
+	virtual ~TimeRetrievalException() throw() {}
+};
+
+/**
+ * Represents an error that occured during an I/O operation.
+ *
+ * @ingroup Exceptions
+ */
+class IOException: public oxt::tracable_exception {
+private:
+	string msg;
+public:
+	IOException(const string &message): msg(message) {}
+	virtual ~IOException() throw() {}
+	virtual const char *what() const throw() { return msg.c_str(); }
+};
+
+/**
+ * Thrown when a certain file cannot be found.
+ */
+class FileNotFoundException: public IOException {
+public:
+	FileNotFoundException(const string &message): IOException(message) {}
+	virtual ~FileNotFoundException() throw() {}
+};
+
+/**
+ * Thrown when an invalid configuration is given.
+ */
+class ConfigurationException: public oxt::tracable_exception {
+private:
+	string msg;
+public:
+	ConfigurationException(const string &message): msg(message) {}
+	virtual ~ConfigurationException() throw() {}
+	virtual const char *what() const throw() { return msg.c_str(); }
+};
+
+/**
+ * Thrown when SpawnManager or ApplicationPool fails to spawn an application
+ * instance. The exception may contain an error page, which is a user-friendly
+ * HTML page with details about the error.
+ */
+class SpawnException: public oxt::tracable_exception {
+private:
+	string msg;
+	bool m_hasErrorPage;
+	string m_errorPage;
+public:
+	SpawnException(const string &message)
+		: msg(message) {
+		m_hasErrorPage = false;
+	}
+	
+	SpawnException(const string &message, const string &errorPage)
+		: msg(message), m_errorPage(errorPage) {
+		m_hasErrorPage = true;
+	}
+	
+	virtual ~SpawnException() throw() {}
+	virtual const char *what() const throw() { return msg.c_str(); }
+	
+	/**
+	 * Check whether an error page is available.
+	 */
+	bool hasErrorPage() const {
+		return m_hasErrorPage;
+	}
+	
+	/**
+	 * Return the error page content.
+	 *
+	 * @pre hasErrorPage()
+	 */
+	const string getErrorPage() const {
+		return m_errorPage;
+	}
+};
+
+/**
+ * A generic runtime exception.
+ *
+ * @ingroup Exceptions
+ */
+class RuntimeException: public oxt::tracable_exception {
+private:
+	string msg;
+public:
+	RuntimeException(const string &message): msg(message) {}
+	virtual ~RuntimeException() throw() {}
+	virtual const char *what() const throw() { return msg.c_str(); }
+};
+
+/**
+ * The application pool is too busy and cannot fulfill a get() request.
+ *
+ * @ingroup Exceptions
+ */
+class BusyException: public oxt::tracable_exception {
+private:
+	string msg;
+public:
+	BusyException(const string &message): msg(message) {}
+	virtual ~BusyException() throw() {}
+	virtual const char *what() const throw() { return msg.c_str(); }
+};
+
+} // namespace Passenger
+
+#endif /* _PASSENGER_EXCEPTIONS_H_ */