[thirdparty/squid.git] / src / ipc / Kid.h

/*
 */

#ifndef SQUID_IPC_KID_H
#define SQUID_IPC_KID_H

#include "SquidString.h"

/// Squid child, including current forked process info and
/// info persistent across restarts
class Kid
{
public:
#if _SQUID_NEXT_
    typedef union wait status_type;
#else
    typedef int status_type;
#endif

    /// keep restarting until the number of bad failures exceed this limit
    enum { badFailureLimit = 4 };

    /// slower start failures are not "frequent enough" to be counted as "bad"
    enum { fastFailureTimeLimit = 10 }; // seconds

public:
    Kid();

    Kid(const String& kid_name);

    /// called when this kid got started, records PID
    void start(pid_t cpid);

    /// called when kid terminates, sets exiting status
    void stop(status_type exitStatus);

    /// returns true if tracking of kid is stopped
    bool running() const;

    /// returns true if master should restart this kid
    bool shouldRestart() const;

    /// returns current pid for a running kid and last pid for a stopped kid
    pid_t getPid() const;

    /// whether the failures are "repeated and frequent"
    bool hopeless() const;

    /// returns true if the process terminated normally
    bool calledExit() const;

    /// returns the exit status of the process
    int exitStatus() const;

    /// whether the process exited with a given exit status code
    bool calledExit(int code) const;

    /// whether the process exited with code 0
    bool exitedHappy() const;

    /// returns true if the kid was terminated by a signal
    bool signaled() const;

    /// returns the number of the signal that caused the kid to terminate
    int termSignal() const;

    /// whether the process was terminated by a given signal
    bool signaled(int sgnl) const;

    /// returns kid name
    const String& name() const;

private:
    // Information preserved across restarts
    String theName; ///< process name
    int badFailures; ///< number of "repeated frequent" failures

    // Information specific to a running or stopped kid
    pid_t  pid; ///< current (for a running kid) or last (for stopped kid) PID
    time_t startTime; ///< last start time
    bool   isRunning; ///< whether the kid is assumed to be alive
    status_type status; ///< exit status of a stopped kid
};

// TODO: processes may not be kids; is there a better place to put this?

/// process kinds
typedef enum {
    pkOther  = 0, ///< we do not know or do not care
    pkCoordinator = 1, ///< manages all other kids
    pkWorker = 2, ///< general-purpose worker bee
    pkDisker = 4, ///< cache_dir manager
    pkHelper = 8  ///< general-purpose helper child
} ProcessKind;

/// ProcessKind for the current process
extern int TheProcessKind;

#endif /* SQUID_IPC_KID_H */
Commit	Line	Data
40daaeb8	1	/*
40daaeb8 AR	2	*/
	3
	4	#ifndef SQUID_IPC_KID_H
	5	#define SQUID_IPC_KID_H
	6
	7	#include "SquidString.h"
	8
40daaeb8 AR	9	/// Squid child, including current forked process info and
	10	/// info persistent across restarts
	11	class Kid
	12	{
	13	public:
1191b93b	14	#if _SQUID_NEXT_
40daaeb8 AR	15	typedef union wait status_type;
	16	#else
	17	typedef int status_type;
	18	#endif
	19
	20	/// keep restarting until the number of bad failures exceed this limit
	21	enum { badFailureLimit = 4 };
	22
	23	/// slower start failures are not "frequent enough" to be counted as "bad"
	24	enum { fastFailureTimeLimit = 10 }; // seconds
	25
	26	public:
	27	Kid();
	28
	29	Kid(const String& kid_name);
	30
	31	/// called when this kid got started, records PID
	32	void start(pid_t cpid);
	33
	34	/// called when kid terminates, sets exiting status
	35	void stop(status_type exitStatus);
	36
	37	/// returns true if tracking of kid is stopped
	38	bool running() const;
	39
ca4b9ee6 DK	40	/// returns true if master should restart this kid
	41	bool shouldRestart() const;
	42
40daaeb8 AR	43	/// returns current pid for a running kid and last pid for a stopped kid
	44	pid_t getPid() const;
	45
	46	/// whether the failures are "repeated and frequent"
	47	bool hopeless() const;
	48
	49	/// returns true if the process terminated normally
	50	bool calledExit() const;
	51
	52	/// returns the exit status of the process
	53	int exitStatus() const;
	54
	55	/// whether the process exited with a given exit status code
	56	bool calledExit(int code) const;
	57
	58	/// whether the process exited with code 0
	59	bool exitedHappy() const;
	60
	61	/// returns true if the kid was terminated by a signal
	62	bool signaled() const;
	63
	64	/// returns the number of the signal that caused the kid to terminate
	65	int termSignal() const;
	66
	67	/// whether the process was terminated by a given signal
	68	bool signaled(int sgnl) const;
	69
	70	/// returns kid name
	71	const String& name() const;
	72
	73	private:
	74	// Information preserved across restarts
	75	String theName; ///< process name
	76	int badFailures; ///< number of "repeated frequent" failures
	77
	78	// Information specific to a running or stopped kid
	79	pid_t pid; ///< current (for a running kid) or last (for stopped kid) PID
	80	time_t startTime; ///< last start time
	81	bool isRunning; ///< whether the kid is assumed to be alive
	82	status_type status; ///< exit status of a stopped kid
	83	};
	84
095ec2b1 AR	85	// TODO: processes may not be kids; is there a better place to put this?
095ec2b1 AR	86
9199139f	87	/// process kinds
095ec2b1 AR	88	typedef enum {
	89	pkOther = 0, ///< we do not know or do not care
	90	pkCoordinator = 1, ///< manages all other kids
	91	pkWorker = 2, ///< general-purpose worker bee
	92	pkDisker = 4, ///< cache_dir manager
ed1a1519	93	pkHelper = 8 ///< general-purpose helper child
095ec2b1 AR	94	} ProcessKind;
	95
	96	/// ProcessKind for the current process
	97	extern int TheProcessKind;
	98
40daaeb8	99	#endif /* SQUID_IPC_KID_H */