blob: aa425357834ef345d2459e7854df5cbe4cf96c2f [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 Armbruster922a01a2018-02-01 12:18:46 +010028#include "qemu/option.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010029#include "block/block_int.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010030#include "qapi/qmp/qdict.h"
Markus Armbrusterd49b6832015-03-17 18:29:20 +010031#include "qapi/qmp/qstring.h"
Daniel P. Berrange1bff9602016-01-21 14:19:20 +000032#include "crypto/secret.h"
Alexander Graf769ce762009-05-11 17:41:42 +020033#include <curl/curl.h>
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020034#include "qemu/cutils.h"
Alexander Graf769ce762009-05-11 17:41:42 +020035
Richard W.M. Jones41c23462014-08-26 21:31:08 +010036// #define DEBUG_CURL
Alexander Graf769ce762009-05-11 17:41:42 +020037// #define DEBUG_VERBOSE
38
39#ifdef DEBUG_CURL
Zhou Jieed79f372016-04-29 13:12:01 +080040#define DEBUG_CURL_PRINT 1
Alexander Graf769ce762009-05-11 17:41:42 +020041#else
Zhou Jieed79f372016-04-29 13:12:01 +080042#define DEBUG_CURL_PRINT 0
Alexander Graf769ce762009-05-11 17:41:42 +020043#endif
Zhou Jieed79f372016-04-29 13:12:01 +080044#define DPRINTF(fmt, ...) \
45 do { \
46 if (DEBUG_CURL_PRINT) { \
47 fprintf(stderr, fmt, ## __VA_ARGS__); \
48 } \
49 } while (0)
Alexander Graf769ce762009-05-11 17:41:42 +020050
Peter Maydell031fd1b2014-01-24 14:56:17 +010051#if LIBCURL_VERSION_NUM >= 0x071000
52/* The multi interface timer callback was introduced in 7.16.0 */
53#define NEED_CURL_TIMER_CALLBACK
Matthew Booth9aedd5a2014-05-14 19:28:40 -040054#define HAVE_SOCKET_ACTION
55#endif
56
57#ifndef HAVE_SOCKET_ACTION
58/* If curl_multi_socket_action isn't available, define it statically here in
59 * terms of curl_multi_socket. Note that ev_bitmask will be ignored, which is
60 * less efficient but still safe. */
61static CURLMcode __curl_multi_socket_action(CURLM *multi_handle,
62 curl_socket_t sockfd,
63 int ev_bitmask,
64 int *running_handles)
65{
66 return curl_multi_socket(multi_handle, sockfd, running_handles);
67}
68#define curl_multi_socket_action __curl_multi_socket_action
Peter Maydell031fd1b2014-01-24 14:56:17 +010069#endif
70
Stefan Hajnoczifb6d1bb2013-02-08 08:49:10 +010071#define PROTOCOLS (CURLPROTO_HTTP | CURLPROTO_HTTPS | \
Max Reitz23dce382016-11-02 18:55:37 +010072 CURLPROTO_FTP | CURLPROTO_FTPS)
Stefan Hajnoczifb6d1bb2013-02-08 08:49:10 +010073
Alexander Graf769ce762009-05-11 17:41:42 +020074#define CURL_NUM_STATES 8
75#define CURL_NUM_ACB 8
Matthew Boothe3542c62014-05-14 19:28:41 -040076#define READ_AHEAD_DEFAULT (256 * 1024)
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -030077#define CURL_TIMEOUT_DEFAULT 5
Richard W.M. Jonesf76faed2014-10-26 11:05:27 +000078#define CURL_TIMEOUT_MAX 10000
Alexander Graf769ce762009-05-11 17:41:42 +020079
Matthew Boothe3542c62014-05-14 19:28:41 -040080#define CURL_BLOCK_OPT_URL "url"
81#define CURL_BLOCK_OPT_READAHEAD "readahead"
Matthew Booth97a3ea52014-05-14 19:28:42 -040082#define CURL_BLOCK_OPT_SSLVERIFY "sslverify"
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -030083#define CURL_BLOCK_OPT_TIMEOUT "timeout"
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +010084#define CURL_BLOCK_OPT_COOKIE "cookie"
Peter Krempa327c8eb2017-05-04 16:00:06 +020085#define CURL_BLOCK_OPT_COOKIE_SECRET "cookie-secret"
Daniel P. Berrange1bff9602016-01-21 14:19:20 +000086#define CURL_BLOCK_OPT_USERNAME "username"
87#define CURL_BLOCK_OPT_PASSWORD_SECRET "password-secret"
88#define CURL_BLOCK_OPT_PROXY_USERNAME "proxy-username"
89#define CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET "proxy-password-secret"
Matthew Boothe3542c62014-05-14 19:28:41 -040090
Alexander Graf769ce762009-05-11 17:41:42 +020091struct BDRVCURLState;
92
Jeff Cody2d259642017-11-07 17:27:22 -050093static bool libcurl_initialized;
94
Alexander Graf769ce762009-05-11 17:41:42 +020095typedef struct CURLAIOCB {
Paolo Bonzini28256d82017-05-15 12:00:58 +020096 Coroutine *co;
Alexander Graf769ce762009-05-11 17:41:42 +020097 QEMUIOVector *qiov;
Nick Thomas363c3c82011-09-21 11:55:50 +010098
Paolo Bonzini2125e5e2017-05-15 12:00:57 +020099 uint64_t offset;
100 uint64_t bytes;
Paolo Bonzini28256d82017-05-15 12:00:58 +0200101 int ret;
Nick Thomas363c3c82011-09-21 11:55:50 +0100102
Alexander Graf769ce762009-05-11 17:41:42 +0200103 size_t start;
104 size_t end;
105} CURLAIOCB;
106
Max Reitzff5ca162016-10-25 04:54:30 +0200107typedef struct CURLSocket {
108 int fd;
109 QLIST_ENTRY(CURLSocket) next;
110} CURLSocket;
111
Alexander Graf769ce762009-05-11 17:41:42 +0200112typedef struct CURLState
113{
114 struct BDRVCURLState *s;
115 CURLAIOCB *acb[CURL_NUM_ACB];
116 CURL *curl;
Max Reitzff5ca162016-10-25 04:54:30 +0200117 QLIST_HEAD(, CURLSocket) sockets;
Alexander Graf769ce762009-05-11 17:41:42 +0200118 char *orig_buf;
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200119 uint64_t buf_start;
Alexander Graf769ce762009-05-11 17:41:42 +0200120 size_t buf_off;
121 size_t buf_len;
122 char range[128];
123 char errmsg[CURL_ERROR_SIZE];
124 char in_use;
125} CURLState;
126
127typedef struct BDRVCURLState {
128 CURLM *multi;
Peter Maydell031fd1b2014-01-24 14:56:17 +0100129 QEMUTimer timer;
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200130 uint64_t len;
Alexander Graf769ce762009-05-11 17:41:42 +0200131 CURLState states[CURL_NUM_STATES];
132 char *url;
Nolanc76f4952009-07-01 17:16:52 -0700133 size_t readahead_size;
Matthew Booth97a3ea52014-05-14 19:28:42 -0400134 bool sslverify;
Richard W.M. Jonesf76faed2014-10-26 11:05:27 +0000135 uint64_t timeout;
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100136 char *cookie;
Fam Zheng3494d652013-07-02 15:19:21 +0800137 bool accept_range;
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200138 AioContext *aio_context;
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100139 QemuMutex mutex;
Paolo Bonzini709f2132018-02-03 10:39:35 -0500140 CoQueue free_state_waitq;
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000141 char *username;
142 char *password;
143 char *proxyusername;
144 char *proxypassword;
Alexander Graf769ce762009-05-11 17:41:42 +0200145} BDRVCURLState;
146
147static void curl_clean_state(CURLState *s);
148static void curl_multi_do(void *arg);
Matthew Booth838ef602014-04-29 16:03:30 +0100149static void curl_multi_read(void *arg);
Alexander Graf769ce762009-05-11 17:41:42 +0200150
Peter Maydell031fd1b2014-01-24 14:56:17 +0100151#ifdef NEED_CURL_TIMER_CALLBACK
Paolo Bonzini34db05e2017-05-15 12:00:54 +0200152/* Called from curl_multi_do_locked, with s->mutex held. */
Peter Maydell031fd1b2014-01-24 14:56:17 +0100153static int curl_timer_cb(CURLM *multi, long timeout_ms, void *opaque)
154{
155 BDRVCURLState *s = opaque;
156
157 DPRINTF("CURL: timer callback timeout_ms %ld\n", timeout_ms);
158 if (timeout_ms == -1) {
159 timer_del(&s->timer);
160 } else {
161 int64_t timeout_ns = (int64_t)timeout_ms * 1000 * 1000;
162 timer_mod(&s->timer,
163 qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + timeout_ns);
164 }
165 return 0;
166}
167#endif
168
Paolo Bonzini34db05e2017-05-15 12:00:54 +0200169/* Called from curl_multi_do_locked, with s->mutex held. */
Alexander Graf769ce762009-05-11 17:41:42 +0200170static int curl_sock_cb(CURL *curl, curl_socket_t fd, int action,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200171 void *userp, void *sp)
Alexander Graf769ce762009-05-11 17:41:42 +0200172{
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200173 BDRVCURLState *s;
Matthew Booth838ef602014-04-29 16:03:30 +0100174 CURLState *state = NULL;
Max Reitzff5ca162016-10-25 04:54:30 +0200175 CURLSocket *socket;
176
Matthew Booth838ef602014-04-29 16:03:30 +0100177 curl_easy_getinfo(curl, CURLINFO_PRIVATE, (char **)&state);
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200178 s = state->s;
Matthew Booth838ef602014-04-29 16:03:30 +0100179
Max Reitzff5ca162016-10-25 04:54:30 +0200180 QLIST_FOREACH(socket, &state->sockets, next) {
181 if (socket->fd == fd) {
182 if (action == CURL_POLL_REMOVE) {
183 QLIST_REMOVE(socket, next);
184 g_free(socket);
185 }
186 break;
187 }
188 }
189 if (!socket) {
190 socket = g_new0(CURLSocket, 1);
191 socket->fd = fd;
192 QLIST_INSERT_HEAD(&state->sockets, socket, next);
193 }
194 socket = NULL;
195
Fam Zheng92b6a162016-08-01 13:04:48 +0800196 DPRINTF("CURL (AIO): Sock action %d on fd %d\n", action, (int)fd);
Alexander Graf769ce762009-05-11 17:41:42 +0200197 switch (action) {
198 case CURL_POLL_IN:
Fam Zhengdca21ef2015-10-23 11:08:05 +0800199 aio_set_fd_handler(s->aio_context, fd, false,
Stefan Hajnoczif6a51c82016-12-01 19:26:41 +0000200 curl_multi_read, NULL, NULL, state);
Alexander Graf769ce762009-05-11 17:41:42 +0200201 break;
202 case CURL_POLL_OUT:
Fam Zhengdca21ef2015-10-23 11:08:05 +0800203 aio_set_fd_handler(s->aio_context, fd, false,
Stefan Hajnoczif6a51c82016-12-01 19:26:41 +0000204 NULL, curl_multi_do, NULL, state);
Alexander Graf769ce762009-05-11 17:41:42 +0200205 break;
206 case CURL_POLL_INOUT:
Fam Zhengdca21ef2015-10-23 11:08:05 +0800207 aio_set_fd_handler(s->aio_context, fd, false,
Stefan Hajnoczif6a51c82016-12-01 19:26:41 +0000208 curl_multi_read, curl_multi_do, NULL, state);
Alexander Graf769ce762009-05-11 17:41:42 +0200209 break;
210 case CURL_POLL_REMOVE:
Fam Zhengdca21ef2015-10-23 11:08:05 +0800211 aio_set_fd_handler(s->aio_context, fd, false,
Stefan Hajnoczif6a51c82016-12-01 19:26:41 +0000212 NULL, NULL, NULL, NULL);
Alexander Graf769ce762009-05-11 17:41:42 +0200213 break;
214 }
215
216 return 0;
217}
218
Paolo Bonzini34db05e2017-05-15 12:00:54 +0200219/* Called from curl_multi_do_locked, with s->mutex held. */
Fam Zheng3494d652013-07-02 15:19:21 +0800220static size_t curl_header_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
Alexander Graf769ce762009-05-11 17:41:42 +0200221{
Fam Zheng3494d652013-07-02 15:19:21 +0800222 BDRVCURLState *s = opaque;
Alexander Graf769ce762009-05-11 17:41:42 +0200223 size_t realsize = size * nmemb;
Fam Zheng3494d652013-07-02 15:19:21 +0800224 const char *accept_line = "Accept-Ranges: bytes";
Alexander Graf769ce762009-05-11 17:41:42 +0200225
Fam Zheng3494d652013-07-02 15:19:21 +0800226 if (realsize >= strlen(accept_line)
227 && strncmp((char *)ptr, accept_line, strlen(accept_line)) == 0) {
228 s->accept_range = true;
Blue Swirl0bfcd592010-05-22 08:02:12 +0000229 }
Alexander Graf769ce762009-05-11 17:41:42 +0200230
231 return realsize;
232}
233
Paolo Bonzini34db05e2017-05-15 12:00:54 +0200234/* Called from curl_multi_do_locked, with s->mutex held. */
Alexander Graf769ce762009-05-11 17:41:42 +0200235static size_t curl_read_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
236{
237 CURLState *s = ((CURLState*)opaque);
238 size_t realsize = size * nmemb;
239 int i;
240
Blue Swirl0bfcd592010-05-22 08:02:12 +0000241 DPRINTF("CURL: Just reading %zd bytes\n", realsize);
Alexander Graf769ce762009-05-11 17:41:42 +0200242
Max Reitz4e767652016-10-25 04:54:29 +0200243 if (!s || !s->orig_buf) {
244 goto read_end;
245 }
Alexander Graf769ce762009-05-11 17:41:42 +0200246
Fam Zheng6d4b9e52014-03-26 13:05:40 +0100247 if (s->buf_off >= s->buf_len) {
248 /* buffer full, read nothing */
Max Reitz4e767652016-10-25 04:54:29 +0200249 goto read_end;
Fam Zheng6d4b9e52014-03-26 13:05:40 +0100250 }
251 realsize = MIN(realsize, s->buf_len - s->buf_off);
Alexander Graf769ce762009-05-11 17:41:42 +0200252 memcpy(s->orig_buf + s->buf_off, ptr, realsize);
253 s->buf_off += realsize;
254
255 for(i=0; i<CURL_NUM_ACB; i++) {
256 CURLAIOCB *acb = s->acb[i];
257
258 if (!acb)
259 continue;
260
261 if ((s->buf_off >= acb->end)) {
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200262 size_t request_length = acb->bytes;
Max Reitz4e504532016-10-25 04:54:31 +0200263
Michael Tokarev03396142012-06-07 20:17:55 +0400264 qemu_iovec_from_buf(acb->qiov, 0, s->orig_buf + acb->start,
265 acb->end - acb->start);
Max Reitz4e504532016-10-25 04:54:31 +0200266
267 if (acb->end - acb->start < request_length) {
268 size_t offset = acb->end - acb->start;
269 qemu_iovec_memset(acb->qiov, offset, 0,
270 request_length - offset);
271 }
272
Paolo Bonzini28256d82017-05-15 12:00:58 +0200273 acb->ret = 0;
Alexander Graf769ce762009-05-11 17:41:42 +0200274 s->acb[i] = NULL;
Paolo Bonzini28256d82017-05-15 12:00:58 +0200275 qemu_mutex_unlock(&s->s->mutex);
276 aio_co_wake(acb->co);
277 qemu_mutex_lock(&s->s->mutex);
Alexander Graf769ce762009-05-11 17:41:42 +0200278 }
279 }
280
Max Reitz4e767652016-10-25 04:54:29 +0200281read_end:
282 /* curl will error out if we do not return this value */
283 return size * nmemb;
Alexander Graf769ce762009-05-11 17:41:42 +0200284}
285
Paolo Bonzini456af342017-05-15 12:00:55 +0200286/* Called with s->mutex held. */
Paolo Bonzini28256d82017-05-15 12:00:58 +0200287static bool curl_find_buf(BDRVCURLState *s, uint64_t start, uint64_t len,
288 CURLAIOCB *acb)
Alexander Graf769ce762009-05-11 17:41:42 +0200289{
290 int i;
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200291 uint64_t end = start + len;
292 uint64_t clamped_end = MIN(end, s->len);
293 uint64_t clamped_len = clamped_end - start;
Alexander Graf769ce762009-05-11 17:41:42 +0200294
295 for (i=0; i<CURL_NUM_STATES; i++) {
296 CURLState *state = &s->states[i];
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200297 uint64_t buf_end = (state->buf_start + state->buf_off);
298 uint64_t buf_fend = (state->buf_start + state->buf_len);
Alexander Graf769ce762009-05-11 17:41:42 +0200299
300 if (!state->orig_buf)
301 continue;
302 if (!state->buf_off)
303 continue;
304
305 // Does the existing buffer cover our section?
306 if ((start >= state->buf_start) &&
307 (start <= buf_end) &&
Max Reitz4e504532016-10-25 04:54:31 +0200308 (clamped_end >= state->buf_start) &&
309 (clamped_end <= buf_end))
Alexander Graf769ce762009-05-11 17:41:42 +0200310 {
311 char *buf = state->orig_buf + (start - state->buf_start);
312
Max Reitz4e504532016-10-25 04:54:31 +0200313 qemu_iovec_from_buf(acb->qiov, 0, buf, clamped_len);
314 if (clamped_len < len) {
315 qemu_iovec_memset(acb->qiov, clamped_len, 0, len - clamped_len);
316 }
Paolo Bonzini28256d82017-05-15 12:00:58 +0200317 acb->ret = 0;
318 return true;
Alexander Graf769ce762009-05-11 17:41:42 +0200319 }
320
321 // Wait for unfinished chunks
Matthew Boothb7079df2014-04-29 16:03:32 +0100322 if (state->in_use &&
323 (start >= state->buf_start) &&
Alexander Graf769ce762009-05-11 17:41:42 +0200324 (start <= buf_fend) &&
Max Reitz4e504532016-10-25 04:54:31 +0200325 (clamped_end >= state->buf_start) &&
326 (clamped_end <= buf_fend))
Alexander Graf769ce762009-05-11 17:41:42 +0200327 {
328 int j;
329
330 acb->start = start - state->buf_start;
Max Reitz4e504532016-10-25 04:54:31 +0200331 acb->end = acb->start + clamped_len;
Alexander Graf769ce762009-05-11 17:41:42 +0200332
333 for (j=0; j<CURL_NUM_ACB; j++) {
334 if (!state->acb[j]) {
335 state->acb[j] = acb;
Paolo Bonzini28256d82017-05-15 12:00:58 +0200336 return true;
Alexander Graf769ce762009-05-11 17:41:42 +0200337 }
338 }
339 }
340 }
341
Paolo Bonzini28256d82017-05-15 12:00:58 +0200342 return false;
Alexander Graf769ce762009-05-11 17:41:42 +0200343}
344
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100345/* Called with s->mutex held. */
Matthew Booth838ef602014-04-29 16:03:30 +0100346static void curl_multi_check_completion(BDRVCURLState *s)
Alexander Graf769ce762009-05-11 17:41:42 +0200347{
Alexander Graf769ce762009-05-11 17:41:42 +0200348 int msgs_in_queue;
349
Alexander Graf769ce762009-05-11 17:41:42 +0200350 /* Try to find done transfers, so we can free the easy
351 * handle again. */
Matthew Booth1f2cead2014-04-29 16:03:31 +0100352 for (;;) {
Alexander Graf769ce762009-05-11 17:41:42 +0200353 CURLMsg *msg;
354 msg = curl_multi_info_read(s->multi, &msgs_in_queue);
355
Matthew Booth1f2cead2014-04-29 16:03:31 +0100356 /* Quit when there are no more completions */
Alexander Graf769ce762009-05-11 17:41:42 +0200357 if (!msg)
358 break;
Alexander Graf769ce762009-05-11 17:41:42 +0200359
Matthew Booth1f2cead2014-04-29 16:03:31 +0100360 if (msg->msg == CURLMSG_DONE) {
361 CURLState *state = NULL;
362 curl_easy_getinfo(msg->easy_handle, CURLINFO_PRIVATE,
363 (char **)&state);
Nicholas Thomasf785a5a2011-08-15 10:00:34 +0100364
Matthew Booth1f2cead2014-04-29 16:03:31 +0100365 /* ACBs for successful messages get completed in curl_read_cb */
366 if (msg->data.result != CURLE_OK) {
367 int i;
Richard W.M. Jones796a0602015-07-08 14:37:48 +0100368 static int errcount = 100;
369
370 /* Don't lose the original error message from curl, since
371 * it contains extra data.
372 */
373 if (errcount > 0) {
374 error_report("curl: %s", state->errmsg);
375 if (--errcount == 0) {
376 error_report("curl: further errors suppressed");
377 }
378 }
379
Matthew Booth1f2cead2014-04-29 16:03:31 +0100380 for (i = 0; i < CURL_NUM_ACB; i++) {
381 CURLAIOCB *acb = state->acb[i];
Nicholas Thomasf785a5a2011-08-15 10:00:34 +0100382
Matthew Booth1f2cead2014-04-29 16:03:31 +0100383 if (acb == NULL) {
384 continue;
Nicholas Thomasf785a5a2011-08-15 10:00:34 +0100385 }
Nicholas Thomasf785a5a2011-08-15 10:00:34 +0100386
Paolo Bonzini28256d82017-05-15 12:00:58 +0200387 acb->ret = -EIO;
Matthew Booth1f2cead2014-04-29 16:03:31 +0100388 state->acb[i] = NULL;
Paolo Bonzini28256d82017-05-15 12:00:58 +0200389 qemu_mutex_unlock(&s->mutex);
390 aio_co_wake(acb->co);
391 qemu_mutex_lock(&s->mutex);
Matthew Booth1f2cead2014-04-29 16:03:31 +0100392 }
Alexander Graf769ce762009-05-11 17:41:42 +0200393 }
Matthew Booth1f2cead2014-04-29 16:03:31 +0100394
395 curl_clean_state(state);
396 break;
Alexander Graf769ce762009-05-11 17:41:42 +0200397 }
Matthew Booth1f2cead2014-04-29 16:03:31 +0100398 }
Alexander Graf769ce762009-05-11 17:41:42 +0200399}
400
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100401/* Called with s->mutex held. */
Paolo Bonzini9d456652017-02-13 14:52:30 +0100402static void curl_multi_do_locked(CURLState *s)
Peter Maydell031fd1b2014-01-24 14:56:17 +0100403{
Max Reitzff5ca162016-10-25 04:54:30 +0200404 CURLSocket *socket, *next_socket;
Peter Maydell031fd1b2014-01-24 14:56:17 +0100405 int running;
406 int r;
407
Matthew Booth838ef602014-04-29 16:03:30 +0100408 if (!s->s->multi) {
Peter Maydell031fd1b2014-01-24 14:56:17 +0100409 return;
410 }
411
Max Reitzff5ca162016-10-25 04:54:30 +0200412 /* Need to use _SAFE because curl_multi_socket_action() may trigger
413 * curl_sock_cb() which might modify this list */
414 QLIST_FOREACH_SAFE(socket, &s->sockets, next, next_socket) {
415 do {
416 r = curl_multi_socket_action(s->s->multi, socket->fd, 0, &running);
417 } while (r == CURLM_CALL_MULTI_PERFORM);
418 }
Matthew Booth838ef602014-04-29 16:03:30 +0100419}
420
Paolo Bonzini9d456652017-02-13 14:52:30 +0100421static void curl_multi_do(void *arg)
422{
423 CURLState *s = (CURLState *)arg;
424
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100425 qemu_mutex_lock(&s->s->mutex);
Paolo Bonzini9d456652017-02-13 14:52:30 +0100426 curl_multi_do_locked(s);
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100427 qemu_mutex_unlock(&s->s->mutex);
Paolo Bonzini9d456652017-02-13 14:52:30 +0100428}
429
Matthew Booth838ef602014-04-29 16:03:30 +0100430static void curl_multi_read(void *arg)
431{
432 CURLState *s = (CURLState *)arg;
433
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100434 qemu_mutex_lock(&s->s->mutex);
Paolo Bonzini9d456652017-02-13 14:52:30 +0100435 curl_multi_do_locked(s);
Matthew Booth838ef602014-04-29 16:03:30 +0100436 curl_multi_check_completion(s->s);
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100437 qemu_mutex_unlock(&s->s->mutex);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100438}
439
440static void curl_multi_timeout_do(void *arg)
441{
442#ifdef NEED_CURL_TIMER_CALLBACK
443 BDRVCURLState *s = (BDRVCURLState *)arg;
444 int running;
445
446 if (!s->multi) {
447 return;
448 }
449
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100450 qemu_mutex_lock(&s->mutex);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100451 curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
452
Matthew Booth838ef602014-04-29 16:03:30 +0100453 curl_multi_check_completion(s);
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100454 qemu_mutex_unlock(&s->mutex);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100455#else
456 abort();
457#endif
458}
459
Paolo Bonzini456af342017-05-15 12:00:55 +0200460/* Called with s->mutex held. */
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200461static CURLState *curl_find_state(BDRVCURLState *s)
Alexander Graf769ce762009-05-11 17:41:42 +0200462{
463 CURLState *state = NULL;
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200464 int i;
Alexander Graf769ce762009-05-11 17:41:42 +0200465
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200466 for (i = 0; i < CURL_NUM_STATES; i++) {
467 if (!s->states[i].in_use) {
Alexander Graf769ce762009-05-11 17:41:42 +0200468 state = &s->states[i];
469 state->in_use = 1;
470 break;
471 }
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200472 }
473 return state;
474}
Alexander Graf769ce762009-05-11 17:41:42 +0200475
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200476static int curl_init_state(BDRVCURLState *s, CURLState *state)
477{
Matthew Booth9e550b32014-04-29 16:03:26 +0100478 if (!state->curl) {
479 state->curl = curl_easy_init();
480 if (!state->curl) {
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200481 return -EIO;
Matthew Booth9e550b32014-04-29 16:03:26 +0100482 }
483 curl_easy_setopt(state->curl, CURLOPT_URL, s->url);
Matthew Booth97a3ea52014-05-14 19:28:42 -0400484 curl_easy_setopt(state->curl, CURLOPT_SSL_VERIFYPEER,
485 (long) s->sslverify);
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100486 if (s->cookie) {
487 curl_easy_setopt(state->curl, CURLOPT_COOKIE, s->cookie);
488 }
Richard W.M. Jonesf76faed2014-10-26 11:05:27 +0000489 curl_easy_setopt(state->curl, CURLOPT_TIMEOUT, (long)s->timeout);
Matthew Booth9e550b32014-04-29 16:03:26 +0100490 curl_easy_setopt(state->curl, CURLOPT_WRITEFUNCTION,
491 (void *)curl_read_cb);
492 curl_easy_setopt(state->curl, CURLOPT_WRITEDATA, (void *)state);
493 curl_easy_setopt(state->curl, CURLOPT_PRIVATE, (void *)state);
494 curl_easy_setopt(state->curl, CURLOPT_AUTOREFERER, 1);
495 curl_easy_setopt(state->curl, CURLOPT_FOLLOWLOCATION, 1);
496 curl_easy_setopt(state->curl, CURLOPT_NOSIGNAL, 1);
497 curl_easy_setopt(state->curl, CURLOPT_ERRORBUFFER, state->errmsg);
498 curl_easy_setopt(state->curl, CURLOPT_FAILONERROR, 1);
Alexander Graf769ce762009-05-11 17:41:42 +0200499
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000500 if (s->username) {
501 curl_easy_setopt(state->curl, CURLOPT_USERNAME, s->username);
502 }
503 if (s->password) {
504 curl_easy_setopt(state->curl, CURLOPT_PASSWORD, s->password);
505 }
506 if (s->proxyusername) {
507 curl_easy_setopt(state->curl,
508 CURLOPT_PROXYUSERNAME, s->proxyusername);
509 }
510 if (s->proxypassword) {
511 curl_easy_setopt(state->curl,
512 CURLOPT_PROXYPASSWORD, s->proxypassword);
513 }
514
Matthew Booth9e550b32014-04-29 16:03:26 +0100515 /* Restrict supported protocols to avoid security issues in the more
516 * obscure protocols. For example, do not allow POP3/SMTP/IMAP see
517 * CVE-2013-0249.
518 *
519 * Restricting protocols is only supported from 7.19.4 upwards.
520 */
Stefan Hajnoczi8a8f5842013-02-13 09:25:34 +0100521#if LIBCURL_VERSION_NUM >= 0x071304
Matthew Booth9e550b32014-04-29 16:03:26 +0100522 curl_easy_setopt(state->curl, CURLOPT_PROTOCOLS, PROTOCOLS);
523 curl_easy_setopt(state->curl, CURLOPT_REDIR_PROTOCOLS, PROTOCOLS);
Stefan Hajnoczi8a8f5842013-02-13 09:25:34 +0100524#endif
Stefan Hajnoczifb6d1bb2013-02-08 08:49:10 +0100525
Alexander Graf769ce762009-05-11 17:41:42 +0200526#ifdef DEBUG_VERBOSE
Matthew Booth9e550b32014-04-29 16:03:26 +0100527 curl_easy_setopt(state->curl, CURLOPT_VERBOSE, 1);
Alexander Graf769ce762009-05-11 17:41:42 +0200528#endif
Matthew Booth9e550b32014-04-29 16:03:26 +0100529 }
Alexander Graf769ce762009-05-11 17:41:42 +0200530
Max Reitzff5ca162016-10-25 04:54:30 +0200531 QLIST_INIT(&state->sockets);
Alexander Graf769ce762009-05-11 17:41:42 +0200532 state->s = s;
533
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200534 return 0;
Alexander Graf769ce762009-05-11 17:41:42 +0200535}
536
Paolo Bonzini456af342017-05-15 12:00:55 +0200537/* Called with s->mutex held. */
Alexander Graf769ce762009-05-11 17:41:42 +0200538static void curl_clean_state(CURLState *s)
539{
Paolo Bonzini675a7752017-05-15 12:00:53 +0200540 int j;
541 for (j = 0; j < CURL_NUM_ACB; j++) {
542 assert(!s->acb[j]);
543 }
544
Alexander Graf769ce762009-05-11 17:41:42 +0200545 if (s->s->multi)
546 curl_multi_remove_handle(s->s->multi, s->curl);
Max Reitzff5ca162016-10-25 04:54:30 +0200547
548 while (!QLIST_EMPTY(&s->sockets)) {
549 CURLSocket *socket = QLIST_FIRST(&s->sockets);
550
551 QLIST_REMOVE(socket, next);
552 g_free(socket);
553 }
554
Alexander Graf769ce762009-05-11 17:41:42 +0200555 s->in_use = 0;
Paolo Bonzini2bb5c932017-05-15 12:00:59 +0200556
Paolo Bonzini709f2132018-02-03 10:39:35 -0500557 qemu_co_enter_next(&s->s->free_state_waitq, &s->s->mutex);
Alexander Graf769ce762009-05-11 17:41:42 +0200558}
559
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200560static void curl_parse_filename(const char *filename, QDict *options,
561 Error **errp)
Alexander Graf769ce762009-05-11 17:41:42 +0200562{
Eric Blake46f5ac22017-04-27 16:58:17 -0500563 qdict_put_str(options, CURL_BLOCK_OPT_URL, filename);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200564}
565
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200566static void curl_detach_aio_context(BlockDriverState *bs)
567{
568 BDRVCURLState *s = bs->opaque;
569 int i;
570
Paolo Bonzini456af342017-05-15 12:00:55 +0200571 qemu_mutex_lock(&s->mutex);
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200572 for (i = 0; i < CURL_NUM_STATES; i++) {
573 if (s->states[i].in_use) {
574 curl_clean_state(&s->states[i]);
575 }
576 if (s->states[i].curl) {
577 curl_easy_cleanup(s->states[i].curl);
578 s->states[i].curl = NULL;
579 }
Markus Armbrusterf7047c22014-06-06 18:25:12 +0200580 g_free(s->states[i].orig_buf);
581 s->states[i].orig_buf = NULL;
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200582 }
583 if (s->multi) {
584 curl_multi_cleanup(s->multi);
585 s->multi = NULL;
586 }
Paolo Bonzini456af342017-05-15 12:00:55 +0200587 qemu_mutex_unlock(&s->mutex);
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200588
589 timer_del(&s->timer);
590}
591
592static void curl_attach_aio_context(BlockDriverState *bs,
593 AioContext *new_context)
594{
595 BDRVCURLState *s = bs->opaque;
596
597 aio_timer_init(new_context, &s->timer,
598 QEMU_CLOCK_REALTIME, SCALE_NS,
599 curl_multi_timeout_do, s);
600
601 assert(!s->multi);
602 s->multi = curl_multi_init();
603 s->aio_context = new_context;
604 curl_multi_setopt(s->multi, CURLMOPT_SOCKETFUNCTION, curl_sock_cb);
605#ifdef NEED_CURL_TIMER_CALLBACK
606 curl_multi_setopt(s->multi, CURLMOPT_TIMERDATA, s);
607 curl_multi_setopt(s->multi, CURLMOPT_TIMERFUNCTION, curl_timer_cb);
608#endif
609}
610
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200611static QemuOptsList runtime_opts = {
612 .name = "curl",
613 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
614 .desc = {
615 {
Matthew Boothe3542c62014-05-14 19:28:41 -0400616 .name = CURL_BLOCK_OPT_URL,
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200617 .type = QEMU_OPT_STRING,
618 .help = "URL to open",
619 },
620 {
Matthew Boothe3542c62014-05-14 19:28:41 -0400621 .name = CURL_BLOCK_OPT_READAHEAD,
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200622 .type = QEMU_OPT_SIZE,
623 .help = "Readahead size",
624 },
Matthew Booth97a3ea52014-05-14 19:28:42 -0400625 {
626 .name = CURL_BLOCK_OPT_SSLVERIFY,
627 .type = QEMU_OPT_BOOL,
628 .help = "Verify SSL certificate"
629 },
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -0300630 {
631 .name = CURL_BLOCK_OPT_TIMEOUT,
632 .type = QEMU_OPT_NUMBER,
633 .help = "Curl timeout"
634 },
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100635 {
636 .name = CURL_BLOCK_OPT_COOKIE,
637 .type = QEMU_OPT_STRING,
638 .help = "Pass the cookie or list of cookies with each request"
639 },
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000640 {
Peter Krempa327c8eb2017-05-04 16:00:06 +0200641 .name = CURL_BLOCK_OPT_COOKIE_SECRET,
642 .type = QEMU_OPT_STRING,
643 .help = "ID of secret used as cookie passed with each request"
644 },
645 {
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000646 .name = CURL_BLOCK_OPT_USERNAME,
647 .type = QEMU_OPT_STRING,
648 .help = "Username for HTTP auth"
649 },
650 {
651 .name = CURL_BLOCK_OPT_PASSWORD_SECRET,
652 .type = QEMU_OPT_STRING,
653 .help = "ID of secret used as password for HTTP auth",
654 },
655 {
656 .name = CURL_BLOCK_OPT_PROXY_USERNAME,
657 .type = QEMU_OPT_STRING,
658 .help = "Username for HTTP proxy auth"
659 },
660 {
661 .name = CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET,
662 .type = QEMU_OPT_STRING,
663 .help = "ID of secret used as password for HTTP proxy auth",
664 },
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200665 { /* end of list */ }
666 },
667};
668
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000669
Max Reitz015a1032013-09-05 14:22:29 +0200670static int curl_open(BlockDriverState *bs, QDict *options, int flags,
671 Error **errp)
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200672{
673 BDRVCURLState *s = bs->opaque;
674 CURLState *state = NULL;
675 QemuOpts *opts;
676 Error *local_err = NULL;
677 const char *file;
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100678 const char *cookie;
Peter Krempa327c8eb2017-05-04 16:00:06 +0200679 const char *cookie_secret;
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200680 double d;
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000681 const char *secretid;
Max Reitz34634ca2017-03-31 14:04:31 +0200682 const char *protocol_delimiter;
Jeff Cody2d259642017-11-07 17:27:22 -0500683 int ret;
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200684
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200685
Richard W.M. Jonesa7cea2b2013-06-10 12:38:43 +0100686 if (flags & BDRV_O_RDWR) {
Paolo Bonzini2a94fee2014-02-17 14:43:57 +0100687 error_setg(errp, "curl block device does not support writes");
Richard W.M. Jonesa7cea2b2013-06-10 12:38:43 +0100688 return -EROFS;
689 }
690
Jeff Cody2d259642017-11-07 17:27:22 -0500691 if (!libcurl_initialized) {
692 ret = curl_global_init(CURL_GLOBAL_ALL);
693 if (ret) {
694 error_setg(errp, "libcurl initialization failed with %d", ret);
695 return -EIO;
696 }
697 libcurl_initialized = true;
698 }
699
Paolo Bonzini456af342017-05-15 12:00:55 +0200700 qemu_mutex_init(&s->mutex);
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800701 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200702 qemu_opts_absorb_qdict(opts, options, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100703 if (local_err) {
Paolo Bonzini2a94fee2014-02-17 14:43:57 +0100704 error_propagate(errp, local_err);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200705 goto out_noclean;
706 }
707
Matthew Boothe3542c62014-05-14 19:28:41 -0400708 s->readahead_size = qemu_opt_get_size(opts, CURL_BLOCK_OPT_READAHEAD,
709 READ_AHEAD_DEFAULT);
Nolanc76f4952009-07-01 17:16:52 -0700710 if ((s->readahead_size & 0x1ff) != 0) {
Paolo Bonzini2a94fee2014-02-17 14:43:57 +0100711 error_setg(errp, "HTTP_READAHEAD_SIZE %zd is not a multiple of 512",
712 s->readahead_size);
Nolanc76f4952009-07-01 17:16:52 -0700713 goto out_noclean;
714 }
715
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -0300716 s->timeout = qemu_opt_get_number(opts, CURL_BLOCK_OPT_TIMEOUT,
717 CURL_TIMEOUT_DEFAULT);
Richard W.M. Jonesf76faed2014-10-26 11:05:27 +0000718 if (s->timeout > CURL_TIMEOUT_MAX) {
719 error_setg(errp, "timeout parameter is too large or negative");
720 goto out_noclean;
721 }
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -0300722
Matthew Booth97a3ea52014-05-14 19:28:42 -0400723 s->sslverify = qemu_opt_get_bool(opts, CURL_BLOCK_OPT_SSLVERIFY, true);
724
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100725 cookie = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE);
Peter Krempa327c8eb2017-05-04 16:00:06 +0200726 cookie_secret = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE_SECRET);
727
728 if (cookie && cookie_secret) {
729 error_setg(errp,
730 "curl driver cannot handle both cookie and cookie secret");
731 goto out_noclean;
732 }
733
734 if (cookie_secret) {
735 s->cookie = qcrypto_secret_lookup_as_utf8(cookie_secret, errp);
736 if (!s->cookie) {
737 goto out_noclean;
738 }
739 } else {
740 s->cookie = g_strdup(cookie);
741 }
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100742
Matthew Boothe3542c62014-05-14 19:28:41 -0400743 file = qemu_opt_get(opts, CURL_BLOCK_OPT_URL);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200744 if (file == NULL) {
Paolo Bonzini2a94fee2014-02-17 14:43:57 +0100745 error_setg(errp, "curl block driver requires an 'url' option");
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200746 goto out_noclean;
747 }
748
Max Reitz34634ca2017-03-31 14:04:31 +0200749 if (!strstart(file, bs->drv->protocol_name, &protocol_delimiter) ||
750 !strstart(protocol_delimiter, "://", NULL))
751 {
752 error_setg(errp, "%s curl driver cannot handle the URL '%s' (does not "
753 "start with '%s://')", bs->drv->protocol_name, file,
754 bs->drv->protocol_name);
755 goto out_noclean;
756 }
757
Daniel P. Berrange1bff9602016-01-21 14:19:20 +0000758 s->username = g_strdup(qemu_opt_get(opts, CURL_BLOCK_OPT_USERNAME));
759 secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PASSWORD_SECRET);
760
761 if (secretid) {
762 s->password = qcrypto_secret_lookup_as_utf8(secretid, errp);
763 if (!s->password) {
764 goto out_noclean;
765 }
766 }
767
768 s->proxyusername = g_strdup(
769 qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_USERNAME));
770 secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET);
771 if (secretid) {
772 s->proxypassword = qcrypto_secret_lookup_as_utf8(secretid, errp);
773 if (!s->proxypassword) {
774 goto out_noclean;
775 }
776 }
777
malcd0f2c4c2010-02-07 02:03:50 +0300778 DPRINTF("CURL: Opening %s\n", file);
Paolo Bonzini709f2132018-02-03 10:39:35 -0500779 qemu_co_queue_init(&s->free_state_waitq);
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200780 s->aio_context = bdrv_get_aio_context(bs);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200781 s->url = g_strdup(file);
Paolo Bonzini456af342017-05-15 12:00:55 +0200782 qemu_mutex_lock(&s->mutex);
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200783 state = curl_find_state(s);
Paolo Bonzini456af342017-05-15 12:00:55 +0200784 qemu_mutex_unlock(&s->mutex);
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200785 if (!state) {
Alexander Graf769ce762009-05-11 17:41:42 +0200786 goto out_noclean;
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200787 }
Alexander Graf769ce762009-05-11 17:41:42 +0200788
789 // Get file size
790
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200791 if (curl_init_state(s, state) < 0) {
792 goto out;
793 }
794
Fam Zheng3494d652013-07-02 15:19:21 +0800795 s->accept_range = false;
Alexander Graf769ce762009-05-11 17:41:42 +0200796 curl_easy_setopt(state->curl, CURLOPT_NOBODY, 1);
Fam Zheng3494d652013-07-02 15:19:21 +0800797 curl_easy_setopt(state->curl, CURLOPT_HEADERFUNCTION,
798 curl_header_cb);
799 curl_easy_setopt(state->curl, CURLOPT_HEADERDATA, s);
Alexander Graf769ce762009-05-11 17:41:42 +0200800 if (curl_easy_perform(state->curl))
801 goto out;
Tomáš Golembiovskýa41c4572016-07-08 13:18:09 +0200802 if (curl_easy_getinfo(state->curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &d)) {
Alexander Graf769ce762009-05-11 17:41:42 +0200803 goto out;
Tomáš Golembiovskýa41c4572016-07-08 13:18:09 +0200804 }
805 /* Prior CURL 7.19.4 return value of 0 could mean that the file size is not
806 * know or the size is zero. From 7.19.4 CURL returns -1 if size is not
807 * known and zero if it is realy zero-length file. */
808#if LIBCURL_VERSION_NUM >= 0x071304
809 if (d < 0) {
810 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
811 "Server didn't report file size.");
812 goto out;
813 }
814#else
815 if (d <= 0) {
816 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
817 "Unknown file size or zero-length file.");
818 goto out;
819 }
820#endif
821
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200822 s->len = d;
Tomáš Golembiovskýa41c4572016-07-08 13:18:09 +0200823
Fam Zheng3494d652013-07-02 15:19:21 +0800824 if ((!strncasecmp(s->url, "http://", strlen("http://"))
825 || !strncasecmp(s->url, "https://", strlen("https://")))
826 && !s->accept_range) {
827 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
828 "Server does not support 'range' (byte ranges).");
829 goto out;
830 }
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200831 DPRINTF("CURL: Size = %" PRIu64 "\n", s->len);
Alexander Graf769ce762009-05-11 17:41:42 +0200832
Paolo Bonzini456af342017-05-15 12:00:55 +0200833 qemu_mutex_lock(&s->mutex);
Alexander Graf769ce762009-05-11 17:41:42 +0200834 curl_clean_state(state);
Paolo Bonzini456af342017-05-15 12:00:55 +0200835 qemu_mutex_unlock(&s->mutex);
Alexander Graf769ce762009-05-11 17:41:42 +0200836 curl_easy_cleanup(state->curl);
837 state->curl = NULL;
838
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200839 curl_attach_aio_context(bs, bdrv_get_aio_context(bs));
Alexander Graf769ce762009-05-11 17:41:42 +0200840
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200841 qemu_opts_del(opts);
Alexander Graf769ce762009-05-11 17:41:42 +0200842 return 0;
843
844out:
Maria Kustovaacd7fdc2014-03-18 09:59:18 +0400845 error_setg(errp, "CURL: Error opening file: %s", state->errmsg);
Alexander Graf769ce762009-05-11 17:41:42 +0200846 curl_easy_cleanup(state->curl);
847 state->curl = NULL;
848out_noclean:
Paolo Bonzini456af342017-05-15 12:00:55 +0200849 qemu_mutex_destroy(&s->mutex);
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100850 g_free(s->cookie);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200851 g_free(s->url);
Jeff Cody996922d2017-11-07 17:27:23 -0500852 g_free(s->username);
853 g_free(s->proxyusername);
854 g_free(s->proxypassword);
Kevin Wolf8e6d58c2013-04-10 15:31:33 +0200855 qemu_opts_del(opts);
Alexander Graf769ce762009-05-11 17:41:42 +0200856 return -EINVAL;
857}
858
Paolo Bonzini28256d82017-05-15 12:00:58 +0200859static void curl_setup_preadv(BlockDriverState *bs, CURLAIOCB *acb)
Alexander Graf769ce762009-05-11 17:41:42 +0200860{
Alexander Graf769ce762009-05-11 17:41:42 +0200861 CURLState *state;
Matthew Boothb69cdef2014-04-29 16:03:29 +0100862 int running;
Alexander Graf769ce762009-05-11 17:41:42 +0200863
Paolo Bonzini19196312017-02-13 14:52:31 +0100864 BDRVCURLState *s = bs->opaque;
Alexander Graf769ce762009-05-11 17:41:42 +0200865
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200866 uint64_t start = acb->offset;
867 uint64_t end;
Alexander Graf769ce762009-05-11 17:41:42 +0200868
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100869 qemu_mutex_lock(&s->mutex);
Paolo Bonzini19196312017-02-13 14:52:31 +0100870
Alexander Graf769ce762009-05-11 17:41:42 +0200871 // In case we have the requested data already (e.g. read-ahead),
872 // we can just call the callback and be done.
Paolo Bonzini28256d82017-05-15 12:00:58 +0200873 if (curl_find_buf(s, start, acb->bytes, acb)) {
874 goto out;
Alexander Graf769ce762009-05-11 17:41:42 +0200875 }
876
877 // No cache found, so let's start a new request
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200878 for (;;) {
879 state = curl_find_state(s);
880 if (state) {
881 break;
882 }
Paolo Bonzini709f2132018-02-03 10:39:35 -0500883 qemu_co_queue_wait(&s->free_state_waitq, &s->mutex);
Paolo Bonzini3ce6a722017-05-15 12:00:56 +0200884 }
885
886 if (curl_init_state(s, state) < 0) {
887 curl_clean_state(state);
Paolo Bonzini28256d82017-05-15 12:00:58 +0200888 acb->ret = -EIO;
Paolo Bonzini19196312017-02-13 14:52:31 +0100889 goto out;
Nick Thomas363c3c82011-09-21 11:55:50 +0100890 }
Alexander Graf769ce762009-05-11 17:41:42 +0200891
892 acb->start = 0;
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200893 acb->end = MIN(acb->bytes, s->len - start);
Alexander Graf769ce762009-05-11 17:41:42 +0200894
895 state->buf_off = 0;
Markus Armbrusterf7047c22014-06-06 18:25:12 +0200896 g_free(state->orig_buf);
Alexander Graf769ce762009-05-11 17:41:42 +0200897 state->buf_start = start;
Max Reitz4e504532016-10-25 04:54:31 +0200898 state->buf_len = MIN(acb->end + s->readahead_size, s->len - start);
899 end = start + state->buf_len - 1;
Kevin Wolf8dc7a772014-05-20 13:26:40 +0200900 state->orig_buf = g_try_malloc(state->buf_len);
901 if (state->buf_len && state->orig_buf == NULL) {
902 curl_clean_state(state);
Paolo Bonzini28256d82017-05-15 12:00:58 +0200903 acb->ret = -ENOMEM;
Paolo Bonzini19196312017-02-13 14:52:31 +0100904 goto out;
Kevin Wolf8dc7a772014-05-20 13:26:40 +0200905 }
Alexander Graf769ce762009-05-11 17:41:42 +0200906 state->acb[0] = acb;
907
Paolo Bonzini2125e5e2017-05-15 12:00:57 +0200908 snprintf(state->range, 127, "%" PRIu64 "-%" PRIu64, start, end);
909 DPRINTF("CURL (AIO): Reading %" PRIu64 " at %" PRIu64 " (%s)\n",
910 acb->bytes, start, state->range);
Alexander Graf769ce762009-05-11 17:41:42 +0200911 curl_easy_setopt(state->curl, CURLOPT_RANGE, state->range);
912
913 curl_multi_add_handle(s->multi, state->curl);
Alexander Graf769ce762009-05-11 17:41:42 +0200914
Matthew Boothb69cdef2014-04-29 16:03:29 +0100915 /* Tell curl it needs to kick things off */
916 curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
Paolo Bonzini19196312017-02-13 14:52:31 +0100917
918out:
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100919 qemu_mutex_unlock(&s->mutex);
Nick Thomas363c3c82011-09-21 11:55:50 +0100920}
921
Paolo Bonzini28256d82017-05-15 12:00:58 +0200922static int coroutine_fn curl_co_preadv(BlockDriverState *bs,
923 uint64_t offset, uint64_t bytes, QEMUIOVector *qiov, int flags)
Nick Thomas363c3c82011-09-21 11:55:50 +0100924{
Paolo Bonzini28256d82017-05-15 12:00:58 +0200925 CURLAIOCB acb = {
926 .co = qemu_coroutine_self(),
927 .ret = -EINPROGRESS,
928 .qiov = qiov,
929 .offset = offset,
930 .bytes = bytes
931 };
Nick Thomas363c3c82011-09-21 11:55:50 +0100932
Paolo Bonzini28256d82017-05-15 12:00:58 +0200933 curl_setup_preadv(bs, &acb);
934 while (acb.ret == -EINPROGRESS) {
935 qemu_coroutine_yield();
936 }
937 return acb.ret;
Alexander Graf769ce762009-05-11 17:41:42 +0200938}
939
Alexander Graf769ce762009-05-11 17:41:42 +0200940static void curl_close(BlockDriverState *bs)
941{
942 BDRVCURLState *s = bs->opaque;
Alexander Graf769ce762009-05-11 17:41:42 +0200943
malcd0f2c4c2010-02-07 02:03:50 +0300944 DPRINTF("CURL: Close\n");
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200945 curl_detach_aio_context(bs);
Paolo Bonziniba3186c2017-02-22 19:07:23 +0100946 qemu_mutex_destroy(&s->mutex);
Peter Maydell031fd1b2014-01-24 14:56:17 +0100947
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +0100948 g_free(s->cookie);
Stefan Weil45724d62012-09-01 11:06:45 +0200949 g_free(s->url);
Jeff Cody996922d2017-11-07 17:27:23 -0500950 g_free(s->username);
951 g_free(s->proxyusername);
952 g_free(s->proxypassword);
Alexander Graf769ce762009-05-11 17:41:42 +0200953}
954
955static int64_t curl_getlength(BlockDriverState *bs)
956{
957 BDRVCURLState *s = bs->opaque;
958 return s->len;
959}
960
961static BlockDriver bdrv_http = {
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200962 .format_name = "http",
963 .protocol_name = "http",
Alexander Graf769ce762009-05-11 17:41:42 +0200964
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200965 .instance_size = sizeof(BDRVCURLState),
966 .bdrv_parse_filename = curl_parse_filename,
967 .bdrv_file_open = curl_open,
968 .bdrv_close = curl_close,
969 .bdrv_getlength = curl_getlength,
Alexander Graf769ce762009-05-11 17:41:42 +0200970
Paolo Bonzini28256d82017-05-15 12:00:58 +0200971 .bdrv_co_preadv = curl_co_preadv,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200972
973 .bdrv_detach_aio_context = curl_detach_aio_context,
974 .bdrv_attach_aio_context = curl_attach_aio_context,
Alexander Graf769ce762009-05-11 17:41:42 +0200975};
976
977static BlockDriver bdrv_https = {
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200978 .format_name = "https",
979 .protocol_name = "https",
Alexander Graf769ce762009-05-11 17:41:42 +0200980
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200981 .instance_size = sizeof(BDRVCURLState),
982 .bdrv_parse_filename = curl_parse_filename,
983 .bdrv_file_open = curl_open,
984 .bdrv_close = curl_close,
985 .bdrv_getlength = curl_getlength,
Alexander Graf769ce762009-05-11 17:41:42 +0200986
Paolo Bonzini28256d82017-05-15 12:00:58 +0200987 .bdrv_co_preadv = curl_co_preadv,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200988
989 .bdrv_detach_aio_context = curl_detach_aio_context,
990 .bdrv_attach_aio_context = curl_attach_aio_context,
Alexander Graf769ce762009-05-11 17:41:42 +0200991};
992
993static BlockDriver bdrv_ftp = {
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200994 .format_name = "ftp",
995 .protocol_name = "ftp",
Alexander Graf769ce762009-05-11 17:41:42 +0200996
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +0200997 .instance_size = sizeof(BDRVCURLState),
998 .bdrv_parse_filename = curl_parse_filename,
999 .bdrv_file_open = curl_open,
1000 .bdrv_close = curl_close,
1001 .bdrv_getlength = curl_getlength,
Alexander Graf769ce762009-05-11 17:41:42 +02001002
Paolo Bonzini28256d82017-05-15 12:00:58 +02001003 .bdrv_co_preadv = curl_co_preadv,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001004
1005 .bdrv_detach_aio_context = curl_detach_aio_context,
1006 .bdrv_attach_aio_context = curl_attach_aio_context,
Alexander Graf769ce762009-05-11 17:41:42 +02001007};
1008
1009static BlockDriver bdrv_ftps = {
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001010 .format_name = "ftps",
1011 .protocol_name = "ftps",
Alexander Graf769ce762009-05-11 17:41:42 +02001012
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001013 .instance_size = sizeof(BDRVCURLState),
1014 .bdrv_parse_filename = curl_parse_filename,
1015 .bdrv_file_open = curl_open,
1016 .bdrv_close = curl_close,
1017 .bdrv_getlength = curl_getlength,
Alexander Graf769ce762009-05-11 17:41:42 +02001018
Paolo Bonzini28256d82017-05-15 12:00:58 +02001019 .bdrv_co_preadv = curl_co_preadv,
Stefan Hajnoczi63f0f452014-05-08 16:34:40 +02001020
1021 .bdrv_detach_aio_context = curl_detach_aio_context,
1022 .bdrv_attach_aio_context = curl_attach_aio_context,
Alexander Graf769ce762009-05-11 17:41:42 +02001023};
1024
Alexander Graf769ce762009-05-11 17:41:42 +02001025static void curl_block_init(void)
1026{
1027 bdrv_register(&bdrv_http);
1028 bdrv_register(&bdrv_https);
1029 bdrv_register(&bdrv_ftp);
1030 bdrv_register(&bdrv_ftps);
Alexander Graf769ce762009-05-11 17:41:42 +02001031}
1032
1033block_init(curl_block_init);