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