xrootd
XrdScheduler.hh
Go to the documentation of this file.
1 #ifndef ___XRD_SCHED_H___
2 #define ___XRD_SCHED_H___
3 /******************************************************************************/
4 /* */
5 /* X r d S c h e d u l e r . h h */
6 /* */
7 /* (c) 2004 by the Board of Trustees of the Leland Stanford, Jr., University */
8 /* Produced by Andrew Hanushevsky for Stanford University under contract */
9 /* DE-AC02-76-SFO0515 with the Department of Energy */
10 /* */
11 /* This file is part of the XRootD software suite. */
12 /* */
13 /* XRootD is free software: you can redistribute it and/or modify it under */
14 /* the terms of the GNU Lesser General Public License as published by the */
15 /* Free Software Foundation, either version 3 of the License, or (at your */
16 /* option) any later version. */
17 /* */
18 /* XRootD is distributed in the hope that it will be useful, but WITHOUT */
19 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
20 /* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */
21 /* License for more details. */
22 /* */
23 /* You should have received a copy of the GNU Lesser General Public License */
24 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */
25 /* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */
26 /* */
27 /* The copyright holder's institutional names and contributor's names may not */
28 /* be used to endorse or promote products derived from this software without */
29 /* specific prior written permission of the institution or contributor. */
30 /******************************************************************************/
31 
32 #include <unistd.h>
33 #include <sys/types.h>
34 
35 #include "XrdSys/XrdSysPthread.hh"
36 #include "Xrd/XrdJob.hh"
37 
38 class XrdOucTrace;
39 class XrdSchedulerPID;
40 class XrdSysError;
41 
42 class XrdScheduler : public XrdJob
43 {
44 public:
45 
47 
48 void Cancel(XrdJob *jp);
49 
50 inline int canStick() {return num_Workers < stk_Workers
52 
53 void DoIt();
54 
55 pid_t Fork(const char *id);
56 
57 void *Reaper();
58 
59 void Run();
60 
61 void Schedule(XrdJob *jp);
62 void Schedule(int num, XrdJob *jfirst, XrdJob *jlast);
63 void Schedule(XrdJob *jp, time_t atime);
64 
65 void setParms(int minw, int maxw, int avlt, int maxi, int once=0);
66 
67 void Start();
68 
69 int Stats(char *buff, int blen, int do_sync=0);
70 
71 void TimeSched();
72 
73 // Statistical information
74 //
75 int num_TCreate; // Number of threads created
76 int num_TDestroy;// Number of threads destroyed
77 int num_Jobs; // Number of jobs scheduled
78 int max_QLength; // Longest queue length we had
79 int num_Limited; // Number of times max was reached
80 
81 // Constructor and destructor
82 //
84  int minw=8, int maxw=8192, int maxi=780);
85 
86  ~XrdScheduler();
87 
88 private:
91 
92 XrdSysMutex DispatchMutex; // Disp: Protects above area
93 int idl_Workers; // Disp: Number of idle workers
94 
95 int min_Workers; // Sched: Min threads we need to have
96 int max_Workers; // Sched: Max threads we can start
97 int max_Workidl; // Sched: Max idle time for threads above min_Workers
98 int num_Workers; // Sched: Number of threads we have
99 int stk_Workers; // Sched: Number of sticky workers we can have
100 int num_JobsinQ; // Sched: Number of outstanding jobs in the queue
101 int num_Layoffs; // Sched: Number of threads to terminate
102 
103 XrdJob *WorkFirst; // Pending work
106 XrdSysMutex SchedMutex; // Protects private area
107 
108 XrdJob *TimerQueue; // Pending work
110 XrdSysMutex TimerMutex; // Protects scheduler area
111 
112 XrdSchedulerPID *firstPID;
114 
115 void hireWorker(int dotrace=1);
116 void Monitor();
117 void traceExit(pid_t pid, int status);
118 static const char *TraceID;
119 };
120 #endif
void Cancel(XrdJob *jp)
XrdJob * WorkFirst
Definition: XrdScheduler.hh:103
int Stats(char *buff, int blen, int do_sync=0)
void TimeSched()
int Active()
Definition: XrdScheduler.hh:46
int num_TDestroy
Definition: XrdScheduler.hh:76
Definition: XrdOucTrace.hh:35
Definition: XrdSysError.hh:87
int idl_Workers
Definition: XrdScheduler.hh:93
Definition: XrdScheduler.hh:42
Definition: XrdSysPthread.hh:140
int max_Workidl
Definition: XrdScheduler.hh:97
static const char * TraceID
Definition: XrdScheduler.hh:118
XrdSysMutex TimerMutex
Definition: XrdScheduler.hh:110
XrdSysSemaphore WorkAvail
Definition: XrdScheduler.hh:105
void hireWorker(int dotrace=1)
int num_Limited
Definition: XrdScheduler.hh:79
XrdJob * TimerQueue
Definition: XrdScheduler.hh:108
Definition: XrdSysPthread.hh:53
int num_JobsinQ
Definition: XrdScheduler.hh:100
Definition: XrdSysPthread.hh:329
int num_Workers
Definition: XrdScheduler.hh:98
void traceExit(pid_t pid, int status)
int num_Jobs
Definition: XrdScheduler.hh:77
XrdSchedulerPID * firstPID
Definition: XrdScheduler.hh:112
int max_Workers
Definition: XrdScheduler.hh:96
int stk_Workers
Definition: XrdScheduler.hh:99
XrdOucTrace * XrdTrace
Definition: XrdScheduler.hh:90
void setParms(int minw, int maxw, int avlt, int maxi, int once=0)
XrdSysMutex DispatchMutex
Definition: XrdScheduler.hh:92
XrdScheduler(XrdSysError *eP, XrdOucTrace *tP, int minw=8, int maxw=8192, int maxi=780)
int num_TCreate
Definition: XrdScheduler.hh:75
XrdSysCondVar TimerRings
Definition: XrdScheduler.hh:109
int min_Workers
Definition: XrdScheduler.hh:95
XrdSysError * XrdLog
Definition: XrdScheduler.hh:89
void * Reaper()
XrdSysMutex ReaperMutex
Definition: XrdScheduler.hh:113
int num_Layoffs
Definition: XrdScheduler.hh:101
void Monitor()
XrdJob * WorkLast
Definition: XrdScheduler.hh:104
int canStick()
Definition: XrdScheduler.hh:50
pid_t Fork(const char *id)
void Schedule(XrdJob *jp)
Definition: XrdJob.hh:42
int max_QLength
Definition: XrdScheduler.hh:78
XrdSysMutex SchedMutex
Definition: XrdScheduler.hh:106