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 1
48 #define XROOTD_MON_FILE 2
49 #define XROOTD_MON_IO 4
50 #define XROOTD_MON_INFO 8
51 #define XROOTD_MON_USER 16
52 #define XROOTD_MON_AUTH 32
53 #define XROOTD_MON_PATH (XROOTD_MON_IO | XROOTD_MON_FILE)
54 #define XROOTD_MON_REDR 64
55 #define XROOTD_MON_IOV 128
56 #define XROOTD_MON_FSTA 256
57 
58 #define XROOTD_MON_FSLFN 1
59 #define XROOTD_MON_FSOPS 2
60 #define XROOTD_MON_FSSSQ 4
61 #define XROOTD_MON_FSXFR 8
62 
63 class XrdScheduler;
64 class XrdNetMsg;
65 class XrdXrootdMonFile;
66 
67 /******************************************************************************/
68 /* C l a s s X r d X r o o t d M o n i t o r */
69 /******************************************************************************/
70 
72 {
73 public:
74  class User;
75 friend class User;
76 friend class XrdXrootdMonFile;
77 
78 // All values for Add_xx() must be passed in network byte order
79 //
80 inline void Add_rd(kXR_unt32 dictid,
81  kXR_int32 rlen,
82  kXR_int64 offset)
83  {Add_io(dictid, rlen, offset);}
84 
85 inline void Add_rv(kXR_unt32 dictid,
86  kXR_int32 rlen,
87  kXR_int16 vcnt,
88  kXR_char vseq,
89  kXR_char vtype)
90  {if (lastWindow != currWindow) Mark();
91  else if (nextEnt == lastEnt) Flush();
92  monBuff->info[nextEnt].arg0.id[0] = vtype;
93  monBuff->info[nextEnt].arg0.id[1] = vseq;
94  monBuff->info[nextEnt].arg0.sVal[1] = vcnt;
95  monBuff->info[nextEnt].arg0.rTot[1] = 0;
96  monBuff->info[nextEnt].arg1.buflen = rlen;
97  monBuff->info[nextEnt++].arg2.dictid = dictid;
98  }
99 
100 inline void Add_wr(kXR_unt32 dictid,
101  kXR_int32 wlen,
102  kXR_int64 offset)
103  {Add_io(dictid,(kXR_int32)htonl(-wlen),offset);}
104 
105  void appID(char *id);
106 
107  void Close(kXR_unt32 dictid, long long rTot, long long wTot);
108 
109  void Disc(kXR_unt32 dictid, int csec, char Flags=0);
110 
111 static void Defaults(char *dest1, int m1, char *dest2, int m2);
112 static void Defaults(int msz, int rsz, int wsz,
113  int flush, int flash, int iDent, int rnm,
114  int fsint=0, int fsopt=0, int fsion=0);
115 
116 static void Ident() {Send(-1, idRec, idLen);}
117 
118 static int Init(XrdScheduler *sp, XrdSysError *errp,
119  const char *iHost, const char *iProg,
120  const char *iName, int Port);
121 
122  void Open(kXR_unt32 dictid, off_t fsize);
123 
124 static int Redirect() {return monREDR;}
125 
126 static int Redirect(kXR_unt32 mID, const char *hName, int Port,
127  const char opC, const char *Path);
128 
129 static time_t Tick();
130 
131 class User
132 {
133 public:
134 
137 char Iops;
138 char Fops;
139 short Len;
140 char *Name;
141 
142 inline int Auths() {return XrdXrootdMonitor::monAUTH;}
143 
144 void Clear() {if (Name) {free(Name); Name = 0; Len = 0;}
145  if (Agent) {Agent->unAlloc(Agent); Agent = 0;}
146  Did = 0; Iops = Fops = 0;
147  }
148 
149  void Enable();
150 
151  void Disable();
152 
153 inline int Files() {return (Agent ? Fops : 0);}
154 
155 inline int Fstat() {return monFSTAT;}
156 
157 inline int Info() {return (Agent ? XrdXrootdMonitor::monINFO : 0);}
158 
159 inline int InOut() {return (Agent ? Iops : 0);}
160 
161 inline int Logins() {return (Agent ? XrdXrootdMonitor::monUSER : 0);}
162 
163 inline kXR_unt32 MapInfo(const char *Info)
165  *this, Info);
166  }
167 
168 inline kXR_unt32 MapPath(const char *Path)
170  *this, Path);
171  }
172 
173  void Register(const char *Uname, const char *Hname,
174  const char *Pname);
175 
176  void Report(const char *Info)
178 
179 inline int Ready() {return XrdXrootdMonitor::monACTIVE;}
180 
181  User() : Agent(0), Did(0), Iops(0), Fops(0), Len(0), Name(0) {}
182  ~User() {Clear();}
183 };
184 
186 
188 
189 static const int rdrMax = 8;
190 
191 private:
193 
194 static
198  int nextEnt;
199  int flushIt;
202  } rdrMon[rdrMax];
205 
206 inline void Add_io(kXR_unt32 duid, kXR_int32 blen, kXR_int64 offs)
207  {if (lastWindow != currWindow) Mark();
208  else if (nextEnt == lastEnt) Flush();
209  monBuff->info[nextEnt].arg0.val = offs;
210  monBuff->info[nextEnt].arg1.buflen = blen;
211  monBuff->info[nextEnt++].arg2.dictid = duid;
212  }
213 static XrdXrootdMonitor *Alloc(int force=0);
214  unsigned char do_Shift(long long xTot, unsigned int &xVal);
215  void Dup(XrdXrootdMonTrace *mrec);
216 static void fillHeader(XrdXrootdMonHeader *hdr,
217  const char id, int size);
218 static MonRdrBuff *Fetch();
219  void Flush();
220 static void Flush(MonRdrBuff *mP);
221 static kXR_unt32 GetDictID();
222 static kXR_unt32 Map(char code, XrdXrootdMonitor::User &uInfo,
223  const char *path);
224  void Mark();
225 static int Send(int mmode, void *buff, int size);
226 static void startClock();
227 static void unAlloc(XrdXrootdMonitor *monp);
228 
232 static char *idRec;
233 static int idLen;
234 static char *Dest1;
235 static int monMode1;
237 static char *Dest2;
238 static int monMode2;
241 static int monBlen;
242  int nextEnt;
243 static int lastEnt;
244 static int lastRnt;
245 static int autoFlash;
246 static int autoFlush;
247 static int FlushTime;
251 static int rdrTOD;
252 static int rdrWin;
253 static int rdrNum;
255 static int isEnabled;
256 static int numMonitor;
257 static int monIdent;
258 static int monRlen;
259 static char sidName[16];
260 static short sidSize;
261 static char monIO;
262 static char monINFO;
263 static char monFILE;
264 static char monREDR;
265 static char monUSER;
266 static char monAUTH;
267 static char monACTIVE;
268 static char monFSTAT;
269 static char monCLOCK;
270 };
271 #endif
XrdXrootdMonitor::User::Info
int Info()
Definition: XrdXrootdMonitor.hh:157
XrdXrootdMonitor::idLen
static int idLen
Definition: XrdXrootdMonitor.hh:233
kXR_int32
int kXR_int32
Definition: XPtypes.hh:89
XrdXrootdMonitor::User::Fops
char Fops
Definition: XrdXrootdMonitor.hh:138
XrdXrootdMonitor::fillHeader
static void fillHeader(XrdXrootdMonHeader *hdr, const char id, int size)
XrdXrootdMonitor::Map
static kXR_unt32 Map(char code, XrdXrootdMonitor::User &uInfo, const char *path)
XrdXrootdMonitor::MonRdrBuff::flushIt
int flushIt
Definition: XrdXrootdMonitor.hh:199
XrdXrootdMonitor::User::Enable
void Enable()
XrdXrootdMonitor::lastEnt
static int lastEnt
Definition: XrdXrootdMonitor.hh:243
XrdXrootdMonitor::monUSER
static char monUSER
Definition: XrdXrootdMonitor.hh:265
XrdXrootdMonitor::Close
void Close(kXR_unt32 dictid, long long rTot, long long wTot)
XrdXrootdMonBurr
Definition: XrdXrootdMonData.hh:73
XrdXrootdMonitor::altMon
static XrdXrootdMonitor * altMon
Definition: XrdXrootdMonitor.hh:185
XrdXrootdMonitor::Add_io
void Add_io(kXR_unt32 duid, kXR_int32 blen, kXR_int64 offs)
Definition: XrdXrootdMonitor.hh:206
XrdXrootdMonTrace::arg2
union XrdXrootdMonTrace::@119 arg2
XrdXrootdMonitor::User::Len
short Len
Definition: XrdXrootdMonitor.hh:139
XrdSysMutex
Definition: XrdSysPthread.hh:165
XrdXrootdMonitor::Dest1
static char * Dest1
Definition: XrdXrootdMonitor.hh:234
XrdXrootdMonitor::monCLOCK
static char monCLOCK
Definition: XrdXrootdMonitor.hh:269
XrdXrootdMonitor::monMode2
static int monMode2
Definition: XrdXrootdMonitor.hh:238
XrdXrootdMonitor::appID
void appID(char *id)
XrdSysPthread.hh
XrdXrootdMonitor
Definition: XrdXrootdMonitor.hh:71
XROOTD_MON_MAPINFO
const kXR_char XROOTD_MON_MAPINFO
Definition: XrdXrootdMonData.hh:99
XrdXrootdMonitor::MonRdrBuff::nextEnt
int nextEnt
Definition: XrdXrootdMonitor.hh:198
kXR_int64
long long kXR_int64
Definition: XPtypes.hh:98
kXR_int16
short kXR_int16
Definition: XPtypes.hh:66
XrdXrootdMonitor::FlushTime
static int FlushTime
Definition: XrdXrootdMonitor.hh:247
XrdXrootdMonitor::Add_rv
void Add_rv(kXR_unt32 dictid, kXR_int32 rlen, kXR_int16 vcnt, kXR_char vseq, kXR_char vtype)
Definition: XrdXrootdMonitor.hh:85
XrdXrootdMonitor::rdrTOD
static int rdrTOD
Definition: XrdXrootdMonitor.hh:251
XrdXrootdMonitor::eDest
static XrdSysError * eDest
Definition: XrdXrootdMonitor.hh:230
XrdXrootdMonitor::User::Auths
int Auths()
Definition: XrdXrootdMonitor.hh:142
XrdXrootdMonitor::Disc
void Disc(kXR_unt32 dictid, int csec, char Flags=0)
XrdXrootdMonitor::User::Logins
int Logins()
Definition: XrdXrootdMonitor.hh:161
XrdXrootdMonitor::User::Ready
int Ready()
Definition: XrdXrootdMonitor.hh:179
XrdXrootdMonitor::rdrMutex
static XrdSysMutex rdrMutex
Definition: XrdXrootdMonitor.hh:204
XrdXrootdMonitor::Init
static int Init(XrdScheduler *sp, XrdSysError *errp, const char *iHost, const char *iProg, const char *iName, int Port)
XrdXrootdMonitor::idRec
static char * idRec
Definition: XrdXrootdMonitor.hh:232
kXR_char
unsigned char kXR_char
Definition: XPtypes.hh:65
XrdXrootdMonitor::autoFlush
static int autoFlush
Definition: XrdXrootdMonitor.hh:246
XrdXrootdMonitor::Send
static int Send(int mmode, void *buff, int size)
XrdXrootdMonitor::Dup
void Dup(XrdXrootdMonTrace *mrec)
XrdXrootdMonTrace::val
kXR_int64 val
Definition: XrdXrootdMonData.hh:47
XrdXrootdMonitor::User::Clear
void Clear()
Definition: XrdXrootdMonitor.hh:144
XrdXrootdMonitor::Sched
static XrdScheduler * Sched
Definition: XrdXrootdMonitor.hh:229
XrdXrootdMonitor::rdrMP
static MonRdrBuff * rdrMP
Definition: XrdXrootdMonitor.hh:203
XrdXrootdMonBuff::info
XrdXrootdMonTrace info[sizeof(XrdXrootdMonTrace)]
Definition: XrdXrootdMonData.hh:60
XrdXrootdMonitor::Alloc
static XrdXrootdMonitor * Alloc(int force=0)
XrdXrootdMonitor::lastWindow
kXR_int32 lastWindow
Definition: XrdXrootdMonitor.hh:249
XrdXrootdMonTrace::rTot
kXR_unt32 rTot[2]
Definition: XrdXrootdMonData.hh:50
XrdXrootdMonitor::User::Iops
char Iops
Definition: XrdXrootdMonitor.hh:137
XrdXrootdMonitor::lastRnt
static int lastRnt
Definition: XrdXrootdMonitor.hh:244
XrdXrootdMonitor::User::MapInfo
kXR_unt32 MapInfo(const char *Info)
Definition: XrdXrootdMonitor.hh:163
XrdXrootdMonitor::User::Did
kXR_unt32 Did
Definition: XrdXrootdMonitor.hh:136
XrdNetMsg
Definition: XrdNetMsg.hh:48
XrdXrootdMonitor::currWindow
static kXR_int32 currWindow
Definition: XrdXrootdMonitor.hh:250
XrdXrootdMonitor::MonRdrBuff::lastTOD
kXR_int32 lastTOD
Definition: XrdXrootdMonitor.hh:200
XrdXrootdMonitor::monIdent
static int monIdent
Definition: XrdXrootdMonitor.hh:257
XrdXrootdMonitor::User::Fstat
int Fstat()
Definition: XrdXrootdMonitor.hh:155
XrdXrootdMonTrace::sVal
kXR_unt16 sVal[4]
Definition: XrdXrootdMonData.hh:49
XrdXrootdMonitor::sizeWindow
static kXR_int32 sizeWindow
Definition: XrdXrootdMonitor.hh:254
XrdXrootdMonitor::User::MapPath
kXR_unt32 MapPath(const char *Path)
Definition: XrdXrootdMonitor.hh:168
XrdXrootdMonitor::windowMutex
static XrdSysMutex windowMutex
Definition: XrdXrootdMonitor.hh:231
kXR_unt32
unsigned int kXR_unt32
Definition: XPtypes.hh:90
XrdXrootdMonitor::numMonitor
static int numMonitor
Definition: XrdXrootdMonitor.hh:256
XrdXrootdMonBuff
Definition: XrdXrootdMonData.hh:58
XrdXrootdMonitor::Open
void Open(kXR_unt32 dictid, off_t fsize)
XrdXrootdMonitor::monIO
static char monIO
Definition: XrdXrootdMonitor.hh:261
XrdXrootdMonitor::monREDR
static char monREDR
Definition: XrdXrootdMonitor.hh:264
XrdXrootdMonitor::startTime
static kXR_int32 startTime
Definition: XrdXrootdMonitor.hh:248
XrdXrootdMonitor::User::Report
void Report(const char *Info)
Definition: XrdXrootdMonitor.hh:176
XrdXrootdMonitor::User::Disable
void Disable()
XrdXrootdMonitor::Fetch
static MonRdrBuff * Fetch()
XrdXrootdMonitor::MonRdrBuff::Mutex
XrdSysMutex Mutex
Definition: XrdXrootdMonitor.hh:201
XrdXrootdMonitor::unAlloc
static void unAlloc(XrdXrootdMonitor *monp)
XrdXrootdMonitor::monBuff
XrdXrootdMonBuff * monBuff
Definition: XrdXrootdMonitor.hh:240
XrdXrootdMonitor::monFSTAT
static char monFSTAT
Definition: XrdXrootdMonitor.hh:268
XrdXrootdMonitor::Tick
static time_t Tick()
XrdXrootdMonTrace::buflen
kXR_int32 buflen
Definition: XrdXrootdMonData.hh:51
XrdXrootdMonitor::sidName
static char sidName[16]
Definition: XrdXrootdMonitor.hh:259
XrdXrootdMonitor::~XrdXrootdMonitor
~XrdXrootdMonitor()
XrdScheduler
Definition: XrdScheduler.hh:44
XrdXrootdMonitor::Flush
void Flush()
XrdXrootdMonTrace::arg1
union XrdXrootdMonTrace::@118 arg1
XrdXrootdMonitor::sidSize
static short sidSize
Definition: XrdXrootdMonitor.hh:260
XrdXrootdMonFile
Definition: XrdXrootdMonFile.hh:44
XrdXrootdMonitor::Add_wr
void Add_wr(kXR_unt32 dictid, kXR_int32 wlen, kXR_int64 offset)
Definition: XrdXrootdMonitor.hh:100
XROOTD_MON_MAPUSER
const kXR_char XROOTD_MON_MAPUSER
Definition: XrdXrootdMonData.hh:105
XrdXrootdMonitor::monBlen
static int monBlen
Definition: XrdXrootdMonitor.hh:241
XrdXrootdMonitor::rdrNum
static int rdrNum
Definition: XrdXrootdMonitor.hh:253
XrdXrootdMonitor::startClock
static void startClock()
XrdXrootdMonitor::InetDest2
static XrdNetMsg * InetDest2
Definition: XrdXrootdMonitor.hh:239
XrdXrootdMonitor::InetDest1
static XrdNetMsg * InetDest1
Definition: XrdXrootdMonitor.hh:236
XrdXrootdMonitor::User::Register
void Register(const char *Uname, const char *Hname, const char *Pname)
XrdXrootdMonitor::monRlen
static int monRlen
Definition: XrdXrootdMonitor.hh:258
XrdXrootdMonitor::Redirect
static int Redirect()
Definition: XrdXrootdMonitor.hh:124
XrdXrootdMonitor::Dest2
static char * Dest2
Definition: XrdXrootdMonitor.hh:237
XROOTD_MON_MAPPATH
const kXR_char XROOTD_MON_MAPPATH
Definition: XrdXrootdMonData.hh:97
XrdXrootdMonitor::Ident
static void Ident()
Definition: XrdXrootdMonitor.hh:116
XrdXrootdMonitor::do_Shift
unsigned char do_Shift(long long xTot, unsigned int &xVal)
XrdXrootdMonitor::User::Files
int Files()
Definition: XrdXrootdMonitor.hh:153
XrdXrootdMonitor::Add_rd
void Add_rd(kXR_unt32 dictid, kXR_int32 rlen, kXR_int64 offset)
Definition: XrdXrootdMonitor.hh:80
XrdXrootdMonHeader
Definition: XrdXrootdMonData.hh:39
XrdXrootdMonitor::MonRdrBuff::Buff
XrdXrootdMonBurr * Buff
Definition: XrdXrootdMonitor.hh:197
XrdXrootdMonitor::monAUTH
static char monAUTH
Definition: XrdXrootdMonitor.hh:266
XrdXrootdMonitor::GetDictID
static kXR_unt32 GetDictID()
XrdXrootdMonitor::monFILE
static char monFILE
Definition: XrdXrootdMonitor.hh:263
XrdXrootdMonitor::Defaults
static void Defaults(char *dest1, int m1, char *dest2, int m2)
XrdXrootdMonitor::User::User
User()
Definition: XrdXrootdMonitor.hh:181
XrdXrootdMonTrace::dictid
kXR_unt32 dictid
Definition: XrdXrootdMonData.hh:54
XrdXrootdMonTrace
Definition: XrdXrootdMonData.hh:46
XrdXrootdMonitor::MonRdrBuff
Definition: XrdXrootdMonitor.hh:195
XrdXrootdMonitor::isEnabled
static int isEnabled
Definition: XrdXrootdMonitor.hh:255
XrdXrootdMonitor::nextEnt
int nextEnt
Definition: XrdXrootdMonitor.hh:242
XrdXrootdMonitor::autoFlash
static int autoFlash
Definition: XrdXrootdMonitor.hh:245
XrdXrootdMonitor::User::Name
char * Name
Definition: XrdXrootdMonitor.hh:140
XrdSysError
Definition: XrdSysError.hh:89
XrdXrootdMonitor::rdrMax
static const int rdrMax
Definition: XrdXrootdMonitor.hh:189
XrdXrootdMonitor::XrdXrootdMonitor
XrdXrootdMonitor()
XrdXrootdMonData.hh
XrdXrootdMonitor::rdrMon
static struct XrdXrootdMonitor::MonRdrBuff rdrMon[rdrMax]
XrdXrootdMonitor::Mark
void Mark()
XrdXrootdMonitor::monINFO
static char monINFO
Definition: XrdXrootdMonitor.hh:262
XrdXrootdMonitor::User
Definition: XrdXrootdMonitor.hh:131
XrdXrootdMonitor::User::~User
~User()
Definition: XrdXrootdMonitor.hh:182
XrdXrootdMonitor::monACTIVE
static char monACTIVE
Definition: XrdXrootdMonitor.hh:267
XrdXrootdMonTrace::id
kXR_char id[8]
Definition: XrdXrootdMonData.hh:48
XrdXrootdMonitor::MonRdrBuff::Next
MonRdrBuff * Next
Definition: XrdXrootdMonitor.hh:196
XrdXrootdMonitor::monMode1
static int monMode1
Definition: XrdXrootdMonitor.hh:235
XrdXrootdMonitor::rdrWin
static int rdrWin
Definition: XrdXrootdMonitor.hh:252
XrdXrootdMonTrace::arg0
union XrdXrootdMonTrace::@117 arg0
XrdXrootdMonitor::User::InOut
int InOut()
Definition: XrdXrootdMonitor.hh:159
XPtypes.hh
XrdXrootdMonitor::User::Agent
XrdXrootdMonitor * Agent
Definition: XrdXrootdMonitor.hh:135