src/ICP.h

   1 /*
   2  * Copyright (C) 1996-2020 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 #ifndef SQUID_ICP_H
  10 #define SQUID_ICP_H
  11
  12 /**
  13  \defgroup ServerProtocolICPAPI ICP
  14  \ingroup ServerProtocol
  15  */
  16
  17 #include "base/RefCount.h"
  18 #include "comm/forward.h"
  19 #include "icp_opcode.h"
  20 #include "ip/Address.h"
  21 #include "LogTags.h"
  22 #include "store_key_md5.h"
  23 #include "StoreClient.h"
  24
  25 class AccessLogEntry;
  26 class HttpRequest;
  27
  28 typedef RefCount<AccessLogEntry> AccessLogEntryPointer;
  29
  30 /**
  31  * Wire-level ICP header.
  32  * DO NOT add or move fields.
  33  * DO NOT add virtual methods.
  34  */
  35 class icp_common_t {
  36 public:
  37     /** opcode */
  38     unsigned char opcode;
  39     /** version number */
  40     unsigned char version;
  41     /** total length (bytes) */
  42     unsigned short length;
  43     /** req number (req'd for UDP) */
  44     uint32_t reqnum;
  45     uint32_t flags;
  46     uint32_t pad;
  47     /** sender host id */
  48     uint32_t shostid;
  49
  50     icp_common_t();
  51     icp_common_t(char *buf, unsigned int len);
  52
  53     void handleReply(char *buf, Ip::Address &from);
  54     icp_opcode getOpCode() const;
  55
  56     /// \returns newly allocated buffer with an ICP message, including header
  57     static icp_common_t *CreateMessage(icp_opcode opcode, int flags, const char *url, int reqnum, int pad);
  58 };
  59
  60 /**
  61  \ingroup ServerProtocolICPAPI
  62  \todo mempool this
  63  */
  64 class ICPState: public StoreClient
  65 {
  66
  67 public:
  68     ICPState(icp_common_t &aHeader, HttpRequest *aRequest);
  69     virtual ~ICPState();
  70
  71     icp_common_t header;
  72     HttpRequest *request;
  73     int fd;
  74
  75     Ip::Address from;
  76     char *url;
  77
  78 protected:
  79     /* StoreClient API */
  80     virtual LogTags *loggingTags() override;
  81     virtual void fillChecklist(ACLFilledChecklist &) const override;
  82
  83     /// either confirms and starts processing a cache hit or returns false
  84     bool confirmAndPrepHit(const StoreEntry &);
  85
  86     mutable AccessLogEntryPointer al;
  87 };
  88
  89 extern Comm::ConnectionPointer icpIncomingConn;
  90 extern Comm::ConnectionPointer icpOutgoingConn;
  91 extern Ip::Address theIcpPublicHostID;
  92
  93 /// \ingroup ServerProtocolICPAPI
  94 HttpRequest* icpGetRequest(char *url, int reqnum, int fd, Ip::Address &from);
  95
  96 /// \ingroup ServerProtocolICPAPI
  97 bool icpAccessAllowed(Ip::Address &from, HttpRequest * icp_request);
  98
  99 /// \ingroup ServerProtocolICPAPI
 100 void icpCreateAndSend(icp_opcode, int flags, char const *url, int reqnum, int pad, int fd, const Ip::Address &from, AccessLogEntryPointer);
 101
 102 /// \ingroup ServerProtocolICPAPI
 103 icp_opcode icpGetCommonOpcode();
 104
 105 /// \ingroup ServerProtocolICPAPI
 106 void icpDenyAccess(Ip::Address &from, char *url, int reqnum, int fd);
 107
 108 /// \ingroup ServerProtocolICPAPI
 109 PF icpHandleUdp;
 110
 111 /// \ingroup ServerProtocolICPAPI
 112 void icpHandleIcpV3(int, Ip::Address &, char *, int);
 113
 114 /// \ingroup ServerProtocolICPAPI
 115 void icpOpenPorts(void);
 116
 117 /// \ingroup ServerProtocolICPAPI
 118 void icpConnectionShutdown(void);
 119
 120 /// \ingroup ServerProtocolICPAPI
 121 void icpClosePorts(void);
 122
 123 /// \ingroup ServerProtocolICPAPI
 124 int icpSetCacheKey(const cache_key * key);
 125
 126 /// \ingroup ServerProtocolICPAPI
 127 const cache_key *icpGetCacheKey(const char *url, int reqnum);
 128
 129 #endif /* SQUID_ICP_H */
 130