src/ICP.h

   1 /*
   2  *
   3  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   4  * ----------------------------------------------------------
   5  *
   6  *  Squid is the result of efforts by numerous individuals from
   7  *  the Internet community; see the CONTRIBUTORS file for full
   8  *  details.   Many organizations have provided support for Squid's
   9  *  development; see the SPONSORS file for full details.  Squid is
  10  *  Copyrighted (C) 2001 by the Regents of the University of
  11  *  California; see the COPYRIGHT file for full details.  Squid
  12  *  incorporates software developed and/or copyrighted by other
  13  *  sources; see the CREDITS file for full details.
  14  *
  15  *  This program is free software; you can redistribute it and/or modify
  16  *  it under the terms of the GNU General Public License as published by
  17  *  the Free Software Foundation; either version 2 of the License, or
  18  *  (at your option) any later version.
  19  *
  20  *  This program is distributed in the hope that it will be useful,
  21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  *  GNU General Public License for more details.
  24  *
  25  *  You should have received a copy of the GNU General Public License
  26  *  along with this program; if not, write to the Free Software
  27  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  28  *
  29  */
  30
  31 #ifndef SQUID_ICP_H
  32 #define SQUID_ICP_H
  33
  34 /**
  35  \defgroup ServerProtocolICPAPI ICP
  36  \ingroup ServerProtocol
  37  */
  38
  39 #include "comm/forward.h"
  40 #include "icp_opcode.h"
  41 #include "ip/Address.h"
  42 #include "StoreClient.h"
  43
  44 class HttpRequest;
  45
  46 /**
  47  \ingroup ServerProtocolICPAPI
  48  *
  49  * This struct is the wire-level header.
  50  * DO NOT add more move fields on pain of breakage.
  51  * DO NOT add virtual methods.
  52  */
  53 struct _icp_common_t {
  54     /** opcode */
  55     unsigned char opcode;
  56     /** version number */
  57     unsigned char version;
  58     /** total length (bytes) */
  59     unsigned short length;
  60     /** req number (req'd for UDP) */
  61     uint32_t reqnum;
  62     uint32_t flags;
  63     uint32_t pad;
  64     /** sender host id */
  65     uint32_t shostid;
  66
  67 /// \todo I don't believe this header is included in non-c++ code anywhere
  68 ///             the struct should become a public POD class and kill these ifdef.
  69 #ifdef __cplusplus
  70
  71     _icp_common_t();
  72     _icp_common_t(char *buf, unsigned int len);
  73
  74     void handleReply(char *buf, Ip::Address &from);
  75     static _icp_common_t *createMessage(icp_opcode opcode, int flags, const char *url, int reqnum, int pad);
  76     icp_opcode getOpCode() const;
  77 #endif
  78 };
  79 typedef struct _icp_common_t icp_common_t;
  80
  81 #ifdef __cplusplus
  82
  83 /// \ingroup ServerProtocolICPAPI
  84 inline icp_opcode & operator++ (icp_opcode & aCode)
  85 {
  86     int tmp = (int) aCode;
  87     aCode = (icp_opcode) (++tmp);
  88     return aCode;
  89 }
  90
  91 /**
  92  \ingroup ServerProtocolICPAPI
  93  \todo mempool this
  94  */
  95 class ICPState
  96 {
  97
  98 public:
  99     ICPState(icp_common_t &aHeader, HttpRequest *aRequest);
 100     virtual ~ICPState();
 101     icp_common_t header;
 102     HttpRequest *request;
 103     int fd;
 104
 105     Ip::Address from;
 106     char *url;
 107 };
 108
 109 #endif
 110
 111 /// \ingroup ServerProtocolICPAPI
 112 struct icpUdpData {
 113
 114     /// IP address for the remote end. Because we reply to packets from unknown non-peers.
 115     Ip::Address address;
 116
 117     void *msg;
 118     size_t len;
 119     icpUdpData *next;
 120 #ifndef LESS_TIMING
 121
 122     struct timeval start;
 123 #endif
 124
 125     log_type logcode;
 126
 127     struct timeval queue_time;
 128 };
 129
 130 extern Comm::ConnectionPointer icpIncomingConn;
 131 extern Comm::ConnectionPointer icpOutgoingConn;
 132 extern Ip::Address theIcpPublicHostID;
 133
 134 /// \ingroup ServerProtocolICPAPI
 135 HttpRequest* icpGetRequest(char *url, int reqnum, int fd, Ip::Address &from);
 136
 137 /// \ingroup ServerProtocolICPAPI
 138 bool icpAccessAllowed(Ip::Address &from, HttpRequest * icp_request);
 139
 140 /// \ingroup ServerProtocolICPAPI
 141 void icpCreateAndSend(icp_opcode, int flags, char const *url, int reqnum, int pad, int fd, const Ip::Address &from);
 142
 143 /// \ingroup ServerProtocolICPAPI
 144 icp_opcode icpGetCommonOpcode();
 145
 146 /// \ingroup ServerProtocolICPAPI
 147 int icpUdpSend(int, const Ip::Address &, icp_common_t *, log_type, int);
 148
 149 /// \ingroup ServerProtocolICPAPI
 150 log_type icpLogFromICPCode(icp_opcode opcode);
 151
 152 /// \ingroup ServerProtocolICPAPI
 153 void icpDenyAccess(Ip::Address &from, char *url, int reqnum, int fd);
 154
 155 /// \ingroup ServerProtocolICPAPI
 156 PF icpHandleUdp;
 157
 158 /// \ingroup ServerProtocolICPAPI
 159 PF icpUdpSendQueue;
 160
 161 /// \ingroup ServerProtocolICPAPI
 162 void icpHandleIcpV3(int, Ip::Address &, char *, int);
 163
 164 /// \ingroup ServerProtocolICPAPI
 165 int icpCheckUdpHit(StoreEntry *, HttpRequest * request);
 166
 167 /// \ingroup ServerProtocolICPAPI
 168 void icpOpenPorts(void);
 169
 170 /// \ingroup ServerProtocolICPAPI
 171 void icpConnectionShutdown(void);
 172
 173 /// \ingroup ServerProtocolICPAPI
 174 void icpClosePorts(void);
 175
 176 /// \ingroup ServerProtocolICPAPI
 177 int icpSetCacheKey(const cache_key * key);
 178
 179 /// \ingroup ServerProtocolICPAPI
 180 const cache_key *icpGetCacheKey(const char *url, int reqnum);
 181
 182 #endif /* SQUID_ICP_H */