1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
/*
Unix SMB/CIFS implementation.
Winbind daemon connection manager
Copyright (C) Tim Potter 2001
Copyright (C) Andrew Bartlett 2002
Copyright (C) Gerald (Jerry) Carter 2003
Copyright (C) Marc VanHeyningen 2008
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "includes.h"
/**
* @file
* Negative connection cache implemented in terms of gencache API
*
* The negative connection cache stores names of servers which have
* been unresponsive so that we don't waste time repeatedly trying
* to contact them. It used to use an in-memory linked list, but
* this limited its utility to a single process
*/
/**
* prefix used for all entries put into the general cache
*/
static const char NEGATIVE_CONN_CACHE_PREFIX[] = "NEG_CONN_CACHE";
/**
* Marshalls the domain and server name into the key for the gencache
* record
*
* @param[in] domain required
* @param[in] server may be a FQDN or an IP address
* @return the resulting string, which the caller is responsible for
* SAFE_FREE()ing
* @retval NULL returned on error
*/
static char *negative_conn_cache_keystr(const char *domain, const char *server)
{
const char NEGATIVE_CONN_CACHE_KEY_FMT[] = "%s/%s,%s";
char *keystr = NULL;
SMB_ASSERT(domain != NULL);
if (server == NULL)
server = "";
keystr = talloc_asprintf(talloc_tos(),NEGATIVE_CONN_CACHE_KEY_FMT,
NEGATIVE_CONN_CACHE_PREFIX, domain, server);
if (keystr == NULL) {
DEBUG(0, ("negative_conn_cache_keystr: malloc error\n"));
}
return keystr;
}
/**
* Marshalls the NT status into a printable value field for the gencache
* record
*
* @param[in] status
* @return the resulting string, which the caller is responsible for
* SAFE_FREE()ing
* @retval NULL returned on error
*/
static char *negative_conn_cache_valuestr(NTSTATUS status)
{
char *valuestr = NULL;
valuestr = talloc_asprintf(talloc_tos(), "%x", NT_STATUS_V(status));
if (valuestr == NULL) {
DEBUG(0, ("negative_conn_cache_valuestr: malloc error\n"));
}
return valuestr;
}
/**
* Un-marshalls the NT status from a printable field for the gencache
* record
*
* @param[in] value The value field from the record
* @return the decoded NT status
* @retval NT_STATUS_OK returned on error
*/
static NTSTATUS negative_conn_cache_valuedecode(const char *value)
{
NTSTATUS result = NT_STATUS_OK;
SMB_ASSERT(value != NULL);
if (sscanf(value, "%x", &(NT_STATUS_V(result))) != 1)
DEBUG(0, ("negative_conn_cache_valuestr: unable to parse "
"value field '%s'\n", value));
return result;
}
/**
* Function passed to gencache_iterate to remove any matching items
* from the list
*
* @param[in] key Key to the record found and to be deleted
* @param[in] value Value to the record (ignored)
* @param[in] timeout Timeout remaining for the record (ignored)
* @param[in] dptr Handle for passing additional data (ignored)
*/
static void delete_matches(const char *key, const char *value,
time_t timeout, void *dptr)
{
gencache_del(key);
}
/**
* Checks for a given domain/server record in the negative cache
*
* @param[in] domain
* @param[in] server may be either a FQDN or an IP address
* @return The cached failure status
* @retval NT_STATUS_OK returned if no record is found or an error occurs
*/
NTSTATUS check_negative_conn_cache( const char *domain, const char *server)
{
NTSTATUS result = NT_STATUS_OK;
char *key = NULL;
char *value = NULL;
key = negative_conn_cache_keystr(domain, server);
if (key == NULL)
goto done;
if (gencache_get(key, &value, (time_t *) NULL))
result = negative_conn_cache_valuedecode(value);
done:
DEBUG(9,("check_negative_conn_cache returning result %d for domain %s "
"server %s\n", NT_STATUS_V(result), domain, server));
TALLOC_FREE(key);
SAFE_FREE(value);
return result;
}
/**
* Delete any negative cache entry for the given domain/server
*
* @param[in] domain
* @param[in] server may be either a FQDN or an IP address
*/
void delete_negative_conn_cache(const char *domain, const char *server)
{
char *key = NULL;
key = negative_conn_cache_keystr(domain, server);
if (key == NULL)
goto done;
gencache_del(key);
DEBUG(9,("delete_negative_conn_cache removing domain %s server %s\n",
domain, server));
done:
TALLOC_FREE(key);
return;
}
/**
* Add an entry to the failed connection cache
*
* @param[in] domain
* @param[in] server may be a FQDN or an IP addr in printable form
* @param[in] result error to cache; must not be NT_STATUS_OK
*/
void add_failed_connection_entry(const char *domain, const char *server,
NTSTATUS result)
{
char *key = NULL;
char *value = NULL;
SMB_ASSERT(!NT_STATUS_IS_OK(result));
key = negative_conn_cache_keystr(domain, server);
if (key == NULL) {
DEBUG(0, ("add_failed_connection_entry: key creation error\n"));
goto done;
}
value = negative_conn_cache_valuestr(result);
if (value == NULL) {
DEBUG(0, ("add_failed_connection_entry: value creation error\n"));
goto done;
}
if (gencache_set(key, value,
time((time_t *) NULL)
+ FAILED_CONNECTION_CACHE_TIMEOUT))
DEBUG(9,("add_failed_connection_entry: added domain %s (%s) "
"to failed conn cache\n", domain, server ));
else
DEBUG(1,("add_failed_connection_entry: failed to add "
"domain %s (%s) to failed conn cache\n",
domain, server));
done:
TALLOC_FREE(key);
TALLOC_FREE(value);
return;
}
/**
* Deletes all records from the negative connection cache in all domains
*/
void flush_negative_conn_cache( void )
{
flush_negative_conn_cache_for_domain("*");
}
/**
* Deletes all records for a specified domain from the negative connection
* cache
*
* @param[in] domain String to match against domain portion of keys, or "*"
* to match all domains
*/
void flush_negative_conn_cache_for_domain(const char *domain)
{
char *key_pattern = NULL;
key_pattern = negative_conn_cache_keystr(domain,"*");
if (key_pattern == NULL) {
DEBUG(0, ("flush_negative_conn_cache_for_domain: "
"key creation error\n"));
goto done;
}
gencache_iterate(delete_matches, (void *) NULL, key_pattern);
DEBUG(8, ("flush_negative_conn_cache_for_domain: flushed domain %s\n",
domain));
done:
TALLOC_FREE(key_pattern);
return;
}
|
