1 #ifndef SQUID_QOSCONFIG_H
2 #define SQUID_QOSCONFIG_H
4 #include "acl/forward.h"
6 #include "ip/forward.h"
8 #if HAVE_LIBNETFILTER_CONNTRACK_LIBNETFILTER_CONNTRACK_H
9 #include <libnetfilter_conntrack/libnetfilter_conntrack.h>
12 #if HAVE_LIBNETFILTER_CONNTRACK_LIBNETFILTER_CONNTRACK_TCP_H
13 #include <libnetfilter_conntrack/libnetfilter_conntrack_tcp.h>
22 // TODO: move to new ACL framework
23 // not integrated in namespace, as this class uses a strange CBDATA definition
32 // TODO: move to new ACL framework
33 // not integrated in namespace, as this class uses a strange CBDATA definition
47 * QOS namespace contains all the QOS functionality: global functions within
48 * the namespace and the configuration parameters within a config class.
54 * Function to retrieve the TOS value of the inbound packet.
55 * Called by FwdState::dispatch if QOS options are enabled.
56 * Bug 2537: This part of ZPH only applies to patched Linux kernels
57 * @param server Server side descriptor of connection to get TOS for
58 * @param clientFde Pointer to client side fde instance to set tosFromServer in
60 void getTosFromServer(const Comm::ConnectionPointer
&server
, fde
*clientFde
);
63 * Function to retrieve the netfilter mark value of the connection
64 * to the upstream server. Called by FwdState::dispatch if QOS
65 * options are enabled.
66 * @param server Server side descriptor of connection to get mark for
67 * @param clientFde Pointer to client side fde instance to set nfmarkFromServer in
69 void getNfmarkFromServer(const Comm::ConnectionPointer
&server
, const fde
*clientFde
);
71 #if USE_LIBNETFILTERCONNTRACK
73 * Callback function to mark connection once it's been found.
74 * This function is called by the libnetfilter_conntrack
75 * libraries, during nfct_query in Ip::Qos::getNfmarkFromServer.
76 * nfct_callback_register is used to register this function.
77 * @param nf_conntrack_msg_type Type of conntrack message
78 * @param nf_conntrack Pointer to the conntrack structure
79 * @param clientFde Pointer to client side fde instance to set nfmarkFromServer in
81 int getNfMarkCallback(enum nf_conntrack_msg_type type
, struct nf_conntrack
*ct
, void *clientFde
);
85 * Function to work out and then apply to the socket the appropriate
86 * TOS value to set on packets when items have not been retrieved from
87 * local cache. Called by clientReplyContext::sendMoreData if QOS is
89 * @param conn Descriptor of socket to set the TOS for
90 * @param hierCode Hier code of request
92 int doTosLocalMiss(const Comm::ConnectionPointer
&conn
, const hier_code hierCode
);
95 * Function to work out and then apply to the socket the appropriate
96 * netfilter mark value to set on packets when items have not been
97 * retrieved from local cache. Called by clientReplyContext::sendMoreData
98 * if QOS is enabled for TOS.
99 * @param conn Descriptor of socket to set the mark for
100 * @param hierCode Hier code of request
102 int doNfmarkLocalMiss(const Comm::ConnectionPointer
&conn
, const hier_code hierCode
);
105 * Function to work out and then apply to the socket the appropriate
106 * TOS value to set on packets when items *have* been retrieved from
107 * local cache. Called by clientReplyContext::doGetMoreData if QOS is
109 * @param conn Descriptor of socket to set the TOS for
111 int doTosLocalHit(const Comm::ConnectionPointer
&conn
);
114 * Function to work out and then apply to the socket the appropriate
115 * netfilter mark value to set on packets when items *have* been
116 * retrieved from local cache. Called by clientReplyContext::doGetMoreData
117 * if QOS is enabled for TOS.
118 * @param conn Descriptor of socket to set the mark for
120 int doNfmarkLocalHit(const Comm::ConnectionPointer
&conn
);
123 * Function to set the TOS value of packets. Sets the value on the socket
124 * which then gets copied to the packets.
125 * @param conn Descriptor of socket to set the TOS for
127 _SQUID_INLINE_
int setSockTos(const Comm::ConnectionPointer
&conn
, tos_t tos
);
130 * Function to set the netfilter mark value of packets. Sets the value on the
131 * socket which then gets copied to the packets. Called from Ip::Qos::doNfmarkLocalMiss
132 * @param conn Descriptor of socket to set the mark for
134 _SQUID_INLINE_
int setSockNfmark(const Comm::ConnectionPointer
&conn
, nfmark_t mark
);
137 * QOS configuration class. Contains all the parameters for QOS functions as well
138 * as functions to check whether either TOS or MARK QOS is enabled.
147 void parseConfigLine();
150 * Dump all the configuration values
152 * NOTE: Due to the low-level nature of the library these
153 * objects are part of the dump function must be self-contained.
154 * which means no StoreEntry references. Just a basic char* buffer.
156 void dumpConfigLine(char *entry
, const char *name
) const;
158 /// Whether we should modify TOS flags based on cache hits and misses.
159 _SQUID_INLINE_
bool isHitTosActive() const;
161 /// Whether we should modify netfilter marks based on cache hits and misses.
162 _SQUID_INLINE_
bool isHitNfmarkActive() const;
165 * Iterates through any outgoing_nfmark or clientside_nfmark configuration parameters
166 * to find out if any Netfilter marking is required.
167 * This function is used on initialisation to define capabilities required (Netfilter
168 * marking requires CAP_NET_ADMIN).
170 _SQUID_INLINE_
bool isAclNfmarkActive() const;
173 * Iterates through any outgoing_tos or clientside_tos configuration parameters
174 * to find out if packets should be marked with TOS flags.
176 _SQUID_INLINE_
bool isAclTosActive() const;
178 tos_t tosLocalHit
; ///< TOS value to apply to local cache hits
179 tos_t tosSiblingHit
; ///< TOS value to apply to hits from siblings
180 tos_t tosParentHit
; ///< TOS value to apply to hits from parent
181 tos_t tosMiss
; ///< TOS value to apply to cache misses
182 tos_t tosMissMask
; ///< Mask for TOS value to apply to cache misses. Applied to the tosMiss value.
183 bool preserveMissTos
; ///< Whether to preserve the TOS value of the inbound packet for misses
184 tos_t preserveMissTosMask
; ///< The mask to apply when preserving the TOS of misses. Applies to preserved value from upstream.
186 nfmark_t markLocalHit
; ///< Netfilter mark value to apply to local cache hits
187 nfmark_t markSiblingHit
; ///< Netfilter mark value to apply to hits from siblings
188 nfmark_t markParentHit
; ///< Netfilter mark value to apply to hits from parent
189 nfmark_t markMiss
; ///< Netfilter mark value to apply to cache misses
190 nfmark_t markMissMask
; ///< Mask for netfilter mark value to apply to cache misses. Applied to the markMiss value.
191 bool preserveMissMark
; ///< Whether to preserve netfilter mark value of inbound connection
192 nfmark_t preserveMissMarkMask
; ///< The mask to apply when preserving the netfilter mark of misses. Applied to preserved value from upstream.
194 acl_tos
*tosToServer
; ///< The TOS that packets to the web server should be marked with, based on ACL
195 acl_tos
*tosToClient
; ///< The TOS that packets to the client should be marked with, based on ACL
196 acl_nfmark
*nfmarkToServer
; ///< The MARK that packets to the web server should be marked with, based on ACL
197 acl_nfmark
*nfmarkToClient
; ///< The MARK that packets to the client should be marked with, based on ACL
201 /// Globally available instance of Qos::Config
202 extern Config TheConfig
;
204 /* legacy parser access wrappers */
205 #define parse_QosConfig(X) (X)->parseConfigLine()
206 #define free_QosConfig(X)
207 #define dump_QosConfig(e,n,X) do { \
208 char temp[256]; /* random number. change as needed. max config line length. */ \
209 (X).dumpConfigLine(temp,n); \
210 storeAppendPrintf(e, "%s", temp); \
221 #endif /* SQUID_QOSCONFIG_H */