XrdXrootdMonitor.hh

Go to the documentation of this file.

#ifndef __XRDXROOTDMONITOR__
#define __XRDXROOTDMONITOR__
/******************************************************************************/
/*                                                                            */
/*                   X r d X r o o t d M o n i t o r . h h                    */
/*                                                                            */
/* (c) 2004 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
/* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/

#include <cinttypes>
#include <cstdlib>
#include <ctime>
#include <netinet/in.h>
#include <sys/types.h>

#include "XrdSec/XrdSecMonitor.hh"
#include "XrdSys/XrdSysPthread.hh"
#include "XrdXrootd/XrdXrootdMonData.hh"
#include "XProtocol/XPtypes.hh"

/******************************************************************************/
/*                            X r d M o n i t o r                             */
/******************************************************************************/

#define XROOTD_MON_ALL   0x00000001
#define XROOTD_MON_FILE  0x00000002
#define XROOTD_MON_IO    0x00000004
#define XROOTD_MON_INFO  0x00000008
#define XROOTD_MON_USER  0x00000010
#define XROOTD_MON_AUTH  0x00000020
#define XROOTD_MON_PATH    (XROOTD_MON_IO   | XROOTD_MON_FILE)
#define XROOTD_MON_REDR  0x00000040
#define XROOTD_MON_IOV   0x00000080
#define XROOTD_MON_FSTA  0x00000100
#define XROOTD_MON_CCM   0x00000200
#define XROOTD_MON_PFC   0x00000400
#define XROOTD_MON_TCPMO 0x00000800
#define XROOTD_MON_TPC   0x00001000
#define XROOTD_MON_THROT 0x00002000
#define XROOTD_MON_GSTRM (XROOTD_MON_CCM | XROOTD_MON_PFC | XROOTD_MON_TCPMO | XROOTD_MON_THROT)

#define XROOTD_MON_FSLFN    1
#define XROOTD_MON_FSOPS    2
#define XROOTD_MON_FSSSQ    4
#define XROOTD_MON_FSXFR    8

class XrdScheduler;
class XrdNetMsg;
class XrdXrootdMonFile;
  
/******************************************************************************/
/*                C l a s s   X r d X r o o t d M o n i t o r                 */
/******************************************************************************/
  
class XrdXrootdMonitor
{
public:
       class User;
friend class User;
friend class XrdXrootdMonFile;

// All values for Add_xx() must be passed in network byte order
//
inline void              Add_rd(kXR_unt32 dictid,
                                kXR_int32 rlen,
                                kXR_int64 offset)
                               {Add_io(dictid, rlen, offset);}

inline void              Add_rv(kXR_unt32 dictid,
                                kXR_int32 rlen,
                                kXR_int16 vcnt,
                                kXR_char  vseq,
                                kXR_char  vtype)
                               {if (lastWindow != currWindow) Mark();
                                   else if (nextEnt == lastEnt) Flush();
                                monBuff->info[nextEnt].arg0.id[0]    = vtype;
                                monBuff->info[nextEnt].arg0.id[1]    = vseq;
                                monBuff->info[nextEnt].arg0.sVal[1]  = vcnt;
                                monBuff->info[nextEnt].arg0.rTot[1]  = 0;
                                monBuff->info[nextEnt].arg1.buflen   = rlen;
                                monBuff->info[nextEnt++].arg2.dictid = dictid;
                               }

inline void              Add_wr(kXR_unt32 dictid,
                                kXR_int32 wlen, 
                                kXR_int64 offset)
                               {Add_io(dictid,(kXR_int32)htonl(-wlen),offset);}

       void              appID(char *id);

       void              Close(kXR_unt32 dictid, long long rTot, long long wTot);

       void              Disc(kXR_unt32 dictid, int csec, char Flags=0);

static void              Defaults(char *dest1, int m1, char *dest2, int m2);
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               Flushing() {return autoFlush;}

static kXR_unt32         GetDictID(bool hbo=false);

static void              Ident() {Send(-1, idRec, idLen);}

static void              Init(XrdScheduler *sp,    XrdSysError *errp,
                              const char   *iHost, const char  *iProg,
                              const char   *iName, int Port);

static int               Init();

static bool              ModeEnabled(int mode)
                                    {return ((monMode1|monMode2) & mode) != 0;}

       void              Open(kXR_unt32 dictid, off_t fsize);

static int               Redirect() {return monREDR;}

static int               Redirect(kXR_unt32  mID, const char *hName, int Port,
                                  const char opC, const char *Path);

static int               Send(int mmode, void *buff, int size, bool setseq=true);

static time_t            Tick();

/******************************************************************************/

class   Hello
{
public:

static  bool       Hail();

virtual void       Ident() {};

                   Hello(const char *dest, char mode);

virtual           ~Hello() {if (theDest) free(theDest);}

private:
static  Hello     *First;
        Hello     *Next;
        char      *theDest;
        char       theMode;
};

/******************************************************************************/

class  User : public XrdSecMonitor
{
public:

XrdXrootdMonitor *Agent;
kXR_unt32         Did;
char              Iops;
char              Fops;
short             Len;
char             *Name;

inline int         Auths() {return XrdXrootdMonitor::monAUTH;}

void               Clear() {if (Name)  {free(Name); Name = 0; Len = 0;}
                            if (Agent) {Agent->unAlloc(Agent); Agent = 0;}
                            Did = 0; Iops = Fops = 0;
                           }

       void        Enable();

       void        Disable();

inline int         Files()  {return (Agent ? Fops : 0);}

inline int         Fstat()  {return monFSTAT;}

inline int         Info()   {return (Agent ? XrdXrootdMonitor::monINFO : 0);}

inline int         InOut()  {return (Agent ? Iops : 0);}

inline int         Logins() {return (Agent ? XrdXrootdMonitor::monUSER : 0);}

inline kXR_unt32   MapInfo(const char *Info)
                          {return XrdXrootdMonitor::Map(XROOTD_MON_MAPINFO,
                                                        *this, Info);
                          }

inline kXR_unt32   MapPath(const char *Path)
                          {return XrdXrootdMonitor::Map(XROOTD_MON_MAPPATH,
                                                        *this, Path);
                          }

       void        Register(const char *Uname, const char *Hname,
                            const char *Pname, unsigned int xSID=0);

       void        Report(const char *Info)
                         {Did=XrdXrootdMonitor::Map(XROOTD_MON_MAPUSER,*this,Info);}

       void        Report(int eCode, int aCode);

       bool        Report(WhatInfo infoT, const char *info) override;

inline int         Ready()  {return XrdXrootdMonitor::monACTIVE;}

       User() : Agent(0), Did(0), Iops(0), Fops(0), Len(0), Name(0) {}
      ~User() {Clear();}
};

/******************************************************************************/

static XrdXrootdMonitor *altMon;

                         XrdXrootdMonitor();

static const int         rdrMax = 8;

private:
                        ~XrdXrootdMonitor(); 

static
struct MonRdrBuff
      {MonRdrBuff        *Next;
       XrdXrootdMonBurr  *Buff;
       int                nextEnt;
       int                flushIt;
       kXR_int32          lastTOD;
       XrdSysMutex        Mutex;
      }                   rdrMon[rdrMax];
static MonRdrBuff        *rdrMP;
static XrdSysMutex        rdrMutex;

inline void              Add_io(kXR_unt32 duid, kXR_int32 blen, kXR_int64 offs)
                               {if (lastWindow != currWindow) Mark();
                                   else if (nextEnt == lastEnt) Flush();
                                monBuff->info[nextEnt].arg0.val      = offs;
                                monBuff->info[nextEnt].arg1.buflen   = blen;
                                monBuff->info[nextEnt++].arg2.dictid = duid;
                               }
static XrdXrootdMonitor *Alloc(int force=0);
       unsigned char     do_Shift(long long xTot, unsigned int &xVal);
       void              Dup(XrdXrootdMonTrace *mrec);
static void              fillHeader(XrdXrootdMonHeader *hdr,
                                    const char id, int size);
static MonRdrBuff       *Fetch();
       void              Flush();
static void              Flush(MonRdrBuff *mP);
static kXR_unt32         Map(char  code, XrdXrootdMonitor::User &uInfo,
                             const char *path);
       void              Mark();
static void              startClock();
static void              unAlloc(XrdXrootdMonitor *monp);

static XrdSysMutex        windowMutex;
static char              *idRec;
static int                idLen;
static char              *Dest1;
static int                monMode1;
static XrdNetMsg         *InetDest1;
static char              *Dest2;
static int                monMode2;
static XrdNetMsg         *InetDest2;
       XrdXrootdMonBuff  *monBuff;
static int                monBlen;
       int                nextEnt;
static int                lastEnt;
static int                lastRnt;
static int                autoFlash;
static int                autoFlush;
static int                FlushTime;
       kXR_int32          lastWindow;
static kXR_int32          currWindow;
static int                rdrTOD;
static int                rdrWin;
static int                rdrNum;
static kXR_int32          sizeWindow;
static int                isEnabled;
static int                numMonitor;
static int                monIdent;
static int                monRlen;
static char               monIO;
static char               monINFO;
static char               monFILE;
static char               monREDR;
static char               monUSER;
static char               monAUTH;
static char               monACTIVE;
static char               monFSTAT;
static char               monCLOCK;
};
#endif