-
Notifications
You must be signed in to change notification settings - Fork 149
/
XProtocol.cc
234 lines (211 loc) · 10.6 KB
/
XProtocol.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/******************************************************************************/
/* */
/* X P r o t o c o l . c c */
/* */
/* (c) 2016 by the Board of Trustees of the Leland Stanford, Jr., University */
/* 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. */
/* */
/* The XRootD protocol definition, documented in this file, is distributed */
/* under a modified BSD license and may be freely used to reimplement it. */
/* Any references to "source" in this license refers to this file or any */
/* other file that specifically contains the following license. */
/* */
/* Redistribution and use in source and binary forms, with or without */
/* modification, are permitted provided that the following conditions */
/* are met: */
/* */
/* 1. Redistributions of source code must retain the above copyright notice, */
/* this list of conditions and the following disclaimer. */
/* */
/* 2. Redistributions in binary form must reproduce the above copyright */
/* notice, this list of conditions and the following disclaimer in the */
/* documentation and/or other materials provided with the distribution. */
/* */
/* 3. Neither the name of the copyright holder nor the names of its */
/* contributors may be used to endorse or promote products derived from */
/* this software without specific prior written permission. */
/* */
/* 4. Derived software may not use the name XRootD or cmsd (regardless of */
/* capitilization) in association with the derived work if the protocol */
/* documented in this file is changed in any way. */
/* */
/* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS */
/* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT */
/* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR */
/* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT */
/* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, */
/* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, */
/* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY */
/* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT */
/* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE */
/* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
/******************************************************************************/
#include <inttypes.h>
#include <netinet/in.h>
#include <sys/types.h>
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <sys/stat.h>
#include <unistd.h>
#include "XProtocol/XProtocol.hh"
/******************************************************************************/
/* G l o b a l s */
/******************************************************************************/
namespace
{
const char *errNames[kXR_ERRFENCE-kXR_ArgInvalid] =
{"Invalid argument", // kXR_ArgInvalid = 3000,
"Missing agument", // kXR_ArgMissing
"Argument is too long", // kXR_ArgTooLong
"File or object is locked", // kXR_FileLocked
"File or object not open", // kXR_FileNotOpen
"Filesystem error", // kXR_FSError
"Invalid request", // kXR_InvalidRequest
"I/O error", // kXR_IOError
"Insufficient memory", // kXR_NoMemory
"Insufficient space", // kXR_NoSpace
"Request not authorized", // kXR_NotAuthorized
"File or object not found", // kXR_NotFound
"Internal server error", // kXR_ServerError
"Unsupported request", // kXR_Unsupported
"No serves available", // kXR_noserver
"Target is not a file", // kXR_NotFile
"Target is a directory", // kXR_isDirectory
"Request cancelled", // kXR_Cancelled
"Checksum length error", // kXR_ChkLenErr
"Checksum is invalid", // kXR_ChkSumErr
"Request in progress", // kXR_inProgress
"Quota exceeded", // kXR_overQuota
"Invalid signature", // kXR_SigVerErr
"Decryption failed", // kXR_DecryptErr
"Overloaded", // kXR_Overloaded
"Filesystem is read only", // kXR_fsReadOnly
"Invalid payload format", // kXR_BadPayload
"File attrbute not found" // kXR_AttrNotFound
};
const char *reqNames[kXR_REQFENCE-kXR_auth] =
{"auth", "query", "chmod", "close",
"dirlist", "getfile", "protocol", "login",
"mkdir", "mv", "open", "ping",
"putfile", "read", "rm", "rmdir",
"sync", "stat", "set", "write",
"admin", "prepare", "statx", "endsess",
"bind", "readv", "verifyw", "locate",
"truncate", "sigver", "decrypt", "writev",
"fattr"
};
// Following value is used to determine if the error or request code is
// host byte or network byte order making use of the fact each starts at 3000
//
union Endianness {kXR_unt16 xyz; unsigned char Endian[2];} little = {1};
}
/******************************************************************************/
/* e r r N a m e */
/******************************************************************************/
const char *XProtocol::errName(kXR_int32 errCode)
{
// Mangle request code if the byte orderdoesn't match our host order
//
if ((errCode < 0 || errCode > kXR_ERRFENCE) && little.Endian[0])
errCode = ntohl(errCode);
// Validate the request code
//
if (errCode < kXR_ArgInvalid || errCode >= kXR_ERRFENCE)
return "!undefined error";
// Return the proper table
//
return errNames[errCode - kXR_ArgInvalid];
}
/******************************************************************************/
/* r e q N a m e */
/******************************************************************************/
const char *XProtocol::reqName(kXR_unt16 reqCode)
{
// Mangle request code if the byte orderdoesn't match our host order
//
if (reqCode > kXR_REQFENCE && little.Endian[0]) reqCode = ntohs(reqCode);
// Validate the request code
//
if (reqCode < kXR_auth || reqCode >= kXR_REQFENCE) return "!unknown";
// Return the proper table
//
return reqNames[reqCode - kXR_auth];
}
/******************************************************************************/
/* n v e c & v v e c o p e r a t i n s */
/******************************************************************************/
// Add an attribute name to nvec (the buffer has to be sufficiently big)
//
char* ClientFattrRequest::NVecInsert( const char *name, char *buffer )
{
// set rc to 0
memset( buffer, 0, sizeof( kXR_unt16 ) );
buffer += sizeof( kXR_unt16 );
// copy attribute name including trailing null
size_t len = strlen( name );
memcpy( buffer, name, len + 1 );
buffer += len + 1;
// return memory that comes right after newly inserted nvec record
return buffer;
}
// Add an attribute name to vvec (the buffer has to be sufficiently big)
//
char* ClientFattrRequest::VVecInsert( const char *value, char *buffer )
{
// copy value size
kXR_int32 len = strlen( value );
kXR_int32 lendat = htonl( len );
memcpy( buffer, &lendat, sizeof( kXR_int32 ) );
buffer += sizeof( kXR_int32 );
// copy value itself
memcpy( buffer, value, len );
buffer += len;
// return memory that comes right after newly inserted vvec entry
return buffer;
}
// Read error code from nvec
//
char* ClientFattrRequest::NVecRead( char* buffer, kXR_unt16 &rc )
{
rc = *reinterpret_cast<const kXR_unt16*>( buffer );
rc = htons( rc );
buffer += sizeof( kXR_unt16 );
return buffer;
}
// Read attribute name from nvec
//
char* ClientFattrRequest::NVecRead( char* buffer, char *&name )
{
name = strdup( buffer );
buffer += strlen( name ) + 1;
return buffer;
}
// Read value length from vvec
//
char* ClientFattrRequest::VVecRead( char* buffer, kXR_int32 &len )
{
len = *reinterpret_cast<const kXR_int32*>( buffer );
len = htonl( len );
buffer += sizeof( kXR_int32 );
return buffer;
}
// Read attribute value from vvec
//
char* ClientFattrRequest::VVecRead( char* buffer, kXR_int32 len, char *&value )
{
value = reinterpret_cast<char*>( malloc( len + 1 ) );
strncpy( value, buffer, len );
value[len] = 0;
buffer += len;
return buffer;
}