xrootd
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 <cinttypes>
34 #include <cstdlib>
35 #include <ctime>
36 #include <netinet/in.h>
37 #include <sys/types.h>
38 
39 #include "XrdSec/XrdSecMonitor.hh"
40 #include "XrdSys/XrdSysPthread.hh"
42 #include "XProtocol/XPtypes.hh"
43 
44 /******************************************************************************/
45 /* X r d M o n i t o r */
46 /******************************************************************************/
47 
48 #define XROOTD_MON_ALL 0x00000001
49 #define XROOTD_MON_FILE 0x00000002
50 #define XROOTD_MON_IO 0x00000004
51 #define XROOTD_MON_INFO 0x00000008
52 #define XROOTD_MON_USER 0x00000010
53 #define XROOTD_MON_AUTH 0x00000020
54 #define XROOTD_MON_PATH (XROOTD_MON_IO | XROOTD_MON_FILE)
55 #define XROOTD_MON_REDR 0x00000040
56 #define XROOTD_MON_IOV 0x00000080
57 #define XROOTD_MON_FSTA 0x00000100
58 #define XROOTD_MON_CCM 0x00000200
59 #define XROOTD_MON_PFC 0x00000400
60 #define XROOTD_MON_TCPMO 0x00000800
61 #define XROOTD_MON_TPC 0x00001000
62 #define XROOTD_MON_GSTRM (XROOTD_MON_CCM | XROOTD_MON_PFC | XROOTD_MON_TCPMO)
63 
64 #define XROOTD_MON_FSLFN 1
65 #define XROOTD_MON_FSOPS 2
66 #define XROOTD_MON_FSSSQ 4
67 #define XROOTD_MON_FSXFR 8
68 
69 class XrdScheduler;
70 class XrdNetMsg;
71 class XrdXrootdMonFile;
72 
73 /******************************************************************************/
74 /* C l a s s X r d X r o o t d M o n i t o r */
75 /******************************************************************************/
76 
78 {
79 public:
80  class User;
81 friend class User;
82 friend class XrdXrootdMonFile;
83 
84 // All values for Add_xx() must be passed in network byte order
85 //
86 inline void Add_rd(kXR_unt32 dictid,
87  kXR_int32 rlen,
88  kXR_int64 offset)
89  {Add_io(dictid, rlen, offset);}
90 
91 inline void Add_rv(kXR_unt32 dictid,
92  kXR_int32 rlen,
93  kXR_int16 vcnt,
94  kXR_char vseq,
95  kXR_char vtype)
96  {if (lastWindow != currWindow) Mark();
97  else if (nextEnt == lastEnt) Flush();
98  monBuff->info[nextEnt].arg0.id[0] = vtype;
99  monBuff->info[nextEnt].arg0.id[1] = vseq;
100  monBuff->info[nextEnt].arg0.sVal[1] = vcnt;
101  monBuff->info[nextEnt].arg0.rTot[1] = 0;
102  monBuff->info[nextEnt].arg1.buflen = rlen;
103  monBuff->info[nextEnt++].arg2.dictid = dictid;
104  }
105 
106 inline void Add_wr(kXR_unt32 dictid,
107  kXR_int32 wlen,
108  kXR_int64 offset)
109  {Add_io(dictid,(kXR_int32)htonl(-wlen),offset);}
110 
111  void appID(char *id);
112 
113  void Close(kXR_unt32 dictid, long long rTot, long long wTot);
114 
115  void Disc(kXR_unt32 dictid, int csec, char Flags=0);
116 
117 static void Defaults(char *dest1, int m1, char *dest2, int m2);
118 static void Defaults(int msz, int rsz, int wsz,
119  int flush, int flash, int iDent, int rnm,
120  int fbsz, int fsint=0, int fsopt=0, int fsion=0);
121 
122 static int Flushing() {return autoFlush;}
123 
124 static kXR_unt32 GetDictID(bool hbo=false);
125 
126 static void Ident() {Send(-1, idRec, idLen);}
127 
128 static void Init(XrdScheduler *sp, XrdSysError *errp,
129  const char *iHost, const char *iProg,
130  const char *iName, int Port);
131 
132 static int Init();
133 
134 static bool ModeEnabled(int mode)
135  {return ((monMode1|monMode2) & mode) != 0;}
136 
137  void Open(kXR_unt32 dictid, off_t fsize);
138 
139 static int Redirect() {return monREDR;}
140 
141 static int Redirect(kXR_unt32 mID, const char *hName, int Port,
142  const char opC, const char *Path);
143 
144 static int Send(int mmode, void *buff, int size, bool setseq=true);
145 
146 static time_t Tick();
147 
148 /******************************************************************************/
149 
150 class Hello
151 {
152 public:
153 
154 static bool Hail();
155 
156 virtual void Ident() {};
157 
158  Hello(const char *dest, char mode);
159 
160 virtual ~Hello() {if (theDest) free(theDest);}
161 
162 private:
163 static Hello *First;
165  char *theDest;
166  char theMode;
167 };
168 
169 /******************************************************************************/
170 
171 class User : public XrdSecMonitor
172 {
173 public:
174 
177 char Iops;
178 char Fops;
179 short Len;
180 char *Name;
181 
182 inline int Auths() {return XrdXrootdMonitor::monAUTH;}
183 
184 void Clear() {if (Name) {free(Name); Name = 0; Len = 0;}
185  if (Agent) {Agent->unAlloc(Agent); Agent = 0;}
186  Did = 0; Iops = Fops = 0;
187  }
188 
189  void Enable();
190 
191  void Disable();
192 
193 inline int Files() {return (Agent ? Fops : 0);}
194 
195 inline int Fstat() {return monFSTAT;}
196 
197 inline int Info() {return (Agent ? XrdXrootdMonitor::monINFO : 0);}
198 
199 inline int InOut() {return (Agent ? Iops : 0);}
200 
201 inline int Logins() {return (Agent ? XrdXrootdMonitor::monUSER : 0);}
202 
203 inline kXR_unt32 MapInfo(const char *Info)
205  *this, Info);
206  }
207 
208 inline kXR_unt32 MapPath(const char *Path)
210  *this, Path);
211  }
212 
213  void Register(const char *Uname, const char *Hname,
214  const char *Pname, unsigned int xSID=0);
215 
216  void Report(const char *Info)
218 
219  void Report(int eCode, int aCode);
220 
221  bool Report(WhatInfo infoT, const char *info) override;
222 
223 inline int Ready() {return XrdXrootdMonitor::monACTIVE;}
224 
225  User() : Agent(0), Did(0), Iops(0), Fops(0), Len(0), Name(0) {}
226  ~User() {Clear();}
227 };
228 
229 /******************************************************************************/
230 
232 
234 
235 static const int rdrMax = 8;
236 
237 private:
239 
240 static
244  int nextEnt;
245  int flushIt;
248  } rdrMon[rdrMax];
251 
252 inline void Add_io(kXR_unt32 duid, kXR_int32 blen, kXR_int64 offs)
253  {if (lastWindow != currWindow) Mark();
254  else if (nextEnt == lastEnt) Flush();
255  monBuff->info[nextEnt].arg0.val = offs;
256  monBuff->info[nextEnt].arg1.buflen = blen;
257  monBuff->info[nextEnt++].arg2.dictid = duid;
258  }
259 static XrdXrootdMonitor *Alloc(int force=0);
260  unsigned char do_Shift(long long xTot, unsigned int &xVal);
261  void Dup(XrdXrootdMonTrace *mrec);
262 static void fillHeader(XrdXrootdMonHeader *hdr,
263  const char id, int size);
264 static MonRdrBuff *Fetch();
265  void Flush();
266 static void Flush(MonRdrBuff *mP);
267 static kXR_unt32 Map(char code, XrdXrootdMonitor::User &uInfo,
268  const char *path);
269  void Mark();
270 static void startClock();
271 static void unAlloc(XrdXrootdMonitor *monp);
272 
274 static char *idRec;
275 static int idLen;
276 static char *Dest1;
277 static int monMode1;
279 static char *Dest2;
280 static int monMode2;
283 static int monBlen;
284  int nextEnt;
285 static int lastEnt;
286 static int lastRnt;
287 static int autoFlash;
288 static int autoFlush;
289 static int FlushTime;
292 static int rdrTOD;
293 static int rdrWin;
294 static int rdrNum;
296 static int isEnabled;
297 static int numMonitor;
298 static int monIdent;
299 static int monRlen;
300 static char monIO;
301 static char monINFO;
302 static char monFILE;
303 static char monREDR;
304 static char monUSER;
305 static char monAUTH;
306 static char monACTIVE;
307 static char monFSTAT;
308 static char monCLOCK;
309 };
310 #endif
static XrdSysMutex windowMutex
Definition: XrdXrootdMonitor.hh:273
unsigned char kXR_char
Definition: XPtypes.hh:65
static void unAlloc(XrdXrootdMonitor *monp)
const kXR_char XROOTD_MON_MAPINFO
Definition: XrdXrootdMonData.hh:107
union XrdXrootdMonTrace::@162 arg1
void Open(kXR_unt32 dictid, off_t fsize)
static char monFSTAT
Definition: XrdXrootdMonitor.hh:307
int Info()
Definition: XrdXrootdMonitor.hh:197
WhatInfo
Definition: XrdSecMonitor.hh:37
static int Redirect()
Definition: XrdXrootdMonitor.hh:139
static Hello * First
Definition: XrdXrootdMonitor.hh:163
char theMode
Definition: XrdXrootdMonitor.hh:166
static MonRdrBuff * Fetch()
Definition: XrdXrootdMonData.hh:73
static XrdNetMsg * InetDest2
Definition: XrdXrootdMonitor.hh:281
static char monAUTH
Definition: XrdXrootdMonitor.hh:305
short Len
Definition: XrdXrootdMonitor.hh:179
static void Defaults(char *dest1, int m1, char *dest2, int m2)
XrdXrootdMonBuff * monBuff
Definition: XrdXrootdMonitor.hh:282
static time_t Tick()
void Add_wr(kXR_unt32 dictid, kXR_int32 wlen, kXR_int64 offset)
Definition: XrdXrootdMonitor.hh:106
static int Flushing()
Definition: XrdXrootdMonitor.hh:122
kXR_unt32 dictid
Definition: XrdXrootdMonData.hh:54
const kXR_char XROOTD_MON_MAPUSER
Definition: XrdXrootdMonData.hh:114
static char * Dest2
Definition: XrdXrootdMonitor.hh:279
char * theDest
Definition: XrdXrootdMonitor.hh:165
static void startClock()
void Add_rd(kXR_unt32 dictid, kXR_int32 rlen, kXR_int64 offset)
Definition: XrdXrootdMonitor.hh:86
Definition: XrdXrootdMonData.hh:46
kXR_int64 val
Definition: XrdXrootdMonData.hh:47
static int monRlen
Definition: XrdXrootdMonitor.hh:299
static const int rdrMax
Definition: XrdXrootdMonitor.hh:235
char Iops
Definition: XrdXrootdMonitor.hh:177
Hello * Next
Definition: XrdXrootdMonitor.hh:164
static struct XrdXrootdMonitor::MonRdrBuff rdrMon[rdrMax]
Definition: XrdNetMsg.hh:49
unsigned char do_Shift(long long xTot, unsigned int &xVal)
union XrdXrootdMonTrace::@163 arg2
static void Ident()
Definition: XrdXrootdMonitor.hh:126
static char monINFO
Definition: XrdXrootdMonitor.hh:301
static int rdrNum
Definition: XrdXrootdMonitor.hh:294
int nextEnt
Definition: XrdXrootdMonitor.hh:244
static XrdNetMsg * InetDest1
Definition: XrdXrootdMonitor.hh:278
char * Name
Definition: XrdXrootdMonitor.hh:180
void Register(const char *Uname, const char *Hname, const char *Pname, unsigned int xSID=0)
static int autoFlash
Definition: XrdXrootdMonitor.hh:287
static kXR_unt32 GetDictID(bool hbo=false)
Definition: XrdXrootdMonitor.hh:77
kXR_int32 lastTOD
Definition: XrdXrootdMonitor.hh:246
int flushIt
Definition: XrdXrootdMonitor.hh:245
Definition: XrdSysError.hh:89
static int idLen
Definition: XrdXrootdMonitor.hh:275
Definition: XrdScheduler.hh:45
int nextEnt
Definition: XrdXrootdMonitor.hh:284
Definition: XrdXrootdMonitor.hh:171
static char monFILE
Definition: XrdXrootdMonitor.hh:302
Definition: XrdSysPthread.hh:164
Definition: XrdXrootdMonData.hh:58
XrdXrootdMonTrace info[sizeof(XrdXrootdMonTrace)]
Definition: XrdXrootdMonData.hh:60
static XrdXrootdMonitor * altMon
Definition: XrdXrootdMonitor.hh:231
void Clear()
Definition: XrdXrootdMonitor.hh:184
Definition: XrdXrootdMonFile.hh:42
kXR_int32 buflen
Definition: XrdXrootdMonData.hh:51
static int isEnabled
Definition: XrdXrootdMonitor.hh:296
static kXR_unt32 Map(char code, XrdXrootdMonitor::User &uInfo, const char *path)
static int FlushTime
Definition: XrdXrootdMonitor.hh:289
XrdXrootdMonBurr * Buff
Definition: XrdXrootdMonitor.hh:243
static char monUSER
Definition: XrdXrootdMonitor.hh:304
void Close(kXR_unt32 dictid, long long rTot, long long wTot)
virtual void Ident()
Definition: XrdXrootdMonitor.hh:156
static int monMode1
Definition: XrdXrootdMonitor.hh:277
Definition: XrdSecMonitor.hh:33
kXR_char id[8]
Definition: XrdXrootdMonData.hh:48
union XrdXrootdMonTrace::@161 arg0
static char * Dest1
Definition: XrdXrootdMonitor.hh:276
void Report(const char *Info)
Definition: XrdXrootdMonitor.hh:216
static int autoFlush
Definition: XrdXrootdMonitor.hh:288
char Fops
Definition: XrdXrootdMonitor.hh:178
static char monACTIVE
Definition: XrdXrootdMonitor.hh:306
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:293
unsigned int kXR_unt32
Definition: XPtypes.hh:90
User()
Definition: XrdXrootdMonitor.hh:225
static XrdSysMutex rdrMutex
Definition: XrdXrootdMonitor.hh:250
int Ready()
Definition: XrdXrootdMonitor.hh:223
static char monCLOCK
Definition: XrdXrootdMonitor.hh:308
static int lastRnt
Definition: XrdXrootdMonitor.hh:286
static char * idRec
Definition: XrdXrootdMonitor.hh:274
static int monMode2
Definition: XrdXrootdMonitor.hh:280
static void fillHeader(XrdXrootdMonHeader *hdr, const char id, int size)
static int lastEnt
Definition: XrdXrootdMonitor.hh:285
static int monIdent
Definition: XrdXrootdMonitor.hh:298
void Add_rv(kXR_unt32 dictid, kXR_int32 rlen, kXR_int16 vcnt, kXR_char vseq, kXR_char vtype)
Definition: XrdXrootdMonitor.hh:91
static MonRdrBuff * rdrMP
Definition: XrdXrootdMonitor.hh:249
void Add_io(kXR_unt32 duid, kXR_int32 blen, kXR_int64 offs)
Definition: XrdXrootdMonitor.hh:252
Definition: XrdXrootdMonData.hh:39
int Auths()
Definition: XrdXrootdMonitor.hh:182
void Disc(kXR_unt32 dictid, int csec, char Flags=0)
int Fstat()
Definition: XrdXrootdMonitor.hh:195
void appID(char *id)
static char monIO
Definition: XrdXrootdMonitor.hh:300
static char monREDR
Definition: XrdXrootdMonitor.hh:303
static kXR_int32 currWindow
Definition: XrdXrootdMonitor.hh:291
void Dup(XrdXrootdMonTrace *mrec)
XrdSysMutex Mutex
Definition: XrdXrootdMonitor.hh:247
kXR_unt32 MapInfo(const char *Info)
Definition: XrdXrootdMonitor.hh:203
kXR_unt32 Did
Definition: XrdXrootdMonitor.hh:176
static int Init()
XrdXrootdMonitor * Agent
Definition: XrdXrootdMonitor.hh:175
static kXR_int32 sizeWindow
Definition: XrdXrootdMonitor.hh:295
static int rdrTOD
Definition: XrdXrootdMonitor.hh:292
kXR_unt32 MapPath(const char *Path)
Definition: XrdXrootdMonitor.hh:208
Definition: XrdXrootdMonitor.hh:241
int kXR_int32
Definition: XPtypes.hh:89
kXR_int32 lastWindow
Definition: XrdXrootdMonitor.hh:290
static int numMonitor
Definition: XrdXrootdMonitor.hh:297
int Files()
Definition: XrdXrootdMonitor.hh:193
int InOut()
Definition: XrdXrootdMonitor.hh:199
MonRdrBuff * Next
Definition: XrdXrootdMonitor.hh:242
Hello(const char *dest, char mode)
virtual ~Hello()
Definition: XrdXrootdMonitor.hh:160
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:134
Definition: XrdXrootdMonitor.hh:150
static int monBlen
Definition: XrdXrootdMonitor.hh:283
short kXR_int16
Definition: XPtypes.hh:66
int Logins()
Definition: XrdXrootdMonitor.hh:201
~User()
Definition: XrdXrootdMonitor.hh:226