src/ICP.h

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