Instance.cc

Go to the documentation of this file.

/*
 * 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.
 */
 
#include "squid.h"
#include "base/File.h"
#include "debug/Messages.h"
#include "fs_io.h"
#include "Instance.h"
#include "md5.h"
#include "parser/Tokenizer.h"
#include "sbuf/Stream.h"
#include "SquidConfig.h"
#include "tools.h"
 
#include <cerrno>
 
/* To support concurrent PID files, convert local static variables into PidFile class */
 
static SBuf TheFile;
 
static SBuf
PidFilenameCalc()
{
    if (!Config.pidFilename || strcmp(Config.pidFilename, "none") == 0)
        return SBuf();
 
    // If chroot has been requested, then we first read the PID file before
    // chroot() and then create/update it inside a chrooted environment.
    // TODO: Consider removing half-baked chroot support from Squid.
    extern bool Chrooted;
    if (!Config.chroot_dir || Chrooted) // no need to compensate
        return SBuf(Config.pidFilename);
 
    SBuf filename;
    filename.append(Config.chroot_dir);
    filename.append("/");
    filename.append(Config.pidFilename);
    debugs(50, 3, "outside chroot: " << filename);
    return filename;
}
 
static SBuf
PidFileDescription(const SBuf &filename)
{
    return ToSBuf("PID file (", filename, ')');
}
 
static SBuf
PidFilename()
{
    const auto name = PidFilenameCalc();
    TheFile = PidFileDescription(name);
    return name;
}
 
static pid_t
GetOtherPid(File &pidFile)
{
    const auto input = pidFile.readSmall(1, 32);
    int64_t rawPid = -1;
 
    Parser::Tokenizer tok(input);
    if (!(tok.int64(rawPid, 10, false) && // PID digits
            (tok.skipOne(CharacterSet::CR)||true) && // optional CR (Windows/etc.)
            tok.skipOne(CharacterSet::LF) && // required end of line
            tok.atEnd())) { // no trailing garbage
        throw TexcHere(ToSBuf("Malformed ", TheFile));
    }
 
    debugs(50, 7, "found PID " << rawPid << " in " << TheFile);
 
    if (rawPid < 1)
        throw TexcHere(ToSBuf("Bad ", TheFile, " contains unreasonably small PID value: ", rawPid));
    const auto finalPid = static_cast<pid_t>(rawPid);
    if (static_cast<int64_t>(finalPid) != rawPid)
        throw TexcHere(ToSBuf("Bad ", TheFile, " contains unreasonably large PID value: ", rawPid));
 
    return finalPid;
}
 
static bool
ProcessIsRunning(const pid_t pid)
{
    const auto result = kill(pid, 0);
    const auto savedErrno = errno;
    if (result != 0)
        debugs(50, 3, "kill(" << pid << ", 0) failed: " << xstrerr(savedErrno));
    // if we do not have permissions to signal the process, then it is running
    return (result == 0 || savedErrno == EPERM);
}
 
static void
ThrowIfAlreadyRunningWith(File &pidFile)
{
    bool running = false;
    SBuf description;
    try {
        const auto pid = GetOtherPid(pidFile);
        description = ToSBuf(TheFile, " with PID ", pid);
        running = ProcessIsRunning(pid);
    }
    catch (const std::exception &ex) {
        debugs(50, 5, "assuming no other Squid instance: " << ex.what());
        return;
    }
 
    if (running)
        throw TexcHere(ToSBuf("Squid is already running: Found fresh instance ", description));
 
    debugs(50, 5, "assuming stale instance " << description);
}
 
pid_t
Instance::Other()
{
    const auto filename = PidFilename();
    if (filename.isEmpty())
        throw TexcHere("no pid_filename configured");
 
    File pidFile(filename, File::Be::ReadOnly().locked());
    return GetOtherPid(pidFile);
}
 
void
Instance::ThrowIfAlreadyRunning()
{
    const auto filename = PidFilename();
    if (filename.isEmpty())
        return; // the check is impossible
 
    if (const auto filePtr = File::Optional(filename, File::Be::ReadOnly().locked())) {
        const std::unique_ptr<File> pidFile(filePtr);
        ThrowIfAlreadyRunningWith(*pidFile);
    } else {
        // It is best to assume then to check because checking without a lock
        // might lead to false positives that lead to no Squid starting at all!
        debugs(50, 5, "cannot lock " << TheFile << "; assuming no other Squid is running");
        // If our assumption is false, we will fail to _create_ the PID file,
        // and, hence, will not start, allowing that other Squid to run.
    }
}
 
static SBuf ThePidFileToRemove;
 
static void
RemoveInstance()
{
    if (ThePidFileToRemove.isEmpty()) // not the PidFilename()!
        return; // nothing to do
 
    debugs(50, Important(22), "Removing " << PidFileDescription(ThePidFileToRemove));
 
    // Do not write to cache_log after our PID file is removed because another
    // instance may already be logging there. Stop logging now because, if we
    // wait until safeunlink(), some debugs() may slip through into the now
    // "unlocked" cache_log, especially if we avoid the sensitive suid() area.
    // Use stderr to capture late debugs() that did not make it into cache_log.
    Debug::StopCacheLogUse();
 
    const char *filename = ThePidFileToRemove.c_str(); // avoid complex operations inside enter_suid()
    enter_suid();
    safeunlink(filename, 0);
    leave_suid();
 
    ThePidFileToRemove.clear();
}
 
void
Instance::WriteOurPid()
{
    // Instance code assumes that we do not support PID filename reconfiguration
    static bool called = false;
    Must(!called);
    called = true;
 
    const auto filename = PidFilename();
    if (filename.isEmpty())
        return; // nothing to do
 
    File pidFile(filename, File::Be::ReadWrite().locked().createdIfMissing().openedByRoot());
 
    // another instance may have started after the caller checked (if it did)
    ThrowIfAlreadyRunningWith(pidFile);
 
    /* now we know that we own the PID file created and/or locked above */
 
    // Cleanup is scheduled through atexit() to ensure both:
    // - cleanup upon fatal() and similar "unplanned" exits and
    // - enter_suid() existence and proper logging support during cleanup.
    // Even without PID filename reconfiguration support, we have to remember
    // the file name we have used because Config.pidFilename may change!
    (void)std::atexit(&RemoveInstance); // failures leave the PID file on disk
    ThePidFileToRemove = filename;
 
    /* write our PID to the locked file */
    SBuf pidBuf;
    pidBuf.Printf("%d\n", static_cast<int>(getpid()));
    pidFile.truncate();
    pidFile.writeAll(pidBuf);
 
    // We must fsync before releasing the lock or other Squid processes may not see
    // our written PID (and decide that they are dealing with a corrupted PID file).
    pidFile.synchronize();
 
    debugs(50, Important(23), "Created " << TheFile);
}
 
static SBuf
PidFilenameHash()
{
    uint8_t hash[SQUID_MD5_DIGEST_LENGTH];
 
    SquidMD5_CTX ctx;
    SquidMD5Init(&ctx);
    const auto name = PidFilenameCalc();
    SquidMD5Update(&ctx, name.rawContent(), name.length());
    SquidMD5Final(hash, &ctx);
 
    // converts raw hash byte at a given position to a filename-suitable character
    const auto hashAt = [&hash](const size_t idx) {
        const auto safeChars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
        return safeChars[hash[idx] % strlen(safeChars)];
    };
 
    SBuf buf;
    buf.appendf("%c%c%c%c", hashAt(0), hashAt(1), hashAt(2), hashAt(3));
    return buf;
}
 
SBuf
Instance::NamePrefix(const char * const head, const char * const tail)
{
    SBuf buf(head);
    buf.append(service_name);
    buf.append("-");
    buf.append(PidFilenameHash());
    if (tail) {
        // TODO: Remove leading "-" from callers and explicitly add it here.
        buf.append(tail);
    }
    return buf;
}