xrootd
XrdXrootdMonitor.hh
Go to the documentation of this file.
1 #ifndef __XRDXROOTDMONITOR__
2 #define __XRDXROOTDMONITOR__
3 /******************************************************************************/
4 /* */
5 /* X r d X r o o t d M o n i t o r . h h */
6 /* */
7 /* (c) 2004 by the Board of Trustees of the Leland Stanford, Jr., University */
8 /* All Rights Reserved */
9 /* Produced by Andrew Hanushevsky for Stanford University under contract */
10 /* DE-AC02-76-SFO0515 with the Department of Energy */
11 /* */
12 /* This file is part of the XRootD software suite. */
13 /* */
14 /* XRootD is free software: you can redistribute it and/or modify it under */
15 /* the terms of the GNU Lesser General Public License as published by the */
16 /* Free Software Foundation, either version 3 of the License, or (at your */
17 /* option) any later version. */
18 /* */
19 /* XRootD is distributed in the hope that it will be useful, but WITHOUT */
20 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
21 /* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */
22 /* License for more details. */
23 /* */
24 /* You should have received a copy of the GNU Lesser General Public License */
25 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */
26 /* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */
27 /* */
28 /* The copyright holder's institutional names and contributor's names may not */
29 /* be used to endorse or promote products derived from this software without */
30 /* specific prior written permission of the institution or contributor. */
31 /******************************************************************************/
32 
33 #include <inttypes.h>
34 #include <stdlib.h>
35 #include <time.h>
36 #include <netinet/in.h>
37 #include <sys/types.h>
38 
39 #include "XrdSys/XrdSysPthread.hh"
41 #include "XProtocol/XPtypes.hh"
42 
43 /******************************************************************************/
44 /* X r d M o n i t o r */
45 /******************************************************************************/
46 
47 #define XROOTD_MON_ALL 0x00000001
48 #define XROOTD_MON_FILE 0x00000002
49 #define XROOTD_MON_IO 0x00000004
50 #define XROOTD_MON_INFO 0x00000008
51 #define XROOTD_MON_USER 0x00000010
52 #define XROOTD_MON_AUTH 0x00000020
53 #define XROOTD_MON_PATH (XROOTD_MON_IO | XROOTD_MON_FILE)
54 #define XROOTD_MON_REDR 0x00000040
55 #define XROOTD_MON_IOV 0x00000080
56 #define XROOTD_MON_FSTA 0x00000100
57 #define XROOTD_MON_CCM 0x00000200
58 #define XROOTD_MON_PFC 0x00000400
59 #define XROOTD_MON_TCPMO 0x00000800
60 #define XROOTD_MON_GSTRM (XROOTD_MON_CCM | XROOTD_MON_PFC | XROOTD_MON_TCPMO)
61 
62 #define XROOTD_MON_FSLFN 1
63 #define XROOTD_MON_FSOPS 2
64 #define XROOTD_MON_FSSSQ 4
65 #define XROOTD_MON_FSXFR 8
66 
67 class XrdScheduler;
68 class XrdNetMsg;
69 class XrdXrootdMonFile;
70 
71 /******************************************************************************/
72 /* C l a s s X r d X r o o t d M o n i t o r */
73 /******************************************************************************/
74 
76 {
77 public:
78  class User;
79 friend class User;
80 friend class XrdXrootdMonFile;
81 
82 // All values for Add_xx() must be passed in network byte order
83 //
84 inline void Add_rd(kXR_unt32 dictid,
85  kXR_int32 rlen,
86  kXR_int64 offset)
87  {Add_io(dictid, rlen, offset);}
88 
89 inline void Add_rv(kXR_unt32 dictid,
90  kXR_int32 rlen,
91  kXR_int16 vcnt,
92  kXR_char vseq,
93  kXR_char vtype)
94  {if (lastWindow != currWindow) Mark();
95  else if (nextEnt == lastEnt) Flush();
96  monBuff->info[nextEnt].arg0.id[0] = vtype;
97  monBuff->info[nextEnt].arg0.id[1] = vseq;
98  monBuff->info[nextEnt].arg0.sVal[1] = vcnt;
99  monBuff->info[nextEnt].arg0.rTot[1] = 0;
100  monBuff->info[nextEnt].arg1.buflen = rlen;
101  monBuff->info[nextEnt++].arg2.dictid = dictid;
102  }
103 
104 inline void Add_wr(kXR_unt32 dictid,
105  kXR_int32 wlen,
106  kXR_int64 offset)
107  {Add_io(dictid,(kXR_int32)htonl(-wlen),offset);}
108 
109  void appID(char *id);
110 
111  void Close(kXR_unt32 dictid, long long rTot, long long wTot);
112 
113  void Disc(kXR_unt32 dictid, int csec, char Flags=0);
114 
115 static void Defaults(char *dest1, int m1, char *dest2, int m2);
116 static void Defaults(int msz, int rsz, int wsz,
117  int flush, int flash, int iDent, int rnm,
118  int fbsz, int fsint=0, int fsopt=0, int fsion=0);
119 
120 static int Flushing() {return autoFlush;}
121 
122 static kXR_unt32 GetDictID(bool hbo=false);
123 
124 static void Ident() {Send(-1, idRec, idLen);}
125 
126 static void Init(XrdScheduler *sp, XrdSysError *errp,
127  const char *iHost, const char *iProg,
128  const char *iName, int Port);
129 
130 static int Init();
131 
132 static bool ModeEnabled(int mode)
133  {return ((monMode1|monMode2) & mode) != 0;}
134 
135  void Open(kXR_unt32 dictid, off_t fsize);
136 
137 static int Redirect() {return monREDR;}
138 
139 static int Redirect(kXR_unt32 mID, const char *hName, int Port,
140  const char opC, const char *Path);
141 
142 static int Send(int mmode, void *buff, int size, bool setseq=true);
143 
144 static time_t Tick();
145 
146 /******************************************************************************/
147 
148 class Hello
149 {
150 public:
151 
152 static bool Hail();
153 
154 virtual void Ident() {};
155 
156  Hello(const char *dest, char mode);
157 
158 virtual ~Hello() {if (theDest) free(theDest);}
159 
160 private:
161 static Hello *First;
163  char *theDest;
164  char theMode;
165 };
166 
167 /******************************************************************************/
168 
169 class User
170 {
171 public:
172 
175 char Iops;
176 char Fops;
177 short Len;
178 char *Name;
179 
180 inline int Auths() {return XrdXrootdMonitor::monAUTH;}
181 
182 void Clear() {if (Name) {free(Name); Name = 0; Len = 0;}
183  if (Agent) {Agent->unAlloc(Agent); Agent = 0;}
184  Did = 0; Iops = Fops = 0;
185  }
186 
187  void Enable();
188 
189  void Disable();
190 
191 inline int Files() {return (Agent ? Fops : 0);}
192 
193 inline int Fstat() {return monFSTAT;}
194 
195 inline int Info() {return (Agent ? XrdXrootdMonitor::monINFO : 0);}
196 
197 inline int InOut() {return (Agent ? Iops : 0);}
198 
199 inline int Logins() {return (Agent ? XrdXrootdMonitor::monUSER : 0);}
200 
201 inline kXR_unt32 MapInfo(const char *Info)
203  *this, Info);
204  }
205 
206 inline kXR_unt32 MapPath(const char *Path)
208  *this, Path);
209  }
210 
211  void Register(const char *Uname, const char *Hname,
212  const char *Pname);
213 
214  void Report(const char *Info)
216 
217 inline int Ready() {return XrdXrootdMonitor::monACTIVE;}
218 
219  User() : Agent(0), Did(0), Iops(0), Fops(0), Len(0), Name(0) {}
220  ~User() {Clear();}
221 };
222 
223 /******************************************************************************/
224 
226 
228 
229 static const int rdrMax = 8;
230 
231 private:
233 
234 static
238  int nextEnt;
239  int flushIt;
242  } rdrMon[rdrMax];
245 
246 inline void Add_io(kXR_unt32 duid, kXR_int32 blen, kXR_int64 offs)
247  {if (lastWindow != currWindow) Mark();
248  else if (nextEnt == lastEnt) Flush();
249  monBuff->info[nextEnt].arg0.val = offs;
250  monBuff->info[nextEnt].arg1.buflen = blen;
251  monBuff->info[nextEnt++].arg2.dictid = duid;
252  }
253 static XrdXrootdMonitor *Alloc(int force=0);
254  unsigned char do_Shift(long long xTot, unsigned int &xVal);
255  void Dup(XrdXrootdMonTrace *mrec);
256 static void fillHeader(XrdXrootdMonHeader *hdr,
257  const char id, int size);
258 static MonRdrBuff *Fetch();
259  void Flush();
260 static void Flush(MonRdrBuff *mP);
261 static kXR_unt32 Map(char code, XrdXrootdMonitor::User &uInfo,
262  const char *path);
263  void Mark();
264 static void startClock();
265 static void unAlloc(XrdXrootdMonitor *monp);
266 
268 static char *idRec;
269 static int idLen;
270 static char *Dest1;
271 static int monMode1;
273 static char *Dest2;
274 static int monMode2;
277 static int monBlen;
278  int nextEnt;
279 static int lastEnt;
280 static int lastRnt;
281 static int autoFlash;
282 static int autoFlush;
283 static int FlushTime;
286 static int rdrTOD;
287 static int rdrWin;
288 static int rdrNum;
290 static int isEnabled;
291 static int numMonitor;
292 static int monIdent;
293 static int monRlen;
294 static char monIO;
295 static char monINFO;
296 static char monFILE;
297 static char monREDR;
298 static char monUSER;
299 static char monAUTH;
300 static char monACTIVE;
301 static char monFSTAT;
302 static char monCLOCK;
303 };
304 #endif
static XrdSysMutex windowMutex
Definition: XrdXrootdMonitor.hh:267
unsigned char kXR_char
Definition: XPtypes.hh:65
static void unAlloc(XrdXrootdMonitor *monp)
const kXR_char XROOTD_MON_MAPINFO
Definition: XrdXrootdMonData.hh:107
void Open(kXR_unt32 dictid, off_t fsize)
static char monFSTAT
Definition: XrdXrootdMonitor.hh:301
int Info()
Definition: XrdXrootdMonitor.hh:195
static int Redirect()
Definition: XrdXrootdMonitor.hh:137
static Hello * First
Definition: XrdXrootdMonitor.hh:161
char theMode
Definition: XrdXrootdMonitor.hh:164
static MonRdrBuff * Fetch()
Definition: XrdXrootdMonData.hh:73
static XrdNetMsg * InetDest2
Definition: XrdXrootdMonitor.hh:275
static char monAUTH
Definition: XrdXrootdMonitor.hh:299
short Len
Definition: XrdXrootdMonitor.hh:177
static void Defaults(char *dest1, int m1, char *dest2, int m2)
XrdXrootdMonBuff * monBuff
Definition: XrdXrootdMonitor.hh:276
static time_t Tick()
void Add_wr(kXR_unt32 dictid, kXR_int32 wlen, kXR_int64 offset)
Definition: XrdXrootdMonitor.hh:104
static int Flushing()
Definition: XrdXrootdMonitor.hh:120
kXR_unt32 dictid
Definition: XrdXrootdMonData.hh:54
const kXR_char XROOTD_MON_MAPUSER
Definition: XrdXrootdMonData.hh:113
static char * Dest2
Definition: XrdXrootdMonitor.hh:273
char * theDest
Definition: XrdXrootdMonitor.hh:163
static void startClock()
void Add_rd(kXR_unt32 dictid, kXR_int32 rlen, kXR_int64 offset)
Definition: XrdXrootdMonitor.hh:84
Definition: XrdXrootdMonData.hh:46
kXR_int64 val
Definition: XrdXrootdMonData.hh:47
static int monRlen
Definition: XrdXrootdMonitor.hh:293
static const int rdrMax
Definition: XrdXrootdMonitor.hh:229
char Iops
Definition: XrdXrootdMonitor.hh:175
Hello * Next
Definition: XrdXrootdMonitor.hh:162
static struct XrdXrootdMonitor::MonRdrBuff rdrMon[rdrMax]
Definition: XrdNetMsg.hh:48
unsigned char do_Shift(long long xTot, unsigned int &xVal)
static void Ident()
Definition: XrdXrootdMonitor.hh:124
static char monINFO
Definition: XrdXrootdMonitor.hh:295
static int rdrNum
Definition: XrdXrootdMonitor.hh:288
int nextEnt
Definition: XrdXrootdMonitor.hh:238
static XrdNetMsg * InetDest1
Definition: XrdXrootdMonitor.hh:272
char * Name
Definition: XrdXrootdMonitor.hh:178
static int autoFlash
Definition: XrdXrootdMonitor.hh:281
static kXR_unt32 GetDictID(bool hbo=false)
Definition: XrdXrootdMonitor.hh:75
kXR_int32 lastTOD
Definition: XrdXrootdMonitor.hh:240
int flushIt
Definition: XrdXrootdMonitor.hh:239
Definition: XrdSysError.hh:89
static int idLen
Definition: XrdXrootdMonitor.hh:269
union XrdXrootdMonTrace::@146 arg0
Definition: XrdScheduler.hh:44
int nextEnt
Definition: XrdXrootdMonitor.hh:278
Definition: XrdXrootdMonitor.hh:169
static char monFILE
Definition: XrdXrootdMonitor.hh:296
Definition: XrdSysPthread.hh:165
Definition: XrdXrootdMonData.hh:58
XrdXrootdMonTrace info[sizeof(XrdXrootdMonTrace)]
Definition: XrdXrootdMonData.hh:60
static XrdXrootdMonitor * altMon
Definition: XrdXrootdMonitor.hh:225
void Clear()
Definition: XrdXrootdMonitor.hh:182
Definition: XrdXrootdMonFile.hh:42
kXR_int32 buflen
Definition: XrdXrootdMonData.hh:51
static int isEnabled
Definition: XrdXrootdMonitor.hh:290
union XrdXrootdMonTrace::@147 arg1
static kXR_unt32 Map(char code, XrdXrootdMonitor::User &uInfo, const char *path)
static int FlushTime
Definition: XrdXrootdMonitor.hh:283
XrdXrootdMonBurr * Buff
Definition: XrdXrootdMonitor.hh:237
static char monUSER
Definition: XrdXrootdMonitor.hh:298
void Close(kXR_unt32 dictid, long long rTot, long long wTot)
virtual void Ident()
Definition: XrdXrootdMonitor.hh:154
static int monMode1
Definition: XrdXrootdMonitor.hh:271
kXR_char id[8]
Definition: XrdXrootdMonData.hh:48
static char * Dest1
Definition: XrdXrootdMonitor.hh:270
void Report(const char *Info)
Definition: XrdXrootdMonitor.hh:214
static int autoFlush
Definition: XrdXrootdMonitor.hh:282
char Fops
Definition: XrdXrootdMonitor.hh:176
static char monACTIVE
Definition: XrdXrootdMonitor.hh:300
const kXR_char XROOTD_MON_MAPPATH
Definition: XrdXrootdMonData.hh:104
static int Send(int mmode, void *buff, int size, bool setseq=true)
static int rdrWin
Definition: XrdXrootdMonitor.hh:287
void Register(const char *Uname, const char *Hname, const char *Pname)
unsigned int kXR_unt32
Definition: XPtypes.hh:90
User()
Definition: XrdXrootdMonitor.hh:219
static XrdSysMutex rdrMutex
Definition: XrdXrootdMonitor.hh:244
int Ready()
Definition: XrdXrootdMonitor.hh:217
static char monCLOCK
Definition: XrdXrootdMonitor.hh:302
static int lastRnt
Definition: XrdXrootdMonitor.hh:280
static char * idRec
Definition: XrdXrootdMonitor.hh:268
static int monMode2
Definition: XrdXrootdMonitor.hh:274
static void fillHeader(XrdXrootdMonHeader *hdr, const char id, int size)
union XrdXrootdMonTrace::@148 arg2
static int lastEnt
Definition: XrdXrootdMonitor.hh:279
static int monIdent
Definition: XrdXrootdMonitor.hh:292
void Add_rv(kXR_unt32 dictid, kXR_int32 rlen, kXR_int16 vcnt, kXR_char vseq, kXR_char vtype)
Definition: XrdXrootdMonitor.hh:89
static MonRdrBuff * rdrMP
Definition: XrdXrootdMonitor.hh:243
void Add_io(kXR_unt32 duid, kXR_int32 blen, kXR_int64 offs)
Definition: XrdXrootdMonitor.hh:246
Definition: XrdXrootdMonData.hh:39
int Auths()
Definition: XrdXrootdMonitor.hh:180
void Disc(kXR_unt32 dictid, int csec, char Flags=0)
int Fstat()
Definition: XrdXrootdMonitor.hh:193
void appID(char *id)
static char monIO
Definition: XrdXrootdMonitor.hh:294
static char monREDR
Definition: XrdXrootdMonitor.hh:297
static kXR_int32 currWindow
Definition: XrdXrootdMonitor.hh:285
void Dup(XrdXrootdMonTrace *mrec)
XrdSysMutex Mutex
Definition: XrdXrootdMonitor.hh:241
kXR_unt32 MapInfo(const char *Info)
Definition: XrdXrootdMonitor.hh:201
kXR_unt32 Did
Definition: XrdXrootdMonitor.hh:174
static int Init()
XrdXrootdMonitor * Agent
Definition: XrdXrootdMonitor.hh:173
static kXR_int32 sizeWindow
Definition: XrdXrootdMonitor.hh:289
static int rdrTOD
Definition: XrdXrootdMonitor.hh:286
kXR_unt32 MapPath(const char *Path)
Definition: XrdXrootdMonitor.hh:206
Definition: XrdXrootdMonitor.hh:235
int kXR_int32
Definition: XPtypes.hh:89
kXR_int32 lastWindow
Definition: XrdXrootdMonitor.hh:284
static int numMonitor
Definition: XrdXrootdMonitor.hh:291
int Files()
Definition: XrdXrootdMonitor.hh:191
int InOut()
Definition: XrdXrootdMonitor.hh:197
MonRdrBuff * Next
Definition: XrdXrootdMonitor.hh:236
Hello(const char *dest, char mode)
virtual ~Hello()
Definition: XrdXrootdMonitor.hh:158
static XrdXrootdMonitor * Alloc(int force=0)
kXR_unt32 rTot[2]
Definition: XrdXrootdMonData.hh:50
kXR_unt16 sVal[4]
Definition: XrdXrootdMonData.hh:49
long long kXR_int64
Definition: XPtypes.hh:98
static bool ModeEnabled(int mode)
Definition: XrdXrootdMonitor.hh:132
Definition: XrdXrootdMonitor.hh:148
static int monBlen
Definition: XrdXrootdMonitor.hh:277
short kXR_int16
Definition: XPtypes.hh:66
int Logins()
Definition: XrdXrootdMonitor.hh:199
~User()
Definition: XrdXrootdMonitor.hh:220