-
Notifications
You must be signed in to change notification settings - Fork 131
/
CacheExceptionUtils.java
244 lines (208 loc) · 9.03 KB
/
CacheExceptionUtils.java
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
/*
COPYRIGHT STATUS:
Dec 1st 2001, Fermi National Accelerator Laboratory (FNAL) documents and
software are sponsored by the U.S. Department of Energy under Contract No.
DE-AC02-76CH03000. Therefore, the U.S. Government retains a world-wide
non-exclusive, royalty-free license to publish or reproduce these documents
and software for U.S. Government purposes. All documents and software
available from this server are protected under the U.S. and Foreign
Copyright Laws, and FNAL reserves all rights.
Distribution of the software available from this server is free of
charge subject to the user following the terms of the Fermitools
Software Legal Information.
Redistribution and/or modification of the software shall be accompanied
by the Fermitools Software Legal Information (including the copyright
notice).
The user is asked to feed back problems, benefits, and/or suggestions
about the software to the Fermilab Software Providers.
Neither the name of Fermilab, the URA, nor the names of the contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
DISCLAIMER OF LIABILITY (BSD):
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL FERMILAB,
OR THE URA, OR THE U.S. DEPARTMENT of ENERGY, OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Liabilities of the Government:
This software is provided by URA, independent from its Prime Contract
with the U.S. Department of Energy. URA is acting independently from
the Government and in its own private capacity and is not acting on
behalf of the U.S. Government, nor as its contractor nor its agent.
Correspondingly, it is understood and agreed that the U.S. Government
has no connection to this software and in no manner whatsoever shall
be liable for nor assume any responsibility or obligation for any claim,
cost, or damages arising out of or resulting from the use of the software
available from this server.
Export Control:
All documents and software available from this server are subject to U.S.
export control laws. Anyone downloading information from this server is
obligated to secure any necessary Government licenses before exporting
documents or software obtained from this server.
*/
package org.dcache.qos.util;
import static org.dcache.qos.util.CacheExceptionUtils.FailureType.FATAL;
import static org.dcache.qos.util.CacheExceptionUtils.FailureType.NEWSOURCE;
import static org.dcache.qos.util.CacheExceptionUtils.FailureType.NEWTARGET;
import static org.dcache.qos.util.CacheExceptionUtils.FailureType.RETRIABLE;
import com.google.common.base.Throwables;
import diskCacheV111.util.CacheException;
import diskCacheV111.util.PnfsId;
import java.io.Serializable;
import java.util.concurrent.ExecutionException;
import org.dcache.qos.data.QoSAction;
import org.dcache.util.CacheExceptionFactory;
/**
* Wrapper methods for processing and handling {@link CacheException}s.
*/
public final class CacheExceptionUtils {
static final String WILL_RETRY_LATER
= " A best effort at retry will be made during the next periodic scan.";
public static boolean replicaNotFound(Serializable object) {
if (object instanceof ExecutionException) {
ExecutionException exception = (ExecutionException) object;
object = exception.getCause();
}
if (object instanceof CacheException) {
CacheException exception = (CacheException) object;
switch (exception.getRc()) {
case CacheException.FILE_NOT_FOUND:
case CacheException.FILE_NOT_IN_REPOSITORY:
/*
* For the purposes of remove we can consider this equivalent.
*/
case CacheException.TIMEOUT:
return true;
}
}
return false;
}
public static CacheException getCacheExceptionFrom(Serializable errorObject) {
if (errorObject instanceof CacheException) {
return (CacheException) errorObject;
}
if (errorObject instanceof Throwable) {
Throwable t = (Throwable) errorObject;
return new CacheException(t.getMessage(), Throwables.getRootCause(t));
}
return new CacheException(String.valueOf(errorObject));
}
public static String getCacheExceptionErrorMessage(String template,
PnfsId pnfsid,
QoSAction type,
String info,
Throwable e) {
Object[] args = new Object[3];
args[0] = pnfsid;
args[1] = info == null ? "" : info;
args[2] = e == null ? "" : new ExceptionMessage(e);
return String.format(template, args);
}
/**
* @param rc error code for CacheException
* @param template string formatting, must have three '%' markers.
* @param pnfsid of the file operation
* @param type of operation
* @param info
* @param e
* @return appropriate CacheException to be propagated.
*/
public static CacheException getCacheException(int rc,
String template,
PnfsId pnfsid,
QoSAction type,
String info,
Throwable e) {
String message = getCacheExceptionErrorMessage(template, pnfsid, type, info, e);
FailureType failureType = getFailureType(rc, type);
if (failureType != FATAL) {
message += WILL_RETRY_LATER;
}
if (e != null) {
return CacheExceptionFactory.exceptionOf(rc, message, e);
}
return CacheExceptionFactory.exceptionOf(rc, message);
}
public static FailureType getFailureType(CacheException exception,
QoSAction type) {
if (exception == null) {
return RETRIABLE;
}
return getFailureType(exception.getRc(), type);
}
private static FailureType getFailureType(int rc, QoSAction type) {
switch (rc) {
case CacheException.FILE_NOT_IN_REPOSITORY:
/*
* Given that replicas can be made from cached copies by
* promoting the file, we need to distinguish clearly
* between this error on an actual copy, indicating
* faulty source, or on set sticky, indicating faulty
* target.
*
* For caching, instead of failing, we allow the
* operation to reverify.
*/
switch (type) {
case COPY_REPLICA:
return NEWSOURCE;
case PERSIST_REPLICA:
return NEWTARGET;
case CACHE_REPLICA:
return RETRIABLE;
default:
return FATAL;
}
/*
*
* The replica already exists on this target.
*/
case CacheException.FILE_IN_CACHE:
return NEWTARGET;
/*
* These are transient source errors.
*/
case CacheException.LOCKED:
case CacheException.FILE_IS_NEW:
case CacheException.HSM_DELAY_ERROR:
/*
* There is not enough information to know whether
* these involve the source or target.
*
* The logic of the verification service, however, is
* to retry these for the indicated number of times,
* and if we continue to fail, the source and target are
* both marked tried, and an attempt with a new source
* and target is made, if possible.
*/
case CacheException.NO_POOL_CONFIGURED:
case CacheException.NO_POOL_ONLINE:
case CacheException.POOL_DISABLED:
case CacheException.SELECTED_POOL_FAILED:
case CacheException.PERMISSION_DENIED:
case CacheException.SERVICE_UNAVAILABLE:
case CacheException.TIMEOUT:
return RETRIABLE;
/*
* Nothing further can be done.
*/
case CacheException.FILE_CORRUPTED:
case CacheException.BROKEN_ON_TAPE:
case CacheException.FILE_NOT_FOUND:
default:
return FATAL;
}
}
public enum FailureType {
NEWTARGET, NEWSOURCE, FATAL, RETRIABLE
}
private CacheExceptionUtils() {
}
}