[thirdparty/squid.git] / src / tools.h

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */

/* DEBUG: section 21    Misc Functions */

#ifndef SQUID_SRC_TOOLS_H
#define SQUID_SRC_TOOLS_H

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

class MemBuf;

extern int DebugSignal;

/// The Squid -n parameter service name.
/// Default is APP_SHORTNAME ('squid').
extern SBuf service_name;

void parseEtcHosts(void);
int getMyPort(void);
void setUmask(mode_t mask);
void strwordquote(MemBuf * mb, const char *str);

class Packable;

/* a common objPackInto interface; used by debugObj */
typedef void (*ObjPackMethod) (void *obj, Packable * p);

/* packs, then prints an object using debugs() */
void debugObj(int section, int level, const char *label, void *obj, ObjPackMethod pm);

/// callback type for signal handlers
typedef void SIGHDLR(int sig);

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
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);

/// whether the current process is the parent of all other Squid processes
bool IamMasterProcess();
/**
 *   whether the current process is dedicated to doing things that only
 *   a single process should do, such as PID file maintenance and WCCP
 */
bool IamPrimaryProcess();
/// whether the current process coordinates worker processes
bool IamCoordinatorProcess();
/// whether the current process handles HTTP transactions and such
bool IamWorkerProcess();
/// whether the current process is dedicated to managing a cache_dir
bool IamDiskProcess();
/// Whether we are running in daemon mode
bool InDaemonMode(); // try using specific Iam*() checks above first
/// Whether there should be more than one worker process running
bool UsingSmp(); // try using specific Iam*() checks above first
/// number of Kid processes as defined in src/ipc/Kid.h
int NumberOfKids();
/// a string describing this process roles such as worker or coordinator
SBuf ProcessRoles();

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);

typedef int PidStatus;

/**
 * Compatibility wrapper function for waitpid
 * \pid the pid of child process to wait for.
 * \param status the exit status returned by waitpid
 * \param flags WNOHANG or 0
 */
pid_t WaitForOnePid(pid_t pid, PidStatus &status, int flags);

/**
 * Wait for state changes in any of the kid processes.
 * Equivalent to waitpid(-1, ...) system call
 * \param status the exit status returned by waitpid
 * \param flags WNOHANG or 0
 */
inline pid_t WaitForAnyPid(PidStatus &status, int flags)
{
    return WaitForOnePid(-1, status, flags);
}

#if _SQUID_WINDOWS_ || _SQUID_MINGW_
/// xstrerror(errno) equivalent for Windows errors returned by GetLastError()
SBuf WindowsErrorMessage(DWORD errorId);
#endif // _SQUID_WINDOWS_ || _SQUID_MINGW_

#endif /* SQUID_SRC_TOOLS_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 1996-2025 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 21 Misc Functions */
	10
	11	#ifndef SQUID_SRC_TOOLS_H
	12	#define SQUID_SRC_TOOLS_H
	13
	14	#include "sbuf/SBuf.h"
	15	#include "typedefs.h"
	16
	17	class MemBuf;
	18
	19	extern int DebugSignal;
	20
	21	/// The Squid -n parameter service name.
	22	/// Default is APP_SHORTNAME ('squid').
	23	extern SBuf service_name;
	24
	25	void parseEtcHosts(void);
	26	int getMyPort(void);
	27	void setUmask(mode_t mask);
	28	void strwordquote(MemBuf * mb, const char *str);
	29
	30	class Packable;
	31
	32	/* a common objPackInto interface; used by debugObj */
	33	typedef void (ObjPackMethod) (void obj, Packable * p);
	34
	35	/* packs, then prints an object using debugs() */
	36	void debugObj(int section, int level, const char label, void obj, ObjPackMethod pm);
	37
	38	/// callback type for signal handlers
	39	typedef void SIGHDLR(int sig);
	40
	41	const char *getMyHostname(void);
	42	const char *uniqueHostname(void);
	43
	44	void death(int sig);
	45	void sigusr2_handle(int sig);
	46	void sig_child(int sig);
	47	void sig_shutdown(int sig); ///< handles shutdown notifications from kids
	48	void leave_suid(void);
	49	void enter_suid(void);
	50	void no_suid(void);
	51	void setMaxFD(void);
	52	void setSystemLimits(void);
	53	void squid_signal(int sig, SIGHDLR *, int flags);
	54	void keepCapabilities(void);
	55	void BroadcastSignalIfAny(int& sig);
	56
	57	/// whether the current process is the parent of all other Squid processes
	58	bool IamMasterProcess();
	59	/**
	60	* whether the current process is dedicated to doing things that only
	61	* a single process should do, such as PID file maintenance and WCCP
	62	*/
	63	bool IamPrimaryProcess();
	64	/// whether the current process coordinates worker processes
	65	bool IamCoordinatorProcess();
	66	/// whether the current process handles HTTP transactions and such
	67	bool IamWorkerProcess();
	68	/// whether the current process is dedicated to managing a cache_dir
	69	bool IamDiskProcess();
	70	/// Whether we are running in daemon mode
	71	bool InDaemonMode(); // try using specific Iam*() checks above first
	72	/// Whether there should be more than one worker process running
	73	bool UsingSmp(); // try using specific Iam*() checks above first
	74	/// number of Kid processes as defined in src/ipc/Kid.h
	75	int NumberOfKids();
	76	/// a string describing this process roles such as worker or coordinator
	77	SBuf ProcessRoles();
	78
	79	void debug_trap(const char *);
	80
	81	void logsFlush(void);
	82
	83	void squid_getrusage(struct rusage *r);
	84	double rusage_cputime(struct rusage *r);
	85	int rusage_maxrss(struct rusage *r);
	86	int rusage_pagefaults(struct rusage *r);
	87	void releaseServerSockets(void);
	88	void PrintRusage(void);
	89	void dumpMallocStats(void);
	90
	91	typedef int PidStatus;
	92
	93	/**
	94	* Compatibility wrapper function for waitpid
	95	* \pid the pid of child process to wait for.
	96	* \param status the exit status returned by waitpid
	97	* \param flags WNOHANG or 0
	98	*/
	99	pid_t WaitForOnePid(pid_t pid, PidStatus &status, int flags);
	100
	101	/**
	102	* Wait for state changes in any of the kid processes.
	103	* Equivalent to waitpid(-1, ...) system call
	104	* \param status the exit status returned by waitpid
	105	* \param flags WNOHANG or 0
	106	*/
	107	inline pid_t WaitForAnyPid(PidStatus &status, int flags)
	108	{
	109	return WaitForOnePid(-1, status, flags);
	110	}
	111
	112	#if _SQUID_WINDOWS_ \|\| _SQUID_MINGW_
	113	/// xstrerror(errno) equivalent for Windows errors returned by GetLastError()
	114	SBuf WindowsErrorMessage(DWORD errorId);
	115	#endif // _SQUID_WINDOWS_ \|\| _SQUID_MINGW_
	116
	117	#endif /* SQUID_SRC_TOOLS_H */
	118