]>
Commit | Line | Data |
---|---|---|
63104e28 | 1 | /* |
f70aedc4 | 2 | * Copyright (C) 1996-2021 The Squid Software Foundation and contributors |
63104e28 | 3 | * |
bbc27441 AJ |
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. | |
63104e28 HN |
7 | */ |
8 | ||
bbc27441 AJ |
9 | /* DEBUG: section 39 Peer user hash based selection */ |
10 | ||
582c2af2 | 11 | #include "squid.h" |
2f1431ea AJ |
12 | |
13 | #if USE_AUTH | |
14 | ||
582c2af2 | 15 | #include "auth/UserRequest.h" |
a011edee | 16 | #include "CachePeer.h" |
582c2af2 FC |
17 | #include "globals.h" |
18 | #include "HttpRequest.h" | |
8822ebee | 19 | #include "mgr/Registration.h" |
f0ba2534 | 20 | #include "neighbors.h" |
cb365059 | 21 | #include "PeerSelectState.h" |
4d5904f7 | 22 | #include "SquidConfig.h" |
63104e28 | 23 | #include "Store.h" |
582c2af2 | 24 | |
074d6a40 | 25 | #include <cmath> |
63104e28 HN |
26 | |
27 | #define ROTATE_LEFT(x, n) (((x) << (n)) | ((x) >> (32-(n)))) | |
28 | ||
f7e1d9ce | 29 | static int n_userhash_peers = 0; |
a3c6762c | 30 | static CachePeer **userhash_peers = NULL; |
f7e1d9ce | 31 | static OBJH peerUserHashCachemgr; |
6b661f2e | 32 | static void peerUserHashRegisterWithCacheManager(void); |
63104e28 HN |
33 | |
34 | static int | |
35 | peerSortWeight(const void *a, const void *b) | |
36 | { | |
a3c6762c FC |
37 | const CachePeer *const *p1 = (const CachePeer *const *)a; |
38 | const CachePeer *const *p2 = (const CachePeer *const *)b; | |
63104e28 HN |
39 | return (*p1)->weight - (*p2)->weight; |
40 | } | |
41 | ||
42 | void | |
f7e1d9ce | 43 | peerUserHashInit(void) |
63104e28 HN |
44 | { |
45 | int W = 0; | |
46 | int K; | |
47 | int k; | |
48 | double P_last, X_last, Xn; | |
a3c6762c FC |
49 | CachePeer *p; |
50 | CachePeer **P; | |
63104e28 HN |
51 | char *t; |
52 | /* Clean up */ | |
53 | ||
5db6bf73 | 54 | for (k = 0; k < n_userhash_peers; ++k) { |
f7e1d9ce | 55 | cbdataReferenceDone(userhash_peers[k]); |
63104e28 HN |
56 | } |
57 | ||
f7e1d9ce HN |
58 | safe_free(userhash_peers); |
59 | n_userhash_peers = 0; | |
63104e28 HN |
60 | /* find out which peers we have */ |
61 | ||
6b661f2e FC |
62 | peerUserHashRegisterWithCacheManager(); |
63 | ||
63104e28 | 64 | for (p = Config.peers; p; p = p->next) { |
f7e1d9ce | 65 | if (!p->options.userhash) |
63104e28 HN |
66 | continue; |
67 | ||
68 | assert(p->type == PEER_PARENT); | |
69 | ||
70 | if (p->weight == 0) | |
71 | continue; | |
72 | ||
5db6bf73 | 73 | ++n_userhash_peers; |
63104e28 HN |
74 | |
75 | W += p->weight; | |
76 | } | |
77 | ||
f7e1d9ce | 78 | if (n_userhash_peers == 0) |
63104e28 HN |
79 | return; |
80 | ||
a3c6762c | 81 | userhash_peers = (CachePeer **)xcalloc(n_userhash_peers, sizeof(*userhash_peers)); |
63104e28 HN |
82 | |
83 | /* Build a list of the found peers and calculate hashes and load factors */ | |
f7e1d9ce HN |
84 | for (P = userhash_peers, p = Config.peers; p; p = p->next) { |
85 | if (!p->options.userhash) | |
63104e28 HN |
86 | continue; |
87 | ||
88 | if (p->weight == 0) | |
89 | continue; | |
90 | ||
91 | /* calculate this peers hash */ | |
f7e1d9ce | 92 | p->userhash.hash = 0; |
63104e28 | 93 | |
5db6bf73 | 94 | for (t = p->name; *t != 0; ++t) |
f7e1d9ce | 95 | p->userhash.hash += ROTATE_LEFT(p->userhash.hash, 19) + (unsigned int) *t; |
63104e28 | 96 | |
f7e1d9ce | 97 | p->userhash.hash += p->userhash.hash * 0x62531965; |
63104e28 | 98 | |
f7e1d9ce | 99 | p->userhash.hash = ROTATE_LEFT(p->userhash.hash, 21); |
63104e28 HN |
100 | |
101 | /* and load factor */ | |
f7e1d9ce | 102 | p->userhash.load_factor = ((double) p->weight) / (double) W; |
63104e28 | 103 | |
f7e1d9ce HN |
104 | if (floor(p->userhash.load_factor * 1000.0) == 0.0) |
105 | p->userhash.load_factor = 0.0; | |
63104e28 HN |
106 | |
107 | /* add it to our list of peers */ | |
108 | *P++ = cbdataReference(p); | |
109 | } | |
110 | ||
111 | /* Sort our list on weight */ | |
f7e1d9ce | 112 | qsort(userhash_peers, n_userhash_peers, sizeof(*userhash_peers), peerSortWeight); |
63104e28 HN |
113 | |
114 | /* Calculate the load factor multipliers X_k | |
115 | * | |
116 | * X_1 = pow ((K*p_1), (1/K)) | |
117 | * X_k = ([K-k+1] * [P_k - P_{k-1}])/(X_1 * X_2 * ... * X_{k-1}) | |
118 | * X_k += pow ((X_{k-1}, {K-k+1}) | |
119 | * X_k = pow (X_k, {1/(K-k+1)}) | |
120 | * simplified to have X_1 part of the loop | |
121 | */ | |
f7e1d9ce | 122 | K = n_userhash_peers; |
63104e28 | 123 | |
f53969cc | 124 | P_last = 0.0; /* Empty P_0 */ |
63104e28 | 125 | |
f53969cc | 126 | Xn = 1.0; /* Empty starting point of X_1 * X_2 * ... * X_{x-1} */ |
63104e28 | 127 | |
f53969cc | 128 | X_last = 0.0; /* Empty X_0, nullifies the first pow statement */ |
63104e28 | 129 | |
5db6bf73 | 130 | for (k = 1; k <= K; ++k) { |
63104e28 | 131 | double Kk1 = (double) (K - k + 1); |
f7e1d9ce HN |
132 | p = userhash_peers[k - 1]; |
133 | p->userhash.load_multiplier = (Kk1 * (p->userhash.load_factor - P_last)) / Xn; | |
134 | p->userhash.load_multiplier += pow(X_last, Kk1); | |
135 | p->userhash.load_multiplier = pow(p->userhash.load_multiplier, 1.0 / Kk1); | |
136 | Xn *= p->userhash.load_multiplier; | |
137 | X_last = p->userhash.load_multiplier; | |
138 | P_last = p->userhash.load_factor; | |
63104e28 HN |
139 | } |
140 | } | |
141 | ||
6b661f2e FC |
142 | static void |
143 | peerUserHashRegisterWithCacheManager(void) | |
63104e28 | 144 | { |
8822ebee | 145 | Mgr::RegisterAction("userhash", "peer userhash information", peerUserHashCachemgr, |
d9fc6862 | 146 | 0, 1); |
63104e28 HN |
147 | } |
148 | ||
a3c6762c | 149 | CachePeer * |
cb365059 | 150 | peerUserHashSelectParent(PeerSelector *ps) |
63104e28 HN |
151 | { |
152 | int k; | |
153 | const char *c; | |
a3c6762c FC |
154 | CachePeer *p = NULL; |
155 | CachePeer *tp; | |
63104e28 HN |
156 | unsigned int user_hash = 0; |
157 | unsigned int combined_hash; | |
158 | double score; | |
159 | double high_score = 0; | |
160 | const char *key = NULL; | |
161 | ||
f7e1d9ce | 162 | if (n_userhash_peers == 0) |
63104e28 HN |
163 | return NULL; |
164 | ||
cb365059 EB |
165 | assert(ps); |
166 | HttpRequest *request = ps->request; | |
167 | ||
a33a428a | 168 | if (request->auth_user_request != NULL) |
26ac0430 | 169 | key = request->auth_user_request->username(); |
eec27647 HN |
170 | |
171 | if (!key) | |
26ac0430 | 172 | return NULL; |
63104e28 HN |
173 | |
174 | /* calculate hash key */ | |
f7e1d9ce | 175 | debugs(39, 2, "peerUserHashSelectParent: Calculating hash for " << key); |
63104e28 | 176 | |
5db6bf73 | 177 | for (c = key; *c != 0; ++c) |
63104e28 HN |
178 | user_hash += ROTATE_LEFT(user_hash, 19) + *c; |
179 | ||
a3c6762c | 180 | /* select CachePeer */ |
5db6bf73 | 181 | for (k = 0; k < n_userhash_peers; ++k) { |
f7e1d9ce HN |
182 | tp = userhash_peers[k]; |
183 | combined_hash = (user_hash ^ tp->userhash.hash); | |
63104e28 HN |
184 | combined_hash += combined_hash * 0x62531965; |
185 | combined_hash = ROTATE_LEFT(combined_hash, 21); | |
f7e1d9ce | 186 | score = combined_hash * tp->userhash.load_multiplier; |
26ac0430 | 187 | debugs(39, 3, "peerUserHashSelectParent: " << tp->name << " combined_hash " << combined_hash << |
63104e28 HN |
188 | " score " << std::setprecision(0) << score); |
189 | ||
cb365059 | 190 | if ((score > high_score) && peerHTTPOkay(tp, ps)) { |
63104e28 HN |
191 | p = tp; |
192 | high_score = score; | |
193 | } | |
194 | } | |
195 | ||
196 | if (p) | |
f7e1d9ce | 197 | debugs(39, 2, "peerUserHashSelectParent: selected " << p->name); |
63104e28 HN |
198 | |
199 | return p; | |
200 | } | |
201 | ||
202 | static void | |
f7e1d9ce | 203 | peerUserHashCachemgr(StoreEntry * sentry) |
63104e28 | 204 | { |
a3c6762c | 205 | CachePeer *p; |
63104e28 HN |
206 | int sumfetches = 0; |
207 | storeAppendPrintf(sentry, "%24s %10s %10s %10s %10s\n", | |
208 | "Hostname", | |
209 | "Hash", | |
210 | "Multiplier", | |
211 | "Factor", | |
212 | "Actual"); | |
213 | ||
214 | for (p = Config.peers; p; p = p->next) | |
215 | sumfetches += p->stats.fetches; | |
216 | ||
217 | for (p = Config.peers; p; p = p->next) { | |
218 | storeAppendPrintf(sentry, "%24s %10x %10f %10f %10f\n", | |
f7e1d9ce HN |
219 | p->name, p->userhash.hash, |
220 | p->userhash.load_multiplier, | |
221 | p->userhash.load_factor, | |
63104e28 HN |
222 | sumfetches ? (double) p->stats.fetches / sumfetches : -1.0); |
223 | } | |
224 | } | |
2f1431ea AJ |
225 | |
226 | #endif /* USE_AUTH */ | |
f53969cc | 227 |