XRootD
Loading...
Searching...
No Matches
XrdCmsCluster.hh
Go to the documentation of this file.
1#ifndef __CMS_CLUSTER__H
2#define __CMS_CLUSTER__H
3/******************************************************************************/
4/* */
5/* X r d C m s C l u s t e r . h h */
6/* */
7/* (c) 2007 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 <cstdlib>
34#include <cstring>
35#include <strings.h>
36#include <netinet/in.h>
37
38#include "XrdCms/XrdCmsTypes.hh"
39#include "XrdOuc/XrdOucTList.hh"
40#include "XrdOuc/XrdOucEnum.hh"
43
44class XrdLink;
45class XrdCmsDrop;
46class XrdCmsNode;
47class XrdCmsSelect;
48class XrdCmsSelector;
49class XrdNetAddr;
50
51namespace XrdCms
52{
53struct CmsRRHdr;
54}
55
56/******************************************************************************/
57/* O p t i o n F l a g s */
58/******************************************************************************/
59
60namespace XrdCms
61{
62
63// Flags passed to Add()
64//
65static const int CMS_noStage = 1;
66static const int CMS_Suspend = 2;
67static const int CMS_Perm = 4;
68static const int CMS_isMan = 8;
69static const int CMS_Lost = 16;
70static const int CMS_isPeer = 32;
71static const int CMS_isProxy = 64;
72static const int CMS_noSpace =128;
73static const int CMS_isSuper =256;
74
75static const int CMS_isVers3 =0x01000000;
76
79
80// Class passed to Space()
81//
83{
84public:
85
86long long Total; // Total space
87long long TotFr; // Total space free
88int wMinF; // Free space minimum to select wFree node
89int wFree; // Free space for nodes providing r/w access (largest one)
90int wNum; // Number of nodes providing r/w access
91int wUtil; // Average utilization (largest one)
92int sFree; // Free space for nodes providing staging (largest one)
93int sNum; // Number of nodes providing staging
94int sUtil; // Average utilization (largest one)
95
96 SpaceData() : Total(0), TotFr(0),wMinF(0),
97 wFree(0), wNum(0), wUtil(0),
98 sFree(0), sNum(0), sUtil(0) {}
100};
101}
102
103/******************************************************************************/
104/* C l a s s X r d C m s C l u s t e r */
105/******************************************************************************/
106
107// This a single-instance global class
108//
109class XrdCmsBaseFR;
110class XrdCmsClustID;
111class XrdCmsSelected;
112class XrdOucTList;
113
115{
116public:
117friend class XrdCmsDrop;
118
119int NodeCnt; // Number of active nodes
120
121// Called to add a new node to the cluster. Status values are defined above.
122//
123XrdCmsNode *Add(XrdLink *lp, int dport, int Status,
124 int sport, const char *theNID, const char *theIF);
125
126// Put nodes in or remove from a blacklist
127//
128virtual void BlackList(XrdOucTList *blP);
129
130// Sends a message to all nodes matching smask (three forms for convenience)
131//
132SMask_t Broadcast(SMask_t, const struct iovec *, int, int tot=0);
133
135 char *Data, int Dlen=0);
136
138 void *Data, int Dlen);
139
140// Sends a message to a single node in a round-robbin fashion.
141//
142int Broadsend(SMask_t smask, XrdCms::CmsRRHdr &Hdr,
143 void *Data, int Dlen);
144
145// Returns the node mask matching the given IP address
146//
147SMask_t getMask(const XrdNetAddr *addr);
148
149// Returns the node mask matching the given cluster ID
150//
151SMask_t getMask(const char *Cid);
152
153// Extracts out node information. Opts are one or more of CmsLSOpts
154//
155enum CmsLSOpts {LS_NULL=0, LS_IPO=0x0100, LS_IDNT=0x0200,
156 LS_ANY =0x0400, LS_IFMASK = 0x0f};
157
158XrdCmsSelected *List(SMask_t mask, CmsLSOpts opts, bool &oksel);
159
160// Returns the location of a file
161//
162int Locate(XrdCmsSelect &Sel);
163
164// Always run as a separate thread to monitor subscribed node performance
165//
166void *MonPerf();
167
168// Alwats run as a separate thread to maintain the node reference count
169//
170void *MonRefs();
171
172// Return total number of redirect references
173//
174long long Refs() {return SelWtot+SelRtot;}
175
176// Called to remove a node from the cluster
177//
178void Remove(XrdCmsNode *theNode);
179
180void Remove(const char *reason, XrdCmsNode *theNode, int immed=0);
181
182// Called to reset the node reference counts for nodes matching smask
183//
184void ResetRef(SMask_t smask, bool isLocked=false);
185
186// Called to select the best possible node to serve a file (two forms)
187//
188static const int NotFound = -1; // Locate() failed to find resource
189static const int Wait4CBk = -2; // Only returned by Locate()
190static const int RetryErr = -3; // Used only by XrdCmsNode retry processing
191static const int EReplete = -4; // Failed, error information is complete
192
193int Select(XrdCmsSelect &Sel);
194
195int Select(SMask_t pmask, int &port, char *hbuff, int &hlen,
196 int isrw, int isMulti, int ifWant);
197
198// Manipulate the global selection lock
199//
200void SLock(bool dolock, bool wrmode=true)
201 {if (dolock)
202 {if (wrmode) STMutex.WriteLock();
203 else STMutex.ReadLock();
204 }
205 else STMutex.UnLock();
206 }
207
208// Called to get cluster space (for managers and supervisors only)
209//
210void Space(XrdCms::SpaceData &sData, SMask_t smask);
211
212// Called to return statistics
213//
214int Stats(char *bfr, int bln); // Server
215int Statt(char *bfr, int bln); // Manager
216
218virtual ~XrdCmsCluster() {} // This object should never be deleted
219
220private:
221XrdCmsNode *AddAlt(XrdCmsClustID *cidP, XrdLink *lp, int port, int Status,
222 int sport, const char *theNID, const char *theIF);
223XrdCmsNode *calcDelay(XrdCmsSelector &selR);
224int Drop(int sent, int sinst, XrdCmsDrop *djp=0);
225void Record(char *path, const char *reason, bool force=false);
226bool maxBits(SMask_t mVec, int mbits);
227int Multiple(SMask_t mVec);
228enum {eExists, eDups, eROfs, eNoRep, eNoSel, eNoEnt}; // Passed to SelFail
229int SelFail(XrdCmsSelect &Sel, int rc);
230int SelNode(XrdCmsSelect &Sel, SMask_t pmask, SMask_t amask);
231XrdCmsNode *SelbyCost(SMask_t, XrdCmsSelector &selR);
232XrdCmsNode *SelbyLoad(SMask_t, XrdCmsSelector &selR);
233XrdCmsNode *SelbyLoadR(SMask_t, XrdCmsSelector &selR);
234XrdCmsNode *SelbyRef (SMask_t, XrdCmsSelector &selR);
235int SelDFS(XrdCmsSelect &Sel, SMask_t amask,
236 SMask_t &pmask, SMask_t &smask, int isRW);
237void sendAList(XrdLink *lp);
238void setAltMan(int snum, XrdLink *lp, int port);
239int Unreachable(XrdCmsSelect &Sel, bool none);
240int Unuseable(XrdCmsSelect &Sel);
241
242// Number of <host>:Port characters per entry was INET6_ADDRSTRLEN+10
243//
244static const int AltSize = 254; // We may revert to IP address
245
246XrdSysRWLock STMutex; // Protects all node information variables
247XrdCmsNode *NodeTab[STMax]; // Current set of nodes
248int NodeWeight[STMax]; // Current set of load balancing weights
249
250int STHi; // NodeTab high watermark
251int Reserved;
252RAtomic_llong SelWtot; // Total number of r/w selections (successful)
253RAtomic_llong SelRtot; // Total number of r/o selections (successful)
254RAtomic_llong SelTcnt; // Total number of all selections
255
256// The following is a list of IP:Port tokens that identify supervisor nodes.
257// The information is sent via the try request to redirect nodes; as needed.
258// The list is alays rotated by one entry each time it is sent.
259//
260char AltMans[STMax*AltSize]; // ||123.123.123.123:12345|| = 21
261char *AltMend;
262int AltMent;
263
264// The following two variables are protected by the STMutex
265//
266SMask_t peerHost; // Nodes that are acting as peers
267SMask_t peerMask; // Always ~peerHost
268};
269
271
272namespace XrdCms
273{
274extern XrdCmsCluster Cluster;
275}
276#endif
#define STMax
unsigned long long SMask_t
#define XRDOUC_ENUM_OPERATORS(T)
Definition XrdOucEnum.hh:22
struct myOpts opts
XrdSys::RAtomic< long long > RAtomic_llong
SMask_t getMask(const XrdNetAddr *addr)
void SLock(bool dolock, bool wrmode=true)
void Space(XrdCms::SpaceData &sData, SMask_t smask)
int Broadsend(SMask_t smask, XrdCms::CmsRRHdr &Hdr, void *Data, int Dlen)
long long Refs()
int Select(XrdCmsSelect &Sel)
int Locate(XrdCmsSelect &Sel)
static const int EReplete
void ResetRef(SMask_t smask, bool isLocked=false)
SMask_t Broadcast(SMask_t, const struct iovec *, int, int tot=0)
XrdCmsSelected * List(SMask_t mask, CmsLSOpts opts, bool &oksel)
static const int RetryErr
XrdCmsNode * Add(XrdLink *lp, int dport, int Status, int sport, const char *theNID, const char *theIF)
static const int NotFound
static const int Wait4CBk
void Remove(XrdCmsNode *theNode)
int Stats(char *bfr, int bln)
virtual ~XrdCmsCluster()
virtual void BlackList(XrdOucTList *blP)
friend class XrdCmsDrop
int Statt(char *bfr, int bln)
static const int CMS_hasAlts
static const int CMS_isSuper
static const int CMS_noSpace
static const int CMS_noStage
XrdCmsCluster Cluster
static const int CMS_Lost
static const int CMS_isMan
static const int CMS_Perm
static const int CMS_isVers3
static const int CMS_isPeer
static const int CMS_isProxy
static const int CMS_Suspend
static const int CMS_notServ