StoreSwapLogData.h

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.
 */
 
#ifndef SQUID_SRC_STORESWAPLOGDATA_H
#define SQUID_SRC_STORESWAPLOGDATA_H
 
#include "md5.h"
#include "mem/forward.h"
#include "store/forward.h"
 
class SwapChecksum24
{
public:
    SwapChecksum24() { raw[0] = raw[1] = raw[2] = 0; }
 
    bool operator ==(const SwapChecksum24 &o) const {
        return raw[0] == o.raw[0] && raw[1] == o.raw[1] && raw[2] == o.raw[2];
    }
 
    bool operator !=(const SwapChecksum24 &o) const {
        return !(*this == o);
    }
 
    void set(uint32_t f1, uint32_t f2, uint32_t f3);
 
    void set(int32_t f1, uint64_t f2);
 
    // printing for debugging
    std::ostream &print(std::ostream &os) const;
 
private:
    uint8_t raw[3]; // designed to follow "op" members, in padding space
};
 
inline std::ostream &
operator <<(std::ostream &os, const SwapChecksum24 &sum)
{
    return sum.print(os);
}
 
class StoreSwapLogData
{
    MEMPROXY_CLASS(StoreSwapLogData);
 
public:
    typedef int64_t SwappedTime;
 
    bool sane() const;
 
    void finalize();
 
    uint8_t op = 0;
 
    SwapChecksum24 checksum; // follows "op" because compiler will pad anyway
 
    sfileno swap_filen = 0;
 
    SwappedTime timestamp = 0;
 
    SwappedTime lastref = 0;
 
    SwappedTime expires = 0;
 
    SwappedTime lastmod = 0;
 
    uint64_t swap_file_sz = 0;
 
    uint16_t refcount;
 
    uint16_t flags = 0;
 
    unsigned char key[SQUID_MD5_DIGEST_LENGTH] = {};
};
 
class StoreSwapLogHeader
{
public:
    // sets default values for this Squid version; loaded values may differ
    StoreSwapLogHeader();
 
    bool sane() const;
 
    size_t gapSize() const;
 
    uint8_t op;
    SwapChecksum24 checksum; // follows "op" because compiler will pad anyway
    int32_t version;
    int32_t record_size;
};
 
#endif /* SQUID_SRC_STORESWAPLOGDATA_H */