xrootd
XrdCmsSelect.hh
Go to the documentation of this file.
1 #ifndef __CMS_SELECT_HH
2 #define __CMS_SELECT_HH
3 /******************************************************************************/
4 /* */
5 /* X r d C m s S e l e c t . 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 <netinet/in.h>
34 
35 #include "XrdCms/XrdCmsKey.hh"
36 
37 /******************************************************************************/
38 /* C l a s s X r d C m s S e l e c t */
39 /******************************************************************************/
40 
41 class XrdCmsRRQInfo;
42 
44 {
45 public:
46 XrdCmsKey Path; // In: Path to select or lookup in the cache
47 XrdCmsRRQInfo *InfoP; // In: Fast redirect routing
48 SMask_t nmask; // In: Nodes to avoid
49 SMask_t smask; // Out: Nodes selected
50 struct iovec *iovP; // In: Prepare notification I/O vector
51 int iovN; // In: Prepare notification I/O vector count
52 int Opts; // In: One or more of the following enums
53 
54 enum {Write = 0x00010, // File will be open in write mode (select & cache)
55  NewFile = 0x00020, // File will be created may not exist (select)
56  Online = 0x00040, // Only consider online files (select & prep)
57  Trunc = 0x00080, // File will be truncated (Select only)
58  Create = 0x000A0, // Create file, truncate if exists
59  Defer = 0x00100, // Do not select a server now (prep only)
60  Peers = 0x00200, // Peer clusters may be selected (select only)
61  Refresh = 0x00400, // Cache should be refreshed (all)
62  Asap = 0x00800, // Respond as soon as possible (locate only)
63  noBind = 0x01000, // Do not new bind file to a server (select only)
64  isMeta = 0x02000, // Only inode information being changed(select only)
65  Freshen = 0x04000, // Freshen access times (prep only)
66  Replica = 0x08000, // File will be replicated (w/ Create) (select only)
67  NoTryLim= 0x10000, // Do not apply the retry limit
68  MWFiles = 0x20000, // Multiwrite files allowed (select only)
69  Advisory= 0x40000, // Cache A/D is advisory (no delay) (have & cache)
70  Pending = 0x80000, // File being staged (have & cache)
71  ifWant = 0x0000f, // XrdNetIF::ifType encoding location
72 
73  Pack = 0x00010000, // Packed selection
74  UseRef = 0x00020000 // Selection by reference count only
75  };
76 
77 struct {SMask_t wf; // Out: Writable locations
78  SMask_t hf; // Out: Existing locations
79  SMask_t pf; // Out: Pending locations
80  SMask_t bf; // Out: Bounced locations
81  } Vec;
82 
83 struct {int Port; // Out: Target node port number
84  char Data[256]; // Out: Target node or error message
85  int DLen; // Out: Length of Data including null byte
86  } Resp;
87 
88  XrdCmsSelect(int opts=0, char *thePath=0, int thePLen=0)
89  : Path(thePath,thePLen), InfoP(0), smask(0), Opts(opts)
90  {Resp.Port = 0; *Resp.Data = '\0'; Resp.DLen = 0;}
92 };
93 
94 /******************************************************************************/
95 /* C l a s s X r d C m s S e l e c t e d */
96 /******************************************************************************/
97 
98 class XrdCmsSelected // Argument to List() after select or locate
99 {
100 public:
101 
102 static const int IdentSize = 264;
103 
106 int Id;
107 int IdentLen; // 12345678901234567890123456
108 char Ident[IdentSize]; // [::123.123.123.123]:123456
109 int Port;
112 int Shrin; // Share intervals used
113 char Share; // Share
114 char RoleID; // Role Identifier
115 char Rsvd[2];
116 int Status; // One of the following
117 
118 enum {Disable = 0x0001,
119  NoStage = 0x0002,
120  Offline = 0x0004,
121  Suspend = 0x0008,
122  isRW = 0x0010,
123  isMangr = 0x0100
124  };
125 
127 
129 };
130 
131 /******************************************************************************/
132 /* C l a s s X r d C m s S e l e c t o r */
133 /******************************************************************************/
134 
136 {
137 public:
138 const char *reason;
139  int delay;
140  short nPick;
141  char needNet;
142  char needSpace;
143  bool selPack;
144  bool xFull;
145  bool xNoNet;
146  bool xOff;
147  bool xOvld;
148  bool xSusp;
149 
150 inline void Reset() {reason = 0; delay = 0; nPick = 0;
151  xFull = xNoNet = xOff = xOvld = xSusp = false;
152  }
153 };
154 #endif
int RefTotW
Definition: XrdCmsSelect.hh:110
SMask_t hf
Definition: XrdCmsSelect.hh:78
XrdCmsSelected * next
Definition: XrdCmsSelect.hh:104
int Port
Definition: XrdCmsSelect.hh:83
char Rsvd[2]
Definition: XrdCmsSelect.hh:115
Definition: XrdCmsSelect.hh:69
int DLen
Definition: XrdCmsSelect.hh:85
Definition: XrdCmsSelect.hh:119
Definition: XrdCmsSelect.hh:59
Definition: XrdCmsSelect.hh:61
char Ident[IdentSize]
Definition: XrdCmsSelect.hh:108
Definition: XrdCmsSelect.hh:64
Definition: XrdCmsSelect.hh:98
Definition: XrdCmsSelect.hh:123
XrdCmsSelected(XrdCmsSelected *np=0)
Definition: XrdCmsSelect.hh:126
int Status
Definition: XrdCmsSelect.hh:116
bool xNoNet
Definition: XrdCmsSelect.hh:145
char Data[256]
Definition: XrdCmsSelect.hh:84
int Shrin
Definition: XrdCmsSelect.hh:112
Definition: XrdCmsSelect.hh:60
~XrdCmsSelected()
Definition: XrdCmsSelect.hh:128
static const int IdentSize
Definition: XrdCmsSelect.hh:102
Definition: XrdCmsSelect.hh:118
Definition: XrdCmsSelect.hh:135
SMask_t bf
Definition: XrdCmsSelect.hh:80
Definition: XrdCmsSelect.hh:55
Definition: XrdCmsSelect.hh:122
Definition: XrdCmsSelect.hh:63
int Port
Definition: XrdCmsSelect.hh:109
int Id
Definition: XrdCmsSelect.hh:106
Definition: XrdCmsSelect.hh:67
Definition: XrdCmsSelect.hh:65
int Opts
Definition: XrdCmsSelect.hh:52
struct XrdCmsSelect::@63 Vec
SMask_t nmask
Definition: XrdCmsSelect.hh:48
int IdentLen
Definition: XrdCmsSelect.hh:107
SMask_t wf
Definition: XrdCmsSelect.hh:77
Definition: XrdCmsSelect.hh:120
short nPick
Definition: XrdCmsSelect.hh:140
XrdCmsRRQInfo * InfoP
Definition: XrdCmsSelect.hh:47
char Share
Definition: XrdCmsSelect.hh:113
XrdCmsKey Path
Definition: XrdCmsSelect.hh:46
Definition: XrdCmsSelect.hh:66
~XrdCmsSelect()
Definition: XrdCmsSelect.hh:91
void Reset()
Definition: XrdCmsSelect.hh:150
bool xSusp
Definition: XrdCmsSelect.hh:148
struct XrdCmsSelect::@64 Resp
struct iovec * iovP
Definition: XrdCmsSelect.hh:50
Definition: XrdCmsSelect.hh:62
unsigned long long SMask_t
Definition: XrdCmsTypes.hh:33
char needSpace
Definition: XrdCmsSelect.hh:142
Definition: XrdCmsSelect.hh:58
SMask_t pf
Definition: XrdCmsSelect.hh:79
Definition: XrdCmsSelect.hh:56
bool selPack
Definition: XrdCmsSelect.hh:143
bool xOff
Definition: XrdCmsSelect.hh:146
int iovN
Definition: XrdCmsSelect.hh:51
int delay
Definition: XrdCmsSelect.hh:139
Definition: XrdCmsSelect.hh:54
Definition: XrdCmsSelect.hh:121
const char * reason
Definition: XrdCmsSelect.hh:138
Definition: XrdCmsKey.hh:47
Definition: XrdCmsSelect.hh:74
bool xOvld
Definition: XrdCmsSelect.hh:147
char needNet
Definition: XrdCmsSelect.hh:141
SMask_t smask
Definition: XrdCmsSelect.hh:49
bool xFull
Definition: XrdCmsSelect.hh:144
int RefTotR
Definition: XrdCmsSelect.hh:111
XrdCmsSelect(int opts=0, char *thePath=0, int thePLen=0)
Definition: XrdCmsSelect.hh:88
SMask_t Mask
Definition: XrdCmsSelect.hh:105
Definition: XrdCmsRRQ.hh:46
Definition: XrdCmsSelect.hh:68
Definition: XrdCmsSelect.hh:70
Definition: XrdCmsSelect.hh:43
Definition: XrdCmsSelect.hh:57
Definition: XrdCmsSelect.hh:73
char RoleID
Definition: XrdCmsSelect.hh:114
Definition: XrdCmsSelect.hh:71