blob: 4ff895df8fd7ecb9ee7e99879c555e9abc413780 [file] [log] [blame]
Alexander Graf769ce762009-05-11 17:41:42 +02001/*
2 * QEMU Block driver for CURL images
3 *
4 * Copyright (c) 2009 Alexander Graf <agraf@suse.de>
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
Markus Armbruster452fcdb2018-02-01 12:18:39 +010024
Peter Maydell80c71a22016-01-18 18:01:42 +000025#include "qemu/osdep.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010026#include "qapi/error.h"
Richard W.M. Jones796a0602015-07-08 14:37:48 +010027#include "qemu/error-report.h"
Markus Armbruster0b8fa322019-05-23 16:35:07 +020028#include "qemu/module.h"
Markus Armbruster922a01a2018-02-01 12:18:46 +010029#include "qemu/option.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010030#include "block/block_int.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010031#include "qapi/qmp/qdict.h"
Markus Armbrusterd49b6832015-03-17 18:29:20 +010032#include "qapi/qmp/qstring.h"
Daniel P. Berrange1bff9602016-01-21 14:19:20 +000033#include "crypto/secret.h"
Alexander Graf769ce762009-05-11 17:41:42 +020034#include <curl/curl.h>
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020035#include "qemu/cutils.h"
Laurent Viviered2a66d2018-12-13 17:27:25 +010036#include "trace.h"
Alexander Graf769ce762009-05-11 17:41:42 +020037
Alexander Graf769ce762009-05-11 17:41:42 +020038// #define DEBUG_VERBOSE
39
Stefan Hajnoczifb6d1bb2013-02-08 08:49:10 +010040#define PROTOCOLS (CURLPROTO_HTTP | CURLPROTO_HTTPS | \
Max Reitz23dce382016-11-02 18:55:37 +010041 CURLPROTO_FTP | CURLPROTO_FTPS)
Stefan Hajnoczifb6d1bb2013-02-08 08:49:10 +010042
Alexander Graf769ce762009-05-11 17:41:42 +020043#define CURL_NUM_STATES 8
44#define CURL_NUM_ACB 8
Richard W.M. Jonesf76faed2014-10-26 11:05:27 +000045#define CURL_TIMEOUT_MAX 10000
Alexander Graf769ce762009-05-11 17:41:42 +020046
Matthew Boothe3542c62014-05-14 19:28:41 -040047#define CURL_BLOCK_OPT_URL "url"
48#define CURL_BLOCK_OPT_READAHEAD "readahead"
Matthew Booth97a3ea52014-05-14 19:28:42 -040049#define CURL_BLOCK_OPT_SSLVERIFY "sslverify"
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -030050#define CURL_BLOCK_OPT_TIMEOUT "timeout"
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +010051#define CURL_BLOCK_OPT_COOKIE "cookie"
Peter Krempa327c8eb2017-05-04 16:00:06 +020052#define CURL_BLOCK_OPT_COOKIE_SECRET "cookie-secret"
Daniel P. Berrange1bff9602016-01-21 14:19:20 +000053#define CURL_BLOCK_OPT_USERNAME "username"
54#define CURL_BLOCK_OPT_PASSWORD_SECRET "password-secret"
55#define CURL_BLOCK_OPT_PROXY_USERNAME "proxy-username"
56#define CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET "proxy-password-secret"
Matthew Boothe3542c62014-05-14 19:28:41 -040057
Max Reitz712b64e2019-02-01 20:29:31 +010058#define CURL_BLOCK_OPT_READAHEAD_DEFAULT (256 * 1024)
59#define CURL_BLOCK_OPT_SSLVERIFY_DEFAULT true
60#define CURL_BLOCK_OPT_TIMEOUT_DEFAULT 5
61
Alexander Graf769ce762009-05-11 17:41:42 +020062struct BDRVCURLState;
Max Reitz04878612019-09-10 14:41:30 +020063struct CURLState;
Alexander Graf769ce762009-05-11 17:41:42 +020064
Jeff Cody2d259642017-11-07 17:27:22 -050065static bool libcurl_initialized;
66
Alexander Graf769ce762009-05-11 17:41:42 +020067typedef struct CURLAIOCB {
Paolo Bonzini28256d82017-05-15 12:00:58 +020068 Coroutine *co;
Alexander Graf769ce762009-05-11 17:41:42 +020069 QEMUIOVector *qiov;
Nick Thomas363c3c82011-09-21 11:55:50 +010070
Paolo Bonzini2125e5e2017-05-15 12:00:57 +020071 uint64_t offset;
72 uint64_t bytes;
Paolo Bonzini28256d82017-05-15 12:00:58 +020073 int ret;
Nick Thomas363c3c82011-09-21 11:55:50 +010074
Alexander Graf769ce762009-05-11 17:41:42 +020075 size_t start;
76 size_t end;
77} CURLAIOCB;
78
Max Reitzff5ca162016-10-25 04:54:30 +020079typedef struct CURLSocket {
80 int fd;
Max Reitz04878612019-09-10 14:41:30 +020081 struct CURLState *state;
Max Reitzff5ca162016-10-25 04:54:30 +020082 QLIST_ENTRY(CURLSocket) next;
83} CURLSocket;
84
Alexander Graf769ce762009-05-11 17:41:42 +020085typedef struct CURLState
86{
87 struct BDRVCURLState *s;
88 CURLAIOCB *acb[CURL_NUM_ACB];
89 CURL *curl;
Max Reitzff5ca162016-10-25 04:54:30 +020090 QLIST_HEAD(, CURLSocket) sockets;
Alexander Graf769ce762009-05-11 17:41:42 +020091 char *orig_buf;
Paolo Bonzini2125e5e2017-05-15 12:00:57 +020092 uint64_t buf_start;
Alexander Graf769ce762009-05-11 17:41:42 +020093 size_t buf_off;
94 size_t buf_len;
95 char range[128];
96 char errmsg[CURL_ERROR_SIZE];
97 char in_use;
98} CURLState;
99
100typedef struct BDRVCURLState {
101 CURLM *multi;
Peter Maydell031fd1b2014-01-24 14:56:17 +0100102 QEMUTimer timer;
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200103 uint64_t len;
Alexander Graf769ce762009-05-11 17:41:42 +0200104 CURLState states[CURL_NUM_STATES];
105 char *url;
Nolanc76f4952009-07-01 17:16:52 -0700106 size_t readahead_size;
Matthew Booth97a3ea52014-05-14 19:28:42 -0400107 bool sslverify;
Richard W.M. Jonesf76faed2014-10-26 11:05:27 +0000108 uint64_t timeout;
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100109 char *cookie;
Fam Zheng3494d652013-07-02 15:19:21 +0800110 bool accept_range;
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200111 AioContext *aio_context;
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100112 QemuMutex mutex;
Paolo Bonzini709f2132018-02-03 10:39:35 -0500113 CoQueue free_state_waitq;
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000114 char *username;
115 char *password;
116 char *proxyusername;
117 char *proxypassword;
Alexander Graf769ce762009-05-11 17:41:42 +0200118} BDRVCURLState;
119
120static void curl_clean_state(CURLState *s);
121static void curl_multi_do(void *arg);
122
Paolo Bonzini34db05e2017-05-15 12:00:54 +0200123/* Called from curl_multi_do_locked, with s->mutex held. */
Peter Maydell031fd1b2014-01-24 14:56:17 +0100124static int curl_timer_cb(CURLM *multi, long timeout_ms, void *opaque)
125{
126 BDRVCURLState *s = opaque;
127
Laurent Viviered2a66d2018-12-13 17:27:25 +0100128 trace_curl_timer_cb(timeout_ms);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100129 if (timeout_ms == -1) {
130 timer_del(&s->timer);
131 } else {
132 int64_t timeout_ns = (int64_t)timeout_ms * 1000 * 1000;
133 timer_mod(&s->timer,
134 qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + timeout_ns);
135 }
136 return 0;
137}
Peter Maydell031fd1b2014-01-24 14:56:17 +0100138
Paolo Bonzini34db05e2017-05-15 12:00:54 +0200139/* Called from curl_multi_do_locked, with s->mutex held. */
Alexander Graf769ce762009-05-11 17:41:42 +0200140static int curl_sock_cb(CURL *curl, curl_socket_t fd, int action,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200141 void *userp, void *sp)
Alexander Graf769ce762009-05-11 17:41:42 +0200142{
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200143 BDRVCURLState *s;
Matthew Booth838ef602014-04-29 16:03:30 +0100144 CURLState *state = NULL;
Max Reitzff5ca162016-10-25 04:54:30 +0200145 CURLSocket *socket;
146
Matthew Booth838ef602014-04-29 16:03:30 +0100147 curl_easy_getinfo(curl, CURLINFO_PRIVATE, (char **)&state);
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200148 s = state->s;
Matthew Booth838ef602014-04-29 16:03:30 +0100149
Max Reitzff5ca162016-10-25 04:54:30 +0200150 QLIST_FOREACH(socket, &state->sockets, next) {
151 if (socket->fd == fd) {
Max Reitzff5ca162016-10-25 04:54:30 +0200152 break;
153 }
154 }
155 if (!socket) {
156 socket = g_new0(CURLSocket, 1);
157 socket->fd = fd;
Max Reitz04878612019-09-10 14:41:30 +0200158 socket->state = state;
Max Reitzff5ca162016-10-25 04:54:30 +0200159 QLIST_INSERT_HEAD(&state->sockets, socket, next);
160 }
Max Reitzff5ca162016-10-25 04:54:30 +0200161
Laurent Viviered2a66d2018-12-13 17:27:25 +0100162 trace_curl_sock_cb(action, (int)fd);
Alexander Graf769ce762009-05-11 17:41:42 +0200163 switch (action) {
164 case CURL_POLL_IN:
Fam Zhengdca21ef2015-10-23 11:08:05 +0800165 aio_set_fd_handler(s->aio_context, fd, false,
Max Reitz9dbad872019-09-10 14:41:33 +0200166 curl_multi_do, NULL, NULL, socket);
Alexander Graf769ce762009-05-11 17:41:42 +0200167 break;
168 case CURL_POLL_OUT:
Fam Zhengdca21ef2015-10-23 11:08:05 +0800169 aio_set_fd_handler(s->aio_context, fd, false,
Max Reitz9dbad872019-09-10 14:41:33 +0200170 NULL, curl_multi_do, NULL, socket);
Alexander Graf769ce762009-05-11 17:41:42 +0200171 break;
172 case CURL_POLL_INOUT:
Fam Zhengdca21ef2015-10-23 11:08:05 +0800173 aio_set_fd_handler(s->aio_context, fd, false,
Max Reitz9dbad872019-09-10 14:41:33 +0200174 curl_multi_do, curl_multi_do, NULL, socket);
Alexander Graf769ce762009-05-11 17:41:42 +0200175 break;
176 case CURL_POLL_REMOVE:
Fam Zhengdca21ef2015-10-23 11:08:05 +0800177 aio_set_fd_handler(s->aio_context, fd, false,
Stefan Hajnoczif6a51c82016-12-01 19:26:41 +0000178 NULL, NULL, NULL, NULL);
Alexander Graf769ce762009-05-11 17:41:42 +0200179 break;
180 }
181
Max Reitz007f3392019-09-10 14:41:31 +0200182 if (action == CURL_POLL_REMOVE) {
183 QLIST_REMOVE(socket, next);
184 g_free(socket);
185 }
186
Alexander Graf769ce762009-05-11 17:41:42 +0200187 return 0;
188}
189
Paolo Bonzini34db05e2017-05-15 12:00:54 +0200190/* Called from curl_multi_do_locked, with s->mutex held. */
Fam Zheng3494d652013-07-02 15:19:21 +0800191static size_t curl_header_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
Alexander Graf769ce762009-05-11 17:41:42 +0200192{
Fam Zheng3494d652013-07-02 15:19:21 +0800193 BDRVCURLState *s = opaque;
Alexander Graf769ce762009-05-11 17:41:42 +0200194 size_t realsize = size * nmemb;
David Edmondson7788a312020-02-24 10:13:09 +0000195 const char *header = (char *)ptr;
196 const char *end = header + realsize;
David Edmondson69032252020-02-24 10:13:10 +0000197 const char *accept_ranges = "accept-ranges:";
David Edmondson7788a312020-02-24 10:13:09 +0000198 const char *bytes = "bytes";
Alexander Graf769ce762009-05-11 17:41:42 +0200199
David Edmondson7788a312020-02-24 10:13:09 +0000200 if (realsize >= strlen(accept_ranges)
David Edmondson69032252020-02-24 10:13:10 +0000201 && g_ascii_strncasecmp(header, accept_ranges,
202 strlen(accept_ranges)) == 0) {
David Edmondson7788a312020-02-24 10:13:09 +0000203
204 char *p = strchr(header, ':') + 1;
205
206 /* Skip whitespace between the header name and value. */
207 while (p < end && *p && g_ascii_isspace(*p)) {
208 p++;
209 }
210
211 if (end - p >= strlen(bytes)
212 && strncmp(p, bytes, strlen(bytes)) == 0) {
213
214 /* Check that there is nothing but whitespace after the value. */
215 p += strlen(bytes);
216 while (p < end && *p && g_ascii_isspace(*p)) {
217 p++;
218 }
219
220 if (p == end || !*p) {
221 s->accept_range = true;
222 }
223 }
Blue Swirl0bfcd592010-05-22 08:02:12 +0000224 }
Alexander Graf769ce762009-05-11 17:41:42 +0200225
226 return realsize;
227}
228
Paolo Bonzini34db05e2017-05-15 12:00:54 +0200229/* Called from curl_multi_do_locked, with s->mutex held. */
Alexander Graf769ce762009-05-11 17:41:42 +0200230static size_t curl_read_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
231{
232 CURLState *s = ((CURLState*)opaque);
233 size_t realsize = size * nmemb;
Alexander Graf769ce762009-05-11 17:41:42 +0200234
Laurent Viviered2a66d2018-12-13 17:27:25 +0100235 trace_curl_read_cb(realsize);
Alexander Graf769ce762009-05-11 17:41:42 +0200236
Max Reitz4e767652016-10-25 04:54:29 +0200237 if (!s || !s->orig_buf) {
238 goto read_end;
239 }
Alexander Graf769ce762009-05-11 17:41:42 +0200240
Fam Zheng6d4b9e52014-03-26 13:05:40 +0100241 if (s->buf_off >= s->buf_len) {
242 /* buffer full, read nothing */
Max Reitz4e767652016-10-25 04:54:29 +0200243 goto read_end;
Fam Zheng6d4b9e52014-03-26 13:05:40 +0100244 }
245 realsize = MIN(realsize, s->buf_len - s->buf_off);
Alexander Graf769ce762009-05-11 17:41:42 +0200246 memcpy(s->orig_buf + s->buf_off, ptr, realsize);
247 s->buf_off += realsize;
248
Max Reitz4e767652016-10-25 04:54:29 +0200249read_end:
250 /* curl will error out if we do not return this value */
251 return size * nmemb;
Alexander Graf769ce762009-05-11 17:41:42 +0200252}
253
Paolo Bonzini456af342017-05-15 12:00:55 +0200254/* Called with s->mutex held. */
Paolo Bonzini28256d82017-05-15 12:00:58 +0200255static bool curl_find_buf(BDRVCURLState *s, uint64_t start, uint64_t len,
256 CURLAIOCB *acb)
Alexander Graf769ce762009-05-11 17:41:42 +0200257{
258 int i;
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200259 uint64_t end = start + len;
260 uint64_t clamped_end = MIN(end, s->len);
261 uint64_t clamped_len = clamped_end - start;
Alexander Graf769ce762009-05-11 17:41:42 +0200262
263 for (i=0; i<CURL_NUM_STATES; i++) {
264 CURLState *state = &s->states[i];
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200265 uint64_t buf_end = (state->buf_start + state->buf_off);
266 uint64_t buf_fend = (state->buf_start + state->buf_len);
Alexander Graf769ce762009-05-11 17:41:42 +0200267
268 if (!state->orig_buf)
269 continue;
270 if (!state->buf_off)
271 continue;
272
273 // Does the existing buffer cover our section?
274 if ((start >= state->buf_start) &&
275 (start <= buf_end) &&
Max Reitz4e504532016-10-25 04:54:31 +0200276 (clamped_end >= state->buf_start) &&
277 (clamped_end <= buf_end))
Alexander Graf769ce762009-05-11 17:41:42 +0200278 {
279 char *buf = state->orig_buf + (start - state->buf_start);
280
Max Reitz4e504532016-10-25 04:54:31 +0200281 qemu_iovec_from_buf(acb->qiov, 0, buf, clamped_len);
282 if (clamped_len < len) {
283 qemu_iovec_memset(acb->qiov, clamped_len, 0, len - clamped_len);
284 }
Paolo Bonzini28256d82017-05-15 12:00:58 +0200285 acb->ret = 0;
286 return true;
Alexander Graf769ce762009-05-11 17:41:42 +0200287 }
288
289 // Wait for unfinished chunks
Matthew Boothb7079df2014-04-29 16:03:32 +0100290 if (state->in_use &&
291 (start >= state->buf_start) &&
Alexander Graf769ce762009-05-11 17:41:42 +0200292 (start <= buf_fend) &&
Max Reitz4e504532016-10-25 04:54:31 +0200293 (clamped_end >= state->buf_start) &&
294 (clamped_end <= buf_fend))
Alexander Graf769ce762009-05-11 17:41:42 +0200295 {
296 int j;
297
298 acb->start = start - state->buf_start;
Max Reitz4e504532016-10-25 04:54:31 +0200299 acb->end = acb->start + clamped_len;
Alexander Graf769ce762009-05-11 17:41:42 +0200300
301 for (j=0; j<CURL_NUM_ACB; j++) {
302 if (!state->acb[j]) {
303 state->acb[j] = acb;
Paolo Bonzini28256d82017-05-15 12:00:58 +0200304 return true;
Alexander Graf769ce762009-05-11 17:41:42 +0200305 }
306 }
307 }
308 }
309
Paolo Bonzini28256d82017-05-15 12:00:58 +0200310 return false;
Alexander Graf769ce762009-05-11 17:41:42 +0200311}
312
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100313/* Called with s->mutex held. */
Matthew Booth838ef602014-04-29 16:03:30 +0100314static void curl_multi_check_completion(BDRVCURLState *s)
Alexander Graf769ce762009-05-11 17:41:42 +0200315{
Alexander Graf769ce762009-05-11 17:41:42 +0200316 int msgs_in_queue;
317
Alexander Graf769ce762009-05-11 17:41:42 +0200318 /* Try to find done transfers, so we can free the easy
319 * handle again. */
Matthew Booth1f2cead2014-04-29 16:03:31 +0100320 for (;;) {
Alexander Graf769ce762009-05-11 17:41:42 +0200321 CURLMsg *msg;
322 msg = curl_multi_info_read(s->multi, &msgs_in_queue);
323
Matthew Booth1f2cead2014-04-29 16:03:31 +0100324 /* Quit when there are no more completions */
Alexander Graf769ce762009-05-11 17:41:42 +0200325 if (!msg)
326 break;
Alexander Graf769ce762009-05-11 17:41:42 +0200327
Matthew Booth1f2cead2014-04-29 16:03:31 +0100328 if (msg->msg == CURLMSG_DONE) {
Max Reitzbfb23b42019-09-10 14:41:35 +0200329 int i;
Matthew Booth1f2cead2014-04-29 16:03:31 +0100330 CURLState *state = NULL;
Max Reitzbfb23b42019-09-10 14:41:35 +0200331 bool error = msg->data.result != CURLE_OK;
332
Matthew Booth1f2cead2014-04-29 16:03:31 +0100333 curl_easy_getinfo(msg->easy_handle, CURLINFO_PRIVATE,
334 (char **)&state);
Nicholas Thomasf785a5a2011-08-15 10:00:34 +0100335
Max Reitzbfb23b42019-09-10 14:41:35 +0200336 if (error) {
Richard W.M. Jones796a0602015-07-08 14:37:48 +0100337 static int errcount = 100;
338
339 /* Don't lose the original error message from curl, since
340 * it contains extra data.
341 */
342 if (errcount > 0) {
343 error_report("curl: %s", state->errmsg);
344 if (--errcount == 0) {
345 error_report("curl: further errors suppressed");
346 }
347 }
Max Reitzbfb23b42019-09-10 14:41:35 +0200348 }
Richard W.M. Jones796a0602015-07-08 14:37:48 +0100349
Max Reitzbfb23b42019-09-10 14:41:35 +0200350 for (i = 0; i < CURL_NUM_ACB; i++) {
351 CURLAIOCB *acb = state->acb[i];
Nicholas Thomasf785a5a2011-08-15 10:00:34 +0100352
Max Reitzbfb23b42019-09-10 14:41:35 +0200353 if (acb == NULL) {
354 continue;
Matthew Booth1f2cead2014-04-29 16:03:31 +0100355 }
Max Reitzbfb23b42019-09-10 14:41:35 +0200356
357 if (!error) {
358 /* Assert that we have read all data */
359 assert(state->buf_off >= acb->end);
360
361 qemu_iovec_from_buf(acb->qiov, 0,
362 state->orig_buf + acb->start,
363 acb->end - acb->start);
364
365 if (acb->end - acb->start < acb->bytes) {
366 size_t offset = acb->end - acb->start;
367 qemu_iovec_memset(acb->qiov, offset, 0,
368 acb->bytes - offset);
369 }
370 }
371
372 acb->ret = error ? -EIO : 0;
373 state->acb[i] = NULL;
374 qemu_mutex_unlock(&s->mutex);
375 aio_co_wake(acb->co);
376 qemu_mutex_lock(&s->mutex);
Alexander Graf769ce762009-05-11 17:41:42 +0200377 }
Matthew Booth1f2cead2014-04-29 16:03:31 +0100378
379 curl_clean_state(state);
380 break;
Alexander Graf769ce762009-05-11 17:41:42 +0200381 }
Matthew Booth1f2cead2014-04-29 16:03:31 +0100382 }
Alexander Graf769ce762009-05-11 17:41:42 +0200383}
384
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100385/* Called with s->mutex held. */
Max Reitz9abaf9f2019-09-10 14:41:34 +0200386static void curl_multi_do_locked(CURLSocket *socket)
Peter Maydell031fd1b2014-01-24 14:56:17 +0100387{
Max Reitz9abaf9f2019-09-10 14:41:34 +0200388 BDRVCURLState *s = socket->state->s;
Peter Maydell031fd1b2014-01-24 14:56:17 +0100389 int running;
390 int r;
391
Max Reitz9abaf9f2019-09-10 14:41:34 +0200392 if (!s->multi) {
Peter Maydell031fd1b2014-01-24 14:56:17 +0100393 return;
394 }
395
Max Reitz9abaf9f2019-09-10 14:41:34 +0200396 do {
397 r = curl_multi_socket_action(s->multi, socket->fd, 0, &running);
398 } while (r == CURLM_CALL_MULTI_PERFORM);
Matthew Booth838ef602014-04-29 16:03:30 +0100399}
400
Paolo Bonzini9d456652017-02-13 14:52:30 +0100401static void curl_multi_do(void *arg)
402{
Max Reitz9dbad872019-09-10 14:41:33 +0200403 CURLSocket *socket = arg;
404 BDRVCURLState *s = socket->state->s;
Paolo Bonzini9d456652017-02-13 14:52:30 +0100405
Max Reitz9dbad872019-09-10 14:41:33 +0200406 qemu_mutex_lock(&s->mutex);
407 curl_multi_do_locked(socket);
408 curl_multi_check_completion(s);
409 qemu_mutex_unlock(&s->mutex);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100410}
411
412static void curl_multi_timeout_do(void *arg)
413{
Peter Maydell031fd1b2014-01-24 14:56:17 +0100414 BDRVCURLState *s = (BDRVCURLState *)arg;
415 int running;
416
417 if (!s->multi) {
418 return;
419 }
420
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100421 qemu_mutex_lock(&s->mutex);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100422 curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
423
Matthew Booth838ef602014-04-29 16:03:30 +0100424 curl_multi_check_completion(s);
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100425 qemu_mutex_unlock(&s->mutex);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100426}
427
Paolo Bonzini456af342017-05-15 12:00:55 +0200428/* Called with s->mutex held. */
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200429static CURLState *curl_find_state(BDRVCURLState *s)
Alexander Graf769ce762009-05-11 17:41:42 +0200430{
431 CURLState *state = NULL;
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200432 int i;
Alexander Graf769ce762009-05-11 17:41:42 +0200433
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200434 for (i = 0; i < CURL_NUM_STATES; i++) {
435 if (!s->states[i].in_use) {
Alexander Graf769ce762009-05-11 17:41:42 +0200436 state = &s->states[i];
437 state->in_use = 1;
438 break;
439 }
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200440 }
441 return state;
442}
Alexander Graf769ce762009-05-11 17:41:42 +0200443
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200444static int curl_init_state(BDRVCURLState *s, CURLState *state)
445{
Matthew Booth9e550b32014-04-29 16:03:26 +0100446 if (!state->curl) {
447 state->curl = curl_easy_init();
448 if (!state->curl) {
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200449 return -EIO;
Matthew Booth9e550b32014-04-29 16:03:26 +0100450 }
451 curl_easy_setopt(state->curl, CURLOPT_URL, s->url);
Matthew Booth97a3ea52014-05-14 19:28:42 -0400452 curl_easy_setopt(state->curl, CURLOPT_SSL_VERIFYPEER,
453 (long) s->sslverify);
Richard W.M. Jones637fa442018-09-14 10:56:22 +0100454 curl_easy_setopt(state->curl, CURLOPT_SSL_VERIFYHOST,
455 s->sslverify ? 2L : 0L);
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100456 if (s->cookie) {
457 curl_easy_setopt(state->curl, CURLOPT_COOKIE, s->cookie);
458 }
Richard W.M. Jonesf76faed2014-10-26 11:05:27 +0000459 curl_easy_setopt(state->curl, CURLOPT_TIMEOUT, (long)s->timeout);
Matthew Booth9e550b32014-04-29 16:03:26 +0100460 curl_easy_setopt(state->curl, CURLOPT_WRITEFUNCTION,
461 (void *)curl_read_cb);
462 curl_easy_setopt(state->curl, CURLOPT_WRITEDATA, (void *)state);
463 curl_easy_setopt(state->curl, CURLOPT_PRIVATE, (void *)state);
464 curl_easy_setopt(state->curl, CURLOPT_AUTOREFERER, 1);
465 curl_easy_setopt(state->curl, CURLOPT_FOLLOWLOCATION, 1);
466 curl_easy_setopt(state->curl, CURLOPT_NOSIGNAL, 1);
467 curl_easy_setopt(state->curl, CURLOPT_ERRORBUFFER, state->errmsg);
468 curl_easy_setopt(state->curl, CURLOPT_FAILONERROR, 1);
Alexander Graf769ce762009-05-11 17:41:42 +0200469
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000470 if (s->username) {
471 curl_easy_setopt(state->curl, CURLOPT_USERNAME, s->username);
472 }
473 if (s->password) {
474 curl_easy_setopt(state->curl, CURLOPT_PASSWORD, s->password);
475 }
476 if (s->proxyusername) {
477 curl_easy_setopt(state->curl,
478 CURLOPT_PROXYUSERNAME, s->proxyusername);
479 }
480 if (s->proxypassword) {
481 curl_easy_setopt(state->curl,
482 CURLOPT_PROXYPASSWORD, s->proxypassword);
483 }
484
Matthew Booth9e550b32014-04-29 16:03:26 +0100485 /* Restrict supported protocols to avoid security issues in the more
486 * obscure protocols. For example, do not allow POP3/SMTP/IMAP see
487 * CVE-2013-0249.
488 *
489 * Restricting protocols is only supported from 7.19.4 upwards.
490 */
Stefan Hajnoczi8a8f5842013-02-13 09:25:34 +0100491#if LIBCURL_VERSION_NUM >= 0x071304
Matthew Booth9e550b32014-04-29 16:03:26 +0100492 curl_easy_setopt(state->curl, CURLOPT_PROTOCOLS, PROTOCOLS);
493 curl_easy_setopt(state->curl, CURLOPT_REDIR_PROTOCOLS, PROTOCOLS);
Stefan Hajnoczi8a8f5842013-02-13 09:25:34 +0100494#endif
Stefan Hajnoczifb6d1bb2013-02-08 08:49:10 +0100495
Alexander Graf769ce762009-05-11 17:41:42 +0200496#ifdef DEBUG_VERBOSE
Matthew Booth9e550b32014-04-29 16:03:26 +0100497 curl_easy_setopt(state->curl, CURLOPT_VERBOSE, 1);
Alexander Graf769ce762009-05-11 17:41:42 +0200498#endif
Matthew Booth9e550b32014-04-29 16:03:26 +0100499 }
Alexander Graf769ce762009-05-11 17:41:42 +0200500
Max Reitzff5ca162016-10-25 04:54:30 +0200501 QLIST_INIT(&state->sockets);
Alexander Graf769ce762009-05-11 17:41:42 +0200502 state->s = s;
503
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200504 return 0;
Alexander Graf769ce762009-05-11 17:41:42 +0200505}
506
Paolo Bonzini456af342017-05-15 12:00:55 +0200507/* Called with s->mutex held. */
Alexander Graf769ce762009-05-11 17:41:42 +0200508static void curl_clean_state(CURLState *s)
509{
Paolo Bonzini675a7752017-05-15 12:00:53 +0200510 int j;
511 for (j = 0; j < CURL_NUM_ACB; j++) {
512 assert(!s->acb[j]);
513 }
514
Alexander Graf769ce762009-05-11 17:41:42 +0200515 if (s->s->multi)
516 curl_multi_remove_handle(s->s->multi, s->curl);
Max Reitzff5ca162016-10-25 04:54:30 +0200517
518 while (!QLIST_EMPTY(&s->sockets)) {
519 CURLSocket *socket = QLIST_FIRST(&s->sockets);
520
521 QLIST_REMOVE(socket, next);
522 g_free(socket);
523 }
524
Alexander Graf769ce762009-05-11 17:41:42 +0200525 s->in_use = 0;
Paolo Bonzini2bb5c932017-05-15 12:00:59 +0200526
Paolo Bonzini709f2132018-02-03 10:39:35 -0500527 qemu_co_enter_next(&s->s->free_state_waitq, &s->s->mutex);
Alexander Graf769ce762009-05-11 17:41:42 +0200528}
529
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200530static void curl_parse_filename(const char *filename, QDict *options,
531 Error **errp)
Alexander Graf769ce762009-05-11 17:41:42 +0200532{
Eric Blake46f5ac22017-04-27 16:58:17 -0500533 qdict_put_str(options, CURL_BLOCK_OPT_URL, filename);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200534}
535
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200536static void curl_detach_aio_context(BlockDriverState *bs)
537{
538 BDRVCURLState *s = bs->opaque;
539 int i;
540
Gan Qixinf5056b72020-12-03 15:50:53 +0800541 WITH_QEMU_LOCK_GUARD(&s->mutex) {
542 for (i = 0; i < CURL_NUM_STATES; i++) {
543 if (s->states[i].in_use) {
544 curl_clean_state(&s->states[i]);
545 }
546 if (s->states[i].curl) {
547 curl_easy_cleanup(s->states[i].curl);
548 s->states[i].curl = NULL;
549 }
550 g_free(s->states[i].orig_buf);
551 s->states[i].orig_buf = NULL;
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200552 }
Gan Qixinf5056b72020-12-03 15:50:53 +0800553 if (s->multi) {
554 curl_multi_cleanup(s->multi);
555 s->multi = NULL;
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200556 }
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200557 }
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200558
559 timer_del(&s->timer);
560}
561
562static void curl_attach_aio_context(BlockDriverState *bs,
563 AioContext *new_context)
564{
565 BDRVCURLState *s = bs->opaque;
566
567 aio_timer_init(new_context, &s->timer,
568 QEMU_CLOCK_REALTIME, SCALE_NS,
569 curl_multi_timeout_do, s);
570
571 assert(!s->multi);
572 s->multi = curl_multi_init();
573 s->aio_context = new_context;
574 curl_multi_setopt(s->multi, CURLMOPT_SOCKETFUNCTION, curl_sock_cb);
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200575 curl_multi_setopt(s->multi, CURLMOPT_TIMERDATA, s);
576 curl_multi_setopt(s->multi, CURLMOPT_TIMERFUNCTION, curl_timer_cb);
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200577}
578
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200579static QemuOptsList runtime_opts = {
580 .name = "curl",
581 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
582 .desc = {
583 {
Matthew Boothe3542c62014-05-14 19:28:41 -0400584 .name = CURL_BLOCK_OPT_URL,
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200585 .type = QEMU_OPT_STRING,
586 .help = "URL to open",
587 },
588 {
Matthew Boothe3542c62014-05-14 19:28:41 -0400589 .name = CURL_BLOCK_OPT_READAHEAD,
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200590 .type = QEMU_OPT_SIZE,
591 .help = "Readahead size",
592 },
Matthew Booth97a3ea52014-05-14 19:28:42 -0400593 {
594 .name = CURL_BLOCK_OPT_SSLVERIFY,
595 .type = QEMU_OPT_BOOL,
596 .help = "Verify SSL certificate"
597 },
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -0300598 {
599 .name = CURL_BLOCK_OPT_TIMEOUT,
600 .type = QEMU_OPT_NUMBER,
601 .help = "Curl timeout"
602 },
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100603 {
604 .name = CURL_BLOCK_OPT_COOKIE,
605 .type = QEMU_OPT_STRING,
606 .help = "Pass the cookie or list of cookies with each request"
607 },
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000608 {
Peter Krempa327c8eb2017-05-04 16:00:06 +0200609 .name = CURL_BLOCK_OPT_COOKIE_SECRET,
610 .type = QEMU_OPT_STRING,
611 .help = "ID of secret used as cookie passed with each request"
612 },
613 {
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000614 .name = CURL_BLOCK_OPT_USERNAME,
615 .type = QEMU_OPT_STRING,
616 .help = "Username for HTTP auth"
617 },
618 {
619 .name = CURL_BLOCK_OPT_PASSWORD_SECRET,
620 .type = QEMU_OPT_STRING,
621 .help = "ID of secret used as password for HTTP auth",
622 },
623 {
624 .name = CURL_BLOCK_OPT_PROXY_USERNAME,
625 .type = QEMU_OPT_STRING,
626 .help = "Username for HTTP proxy auth"
627 },
628 {
629 .name = CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET,
630 .type = QEMU_OPT_STRING,
631 .help = "ID of secret used as password for HTTP proxy auth",
632 },
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200633 { /* end of list */ }
634 },
635};
636
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000637
Max Reitz015a1032013-09-05 14:22:29 +0200638static int curl_open(BlockDriverState *bs, QDict *options, int flags,
639 Error **errp)
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200640{
641 BDRVCURLState *s = bs->opaque;
642 CURLState *state = NULL;
643 QemuOpts *opts;
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200644 const char *file;
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100645 const char *cookie;
Peter Krempa327c8eb2017-05-04 16:00:06 +0200646 const char *cookie_secret;
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200647 double d;
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000648 const char *secretid;
Max Reitz34634ca2017-03-31 14:04:31 +0200649 const char *protocol_delimiter;
Jeff Cody2d259642017-11-07 17:27:22 -0500650 int ret;
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200651
Kevin Wolf6ceef362018-10-08 17:27:18 +0200652 ret = bdrv_apply_auto_read_only(bs, "curl driver does not support writes",
653 errp);
654 if (ret < 0) {
655 return ret;
Richard W.M. Jonesa7cea2b2013-06-10 12:38:43 +0100656 }
657
Jeff Cody2d259642017-11-07 17:27:22 -0500658 if (!libcurl_initialized) {
659 ret = curl_global_init(CURL_GLOBAL_ALL);
660 if (ret) {
661 error_setg(errp, "libcurl initialization failed with %d", ret);
662 return -EIO;
663 }
664 libcurl_initialized = true;
665 }
666
Paolo Bonzini456af342017-05-15 12:00:55 +0200667 qemu_mutex_init(&s->mutex);
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800668 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
Markus Armbruster668f62e2020-07-07 18:06:02 +0200669 if (!qemu_opts_absorb_qdict(opts, options, errp)) {
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200670 goto out_noclean;
671 }
672
Matthew Boothe3542c62014-05-14 19:28:41 -0400673 s->readahead_size = qemu_opt_get_size(opts, CURL_BLOCK_OPT_READAHEAD,
Max Reitz712b64e2019-02-01 20:29:31 +0100674 CURL_BLOCK_OPT_READAHEAD_DEFAULT);
Nolanc76f4952009-07-01 17:16:52 -0700675 if ((s->readahead_size & 0x1ff) != 0) {
Paolo Bonzini2a94fee2014-02-17 14:43:57 +0100676 error_setg(errp, "HTTP_READAHEAD_SIZE %zd is not a multiple of 512",
677 s->readahead_size);
Nolanc76f4952009-07-01 17:16:52 -0700678 goto out_noclean;
679 }
680
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -0300681 s->timeout = qemu_opt_get_number(opts, CURL_BLOCK_OPT_TIMEOUT,
Max Reitz712b64e2019-02-01 20:29:31 +0100682 CURL_BLOCK_OPT_TIMEOUT_DEFAULT);
Richard W.M. Jonesf76faed2014-10-26 11:05:27 +0000683 if (s->timeout > CURL_TIMEOUT_MAX) {
684 error_setg(errp, "timeout parameter is too large or negative");
685 goto out_noclean;
686 }
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -0300687
Max Reitz712b64e2019-02-01 20:29:31 +0100688 s->sslverify = qemu_opt_get_bool(opts, CURL_BLOCK_OPT_SSLVERIFY,
689 CURL_BLOCK_OPT_SSLVERIFY_DEFAULT);
Matthew Booth97a3ea52014-05-14 19:28:42 -0400690
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100691 cookie = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE);
Peter Krempa327c8eb2017-05-04 16:00:06 +0200692 cookie_secret = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE_SECRET);
693
694 if (cookie && cookie_secret) {
695 error_setg(errp,
696 "curl driver cannot handle both cookie and cookie secret");
697 goto out_noclean;
698 }
699
700 if (cookie_secret) {
701 s->cookie = qcrypto_secret_lookup_as_utf8(cookie_secret, errp);
702 if (!s->cookie) {
703 goto out_noclean;
704 }
705 } else {
706 s->cookie = g_strdup(cookie);
707 }
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100708
Matthew Boothe3542c62014-05-14 19:28:41 -0400709 file = qemu_opt_get(opts, CURL_BLOCK_OPT_URL);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200710 if (file == NULL) {
Paolo Bonzini2a94fee2014-02-17 14:43:57 +0100711 error_setg(errp, "curl block driver requires an 'url' option");
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200712 goto out_noclean;
713 }
714
Max Reitz34634ca2017-03-31 14:04:31 +0200715 if (!strstart(file, bs->drv->protocol_name, &protocol_delimiter) ||
716 !strstart(protocol_delimiter, "://", NULL))
717 {
718 error_setg(errp, "%s curl driver cannot handle the URL '%s' (does not "
719 "start with '%s://')", bs->drv->protocol_name, file,
720 bs->drv->protocol_name);
721 goto out_noclean;
722 }
723
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000724 s->username = g_strdup(qemu_opt_get(opts, CURL_BLOCK_OPT_USERNAME));
725 secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PASSWORD_SECRET);
726
727 if (secretid) {
728 s->password = qcrypto_secret_lookup_as_utf8(secretid, errp);
729 if (!s->password) {
730 goto out_noclean;
731 }
732 }
733
734 s->proxyusername = g_strdup(
735 qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_USERNAME));
736 secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET);
737 if (secretid) {
738 s->proxypassword = qcrypto_secret_lookup_as_utf8(secretid, errp);
739 if (!s->proxypassword) {
740 goto out_noclean;
741 }
742 }
743
Laurent Viviered2a66d2018-12-13 17:27:25 +0100744 trace_curl_open(file);
Paolo Bonzini709f2132018-02-03 10:39:35 -0500745 qemu_co_queue_init(&s->free_state_waitq);
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200746 s->aio_context = bdrv_get_aio_context(bs);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200747 s->url = g_strdup(file);
Paolo Bonzini456af342017-05-15 12:00:55 +0200748 qemu_mutex_lock(&s->mutex);
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200749 state = curl_find_state(s);
Paolo Bonzini456af342017-05-15 12:00:55 +0200750 qemu_mutex_unlock(&s->mutex);
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200751 if (!state) {
Alexander Graf769ce762009-05-11 17:41:42 +0200752 goto out_noclean;
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200753 }
Alexander Graf769ce762009-05-11 17:41:42 +0200754
755 // Get file size
756
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200757 if (curl_init_state(s, state) < 0) {
758 goto out;
759 }
760
Fam Zheng3494d652013-07-02 15:19:21 +0800761 s->accept_range = false;
Alexander Graf769ce762009-05-11 17:41:42 +0200762 curl_easy_setopt(state->curl, CURLOPT_NOBODY, 1);
Fam Zheng3494d652013-07-02 15:19:21 +0800763 curl_easy_setopt(state->curl, CURLOPT_HEADERFUNCTION,
764 curl_header_cb);
765 curl_easy_setopt(state->curl, CURLOPT_HEADERDATA, s);
Alexander Graf769ce762009-05-11 17:41:42 +0200766 if (curl_easy_perform(state->curl))
767 goto out;
Tomáš Golembiovskýa41c4572016-07-08 13:18:09 +0200768 if (curl_easy_getinfo(state->curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &d)) {
Alexander Graf769ce762009-05-11 17:41:42 +0200769 goto out;
Tomáš Golembiovskýa41c4572016-07-08 13:18:09 +0200770 }
771 /* Prior CURL 7.19.4 return value of 0 could mean that the file size is not
772 * know or the size is zero. From 7.19.4 CURL returns -1 if size is not
Stefan Weil50d6a8a2018-07-12 21:51:20 +0200773 * known and zero if it is really zero-length file. */
Tomáš Golembiovskýa41c4572016-07-08 13:18:09 +0200774#if LIBCURL_VERSION_NUM >= 0x071304
775 if (d < 0) {
776 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
777 "Server didn't report file size.");
778 goto out;
779 }
780#else
781 if (d <= 0) {
782 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
783 "Unknown file size or zero-length file.");
784 goto out;
785 }
786#endif
787
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200788 s->len = d;
Tomáš Golembiovskýa41c4572016-07-08 13:18:09 +0200789
Fam Zheng3494d652013-07-02 15:19:21 +0800790 if ((!strncasecmp(s->url, "http://", strlen("http://"))
791 || !strncasecmp(s->url, "https://", strlen("https://")))
792 && !s->accept_range) {
793 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
794 "Server does not support 'range' (byte ranges).");
795 goto out;
796 }
Laurent Viviered2a66d2018-12-13 17:27:25 +0100797 trace_curl_open_size(s->len);
Alexander Graf769ce762009-05-11 17:41:42 +0200798
Paolo Bonzini456af342017-05-15 12:00:55 +0200799 qemu_mutex_lock(&s->mutex);
Alexander Graf769ce762009-05-11 17:41:42 +0200800 curl_clean_state(state);
Paolo Bonzini456af342017-05-15 12:00:55 +0200801 qemu_mutex_unlock(&s->mutex);
Alexander Graf769ce762009-05-11 17:41:42 +0200802 curl_easy_cleanup(state->curl);
803 state->curl = NULL;
804
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200805 curl_attach_aio_context(bs, bdrv_get_aio_context(bs));
Alexander Graf769ce762009-05-11 17:41:42 +0200806
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200807 qemu_opts_del(opts);
Alexander Graf769ce762009-05-11 17:41:42 +0200808 return 0;
809
810out:
Maria Kustovaacd7fdc2014-03-18 09:59:18 +0400811 error_setg(errp, "CURL: Error opening file: %s", state->errmsg);
Alexander Graf769ce762009-05-11 17:41:42 +0200812 curl_easy_cleanup(state->curl);
813 state->curl = NULL;
814out_noclean:
Paolo Bonzini456af342017-05-15 12:00:55 +0200815 qemu_mutex_destroy(&s->mutex);
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100816 g_free(s->cookie);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200817 g_free(s->url);
Jeff Cody996922d2017-11-07 17:27:23 -0500818 g_free(s->username);
819 g_free(s->proxyusername);
820 g_free(s->proxypassword);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200821 qemu_opts_del(opts);
Alexander Graf769ce762009-05-11 17:41:42 +0200822 return -EINVAL;
823}
824
Paolo Bonzini28256d82017-05-15 12:00:58 +0200825static void curl_setup_preadv(BlockDriverState *bs, CURLAIOCB *acb)
Alexander Graf769ce762009-05-11 17:41:42 +0200826{
Alexander Graf769ce762009-05-11 17:41:42 +0200827 CURLState *state;
Matthew Boothb69cdef2014-04-29 16:03:29 +0100828 int running;
Alexander Graf769ce762009-05-11 17:41:42 +0200829
Paolo Bonzini19196312017-02-13 14:52:31 +0100830 BDRVCURLState *s = bs->opaque;
Alexander Graf769ce762009-05-11 17:41:42 +0200831
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200832 uint64_t start = acb->offset;
833 uint64_t end;
Alexander Graf769ce762009-05-11 17:41:42 +0200834
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100835 qemu_mutex_lock(&s->mutex);
Paolo Bonzini19196312017-02-13 14:52:31 +0100836
Alexander Graf769ce762009-05-11 17:41:42 +0200837 // In case we have the requested data already (e.g. read-ahead),
838 // we can just call the callback and be done.
Paolo Bonzini28256d82017-05-15 12:00:58 +0200839 if (curl_find_buf(s, start, acb->bytes, acb)) {
840 goto out;
Alexander Graf769ce762009-05-11 17:41:42 +0200841 }
842
843 // No cache found, so let's start a new request
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200844 for (;;) {
845 state = curl_find_state(s);
846 if (state) {
847 break;
848 }
Paolo Bonzini709f2132018-02-03 10:39:35 -0500849 qemu_co_queue_wait(&s->free_state_waitq, &s->mutex);
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200850 }
851
852 if (curl_init_state(s, state) < 0) {
853 curl_clean_state(state);
Paolo Bonzini28256d82017-05-15 12:00:58 +0200854 acb->ret = -EIO;
Paolo Bonzini19196312017-02-13 14:52:31 +0100855 goto out;
Nick Thomas363c3c82011-09-21 11:55:50 +0100856 }
Alexander Graf769ce762009-05-11 17:41:42 +0200857
858 acb->start = 0;
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200859 acb->end = MIN(acb->bytes, s->len - start);
Alexander Graf769ce762009-05-11 17:41:42 +0200860
861 state->buf_off = 0;
Markus Armbrusterf7047c22014-06-06 18:25:12 +0200862 g_free(state->orig_buf);
Alexander Graf769ce762009-05-11 17:41:42 +0200863 state->buf_start = start;
Max Reitz4e504532016-10-25 04:54:31 +0200864 state->buf_len = MIN(acb->end + s->readahead_size, s->len - start);
865 end = start + state->buf_len - 1;
Kevin Wolf8dc7a772014-05-20 13:26:40 +0200866 state->orig_buf = g_try_malloc(state->buf_len);
867 if (state->buf_len && state->orig_buf == NULL) {
868 curl_clean_state(state);
Paolo Bonzini28256d82017-05-15 12:00:58 +0200869 acb->ret = -ENOMEM;
Paolo Bonzini19196312017-02-13 14:52:31 +0100870 goto out;
Kevin Wolf8dc7a772014-05-20 13:26:40 +0200871 }
Alexander Graf769ce762009-05-11 17:41:42 +0200872 state->acb[0] = acb;
873
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200874 snprintf(state->range, 127, "%" PRIu64 "-%" PRIu64, start, end);
Laurent Viviered2a66d2018-12-13 17:27:25 +0100875 trace_curl_setup_preadv(acb->bytes, start, state->range);
Alexander Graf769ce762009-05-11 17:41:42 +0200876 curl_easy_setopt(state->curl, CURLOPT_RANGE, state->range);
877
Max Reitzc34dc072019-09-10 14:41:36 +0200878 if (curl_multi_add_handle(s->multi, state->curl) != CURLM_OK) {
879 state->acb[0] = NULL;
880 acb->ret = -EIO;
881
882 curl_clean_state(state);
883 goto out;
884 }
Alexander Graf769ce762009-05-11 17:41:42 +0200885
Matthew Boothb69cdef2014-04-29 16:03:29 +0100886 /* Tell curl it needs to kick things off */
887 curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
Paolo Bonzini19196312017-02-13 14:52:31 +0100888
889out:
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100890 qemu_mutex_unlock(&s->mutex);
Nick Thomas363c3c82011-09-21 11:55:50 +0100891}
892
Paolo Bonzini28256d82017-05-15 12:00:58 +0200893static int coroutine_fn curl_co_preadv(BlockDriverState *bs,
894 uint64_t offset, uint64_t bytes, QEMUIOVector *qiov, int flags)
Nick Thomas363c3c82011-09-21 11:55:50 +0100895{
Paolo Bonzini28256d82017-05-15 12:00:58 +0200896 CURLAIOCB acb = {
897 .co = qemu_coroutine_self(),
898 .ret = -EINPROGRESS,
899 .qiov = qiov,
900 .offset = offset,
901 .bytes = bytes
902 };
Nick Thomas363c3c82011-09-21 11:55:50 +0100903
Paolo Bonzini28256d82017-05-15 12:00:58 +0200904 curl_setup_preadv(bs, &acb);
905 while (acb.ret == -EINPROGRESS) {
906 qemu_coroutine_yield();
907 }
908 return acb.ret;
Alexander Graf769ce762009-05-11 17:41:42 +0200909}
910
Alexander Graf769ce762009-05-11 17:41:42 +0200911static void curl_close(BlockDriverState *bs)
912{
913 BDRVCURLState *s = bs->opaque;
Alexander Graf769ce762009-05-11 17:41:42 +0200914
Laurent Viviered2a66d2018-12-13 17:27:25 +0100915 trace_curl_close();
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200916 curl_detach_aio_context(bs);
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100917 qemu_mutex_destroy(&s->mutex);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100918
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100919 g_free(s->cookie);
Stefan Weil45724d62012-09-01 11:06:45 +0200920 g_free(s->url);
Jeff Cody996922d2017-11-07 17:27:23 -0500921 g_free(s->username);
922 g_free(s->proxyusername);
923 g_free(s->proxypassword);
Alexander Graf769ce762009-05-11 17:41:42 +0200924}
925
926static int64_t curl_getlength(BlockDriverState *bs)
927{
928 BDRVCURLState *s = bs->opaque;
929 return s->len;
930}
931
Max Reitz937c0072019-02-01 20:29:32 +0100932static void curl_refresh_filename(BlockDriverState *bs)
933{
934 BDRVCURLState *s = bs->opaque;
935
936 /* "readahead" and "timeout" do not change the guest-visible data,
937 * so ignore them */
938 if (s->sslverify != CURL_BLOCK_OPT_SSLVERIFY_DEFAULT ||
939 s->cookie || s->username || s->password || s->proxyusername ||
940 s->proxypassword)
941 {
942 return;
943 }
944
945 pstrcpy(bs->exact_filename, sizeof(bs->exact_filename), s->url);
946}
947
948
Max Reitz26542672019-02-01 20:29:25 +0100949static const char *const curl_strong_runtime_opts[] = {
950 CURL_BLOCK_OPT_URL,
951 CURL_BLOCK_OPT_SSLVERIFY,
952 CURL_BLOCK_OPT_COOKIE,
953 CURL_BLOCK_OPT_COOKIE_SECRET,
954 CURL_BLOCK_OPT_USERNAME,
955 CURL_BLOCK_OPT_PASSWORD_SECRET,
956 CURL_BLOCK_OPT_PROXY_USERNAME,
957 CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET,
958
959 NULL
960};
961
Alexander Graf769ce762009-05-11 17:41:42 +0200962static BlockDriver bdrv_http = {
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200963 .format_name = "http",
964 .protocol_name = "http",
Alexander Graf769ce762009-05-11 17:41:42 +0200965
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200966 .instance_size = sizeof(BDRVCURLState),
967 .bdrv_parse_filename = curl_parse_filename,
968 .bdrv_file_open = curl_open,
969 .bdrv_close = curl_close,
970 .bdrv_getlength = curl_getlength,
Alexander Graf769ce762009-05-11 17:41:42 +0200971
Paolo Bonzini28256d82017-05-15 12:00:58 +0200972 .bdrv_co_preadv = curl_co_preadv,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200973
974 .bdrv_detach_aio_context = curl_detach_aio_context,
975 .bdrv_attach_aio_context = curl_attach_aio_context,
Max Reitz26542672019-02-01 20:29:25 +0100976
Max Reitz937c0072019-02-01 20:29:32 +0100977 .bdrv_refresh_filename = curl_refresh_filename,
Max Reitz26542672019-02-01 20:29:25 +0100978 .strong_runtime_opts = curl_strong_runtime_opts,
Alexander Graf769ce762009-05-11 17:41:42 +0200979};
980
981static BlockDriver bdrv_https = {
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200982 .format_name = "https",
983 .protocol_name = "https",
Alexander Graf769ce762009-05-11 17:41:42 +0200984
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200985 .instance_size = sizeof(BDRVCURLState),
986 .bdrv_parse_filename = curl_parse_filename,
987 .bdrv_file_open = curl_open,
988 .bdrv_close = curl_close,
989 .bdrv_getlength = curl_getlength,
Alexander Graf769ce762009-05-11 17:41:42 +0200990
Paolo Bonzini28256d82017-05-15 12:00:58 +0200991 .bdrv_co_preadv = curl_co_preadv,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200992
993 .bdrv_detach_aio_context = curl_detach_aio_context,
994 .bdrv_attach_aio_context = curl_attach_aio_context,
Max Reitz26542672019-02-01 20:29:25 +0100995
Max Reitz937c0072019-02-01 20:29:32 +0100996 .bdrv_refresh_filename = curl_refresh_filename,
Max Reitz26542672019-02-01 20:29:25 +0100997 .strong_runtime_opts = curl_strong_runtime_opts,
Alexander Graf769ce762009-05-11 17:41:42 +0200998};
999
1000static BlockDriver bdrv_ftp = {
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001001 .format_name = "ftp",
1002 .protocol_name = "ftp",
Alexander Graf769ce762009-05-11 17:41:42 +02001003
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001004 .instance_size = sizeof(BDRVCURLState),
1005 .bdrv_parse_filename = curl_parse_filename,
1006 .bdrv_file_open = curl_open,
1007 .bdrv_close = curl_close,
1008 .bdrv_getlength = curl_getlength,
Alexander Graf769ce762009-05-11 17:41:42 +02001009
Paolo Bonzini28256d82017-05-15 12:00:58 +02001010 .bdrv_co_preadv = curl_co_preadv,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001011
1012 .bdrv_detach_aio_context = curl_detach_aio_context,
1013 .bdrv_attach_aio_context = curl_attach_aio_context,
Max Reitz26542672019-02-01 20:29:25 +01001014
Max Reitz937c0072019-02-01 20:29:32 +01001015 .bdrv_refresh_filename = curl_refresh_filename,
Max Reitz26542672019-02-01 20:29:25 +01001016 .strong_runtime_opts = curl_strong_runtime_opts,
Alexander Graf769ce762009-05-11 17:41:42 +02001017};
1018
1019static BlockDriver bdrv_ftps = {
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001020 .format_name = "ftps",
1021 .protocol_name = "ftps",
Alexander Graf769ce762009-05-11 17:41:42 +02001022
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001023 .instance_size = sizeof(BDRVCURLState),
1024 .bdrv_parse_filename = curl_parse_filename,
1025 .bdrv_file_open = curl_open,
1026 .bdrv_close = curl_close,
1027 .bdrv_getlength = curl_getlength,
Alexander Graf769ce762009-05-11 17:41:42 +02001028
Paolo Bonzini28256d82017-05-15 12:00:58 +02001029 .bdrv_co_preadv = curl_co_preadv,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001030
1031 .bdrv_detach_aio_context = curl_detach_aio_context,
1032 .bdrv_attach_aio_context = curl_attach_aio_context,
Max Reitz26542672019-02-01 20:29:25 +01001033
Max Reitz937c0072019-02-01 20:29:32 +01001034 .bdrv_refresh_filename = curl_refresh_filename,
Max Reitz26542672019-02-01 20:29:25 +01001035 .strong_runtime_opts = curl_strong_runtime_opts,
Alexander Graf769ce762009-05-11 17:41:42 +02001036};
1037
Alexander Graf769ce762009-05-11 17:41:42 +02001038static void curl_block_init(void)
1039{
1040 bdrv_register(&bdrv_http);
1041 bdrv_register(&bdrv_https);
1042 bdrv_register(&bdrv_ftp);
1043 bdrv_register(&bdrv_ftps);
Alexander Graf769ce762009-05-11 17:41:42 +02001044}
1045
1046block_init(curl_block_init);