src/CachePeer.cc

   1 /*
   2  * Copyright (C) 1996-2023 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 #include "squid.h"
  10 #include "acl/Gadgets.h"
  11 #include "CachePeer.h"
  12 #include "defines.h"
  13 #include "neighbors.h"
  14 #include "NeighborTypeDomainList.h"
  15 #include "pconn.h"
  16 #include "PeerDigest.h"
  17 #include "PeerPoolMgr.h"
  18 #include "SquidConfig.h"
  19 #include "util.h"
  20
  21 CBDATA_CLASS_INIT(CachePeer);
  22
  23 CachePeer::CachePeer(const char * const hostname):
  24     name(xstrdup(hostname)),
  25     host(xstrdup(hostname))
  26 {
  27     Tolower(host); // but .name preserves original spelling
  28 }
  29
  30 CachePeer::~CachePeer()
  31 {
  32     xfree(name);
  33     xfree(host);
  34
  35     while (NeighborTypeDomainList *l = typelist) {
  36         typelist = l->next;
  37         xfree(l->domain);
  38         xfree(l);
  39     }
  40
  41     aclDestroyAccessList(&access);
  42
  43 #if USE_CACHE_DIGESTS
  44     void *digestTmp = nullptr;
  45     if (cbdataReferenceValidDone(digest, &digestTmp))
  46         peerDigestNotePeerGone(static_cast<PeerDigest *>(digestTmp));
  47     xfree(digest_url);
  48 #endif
  49
  50     xfree(login);
  51
  52     delete standby.pool;
  53
  54     // the mgr job will notice that its owner is gone and stop
  55     PeerPoolMgr::Checkpoint(standby.mgr, "peer gone");
  56
  57     xfree(domain);
  58 }
  59
  60 void
  61 CachePeer::noteSuccess()
  62 {
  63     if (!tcp_up) {
  64         debugs(15, 2, "connection to " << *this << " succeeded");
  65         tcp_up = connect_fail_limit; // NP: so peerAlive() works properly.
  66         peerAlive(this);
  67     } else {
  68         tcp_up = connect_fail_limit;
  69     }
  70 }
  71
  72 void
  73 CachePeer::noteFailure(const Http::StatusCode code)
  74 {
  75     if (Http::Is4xx(code))
  76         return; // this failure is not our fault
  77
  78     countFailure();
  79 }
  80
  81 // TODO: Require callers to detail failures instead of using one (and often
  82 // misleading!) "connection failed" phrase for all of them.
  83 /// noteFailure() helper for handling failures attributed to this peer
  84 void
  85 CachePeer::countFailure()
  86 {
  87     stats.last_connect_failure = squid_curtime;
  88     if (tcp_up > 0)
  89         --tcp_up;
  90
  91     const auto consideredAliveByAdmin = (stats.logged_state == PEER_ALIVE);
  92     const auto level = consideredAliveByAdmin ? DBG_IMPORTANT : 2;
  93     debugs(15, level, "ERROR: Connection to " << *this << " failed");
  94
  95     if (consideredAliveByAdmin) {
  96         if (!tcp_up) {
  97             debugs(15, DBG_IMPORTANT, "Detected DEAD " << neighborTypeStr(this) << ": " << name);
  98             stats.logged_state = PEER_DEAD;
  99         } else {
 100             debugs(15, 2, "additional failures needed to mark this cache_peer DEAD: " << tcp_up);
 101         }
 102     } else {
 103         assert(!tcp_up);
 104         debugs(15, 2, "cache_peer " << *this << " is still DEAD");
 105     }
 106 }
 107
 108 void
 109 CachePeer::rename(const char * const newName)
 110 {
 111     if (!newName || !*newName)
 112         throw TextException("cache_peer name=value cannot be empty", Here());
 113
 114     xfree(name);
 115     name = xstrdup(newName);
 116 }
 117
 118 time_t
 119 CachePeer::connectTimeout() const
 120 {
 121     if (connect_timeout_raw > 0)
 122         return connect_timeout_raw;
 123     return Config.Timeout.peer_connect;
 124 }
 125
 126 std::ostream &
 127 operator <<(std::ostream &os, const CachePeer &p)
 128 {
 129     return os << p.name;
 130 }
 131