src/fde.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 /* DEBUG: section 05    Comm */
  10
  11 #include "squid.h"
  12 #include "comm/Read.h"
  13 #include "debug/Stream.h"
  14 #include "fd.h"
  15 #include "fde.h"
  16 #include "globals.h"
  17 #include "Store.h"
  18
  19 fde *fde::Table = nullptr;
  20
  21 void
  22 fde::setIo(READ_HANDLER *reader, WRITE_HANDLER *writer)
  23 {
  24     assert(reader);
  25     assert(writer);
  26     assert(!flags.read_pending); // this method is only meant for new FDs
  27
  28     readMethod_ = reader;
  29     writeMethod_ = writer;
  30 }
  31
  32 void
  33 fde::useDefaultIo()
  34 {
  35     debugs(5, 7, "old read_pending=" << flags.read_pending);
  36
  37     // Some buffering readers are using external-to-them buffers (e.g., inBuf)
  38     // and might leave true flags.read_pending behind without losing data. We
  39     // must clear the flag here because default I/O methods do not know about it
  40     // and will leave it set forever, resulting in I/O loops.
  41     flags.read_pending = false;
  42
  43     readMethod_ = default_read_method;
  44     writeMethod_ = default_write_method;
  45 }
  46
  47 /// use I/O methods that maintain an internal-to-them buffer
  48 void
  49 fde::useBufferedIo(READ_HANDLER *bufferingReader, WRITE_HANDLER *bufferingWriter)
  50 {
  51     debugs(5, 7, "read_pending=" << flags.read_pending);
  52
  53     assert(bufferingReader);
  54     assert(bufferingWriter);
  55     // flags.read_pending ought to be false here, but these buffering methods
  56     // can handle a stale true flag so we do not check or reset it
  57
  58     readMethod_ = bufferingReader;
  59     writeMethod_ = bufferingWriter;
  60 }
  61
  62 bool
  63 fde::readPending(int fdNumber) const
  64 {
  65     if (type == FD_SOCKET)
  66         return Comm::MonitorsRead(fdNumber);
  67
  68     return read_handler != nullptr;
  69 }
  70
  71 void
  72 fde::dumpStats(StoreEntry &dumpEntry, int fdNumber) const
  73 {
  74     if (!flags.open)
  75         return;
  76
  77 #if _SQUID_WINDOWS_
  78     storeAppendPrintf(&dumpEntry, "%4d 0x%-8lX %-6.6s %4d %7" PRId64 "%c %7" PRId64 "%c %-21s %s\n",
  79                       fdNumber,
  80                       win32.handle,
  81 #else
  82     storeAppendPrintf(&dumpEntry, "%4d %-6.6s %4d %7" PRId64 "%c %7" PRId64 "%c %-21s %s\n",
  83                       fdNumber,
  84 #endif
  85                       fdTypeStr[type],
  86                       timeoutHandler ? (int) (timeout - squid_curtime) : 0,
  87                       bytes_read,
  88                       readPending(fdNumber) ? '*' : ' ',
  89                       bytes_written,
  90                       write_handler ? '*' : ' ',
  91                       remoteAddr(),
  92                       desc);
  93 }
  94
  95 void
  96 fde::DumpStats(StoreEntry *dumpEntry)
  97 {
  98     storeAppendPrintf(dumpEntry, "Active file descriptors:\n");
  99 #if _SQUID_WINDOWS_
 100     storeAppendPrintf(dumpEntry, "%-4s %-10s %-6s %-4s %-7s* %-7s* %-21s %s\n",
 101                       "File",
 102                       "Handle",
 103 #else
 104     storeAppendPrintf(dumpEntry, "%-4s %-6s %-4s %-7s* %-7s* %-21s %s\n",
 105                       "File",
 106 #endif
 107                       "Type",
 108                       "Tout",
 109                       "Nread",
 110                       "Nwrite",
 111                       "Remote Address",
 112                       "Description");
 113 #if _SQUID_WINDOWS_
 114     storeAppendPrintf(dumpEntry, "---- ---------- ------ ---- -------- -------- --------------------- ------------------------------\n");
 115 #else
 116     storeAppendPrintf(dumpEntry, "---- ------ ---- -------- -------- --------------------- ------------------------------\n");
 117 #endif
 118
 119     for (int i = 0; i < Squid_MaxFD; ++i) {
 120         fde::Table[i].dumpStats(*dumpEntry, i);
 121     }
 122 }
 123
 124 char const *
 125 fde::remoteAddr() const
 126 {
 127     static char buf[MAX_IPSTRLEN+7]; // 7 = length of ':port' strings
 128     *buf = 0;
 129
 130     if (type == FD_SOCKET) {
 131         if (*ipaddr)
 132             snprintf(buf, sizeof(buf), "%s:%u", ipaddr, remote_port);
 133         else
 134             local_addr.toUrl(buf, sizeof(buf)); // toHostStr does not include port.
 135     }
 136
 137     return buf;
 138 }
 139
 140 void
 141 fde::Init()
 142 {
 143     assert(!Table);
 144     Table = static_cast<fde *>(xcalloc(Squid_MaxFD, sizeof(fde)));
 145 }
 146