XRootD
XrdOucPgrwUtils.hh
Go to the documentation of this file.
1 #ifndef __XRDOUCPGRWUTILS_HH__
2 #define __XRDOUCPGRWUTILS_HH__
3 /******************************************************************************/
4 /* */
5 /* X r d O u c P g r w U t i l s . h h */
6 /* */
7 /* (c) 2021 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 <cstdint>
34 #include <vector>
35 #include <sys/types.h>
36 
38 {
39 public:
40 
41 //------------------------------------------------------------------------------
52 //------------------------------------------------------------------------------
53 
54 static void csCalc(const char* data, off_t offs, size_t count,
55  uint32_t* csval);
56 
57 static void csCalc(const char* data, off_t offs, size_t count,
58  std::vector<uint32_t> &csvec);
59 
60 //------------------------------------------------------------------------------
62 //| applying the pgRead/pgWrite requirements.
68 //------------------------------------------------------------------------------
69 
70 static int csNum(off_t offs, int count);
71 
72 //------------------------------------------------------------------------------
74 //| applying the pgRead/pgWrite requirements and return the length of the first
83 //------------------------------------------------------------------------------
84 
85 static int csNum(off_t offs, int count, int &fLen, int &lLen);
86 
87 //------------------------------------------------------------------------------
98 //------------------------------------------------------------------------------
99 
100 struct dataInfo
101  {const char* data;
102  const uint32_t* csval;
103  off_t offs;
104  int count;
105 
106  dataInfo(const char* dP, const uint32_t* cP, off_t o, int n)
107  : data(dP), csval(cP), offs(o), count(n) {}
108  };
109 
110 static bool csVer(dataInfo &dInfo, off_t &bado, int &badc);
111 
112 //------------------------------------------------------------------------------
114 //| pgRead/pgWrite requirements.
132 //------------------------------------------------------------------------------
133 
134 struct Layout
135 {
136 off_t bOffset;
137 int dataLen;
138 int sockLen;
139 int fLen;
140 int lLen;
141 const char *eWhy;
142 };
143 
144 static int recvLayout(Layout &layout, off_t offs, int dlen, int bsz=0);
145 
146 static int sendLayout(Layout &layout, off_t offs, int dlen, int bsz=0);
147 
150 
151 private:
152 };
153 #endif
static void csCalc(const char *data, off_t offs, size_t count, uint32_t *csval)
off_t bOffset
Buffer offset to apply iov[1].iov_base.
int dataLen
Total number of filesys bytes the iovec will handle.
static int sendLayout(Layout &layout, off_t offs, int dlen, int bsz=0)
int fLen
Length to use for iov[1].iov_len.
static bool csVer(dataInfo &dInfo, off_t &bado, int &badc)
int sockLen
Total number of network bytes the iovec will handle.
const char * eWhy
Reason for failure when zero is returned.
static int csNum(off_t offs, int count)
Compute the required size of a checksum vector based on offset & length.
int lLen
Length to use for iov[csnum*2-1].iov_len)
static int recvLayout(Layout &layout, off_t offs, int dlen, int bsz=0)
Compute the layout for an iovec that receives network bytes applying.
const char * data
Pointer to data buffer.
int count
Number of bytes to check.
const uint32_t * csval
Pointer to vector of checksums.
off_t offs
Offset associated with data.
dataInfo(const char *dP, const uint32_t *cP, off_t o, int n)