OwlCyberSecurity - MANAGER

Edit File: BasicProcessInfo.h

/*
 *  Phusion Passenger - https://www.phusionpassenger.com/
 *  Copyright (c) 2014-2018 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_APPLICATION_POOL2_BASIC_PROCESS_INFO_H_
#define _PASSENGER_APPLICATION_POOL2_BASIC_PROCESS_INFO_H_

#include <sys/types.h>
#include <cstring>

#include <jsoncpp/json.h>

#include <StaticString.h>
#include <Exceptions.h>
#include <JsonTools/JsonUtils.h>
#include <Core/ApplicationPool/BasicGroupInfo.h>
#include <Core/SpawningKit/Result.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"))
		  // We initialize this in Process::initializeStickySessionId(),
		  // called from Group::attach().
		  // We should probably some day refactor this. The reason we do
		  // it the way we do right now is because some day we want to be able
		  // to attach external processes, so the best place to initialize this
		  // information is in Group::attach().
		  //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();
	}

BasicProcessInfo(Process *_process, const BasicGroupInfo *_groupInfo,
		const SpawningKit::Result &skResult)
		: process(_process),
		  groupInfo(_groupInfo),
		  pid(skResult.pid)
		  // See above comment about the 'stickySessionId' field
	{
		assert(skResult.gupid.size() <= GUPID_MAX_SIZE);
		memcpy(gupid, skResult.gupid.data(), skResult.gupid.size());
		gupidSize = skResult.gupid.size();
	}
};

} // namespace ApplicationPool2
} // namespace Passenger

#endif /* _PASSENGER_APPLICATION_POOL2_BASIC_PROCESS_INFO_H_ */