passenger 4.0.45 → 4.0.46

data/ext/common/ApplicationPool2/Options.h

@@ -46,13 +46,13 @@ using namespace boost;
 
 /**
  * This struct encapsulates information for ApplicationPool::get() and for
- * SpawnManager::spawn(), such as which application is to be spawned.
+ * Spawner::spawn(), such as which application is to be spawned.
  *
- * <h2>Privilege lowering support</h2>
+ * ## Privilege lowering support
  *
  * If <em>user</em> is given and isn't the empty string, then the application process
  * will run as the given username. Otherwise, the owner of the application's startup
- * file (e.g. config.ru or config/environment.rb) will be used.
+ * file (e.g. config.ru) will be used.
  *
  * If <em>group</em> is given and isn't the empty string, then the application process
  * will run as the given group name. If it's set to the special value
@@ -278,10 +278,14 @@ public:
 	 */
 	bool loadShellEnvvars;
 	
-	/** Whether Union Station logging should be enabled. This option only affects
-	 * whether the application enables Union Station support; whether a request
-	 * actually results in data being logged to Union Station depends on whether
-	 * the 'logger' member is set.
+	/** Whether Union Station logging should be enabled. Enabling this option will
+	 * result in:
+	 * 
+	 *  - The application enabling its Union Station support.
+	 *  - Periodic tasks such as `collectAnalytics()` to log things to Union Station.
+	 *
+	 * It does *not* necessarily result in a request logging data to Union Station.
+	 * That depends on whether the `transaction` member is set.
 	 *
 	 * If this is set to true, then 'loggingAgentAddress', 'loggingAgentUsername'
 	 * and 'loggingAgentPassword' must be non-empty.
@@ -365,6 +369,11 @@ public:
 	 * The Union Station log transaction that this request belongs to.
 	 * May be the null pointer, in which case Union Station logging is
 	 * disabled for this request.
+	 *
+	 * When an Options object is passed to another thread (either direct or through
+	 * a copy), the caller should call `detachFromUnionStationTransaction()`.
+	 * Each Union Station transaction object is only supposed to be used in the same
+	 * thread.
 	 */
 	UnionStation::TransactionPtr transaction;
 

data/ext/common/ApplicationPool2/Pool.h

@@ -47,11 +47,8 @@
 #include <ApplicationPool2/Session.h>
 #include <ApplicationPool2/SpawnerFactory.h>
 #include <ApplicationPool2/Options.h>
-#include <UnionStation/Core.h>
-#include <UnionStation/Transaction.h>
 #include <Logging.h>
 #include <Exceptions.h>
-#include <RandomGenerator.h>
 #include <Hooks.h>
 #include <Utils/Lock.h>
 #include <Utils/AnsiColorConstants.h>
@@ -125,8 +122,6 @@ public:
 	typedef boost::shared_ptr<DebugSupport> DebugSupportPtr;
 
 	SpawnerFactoryPtr spawnerFactory;
-	UnionStation::CorePtr unionStationCore;
-	RandomGeneratorPtr randomGenerator;
 	SystemMetricsCollector systemMetricsCollector;
 	SystemMetrics systemMetrics;
 
@@ -279,6 +274,18 @@ public:
 		}
 	}
 
+	const SpawnerConfigPtr &getSpawnerConfig() const {
+		return spawnerFactory->getConfig();
+	}
+
+	const UnionStation::CorePtr &getUnionStationCore() const {
+		return getSpawnerConfig()->unionStationCore;
+	}
+
+	const RandomGeneratorPtr &getRandomGenerator() const {
+		return getSpawnerConfig()->randomGenerator;
+	}
+
 	ProcessPtr findOldestIdleProcess(const Group *exclude = NULL) const {
 		ProcessPtr oldestIdleProcess;
 		
@@ -783,6 +790,7 @@ public:
 	void prepareUnionStationProcessStateLogs(vector<UnionStationLogEntry> &logEntries,
 		const GroupPtr &group) const
 	{
+		const UnionStation::CorePtr &unionStationCore = getUnionStationCore();
 		if (group->options.analytics && unionStationCore != NULL) {
 			logEntries.push_back(UnionStationLogEntry());
 			UnionStationLogEntry &entry = logEntries.back();
@@ -792,7 +800,7 @@ public:
 			group->inspectXml(stream, false);
 			stream << "</group>";
 
-			entry.groupName = group->name;
+			entry.groupName = group->options.getAppGroupName();
 			entry.category  = "processes";
 			entry.key       = group->options.unionStationKey;
 			entry.data      = stream.str();
@@ -802,6 +810,7 @@ public:
 	void prepareUnionStationSystemMetricsLogs(vector<UnionStationLogEntry> &logEntries,
 		const GroupPtr &group) const
 	{
+		const UnionStation::CorePtr &unionStationCore = getUnionStationCore();
 		if (group->options.analytics && unionStationCore != NULL) {
 			logEntries.push_back(UnionStationLogEntry());
 			UnionStationLogEntry &entry = logEntries.back();
@@ -810,7 +819,7 @@ public:
 			stream << "System metrics: ";
 			systemMetrics.toXml(stream);
 
-			entry.groupName = group->name;
+			entry.groupName = group->options.getAppGroupName();
 			entry.category  = "system_metrics";
 			entry.key       = group->options.unionStationKey;
 			entry.data      = stream.str();
@@ -901,15 +910,18 @@ public:
 
 			l.unlock();
 			UPDATE_TRACE_POINT();
-			while (!logEntries.empty()) {
-				UnionStationLogEntry &entry = logEntries.back();
-				UnionStation::TransactionPtr transaction =
-					unionStationCore->newTransaction(
-						entry.groupName,
-						entry.category,
-						entry.key);
-				transaction->message(entry.data);
-				logEntries.pop_back();
+			if (!logEntries.empty()) {
+				const UnionStation::CorePtr &unionStationCore = getUnionStationCore();
+				while (!logEntries.empty()) {
+					UnionStationLogEntry &entry = logEntries.back();
+					UnionStation::TransactionPtr transaction =
+						unionStationCore->newTransaction(
+							entry.groupName,
+							entry.category,
+							entry.key);
+					transaction->message(entry.data);
+					logEntries.pop_back();
+				}
 			}
 
 			UPDATE_TRACE_POINT();
@@ -959,17 +971,9 @@ public:
 	
 public:
 	Pool(const SpawnerFactoryPtr &spawnerFactory,
-		const UnionStation::CorePtr &unionStationCore = UnionStation::CorePtr(),
-		const RandomGeneratorPtr &randomGenerator = RandomGeneratorPtr(),
 		const VariantMap *agentsOptions = NULL)
 	{
 		this->spawnerFactory = spawnerFactory;
-		this->unionStationCore = unionStationCore;
-		if (randomGenerator != NULL) {
-			this->randomGenerator = randomGenerator;
-		} else {
-			this->randomGenerator = boost::make_shared<RandomGenerator>();
-		}
 		this->agentsOptions = agentsOptions;
 
 		try {

data/ext/common/ApplicationPool2/Process.h

@@ -331,8 +331,7 @@ public:
 		const FileDescriptor &_errorPipe,
 		const SocketListPtr &_sockets,
 		unsigned long long _spawnerCreationTime,
-		unsigned long long _spawnStartTime,
-		const SpawnerConfigPtr &_config = SpawnerConfigPtr())
+		unsigned long long _spawnStartTime)
 		: pqHandle(NULL),
 		  pid(_pid),
 		  stickySessionId(0),
@@ -354,13 +353,6 @@ public:
 		  longRunningConnectionsAborted(false),
 		  shutdownStartTime(0)
 	{
-		SpawnerConfigPtr config;
-		if (_config == NULL) {
-			config = boost::make_shared<SpawnerConfig>();
-		} else {
-			config = _config;
-		}
-
 		if (_adminSocket != -1) {
 			PipeWatcherPtr watcher = boost::make_shared<PipeWatcher>(_adminSocket,
 				"stdout", pid);

data/ext/common/ApplicationPool2/SmartSpawner.h

@@ -99,7 +99,7 @@ private:
 	vector<string> createRealPreloaderCommand(const Options &options,
 		shared_array<const char *> &args)
 	{
-		string agentsDir = resourceLocator.getAgentsDir();
+		string agentsDir = config->resourceLocator.getAgentsDir();
 		vector<string> command;
 		
 		if (shouldLoadShellEnvvars(options, preparation)) {
@@ -131,12 +131,13 @@ private:
 		StartupDetails &details)
 	{
 		throwPreloaderSpawnException(msg, errorKind, details.stderrCapturer,
-			details.debugDir);
+			*details.options, details.debugDir);
 	}
 
 	void throwPreloaderSpawnException(const string &msg,
 		SpawnException::ErrorKind errorKind,
 		BackgroundIOCapturerPtr &stderrCapturer,
+		const Options &options,
 		const DebugDirPtr &debugDir)
 	{
 		TRACE_POINT();
@@ -185,7 +186,7 @@ private:
 			errorKind);
 		e.setPreloaderCommand(getPreloaderCommandString());
 		annotatePreloaderException(e, debugDir);
-		throw e;
+		throwSpawnException(e, options);
 	}
 
 	void annotatePreloaderException(SpawnException &e, const DebugDirPtr &debugDir) {
@@ -331,14 +332,14 @@ private:
 		TRACE_POINT();
 		try {
 			string data = "You have control 1.0\n"
-				"passenger_root: " + resourceLocator.getRoot() + "\n"
-				"ruby_libdir: " + resourceLocator.getRubyLibDir() + "\n"
+				"passenger_root: " + config->resourceLocator.getRoot() + "\n"
+				"ruby_libdir: " + config->resourceLocator.getRubyLibDir() + "\n"
 				"passenger_version: " PASSENGER_VERSION "\n"
 				"generation_dir: " + generation->getPath() + "\n";
 
 			vector<string> args;
 			vector<string>::const_iterator it, end;
-			details.options->toVector(args, resourceLocator, Options::SPAWN_OPTIONS);
+			details.options->toVector(args, config->resourceLocator, Options::SPAWN_OPTIONS);
 			for (it = args.begin(); it != args.end(); it++) {
 				const string &key = *it;
 				it++;
@@ -507,7 +508,7 @@ private:
 				SpawnException::PRELOADER_STARTUP_EXPLAINABLE_ERROR);
 			e.setPreloaderCommand(getPreloaderCommandString());
 			annotatePreloaderException(e, details.debugDir);
-			throw e;
+			throwSpawnException(e, *details.options);
 		} catch (const SystemException &e) {
 			throwPreloaderSpawnException("An error occurred while starting up "
 				"the preloader. It tried to report an error message, but "
@@ -608,6 +609,7 @@ private:
 				"socket: " + string(e.what()),
 				SpawnException::APP_STARTUP_PROTOCOL_ERROR,
 				stderrCapturer,
+				options,
 				DebugDirPtr());
 		}
 		
@@ -619,7 +621,7 @@ private:
 		vector<string>::const_iterator it;
 		
 		writeExact(fd, "spawn\n", &timeout);
-		options.toVector(args, resourceLocator, Options::SPAWN_OPTIONS);
+		options.toVector(args, config->resourceLocator, Options::SPAWN_OPTIONS);
 		for (it = args.begin(); it != args.end(); it++) {
 			const string &key = *it;
 			it++;
@@ -642,6 +644,7 @@ private:
 					toString(spawnedPid) + "'",
 					SpawnException::APP_STARTUP_PROTOCOL_ERROR,
 					stderrCapturer,
+					options,
 					DebugDirPtr());
 			}
 			// TODO: we really should be checking UID.
@@ -654,6 +657,7 @@ private:
 					"the same session: '" + toString(spawnedPid) + "'",
 					SpawnException::APP_STARTUP_PROTOCOL_ERROR,
 					stderrCapturer,
+					options,
 					DebugDirPtr());
 			}
 			
@@ -699,12 +703,11 @@ protected:
 	}
 
 public:
-	SmartSpawner(const ResourceLocator &_resourceLocator,
-		const ServerInstanceDir::GenerationPtr &_generation,
+	SmartSpawner(const ServerInstanceDir::GenerationPtr &_generation,
 		const vector<string> &_preloaderCommand,
 		const Options &_options,
-		const SpawnerConfigPtr &_config = SpawnerConfigPtr())
-		: Spawner(_resourceLocator),
+		const SpawnerConfigPtr &_config)
+		: Spawner(_config),
 		  preloaderCommand(_preloaderCommand)
 	{
 		if (preloaderCommand.size() < 2) {
@@ -715,12 +718,6 @@ public:
 		options    = _options.copyAndPersist().detachFromUnionStationTransaction();
 		pid        = -1;
 		m_lastUsed = SystemTime::getUsec();
-
-		if (_config == NULL) {
-			config = boost::make_shared<SpawnerConfig>();
-		} else {
-			config = _config;
-		}
 	}
 	
 	virtual ~SmartSpawner() {

data/ext/common/ApplicationPool2/Spawner.h

@@ -73,12 +73,12 @@
 #include <pwd.h>
 #include <grp.h>
 #include <dirent.h>
+#include <ApplicationPool2/Common.h>
 #include <ApplicationPool2/Process.h>
 #include <ApplicationPool2/Options.h>
 #include <ApplicationPool2/PipeWatcher.h>
 #include <FileDescriptor.h>
 #include <Exceptions.h>
-#include <ResourceLocator.h>
 #include <StaticString.h>
 #include <ServerInstanceDir.h>
 #include <Utils.h>
@@ -384,16 +384,16 @@ private:
 		TRACE_POINT();
 		try {
 			string data = "You have control 1.0\n"
-				"passenger_root: " + resourceLocator.getRoot() + "\n"
+				"passenger_root: " + config->resourceLocator.getRoot() + "\n"
 				"passenger_version: " PASSENGER_VERSION "\n"
-				"ruby_libdir: " + resourceLocator.getRubyLibDir() + "\n"
+				"ruby_libdir: " + config->resourceLocator.getRubyLibDir() + "\n"
 				"generation_dir: " + generation->getPath() + "\n"
 				"gupid: " + details.gupid + "\n"
 				"connect_password: " + details.connectPassword + "\n";
 
 			vector<string> args;
 			vector<string>::const_iterator it, end;
-			details.options->toVector(args, resourceLocator, Options::SPAWN_OPTIONS);
+			details.options->toVector(args, config->resourceLocator, Options::SPAWN_OPTIONS);
 			for (it = args.begin(); it != args.end(); it++) {
 				const string &key = *it;
 				it++;
@@ -530,14 +530,12 @@ private:
 			details.pid,
 			details.gupid, details.connectPassword,
 			details.adminSocket, details.errorPipe,
-			sockets, creationTime, details.spawnStartTime,
-			config);
+			sockets, creationTime, details.spawnStartTime);
 		process->codeRevision = details.preparation->codeRevision;
 		return process;
 	}
 	
 protected:
-	ResourceLocator resourceLocator;
 	ServerInstanceDir::GenerationPtr generation;
 	SpawnerConfigPtr config;
 	
@@ -730,6 +728,11 @@ protected:
 			true,
 			errorKind);
 		annotateAppSpawnException(e, details);
+		throwSpawnException(e, *details.options);
+	}
+
+	void throwSpawnException(SpawnException &e, const Options &options) {
+		processAndLogNewSpawnException(e, options, config);
 		throw e;
 	}
 
@@ -796,7 +799,7 @@ protected:
 		}
 	}
 
-	SpawnPreparationInfo prepareSpawn(const Options &options) const {
+	SpawnPreparationInfo prepareSpawn(const Options &options) {
 		TRACE_POINT();
 		SpawnPreparationInfo info;
 		prepareChroot(info, options);
@@ -806,7 +809,7 @@ protected:
 		return info;
 	}
 
-	void prepareChroot(SpawnPreparationInfo &info, const Options &options) const {
+	void prepareChroot(SpawnPreparationInfo &info, const Options &options) {
 		TRACE_POINT();
 		info.appRoot = absolutizePath(options.appRoot);
 		if (options.preexecChroot.empty()) {
@@ -815,10 +818,11 @@ protected:
 			info.chrootDir = absolutizePath(options.preexecChroot);
 		}
 		if (info.appRoot != info.chrootDir && startsWith(info.appRoot, info.chrootDir + "/")) {
-			throw SpawnException("Invalid configuration: '" + info.chrootDir +
+			SpawnException e("Invalid configuration: '" + info.chrootDir +
 				"' has been configured as the chroot jail, but the application " +
 				"root directory '" + info.appRoot + "' is not a subdirectory of the " +
 				"chroot directory, which it must be.");
+			throwSpawnException(e, options);
 		}
 		if (info.appRoot == info.chrootDir) {
 			info.appRootInsideChroot = "/";
@@ -1042,7 +1046,7 @@ protected:
 		
 		appendNullTerminatedKeyValue(result, "IN_PASSENGER", "1");
 		appendNullTerminatedKeyValue(result, "PYTHONUNBUFFERED", "1");
-		appendNullTerminatedKeyValue(result, "NODE_PATH", resourceLocator.getNodeLibDir());
+		appendNullTerminatedKeyValue(result, "NODE_PATH", config->resourceLocator.getNodeLibDir());
 		appendNullTerminatedKeyValue(result, "RAILS_ENV", options.environment);
 		appendNullTerminatedKeyValue(result, "RACK_ENV", options.environment);
 		appendNullTerminatedKeyValue(result, "WSGI_ENV", options.environment);
@@ -1313,7 +1317,7 @@ protected:
 				attributes["html"] == "true",
 				SpawnException::APP_STARTUP_EXPLAINABLE_ERROR);
 			annotateAppSpawnException(e, details);
-			throw e;
+			throwSpawnException(e, *details.options);
 		} catch (const SystemException &e) {
 			throwAppSpawnException("An error occurred while starting the "
 				"web application. It tried to report an error message, but "
@@ -1352,8 +1356,8 @@ public:
 	 */
 	const unsigned long long creationTime;
 
-	Spawner(const ResourceLocator &_resourceLocator)
-		: resourceLocator(_resourceLocator),
+	Spawner(const SpawnerConfigPtr &_config)
+		: config(_config),
 		  creationTime(SystemTime::getUsec())
 		{ }
 	

data/ext/common/ApplicationPool2/SpawnerFactory.h

@@ -40,15 +40,13 @@ using namespace oxt;
 
 class SpawnerFactory {
 private:
-	ResourceLocator resourceLocator;
 	ServerInstanceDir::GenerationPtr generation;
-	RandomGeneratorPtr randomGenerator;
 	boost::mutex syncher;
 	SpawnerConfigPtr config;
 	DummySpawnerPtr dummySpawner;
 	
 	SpawnerPtr tryCreateSmartSpawner(const Options &options) {
-		string dir = resourceLocator.getHelperScriptsDir();
+		string dir = config->resourceLocator.getHelperScriptsDir();
 		vector<string> preloaderCommand;
 		if (options.appType == "classic-rails") {
 			preloaderCommand.push_back(options.ruby);
@@ -59,23 +57,16 @@ private:
 		} else {
 			return SpawnerPtr();
 		}
-		return boost::make_shared<SmartSpawner>(resourceLocator,
-			generation, preloaderCommand, options, config);
+		return boost::make_shared<SmartSpawner>(generation, preloaderCommand,
+			options, config);
 	}
 	
 public:
-	SpawnerFactory(const ResourceLocator &_resourceLocator,
-		const ServerInstanceDir::GenerationPtr &_generation,
-		const SpawnerConfigPtr &_config = SpawnerConfigPtr())
-		: resourceLocator(_resourceLocator),
-		  generation(_generation)
-	{
-		if (_config == NULL) {
-			config = boost::make_shared<SpawnerConfig>();
-		} else {
-			config = _config;
-		}
-	}
+	SpawnerFactory(const ServerInstanceDir::GenerationPtr &_generation,
+		const SpawnerConfigPtr &_config)
+		: generation(_generation),
+		  config(_config)
+		{ }
 	
 	virtual ~SpawnerFactory() { }
 	
@@ -83,13 +74,12 @@ public:
 		if (options.spawnMethod == "smart" || options.spawnMethod == "smart-lv2") {
 			SpawnerPtr spawner = tryCreateSmartSpawner(options);
 			if (spawner == NULL) {
-				spawner = boost::make_shared<DirectSpawner>(resourceLocator,
-					generation, config);
+				spawner = boost::make_shared<DirectSpawner>(generation, config);
 			}
 			return spawner;
 		} else if (options.spawnMethod == "direct" || options.spawnMethod == "conservative") {
 			boost::shared_ptr<DirectSpawner> spawner = boost::make_shared<DirectSpawner>(
-				resourceLocator, generation, config);
+				generation, config);
 			return spawner;
 		} else if (options.spawnMethod == "dummy") {
 			syscalls::usleep(config->spawnerCreationSleepTime);
@@ -107,7 +97,7 @@ public:
 	DummySpawnerPtr getDummySpawner() {
 		boost::lock_guard<boost::mutex> l(syncher);
 		if (dummySpawner == NULL) {
-			dummySpawner = boost::make_shared<DummySpawner>(resourceLocator, config);
+			dummySpawner = boost::make_shared<DummySpawner>(config);
 		}
 		return dummySpawner;
 	}
@@ -115,17 +105,9 @@ public:
 	/**
 	 * All created Spawner objects share the same SpawnerConfig object.
 	 */
-	SpawnerConfigPtr getConfig() const {
+	const SpawnerConfigPtr &getConfig() const {
 		return config;
 	}
-
-	RandomGeneratorPtr getRandomGenerator() const {
-		return randomGenerator;
-	}
-
-	const ResourceLocator &getResourceLocator() const {
-		return resourceLocator;
-	}
 };
 
 typedef boost::shared_ptr<SpawnerFactory> SpawnerFactoryPtr;