/
jcr.cc
1100 lines (949 loc) · 27.9 KB
/
jcr.cc
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
/*
BAREOS® - Backup Archiving REcovery Open Sourced
Copyright (C) 2000-2012 Free Software Foundation Europe e.V.
Copyright (C) 2011-2012 Planets Communications B.V.
Copyright (C) 2013-2024 Bareos GmbH & Co. KG
This program is Free Software; you can redistribute it and/or
modify it under the terms of version three of the GNU Affero General Public
License as published by the Free Software Foundation and included
in the file LICENSE.
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
Affero General Public License for more details.
You should have received a copy of the GNU Affero 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.
*/
/*
* Manipulation routines for Job Control Records and
* handling of last_jobs_list.
*
* Kern E. Sibbald, December 2000
*
* These routines are thread safe.
*
* The job list routines were re-written in May 2005 to
* eliminate the global lock while traversing the list, and
* to use the dlist subroutines. The locking is now done
* on the list each time the list is modified or traversed.
* That is it is "micro-locked" rather than globally locked.
* The result is that there is one lock/unlock for each entry
* in the list while traversing it rather than a single lock
* at the beginning of a traversal and one at the end. This
* incurs slightly more overhead, but effectively eliminates
* the possibilty of race conditions. In addition, with the
* exception of the global locking of the list during the
* re-reading of the config file, no recursion is needed.
*
*/
#include "include/bareos.h"
#include "include/jcr.h"
#include "lib/jcr.h"
#include "lib/berrno.h"
#include "lib/bsignal.h"
#include "lib/breg.h"
#include "lib/edit.h"
#include "lib/thread_specific_data.h"
#include "lib/tls_conf.h"
#include "lib/bsock.h"
#include "lib/recent_job_results_list.h"
#include "lib/message_queue_item.h"
#include "lib/volume_session_info.h"
#include "lib/watchdog.h"
#include <algorithm>
#include <thread>
#include <atomic>
#include <chrono>
const int debuglevel = 3400;
static void JcrTimeoutCheck(watchdog_t* self);
std::atomic<std::size_t> num_jobs_run;
std::size_t NumJobsRun()
{
return num_jobs_run.load(std::memory_order_relaxed);
}
static std::vector<std::weak_ptr<JobControlRecord>> job_control_record_cache;
static dlist<JobControlRecord>* job_control_record_chain = nullptr;
static int watch_dog_timeout = 0;
static std::mutex jcr_chain_mutex;
static pthread_mutex_t job_start_mutex = PTHREAD_MUTEX_INITIALIZER;
static char Job_status[] = "Status Job=%s JobStatus=%d\n";
void LockJobs() { lock_mutex(job_start_mutex); }
void UnlockJobs() { unlock_mutex(job_start_mutex); }
/*
* Get an ASCII representation of the Operation being performed as an english
* Noun
*/
const char* JobControlRecord::get_OperationName()
{
switch (JobType_) {
case JT_BACKUP:
return T_("Backup");
case JT_VERIFY:
return T_("Verifying");
case JT_RESTORE:
return T_("Restoring");
case JT_ARCHIVE:
return T_("Archiving");
case JT_COPY:
return T_("Copying");
case JT_MIGRATE:
return T_("Migration");
case JT_SCAN:
return T_("Scanning");
case JT_CONSOLIDATE:
return T_("Consolidating");
default:
return T_("Unknown operation");
}
}
/*
* Get an ASCII representation of the Action being performed either an english
* Verb or Adjective
*/
const char* JobControlRecord::get_ActionName(bool past)
{
switch (JobType_) {
case JT_BACKUP:
return T_("backup");
case JT_VERIFY:
return (past) ? T_("verified") : T_("verify");
case JT_RESTORE:
return (past) ? T_("restored") : T_("restore");
case JT_ARCHIVE:
return (past) ? T_("archived") : T_("archive");
case JT_COPY:
return (past) ? T_("copied") : T_("copy");
case JT_MIGRATE:
return (past) ? T_("migrated") : T_("migrate");
case JT_SCAN:
return (past) ? T_("scanned") : T_("scan");
case JT_CONSOLIDATE:
return (past) ? T_("consolidated") : T_("consolidate");
default:
return T_("unknown action");
}
}
bool JobControlRecord::JobReads()
{
switch (JobType_) {
case JT_VERIFY:
case JT_RESTORE:
case JT_COPY:
case JT_MIGRATE:
return true;
case JT_BACKUP:
if (JobLevel_ == L_VIRTUAL_FULL) { return true; }
break;
default:
break;
}
return false;
}
struct job_callback_item {
void (*JobEndCb)(JobControlRecord* jcr, void*);
void* ctx{};
};
// Pop each job_callback_item and process it.
static void CallJobEndCallbacks(JobControlRecord* jcr)
{
job_callback_item* item;
if (jcr->job_end_callbacks.size() > 0) {
item = (job_callback_item*)jcr->job_end_callbacks.pop();
while (item) {
item->JobEndCb(jcr, item->ctx);
free(item);
item = (job_callback_item*)jcr->job_end_callbacks.pop();
}
}
}
JobControlRecord::JobControlRecord()
{
Dmsg0(100, "Construct JobControlRecord\n");
msg_queue = new dlist<MessageQueueItem>();
int status;
if ((status = pthread_mutex_init(&msg_queue_mutex, nullptr)) != 0) {
BErrNo be;
Jmsg(nullptr, M_ABORT, 0, T_("Could not init msg_queue mutex. ERR=%s\n"),
be.bstrerror(status));
}
my_thread_id = pthread_self();
job_end_callbacks.init(1, false);
sched_time = time(nullptr);
initial_sched_time = sched_time;
IncUseCount();
VolumeName = GetPoolMemory(PM_FNAME);
VolumeName[0] = 0;
errmsg = GetPoolMemory(PM_MESSAGE);
errmsg[0] = 0;
comment = GetPoolMemory(PM_FNAME);
comment[0] = 0;
// Setup some dummy values
bstrncpy(Job, "*System*", sizeof(Job));
JobId = 0;
setJobType(JT_SYSTEM); /* internal job until defined */
setJobLevel(L_NONE);
setJobStatusWithPriorityCheck(JS_Created); /* ready to run */
SetTimeoutHandler();
}
JobControlRecord* new_jcr(JCR_free_HANDLER* daemon_free_jcr)
{
Dmsg0(debuglevel, "Enter new_jcr\n");
JobControlRecord* jcr
= static_cast<JobControlRecord*>(malloc(sizeof(JobControlRecord)));
jcr = new (jcr) JobControlRecord();
jcr->daemon_free_jcr = daemon_free_jcr;
return jcr;
}
void register_jcr(JobControlRecord* jcr)
{
Dmsg0(debuglevel, "Enter register_jcr\n");
LockJobs();
LockJcrChain();
InitJcrChain();
job_control_record_chain->append(jcr);
UnlockJcrChain();
UnlockJobs();
}
void InitJcr(std::shared_ptr<JobControlRecord> jcr,
JCR_free_HANDLER* daemon_free_jcr)
{
jcr->daemon_free_jcr = daemon_free_jcr;
LockJobs();
LockJcrChain();
job_control_record_cache.emplace_back(std::move(jcr));
UnlockJcrChain();
UnlockJobs();
}
/*
* Remove a JobControlRecord from the chain
*
* NOTE! The chain must be locked prior to calling this routine.
*/
static void RemoveJcr(JobControlRecord* jcr)
{
Dmsg0(debuglevel, "Enter RemoveJcr\n");
if (!jcr) { Emsg0(M_ABORT, 0, T_("nullptr jcr.\n")); }
job_control_record_chain->remove(jcr);
Dmsg0(debuglevel, "Leave RemoveJcr\n");
}
static void FreeCommonJcr(JobControlRecord* jcr)
{
Dmsg1(100, "FreeCommonJcr: %p \n", jcr);
if (!jcr) { Dmsg0(100, "FreeCommonJcr: Invalid jcr\n"); }
RemoveJcrFromThreadSpecificData(jcr);
jcr->SetKillable(false);
if (jcr->msg_queue) {
delete jcr->msg_queue;
jcr->msg_queue = nullptr;
pthread_mutex_destroy(&jcr->msg_queue_mutex);
}
if (jcr->client_name) {
FreePoolMemory(jcr->client_name);
jcr->client_name = nullptr;
}
if (jcr->attr) {
FreePoolMemory(jcr->attr);
jcr->attr = nullptr;
}
if (jcr->sd_auth_key) {
free(jcr->sd_auth_key);
jcr->sd_auth_key = nullptr;
}
if (jcr->VolumeName) {
FreePoolMemory(jcr->VolumeName);
jcr->VolumeName = nullptr;
}
if (jcr->dir_bsock) {
jcr->dir_bsock->close();
delete jcr->dir_bsock;
jcr->dir_bsock = nullptr;
}
if (jcr->errmsg) {
FreePoolMemory(jcr->errmsg);
jcr->errmsg = nullptr;
}
if (jcr->where) {
free(jcr->where);
jcr->where = nullptr;
}
if (jcr->RegexWhere) {
free(jcr->RegexWhere);
jcr->RegexWhere = nullptr;
}
if (jcr->where_bregexp) {
FreeBregexps(jcr->where_bregexp);
delete jcr->where_bregexp;
jcr->where_bregexp = nullptr;
}
if (jcr->cached_path) {
FreePoolMemory(jcr->cached_path);
jcr->cached_path = nullptr;
jcr->cached_pnl = 0;
}
if (jcr->id_list) {
FreeGuidList(jcr->id_list);
jcr->id_list = nullptr;
}
if (jcr->comment) {
FreePoolMemory(jcr->comment);
jcr->comment = nullptr;
}
}
static void JcrCleanup(JobControlRecord* jcr)
{
DequeueMessages(jcr);
CallJobEndCallbacks(jcr);
Dmsg1(debuglevel, "End job=%d\n", jcr->JobId);
switch (jcr->getJobType()) {
case JT_BACKUP:
case JT_VERIFY:
case JT_RESTORE:
case JT_MIGRATE:
case JT_COPY:
case JT_ADMIN:
if (jcr->JobId > 0) { // except Console Jobs
num_jobs_run.fetch_add(1, std::memory_order_relaxed);
RecentJobResultsList::Append(jcr);
}
break;
default:
break;
}
CloseMsg(jcr);
if (jcr->daemon_free_jcr) { jcr->daemon_free_jcr(jcr); }
FreeCommonJcr(jcr);
CloseMsg(nullptr); // flush any daemon messages
}
JobControlRecord::~JobControlRecord()
{
Dmsg0(100, "Destruct JobControlRecord\n");
JcrCleanup(this);
Dmsg0(debuglevel, "JobControlRecord Destructor finished\n");
}
static bool RunJcrGarbageCollector(JobControlRecord* jcr)
{
LockJcrChain();
jcr->DecUseCount(); /* decrement use count */
if (jcr->UseCount() < 0) {
Jmsg2(jcr, M_ERROR, 0, T_("JobControlRecord UseCount=%d JobId=%d\n"),
jcr->UseCount(), jcr->JobId);
}
if (jcr->JobId > 0) {
Dmsg3(debuglevel, "Dec FreeJcr jid=%u UseCount=%d Job=%s\n", jcr->JobId,
jcr->UseCount(), jcr->Job);
}
if (jcr->UseCount() > 0) { /* if in use */
UnlockJcrChain();
return false;
}
if (jcr->JobId > 0) {
Dmsg3(debuglevel, "remove jcr jid=%u UseCount=%d Job=%s\n", jcr->JobId,
jcr->UseCount(), jcr->Job);
}
RemoveJcr(jcr); /* remove Jcr from chain */
UnlockJcrChain();
return true;
}
// Global routine to free a jcr
void b_free_jcr(const char* file, int line, JobControlRecord* jcr)
{
Dmsg3(debuglevel, "Enter FreeJcr jid=%u from %s:%d\n", jcr->JobId, file,
line);
if (RunJcrGarbageCollector(jcr)) {
std::destroy_at(jcr);
free(jcr);
}
Dmsg0(debuglevel, "Exit FreeJcr\n");
}
void JobControlRecord::SetKillable(bool killable)
{
std::unique_lock l(mutex_);
my_thread_killable_ = killable;
if (killable) {
my_thread_id = pthread_self();
} else {
memset(&my_thread_id, 0, sizeof(my_thread_id));
}
}
void JobControlRecord::MyThreadSendSignal(int sig)
{
std::unique_lock l(mutex_);
if (IsKillable() && !pthread_equal(my_thread_id, pthread_self())) {
Dmsg1(800, "Send kill to jid=%d\n", JobId);
pthread_kill(my_thread_id, sig);
} else if (!IsKillable()) {
Dmsg1(10, "Warning, can't send kill to jid=%d\n", JobId);
}
}
/*
* Given a JobId, find the JobControlRecord
*
* Returns: jcr on success
* nullptr on failure
*/
JobControlRecord* get_jcr_by_id(uint32_t JobId)
{
JobControlRecord* jcr;
foreach_jcr (jcr) {
if (jcr->JobId == JobId) {
jcr->IncUseCount();
Dmsg3(debuglevel, "Inc get_jcr jid=%u UseCount=%d Job=%s\n", jcr->JobId,
jcr->UseCount(), jcr->Job);
break;
}
}
endeach_jcr(jcr);
return jcr;
}
static void CleanupExpired(std::vector<std::weak_ptr<JobControlRecord>>& v)
{
v.erase(std::remove_if(v.begin(), v.end(),
[](const auto& p) { return p.expired(); }),
v.end());
}
std::size_t GetJcrCount()
{
std::unique_lock _{jcr_chain_mutex};
CleanupExpired(job_control_record_cache);
return job_control_record_cache.size();
}
template <typename P>
static std::shared_ptr<JobControlRecord> GetJcr(P predicate)
{
std::unique_lock _{jcr_chain_mutex};
CleanupExpired(job_control_record_cache);
for (const auto& ptr : job_control_record_cache) {
if (auto jcr = ptr.lock(); jcr && predicate(jcr.get())) { return jcr; }
}
return {};
}
std::shared_ptr<JobControlRecord> GetJcrById(uint32_t JobId)
{
return GetJcr(
[JobId](const JobControlRecord* jcr) { return jcr->JobId == JobId; });
}
std::shared_ptr<JobControlRecord> GetJcrByFullName(std::string_view name)
{
return GetJcr([name](const JobControlRecord* jcr) {
return std::string_view{jcr->Job} == name;
});
}
std::shared_ptr<JobControlRecord> GetJcrByPartialName(std::string_view name)
{
return GetJcr([name](const JobControlRecord* jcr) {
return std::string_view{jcr->Job}.find(name) == 0;
});
}
std::shared_ptr<JobControlRecord> GetJcrBySession(VolumeSessionInfo vsi)
{
static_assert(sizeof(vsi) == 8);
return GetJcr([vsi](const JobControlRecord* jcr) {
return (VolumeSessionInfo{jcr->VolSessionId, jcr->VolSessionTime} == vsi);
});
}
/*
* Given a SessionId and SessionTime, find the JobControlRecord
*
* Returns: jcr on success
* nullptr on failure
*/
JobControlRecord* get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime)
{
JobControlRecord* jcr;
foreach_jcr (jcr) {
if (jcr->VolSessionId == SessionId && jcr->VolSessionTime == SessionTime) {
jcr->IncUseCount();
Dmsg3(debuglevel, "Inc get_jcr jid=%u UseCount=%d Job=%s\n", jcr->JobId,
jcr->UseCount(), jcr->Job);
break;
}
}
endeach_jcr(jcr);
return jcr;
}
/*
* Given a Job, find the JobControlRecord compares on the number of
* characters in Job thus allowing partial matches.
*
* Returns: jcr on success
* nullptr on failure
*/
JobControlRecord* get_jcr_by_partial_name(char* Job)
{
JobControlRecord* jcr;
int len;
if (!Job) { return nullptr; }
len = strlen(Job);
foreach_jcr (jcr) {
if (bstrncmp(Job, jcr->Job, len)) {
jcr->IncUseCount();
Dmsg3(debuglevel, "Inc get_jcr jid=%u UseCount=%d Job=%s\n", jcr->JobId,
jcr->UseCount(), jcr->Job);
break;
}
}
endeach_jcr(jcr);
return jcr;
}
/*
* Given a Job, find the JobControlRecord requires an exact match of names.
*
* Returns: jcr on success
* nullptr on failure
*/
JobControlRecord* get_jcr_by_full_name(char* Job)
{
JobControlRecord* jcr;
if (!Job) { return nullptr; }
foreach_jcr (jcr) {
if (bstrcmp(jcr->Job, Job)) {
jcr->IncUseCount();
Dmsg3(debuglevel, "Inc get_jcr jid=%u UseCount=%d Job=%s\n", jcr->JobId,
jcr->UseCount(), jcr->Job);
break;
}
}
endeach_jcr(jcr);
return jcr;
}
const char* JcrGetAuthenticateKey(const char* unified_job_name)
{
if (!unified_job_name) { return nullptr; }
JobControlRecord* jcr;
const char* auth_key = nullptr;
foreach_jcr (jcr) {
if (bstrcmp(jcr->Job, unified_job_name)) {
auth_key = jcr->sd_auth_key;
Dmsg3(debuglevel, "Inc get_jcr jid=%u UseCount=%d Job=%s\n", jcr->JobId,
jcr->UseCount(), jcr->Job);
break;
}
}
endeach_jcr(jcr);
return auth_key;
}
TlsPolicy JcrGetTlsPolicy(const char* unified_job_name)
{
if (!unified_job_name) { return kBnetTlsUnknown; }
TlsPolicy policy = kBnetTlsUnknown;
JobControlRecord* jcr;
foreach_jcr (jcr) {
if (bstrcmp(jcr->Job, unified_job_name)) {
policy = jcr->sd_tls_policy;
Dmsg4(debuglevel, "Inc get_jcr jid=%u UseCount=%d Job=%s TlsPolicy=%d\n",
jcr->JobId, jcr->UseCount(), jcr->Job, policy);
break;
}
}
endeach_jcr(jcr);
return policy;
}
static void UpdateWaitTime(JobControlRecord* jcr, int newJobStatus)
{
bool enter_in_waittime;
int oldJobStatus = jcr->getJobStatus();
switch (newJobStatus) {
case JS_WaitFD:
case JS_WaitSD:
case JS_WaitMedia:
case JS_WaitMount:
case JS_WaitStoreRes:
case JS_WaitJobRes:
case JS_WaitClientRes:
case JS_WaitMaxJobs:
case JS_WaitPriority:
enter_in_waittime = true;
break;
default:
enter_in_waittime = false; /* not a Wait situation */
break;
}
/* If we were previously waiting and are not any more
* we want to update the wait_time variable, which is
* the start of waiting. */
switch (oldJobStatus) {
case JS_WaitFD:
case JS_WaitSD:
case JS_WaitMedia:
case JS_WaitMount:
case JS_WaitStoreRes:
case JS_WaitJobRes:
case JS_WaitClientRes:
case JS_WaitMaxJobs:
case JS_WaitPriority:
if (!enter_in_waittime) { /* we get out the wait time */
jcr->wait_time_sum += (time(nullptr) - jcr->wait_time);
jcr->wait_time = 0;
}
break;
default:
// If wait state is new, we keep current time for watchdog MaxWaitTime
if (enter_in_waittime) { jcr->wait_time = time(nullptr); }
break;
}
}
// Priority runs from 0 (lowest) to 10 (highest)
static int GetStatusPriority(int JobStatus)
{
int priority = 0;
switch (JobStatus) {
case JS_Incomplete:
priority = 10;
break;
case JS_ErrorTerminated:
case JS_FatalError:
case JS_Canceled:
priority = 9;
break;
case JS_Error:
priority = 8;
break;
case JS_Differences:
priority = 7;
break;
}
return priority;
}
// Send Job status to Director
bool JobControlRecord::sendJobStatus()
{
if (dir_bsock) { return dir_bsock->fsend(Job_status, Job, getJobStatus()); }
return true;
}
// Set and send Job status to Director
bool JobControlRecord::sendJobStatus(int newJobStatus)
{
if (!is_JobStatus(newJobStatus)) {
setJobStatusWithPriorityCheck(newJobStatus);
if (dir_bsock) { return dir_bsock->fsend(Job_status, Job, getJobStatus()); }
}
return true;
}
void JobControlRecord::setJobStarted()
{
job_started = true;
job_started_time = time(nullptr);
}
void JobControlRecord::setJobStatusWithPriorityCheck(int newJobStatus)
{
int priority;
int oldJobStatus = JobStatus_;
int old_priority = GetStatusPriority(oldJobStatus);
priority = GetStatusPriority(newJobStatus);
Dmsg2(800, "setJobStatus(%s, %c)\n", Job, newJobStatus);
// Update wait_time depending on newJobStatus and oldJobStatus
UpdateWaitTime(this, newJobStatus);
/* For a set of errors, ... keep the current status
* so it isn't lost. For all others, set it. */
Dmsg2(800, "OnEntry JobStatus=%c newJobstatus=%c\n", oldJobStatus,
newJobStatus);
/* If status priority is > than proposed new status, change it.
* If status priority == new priority and both are zero, take the new
* status. If it is not zero, then we keep the first non-zero "error" that
* occurred. */
if (priority > old_priority || (priority == 0 && old_priority == 0)) {
Dmsg4(800, "Set new stat. old: %c,%d new: %c,%d\n", oldJobStatus,
old_priority, newJobStatus, priority);
JobStatus_.compare_exchange_strong(oldJobStatus, newJobStatus);
}
if (oldJobStatus != JobStatus_) {
Dmsg2(800, "leave setJobStatus old=%c new=%c\n", oldJobStatus,
newJobStatus);
// GeneratePluginEvent(this, bEventStatusChange, nullptr);
}
}
void LockJcrChain() { jcr_chain_mutex.lock(); }
void UnlockJcrChain() { jcr_chain_mutex.unlock(); }
/*
* Start walk of jcr chain
* The proper way to walk the jcr chain is:
* JobControlRecord *jcr;
* foreach_jcr(jcr) {
* ...
* }
* endeach_jcr(jcr);
*
* It is possible to leave out the endeach_jcr(jcr), but
* in that case, the last jcr referenced must be explicitly
* released with:
*
* FreeJcr(jcr);
*/
JobControlRecord* jcr_walk_start()
{
JobControlRecord* jcr;
LockJcrChain();
jcr = (JobControlRecord*)job_control_record_chain->first();
if (jcr) {
jcr->IncUseCount();
if (jcr->JobId > 0) {
Dmsg3(debuglevel, "Inc walk_start jid=%u UseCount=%d Job=%s\n",
jcr->JobId, jcr->UseCount(), jcr->Job);
}
}
UnlockJcrChain();
return jcr;
}
// Get next jcr from chain, and release current one
JobControlRecord* jcr_walk_next(JobControlRecord* prev_jcr)
{
JobControlRecord* jcr;
LockJcrChain();
jcr = (JobControlRecord*)job_control_record_chain->next(prev_jcr);
if (jcr) {
jcr->IncUseCount();
if (jcr->JobId > 0) {
Dmsg3(debuglevel, "Inc walk_next jid=%u UseCount=%d Job=%s\n", jcr->JobId,
jcr->UseCount(), jcr->Job);
}
}
UnlockJcrChain();
if (prev_jcr) { FreeJcr(prev_jcr); }
return jcr;
}
// Release last jcr referenced
void JcrWalkEnd(JobControlRecord* jcr)
{
if (jcr) {
if (jcr->JobId > 0) {
Dmsg3(debuglevel, "Free walk_end jid=%u UseCount=%d Job=%s\n", jcr->JobId,
jcr->UseCount(), jcr->Job);
}
FreeJcr(jcr);
}
}
void JobControlRecord::UpdateJobStats()
{
time_t now = time(nullptr);
int sec;
if (last_time == 0) { last_time = run_time; }
sec = now - last_time;
if (sec <= 0) { sec = 1; }
LastRate = (JobBytes - LastJobBytes) / sec;
time_t totalruntime = now - run_time;
if (totalruntime <= 0) { totalruntime = 1; }
AverageRate = JobBytes / totalruntime;
LastJobBytes = JobBytes;
last_time = now;
}
// Return number of Jobs
int JobCount()
{
JobControlRecord* jcr;
int count = 0;
LockJcrChain();
for (jcr = (JobControlRecord*)job_control_record_chain->first(); jcr;
(jcr = (JobControlRecord*)job_control_record_chain->next(jcr))) {
if (jcr->JobId > 0) { count++; }
}
UnlockJcrChain();
return count;
}
/*
* Setup to call the timeout check routine every 30 seconds
* This routine will check any timers that have been enabled.
*/
bool InitJcrSubsystem(int timeout)
{
watchdog_t* wd = new_watchdog();
watch_dog_timeout = timeout;
wd->one_shot = false;
wd->interval = 30; /* FIXME: should be configurable somewhere, even
if only with a #define */
wd->callback = JcrTimeoutCheck;
RegisterWatchdog(wd);
return true;
}
void InitJcrChain()
{
if (!job_control_record_chain) {
job_control_record_chain = new dlist<JobControlRecord>();
}
}
void CleanupJcrChain()
{
if (job_control_record_chain) {
delete job_control_record_chain;
job_control_record_chain = nullptr;
}
}
static void JcrTimeoutCheck(watchdog_t* /* self */)
{
JobControlRecord* jcr;
BareosSocket* bs;
time_t timer_start;
Dmsg0(debuglevel, "Start JobControlRecord timeout checks\n");
/* Walk through all JCRs checking if any one is
* blocked for more than specified max time.
*/
foreach_jcr (jcr) {
Dmsg2(debuglevel, "JcrTimeoutCheck JobId=%u jcr=0x%x\n", jcr->JobId, jcr);
if (jcr->JobId == 0) { continue; }
bs = jcr->store_bsock;
if (bs) {
timer_start = bs->timer_start;
if (timer_start && (watchdog_time - timer_start) > watch_dog_timeout) {
bs->timer_start = 0; /* turn off timer */
bs->SetTimedOut();
Qmsg(jcr, M_ERROR, 0,
T_("Watchdog sending kill after %d secs to thread stalled reading "
"Storage daemon.\n"),
watchdog_time - timer_start);
jcr->MyThreadSendSignal(TIMEOUT_SIGNAL);
}
}
bs = jcr->file_bsock;
if (bs) {
timer_start = bs->timer_start;
if (timer_start && (watchdog_time - timer_start) > watch_dog_timeout) {
bs->timer_start = 0; /* turn off timer */
bs->SetTimedOut();
Qmsg(jcr, M_ERROR, 0,
T_("Watchdog sending kill after %d secs to thread stalled reading "
"File daemon.\n"),
watchdog_time - timer_start);
jcr->MyThreadSendSignal(TIMEOUT_SIGNAL);
}
}
bs = jcr->dir_bsock;
if (bs) {
timer_start = bs->timer_start;
if (timer_start && (watchdog_time - timer_start) > watch_dog_timeout) {
bs->timer_start = 0; /* turn off timer */
bs->SetTimedOut();
Qmsg(jcr, M_ERROR, 0,
T_("Watchdog sending kill after %d secs to thread stalled reading "
"Director.\n"),
watchdog_time - timer_start);
jcr->MyThreadSendSignal(TIMEOUT_SIGNAL);
}
}
}
endeach_jcr(jcr);
Dmsg0(debuglevel, "Finished JobControlRecord timeout checks\n");
}
/*
* Return next JobId from comma separated list
*
* Returns:
* 1 if next JobId returned
* 0 if no more JobIds are in list
* -1 there is an error
*/
int GetNextJobidFromList(const char** p, uint32_t* JobId)
{
const int maxlen = 30;
char jobid[maxlen + 1];
const char* q = *p;
jobid[0] = 0;
for (int i = 0; i < maxlen; i++) {
if (*q == 0) {
break;
} else if (*q == ',') {
q++;
break;
}
jobid[i] = *q++;
jobid[i + 1] = 0;
}
if (jobid[0] == 0) {
return 0;
} else if (!Is_a_number(jobid)) {
return -1; /* error */
}
*p = q;
*JobId = str_to_int64(jobid);
return 1;
}