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