passenger 4.0.0.rc6 → 4.0.1

data/ext/common/ApplicationPool2/Pool.h

@@ -428,7 +428,7 @@ public:
 	}
 	
 	void inspectProcessList(const InspectOptions &options, stringstream &result,
-		const ProcessList &processes) const
+		const Group *group, const ProcessList &processes) const
 	{
 		ProcessList::const_iterator p_it;
 		for (p_it = processes.begin(); p_it != processes.end(); p_it++) {
@@ -453,8 +453,7 @@ public:
 				result << "    Disabling..." << endl;
 			} else if (process->enabled == Process::DISABLED) {
 				result << "    DISABLED" << endl;
-			}
-			if (process->getLifeStatus() == Process::SHUTTING_DOWN) {
+			} else if (process->enabled == Process::DETACHED) {
 				result << "    Shutting down...";
 			}
 
@@ -1388,10 +1387,10 @@ public:
 					result << "  (spawning new process...)" << endl;
 				}
 				result << "  Requests in queue: " << group->getWaitlist.size() << endl;
-				inspectProcessList(options, result, group->enabledProcesses);
-				inspectProcessList(options, result, group->disablingProcesses);
-				inspectProcessList(options, result, group->disabledProcesses);
-				inspectProcessList(options, result, group->detachedProcesses);
+				inspectProcessList(options, result, group, group->enabledProcesses);
+				inspectProcessList(options, result, group, group->disablingProcesses);
+				inspectProcessList(options, result, group, group->disabledProcesses);
+				inspectProcessList(options, result, group, group->detachedProcesses);
 				result << endl;
 			}
 		}

data/ext/common/ApplicationPool2/Process.h

@@ -128,7 +128,7 @@ class Process: public enable_shared_from_this<Process> {
 private:
 	friend class Group;
 	
-	/** A mutex to protect access to `m_shutDown`. */
+	/** A mutex to protect access to `lifeStatus`. */
 	mutable boost::mutex lifetimeSyncher;
 
 	/** Group inside the Pool that this Process belongs to.
@@ -200,9 +200,10 @@ public:
 	 * the admin socket need not be closed, etc.
 	 */
 	bool dummy;
-	/** Whether it is required that shutdown() must be called before destroying
-	 * this Process. Normally true, except for dummy Process objects created by
-	 * Pool::asyncGet() with options.noop == true.
+	/** Whether it is required that triggerShutdown() and cleanup() must be called
+	 * before destroying this Process. Normally true, except for dummy Process
+	 * objects created by Pool::asyncGet() with options.noop == true, because those
+	 * processes are never added to Group.enabledProcesses.
 	 */
 	bool requiresShutdown;
 	
@@ -224,19 +225,21 @@ public:
 	int sessions;
 	/** Number of sessions opened so far. */
 	unsigned int processed;
-	/** Do not access directly, always use `isAlive()`/`isShutDown()`/`getLifeStatus()` or
+	/** Do not access directly, always use `isAlive()`/`isDead()`/`getLifeStatus()` or
 	 * through `lifetimeSyncher`. */
 	enum LifeStatus {
 		/** Up and operational. */
 		ALIVE,
-		/** Being shut down. The containing Group has just detached this
-		 * Process and is now waiting for it to be shutdownable.
-		 */
-		SHUTTING_DOWN,
+		/** This process has been detached, and the detached processes checker has
+		 * verified that there are no active sessions left and has told the process
+		 * to shut down. In this state we're supposed to wait until the process
+		 * has actually shutdown, after which clean() must be called. */
+		SHUTDOWN_TRIGGERED,
 		/**
-		 * Shut down. Object no longer usable. No more sessions are active.
+		 * The process has exited and clean() has been called. In this state,
+		 * this object is no longer usable.
 		 */
-		SHUT_DOWN
+		DEAD
 	} lifeStatus;
 	enum EnabledStatus {
 		/** Up and operational. */
@@ -250,7 +253,14 @@ public:
 		 * requests. It *may* still handle some requests, e.g. by
 		 * the Out-of-Band-Work trigger.
 		 */
-		DISABLED
+		DISABLED,
+		/**
+		 * Process has been detached. It will be removed from the Group
+		 * as soon we have detected that the OS process has exited. Detached
+		 * processes are allowed to finish their requests, but are not
+		 * eligible for new requests.
+		 */
+		DETACHED
 	} enabled;
 	enum OobwStatus {
 		/** Process is not using out-of-band work. */
@@ -330,15 +340,19 @@ public:
 	}
 	
 	~Process() {
-		if (OXT_UNLIKELY(!isShutDown() && requiresShutdown)) {
-			P_BUG("You must call Process::shutdown() before actually "
+		if (OXT_UNLIKELY(!isDead() && requiresShutdown)) {
+			P_BUG("You must call Process::triggerShutdown() and Process::cleanup() before actually "
 				"destroying the Process object.");
 		}
 	}
 
-	static void maybeShutdown(ProcessPtr process) {
+	static void forceTriggerShutdownAndCleanup(ProcessPtr process) {
 		if (process != NULL) {
-			process->shutdown();
+			process->triggerShutdown();
+			// Pretend like the OS process has exited so
+			// that the canCleanup() precondition is true.
+			process->m_osProcessExists = false;
+			process->cleanup();
 		}
 	}
 
@@ -348,7 +362,7 @@ public:
 	 * @post result != NULL
 	 */
 	const GroupPtr getGroup() const {
-		assert(!isShutDown());
+		assert(!isDead());
 		return group.lock();
 	}
 	
@@ -359,7 +373,7 @@ public:
 
 	/**
 	 * Thread-safe.
-	 * @pre getLifeState() != SHUT_DOWN
+	 * @pre getLifeState() != DEAD
 	 * @post result != NULL
 	 */
 	SuperGroupPtr getSuperGroup() const;
@@ -371,9 +385,15 @@ public:
 	}
 
 	// Thread-safe.
-	bool isShutDown() const {
+	bool hasTriggeredShutdown() const {
 		lock_guard<boost::mutex> lock(lifetimeSyncher);
-		return lifeStatus == SHUT_DOWN;
+		return lifeStatus == SHUTDOWN_TRIGGERED;
+	}
+
+	// Thread-safe.
+	bool isDead() const {
+		lock_guard<boost::mutex> lock(lifetimeSyncher);
+		return lifeStatus == DEAD;
 	}
 
 	// Thread-safe.
@@ -382,32 +402,30 @@ public:
 		return lifeStatus;
 	}
 
-	void setShuttingDown() {
+	bool canTriggerShutdown() const {
+		return getLifeStatus() == ALIVE && sessions == 0;
+	}
+
+	void triggerShutdown() {
+		assert(canTriggerShutdown());
 		{
 			lock_guard<boost::mutex> lock(lifetimeSyncher);
 			assert(lifeStatus == ALIVE);
-			lifeStatus = SHUTTING_DOWN;
+			lifeStatus = SHUTDOWN_TRIGGERED;
 		}
 		if (!dummy) {
 			syscalls::shutdown(adminSocket, SHUT_WR);
 		}
 	}
 
-	void shutdown() {
-		LifeStatus ls = getLifeStatus();
-		if (ls == SHUT_DOWN || !requiresShutdown) {
-			// Some code have guards that call process->shutdown().
-			// Returning instead of enforcing !isShutdown() makes things easier.
-			return;
-		}
-
-		assert(sessions == 0);
+	bool canCleanup() const {
+		return getLifeStatus() == SHUTDOWN_TRIGGERED && !osProcessExists();
+	}
 
-		if (ls == ALIVE) {
-			setShuttingDown();
-		}
+	void cleanup() {
+		assert(canCleanup());
 
-		P_TRACE(2, "Shutting down Process object " << inspect());
+		P_TRACE(2, "Cleaning up process " << inspect());
 		if (!dummy) {
 			if (OXT_LIKELY(sockets != NULL)) {
 				SocketList::const_iterator it, end = sockets->end();
@@ -421,11 +439,7 @@ public:
 		}
 
 		lock_guard<boost::mutex> lock(lifetimeSyncher);
-		lifeStatus = SHUT_DOWN;
-	}
-
-	bool canBeShutDown() const {
-		return sessions == 0 && !osProcessExists();
+		lifeStatus = DEAD;
 	}
 
 	/** Checks whether the OS process exists.
@@ -535,11 +549,11 @@ public:
 		case ALIVE:
 			stream << "<life_status>ALIVE</life_status>";
 			break;
-		case SHUTTING_DOWN:
-			stream << "<life_status>SHUTTING_DOWN</life_status>";
+		case SHUTDOWN_TRIGGERED:
+			stream << "<life_status>SHUTDOWN_TRIGGERED</life_status>";
 			break;
-		case SHUT_DOWN:
-			stream << "<life_status>SHUT_DOWN</life_status>";
+		case DEAD:
+			stream << "<life_status>DEAD</life_status>";
 			break;
 		default:
 			P_BUG("Unknown 'lifeStatus' state " << (int) lifeStatus);
@@ -554,6 +568,9 @@ public:
 		case DISABLED:
 			stream << "<enabled>DISABLED</enabled>";
 			break;
+		case DETACHED:
+			stream << "<enabled>DETACHED</enabled>";
+			break;
 		default:
 			P_BUG("Unknown 'enabled' state " << (int) enabled);
 		}

data/ext/common/ApplicationPool2/Spawner.h

@@ -801,6 +801,7 @@ protected:
 			return;
 		}
 		
+		UPDATE_TRACE_POINT();
 		string defaultGroup;
 		string startupFile = absolutizePath(options.getStartupFile(), info.appRoot);
 		struct passwd *userInfo = NULL;
@@ -823,6 +824,7 @@ protected:
 			defaultGroup = options.defaultGroup;
 		}
 		
+		UPDATE_TRACE_POINT();
 		if (!options.user.empty()) {
 			userInfo = getpwnam(options.user.c_str());
 		} else {
@@ -838,6 +840,7 @@ protected:
 			userInfo = getpwnam(options.defaultUser.c_str());
 		}
 		
+		UPDATE_TRACE_POINT();
 		if (!options.group.empty()) {
 			if (options.group == "!STARTUP_FILE!") {
 				struct stat buf;
@@ -857,6 +860,7 @@ protected:
 			groupInfo = getgrnam(defaultGroup.c_str());
 		}
 		
+		UPDATE_TRACE_POINT();
 		if (userInfo == NULL) {
 			throw RuntimeException("Cannot determine a user to lower privilege to");
 		}
@@ -864,6 +868,7 @@ protected:
 			throw RuntimeException("Cannot determine a group to lower privilege to");
 		}
 		
+		UPDATE_TRACE_POINT();
 		#ifdef __APPLE__
 			int groups[1024];
 			info.ngroups = sizeof(groups) / sizeof(int);

data/ext/common/BackgroundEventLoop.cpp

@@ -63,17 +63,7 @@ startBackgroundLoop(BackgroundEventLoop *bg) {
 
 BackgroundEventLoop::BackgroundEventLoop(bool scalable) {
 	TRACE_POINT();
-	loop = ev_loop_new(EVBACKEND_EPOLL);
-	if (loop == NULL) {
-		loop = ev_loop_new(EVBACKEND_KQUEUE);
-	}
-	if (loop == NULL) {
-		loop = ev_loop_new(0);
-	}
-	if (loop == NULL) {
-		throw RuntimeException("Cannot create an event loop");
-	}
-
+	
 	if (scalable) {
 		loop = ev_loop_new(EVBACKEND_KQUEUE);
 		if (loop == NULL) {
@@ -85,6 +75,10 @@ BackgroundEventLoop::BackgroundEventLoop(bool scalable) {
 	} else {
 		loop = ev_loop_new(EVBACKEND_POLL);
 	}
+	if (loop == NULL) {
+		throw RuntimeException("Cannot create an event loop");
+	}
+
 	async = (ev_async *) malloc(sizeof(ev_async));
 	async->data = this;
 	ev_async_init(async, signalBackgroundEventLoopExit);

data/ext/common/Constants.h

@@ -26,7 +26,7 @@
 #define _PASSENGER_CONSTANTS_H_
 
 /* Don't forget to update lib/phusion_passenger.rb too. */
-#define PASSENGER_VERSION "4.0.0.rc6"
+#define PASSENGER_VERSION "4.0.1"
 
 #define FEEDBACK_FD 3
 

data/ext/common/Utils.cpp

@@ -391,7 +391,7 @@ getProcessUsername() {
 		result = (struct passwd *) NULL;
 	}
 	
-	if (result == (struct passwd *) NULL) {
+	if (result == (struct passwd *) NULL || result->pw_name == NULL || result->pw_name[0] == '\0') {
 		snprintf(strings, sizeof(strings), "UID %lld", (long long) getuid());
 		strings[sizeof(strings) - 1] = '\0';
 		return strings;

data/ext/common/agents/HelperAgent/AgentOptions.h

@@ -1,6 +1,6 @@
 /*
  *  Phusion Passenger - https://www.phusionpassenger.com/
- *  Copyright (c) 2011, 2012 Phusion
+ *  Copyright (c) 2011-2013 Phusion
  *
  *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
  *

data/ext/common/agents/HelperAgent/RequestHandler.h

@@ -1646,6 +1646,8 @@ private:
 		options.loggingAgentAddress = this->options.loggingAgentAddress;
 		options.loggingAgentUsername = "logging";
 		options.loggingAgentPassword = this->options.loggingAgentPassword;
+		options.defaultUser = this->options.defaultUser;
+		options.defaultGroup = this->options.defaultGroup;
 		fillPoolOption(client, options.appGroupName, "PASSENGER_APP_GROUP_NAME");
 		fillPoolOption(client, options.appType, "PASSENGER_APP_TYPE");
 		fillPoolOption(client, options.environment, "PASSENGER_ENV");

data/ext/common/agents/LoggingAgent/LoggingServer.h

@@ -1129,7 +1129,10 @@ public:
 		TransactionMap::const_iterator end = transactions.end();
 		
 		stream << "Number of clients : " << getClients().size() << "\n";
-		stream << "RemoteSender queue: " << remoteSender.queued() << " items\n";
+		stream << "\n";
+
+		stream << "RemoteSender:\n";
+		remoteSender.inspect(stream);
 		stream << "\n";
 
 		LogSinkCache::const_iterator sit;

data/ext/common/agents/LoggingAgent/RemoteSender.h

@@ -33,12 +33,14 @@
 
 #include <boost/shared_ptr.hpp>
 #include <boost/bind.hpp>
+#include <boost/foreach.hpp>
 #include <oxt/thread.hpp>
 #include <string>
 #include <list>
 
 #include <Logging.h>
 #include <StaticString.h>
+#include <Utils.h>
 #include <Utils/BlockingQueue.h>
 #include <Utils/SystemTime.h>
 #include <Utils/ScopeGuard.h>
@@ -164,6 +166,10 @@ private:
 			}
 			curl_slist_free_all(headers);
 		}
+
+		string name() const {
+			return ip + ":" + toString(port);
+		}
 		
 		bool ping() {
 			P_DEBUG("Pinging Union Station gateway " << ip << ":" << port);
@@ -258,12 +264,13 @@ private:
 	BlockingQueue<Item> queue;
 	oxt::thread *thr;
 	
+	mutable boost::mutex syncher;
 	list<ServerPtr> servers;
 	time_t nextCheckupTime;
+	unsigned int packetsSent, packetsDropped;
 	
 	void threadMain() {
 		ScopeGuard guard(boost::bind(&RemoteSender::freeThreadData, this));
-		nextCheckupTime = 0;
 		
 		while (true) {
 			Item item;
@@ -292,21 +299,22 @@ private:
 	}
 	
 	bool firstStarted() const {
+		lock_guard<boost::mutex> l(syncher);
 		return nextCheckupTime == 0;
 	}
 	
 	void recheckServers() {
-		P_DEBUG("Rechecking Union Station gateway servers (" << gatewayAddress << ")...");
+		P_INFO("Rechecking Union Station gateway servers (" << gatewayAddress << ")...");
 		
 		vector<string> ips;
 		vector<string>::const_iterator it;
+		list<ServerPtr> servers;
 		string hostName;
 		bool someServersAreDown = false;
 		
 		ips = resolveHostname(gatewayAddress, gatewayPort);
-		P_DEBUG(ips.size() << " Union Station gateway servers found");
+		P_INFO(ips.size() << " Union Station gateway servers found");
 		
-		servers.clear();
 		for (it = ips.begin(); it != ips.end(); it++) {
 			ServerPtr server = make_shared<Server>(*it, gatewayAddress, gatewayPort,
 				certificate, &proxyInfo);
@@ -316,7 +324,7 @@ private:
 				someServersAreDown = true;
 			}
 		}
-		P_DEBUG(servers.size() << " Union Station gateway servers are up");
+		P_INFO(servers.size() << " Union Station gateway servers are up");
 		
 		if (servers.empty()) {
 			scheduleNextCheckup(5 * 60);
@@ -325,9 +333,13 @@ private:
 		} else {
 			scheduleNextCheckup(3 * 60 * 60);
 		}
+
+		lock_guard<boost::mutex> l(syncher);
+		this->servers = servers;
 	}
 	
 	void freeThreadData() {
+		lock_guard<boost::mutex> l(syncher);
 		servers.clear(); // Invoke destructors inside this thread.
 	}
 	
@@ -345,6 +357,7 @@ private:
 	}
 	
 	unsigned int msecUntilNextCheckup() const {
+		lock_guard<boost::mutex> l(syncher);
 		time_t now = SystemTime::get();
 		if (now >= nextCheckupTime) {
 			return 0;
@@ -354,10 +367,12 @@ private:
 	}
 	
 	bool timeForCheckup() const {
+		lock_guard<boost::mutex> l(syncher);
 		return SystemTime::get() >= nextCheckupTime;
 	}
 	
 	void sendOut(const Item &item) {
+		unique_lock<boost::mutex> l(syncher);
 		bool sent = false;
 		bool someServersWentDown = false;
 		
@@ -365,12 +380,18 @@ private:
 			// Pick first available server and put it on the back of the list
 			// for round-robin load balancing.
 			ServerPtr server = servers.front();
-			servers.pop_front();
+			l.unlock();
 			if (server->send(item)) {
+				l.lock();
+				servers.pop_front();
 				servers.push_back(server);
 				sent = true;
+				packetsSent++;
 			} else {
+				l.lock();
+				servers.pop_front();
 				someServersWentDown = true;
+				packetsDropped++;
 			}
 		}
 		
@@ -386,6 +407,13 @@ private:
 		 * effectively dropped until after the next checkup has detected
 		 * servers that are up.
 		 */
+		if (!sent) {
+			P_WARN("Dropping Union Station packet because no servers are available: "
+				"key=" << item.unionStationKey <<
+				", node=" << item.nodeName <<
+				", category=" << item.category <<
+				", compressedDataSize=" << item.data.size());
+		}
 	}
 	
 	bool compress(const StaticString data[], unsigned int count, string &output) {
@@ -443,6 +471,9 @@ public:
 			throw RuntimeException("Invalid Union Station proxy address \"" +
 				proxyAddress + "\": " + e.what());
 		}
+		nextCheckupTime = 0;
+		packetsSent = 0;
+		packetsDropped = 0;
 		thr = new oxt::thread(
 			boost::bind(&RemoteSender::threadMain, this),
 			"RemoteSender thread",
@@ -494,12 +525,33 @@ public:
 
 		if (!queue.tryAdd(item)) {
 			P_WARN("The Union Station gateway isn't responding quickly enough; dropping packet.");
+			lock_guard<boost::mutex> l(syncher);
+			packetsDropped++;
 		}
 	}
 	
 	unsigned int queued() const {
 		return queue.size();
 	}
+
+	template<typename Stream>
+	void inspect(Stream &stream) const {
+		lock_guard<boost::mutex> l(syncher);
+		stream << "  Available servers (" << servers.size() << "): ";
+		foreach (const ServerPtr server, servers) {
+			stream << server->name() << " ";
+		}
+		stream << "\n";
+		stream << "  Items in queue: " << queue.size() << "\n";
+		stream << "  Packet sent out so far: " << packetsSent << "\n";
+		stream << "  Packet dropped out so far: " << packetsDropped << "\n";
+		stream << "  Next server checkup time: ";
+		if (nextCheckupTime == 0) {
+			stream << "not yet scheduled, waiting for first packet\n";
+		} else {
+			stream << "in " << distanceOfTimeInWords(nextCheckupTime) << "\n";
+		}
+	}
 };