passenger 4.0.27 → 4.0.28

data/ext/common/ApplicationPool2/SmartSpawner.h

@@ -49,16 +49,12 @@ private:
 		BackgroundIOCapturerPtr stderrCapturer;
 		DebugDirPtr debugDir;
 		const Options *options;
-		bool forwardStderr;
-		int forwardStderrTo;
 
 		/****** Working state ******/
 		unsigned long long timeout;
 
 		StartupDetails() {
 			options = NULL;
-			forwardStderr = false;
-			forwardStderrTo = STDERR_FILENO;
 			timeout = 0;
 		}
 	};
@@ -268,13 +264,13 @@ private:
 			details.stderrCapturer =
 				make_shared<BackgroundIOCapturer>(
 					errorPipe.first,
-					string("[App ") + toString(pid) + " stderr] ",
-					config->forwardStderr);
+					pid,
+					// The cast works around a compilation problem in Clang.
+					(const char *) "stderr");
 			details.stderrCapturer->start();
 			details.debugDir = debugDir;
 			details.options = &options;
 			details.timeout = options.startTimeout * 1000;
-			details.forwardStderr = config->forwardStderr;
 			
 			{
 				this_thread::restore_interruption ri(di);
@@ -290,12 +286,12 @@ private:
 			PipeWatcherPtr watcher;
 
 			watcher = boost::make_shared<PipeWatcher>(adminSocket.second,
-				"stdout", pid, config->forwardStdout);
+				"stdout", pid);
 			watcher->initialize();
 			watcher->start();
 
 			watcher = boost::make_shared<PipeWatcher>(errorPipe.first,
-				"stderr", pid, config->forwardStderr);
+				"stderr", pid);
 			watcher->initialize();
 			watcher->start();
 			
@@ -777,7 +773,6 @@ public:
 		details.adminSocket = result.adminSocket;
 		details.io = result.io;
 		details.options = &options;
-		details.forwardStderr = config->forwardStderr;
 		ProcessPtr process = negotiateSpawn(details);
 		P_DEBUG("Process spawning done: appRoot=" << options.appRoot <<
 			", pid=" << process->pid);

data/ext/common/ApplicationPool2/Spawner.h

@@ -118,8 +118,8 @@ protected:
 	class BackgroundIOCapturer {
 	private:
 		FileDescriptor fd;
-		string prefix;
-		bool print;
+		pid_t pid;
+		const char *channelName;
 		boost::mutex dataSyncher;
 		string data;
 		oxt::thread *thr;
@@ -148,16 +148,16 @@ protected:
 						data.append(buf, ret);
 					}
 					UPDATE_TRACE_POINT();
-					if (print && ret == 1 && buf[0] == '\n') {
-						P_INFO(prefix);
-					} else if (print) {
+					if (ret == 1 && buf[0] == '\n') {
+						printAppOutput(pid, channelName, "", 0);
+					} else {
 						vector<StaticString> lines;
 						if (ret > 0 && buf[ret - 1] == '\n') {
 							ret--;
 						}
 						split(StaticString(buf, ret), '\n', lines);
 						foreach (const StaticString line, lines) {
-							P_INFO(prefix << line);
+							printAppOutput(pid, channelName, line.data(), line.size());
 						}
 					}
 				}
@@ -165,10 +165,10 @@ protected:
 		}
 		
 	public:
-		BackgroundIOCapturer(const FileDescriptor &_fd, const string &_prefix, bool _print)
+		BackgroundIOCapturer(const FileDescriptor &_fd, pid_t _pid, const char *_channelName)
 			: fd(_fd),
-			  prefix(_prefix),
-			  print(_print),
+			  pid(_pid),
+			  channelName(_channelName),
 			  thr(NULL)
 			{ }
 		
@@ -344,8 +344,6 @@ protected:
 		FileDescriptor adminSocket;
 		FileDescriptor errorPipe;
 		const Options *options;
-		bool forwardStderr;
-		int forwardStderrTo;
 		DebugDirPtr debugDir;
 		
 		/****** Working state ******/
@@ -359,8 +357,6 @@ protected:
 			preparation = NULL;
 			pid = 0;
 			options = NULL;
-			forwardStderr = false;
-			forwardStderrTo = STDERR_FILENO;
 			spawnStartTime = 0;
 			timeout = 0;
 		}
@@ -792,8 +788,7 @@ protected:
 				if (details.stderrCapturer != NULL) {
 					details.stderrCapturer->appendToBuffer(result);
 				}
-				P_LOG(config->forwardStdout ? LVL_INFO : LVL_DEBUG,
-					"[App " << details.pid << " stdout] " << line);
+				printAppOutput(details.pid, "stdout", line.data(), line.size());
 			}
 		}
 	}

data/ext/common/ApplicationPool2/SuperGroup.h

@@ -192,6 +192,9 @@ private:
 	static boost::mutex &getPoolSyncher(const PoolPtr &pool);
 	static void runAllActions(const vector<Callback> &actions);
 	string generateSecret() const;
+	void runInitializationHooks() const;
+	void runDestructionHooks() const;
+	void setupInitializationOrDestructionHook(HookScriptOptions &options) const;
 	
 	void createInterruptableThread(const boost::function<void ()> &func, const string &name,
 		unsigned int stackSize);
@@ -273,8 +276,8 @@ private:
 			}
 			
 			while (!group->getWaitlist.empty()) {
-				getWaitlist.push(group->getWaitlist.front());
-				group->getWaitlist.pop();
+				getWaitlist.push_back(group->getWaitlist.front());
+				group->getWaitlist.pop_front();
 			}
 			detachedGroups.push_back(group);
 			group->shutdown(
@@ -299,7 +302,7 @@ private:
 				postLockActions.push_back(boost::bind(
 					waiter.callback, session, ExceptionPtr()));
 			}
-			getWaitlist.pop();
+			getWaitlist.pop_front();
 		}
 	}
 	
@@ -321,9 +324,7 @@ private:
 	void doDestroy(SuperGroupPtr self, unsigned int generation, ShutdownCallback callback) {
 		TRACE_POINT();
 		
-		// In the future we can run more destruction code here,
-		// without holding the lock. Note that any destruction
-		// code may not interfere with doInitialize().
+		runDestructionHooks();
 		
 		// Wait until 'detachedGroups' is empty.
 		UPDATE_TRACE_POINT();
@@ -398,7 +399,7 @@ public:
 	 *    if !getWaitlist.empty():
 	 *       state == INITIALIZING
 	 */
-	std::queue<GetWaiter> getWaitlist;
+	deque<GetWaiter> getWaitlist;
 
 	/**
 	 * Groups which are being shut down right now. These Groups contain a
@@ -575,7 +576,7 @@ public:
 	SessionPtr get(const Options &newOptions, const GetCallback &callback) {
 		switch (state) {
 		case INITIALIZING:
-			getWaitlist.push(GetWaiter(newOptions, callback));
+			getWaitlist.push_back(GetWaiter(newOptions, callback));
 			verifyInvariants();
 			return SessionPtr();
 		case READY:
@@ -595,7 +596,7 @@ public:
 			}
 		case DESTROYING:
 		case DESTROYED:
-			getWaitlist.push(GetWaiter(newOptions, callback));
+			getWaitlist.push_back(GetWaiter(newOptions, callback));
 			setState(INITIALIZING);
 			createInterruptableThread(
 				boost::bind(

data/ext/common/Constants.h

@@ -48,8 +48,6 @@
 
 	#define DEFAULT_LOG_LEVEL 0
 
-	#define DEFAULT_MAX_INSTANCES_PER_APP 0
-
 	#define DEFAULT_MAX_POOL_SIZE 6
 
 	#define DEFAULT_NODEJS "node"
@@ -80,7 +78,7 @@
 
 	#define NGINX_DOC_URL "http://www.modrails.com/documentation/Users%20guide%20Nginx.html"
 
-	#define PASSENGER_VERSION "4.0.27"
+	#define PASSENGER_VERSION "4.0.28"
 
 	#define POOL_HELPER_THREAD_STACK_SIZE 262144
 

data/ext/common/Hooks.h

@@ -0,0 +1,193 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2010-2013 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_HOOKS_H_
+#define _PASSENGER_HOOKS_H_
+
+#include <string>
+#include <vector>
+#include <utility>
+
+#include <oxt/backtrace.hpp>
+
+#include <sys/types.h>
+#include <sys/wait.h>
+#include <cstdio>
+#include <cerrno>
+#include <cstring>
+#include <cctype>
+#include <stdlib.h>
+#include <unistd.h>
+
+#include <Logging.h>
+#include <Utils.h>
+#include <Utils/StrIntUtils.h>
+#include <Utils/VariantMap.h>
+
+namespace Passenger {
+
+using namespace std;
+using namespace oxt;
+
+
+struct HookScriptOptions {
+	// Required.
+	string name;
+	string spec;
+
+	// Optional.
+	const VariantMap *agentsOptions;
+	vector< pair<string, string> > environment;
+
+	HookScriptOptions()
+		: agentsOptions(NULL)
+		{ }
+};
+
+namespace {
+	inline vector< pair<string, string> >
+	agentsOptionsToEnvVars(const VariantMap &agentsOptions) {
+		vector< pair<string, string> > result;
+		VariantMap::ConstIterator it, end = agentsOptions.end();
+
+		result.reserve(agentsOptions.size());
+		for (it = agentsOptions.begin(); it != end; it++) {
+			string key = "PASSENGER_";
+			const char *data = it->first.data();
+			const char *end = it->first.data() + it->first.size();
+
+			while (data < end) {
+				key.append(1, toupper(*data));
+				data++;
+			}
+			result.push_back(make_pair(key, it->second));
+		}
+
+		return result;
+	}
+
+	inline void
+	setEnvVarsFromVector(const vector< pair<string, string> > &envvars) {
+		vector< pair<string, string> >::const_iterator it;
+
+		for (it = envvars.begin(); it != envvars.end(); it++) {
+			setenv(it->first.c_str(), it->second.c_str(), 1);
+		}
+	}
+
+	inline void
+	createHookScriptEnvironment(const HookScriptOptions &options, vector< pair<string, string> > &envvars) {
+		vector< pair<string, string> >::const_iterator it, end = options.environment.end();
+		if (options.agentsOptions) {
+			envvars = agentsOptionsToEnvVars(*options.agentsOptions);
+		}
+		for (it = options.environment.begin(); it != end; it++) {
+			envvars.push_back(*it);
+		}
+	}
+
+	inline void
+	parseHookScriptSpec(const HookScriptOptions &options, vector<string> &commands) {
+		split(options.spec, ';', commands);
+
+		vector<string>::iterator it, end = commands.end();
+		for (it = commands.begin(); it != end; it++) {
+			*it = strip(*it);
+		}
+	}
+}
+
+inline bool
+runSingleHookScript(HookScriptOptions &options, const string &command,
+	const vector< pair<string, string> > &envvars)
+{
+	TRACE_POINT_WITH_DATA(command.c_str());
+	pid_t pid;
+	int e, status;
+
+	P_INFO("Running " << options.name << " hook script: " << command);
+
+	pid = fork();
+	if (pid == 0) {
+		resetSignalHandlersAndMask();
+		disableMallocDebugging();
+		closeAllFileDescriptors(2);
+		setEnvVarsFromVector(envvars);
+
+		execlp(command.c_str(), command.c_str(), (const char * const) 0);
+		e = errno;
+		fprintf(stderr, "*** ERROR: Cannot execute %s hook script %s: %s (errno=%d)\n",
+			options.name.c_str(), command.c_str(), strerror(e), e);
+		fflush(stderr);
+		_exit(1);
+		return true; // Never reached.
+
+	} else if (pid == -1) {
+		e = errno;
+		P_ERROR("Cannot fork a process for hook script " << command <<
+			": " << strerror(e) << " (errno=" << e << ")");
+		return false;
+
+	} else if (waitpid(pid, &status, 0) == -1) {
+		e = errno;
+		P_ERROR("Unable to wait for hook script " << command <<
+			" (PID " << pid << "): " << strerror(e) << " (errno=" <<
+			e << ")");
+		return false;
+
+	} else {
+		P_INFO("Hook script " << command << " (PID " << pid <<
+			") exited with status " << WEXITSTATUS(status));
+		return WEXITSTATUS(status) == 0;
+	}
+}
+
+inline bool
+runHookScripts(HookScriptOptions &options) {
+	TRACE_POINT();
+	if (options.spec.empty()) {
+		return true;
+	}
+
+	vector<string> commands;
+	vector< pair<string, string> > envvars;
+
+	parseHookScriptSpec(options, commands);
+	if (commands.empty()) {
+		return true;
+	}
+	createHookScriptEnvironment(options, envvars);
+
+	foreach (const string command, commands) {
+		if (!runSingleHookScript(options, command, envvars)) {
+			return false;
+		}
+	}
+	return true;
+}
+
+
+} // namespace Passenger
+
+#endif /* _PASSENGER_HOOKS_H_ */

data/ext/common/Logging.cpp

@@ -27,6 +27,7 @@
 #include <fcntl.h>
 #include <unistd.h>
 #include <Logging.h>
+#include <StaticString.h>
 #include <Utils/StrIntUtils.h>
 #include <Utils/IOUtils.h>
 
@@ -34,6 +35,7 @@ namespace Passenger {
 
 int _logLevel = 0;
 int _logOutput = STDERR_FILENO;
+static bool printAppOutputAsDebuggingMessages = false;
 
 int
 getLogLevel() {
@@ -86,8 +88,8 @@ _prepareLogEntry(std::stringstream &sstream, const char *file, unsigned int line
 		" ]: ";
 }
 
-void
-_writeLogEntry(const std::string &str) {
+static void
+_writeLogEntry(const StaticString &str) {
 	try {
 		writeExact(_logOutput, str.data(), str.size());
 	} catch (const SystemException &) {
@@ -101,5 +103,68 @@ _writeLogEntry(const std::string &str) {
 	}
 }
 
+void
+_writeLogEntry(const std::string &str) {
+	_writeLogEntry(StaticString(str));
+}
+
+static void
+realPrintAppOutput(char *buf, unsigned int bufSize,
+	const char *pidStr, unsigned int pidStrLen,
+	const char *channelName, unsigned int channelNameLen,
+	const char *message, unsigned int messageLen)
+{
+	char *pos = buf;
+	char *end = buf + bufSize;
+
+	pos = appendData(pos, end, "App ");
+	pos = appendData(pos, end, pidStr, pidStrLen);
+	pos = appendData(pos, end, " ");
+	pos = appendData(pos, end, channelName, channelNameLen);
+	pos = appendData(pos, end, ": ");
+	pos = appendData(pos, end, message, messageLen);
+	pos = appendData(pos, end, "\n");
+	_writeLogEntry(StaticString(buf, pos - buf));
+}
+
+void
+printAppOutput(pid_t pid, const char *channelName, const char *message, unsigned int size) {
+	if (printAppOutputAsDebuggingMessages) {
+		P_DEBUG("App " << pid << " " << channelName << ": " << StaticString(message, size));
+	} else {
+		char pidStr[sizeof("4294967295")];
+		unsigned int pidStrLen, channelNameLen, totalLen;
+
+		try {
+			pidStrLen = integerToOtherBase<pid_t, 10>(pid, pidStr, sizeof(pidStr));
+		} catch (const std::length_error &) {
+			pidStr[0] = '?';
+			pidStr[1] = '\0';
+			pidStrLen = 1;
+		}
+
+		channelNameLen = strlen(channelName);
+		totalLen = (sizeof("App X Y: \n") - 2) + pidStrLen + channelNameLen + size;
+		if (totalLen < 1024) {
+			char buf[1024];
+			realPrintAppOutput(buf, sizeof(buf),
+				pidStr, pidStrLen,
+				channelName, channelNameLen,
+				message, size);
+		} else {
+			DynamicBuffer buf(totalLen);
+			realPrintAppOutput(buf.data, totalLen,
+				pidStr, pidStrLen,
+				channelName, channelNameLen,
+				message, size);
+		}
+	}
+}
+
+void
+setPrintAppOutputAsDebuggingMessages(bool enabled) {
+	printAppOutputAsDebuggingMessages = enabled;
+}
+
 } // namespace Passenger