2 * Copyright (C) 1996-2016 The Squid Software Foundation and contributors
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.
9 #ifndef SQUID_FORWARD_H
10 #define SQUID_FORWARD_H
12 #include "base/RefCount.h"
14 #include "comm/Connection.h"
17 #include "http/StatusCode.h"
18 #include "ip/Address.h"
19 #include "security/forward.h"
21 #include "ssl/support.h"
27 typedef RefCount
<AccessLogEntry
> AccessLogEntryPointer
;
29 typedef RefCount
<PconnPool
> PconnPoolPointer
;
37 class CertValidationResponse
;
42 * Returns the TOS value that we should be setting on the connection
43 * to the server, based on the ACL.
45 tos_t
GetTosToServer(HttpRequest
* request
);
48 * Returns the Netfilter mark value that we should be setting on the
49 * connection to the server, based on the ACL.
51 nfmark_t
GetNfmarkToServer(HttpRequest
* request
);
53 /// Sets initial TOS value and Netfilter for the future outgoing connection.
54 void GetMarkingsToServer(HttpRequest
* request
, Comm::Connection
&conn
);
58 class FwdState
: public RefCountable
60 CBDATA_CLASS(FwdState
);
63 typedef RefCount
<FwdState
> Pointer
;
65 static void initModule();
67 /// Initiates request forwarding to a peer or origin server.
68 static void Start(const Comm::ConnectionPointer
&client
, StoreEntry
*, HttpRequest
*, const AccessLogEntryPointer
&alp
);
69 /// Same as Start() but no master xaction info (AccessLogEntry) available.
70 static void fwdStart(const Comm::ConnectionPointer
&client
, StoreEntry
*, HttpRequest
*);
72 /// This is the real beginning of server connection. Call it whenever
73 /// the forwarding server destination has changed and a new one needs to be opened.
74 /// Produces the cannot-forward error on fail if no better error exists.
75 void startConnectionOrFail();
77 void fail(ErrorState
*err
);
78 void unregister(Comm::ConnectionPointer
&conn
);
79 void unregister(int fd
);
81 void handleUnregisteredServerEnd();
83 bool reforwardableStatus(const Http::StatusCode s
) const;
84 void serverClosed(int fd
);
86 void connectDone(const Comm::ConnectionPointer
& conn
, Comm::Flag status
, int xerrno
);
87 void connectTimeout(int fd
);
88 time_t timeLeft() const; ///< the time left before the forwarding timeout expired
90 bool checkRetriable();
92 /// Pops a connection from connection pool if available. If not
93 /// checks the peer stand-by connection pool for available connection.
94 Comm::ConnectionPointer
pconnPop(const Comm::ConnectionPointer
&dest
, const char *domain
);
95 void pconnPush(Comm::ConnectionPointer
& conn
, const char *domain
);
97 bool dontRetry() { return flags
.dont_retry
; }
99 void dontRetry(bool val
) { flags
.dont_retry
= val
; }
101 /** return a ConnectionPointer to the current server connection (may or may not be open) */
102 Comm::ConnectionPointer
const & serverConnection() const { return serverConn
; };
105 // hidden for safer management of self; use static fwdStart
106 FwdState(const Comm::ConnectionPointer
&client
, StoreEntry
*, HttpRequest
*, const AccessLogEntryPointer
&alp
);
107 void start(Pointer aSelf
);
109 #if STRICT_ORIGINAL_DST
110 void selectPeerForIntercepted();
112 static void logReplyStatus(int tries
, const Http::StatusCode status
);
113 void doneWithRetries();
116 ErrorState
*makeConnectingError(const err_type type
) const;
117 void connectedToPeer(Security::EncryptorAnswer
&answer
);
118 static void RegisterWithCacheManager(void);
120 /// stops monitoring server connection for closure and updates pconn stats
121 void closeServerConnection(const char *reason
);
123 void syncWithServerConn(const char *host
);
124 void syncHierNote(const Comm::ConnectionPointer
&server
, const char *host
);
128 HttpRequest
*request
;
129 AccessLogEntryPointer al
; ///< info for the future access.log entry
131 static void abort(void*);
136 Comm::ConnectionPointer clientConn
; ///< a possibly open connection to the client.
140 // AsyncCalls which we set and may need cancelling.
142 AsyncCall::Pointer connector
; ///< a call linking us to the ConnOpener producing serverConn.
146 bool connected_okay
; ///< TCP link ever opened properly. This affects retry of POST,PUT,CONNECT,etc
148 bool forward_completed
;
151 /** connections to open, in order, until successful */
152 Comm::ConnectionList serverDestinations
;
154 Comm::ConnectionPointer serverConn
; ///< a successfully opened connection to a server.
156 AsyncCall::Pointer closeHandler
; ///< The serverConn close handler
158 /// possible pconn race states
159 typedef enum { raceImpossible
, racePossible
, raceHappened
} PconnRace
;
160 PconnRace pconnRace
; ///< current pconn race state
163 void getOutgoingAddress(HttpRequest
* request
, Comm::ConnectionPointer conn
);
165 #endif /* SQUID_FORWARD_H */