#include "squid.h"
#include "anyp/PortCfg.h"
#include "base/Subscription.h"
#include "client_side.h"
#include "compat/unistd.h"
#include "fatal.h"
#include "fde.h"
#include "fqdncache.h"
#include "fs_io.h"
#include "htcp.h"
#include "http/Stream.h"
#include "ICP.h"
#include "ip/Intercept.h"
#include "ip/QosConfig.h"
#include "ipc/Coordinator.h"
#include "ipc/Kids.h"
#include "ipcache.h"
#include "MemBuf.h"
#include "sbuf/Stream.h"
#include "SquidConfig.h"
#include "SquidMath.h"
#include "store/Disks.h"
#include "tools.h"
#include "wordlist.h"
#include <cerrno>

Include dependency graph for tools.cc:

Macros
#define	DEAD_MSG "\The Squid Cache (version %s) died.\n\\n\You've encountered a fatal error in the Squid Cache version %s.\n\If a core file was created (possibly in the swap directory),\n\please execute 'gdb squid core' or 'dbx squid core', then type 'where',\n\and report the trace back to squid-bugs@lists.squid-cache.org.\n\\n\Thanks!\n"

#define	HAVE_GETPAGESIZE 0

Functions
static void	mail_warranty (void)

static void	restoreCapabilities (bool keep)

void	releaseServerSockets (void)

static char *	dead_msg (void)

void	dumpMallocStats (void)

void	squid_getrusage (struct rusage *r)

double	rusage_cputime (struct rusage *r)

int	rusage_maxrss (struct rusage *r)

int	rusage_pagefaults (struct rusage *r)

static void	makeTraceable ()

static void	setTraceability ()

void	PrintRusage (void)

void	death (int sig)

void	BroadcastSignalIfAny (int &sig)

void	sigusr2_handle (int sig)

void	debug_trap (const char *message)

const char *	getMyHostname (void)

const char *	uniqueHostname (void)

void	leave_suid (void)

void	enter_suid (void)

void	no_suid (void)

bool	IamMasterProcess ()
	whether the current process is the parent of all other Squid processes

bool	IamWorkerProcess ()
	whether the current process handles HTTP transactions and such

bool	IamDiskProcess ()
	whether the current process is dedicated to managing a cache_dir

bool	InDaemonMode ()
	Whether we are running in daemon mode.

bool	UsingSmp ()
	Whether there should be more than one worker process running.

bool	IamCoordinatorProcess ()
	whether the current process coordinates worker processes

bool	IamPrimaryProcess ()

int	NumberOfKids ()
	number of Kid processes as defined in src/ipc/Kid.h

SBuf	ProcessRoles ()
	a string describing this process roles such as worker or coordinator

void	setMaxFD (void)

void	setSystemLimits (void)

void	squid_signal (int sig, SIGHDLR *func, int flags)

void	logsFlush (void)

void	debugObj (int section, int level, const char label, void obj, ObjPackMethod pm)

void	parseEtcHosts (void)

int	getMyPort (void)

void	setUmask (mode_t mask)

void	strwordquote (MemBuf mb, const char str)

void	keepCapabilities (void)

pid_t	WaitForOnePid (pid_t pid, PidStatus &status, int flags)

Variables
int	DebugSignal = -1

SBuf	service_name (APP_SHORTNAME)

static char	tmp_error_buf [32768]

Macro Definition Documentation

◆ DEAD_MSG

#define DEAD_MSG "\The Squid Cache (version %s) died.\n\\n\You've encountered a fatal error in the Squid Cache version %s.\n\If a core file was created (possibly in the swap directory),\n\please execute 'gdb squid core' or 'dbx squid core', then type 'where',\n\and report the trace back to squid-bugs@lists.squid-cache.org.\n\\n\Thanks!\n"

Definition at line 62 of file tools.cc.

◆ HAVE_GETPAGESIZE

#define HAVE_GETPAGESIZE 0

Definition at line 249 of file tools.cc.

Function Documentation

◆ BroadcastSignalIfAny()

void BroadcastSignalIfAny ( int & sig )

Definition at line 411 of file tools.cc.

References Kids::count(), Kids::get(), IamMasterProcess(), and TheKids.

Referenced by masterCheckAndBroadcastSignals().

◆ dead_msg()

static char * dead_msg ( void )

static

Definition at line 108 of file tools.cc.

References DEAD_MSG, LOCAL_ARRAY, and version_string.

Referenced by death(), and mail_warranty().

◆ death()

void death ( int sig )

Definition at line 338 of file tools.cc.

References SquidConfig::adminEmail, Config, DBG_CRITICAL, dead_msg(), debugs, DebugStream(), dumpMallocStats(), ForceAlert(), mail_warranty(), Debug::PrepareToDie(), PrintRusage(), releaseServerSockets(), shutting_down, squid_curtime, SQUID_RELEASE_TIME, and storeDirWriteCleanLogs().

Referenced by mainInitialize().

◆ debug_trap()

void debug_trap ( const char * message )

Definition at line 451 of file tools.cc.

References DBG_CRITICAL, debugs, fatal_dump(), and opt_catch_signals.

Referenced by EventScheduler::cancel(), clientdbEstablished(), clientdbUpdate(), neighborsUdpAck(), netdbHashDelete(), and unlinkdUnlink().

◆ debugObj()

void debugObj	(	int	section,
		int	level,
		const char *	label,
		void *	obj,
		ObjPackMethod	pm
	)

Definition at line 931 of file tools.cc.

References assert, MemBuf::buf, MemBuf::clean(), debugs, and MemBuf::init().

Referenced by clientInterpretRequestHeaders(), and internalStart().

◆ dumpMallocStats()

void dumpMallocStats ( void )

Definition at line 167 of file tools.cc.

References DebugStream(), and Math::intPercent().

Referenced by death(), fatal_common(), and SquidShutdown().

◆ enter_suid()

void enter_suid ( void )

Definition at line 616 of file tools.cc.

References debugs, setTraceability(), and xstrerr().

Referenced by comm_set_transparent(), htcpOpenPorts(), icpOpenPorts(), mainReconfigureFinish(), File::open(), Ipc::Coordinator::openListenSocket(), Ip::Intercept::ProbeForTproxy(), RemoveInstance(), squid_getrusage(), SquidMain(), Ipc::StartListening(), StartUsingConfig(), and watch_child().

◆ getMyHostname()

const char * getMyHostname ( void )

Definition at line 460 of file tools.cc.

References Config, DBG_CRITICAL, DBG_IMPORTANT, debugs, Ip::Address::FreeAddr(), Ip::Address::getAddrInfo(), HttpPortList, Ip::Address::isAnyAddr(), LOCAL_ARRAY, SQUIDHOSTNAMELEN, SquidConfig::visibleHostname, xgethostname(), and xstrerr().

Referenced by ErrorState::compileLegacyCode(), configDoConfigure(), ErrorState::Dump(), idnsParseResolvConf(), internalHostname(), internalLocalUri(), neighbors_init(), uniqueHostname(), and urnHandleReply().

◆ getMyPort()

int getMyPort ( void )

Definition at line 1034 of file tools.cc.

References DBG_CRITICAL, debugs, FtpPortList, and HttpPortList.

Referenced by ClientHttpRequest::checkForInternalAccess(), ErrorState::compileLegacyCode(), and internalLocalUri().

◆ IamCoordinatorProcess()

bool IamCoordinatorProcess ( )

Definition at line 695 of file tools.cc.

References pkCoordinator, and TheProcessKind.

Referenced by IamPrimaryProcess(), ProcessRoles(), and SquidMain().

◆ IamDiskProcess()

bool IamDiskProcess ( )

Definition at line 677 of file tools.cc.

References pkDisker, and TheProcessKind.

Referenced by ProcessRoles().

◆ IamMasterProcess()

bool IamMasterProcess ( )

Definition at line 661 of file tools.cc.

References KidIdentifier.

Referenced by BroadcastSignalIfAny(), ProcessRoles(), SquidMain(), StartUsingConfig(), and Ipc::Mem::RegisteredRunner::useConfig().

◆ IamPrimaryProcess()

bool IamPrimaryProcess ( )

whether the current process is dedicated to doing things that only a single process should do, such as PID file maintenance and WCCP

Definition at line 701 of file tools.cc.

References Config, IamCoordinatorProcess(), IamWorkerProcess(), NumberOfKids(), opt_no_daemon, and SquidConfig::workers.

Referenced by Mgr::InfoAction::dump(), mainReconfigureFinish(), SquidMain(), wccp2ConnectionClose(), wccp2ConnectionOpen(), wccp2Init(), wccpConnectionClose(), wccpConnectionOpen(), and wccpInit().

◆ IamWorkerProcess()

bool IamWorkerProcess ( )

Definition at line 667 of file tools.cc.

References Config, opt_no_daemon, pkWorker, TheProcessKind, and SquidConfig::workers.

Referenced by IamPrimaryProcess(), and ProcessRoles().

◆ InDaemonMode()

bool InDaemonMode ( )

Definition at line 683 of file tools.cc.

References Config, opt_no_daemon, and SquidConfig::workers.

Referenced by Store::Disks::configure(), CpuAffinityCheck(), CpuAffinityInit(), Rock::SwapDir::needsDiskStrand(), NumberOfKids(), SquidMain(), StartUsingConfig(), Ipc::Mem::RegisteredRunner::useConfig(), and UsingSmp().

◆ keepCapabilities()

void keepCapabilities ( void )

Definition at line 1115 of file tools.cc.

◆ leave_suid()

void leave_suid ( void )

leave a privileged section. (Give up any privilegies) Routines that need privilegies can rap themselves in enter_suid() and leave_suid() To give upp all posibilites to gain privilegies use no_suid()

Definition at line 552 of file tools.cc.

References Config, Config2, DBG_CRITICAL, debugs, SquidConfig::effectiveGroup, SquidConfig2::effectiveGroupID, SquidConfig::effectiveUser, SquidConfig2::effectiveUserID, fatalf(), initgroups(), restoreCapabilities(), setTraceability(), and xstrerr().

Referenced by comm_set_transparent(), fatal(), fatal_dump(), htcpOpenPorts(), icpOpenPorts(), no_suid(), File::open(), Ipc::Coordinator::openListenSocket(), Ip::Intercept::ProbeForTproxy(), RemoveInstance(), setEffectiveUser(), squid_getrusage(), SquidMain(), Ipc::StartListening(), StartUsingConfig(), and watch_child().

◆ logsFlush()

void logsFlush ( void )

Definition at line 924 of file tools.cc.

References DebugStream().

◆ mail_warranty()

static void mail_warranty ( void )

static

Definition at line 116 of file tools.cc.

References SquidConfig::adminEmail, APP_SHORTNAME, Config, dead_msg(), SquidConfig::EmailFrom, SquidConfig::EmailProgram, NULL, tempnam(), uniqueHostname(), and xfree.

Referenced by death().

◆ makeTraceable()

static void makeTraceable ( )

static

Make the process traceable if possible. Call setTraceability() instead! Traceable processes may support attachment via ptrace(2) or ktrace(2), debugging sysctls, hwpmc(4), dtrace(1) and core dumping.

Definition at line 281 of file tools.cc.

References debugs, Here, ToSBuf(), and xstrerr().

Referenced by setTraceability().