#include "sbuf/SBuf.h"
#include "typedefs.h"

Include dependency graph for tools.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef void(*	ObjPackMethod) (void obj, Packable p)

typedef void	SIGHDLR(int sig)
	callback type for signal handlers More...

typedef int	PidStatus

Functions
void	parseEtcHosts (void)

int	getMyPort (void)

void	setUmask (mode_t mask)

void	strwordquote (MemBuf mb, const char str)

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

const char *	getMyHostname (void)

const char *	uniqueHostname (void)

void	death (int sig)

void	sigusr2_handle (int sig)

void	sig_child (int sig)

void	sig_shutdown (int sig)
	handles shutdown notifications from kids More...

void	leave_suid (void)

void	enter_suid (void)

void	no_suid (void)

void	setMaxFD (void)

void	setSystemLimits (void)

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

void	keepCapabilities (void)

void	BroadcastSignalIfAny (int &sig)

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

bool	IamPrimaryProcess ()

bool	IamCoordinatorProcess ()
	whether the current process coordinates worker processes More...

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

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

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

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

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

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

void	debug_trap (const char *)

void	logsFlush (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)

void	releaseServerSockets (void)

void	PrintRusage (void)

void	dumpMallocStats (void)

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

pid_t	WaitForAnyPid (PidStatus &status, int flags)

Variables
int	DebugSignal

SBuf	service_name

Typedef Documentation

◆ ObjPackMethod

typedef void(* ObjPackMethod) (void *obj, Packable *p)

Definition at line 33 of file tools.h.

◆ PidStatus

typedef int PidStatus

Definition at line 91 of file tools.h.

◆ SIGHDLR

typedef void SIGHDLR(int sig)

Definition at line 39 of file tools.h.

Function Documentation

◆ BroadcastSignalIfAny()

void BroadcastSignalIfAny ( int & sig )

Definition at line 418 of file tools.cc.

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

Referenced by masterCheckAndBroadcastSignals().

◆ death()

void death ( int sig )

Definition at line 345 of file tools.cc.

References SquidConfig::adminEmail, Config, DBG_CRITICAL, dead_msg(), debug_log, debugs, 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 458 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 938 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 166 of file tools.cc.

References debug_log, and Math::intPercent().

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

◆ enter_suid()

void enter_suid ( void )

Definition at line 623 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 467 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, and xstrerr().

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

◆ getMyPort()

int getMyPort ( void )

Definition at line 1041 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 702 of file tools.cc.

References pkCoordinator, and TheProcessKind.

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

◆ IamDiskProcess()

bool IamDiskProcess ( )

Definition at line 684 of file tools.cc.

References pkDisker, and TheProcessKind.

Referenced by IpcIoFile::close(), Rock::SwapDir::create(), Rock::SwapDir::doReportStat(), IpcIoFile::HandleMessagesAtStart(), IpcIoFile::HandleNotification(), Rock::Rebuild::IsResponsible(), IpcIoFile::open(), ProcessRoles(), and SquidMain().

◆ IamMasterProcess()

bool IamMasterProcess ( )

Definition at line 668 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 708 of file tools.cc.

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

Referenced by Mgr::InfoAction::dump(), mainInitialize(), mainReconfigureFinish(), serverConnectionsClose(), serverConnectionsOpen(), and SquidMain().

◆ IamWorkerProcess()

bool IamWorkerProcess ( )

◆ InDaemonMode()

bool InDaemonMode ( )

Definition at line 690 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 1122 of file tools.cc.

References Ip::Interceptor.

Referenced by setEffectiveUser().

◆ 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 559 of file tools.cc.

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