xrootd
XProtocol.hh
Go to the documentation of this file.
1 #ifndef __XPROTOCOL_H
2 #define __XPROTOCOL_H
3 /******************************************************************************/
4 /* */
5 /* X P r o t o c o l . h h */
6 /* */
7 /* (c) 2012 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 //#ifndef __GNUC__
34 //#define __attribute__(x)
35 //#ifdef SUNCC
36 //#pragma pack(4)
37 //#endif
38 //#endif
39 
40 #ifdef __CINT__
41 #define __attribute__(x)
42 #endif
43 
44 // The following is the binary representation of the protocol version here.
45 // Protocol version is repesented as three base10 digits x.y.z with x having no
46 // upper limit (i.e. n.9.9 + 1 -> n+1.0.0).
47 //
48 #define kXR_PROTOCOLVERSION 0x00000297
49 #define kXR_PROTOCOLVSTRING "2.9.7"
50 
51 #include "XProtocol/XPtypes.hh"
52 
53 // KINDS of SERVERS
54 //
55 //
56 #define kXR_DataServer 1
57 #define kXR_LBalServer 0
58 
59 // The below are defined for protocol version 2.9.7 or higher
60 //
61 #define kXR_isManager 0x00000002
62 #define kXR_isServer 0x00000001
63 #define kXR_attrMeta 0x00000100
64 #define kXR_attrProxy 0x00000200
65 #define kXR_attrSuper 0x00000400
66 
67 #define kXR_maxReqRetry 10
68 
69 //
70 // Kind of error inside a XTNetFile's routine (temporary)
71 //
73  kGENERICERR = 0, // Generic error
74  kREAD, // Error while reading from stream
75  kWRITE, // Error while writing to stream
76  kREDIRCONNECT, // Error redirecting to a given host
77  kOK, // Everything seems ok
78  kNOMORESTREAMS // No more available stream IDs for
79  // async processing
80 };
81 
82 //______________________________________________
83 // PROTOCOL DEFINITION: CLIENT'S REQUESTS TYPES
84 //______________________________________________
85 //
87  kXR_auth = 3000,
88  kXR_query, // 3001
89  kXR_chmod, // 3002
90  kXR_close, // 3003
91  kXR_dirlist, // 3004
92  kXR_getfile, // 3005
93  kXR_protocol,// 3006
94  kXR_login, // 3007
95  kXR_mkdir, // 3008
96  kXR_mv, // 3009
97  kXR_open, // 3010
98  kXR_ping, // 3011
99  kXR_putfile, // 3012
100  kXR_read, // 3013
101  kXR_rm, // 3014
102  kXR_rmdir, // 3015
103  kXR_sync, // 3016
104  kXR_stat, // 3017
105  kXR_set, // 3018
106  kXR_write, // 3019
107  kXR_admin, // 3020
108  kXR_prepare, // 3021
109  kXR_statx, // 3022
110  kXR_endsess, // 3023
111  kXR_bind, // 3024
112  kXR_readv, // 3025
113  kXR_verifyw, // 3026
114  kXR_locate, // 3027
115  kXR_truncate // 3028
116 };
117 
118 // OPEN MODE FOR A REMOTE FILE
120  kXR_ur = 0x100,
121  kXR_uw = 0x080,
122  kXR_ux = 0x040,
123  kXR_gr = 0x020,
124  kXR_gw = 0x010,
125  kXR_gx = 0x008,
126  kXR_or = 0x004,
127  kXR_ow = 0x002,
128  kXR_ox = 0x001
129 };
130 
134 };
135 
136 // this is a bitmask
141 };
142 
143 // this is a single number that goes into capver as the version
144 //
146  kXR_ver000 = 0, // Old clients predating history
147  kXR_ver001 = 1, // Generally implemented 2005 protocol
148  kXR_ver002 = 2, // Same as 1 but adds asyncresp recognition
149  kXR_ver003 = 3 // The 2011-2012 rewritten client
150 };
151 
154 };
155 
157  kXR_file = 0,
158  kXR_xset = 1,
165 };
166 
169 };
170 
175  kXR_new = 8,
178  kXR_async = 64,
179  kXR_refresh = 128,
180  kXR_mkpath = 256,
182  kXR_retstat = 1024,
183  kXR_replica = 2048,
184  kXR_posc = 4096,
185  kXR_nowait = 8192,
186  kXR_seqio =16384
187 };
188 
200 };
201 
205 };
206 
210 };
211 
212 // Andy's request for async/unsolicited
218  kXR_wmode = 16,
219  kXR_coloc = 32,
221 };
222 
223 //_______________________________________________
224 // PROTOCOL DEFINITION: SERVER'S RESPONSES TYPES
225 //_______________________________________________
226 //
228  kXR_ok = 0,
229  kXR_oksofar = 4000,
237 };
238 
239 //_______________________________________________
240 // PROTOCOL DEFINITION: SERVER"S ATTN CODES
241 //_______________________________________________
242 
244  kXR_asyncab = 5000,
253 };
254 
255 //_______________________________________________
256 // PROTOCOL DEFINITION: SERVER'S ERROR CODES
257 //_______________________________________________
258 //
282 };
283 
284 
285 //______________________________________________
286 // PROTOCOL DEFINITION: CLIENT'S REQUESTS STRUCTS
287 //______________________________________________
288 //
289 // We need to pack structures sent all over the net!
290 // __attribute__((packed)) assures no padding bytes.
291 //
292 // Nice bodies of the headers for the client requests.
293 // Note that the protocol specifies these values to be in network
294 // byte order when sent
295 //
296 // G.Ganis: use of flat structures to avoid packing options
297 
303 };
310 };
316 };
323 };
331 };
338 };
344 };
352 };
359 };
369 };
377 };
383 };
391 };
392 
398 };
402  kXR_int32 clientpv; // 2.9.7 or higher
405 };
411  kXR_unt16 port; // 2.9.9 or higher
414 };
422 };
431 };
439 };
446 };
452 };
458 };
464 };
472 };
479 };
487 };
496 };
503  kXR_char vertype; // One of XVerifyType
505  kXR_int32 dlen; // Includes crc length
506 };
507 
513 };
514 
515 typedef union {
516  struct ClientRequestHdr header;
517  struct ClientAdminRequest admin;
518  struct ClientAuthRequest auth;
519  struct ClientBindRequest bind;
520  struct ClientChmodRequest chmod;
521  struct ClientCloseRequest close;
522  struct ClientDirlistRequest dirlist;
523  struct ClientEndsessRequest endsess;
524  struct ClientGetfileRequest getfile;
525  struct ClientLocateRequest locate;
526  struct ClientLoginRequest login;
527  struct ClientMkdirRequest mkdir;
528  struct ClientMvRequest mv;
529  struct ClientOpenRequest open;
530  struct ClientPingRequest ping;
531  struct ClientPrepareRequest prepare;
532  struct ClientProtocolRequest protocol;
533  struct ClientPutfileRequest putfile;
534  struct ClientQueryRequest query;
535  struct ClientReadRequest read;
536  struct ClientReadVRequest readv;
537  struct ClientRmRequest rm;
538  struct ClientRmdirRequest rmdir;
539  struct ClientSetRequest set;
540  struct ClientStatRequest stat;
541  struct ClientSyncRequest sync;
542  struct ClientTruncateRequest truncate;
543  struct ClientWriteRequest write;
544 } ClientRequest;
545 
550 };
551 
552 struct read_args {
555  // his struct is followed by an array of readahead_list
556 };
557 
558 //_____________________________________________________________________
559 // PROTOCOL DEFINITION: SERVER'S RESPONSE
560 //_____________________________________________________________________
561 //
562 
563 // Nice header for the server response.
564 // Note that the protocol specifies these values to be in network
565 // byte order when sent
566 //
567 // G.Ganis: The following structures never need padding bytes:
568 // no need of packing options
569 
574 };
575 
576 // Body for the kXR_bind response... useful
579 };
580 
581 // Body for the kXR_open response... useful
584  kXR_int32 cpsize; // cpsize & cptype returned if kXR_compress *or*
585  kXR_char cptype[4]; // kXR_retstat is specified
586 }; // info will follow if kXR_retstat is specified
587 
588 // Body for the kXR_protocol response... useful
592 };
593 
596  kXR_char sec[4096]; // Should be sufficient for every use
597 };
598 
601  char host[4096]; // Should be sufficient for every use
602 };
603 
606  char errmsg[4096]; // Should be sufficient for every use
607 };
608 
611  char infomsg[4096]; // Should be sufficient for every use
612 };
613 
616 };
617 
620  char parms[4096]; // Should be sufficient for every use
621 };
622 
626  char host[4092];
627 };
628 
631  char reserved[4];
633  char respdata[4096];
634 };
635 
639 };
640 
645 };
646 
648  char data[4096];
649 };
650 
652  char data[4096];
653 };
654 
656 {
658  union
659  {
670  } body;
671 };
672 
674 
675 // The fields to be sent as initial handshake
682 };
683 
684 // The body received after the first handshake's header
689 };
690 
691 
692 
694 
695 struct ALIGN_CHECK {char chkszreq[25-sizeof(ClientRequest)];
696  char chkszrsp[ 9-sizeof(ServerResponseHeader)];
697 };
698 
699 /******************************************************************************/
700 /* X P r o t o c o l U t i l i t i e s */
701 /******************************************************************************/
702 
703 #include <errno.h>
704 #if defined(WIN32)
705 #if !defined(ENOTBLK)
706 # define ENOTBLK 15
707 #endif
708 #if !defined(ETXTBSY)
709 #define ETXTBSY 26
710 #endif
711 #if !defined(ENOBUFS)
712 #define ENOBUFS 105
713 #endif
714 #if !defined(ENETUNREACH)
715 #define ENETUNREACH 114
716 #endif
717 #endif
718 
720 {
721 public:
722 
723 // mapError() is the occicial mapping from errno to xrootd protocol error.
724 //
725 static int mapError(int rc)
726  {if (rc < 0) rc = -rc;
727  switch(rc)
728  {case ENOENT: return kXR_NotFound;
729  case EPERM: return kXR_NotAuthorized;
730  case EACCES: return kXR_NotAuthorized;
731  case EIO: return kXR_IOError;
732  case ENOMEM: return kXR_NoMemory;
733  case ENOBUFS: return kXR_NoMemory;
734  case ENOSPC: return kXR_NoSpace;
735  case ENAMETOOLONG: return kXR_ArgTooLong;
736  case ENETUNREACH: return kXR_noserver;
737  case ENOTBLK: return kXR_NotFile;
738  case EISDIR: return kXR_isDirectory;
739  case EEXIST: return kXR_InvalidRequest;
740  case ETXTBSY: return kXR_inProgress;
741  default: return kXR_FSError;
742  }
743  }
744 };
745 #endif