Kid.cc
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2018 The Squid Software Foundation and contributors
3  *
4  * Squid software is distributed under GPLv2+ license and includes
5  * contributions from numerous individuals and organizations.
6  * Please see the COPYING and CONTRIBUTORS files for details.
7  */
8 
9 /* DEBUG: section 54 Interprocess Communication */
10 
11 #include "squid.h"
12 #include "globals.h"
13 #include "ipc/Kid.h"
14 #include "SquidConfig.h"
15 
16 #include <ctime>
17 #if HAVE_SYS_WAIT_H
18 #include <sys/wait.h>
19 #endif
20 
22 
24 {
25 }
26 
27 Kid::Kid(const char *aRole, const int anId):
28  processRole(aRole),
29  processId(anId)
30 {
31 }
32 
34 void Kid::start(pid_t cpid)
35 {
36  assert(!running());
37  assert(cpid > 0);
38 
39  isRunning = true;
40  stopTime = 0;
41  pid = cpid;
43 }
44 
46 void
47 Kid::stop(PidStatus const theExitStatus)
48 {
49  assert(running());
50  assert(startTime != 0);
51 
52  isRunning = false;
54  status = theExitStatus;
55 
57  ++badFailures;
58  else
59  badFailures = 0; // the failures are not "frequent" [any more]
60 
61  reportStopped(); // after all state changes
62 }
63 
65 void
67 {
68  if (calledExit()) {
69  syslog(LOG_NOTICE,
70  "Squid Parent: %s process %d exited with status %d",
71  gist().c_str(), pid, exitStatus());
72  } else if (signaled()) {
73  syslog(LOG_NOTICE,
74  "Squid Parent: %s process %d exited due to signal %d with status %d",
75  gist().c_str(), pid, termSignal(), exitStatus());
76  } else {
77  syslog(LOG_NOTICE, "Squid Parent: %s process %d exited",
78  gist().c_str(), pid);
79  }
80 
82  syslog(LOG_NOTICE, "Squid Parent: %s process %d will not be restarted for %ld "
83  "seconds due to repeated, frequent failures",
84  gist().c_str(),
85  pid,
86  static_cast<long int>(Config.hopelessKidRevivalDelay));
87  }
88 }
89 
91 bool Kid::running() const
92 {
93  return isRunning;
94 }
95 
97 bool Kid::shouldRestart() const
98 {
99  return !(running() ||
100  exitedHappy() ||
101  hopeless() ||
102  shutting_down ||
103  signaled(SIGKILL) || // squid -k kill
104  signaled(SIGINT) || // unexpected forced shutdown
105  signaled(SIGTERM)); // unexpected forced shutdown
106 }
107 
109 pid_t Kid::getPid() const
110 {
111  assert(pid > 0);
112  return pid;
113 }
114 
116 bool Kid::hopeless() const
117 {
118  return badFailures > badFailureLimit;
119 }
120 
122 bool Kid::calledExit() const
123 {
124  return (pid > 0) && !running() && WIFEXITED(status);
125 }
126 
128 int Kid::exitStatus() const
129 {
130  return WEXITSTATUS(status);
131 }
132 
134 bool Kid::calledExit(int code) const
135 {
136  return calledExit() && (exitStatus() == code);
137 }
138 
140 bool Kid::exitedHappy() const
141 {
142  return calledExit(0);
143 }
144 
146 bool Kid::signaled() const
147 {
148  return (pid > 0) && !running() && WIFSIGNALED(status);
149 }
150 
152 int Kid::termSignal() const
153 {
154  return WTERMSIG(status);
155 }
156 
158 bool Kid::signaled(int sgnl) const
159 {
160  return signaled() && (termSignal() == sgnl);
161 }
162 
165 {
166  SBuf name("(");
167  name.append(gist());
168  name.append(")");
169  return name;
170 }
171 
173 {
174  SBuf name(processRole);
175  name.appendf("-%d", processId);
176  return name;
177 }
178 
179 time_t
181 {
182  return squid_curtime > stopTime ? squid_curtime - stopTime : 0;
183 }
184 
bool calledExit() const
returns true if the process terminated normally
Definition: Kid.cc:122
int PidStatus
Definition: tools.h:94
#define assert(EX)
Definition: assert.h:17
SBuf & appendf(const char *fmt,...)
Definition: SBuf.cc:239
void reportStopped() const
describes a recently stopped kid
Definition: Kid.cc:66
void stop(PidStatus const exitStatus)
called when kid terminates, sets exiting status
Definition: Kid.cc:47
Definition: SBuf.h:86
pid_t pid
current (for a running kid) or last (for stopped kid) PID
Definition: Kid.h:92
SBuf & append(const SBuf &S)
Definition: SBuf.cc:195
SBuf processRole
Definition: Kid.h:87
PidStatus status
exit status of a stopped kid
Definition: Kid.h:96
time_t squid_curtime
Definition: stub_time.cc:17
bool hopeless() const
whether the failures are "repeated and frequent"
Definition: Kid.cc:116
int termSignal() const
returns the number of the signal that caused the kid to terminate
Definition: Kid.cc:152
int shutting_down
Definition: testAddress.cc:36
pid_t getPid() const
returns current pid for a running kid and last pid for a stopped kid
Definition: Kid.cc:109
void start(pid_t cpid)
called when this kid got started, records PID
Definition: Kid.cc:34
bool running() const
returns true if tracking of kid is stopped
Definition: Kid.cc:91
unsigned char code
Definition: html_quote.c:20
time_t deathDuration() const
Definition: Kid.cc:180
we do not know or do not care
Definition: Kid.h:103
bool shouldRestart() const
returns true if master should restart this kid
Definition: Kid.cc:97
SBuf processName() const
returns kid name
Definition: Kid.cc:164
Kid()
Definition: Kid.cc:23
time_t hopelessKidRevivalDelay
hopeless_kid_revival_delay
Definition: SquidConfig.h:99
SBuf gist() const
Definition: Kid.cc:172
int TheProcessKind
ProcessKind for the current process.
Definition: Kid.cc:21
bool isRunning
whether the kid is assumed to be alive
Definition: Kid.h:95
bool signaled() const
returns true if the kid was terminated by a signal
Definition: Kid.cc:146
bool exitedHappy() const
whether the process exited with code 0
Definition: Kid.cc:140
time_t startTime
last start time
Definition: Kid.h:93
class SquidConfig Config
Definition: SquidConfig.cc:12
time_t stopTime
last termination time
Definition: Kid.h:94
int badFailures
number of "repeated frequent" failures
Definition: Kid.h:89
int processId
Definition: Kid.h:88
int exitStatus() const
returns the exit status of the process
Definition: Kid.cc:128

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors