passenger 5.1.10 → 5.1.11

data/src/agent/Shared/{Base.h → Fundamentals/Initialization.h}

@@ -23,37 +23,46 @@
  *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  *  THE SOFTWARE.
  */
-#ifndef _PASSENGER_AGENT_BASE_H_
-#define _PASSENGER_AGENT_BASE_H_
+#ifndef _PASSENGER_AGENT_FUNDAMENTALS_INITIALIZATION_H_
+#define _PASSENGER_AGENT_FUNDAMENTALS_INITIALIZATION_H_
 
 /** Common initialization code for all agents. */
 
 #include <cstddef>
 #include <Utils/VariantMap.h>
+#include <Shared/Fundamentals/AbortHandler.h>
 
 namespace Passenger {
+namespace Agent {
+namespace Fundamentals {
+
+
+struct Context {
+	ResourceLocator *resourceLocator;
+	unsigned int randomSeed;
+	int origArgc;
+	char **origArgv;
+	bool feedbackFdAvailable;
+	AbortHandlerConfig abortHandlerConfig;
+};
 
-typedef void (*DiagnosticsDumper)(void *userData);
 typedef void (*OptionParserFunc)(int argc, const char **argv, VariantMap &options);
 typedef void (*PreinitializationFunc)(VariantMap &options);
 
-const char *getEnvString(const char *name, const char *defaultValue = NULL);
-bool hasEnvOption(const char *name, bool defaultValue = false);
+extern Context *context;
+
 
-bool feedbackFdAvailable();
 VariantMap initializeAgent(int argc, char **argv[], const char *processName,
 	OptionParserFunc optionParser = NULL, PreinitializationFunc preinit = NULL,
 	int argStartIndex = 1);
-void initializeAgentOptions(const char *processName, VariantMap &options,
-	PreinitializationFunc preinit = NULL);
-void storeArgvCopy(int argc, char *argv[]);
-void installAgentAbortHandler();
-void installDiagnosticsDumper(DiagnosticsDumper func, void *userData);
-
 void shutdownAgent(VariantMap *agentOptions);
 
+bool feedbackFdAvailable();
 void restoreOomScore(VariantMap *agentOptions);
 
-}
 
-#endif /* _PASSENGER_AGENT_BASE_H_ */
+} // namespace Fundamentals
+} // namespace Agent
+} // namespace Passenger
+
+#endif /* _PASSENGER_AGENT_FUNDAMENTALS_INITIALIZATION_H_ */

data/src/agent/Shared/Fundamentals/Utils.cpp

@@ -0,0 +1,127 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2010-2017 Phusion Holding B.V.
+ *
+ *  "Passenger", "Phusion Passenger" and "Union Station" are registered
+ *  trademarks of Phusion Holding B.V.
+ *
+ *  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.
+ */
+
+#include <Shared/Fundamentals/Utils.h>
+#include <oxt/backtrace.hpp>
+#include <cstdlib>
+#include <cstring>
+#include <signal.h>
+#include <fcntl.h>
+#include <unistd.h>
+
+namespace Passenger {
+namespace Agent {
+namespace Fundamentals {
+
+using namespace std;
+
+
+const char *
+getEnvString(const char *name, const char *defaultValue) {
+	const char *value = getenv(name);
+	if (value != NULL && *value != '\0') {
+		return value;
+	} else {
+		return defaultValue;
+	}
+}
+
+bool
+getEnvBool(const char *name, bool defaultValue) {
+	const char *value = getEnvString(name);
+	if (value != NULL) {
+		return strcmp(value, "yes") == 0
+			|| strcmp(value, "y") == 0
+			|| strcmp(value, "1") == 0
+			|| strcmp(value, "on") == 0
+			|| strcmp(value, "true") == 0;
+	} else {
+		return defaultValue;
+	}
+}
+
+void
+ignoreSigpipe() {
+	struct sigaction action;
+	action.sa_handler = SIG_IGN;
+	action.sa_flags   = 0;
+	sigemptyset(&action.sa_mask);
+	sigaction(SIGPIPE, &action, NULL);
+}
+
+/**
+ * Linux-only way to change OOM killer configuration for
+ * current process. Requires root privileges, which we
+ * should have.
+ *
+ * Returns 0 on success, or an errno code on error.
+ *
+ * This function is async signal-safe.
+ */
+int
+tryRestoreOomScore(const StaticString &scoreString, bool &isLegacy) {
+	TRACE_POINT();
+	if (scoreString.empty()) {
+		return 0;
+	}
+
+	int fd, ret, e;
+	size_t written = 0;
+	StaticString score;
+
+	if (scoreString.at(0) == 'l') {
+		isLegacy = true;
+		score = scoreString.substr(1);
+		fd = open("/proc/self/oom_adj", O_WRONLY | O_TRUNC, 0600);
+	} else {
+		isLegacy = false;
+		score = scoreString;
+		fd = open("/proc/self/oom_score_adj", O_WRONLY | O_TRUNC, 0600);
+	}
+
+	if (fd == -1) {
+		return errno;
+	}
+
+	do {
+		ret = write(fd, score.data() + written, score.size() - written);
+		if (ret != -1) {
+			written += ret;
+		}
+	} while (ret == -1 && errno != EAGAIN && written < score.size());
+	e = errno;
+	close(fd);
+	if (ret == -1) {
+		return e;
+	} else {
+		return 0;
+	}
+}
+
+
+} // namespace Fundamentals
+} // namespace Agent
+} // namespace Passenger

data/src/agent/Shared/Fundamentals/Utils.h

@@ -0,0 +1,46 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2010-2017 Phusion Holding B.V.
+ *
+ *  "Passenger", "Phusion Passenger" and "Union Station" are registered
+ *  trademarks of Phusion Holding B.V.
+ *
+ *  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_AGENT_FUNDAMENTALS_UTILS_H_
+#define _PASSENGER_AGENT_FUNDAMENTALS_UTILS_H_
+
+#include <StaticString.h>
+
+namespace Passenger {
+namespace Agent {
+namespace Fundamentals {
+
+
+const char *getEnvString(const char *name, const char *defaultValue = NULL);
+bool getEnvBool(const char *name, bool defaultValue = false);
+void ignoreSigpipe();
+int tryRestoreOomScore(const StaticString &score, bool &isLegacy);
+
+
+} // namespace Fundamentals
+} // namespace Agent
+} // namespace Passenger
+
+#endif /* _PASSENGER_AGENT_FUNDAMENTALS_UTILS_H_ */

data/src/agent/TempDirToucher/TempDirToucherMain.cpp

@@ -73,7 +73,7 @@ static sig_atomic_t shouldIgnoreNextTermSignal = 0;
 
 static void
 usage() {
-	printf("Usage: " AGENT_EXE " temp-dir-watcher <DIRECTORY> [OPTIONS...]\n");
+	printf("Usage: " AGENT_EXE " temp-dir-toucher <DIRECTORY> [OPTIONS...]\n");
 	printf("Touches everything in a directory every 30 minutes, to "
 		"prevent /tmp cleaners from removing the directory.\n");
 	printf("\n");

data/src/agent/Watchdog/CoreWatcher.cpp

@@ -24,6 +24,8 @@
  *  THE SOFTWARE.
  */
 
+#include <Shared/Fundamentals/Utils.h>
+
 class CoreWatcher: public AgentWatcher {
 protected:
 	string agentFilename;
@@ -37,7 +39,7 @@ protected:
 	}
 
 	virtual void execProgram() const {
-		if (hasEnvOption("PASSENGER_RUN_CORE_IN_VALGRIND", false)) {
+		if (getEnvBool("PASSENGER_RUN_CORE_IN_VALGRIND", false)) {
 			execlp("valgrind", "valgrind", "--dsymutil=yes", "--track-origins=yes", "--leak-check=full",
 				agentFilename.c_str(), "core",
 				// Some extra space to allow the child process to change its process title.

data/src/agent/Watchdog/InstanceDirToucher.cpp

@@ -24,6 +24,10 @@
  *  THE SOFTWARE.
  */
 
+#include <boost/bind.hpp>
+#include <Shared/Fundamentals/Utils.h>
+#include <Utils/AsyncSignalSafeUtils.h>
+
 /**
  * Touch all files in the server instance dir every 6 hours in order to prevent /tmp
  * cleaners from weaking havoc:
@@ -34,68 +38,101 @@ private:
 	WorkingObjectsPtr wo;
 	oxt::thread *thr;
 
+	static void afterFork(const StaticString &originalOomScore, const char *workingDir) {
+		namespace ASSU = AsyncSignalSafeUtils;
+		int prio, ret, e;
+
+		// Make process nicer.
+		do {
+			prio = getpriority(PRIO_PROCESS, getpid());
+		} while (prio == -1 && errno == EINTR);
+		if (prio != -1) {
+			prio++;
+			if (prio > 20) {
+				prio = 20;
+			}
+			do {
+				ret = setpriority(PRIO_PROCESS, getpid(), prio);
+			} while (ret == -1 && errno == EINTR);
+		} else {
+			char buf[1024];
+			char *pos = buf;
+			const char *end = buf + sizeof(buf);
+
+			e = errno;
+			pos = ASSU::appendData(pos, end, "getpriority() failed: ");
+			pos = ASSU::appendData(pos, end, ASSU::limitedStrerror(e));
+			pos = ASSU::appendData(pos, end, " (errno=");
+			pos = ASSU::appendInteger<int, 10>(pos, end, e);
+			pos = ASSU::appendData(pos, end, ")");
+			ASSU::printError(buf, pos - buf);
+		}
+
+		do {
+			ret = chdir(workingDir);
+		} while (ret == -1 && errno == EINTR);
+		if (ret == -1) {
+			char buf[1024];
+			char *pos = buf;
+			const char *end = buf + sizeof(buf);
+
+			e = errno;
+			pos = ASSU::appendData(pos, end, "chdir(\"");
+			pos = ASSU::appendData(pos, end, workingDir);
+			pos = ASSU::appendData(pos, end, "\") failed: ");
+			pos = ASSU::appendData(pos, end, ASSU::limitedStrerror(e));
+			pos = ASSU::appendData(pos, end, " (errno=");
+			pos = ASSU::appendInteger<int, 10>(pos, end, e);
+			pos = ASSU::appendData(pos, end, ")");
+			ASSU::printError(buf, pos - buf);
+			_exit(1);
+		}
+
+		bool isLegacy;
+		ret = tryRestoreOomScore(originalOomScore, isLegacy);
+		if (ret != 0) {
+			char buf[1024];
+			char *pos = buf;
+			const char *end = buf + sizeof(buf);
+
+			pos = ASSU::appendData(pos, end, "Unable to set OOM score to ");
+			pos = ASSU::appendData(pos, end, originalOomScore.data(), originalOomScore.size());
+			pos = ASSU::appendData(pos, end, " (legacy: ");
+			pos = ASSU::appendData(pos, end, isLegacy ? "true" : "false");
+			pos = ASSU::appendData(pos, end, ") due to error: ");
+			pos = ASSU::appendData(pos, end, ASSU::limitedStrerror(ret));
+			pos = ASSU::appendData(pos, end, " (errno=");
+			pos = ASSU::appendInteger<int, 10>(pos, end, ret);
+			pos = ASSU::appendData(pos, end, "). Process will remain at inherited OOM score.");
+			ASSU::printError(buf, pos - buf);
+		}
+	}
+
 	void
 	threadMain() {
+		string originalOomScore = agentsOptions->get("original_oom_score", false);
+		string workingDir = wo->instanceDir->getPath().c_str();
+
 		while (!boost::this_thread::interruption_requested()) {
 			syscalls::sleep(60 * 60);
 
 			begin_touch:
 
-			boost::this_thread::disable_interruption di;
-			boost::this_thread::disable_syscall_interruption dsi;
-			// Fork a process which touches everything in the server instance dir.
-			pid_t pid = syscalls::fork();
-			if (pid == 0) {
-				// Child
-				int prio, ret, e;
-
-				closeAllFileDescriptors(2);
-
-				// Make process nicer.
-				do {
-					prio = getpriority(PRIO_PROCESS, getpid());
-				} while (prio == -1 && errno == EINTR);
-				if (prio != -1) {
-					prio++;
-					if (prio > 20) {
-						prio = 20;
-					}
-					do {
-						ret = setpriority(PRIO_PROCESS, getpid(), prio);
-					} while (ret == -1 && errno == EINTR);
-				} else {
-					perror("getpriority");
-				}
-
-				do {
-					ret = chdir(wo->instanceDir->getPath().c_str());
-				} while (ret == -1 && errno == EINTR);
-				if (ret == -1) {
-					e = errno;
-					fprintf(stderr, "chdir(\"%s\") failed: %s (%d)\n",
-						wo->instanceDir->getPath().c_str(),
-						strerror(e), e);
-					fflush(stderr);
-					_exit(1);
-				}
-				restoreOomScore(agentsOptions);
-
-				execlp("/bin/sh", "/bin/sh", "-c", "find . | xargs touch", (char *) 0);
-				e = errno;
-				fprintf(stderr, "Cannot execute 'find . | xargs touch': %s (%d)\n",
-					strerror(e), e);
-				fflush(stderr);
-				_exit(1);
-			} else if (pid == -1) {
-				// Error
-				P_WARN("Could not touch the server instance directory because "
-					"fork() failed. Retrying in 2 minutes...");
-				boost::this_thread::restore_interruption si(di);
-				boost::this_thread::restore_syscall_interruption rsi(dsi);
+			try {
+				const char *command[] = {
+					"/bin/sh",
+					"-c",
+					"find . | xargs touch",
+					NULL
+				};
+				SubprocessInfo info;
+				runCommand(command, info, true, true,
+					boost::bind(afterFork, originalOomScore, workingDir.c_str()));
+			} catch (const SystemException &e) {
+				P_WARN("Could not touch the " PROGRAM_NAME " instance directory ("
+					<< e.what() << "). Retrying in 2 minutes...");
 				syscalls::sleep(60 * 2);
 				goto begin_touch;
-			} else {
-				syscalls::waitpid(pid, NULL, 0);
 			}
 		}
 	}

data/src/agent/Watchdog/WatchdogMain.cpp

@@ -43,7 +43,7 @@
 #endif
 
 #ifdef __linux__
-#include <sys/prctl.h>
+	#include <sys/prctl.h>
 #endif
 #include <sys/select.h>
 #include <sys/types.h>
@@ -62,10 +62,9 @@
 #include <cerrno>
 
 #include <jsoncpp/json.h>
-#include <Shared/Base.h>
+#include <Shared/Fundamentals/Initialization.h>
 #include <Shared/ApiServerUtils.h>
 #include <Core/OptionParser.h>
-#include <UstRouter/OptionParser.h>
 #include <Watchdog/ApiServer.h>
 #include <Constants.h>
 #include <InstanceDirectory.h>
@@ -90,6 +89,7 @@ using namespace std;
 using namespace boost;
 using namespace oxt;
 using namespace Passenger;
+using namespace Passenger::Agent::Fundamentals;
 
 
 enum OomFileType {
@@ -158,7 +158,6 @@ static void cleanup(const WorkingObjectsPtr &wo);
 #include "AgentWatcher.cpp"
 #include "InstanceDirToucher.cpp"
 #include "CoreWatcher.cpp"
-#include "UstRouterWatcher.cpp"
 
 
 /***** Functions *****/
@@ -654,7 +653,7 @@ parseOptions(int argc, const char *argv[], VariantMap &options) {
 				 || p.isFlag(argv[i], '\0', "--begin-core-args"))
 				{
 					break;
-				} else if (!parseUstRouterOption(argc, argv, i, options)) {
+				} else {
 					fprintf(stderr, "ERROR: unrecognized UstRouter argument %s. Please "
 						"type '%s ust-router --help' for usage.\n", argv[i], argv[0]);
 					exit(1);
@@ -949,9 +948,15 @@ lowerPrivilege() {
 				"to that of user '" + userName + "' and group '" + groupName +
 				"': cannot set user ID to " + toString(pwUser->pw_uid), e);
 		}
-#ifdef __linux__
-		prctl(PR_SET_DUMPABLE, 1);
-#endif
+		#ifdef __linux__
+			// When we change the uid, /proc/self/pid contents don't change owner,
+			// causing us to lose access to our own /proc/self/pid files.
+			// This prctl call changes those files' ownership.
+			// References:
+			// https://stackoverflow.com/questions/8337846/files-ownergroup-doesnt-change-at-location-proc-pid-after-setuid
+			// http://man7.org/linux/man-pages/man5/proc.5.html (search for "dumpable")
+			prctl(PR_SET_DUMPABLE, 1);
+		#endif
 		setenv("USER", pwUser->pw_name, 1);
 		setenv("HOME", pwUser->pw_dir, 1);
 		setenv("UID", toString(gid).c_str(), 1);
@@ -1062,26 +1067,6 @@ initializeWorkingObjects(const WorkingObjectsPtr &wo, InstanceDirToucherPtr &ins
 	options.setStrSet("core_api_addresses", strset);
 
 	UPDATE_TRACE_POINT();
-	options.setDefault("ust_router_address",
-		"unix:" + wo->instanceDir->getPath() + "/agents.s/ust_router");
-	options.setDefault("ust_router_password",
-		wo->randomGenerator.generateAsciiString(24));
-
-	strset = options.getStrSet("ust_router_api_addresses", false);
-	strset.insert(strset.begin(),
-		"unix:" + wo->instanceDir->getPath() + "/agents.s/ust_router_api");
-	options.setStrSet("ust_router_api_addresses", strset);
-
-	UPDATE_TRACE_POINT();
-	strset = options.getStrSet("ust_router_authorizations", false);
-	strset.insert(strset.begin(),
-		"readonly:ro_admin:" + wo->instanceDir->getPath() +
-		"/read_only_admin_password.txt");
-	strset.insert(strset.begin(),
-		"full:admin:" + wo->instanceDir->getPath() +
-		"/full_admin_password.txt");
-	options.setStrSet("ust_router_authorizations", strset);
-
 	strset = options.getStrSet("core_authorizations", false);
 	strset.insert(strset.begin(),
 		"readonly:ro_admin:" + wo->instanceDir->getPath() +
@@ -1096,7 +1081,6 @@ static void
 initializeAgentWatchers(const WorkingObjectsPtr &wo, vector<AgentWatcherPtr> &watchers) {
 	TRACE_POINT();
 	watchers.push_back(boost::make_shared<CoreWatcher>(wo));
-	watchers.push_back(boost::make_shared<UstRouterWatcher>(wo));
 }
 
 static void