passenger 5.0.9 → 5.0.10

data/doc/Design and Architecture.txt

@@ -219,11 +219,6 @@ The main interface into the subsystem is the Pool class, with its `asyncGet()` m
 
 The Pool class is the core of the subsystem. It contains high-level process management logic but not low-level details, such as the details of spawning processes. The code is further divided into the following classes, each of which contain the core code managing its respective domain:
 
-**SuperGroup**::
-	A logical collection of different applications. It's designed to be able to contain one or more Groups, but currently it always contains exactly 1 Group.
-+
-SuperGroup was originally introduced as a building block for a future feature: polyglot, multi-language applications. The idea was that, as more and more programming languages are introduced and become popular, there would be more and more demand to write applications in multiple languages. This would be done by splitting applications into multiple parts, with each part implemented in a different language. We wanted to introduce a feature that makes it super-easy to make such polyglot applications as a single whole. However, as time went on, we realized that we were mistaken and that most developers actually don't want to bother with multiple programming languages: they'd rather stick with a single one. So nowadays, SuperGroup is actually obsolete, but it's still kept in the codebase because it's not harmful, and removing it is too much work.
-
 **Group**::
 	Represents an application. It can contain multiple processes, all belonging to the same application.
 
@@ -239,7 +234,7 @@ SuperGroup was originally introduced as a building block for a future feature: p
 **Options (not shown in diagram)**::
 	A configuration object for the `Pool::asyncGet()` method.
 
-If you look at the diagram, then you see that SuperGroup, Group and Process all have 0..1 associations with their containing classes. An object that has a NULL association with its containing object, is considered invalid and should not be used. The fact that the association can be NULL is a detail of the memory management scheme that we employ.
+If you look at the diagram, then you see that Group and Process all have 0..1 associations with their containing classes. An object that has a NULL association with its containing object, is considered invalid and should not be used. The fact that the association can be NULL is a detail of the memory management scheme that we employ.
 
 [[spawner_subsystem]]
 === The Spawner subsystem

data/doc/Users guide Apache.html

@@ -4431,7 +4431,7 @@ stay that way until someone visits <em>foobar.com</em>. Suppose that there is on
 be spawned in the background. After 10 seconds, when the idle timeout has
 been reached, these 3 application processes will not be cleaned up.</p></div>
 <div class="paragraph"><p>Now suppose that there’s a sudden spike of traffic, and 100 users visit <em>foobar.com</em>
-simultanously. Phusion Passenger will start 12 more application processes. After the idle
+simultaneously. Phusion Passenger will start 12 more application processes. After the idle
 timeout of 10 seconds have passed, Phusion Passenger will clean up 12 application
 processes, keeping 3 processes around.</p></div>
 <div class="paragraph"><p>The PassengerMinInstances option may occur in the following places:</p></div>
@@ -7201,24 +7201,6 @@ The application taking too long to start, and hitting Phusion Passenger’s time
 <div class="paragraph"><p>This hook does not block because it’s always run in an extra background thread. Errors in the hook script are ignored.</p></div>
 </dd>
 <dt class="hdlist1">
-<span class="monospaced">after_initialize_supergroup</span>
-</dt>
-<dd>
-<p>
-        Called right after Phusion Passenger has allocated data structures for an application, and is about to spawn a process for the first time for this application. Errors in the hook script are ignored. Extra environment variables: <span class="monospaced">PASSENGER_APP_ROOT</span>.
-</p>
-</dd>
-<dt class="hdlist1">
-<span class="monospaced">before_destroy_supergroup</span>
-</dt>
-<dd>
-<p>
-        Called right before Phusion Passenger decallocates data structures for an application. Errors in the hook script are ignored.
-</p>
-<div class="paragraph"><p>Note that the <span class="monospaced">after_initialize_supergroup</span> hook may be called while this hook is still being executed, so make sure that operations don’t conflict with each other.</p></div>
-<div class="paragraph"><p>Extra environment variables: <span class="monospaced">PASSENGER_APP_ROOT</span>.</p></div>
-</dd>
-<dt class="hdlist1">
 <span class="monospaced">max_request_time_reached</span> (since 5.0.2, Enterprise-only)
 </dt>
 <dd>

data/doc/Users guide Apache.txt

@@ -1135,7 +1135,7 @@ be spawned in the background. After 10 seconds, when the idle timeout has
 been reached, these 3 application processes will not be cleaned up.
 
 Now suppose that there's a sudden spike of traffic, and 100 users visit 'foobar.com'
-simultanously. Phusion Passenger will start 12 more application processes. After the idle
+simultaneously. Phusion Passenger will start 12 more application processes. After the idle
 timeout of 10 seconds have passed, Phusion Passenger will clean up 12 application
 processes, keeping 3 processes around.
 

data/doc/Users guide Nginx.html

@@ -4470,7 +4470,7 @@ In an <em>if</em> configuration scope.
 <div class="sect3">
 <a href="javascript:void(0)" class="comments empty" title="Add a comment"><span class="count"></span></a><span class="anchor_helper" id="PassengerMaxPoolSize"></span><h4 data-comment-topic="passenger-max-pool-size-integer--3jzefs" data-anchor="PassengerMaxPoolSize">7.5.1. passenger_max_pool_size &lt;integer&gt;</h4>
 <div class="paragraph"><p>The maximum number of <a href="#application_process">application processes</a> that may
-simultanously exist. A larger number results in higher memory usage,
+simultaneously exist. A larger number results in higher memory usage,
 but improves the ability to handle concurrent HTTP requests.</p></div>
 <div class="paragraph"><p>The optimal value depends on your system’s hardware and your workload. You can learn more at the Phusion article <a href="http://blog.phusion.nl/2013/03/12/tuning-phusion-passengers-concurrency-settings/">Tuning Phusion Passenger’s concurrency settings</a>.</p></div>
 <div class="paragraph"><p>If you find that your server is running out of memory then you should lower this value.</p></div>
@@ -4532,7 +4532,7 @@ stay that way until someone visits <em>foobar.com</em>. Suppose that there is on
 be spawned in the background. After 10 seconds, when the idle timeout has
 been reached, these 3 application processes will not be cleaned up.</p></div>
 <div class="paragraph"><p>Now suppose that there’s a sudden spike of traffic, and 100 users visit <em>foobar.com</em>
-simultanously. Phusion Passenger will start 12 more application processes. After the idle
+simultaneously. Phusion Passenger will start 12 more application processes. After the idle
 timeout of 10 seconds have passed, Phusion Passenger will clean up 12 application
 processes, keeping 3 processes around.</p></div>
 <div class="paragraph"><p>The passenger_min_instances option may occur in the following places:</p></div>
@@ -7186,24 +7186,6 @@ The application taking too long to start, and hitting Phusion Passenger’s time
 <div class="paragraph"><p>This hook does not block because it’s always run in an extra background thread. Errors in the hook script are ignored.</p></div>
 </dd>
 <dt class="hdlist1">
-<span class="monospaced">after_initialize_supergroup</span>
-</dt>
-<dd>
-<p>
-        Called right after Phusion Passenger has allocated data structures for an application, and is about to spawn a process for the first time for this application. Errors in the hook script are ignored. Extra environment variables: <span class="monospaced">PASSENGER_APP_ROOT</span>.
-</p>
-</dd>
-<dt class="hdlist1">
-<span class="monospaced">before_destroy_supergroup</span>
-</dt>
-<dd>
-<p>
-        Called right before Phusion Passenger decallocates data structures for an application. Errors in the hook script are ignored.
-</p>
-<div class="paragraph"><p>Note that the <span class="monospaced">after_initialize_supergroup</span> hook may be called while this hook is still being executed, so make sure that operations don’t conflict with each other.</p></div>
-<div class="paragraph"><p>Extra environment variables: <span class="monospaced">PASSENGER_APP_ROOT</span>.</p></div>
-</dd>
-<dt class="hdlist1">
 <span class="monospaced">max_request_time_reached</span> (since 5.0.2, Enterprise-only)
 </dt>
 <dd>

data/doc/Users guide Nginx.txt

@@ -1084,7 +1084,7 @@ In each place, it may be specified at most once. The default value depends on <<
 [[PassengerMaxPoolSize]]
 ==== passenger_max_pool_size <integer> ====
 The maximum number of <<application_process,application processes>> that may
-simultanously exist. A larger number results in higher memory usage,
+simultaneously exist. A larger number results in higher memory usage,
 but improves the ability to handle concurrent HTTP requests.
 
 The optimal value depends on your system's hardware and your workload. You can learn more at the Phusion article link:http://blog.phusion.nl/2013/03/12/tuning-phusion-passengers-concurrency-settings/[Tuning Phusion Passenger's concurrency settings].
@@ -1139,7 +1139,7 @@ be spawned in the background. After 10 seconds, when the idle timeout has
 been reached, these 3 application processes will not be cleaned up.
 
 Now suppose that there's a sudden spike of traffic, and 100 users visit 'foobar.com'
-simultanously. Phusion Passenger will start 12 more application processes. After the idle
+simultaneously. Phusion Passenger will start 12 more application processes. After the idle
 timeout of 10 seconds have passed, Phusion Passenger will clean up 12 application
 processes, keeping 3 processes around.
 

data/doc/users_guide_snippets/tips.txt

@@ -554,15 +554,6 @@ Extra environment variables:
 +
 This hook does not block because it's always run in an extra background thread. Errors in the hook script are ignored.
 
-`after_initialize_supergroup`::
-	Called right after Phusion Passenger has allocated data structures for an application, and is about to spawn a process for the first time for this application. Errors in the hook script are ignored. Extra environment variables: `PASSENGER_APP_ROOT`.
-`before_destroy_supergroup`::
-	Called right before Phusion Passenger decallocates data structures for an application. Errors in the hook script are ignored.
-+
-Note that the `after_initialize_supergroup` hook may be called while this hook is still being executed, so make sure that operations don't conflict with each other.
-+
-Extra environment variables: `PASSENGER_APP_ROOT`.
-
 `max_request_time_reached` (since 5.0.2, Enterprise-only)::
 	Called when a <<PassengerMaxRequestTime,max request time limit>> has been reached. Please note that as soon as this hook has finished executing, the application process will be killed with SIGKILL. So if you want to perform any diagnostics on the process in question (e.g. with strace, gdb, etc), please do not exit your hook script until you've obtained all the diagnostics you want.
 +

data/ext/common/ApplicationPool2/ApiKey.h

@@ -0,0 +1,158 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2015 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_APPLICATION_POOL2_API_KEY_H_
+#define _PASSENGER_APPLICATION_POOL2_API_KEY_H_
+
+#include <oxt/macros.hpp>
+#include <string>
+#include <cstring>
+#include <Exceptions.h>
+#include <StaticString.h>
+#include <Utils/StrIntUtils.h>
+
+namespace Passenger {
+namespace ApplicationPool2 {
+
+using namespace std;
+
+
+/**
+ * An API key is a string that determines which app a particular ApiServer
+ * client may access. It is automatically generated by a Group and passed to
+ * all application processes that it spawns. Application processes can then
+ * use that API key to perform API calls by connecting to the ApiServer.
+ *
+ * An API key is transient, not persistent. That is, it is only valid during
+ * the life time of a Group. It is not pre-generated by the user.
+ *
+ * An API key is unique per Pool, so may be used to uniquely identify a Group
+ * object within a Pool.
+ *
+ * An API key may be null, which means that it's not given.
+ *
+ * There also exists a special "super" API key. This API key doesn't have a
+ * particular value, so it cannot be used to uniquely identify a Group. Instead,
+ * its purpose is to signal that the client is authorized to access all apps in
+ * the Pool. Super API keys are associated with ApiServer clients that are
+ * authenticated with one of the API accounts.
+ */
+class ApiKey {
+public:
+	static const unsigned int SIZE = 16;
+
+private:
+	/*
+	 * On x86_64 the value is as big as a StaticString,
+	 * so might as well directly embed the data instead.
+	 */
+	char value[SIZE];
+
+	OXT_FORCE_INLINE
+	bool validateNonSuperKeyValueChar(const char ch) const {
+		return (ch >= 'a' && ch <= 'z')
+			|| (ch >= 'A' && ch <= 'Z')
+			|| (ch >= '0' && ch <= '9');
+	}
+
+	void validateNonSuperKeyValue(const StaticString &value) const {
+		const char *data = value.data();
+		const char *end  = value.data() + value.size();
+		while (data < end) {
+			if (!validateNonSuperKeyValueChar(*data)) {
+				throw ArgumentException("API keys may only contain the characters a-z, A-Z and 0-9.");
+			}
+			data++;
+		}
+	}
+
+public:
+	ApiKey() {
+		value[0] = '\0';
+	}
+
+	ApiKey(const StaticString &other) {
+		if (other.size() != SIZE) {
+			throw ArgumentException("API keys must be exactly "
+				+ Passenger::toString(SIZE) + " characters in length");
+		}
+		validateNonSuperKeyValue(other);
+		memcpy(value, other.data(), SIZE);
+	}
+
+	ApiKey(const ApiKey &other) {
+		memcpy(value, other.value, SIZE);
+	}
+
+	static ApiKey makeSuper() {
+		ApiKey key;
+		key.value[0] = '!';
+		assert(key.isSuper());
+		return key;
+	}
+
+	bool isNull() const {
+		return value[0] == '\0';
+	}
+
+	bool isSuper() const {
+		return value[0] == '!';
+	}
+
+	bool constantTimeCompare(const StaticString &other) const {
+		return Passenger::constantTimeCompare(toStaticString(), other);
+	}
+
+	bool constantTimeCompare(const ApiKey &other) const {
+		return Passenger::constantTimeCompare(toStaticString(), other.toStaticString());
+	}
+
+	string toString() const {
+		return toStaticString().toString();
+	}
+
+	StaticString toStaticString() const {
+		if (value[0] == '\0') {
+			return StaticString();
+		} else if (value[0] == '!') {
+			return StaticString("superkey");
+		} else {
+			return StaticString(value, SIZE);
+		}
+	}
+
+	bool operator==(const StaticString &other) const {
+		return other.size() == SIZE && memcmp(value, other.data(), SIZE) == 0;
+	}
+
+	bool operator==(const ApiKey &other) const {
+		return memcmp(value, other.value, SIZE) == 0;
+	}
+};
+
+
+} // namespace ApplicationPool2
+} // namespace Passenger
+
+#endif /* _PASSENGER_APPLICATION_POOL2_API_KEY_H_ */

data/ext/common/ApplicationPool2/BasicGroupInfo.h

@@ -0,0 +1,81 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2014-2015 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_APPLICATION_POOL2_BASIC_GROUP_INFO_H_
+#define _PASSENGER_APPLICATION_POOL2_BASIC_GROUP_INFO_H_
+
+#include <string>
+#include <cstddef>
+#include <ApplicationPool2/Context.h>
+#include <ApplicationPool2/ApiKey.h>
+
+namespace Passenger {
+namespace ApplicationPool2 {
+
+
+class Group;
+
+/**
+ * Contains basic Group information. This information is set during the
+ * initialization of a Group and never changed afterwards. This struct
+ * encapsulates that information. It is contained inside `Group` as a const
+ * object. Because of the immutable nature of the information, multithreaded
+ * access is safe.
+ *
+ * Since Process and Session sometimes need to look up this basic group
+ * information, this struct also serves to ensure that Process and Session do
+ * not have a direct dependency on Group, but on GroupImmutableInfo instead.
+ */
+class BasicGroupInfo {
+public:
+	Context *context;
+
+	/**
+	 * A back pointer to the Group that this BasicGroupInfo is contained in.
+	 * May be NULL in unit tests.
+	 */
+	Group *group;
+
+	/**
+	 * This name uniquely identifies this Group within its Pool. It can
+	 * also be used as the display name.
+	 */
+	std::string name;
+
+	/**
+	 * This Group's unique API key.
+	 */
+	ApiKey apiKey;
+
+	BasicGroupInfo()
+		: context(NULL),
+		  group(NULL)
+		{ }
+};
+
+
+} // namespace ApplicationPool2
+} // namespace Passenger
+
+#endif /* _PASSENGER_APPLICATION_POOL2_BASIC_GROUP_INFO_H_ */

data/ext/common/ApplicationPool2/BasicProcessInfo.h

@@ -0,0 +1,106 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2014-2015 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_APPLICATION_POOL2_BASIC_PROCESS_INFO_H_
+#define _PASSENGER_APPLICATION_POOL2_BASIC_PROCESS_INFO_H_
+
+#include <sys/types.h>
+#include <cstring>
+
+#include <StaticString.h>
+#include <Exceptions.h>
+#include <ApplicationPool2/BasicGroupInfo.h>
+#include <Utils/json.h>
+#include <Utils/JsonUtils.h>
+
+namespace Passenger {
+namespace ApplicationPool2 {
+
+using namespace std;
+
+
+class Process;
+
+/**
+ * Contains a subset of the information in Process. This subset consists only
+ * of information that is:
+ *
+ *  1. ...read-only and set during Process constructions.
+ *  2. ...needed by Session.
+ *
+ * This class is contained inside `Process` as a const object. Because the
+ * information is read-only, and because Process outlives all related Session
+ * objects, Session can access it without grabbing the lock on Process.
+ *
+ * This class also serves to ensure that Session does not have a direct
+ * dependency on Process.
+ */
+class BasicProcessInfo {
+public:
+	static const unsigned int GUPID_MAX_SIZE = 20;
+
+	/** The Process that this BasicProcessInfo is contained in. */
+	Process *process;
+
+	/** The basic information of the Group that the associated Process is contained in. */
+	const BasicGroupInfo *groupInfo;
+
+	/**
+	 * The operating system process ID.
+	 */
+	pid_t pid;
+
+	/**
+	 * An ID that uniquely identifies this Process in the Group, for
+	 * use in implementing sticky sessions. Set by Group::attach().
+	 */
+	unsigned int stickySessionId;
+
+	/**
+	 * UUID for this process, randomly generated and extremely unlikely to ever
+	 * appear again in this universe.
+	 */
+	char gupid[GUPID_MAX_SIZE];
+	unsigned int gupidSize;
+
+
+	BasicProcessInfo(Process *_process, const BasicGroupInfo *_groupInfo,
+		const Json::Value &json)
+		: process(_process),
+		  groupInfo(_groupInfo),
+		  pid(getJsonIntField(json, "pid"))
+		  //stickySessionId(getJsonUintField(json, "sticky_session_id", 0))
+	{
+		StaticString gupid = getJsonStaticStringField(json, "gupid");
+		assert(gupid.size() <= GUPID_MAX_SIZE);
+		memcpy(this->gupid, gupid.data(), gupid.size());
+		gupidSize = gupid.size();
+	}
+};
+
+
+} // namespace ApplicationPool2
+} // namespace Passenger
+
+#endif /* _PASSENGER_APPLICATION_POOL2_BASIC_PROCESS_INFO_H_ */