xrootd
XrdXrootdMonData.hh
Go to the documentation of this file.
1 #ifndef __XRDXROOTDMONDATA__
2 #define __XRDXROOTDMONDATA__
3 /******************************************************************************/
4 /* */
5 /* X r d X r o o t d M o n D a t a . 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 "XProtocol/XPtypes.hh"
34 
35 /******************************************************************************/
36 /* P a c k e t D e f i n i t i o n s */
37 /******************************************************************************/
38 
40  {kXR_char code; // '='|'d'|'f'|'i'|'p'|'r'|'t'|'u'|'x'
41  kXR_char pseq; // packet sequence
42  kXR_unt16 plen; // packet length
43  kXR_int32 stod; // Unix time at Server Start
44  };
45 
47  {union {kXR_int64 val;
48  kXR_char id[8];
51  union {kXR_int32 buflen;
54  union {kXR_unt32 dictid;
56  };
57 
60  XrdXrootdMonTrace info[sizeof(XrdXrootdMonTrace)]; //This is really [n]
61  };
62 
64  {union {kXR_int32 Window;
65  struct {kXR_char Type;
68  } rdr; } arg0;
69  union {kXR_unt32 dictid;
71  };
72 
75  union {kXR_int64 sID;
76  kXR_char sXX[8]; };
77  XrdXrootdMonRedir info[sizeof(XrdXrootdMonRedir)]; //This is really [n]
78  };
79 
83  char info[1024+256];
84  };
85 
92 const kXR_char XROOTD_MON_REDHOST = 0xf0; // No Modifier
94 
95 
98 const kXR_char XROOTD_MON_MAPFSTA = 'f'; // The "f" stream
100 const kXR_char XROOTD_MON_MAPMIGR = 'm'; // Internal use only!
103 const kXR_char XROOTD_MON_MAPSTAG = 's'; // Internal use only!
107 
108 // The following bits are insert in the low order 4 bits of the MON_REDIRECT
109 // entry code to indicate the actual operation that was requestded.
110 //
111 const kXR_char XROOTD_MON_REDSID = 0xf0; // Server Identification
112 const kXR_char XROOTD_MON_REDTIME = 0x00; // Timing mark
113 
114 const kXR_char XROOTD_MON_REDIRECT = 0x80; // With Modifier below!
115 const kXR_char XROOTD_MON_REDLOCAL = 0x90; // With Modifier below!
116 
117 const kXR_char XROOTD_MON_CHMOD = 0x01; // Modifiers for the above
124 const kXR_char XROOTD_MON_MV = 0x08;
127 const kXR_char XROOTD_MON_RM = 0x0b;
131 
134 
135 const int XROOTD_MON_SRCMASK = 0x000000f;
136 const int XROOTD_MON_TRGMASK = 0x7fffff0;
137 const int XROOTD_MON_NEWSTID = 0x8000000;
138 
139 /******************************************************************************/
140 /* " f " S t r e a m S p e c i f i c R e c o r d s */
141 /******************************************************************************/
142 
143 // The UDP buffer layout is as follows:
144 //
145 // XrdXrootdMonHeader with Code == XROOTD_MON_MAPFSTA
146 // XrdXrootdMonFileTOD with recType == isTime
147 // XrdXrootdMonFileHdr with recType == one of recTval (variable length)
148 // ... additional XrdXrootdMonFileHdr's (variable length)
149 // XrdXrootdMonFileTOD with recType == isTime
150 
152 {
153 enum recTval {isClose = 0, // Record for close
154  isOpen, // Record for open
155  isTime, // Record for time
156  isXfr, // Record for transfers
157  isDisc // Record for disconnection
158  };
159 
160 enum recFval {forced =0x01, // If recFlag == isClose close due to disconnect
161  hasOPS =0x02, // If recFlag == isClose MonStatXFR + MonStatOPS
162  hasSSQ =0x04, // If recFlag == isClose XFR + OPS + MonStatSSQ
163  hasLFN =0x01, // If recFlag == isOpen the lfn is present
164  hasRW =0x02 // If recFlag == isOpen file opened r/w
165  };
166 
167 char recType; // RecTval: isClose | isOpen | isTime | isXfr
168 char recFlag; // RecFval: Record type-specific flags
169 short recSize; // Size of this record in bytes
170 union
171 {
172 kXR_unt32 fileID; // dictid of file for all rectypes except "disc" & "time"
173 kXR_unt32 userID; // dictid of user for rectypes equal "disc"
174 short nRecs[2]; // isTime: nRecs[0] == isXfr recs nRecs[1] == total recs
175 };
176 };
177 
178 // The following record is always be present as the first record in the udp
179 // udp packet and should be used to establish the recording window.
180 //
182 {
184 int tBeg; // time(0) of following record
185 int tEnd; // time(0) when packet was sent
186 };
187 
188 // The following variable length structure exists in XrdXrootdMonFileOPN if
189 // "lfn" has been specified. It exists only when recFlag & hasLFN is TRUE.
190 // The user's dictid will be zero (missing) if user monitoring is not enabled.
191 //
193 {
194 kXR_unt32 user; // Monitoring dictid for the user, may be 0.
195 char lfn[1028];// Variable length, use recSize!
196 };
197 
198 // The following is reported when a file is opened. If "lfn" was specified and
199 // Hdr.recFlag & hasLFN is TRUE the XrdXrootdMonFileLFN structure is present.
200 // However, it variable in size and the next record will be found using recSize.
201 // The lfn is gauranteed to end with at least one null byte.
202 //
204 {
206 long long fsz; // 8 file size at time of open
207 XrdXrootdMonFileLFN ufn; // Present ONLY if recFlag & hasLFN is TRUE
208 };
209 
210 // The following data is collected on a per file basis
211 //
212 struct XrdXrootdMonStatOPS // 48 Bytes
213 {
214 int read; // Number of read() calls
215 int readv; // Number of readv() calls
216 int write; // Number of write() calls
217 short rsMin; // Smallest readv() segment count
218 short rsMax; // Largest readv() segment count
219 long long rsegs; // Number of readv() segments
220 int rdMin; // Smallest read() request size
221 int rdMax; // Largest read() request size
222 int rvMin; // Smallest readv() request size
223 int rvMax; // Largest readv() request size
224 int wrMin; // Smallest write() request size
225 int wrMax; // Largest write() request size
226 };
227 
229 {
230 long long dlong;
231 double dreal;
232 };
233 
234 struct XrdXrootdMonStatSSQ // 32 Bytes (all values net ordered IEEE754)
235 {
236 XrdXrootdMonDouble read; // Sum (all read requests)**2 (size)
237 XrdXrootdMonDouble readv; // Sum (all readv requests)**2 (size as a unit)
238 XrdXrootdMonDouble rsegs; // Sum (all readv segments)**2 (count as a unit)
239 XrdXrootdMonDouble write; // Sum (all write requests)**2 (size)
240 };
241 
242 // The following transfer data is collected for each open file.
243 //
245 {
246 long long read; // Bytes read from file so far using read()
247 long long readv; // Bytes read from file so far using readv()
248 long long write; // Bytes written to file so far
249 };
250 
251 // The following is reported upon file close. This is a variable length record.
252 // The record always contains XrdXrootdMonStatXFR after XrdXrootdMonFileHdr.
253 // If (recFlag & hasOPS) TRUE XrdXrootdMonStatOPS follows XrdXrootdMonStatXFR
254 // If (recFlag & hasSSQ) TRUE XrdXrootdMonStatSQV follows XrdXrootdMonStatOPS
255 // The XrdXrootdMonStatSSQ information is present only if "ssq" was specified.
256 //
257 struct XrdXrootdMonFileCLS // 32 | 80 | 96 Bytes
258 {
259 XrdXrootdMonFileHdr Hdr; // Always present (recSize has full length)
260 XrdXrootdMonStatXFR Xfr; // Always present
261 XrdXrootdMonStatOPS Ops; // Only present when (recFlag & hasOPS) is True
262 XrdXrootdMonStatSSQ Ssq; // Only present when (recFlag & hasSSQ) is True
263 };
264 
265 // The following is reported when a user ends a session.
266 //
268 {
270 };
271 
272 // The following is reported each interval*count for each open file when "xfr"
273 // is specified. These records may be interspersed with other records.
274 //
275 struct XrdXrootdMonFileXFR // 32 Bytes
276 {
277 XrdXrootdMonFileHdr Hdr; // Always present with recType == isXFR
278 XrdXrootdMonStatXFR Xfr; // Always present
279 };
280 #endif
unsigned char kXR_char
Definition: XPtypes.hh:38
const kXR_char XROOTD_MON_OPENR
Definition: XrdXrootdMonData.hh:121
short rsMax
Definition: XrdXrootdMonData.hh:218
const kXR_char XROOTD_MON_MAPINFO
Definition: XrdXrootdMonData.hh:99
union XrdXrootdMonTrace::@5 arg2
double dreal
Definition: XrdXrootdMonData.hh:231
const kXR_char XROOTD_MON_BOUNDP
Definition: XrdXrootdMonData.hh:133
const kXR_char XROOTD_MON_REDIRECT
Definition: XrdXrootdMonData.hh:114
Definition: XrdXrootdMonData.hh:163
int rvMax
Definition: XrdXrootdMonData.hh:223
kXR_unt32 dictid
Definition: XrdXrootdMonData.hh:82
short rsMin
Definition: XrdXrootdMonData.hh:217
const kXR_char XROOTD_MON_RM
Definition: XrdXrootdMonData.hh:127
XrdXrootdMonStatOPS Ops
Definition: XrdXrootdMonData.hh:261
const kXR_char XROOTD_MON_PREP
Definition: XrdXrootdMonData.hh:125
int rvMin
Definition: XrdXrootdMonData.hh:222
const kXR_char XROOTD_MON_RMDIR
Definition: XrdXrootdMonData.hh:128
kXR_char pseq
Definition: XrdXrootdMonData.hh:41
Definition: XrdXrootdMonData.hh:73
XrdXrootdMonFileLFN ufn
Definition: XrdXrootdMonData.hh:207
const kXR_char XROOTD_MON_FORCED
Definition: XrdXrootdMonData.hh:132
Definition: XrdXrootdMonData.hh:157
const kXR_char XROOTD_MON_QUERY
Definition: XrdXrootdMonData.hh:126
kXR_unt32 dictid
Definition: XrdXrootdMonData.hh:54
const kXR_char XROOTD_MON_MAPUSER
Definition: XrdXrootdMonData.hh:105
union XrdXrootdMonRedir::@7 arg1
unsigned short kXR_unt16
Definition: XPtypes.hh:40
const kXR_char XROOTD_MON_STAT
Definition: XrdXrootdMonData.hh:129
const kXR_char XROOTD_MON_LOCATE
Definition: XrdXrootdMonData.hh:118
Definition: XrdXrootdMonData.hh:203
kXR_int64 sID
Definition: XrdXrootdMonData.hh:75
Definition: XrdXrootdMonData.hh:46
kXR_int64 val
Definition: XrdXrootdMonData.hh:47
kXR_char Type
Definition: XrdXrootdMonData.hh:65
const kXR_char XROOTD_MON_DISC
Definition: XrdXrootdMonData.hh:88
union XrdXrootdMonRedir::@6 arg0
Definition: XrdXrootdMonData.hh:153
Definition: XrdXrootdMonData.hh:267
XrdXrootdMonStatSSQ Ssq
Definition: XrdXrootdMonData.hh:262
XrdXrootdMonFileHdr Hdr
Definition: XrdXrootdMonData.hh:259
Definition: XrdXrootdMonData.hh:244
XrdXrootdMonFileHdr Hdr
Definition: XrdXrootdMonData.hh:183
XrdXrootdMonHeader hdr
Definition: XrdXrootdMonData.hh:59
Definition: XrdXrootdMonData.hh:80
const kXR_char XROOTD_MON_TRUNC
Definition: XrdXrootdMonData.hh:130
kXR_unt32 userID
Definition: XrdXrootdMonData.hh:173
const int XROOTD_MON_SRCMASK
Definition: XrdXrootdMonData.hh:135
XrdXrootdMonDouble readv
Definition: XrdXrootdMonData.hh:237
Definition: XrdXrootdMonData.hh:212
const kXR_char XROOTD_MON_APPID
Definition: XrdXrootdMonData.hh:86
XrdXrootdMonDouble read
Definition: XrdXrootdMonData.hh:236
long long fsz
Definition: XrdXrootdMonData.hh:206
XrdXrootdMonHeader hdr
Definition: XrdXrootdMonData.hh:74
int tEnd
Definition: XrdXrootdMonData.hh:185
kXR_unt16 plen
Definition: XrdXrootdMonData.hh:42
Definition: XrdXrootdMonData.hh:58
char info[1024+256]
Definition: XrdXrootdMonData.hh:83
XrdXrootdMonTrace info[sizeof(XrdXrootdMonTrace)]
Definition: XrdXrootdMonData.hh:60
int tBeg
Definition: XrdXrootdMonData.hh:184
Definition: XrdXrootdMonData.hh:161
const kXR_char XROOTD_MON_MAPMIGR
Definition: XrdXrootdMonData.hh:100
const kXR_char XROOTD_MON_REDSID
Definition: XrdXrootdMonData.hh:111
int wrMin
Definition: XrdXrootdMonData.hh:224
recTval
Definition: XrdXrootdMonData.hh:153
const kXR_char XROOTD_MON_MAPFSTA
Definition: XrdXrootdMonData.hh:98
kXR_int32 buflen
Definition: XrdXrootdMonData.hh:51
union XrdXrootdMonTrace::@3 arg0
const kXR_char XROOTD_MON_READV
Definition: XrdXrootdMonData.hh:90
const kXR_char XROOTD_MON_MV
Definition: XrdXrootdMonData.hh:124
long long dlong
Definition: XrdXrootdMonData.hh:230
Definition: XrdXrootdMonData.hh:228
const kXR_char XROOTD_MON_MAPREDR
Definition: XrdXrootdMonData.hh:102
char recFlag
Definition: XrdXrootdMonData.hh:168
kXR_char Dent
Definition: XrdXrootdMonData.hh:66
const kXR_char XROOTD_MON_MAPPURG
Definition: XrdXrootdMonData.hh:101
XrdXrootdMonRedir info[sizeof(XrdXrootdMonRedir)]
Definition: XrdXrootdMonData.hh:77
kXR_unt32 dictid
Definition: XrdXrootdMonData.hh:69
Definition: XrdXrootdMonData.hh:160
Definition: XrdXrootdMonData.hh:63
Definition: XrdXrootdMonData.hh:257
const kXR_char XROOTD_MON_MAPSTAG
Definition: XrdXrootdMonData.hh:103
const kXR_char XROOTD_MON_OPEN
Definition: XrdXrootdMonData.hh:89
XrdXrootdMonFileHdr Hdr
Definition: XrdXrootdMonData.hh:277
const int XROOTD_MON_TRGMASK
Definition: XrdXrootdMonData.hh:136
const kXR_char XROOTD_MON_MAPIDNT
Definition: XrdXrootdMonData.hh:96
const kXR_char XROOTD_MON_MAPPATH
Definition: XrdXrootdMonData.hh:97
kXR_char sXX[8]
Definition: XrdXrootdMonData.hh:76
Definition: XrdXrootdMonData.hh:181
int wrMax
Definition: XrdXrootdMonData.hh:225
kXR_int16 Port
Definition: XrdXrootdMonData.hh:67
const kXR_char XROOTD_MON_REDTIME
Definition: XrdXrootdMonData.hh:112
unsigned int kXR_unt32
Definition: XPtypes.hh:63
short recSize
Definition: XrdXrootdMonData.hh:169
XrdXrootdMonFileHdr Hdr
Definition: XrdXrootdMonData.hh:205
const kXR_char XROOTD_MON_WINDOW
Definition: XrdXrootdMonData.hh:93
kXR_char code
Definition: XrdXrootdMonData.hh:40
kXR_int32 Window
Definition: XrdXrootdMonData.hh:52
const kXR_char XROOTD_MON_CLOSE
Definition: XrdXrootdMonData.hh:87
int write
Definition: XrdXrootdMonData.hh:216
const kXR_char XROOTD_MON_MKDIR
Definition: XrdXrootdMonData.hh:123
short nRecs[2]
Definition: XrdXrootdMonData.hh:174
Definition: XrdXrootdMonData.hh:39
Definition: XrdXrootdMonData.hh:234
int read
Definition: XrdXrootdMonData.hh:214
kXR_unt32 wTot
Definition: XrdXrootdMonData.hh:53
char recType
Definition: XrdXrootdMonData.hh:167
Definition: XrdXrootdMonData.hh:164
XrdXrootdMonFileHdr Hdr
Definition: XrdXrootdMonData.hh:269
XrdXrootdMonStatXFR Xfr
Definition: XrdXrootdMonData.hh:278
XrdXrootdMonDouble rsegs
Definition: XrdXrootdMonData.hh:238
kXR_unt32 user
Definition: XrdXrootdMonData.hh:194
kXR_unt32 fileID
Definition: XrdXrootdMonData.hh:172
Definition: XrdXrootdMonData.hh:275
long long readv
Definition: XrdXrootdMonData.hh:247
XrdXrootdMonDouble write
Definition: XrdXrootdMonData.hh:239
recFval
Definition: XrdXrootdMonData.hh:160
const kXR_char XROOTD_MON_OPENW
Definition: XrdXrootdMonData.hh:122
const int XROOTD_MON_NEWSTID
Definition: XrdXrootdMonData.hh:137
const kXR_char XROOTD_MON_OPENDIR
Definition: XrdXrootdMonData.hh:119
int kXR_int32
Definition: XPtypes.hh:62
Definition: XrdXrootdMonData.hh:162
int rdMax
Definition: XrdXrootdMonData.hh:221
XrdXrootdMonHeader hdr
Definition: XrdXrootdMonData.hh:81
kXR_int32 stod
Definition: XrdXrootdMonData.hh:43
Definition: XrdXrootdMonData.hh:156
Definition: XrdXrootdMonData.hh:154
struct XrdXrootdMonRedir::@6::@8 rdr
Definition: XrdXrootdMonData.hh:151
int rdMin
Definition: XrdXrootdMonData.hh:220
const kXR_char XROOTD_MON_MAPXFER
Definition: XrdXrootdMonData.hh:106
Definition: XrdXrootdMonData.hh:192
const kXR_char XROOTD_MON_REDHOST
Definition: XrdXrootdMonData.hh:92
XrdXrootdMonStatXFR Xfr
Definition: XrdXrootdMonData.hh:260
const kXR_char XROOTD_MON_REDLOCAL
Definition: XrdXrootdMonData.hh:115
kXR_unt32 rTot[2]
Definition: XrdXrootdMonData.hh:50
const kXR_char XROOTD_MON_READU
Definition: XrdXrootdMonData.hh:91
kXR_unt16 sVal[4]
Definition: XrdXrootdMonData.hh:49
long long kXR_int64
Definition: XPtypes.hh:71
char lfn[1028]
Definition: XrdXrootdMonData.hh:195
long long write
Definition: XrdXrootdMonData.hh:248
const kXR_char XROOTD_MON_MAPTRCE
Definition: XrdXrootdMonData.hh:104
const kXR_char XROOTD_MON_OPENC
Definition: XrdXrootdMonData.hh:120
union XrdXrootdMonTrace::@4 arg1
long long rsegs
Definition: XrdXrootdMonData.hh:219
long long read
Definition: XrdXrootdMonData.hh:246
int readv
Definition: XrdXrootdMonData.hh:215
const kXR_char XROOTD_MON_CHMOD
Definition: XrdXrootdMonData.hh:117
Definition: XrdXrootdMonData.hh:155
kXR_int32 Window
Definition: XrdXrootdMonData.hh:64
short kXR_int16
Definition: XPtypes.hh:39