XRootD
Loading...
Searching...
No Matches
XrdTpcTPC.hh
Go to the documentation of this file.
1
2#include <memory>
3#include <string>
4#include <vector>
5#include <sys/time.h>
6
8
11
13#include "XrdTpcPMarkManager.hh"
14
15#include <curl/curl.h>
16
17class XrdOucErrInfo;
18class XrdOucStream;
19class XrdSfsFile;
21class XrdXrootdTpcMon;
22typedef void CURL;
23
24namespace TPC {
25class State;
26
27enum LogMask {
28 Debug = 0x01,
29 Info = 0x02,
30 Warning = 0x04,
31 Error = 0x08,
32 All = 0xff
33};
34
35
37 void operator()(CURL *curl);
38};
39using ManagedCurlHandle = std::unique_ptr<CURL, CurlDeleter>;
40
41
43public:
44 TPCHandler(XrdSysError *log, const char *config, XrdOucEnv *myEnv);
45 virtual ~TPCHandler();
46
47 virtual bool MatchesPath(const char *verb, const char *path);
48 virtual int ProcessReq(XrdHttpExtReq &req);
49 // Abstract method in the base class, but does not seem to be used
50 virtual int Init(const char *cfgfile) {return 0;}
51
52private:
53
54 static int sockopt_callback(void * clientp, curl_socket_t curlfd, curlsocktype purpose);
55 static int opensocket_callback(void *clientp,
56 curlsocktype purpose,
57 struct curl_sockaddr *address);
58
59 static int closesocket_callback(void *clientp, curl_socket_t fd);
60
61 struct TPCLogRecord {
62
63 TPCLogRecord(XrdHttpExtReq & req) : bytes_transferred( -1 ), status( -1 ),
64 tpc_status(-1), streams( 1 ), isIPv6(false), mReq(req), pmarkManager(mReq)
65 {
66 gettimeofday(&begT, 0); // Set effective start time
67 }
68 ~TPCLogRecord();
69
70 std::string log_prefix;
71 std::string local;
72 std::string remote;
73 std::string name;
74 std::string clID;
75 static XrdXrootdTpcMon* tpcMonitor;
76 timeval begT;
77 off_t bytes_transferred;
78 int status;
79 int tpc_status;
80 unsigned int streams;
81 bool isIPv6;
82 XrdHttpExtReq & mReq;
83 XrdTpc::PMarkManager pmarkManager;
84 XrdSysError * m_log;
85 };
86
87 int ProcessOptionsReq(XrdHttpExtReq &req);
88
89 static std::string GetAuthz(XrdHttpExtReq &req);
90
91 // Configure curl handle's CA settings. The CA files present here should
92 // be valid for the lifetime of the process.
93 void ConfigureCurlCA(CURL *curl);
94
95 // Redirect the transfer according to the contents of an XrdOucErrInfo object.
96 int RedirectTransfer(CURL *curl, const std::string &redirect_resource, XrdHttpExtReq &req,
97 XrdOucErrInfo &error, TPCLogRecord &);
98
99 int OpenWaitStall(XrdSfsFile &fh, const std::string &resource, int mode,
100 int openMode, const XrdSecEntity &sec,
101 const std::string &authz);
102
103 int DetermineXferSize(CURL *curl, XrdHttpExtReq &req, TPC::State &state,
104 bool &success, TPCLogRecord &, bool shouldReturnErrorToClient = true);
105
106 int GetContentLengthTPCPull(CURL *curl, XrdHttpExtReq &req, uint64_t & contentLength, bool & success, TPCLogRecord &rec);
107
108 // Send a 'performance marker' back to the TPC client, informing it of our
109 // progress. The TPC client will use this information to determine whether
110 // the transfer is making sufficient progress and/or other monitoring info
111 // (such as whether the transfer is happening over IPv4, IPv6, or both).
112 int SendPerfMarker(XrdHttpExtReq &req, TPCLogRecord &rec, TPC::State &state);
113 int SendPerfMarker(XrdHttpExtReq &req, TPCLogRecord &rec, std::vector<State*> &state,
114 off_t bytes_transferred);
115
116 // Perform the libcurl transfer, periodically sending back chunked updates.
117 int RunCurlWithUpdates(CURL *curl, XrdHttpExtReq &req, TPC::State &state,
118 TPCLogRecord &rec);
119
120 // Experimental multi-stream version of RunCurlWithUpdates
121 int RunCurlWithStreams(XrdHttpExtReq &req, TPC::State &state,
122 size_t streams, TPCLogRecord &rec);
123 int RunCurlWithStreamsImpl(XrdHttpExtReq &req, TPC::State &state,
124 size_t streams, std::vector<TPC::State*> &streams_handles,
125 std::vector<ManagedCurlHandle> &curl_handles,
126 TPCLogRecord &rec);
127
128 int ProcessPushReq(const std::string & resource, XrdHttpExtReq &req);
129 int ProcessPullReq(const std::string &resource, XrdHttpExtReq &req);
130
131 bool ConfigureFSLib(XrdOucStream &Config, std::string &path1, bool &path1_alt,
132 std::string &path2, bool &path2_alt);
133 bool Configure(const char *configfn, XrdOucEnv *myEnv);
134 bool ConfigureLogger(XrdOucStream &Config);
135
136 // Generate a consistently-formatted log message.
137 void logTransferEvent(LogMask lvl, const TPCLogRecord &record,
138 const std::string &event, const std::string &message="");
139
140 std::string generateClientErr(std::stringstream &err_ss, const TPCLogRecord &rec, CURLcode cCode = CURLcode::CURLE_OK);
141
142 std::string prepareURL(XrdHttpExtReq &req, bool & hasSetOpaque);
143 std::string prepareURL(XrdHttpExtReq &req);
144
145 static int m_marker_period;
146 static size_t m_block_size;
147 static size_t m_small_block_size;
148 bool m_desthttps;
149 bool m_fixed_route; // If 'true' the Destination IP in an HTTP-TPC is forced to be the same as the IP used to contact the server
150 // when 'false' any IP available can be selected
151 int m_timeout; // the 'timeout interval'; if no bytes have been received during this time period, abort the transfer.
152 int m_first_timeout; // the 'first timeout interval'; the amount of time we're willing to wait to get the first byte.
153 // Unless explicitly specified, this is 2x the timeout interval.
154 std::string m_cadir; // The directory to use for CAs.
155 std::string m_cafile; // The file to use for CAs in libcurl
156 static XrdSysMutex m_monid_mutex;
157 static uint64_t m_monid;
158 XrdSysError m_log;
159 XrdSfsFileSystem *m_sfs;
160 std::shared_ptr<XrdTlsTempCA> m_ca_file;
161
162 // 16 blocks in flight at 16 MB each, meaning that there will be up to 256MB
163 // in flight; this is equal to the bandwidth delay product of a 200ms transcontinental
164 // connection at 10Gbps.
165#ifdef USE_PIPELINING
166 static const int m_pipelining_multiplier = 16;
167#else
168 static const int m_pipelining_multiplier = 1;
169#endif
170
171 bool usingEC; // indicate if XrdEC is used
172
173 // Time to connect the curl socket to the remote server uses the linux's default value
174 // of 60 seconds
175 static const long CONNECT_TIMEOUT = 60;
176
177 // hdr2cgimap
178 std::map<std::string,std::string> hdr2cgimap;
179};
180}
Utility functions for XrdHTTP.
void CURL
void CURL
Definition XrdTpcTPC.hh:22
virtual int ProcessReq(XrdHttpExtReq &req)
Definition XrdTpcTPC.cc:268
virtual ~TPCHandler()
Definition XrdTpcTPC.cc:296
virtual int Init(const char *cfgfile)
Initializes the external request handler.
Definition XrdTpcTPC.hh:50
virtual bool MatchesPath(const char *verb, const char *path)
Tells if the incoming path is recognized as one of the paths that have to be processed.
Definition XrdTpcTPC.cc:249
std::unique_ptr< CURL, CurlDeleter > ManagedCurlHandle
Definition XrdTpcTPC.hh:39
LogMask
Definition XrdTpcTPC.hh:27
@ All
Definition XrdTpcTPC.hh:32
@ Info
Definition XrdTpcTPC.hh:29
@ Error
Definition XrdTpcTPC.hh:31
@ Debug
Definition XrdTpcTPC.hh:28
@ Warning
Definition XrdTpcTPC.hh:30
void operator()(CURL *curl)
Definition XrdTpcTPC.cc:84