ipcache.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_IPCACHE_H
#define SQUID_SRC_IPCACHE_H
 
#include "base/CbcPointer.h"
#include "dns/forward.h"
#include "ip/Address.h"
#include <iosfwd>
#include <vector>
 
// The IPs the caller should not connect to are "bad". Other IPs are "good".
 
namespace Dns {
 
class CachedIp
{
public:
    explicit CachedIp(const Ip::Address &anIp): ip(anIp) {}
 
    bool bad() const { return bad_; }
 
    void markAsBad() { bad_ = true; }
 
    void forgetMarking() { bad_ = false; }
 
    Ip::Address ip;
 
private:
    bool bad_ = false; 
};
 
class IpsIterator;
class GoodIpsIterator;
template <class Iterator>
class IpsSelector;
 
class CachedIps
{
public:
    bool have(const Ip::Address &ip, size_t *position = nullptr) const;
 
    const Ip::Address &current() const { return ips.at(goodPosition).ip; }
 
    bool empty() const noexcept { return ips.empty(); } 
    size_t size() const noexcept { return ips.size(); } 
    size_t badCount() const noexcept { return badCount_; } 
 
    inline IpsSelector<GoodIpsIterator> good() const; 
    inline IpsSelector<IpsIterator> goodAndBad() const; 
 
    typedef std::vector<CachedIp> Storage;
    const Storage &raw() const { return ips; } 
 
    void markAsBad(const char *name, const Ip::Address &ip);
 
    void forgetMarking(const char *name, const Ip::Address &ip);
 
    void pushUnique(const Ip::Address &ip);
 
    void reset(const Ip::Address &ip);
 
    void reportCurrent(std::ostream &os) const;
 
private:
    bool seekNewGood(const char *name);
    void restoreGoodness(const char *name);
 
    // Memory- and speed-optimized for "a few (and usually just one)" IPs,
    // the vast majority of which are "good". The current implementation
    // does linear searches and often reallocs when adding IPs.
    Storage ips; 
 
    template <class Iterator> friend class IpsSelector;
    size_t goodPosition = 0; 
    size_t badCount_ = 0; 
};
 
// The CachedIps class keeps meta information about individual IP addresses
// together with those IPs. CachedIps users do not care about caching details;
// they just want to iterate (a subset of) cached IPs. The IpsIterator and
// IpsSelector classes below are minimal helper classes that make cached IPs
// iteration easier, safer, and copy-free. See also: CachedIps::good().
 
class IpsIterator
{
public:
    typedef std::vector<CachedIp> Raw;
    typedef Raw::const_iterator RawIterator;
 
    // some of the standard iterator traits
    using iterator_category = std::forward_iterator_tag;
    using value_type = const Ip::Address;
    using pointer = value_type *;
    using reference = value_type &;
 
    IpsIterator(const Raw &raw, const size_t): position_(raw.cbegin()) {}
    // special constructor for end() iterator
    explicit IpsIterator(const Raw &raw): position_(raw.cend()) {}
 
    reference operator *() const { return position_->ip; }
    pointer operator ->() const { return &position_->ip; }
 
    IpsIterator& operator++() { ++position_; return *this; }
    IpsIterator operator++(int) { const auto oldMe = *this; ++(*this); return oldMe; }
 
    bool operator ==(const IpsIterator them) const { return position_ == them.position_; }
    bool operator !=(const IpsIterator them) const { return !(*this == them); }
 
private:
    RawIterator position_; 
};
 
class GoodIpsIterator
{
public:
    typedef std::vector<CachedIp> Raw;
    typedef Raw::const_iterator RawIterator;
 
    // some of the standard iterator traits
    using iterator_category = std::forward_iterator_tag;
    using value_type = const Ip::Address;
    using pointer = value_type *;
    using reference = value_type &;
 
    GoodIpsIterator(const Raw &raw, const size_t currentPos): raw_(raw), position_(currentPos), processed_(0) { sync(); }
    // special constructor for end() iterator
    explicit GoodIpsIterator(const Raw &raw): raw_(raw), position_(0), processed_(raw.size()) {}
 
    reference operator *() const { return current().ip; }
    pointer operator ->() const { return &current().ip; }
 
    GoodIpsIterator& operator++() { next(); sync(); return *this; }
    GoodIpsIterator operator++(int) { const auto oldMe = *this; ++(*this); return oldMe; }
 
    bool operator ==(const GoodIpsIterator them) const { return processed_ == them.processed_; }
    bool operator !=(const GoodIpsIterator them) const { return !(*this == them); }
 
private:
    const CachedIp &current() const { return raw_[position_ % raw_.size()]; }
    void next() { ++position_; ++processed_; }
    void sync() { while (processed_ < raw_.size() && current().bad()) next(); }
 
    const Raw &raw_; 
    size_t position_; 
    size_t processed_; 
};
 
template <class Iterator>
class IpsSelector
{
public:
    explicit IpsSelector(const CachedIps &ips): ips_(ips) {}
 
    Iterator cbegin() const noexcept { return Iterator(ips_.raw(), ips_.goodPosition); }
    Iterator cend() const noexcept { return Iterator(ips_.raw()); }
    Iterator begin() const noexcept { return cbegin(); }
    Iterator end() const noexcept { return cend(); }
 
private:
    const CachedIps &ips_; 
};
 
class IpReceiver: public virtual CbdataParent
{
public:
    ~IpReceiver() override {}
 
    virtual void noteIps(const CachedIps *ips, const LookupDetails &details) = 0;
 
    virtual void noteIp(const Ip::Address &) {}
 
    virtual void noteLookup(const Dns::LookupDetails &) {}
};
 
void nbgethostbyname(const char *name, const CbcPointer<IpReceiver> &receiver);
 
inline std::ostream &
operator <<(std::ostream &os, const CachedIps &ips)
{
    ips.reportCurrent(os);
    return os;
}
 
} // namespace Dns
 
typedef Dns::CachedIps ipcache_addrs; 
 
typedef void IPH(const ipcache_addrs *, const Dns::LookupDetails &details, void *);
 
void ipcache_purgelru(void *);
void ipcache_nbgethostbyname(const char *name, IPH * handler, void *handlerData);
const ipcache_addrs *ipcache_gethostbyname(const char *, int flags);
void ipcacheInvalidate(const char *);
void ipcacheInvalidateNegative(const char *);
void ipcache_init(void);
void ipcacheMarkBadAddr(const char *name, const Ip::Address &);
void ipcacheMarkGoodAddr(const char *name, const Ip::Address &);
void ipcache_restart(void);
int ipcacheAddEntryFromHosts(const char *name, const char *ipaddr);
 
/* inlined implementations */
 
inline Dns::IpsSelector<Dns::GoodIpsIterator>
Dns::CachedIps::good() const
{
    return IpsSelector<GoodIpsIterator>(*this);
}
 
inline Dns::IpsSelector<Dns::IpsIterator>
Dns::CachedIps::goodAndBad() const
{
    return IpsSelector<IpsIterator>(*this);
}
 
#endif /* SQUID_SRC_IPCACHE_H */