/
task.py
1386 lines (1208 loc) · 46.9 KB
/
task.py
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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# Copyright 2009-2017 Red Hat, Inc.
#
# 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 2 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, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#
# Refer to the README and COPYING files for full details of the license
#
'''
Tasks: tasks object model some sort of VDSM task (storage task).
A task object may be standalone (unmanaged task), but then it is limited
and cannot be automatically persisted or run (asynchronous jobs).
A managed task is managed by a TaskManager. Under the task manager a task
may persist itself, run asynchronous jobs, run recovery procedures, etc.
A task is successful if it finished its operations during the
prepare state (i.e. it did not schedule any async jobs), or all its
scheduled jobs complete without error.
The task result is the prepare state result if no async jobs are scheduled,
or the result of the last job run.
Jobs: jobs object model an asynchronous job that is run in a context of a
thread belonging to a thread pool (and managed by the task manager).
Currently a task may schedule any number of jobs that run sequentially by
the same worker thread.
Recovery: recovery objects model a recovery operation required to restore
the system to a known coherent state. A task may register several recovery
objects that are kept in a stack (the last recovery registered is run
first - lifo).
Tasks that have "auto" recovery policy run the recovery procedure
("rollback"),
in any case of task failure/abort, and immediately after the task is
recovered (loaded) from its persisted store.
'''
from __future__ import absolute_import
import logging
import os
import threading
import uuid
from contextlib import contextmanager
from functools import wraps
from weakref import proxy
import six
from vdsm.common import concurrent
from vdsm.common.logutils import SimpleLogAdapter
from vdsm.common.threadlocal import vars
from vdsm.config import config
from vdsm.storage import exception as se
from vdsm.storage import constants as sc
from vdsm.storage import outOfProcess as oop
from vdsm.storage import resourceManager
KEY_SEPARATOR = "="
KEY_SEPARATOR_ENCODED = "_eq_"
TASK_EXT = ".task"
JOB_EXT = ".job"
RESOURCE_EXT = ".resource"
RECOVER_EXT = ".recover"
RESULT_EXT = ".result"
BACKUP_EXT = ".backup"
TEMP_EXT = ".temp"
NUM_SEP = "."
FIELD_SEP = ","
TASK_METADATA_VERSION = 1
ROLLBACK_SENTINEL = "rollback sentinel"
def getProcPool():
return oop.getProcessPool(sc.GLOBAL_OOP)
def _eq_encode(s):
if KEY_SEPARATOR_ENCODED in s:
raise ValueError("%s includes %s" % (s, KEY_SEPARATOR_ENCODED))
return s.replace(KEY_SEPARATOR, KEY_SEPARATOR_ENCODED)
def _eq_decode(s):
return s.replace(KEY_SEPARATOR_ENCODED, KEY_SEPARATOR)
def threadlocal_task(m):
"""
Decorator that set the task object in thread local storage task attribute
while the decorated method is running.
"""
@wraps(m)
def wrapper(self, *a, **kw):
vars.task = self
try:
return m(self, *a, **kw)
finally:
vars.task = None
return wrapper
class State:
unknown = "unknown"
init = "init"
preparing = "preparing"
blocked = "blocked"
acquiring = "acquiring"
queued = "queued"
running = "running"
finished = "finished"
aborting = "aborting"
waitrecover = "waitrecover"
recovering = "recovering"
racquiring = "racquiring"
raborting = "raborting"
recovered = "recovered"
failed = "failed"
# For backward compatibility, inner states can be translated to
# previously supported
# format of state and result
DEPRECATED_STATE = {
unknown: "unknown",
init: "init",
preparing: "running",
blocked: "running",
acquiring: "running",
queued: "running",
running: "running",
finished: "finished",
aborting: "aborting",
waitrecover: "cleaning",
recovering: "cleaning",
racquiring: "cleaning",
raborting: "aborting",
recovered: "finished",
failed: "finished"
}
DEPRECATED_RESULT = {
unknown: "",
init: "",
preparing: "",
blocked: "",
acquiring: "",
queued: "",
running: "",
finished: "success",
aborting: "",
waitrecover: "",
recovering: "",
racquiring: "",
raborting: "",
recovered: "cleanSuccess",
failed: "cleanFailure"
}
# valid state transitions: newstate <- [from states]
_moveto = {
unknown: [],
init: [],
preparing: [init, blocked],
blocked: [preparing],
acquiring: [preparing, acquiring],
queued: [acquiring, running],
running: [queued],
finished: [running, preparing],
aborting: [preparing, blocked, acquiring, queued, running],
waitrecover: [aborting],
racquiring: [aborting, finished, racquiring, waitrecover],
recovering: [racquiring],
raborting: [racquiring, recovering, waitrecover],
recovered: [recovering],
failed: [recovering, aborting, raborting],
}
_done = [finished, recovered, failed]
_recovering = [racquiring, recovering]
def __init__(self, state=None):
try:
if not state:
self.state = self.unknown
else:
self.state = getattr(self, state)
except:
self.state = self.unknown
def value(self):
return self.state
def isDone(self):
return self.state in self._done
def isRecovering(self):
return self.state in self._recovering
def canAbort(self):
return self.state in self._moveto[self.aborting]
def canAbortRecovery(self):
return self.state in self._moveto[self.raborting]
def __str__(self):
return self.state
def moveto(self, state, force=False):
if state not in self._moveto:
raise ValueError("not a valid target state: %s" % state)
if not force and self.state not in self._moveto[state]:
raise se.TaskStateTransitionError("from %s to %s" %
(self.state, state))
self.state = state
def __eq__(self, state):
return self.state == state
def __ne__(self, state):
return self.state != state
class EnumType(object):
def __init__(self, enum):
if not getattr(self, enum, None):
raise ValueError("%s not a valid type for %s" % (enum, repr(self)))
self.value = enum
def __str__(self):
return str(self.value)
def __eq__(self, x):
if type(x) == str:
return self.value == x
if isinstance(x, self):
return x.value == self.value
return False
def __ne__(self, x):
return not self.__eq__(x)
class TaskPersistType(EnumType):
none = "none"
manual = "manual"
auto = "auto"
class TaskCleanType(EnumType):
none = "none"
manual = "manual"
auto = "auto"
class TaskRecoveryType(EnumType):
none = "none"
manual = "manual"
auto = "auto"
class ParamList:
def __init__(self, params="", sep=FIELD_SEP):
self.sep = sep
if not params:
self.params = ""
if type(params) == list:
for i in params:
if not isinstance(i, six.string_types):
raise ValueError("ParamsList: param item %s not a string"
" (%s)" % (i, type(i)))
if sep in i:
raise ValueError("ParamsList: sep %s in %s" % (sep, i))
self.params = params
elif isinstance(params, six.string_types):
self.params = [s.strip() for s in params.split(sep)]
else:
raise ValueError("ParamList: params type not supported (%s)" %
type(params))
def getList(self):
return self.params[:]
def __str__(self):
s = ""
for i in self.params:
s += six.text_type(i) + self.sep
# remove last sep
if s:
s = s[:-1]
return s
class Job:
fields = {
"name": six.text_type,
"runcmd": six.text_type,
}
def __init__(self, name, cmd, *argslist, **argsdict):
self.name = name
self.cmd = cmd # function pointer to run
self.argslist = argslist
self.argsdict = argsdict
self.runcmd = "%r (args: %s kwargs: %s)" % (cmd, argslist, argsdict)
self.callback = None # callback to call before running the job
self.task = None
def setCallback(self, callback):
if not callable(callback):
raise ValueError("Task.Job: callback %s is not callable" %
repr(callback))
self.callback = callback
def setOwnerTask(self, task):
self.task = proxy(task)
def run(self):
if not self.task:
raise se.InvalidJob("Job %s: no parent task" % self)
self.task.log.debug("Job.run: running %s callback %r",
self, self.callback)
if self.callback:
self.callback(self)
return self.cmd(*self.argslist, **self.argsdict)
def __str__(self):
return "%s: %s" % (self.name, self.runcmd)
class Recovery:
'''
A recovery object is used to register a recovery function to
the recovery process.
The recovery functions are kept in a stack so they are carried out
in FILO order.
The recovery function itself must be a static/class binded method of
a visible class.
The recovery function must accept a recovery object as the first
parameter - fn(recovery, ...)
All other parameters if any must be strings.
'''
fields = {
"name": six.text_type,
"moduleName": six.text_type,
"object": six.text_type,
"function": six.text_type,
"params": ParamList,
}
def __init__(self, name, modname, objname, fnname, argslist):
self.name = name
self.validateName(modname)
self.validateName(objname)
self.validateName(modname)
self.validateName(fnname)
self.object = objname
self.moduleName = modname
self.function = fnname
self.params = ParamList(argslist)
self.callback = None
self.task = None
def validateName(self, name):
vname = name.replace("_", "")
if not vname.isalnum():
raise TypeError("Parameter %s must be a plain str" % name)
def setCallback(self, callback):
if not callable(callback):
raise ValueError("Task.Recovery: callback %s is not callable" %
repr(callback))
self.task.log.debug("Recovery.run: running %s callback %r",
self, self.callback)
self.callback = callback
def setOwnerTask(self, task):
self.task = proxy(task)
def run(self):
if not self.task:
raise se.InvalidRecovery("Recovery - %s: no parent task" % self)
self.validateName(self.object)
self.validateName(self.function)
if self.callback:
self.callback(self)
# instantiate an object of class "self.object" (bad name)
module = __import__('vdsm.storage.' + self.moduleName,
locals(), globals(),
[self.moduleName])
classObj = getattr(module, self.object)
function = getattr(classObj, self.function)
argslist = self.params.getList()
return function(self.task, *argslist)
def __str__(self):
return "%s: %s->%s(%s)" % (self.name,
self.object,
self.function,
self.params)
class TaskResult(object):
fields = {
"code": int,
"message": six.text_type,
"result": six.text_type,
}
def __init__(self, code=0, message="", result=""):
self.code = code
self.message = message
self.result = result
def toDict(self):
return dict(message=self.message,
code=str(self.code),
result=self.result)
def __str__(self):
return "Task result: %s - %s: %s" % (self.code,
self.message,
self.result)
class TaskPriority(EnumType):
low = "low"
medium = "medium"
high = "high"
class Task:
# External Task info
fields = {
# field_name: type
"id": str,
"name": six.text_type,
"tag": six.text_type,
"store": six.text_type,
"recoveryPolicy": TaskRecoveryType,
"persistPolicy": TaskPersistType,
"cleanPolicy": TaskCleanType,
"priority": TaskPriority,
"state": State,
"njobs": int,
"nrecoveries": int,
"metadataVersion": int
}
log = logging.getLogger('storage.TaskManager.Task')
def __init__(self, id, name="", tag="",
recovery=TaskRecoveryType.none,
priority=TaskPriority.low):
"""
id - Unique ID
name - human readable name
persist - persistency type: auto-clean/manual-clean/not-persistent
"""
if not id:
id = str(uuid.uuid4())
self.metadataVersion = TASK_METADATA_VERSION
self.validateID(id)
self.lock = threading.Lock()
self.callbackLock = threading.Lock()
self.id = str(id)
self.name = name
self.tag = tag
self.priority = priority
self.recoveryPolicy = recovery
self.persistPolicy = TaskPersistType.none
self.cleanPolicy = TaskCleanType.auto
self.store = None
self.defaultException = None
self.state = State(State.init)
self.result = TaskResult(0, "Task is initializing", "")
self.resOwner = resourceManager.Owner(proxy(self), raiseonfailure=True)
self.error = se.TaskAborted("Unknown error encountered")
self.mng = None
self._abort_lock = threading.Lock()
self._abort_callbacks = set()
self._aborting = False
self._forceAbort = False
self.ref = 0
self.recoveries = []
self.jobs = []
self.nrecoveries = 0 # just utility count - used by save/load
self.njobs = 0 # just utility count - used by save/load
self.log = SimpleLogAdapter(self.log, {"Task": self.id})
def __del__(self):
def finalize(log, owner, taskDir):
log.warn("Task was autocleaned")
owner.releaseAll()
if taskDir is not None:
getProcPool().fileUtils.cleanupdir(taskDir)
if not self.state.isDone():
taskDir = None
if (self.cleanPolicy == TaskCleanType.auto and
self.store is not None):
taskDir = os.path.join(self.store, self.id)
t = concurrent.thread(
finalize,
args=(self.log, self.resOwner, taskDir),
name="task/" + self.id[:8])
t.start()
def _done(self):
self.resOwner.releaseAll()
if self.cleanPolicy == TaskCleanType.auto:
self.clean()
def __state_preparing(self, fromState):
pass
def __state_blocked(self, fromState):
pass
def __state_acquiring(self, fromState):
if self.resOwner.requestsGranted():
self._updateState(State.queued)
def __state_queued(self, fromState):
try:
self.mng.queue(self)
except Exception as e:
self._setError(e)
self.stop()
def __state_running(self, fromState):
self._runJobs()
def __state_finished(self, fromState):
self._done()
def __state_aborting(self, fromState):
if self.ref > 1:
return
self.log.debug("_aborting: recover policy %s", self.recoveryPolicy)
if self.recoveryPolicy == TaskRecoveryType.auto:
self._updateState(State.racquiring)
elif self.recoveryPolicy == TaskRecoveryType.none:
self._updateState(State.failed)
else:
self._updateState(State.waitrecover)
def __state_waitrecover(self, fromState):
pass
def __state_racquiring(self, fromState):
if self.resOwner.requestsGranted():
self._updateState(State.recovering)
def __state_recovering(self, fromState):
self._recover()
def __state_raborting(self, fromState):
if self.ref == 1:
self._updateState(State.failed)
else:
self.log.warn("State was change to 'raborting' "
"when ref was not 1.")
def __state_recovered(self, fromState):
self._done()
def __state_failed(self, fromState):
self._done()
def __state_cleaning(self, fromState):
pass
def _updateState(self, state, force=False):
fromState = self.state
requestedState = state
if self._aborting:
if self.state.canAbort():
state = State.aborting
elif self.state.canAbortRecovery() and state != State.recovered:
state = State.raborting
self._aborting = False
if requestedState == state:
self.log.debug("moving from state %s -> state %s",
fromState, state)
else:
self.log.debug("moving from state %s -> state %s instead of %s",
fromState, state, requestedState)
self.state.moveto(state, force)
if self.persistPolicy == TaskPersistType.auto:
try:
self.persist()
except Exception:
self.log.warning("Task._updateState: failed persisting task"
" %s", self.id, exc_info=True)
fn = getattr(self, "_Task__state_%s" % state)
fn(fromState)
def _updateResult(self, code, message, result):
self.result.result = result
self.result.code = code
self.result.message = message
@classmethod
def validateID(cls, taskID):
if not taskID or "." in taskID:
raise se.InvalidParameterException("taskID", taskID)
@classmethod
def _loadMetaFile(cls, filename, obj, fields):
try:
for line in getProcPool().readLines(filename):
# process current line
line = line.encode('utf8')
if line.find(KEY_SEPARATOR) < 0:
continue
parts = line.split(KEY_SEPARATOR)
if len(parts) != 2:
cls.log.warning("Task._loadMetaFile: %s - ignoring line"
" '%s'", filename, line)
continue
field = _eq_decode(parts[0].strip())
value = _eq_decode(parts[1].strip())
if field not in fields:
cls.log.warning("Task._loadMetaFile: %s - ignoring field"
" %s in line '%s'", filename, field, line)
continue
ftype = fields[field]
setattr(obj, field, ftype(value))
except Exception:
cls.log.error("Unexpected error", exc_info=True)
raise se.TaskMetaDataLoadError(filename)
@classmethod
def _dump(cls, obj, fields):
lines = []
for field in fields:
try:
value = six.text_type(getattr(obj, field))
except AttributeError:
cls.log.warning("object %s field %s not found" %
(obj, field), exc_info=True)
else:
try:
field = _eq_encode(field)
value = _eq_encode(value)
except ValueError as e:
cls.log.warning("Object %s: Cannot encode field %s or "
"value %s. Skipping field. %s",
obj, field, value, e)
else:
lines.append("%s %s %s" % (field, KEY_SEPARATOR, value))
return lines
@classmethod
def _saveMetaFile(cls, filename, obj, fields):
try:
getProcPool().writeLines(filename,
[l.encode('utf-8') + b"\n"
for l in cls._dump(obj, fields)])
except Exception:
cls.log.error("Unexpected error", exc_info=True)
raise se.TaskMetaDataSaveError(filename)
def _loadTaskMetaFile(self, taskDir):
taskFile = os.path.join(taskDir, self.id + TASK_EXT)
self._loadMetaFile(taskFile, self, Task.fields)
def _saveTaskMetaFile(self, taskDir):
taskFile = os.path.join(taskDir, self.id + TASK_EXT)
self._saveMetaFile(taskFile, self, Task.fields)
def _loadJobMetaFile(self, taskDir, n):
taskFile = os.path.join(taskDir, self.id + JOB_EXT + NUM_SEP + str(n))
self._loadMetaFile(taskFile, self.jobs[n], Job.fields)
def _saveJobMetaFile(self, taskDir, n):
taskFile = os.path.join(taskDir, self.id + JOB_EXT + NUM_SEP + str(n))
self._saveMetaFile(taskFile, self.jobs[n], Job.fields)
def _loadRecoveryMetaFile(self, taskDir, n):
taskFile = os.path.join(taskDir,
self.id + RECOVER_EXT + NUM_SEP + str(n))
self._loadMetaFile(taskFile, self.recoveries[n], Recovery.fields)
def _saveRecoveryMetaFile(self, taskDir, n):
taskFile = os.path.join(taskDir,
self.id + RECOVER_EXT + NUM_SEP + str(n))
self._saveMetaFile(taskFile, self.recoveries[n], Recovery.fields)
def _loadTaskResultMetaFile(self, taskDir):
taskFile = os.path.join(taskDir, self.id + RESULT_EXT)
self._loadMetaFile(taskFile, self.result, TaskResult.fields)
def _saveTaskResultMetaFile(self, taskDir):
taskFile = os.path.join(taskDir, self.id + RESULT_EXT)
self._saveMetaFile(taskFile, self.result, TaskResult.fields)
def _getResourcesKeyList(self, taskDir):
keys = []
for path in getProcPool().glob.glob(os.path.join(taskDir,
"*" + RESOURCE_EXT)):
filename = os.path.basename(path)
keys.append(filename[:filename.rfind(RESOURCE_EXT)])
return keys
def _load(self, storPath, ext=""):
self.log.debug("%s: load from %s, ext '%s'", self, storPath, ext)
if self.state != State.init:
raise se.TaskMetaDataLoadError("task %s - can't load self: "
"not in init state" % self)
taskDir = os.path.join(storPath, str(self.id) + str(ext))
if not getProcPool().os.path.exists(taskDir):
raise se.TaskDirError("load: no such task dir '%s'" % taskDir)
oldid = self.id
self._loadTaskMetaFile(taskDir)
if self.id != oldid:
raise se.TaskMetaDataLoadError("task %s: loaded file do not match"
" id (%s != %s)" %
(self, self.id, oldid))
if self.state == State.finished:
self._loadTaskResultMetaFile(taskDir)
for jn in range(self.njobs):
self.jobs.append(Job("load", None))
self._loadJobMetaFile(taskDir, jn)
self.jobs[jn].setOwnerTask(self)
for rn in range(self.nrecoveries):
self.recoveries.append(Recovery("load", "load",
"load", "load", ""))
self._loadRecoveryMetaFile(taskDir, rn)
self.recoveries[rn].setOwnerTask(self)
def _save(self, storPath):
origTaskDir = os.path.join(storPath, self.id)
if not getProcPool().os.path.exists(origTaskDir):
raise se.TaskDirError("_save: no such task dir '%s'" % origTaskDir)
taskDir = os.path.join(storPath, self.id + TEMP_EXT)
self.log.debug("_save: orig %s temp %s", origTaskDir, taskDir)
if getProcPool().os.path.exists(taskDir):
getProcPool().fileUtils.cleanupdir(taskDir)
getProcPool().os.mkdir(taskDir)
try:
self.njobs = len(self.jobs)
self.nrecoveries = len(self.recoveries)
self._saveTaskMetaFile(taskDir)
if self.state == State.finished:
self._saveTaskResultMetaFile(taskDir)
for jn in range(self.njobs):
self._saveJobMetaFile(taskDir, jn)
for rn in range(self.nrecoveries):
self._saveRecoveryMetaFile(taskDir, rn)
except Exception as e:
self.log.error("Unexpected error", exc_info=True)
try:
getProcPool().fileUtils.cleanupdir(taskDir)
except:
self.log.warning("can't remove temp taskdir %s" % taskDir)
raise se.TaskPersistError("%s persist failed: %s" % (self, e))
# Make sure backup dir doesn't exist
getProcPool().fileUtils.cleanupdir(origTaskDir + BACKUP_EXT)
getProcPool().os.rename(origTaskDir, origTaskDir + BACKUP_EXT)
getProcPool().os.rename(taskDir, origTaskDir)
getProcPool().fileUtils.cleanupdir(origTaskDir + BACKUP_EXT)
getProcPool().fileUtils.fsyncPath(origTaskDir)
def _clean(self, storPath):
taskDir = os.path.join(storPath, self.id)
getProcPool().fileUtils.cleanupdir(taskDir)
def _recoverDone(self):
# protect agains races with stop/abort
self.log.debug("Recover Done: state %s", self.state)
while True:
try:
if self.state == State.recovering:
self._updateState(State.recovered)
elif self.state == State.raborting:
self._updateState(State.failed)
return
except se.TaskStateTransitionError:
self.log.error("Unexpected error", exc_info=True)
def _recover(self):
self.log.debug("_recover")
if not self.state == State.recovering:
raise se.TaskStateError("%s: _recover in state %s" %
(self, self.state))
try:
while self.state == State.recovering:
rec = self.popRecovery()
self.log.debug("running recovery %s", rec)
if not rec:
break
self._run(rec.run)
except Exception as e:
self.log.warning("task %s: recovery failed: %s",
self, e, exc_info=True)
# protect agains races with stop/abort
try:
if self.state == State.recovering:
self._updateState(State.raborting)
except se.TaskStateTransitionError:
pass
self._recoverDone()
def resourceAcquired(self, namespace, resource, locktype):
# Callback from resourceManager.Owner. May be called by another thread.
self._incref()
try:
self.callbackLock.acquire()
try:
self.log.debug("_resourcesAcquired: %s.%s (%s)",
namespace, resource, locktype)
if self.state == State.preparing:
return
if self.state == State.acquiring:
self._updateState(State.acquiring)
elif self.state == State.racquiring:
self._updateState(State.racquiring)
elif self.state == State.blocked:
self._updateState(State.preparing)
elif (self.state == State.aborting or
self.state == State.raborting):
self.log.debug("resource %s.%s acquired while in state %s",
namespace, resource, self.state)
else:
raise se.TaskStateError("acquire is not allowed in state"
" %s" % self.state)
finally:
self.callbackLock.release()
finally:
self._decref()
def resourceRegistered(self, namespace, resource, locktype):
self._incref()
try:
self.callbackLock.acquire()
try:
# Callback from resourceManager.Owner. May be called
# by another thread.
self.log.debug("_resourcesAcquired: %s.%s (%s)",
namespace, resource, locktype)
# Protect against races with stop/abort
if self.state == State.preparing:
self._updateState(State.blocked)
finally:
self.callbackLock.release()
finally:
self._decref()
def _setError(self, e=se.TaskAborted("Unknown error encountered"),
expected=False):
if not expected:
self.log.exception("Unexpected error")
self.error = e
def _run(self, fn, *args, **kargs):
code = 100
message = "Unknown Error"
try:
return fn(*args, **kargs)
except se.StorageException as e:
code = e.code
message = str(e)
self._setError(e, e.expected)
except Exception as e:
message = six.text_type(e)
self._setError(e)
except:
self._setError()
self.log.debug("Task._run: %s %s %s failed - stopping task",
self, args, kargs)
self.stop()
raise se.TaskAborted(message, code)
def _runJobs(self):
result = ""
code = 100
message = "Unknown Error"
i = 0
j = None
try:
if self.aborting():
raise se.TaskAborted("shutting down")
if not self.state == State.running:
raise se.TaskStateError("%s: can't run Jobs in state %s" %
(self, self.state))
# for now: result is the last job result, jobs are run sequentially
for j in self.jobs:
if self.aborting():
raise se.TaskAborted("shutting down")
self.log.debug("Task.run: running job %s: %s" % (i, j))
self._updateResult(
0, 'running job {0} of {1}'.format(i + 1, len(self.jobs)),
'')
result = self._run(j.run)
if result is None:
result = ""
i += 1
j = None
self._updateResult(0, "%s jobs completed successfully" % i, result)
self._updateState(State.finished)
self.log.debug('Task.run: exit - success: result %s' % result)
return result
except se.TaskAborted as e:
self.log.debug("aborting: %s", e)
message = e.value
code = e.abortedcode
if not self.aborting():
self.log.error("Aborted exception but not in aborting state")
raise
self._updateResult(code, message, "")
def _doAbort(self, force=False):
self.log.debug("Task._doAbort: force %s" % force)
self.lock.acquire()
# Am I really the last?
if self.ref != 0:
self.lock.release()
return
self.ref += 1
self.lock.release()
try:
try:
if (not self.state.canAbort() and
(force and not self.state.canAbortRecovery())):
self.log.warning("Task._doAbort %s: ignoring - "
"at state %s", self, self.state)
return
self.resOwner.cancelAll()
if self.state.canAbort():
self._updateState(State.aborting)
else:
self._updateState(State.raborting)
except se.TaskAborted:
self._updateState(State.failed)
finally:
self.lock.acquire()
self.ref -= 1
self.lock.release()
# If something horrible went wrong. Just fail the task.
if not self.state.isDone():
self.log.warn("Task exited in non terminal state. "
"Setting tasks as failed.")
self._updateState(State.failed)
def _doRecover(self):
self.lock.acquire()
# Am I really the last?
if self.ref != 0:
self.lock.release()
raise se.TaskHasRefs(six.text_type(self))
self.ref += 1
self.lock.release()
try:
self._updateState(State.racquiring)
finally:
self.lock.acquire()
self.ref -= 1
self.lock.release()
def _incref(self, force=False):
self.lock.acquire()
try:
if self.aborting() and (self._forceAbort or not force):
raise se.TaskAborted(six.text_type(self))
self.ref += 1
ref = self.ref
return ref
finally:
self.lock.release()
def _decref(self, force=False):
self.lock.acquire()
self.ref -= 1