forked from YahooArchive/oozie
-
Notifications
You must be signed in to change notification settings - Fork 0
/
XCommand.java
448 lines (411 loc) · 15.2 KB
/
XCommand.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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
/**
* Copyright (c) 2010 Yahoo! Inc. All rights reserved.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License. See accompanying LICENSE file.
*/
package org.apache.oozie.command;
import org.apache.oozie.ErrorCode;
import org.apache.oozie.FaultInjection;
import org.apache.oozie.XException;
import org.apache.oozie.service.CallableQueueService;
import org.apache.oozie.service.InstrumentationService;
import org.apache.oozie.service.MemoryLocksService;
import org.apache.oozie.service.Services;
import org.apache.oozie.util.Instrumentation;
import org.apache.oozie.util.MemoryLocks;
import org.apache.oozie.util.XCallable;
import org.apache.oozie.util.XLog;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
/**
* Base class for synchronous and asynchronous commands.
* <p/>
* It enables by API the following pattern:
* <p/>
* <ul>
* <li>single execution: a command instance can be executed only once</li>
* <li>eager data loading: loads data for eager precondition check</li>
* <li>eager precondition check: verify precondition before obtaining lock</li>
* <li>data loading: loads data for precondition check and execution</li>
* <li>precondition check: verifies precondition for execution is still met</li>
* <li>locking: obtains exclusive lock on key before executing the command</li>
* <li>execution: command logic</li>
* </ul>
* <p/>
* It has built in instrumentation and logging.
*/
public abstract class XCommand<T> implements XCallable<T> {
public static final String DEFAULT_LOCK_TIMEOUT = "oozie.command.default.lock.timeout";
public static final String INSTRUMENTATION_GROUP = "commands";
public static final Long DEFAULT_REQUEUE_DELAY = 10L;
public XLog LOG = XLog.getLog(getClass());
private String key;
private String name;
private int priority;
private String type;
private long createdTime;
private MemoryLocks.LockToken lock;
private boolean used = false;
private Map<Long, List<XCommand<?>>> commandQueue;
protected boolean dryrun = false;
protected Instrumentation instrumentation;
protected XLog.Info logInfo;
/**
* Create a command.
*
* @param name command name.
* @param type command type.
* @param priority command priority.
*/
public XCommand(String name, String type, int priority) {
this.name = name;
this.type = type;
this.priority = priority;
this.key = name + "_" + UUID.randomUUID();
createdTime = System.currentTimeMillis();
logInfo = new XLog.Info();
instrumentation = Services.get().get(InstrumentationService.class).get();
}
/**
* @param name command name.
* @param type command type.
* @param priority command priority.
* @param dryrun indicates if dryrun option is enabled. if enabled bundle will show a diagnostic output without
* really running the job
*/
public XCommand(String name, String type, int priority, boolean dryrun) {
this(name, type, priority);
this.dryrun = dryrun;
}
/**
* Return the command name.
*
* @return the command name.
*/
@Override
public String getName() {
return name;
}
/**
* Return the callable type.
* <p/>
* The command type is used for concurrency throttling in the {@link CallableQueueService}.
*
* @return the command type.
*/
@Override
public String getType() {
return type;
}
/**
* Return the priority of the command.
*
* @return the command priority.
*/
@Override
public int getPriority() {
return priority;
}
/**
* Returns the creation time of the command.
*
* @return the command creation time, in milliseconds.
*/
@Override
public long getCreatedTime() {
return createdTime;
}
/**
* Queue a command for execution after the current command execution completes.
* <p/>
* All commands queued during the execution of the current command will be queued for a single serial execution.
* <p/>
* If the command execution throws an exception, no command will be effectively queued.
*
* @param command command to queue.
*/
protected void queue(XCommand<?> command) {
queue(command, 0);
}
/**
* Queue a command for delayed execution after the current command execution completes.
* <p/>
* All commands queued during the execution of the current command with the same delay will be queued for a single
* serial execution.
* <p/>
* If the command execution throws an exception, no command will be effectively queued.
*
* @param command command to queue.
* @param msDelay delay in milliseconds.
*/
protected void queue(XCommand<?> command, long msDelay) {
if (commandQueue == null) {
commandQueue = new HashMap<Long, List<XCommand<?>>>();
}
List<XCommand<?>> list = commandQueue.get(msDelay);
if (list == null) {
list = new ArrayList<XCommand<?>>();
commandQueue.put(msDelay, list);
}
list.add(command);
}
/**
* Obtain an exclusive lock on the {link #getEntityKey}.
* <p/>
* A timeout of {link #getLockTimeOut} is used when trying to obtain the lock.
*
* @throws InterruptedException thrown if an interruption happened while trying to obtain the lock
* @throws CommandException thrown i the lock could not be obtained.
*/
private void acquireLock() throws InterruptedException, CommandException {
lock = Services.get().get(MemoryLocksService.class).getWriteLock(getEntityKey(), getLockTimeOut());
if (lock == null) {
Instrumentation instrumentation = Services.get().get(InstrumentationService.class).get();
instrumentation.incr(INSTRUMENTATION_GROUP, getName() + ".lockTimeOut", 1);
if (isReQueueRequired()) {
//if not acquire the lock, re-queue itself with default delay
resetUsed();
queue(this, getRequeueDelay());
LOG.debug("Could not get lock [{0}], timed out [{1}]ms, and requeue itself [{2}]", this.toString(), getLockTimeOut(), getName());
} else {
throw new CommandException(ErrorCode.E0606, this.toString(), getLockTimeOut());
}
} else {
LOG.debug("Acquired lock for [{0}] in [{1}]", getEntityKey(), getName());
}
}
/**
* Release the lock on the {link #getEntityKey}.
*/
private void releaseLock() {
if (lock != null) {
lock.release();
LOG.debug("Released lock for [{0}] in [{1}]", getEntityKey(), getName());
}
}
/**
* Implements the XCommand life-cycle.
*
* @return the {link #execute} return value.
* @throws Exception thrown if the command could not be executed.
*/
@Override
public final T call() throws CommandException {
if (used) {
throw new IllegalStateException(this.getClass().getSimpleName() + " already used.");
}
used = true;
commandQueue = null;
Instrumentation instrumentation = Services.get().get(InstrumentationService.class).get();
instrumentation.incr(INSTRUMENTATION_GROUP, getName() + ".executions", 1);
Instrumentation.Cron callCron = new Instrumentation.Cron();
try {
callCron.start();
eagerLoadState();
LOG = XLog.resetPrefix(LOG);
eagerVerifyPrecondition();
try {
T ret = null;
if (isLockRequired()) {
Instrumentation.Cron acquireLockCron = new Instrumentation.Cron();
acquireLockCron.start();
acquireLock();
acquireLockCron.stop();
instrumentation.addCron(INSTRUMENTATION_GROUP, getName() + ".acquireLock", acquireLockCron);
}
if (!isLockRequired() || (isLockRequired() && lock != null)) {
LOG.debug("Load state for [{0}]", getEntityKey());
loadState();
LOG = XLog.resetPrefix(LOG);
LOG.debug("Precondition check for command [{0}] key [{1}]", getName(), getEntityKey());
verifyPrecondition();
LOG.debug("Execute command [{0}] key [{1}]", getName(), getEntityKey());
Instrumentation.Cron executeCron = new Instrumentation.Cron();
executeCron.start();
ret = execute();
executeCron.stop();
instrumentation.addCron(INSTRUMENTATION_GROUP, getName() + ".execute", executeCron);
}
if (commandQueue != null) {
CallableQueueService callableQueueService = Services.get().get(CallableQueueService.class);
for (Map.Entry<Long, List<XCommand<?>>> entry : commandQueue.entrySet()) {
LOG.debug("Queuing [{0}] commands with delay [{1}]ms", entry.getValue().size(), entry.getKey());
if (!callableQueueService.queueSerial(entry.getValue(), entry.getKey())) {
LOG.warn("Could not queue [{0}] commands with delay [{1}]ms, queue full", entry.getValue()
.size(), entry.getKey());
}
}
}
return ret;
}
finally {
if (isLockRequired()) {
releaseLock();
}
}
}
catch(PreconditionException pex){
LOG.warn(pex.getMessage().toString() + ", Error Code: " + pex.getErrorCode().toString());
instrumentation.incr(INSTRUMENTATION_GROUP, getName() + ".preconditionfailed", 1);
return null;
}
catch (XException ex) {
LOG.error("XException, ", ex);
instrumentation.incr(INSTRUMENTATION_GROUP, getName() + ".xexceptions", 1);
if (ex instanceof CommandException) {
throw (CommandException) ex;
}
else {
throw new CommandException(ex);
}
}
catch (Exception ex) {
LOG.error("Exception, ", ex);
instrumentation.incr(INSTRUMENTATION_GROUP, getName() + ".exceptions", 1);
throw new CommandException(ErrorCode.E0607, ex);
}
finally {
FaultInjection.deactivate("org.apache.oozie.command.SkipCommitFaultInjection");
callCron.stop();
instrumentation.addCron(INSTRUMENTATION_GROUP, getName() + ".call", callCron);
}
}
/**
* Return the time out when acquiring a lock.
* <p/>
* The value is loaded from the Oozie configuration, the property {link #DEFAULT_LOCK_TIMEOUT}.
* <p/>
* Subclasses should override this method if they want to use a different time out.
*
* @return the lock time out in milliseconds.
*/
protected long getLockTimeOut() {
return Services.get().getConf().getLong(DEFAULT_LOCK_TIMEOUT, 5 * 1000);
}
/**
* Indicate if the the command requires locking.
* <p/>
* Subclasses should override this method if they require locking.
*
* @return <code>true/false</code>
*/
protected abstract boolean isLockRequired();
/**
* Return the entity key for the command.
* <p/>
*
* @return the entity key for the command.
*/
protected abstract String getEntityKey();
/**
* Indicate if the the command requires to requeue itself if the lock is not acquired.
* <p/>
* Subclasses should override this method if they don't want to requeue.
* <p/>
* Default is true.
*
* @return <code>true/false</code>
*/
protected boolean isReQueueRequired() {
return true;
}
/**
* Load the necessary state to perform an eager precondition check.
* <p/>
* This implementation does a NOP.
* <p/>
* Subclasses should override this method and load the state needed to do an eager precondition check.
* <p/>
* A trivial implementation is calling {link #loadState}.
*/
protected void eagerLoadState() throws CommandException{
}
/**
* Verify the precondition for the command before obtaining a lock.
* <p/>
* This implementation does a NOP.
* <p/>
* A trivial implementation is calling {link #verifyPrecondition}.
*
* @throws CommandException thrown if the precondition is not met.
*/
protected void eagerVerifyPrecondition() throws CommandException,PreconditionException {
}
/**
* Load the necessary state to perform the precondition check and to execute the command.
* <p/>
* Subclasses must implement this method and load the state needed to do the precondition check and execute the
* command.
*/
protected abstract void loadState() throws CommandException;
/**
* Verify the precondition for the command after a lock has been obtain, just before executing the command.
* <p/>
*
* @throws CommandException thrown if the precondition is not met.
*/
protected abstract void verifyPrecondition() throws CommandException,PreconditionException;
/**
* Command execution body.
* <p/>
* This method will be invoked after the {link #loadState} and {link #verifyPrecondition} methods.
* <p/>
* If the command requires locking, this method will be invoked ONLY if the lock has been acquired.
*
* @return a return value from the execution of the command, only meaningful if the command is executed
* synchronously.
* @throws CommandException thrown if the command execution failed.
*/
protected abstract T execute() throws CommandException;
/**
* Return the {@link Instrumentation} instance in use.
*
* @return the {@link Instrumentation} instance in use.
*/
protected Instrumentation getInstrumentation() {
return instrumentation;
}
/**
* @param used set false to the used
*/
public void resetUsed() {
this.used = false;
}
/**
* Return the delay time for requeue
*
* @return delay time when requeue itself
*/
protected Long getRequeueDelay() {
return DEFAULT_REQUEUE_DELAY;
}
/**
* Get command key
*
* @return command key
*/
@Override
public String getKey(){
return this.key;
}
/**
* Get XLog log
*
* @return XLog
*/
public XLog getLog() {
return LOG;
}
}