2 * QEMU Block driver for CURL images
4 * Copyright (c) 2009 Alexander Graf <agraf@suse.de>
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
25 #include "qemu/osdep.h"
26 #include "qapi/error.h"
27 #include "qemu/error-report.h"
28 #include "qemu/module.h"
29 #include "qemu/option.h"
30 #include "block/block-io.h"
31 #include "block/block_int.h"
32 #include "qapi/qmp/qdict.h"
33 #include "qapi/qmp/qstring.h"
34 #include "crypto/secret.h"
35 #include <curl/curl.h>
36 #include "qemu/cutils.h"
39 // #define DEBUG_VERBOSE
41 /* CURL 7.85.0 switches to a string based API for specifying
42 * the desired protocols.
44 #if LIBCURL_VERSION_NUM >= 0x075500
45 #define PROTOCOLS "HTTP,HTTPS,FTP,FTPS"
47 #define PROTOCOLS (CURLPROTO_HTTP | CURLPROTO_HTTPS | \
48 CURLPROTO_FTP | CURLPROTO_FTPS)
51 #define CURL_NUM_STATES 8
52 #define CURL_NUM_ACB 8
53 #define CURL_TIMEOUT_MAX 10000
55 #define CURL_BLOCK_OPT_URL "url"
56 #define CURL_BLOCK_OPT_READAHEAD "readahead"
57 #define CURL_BLOCK_OPT_SSLVERIFY "sslverify"
58 #define CURL_BLOCK_OPT_TIMEOUT "timeout"
59 #define CURL_BLOCK_OPT_COOKIE "cookie"
60 #define CURL_BLOCK_OPT_COOKIE_SECRET "cookie-secret"
61 #define CURL_BLOCK_OPT_USERNAME "username"
62 #define CURL_BLOCK_OPT_PASSWORD_SECRET "password-secret"
63 #define CURL_BLOCK_OPT_PROXY_USERNAME "proxy-username"
64 #define CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET "proxy-password-secret"
66 #define CURL_BLOCK_OPT_READAHEAD_DEFAULT (256 * 1024)
67 #define CURL_BLOCK_OPT_SSLVERIFY_DEFAULT true
68 #define CURL_BLOCK_OPT_TIMEOUT_DEFAULT 5
73 static bool libcurl_initialized;
75 typedef struct CURLAIOCB {
87 typedef struct CURLSocket {
89 struct BDRVCURLState *s;
92 typedef struct CURLState
94 struct BDRVCURLState *s;
95 CURLAIOCB *acb[CURL_NUM_ACB];
102 char errmsg[CURL_ERROR_SIZE];
106 typedef struct BDRVCURLState {
110 CURLState states[CURL_NUM_STATES];
111 GHashTable *sockets; /* GINT_TO_POINTER(fd) -> socket */
113 size_t readahead_size;
118 AioContext *aio_context;
120 CoQueue free_state_waitq;
127 static void curl_clean_state(CURLState *s);
128 static void curl_multi_do(void *arg);
130 static gboolean curl_drop_socket(void *key, void *value, void *opaque)
132 CURLSocket *socket = value;
133 BDRVCURLState *s = socket->s;
135 aio_set_fd_handler(s->aio_context, socket->fd,
136 NULL, NULL, NULL, NULL, NULL);
140 static void curl_drop_all_sockets(GHashTable *sockets)
142 g_hash_table_foreach_remove(sockets, curl_drop_socket, NULL);
145 /* Called from curl_multi_do_locked, with s->mutex held. */
146 static int curl_timer_cb(CURLM *multi, long timeout_ms, void *opaque)
148 BDRVCURLState *s = opaque;
150 trace_curl_timer_cb(timeout_ms);
151 if (timeout_ms == -1) {
152 timer_del(&s->timer);
154 int64_t timeout_ns = (int64_t)timeout_ms * 1000 * 1000;
156 qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + timeout_ns);
161 /* Called from curl_multi_do_locked, with s->mutex held. */
162 static int curl_sock_cb(CURL *curl, curl_socket_t fd, int action,
163 void *userp, void *sp)
166 CURLState *state = NULL;
169 curl_easy_getinfo(curl, CURLINFO_PRIVATE, (char **)&state);
172 socket = g_hash_table_lookup(s->sockets, GINT_TO_POINTER(fd));
174 socket = g_new0(CURLSocket, 1);
177 g_hash_table_insert(s->sockets, GINT_TO_POINTER(fd), socket);
180 trace_curl_sock_cb(action, (int)fd);
183 aio_set_fd_handler(s->aio_context, fd,
184 curl_multi_do, NULL, NULL, NULL, socket);
187 aio_set_fd_handler(s->aio_context, fd,
188 NULL, curl_multi_do, NULL, NULL, socket);
190 case CURL_POLL_INOUT:
191 aio_set_fd_handler(s->aio_context, fd,
192 curl_multi_do, curl_multi_do,
195 case CURL_POLL_REMOVE:
196 aio_set_fd_handler(s->aio_context, fd,
197 NULL, NULL, NULL, NULL, NULL);
201 if (action == CURL_POLL_REMOVE) {
202 g_hash_table_remove(s->sockets, GINT_TO_POINTER(fd));
208 /* Called from curl_multi_do_locked, with s->mutex held. */
209 static size_t curl_header_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
211 BDRVCURLState *s = opaque;
212 size_t realsize = size * nmemb;
213 const char *header = (char *)ptr;
214 const char *end = header + realsize;
215 const char *accept_ranges = "accept-ranges:";
216 const char *bytes = "bytes";
218 if (realsize >= strlen(accept_ranges)
219 && g_ascii_strncasecmp(header, accept_ranges,
220 strlen(accept_ranges)) == 0) {
222 char *p = strchr(header, ':') + 1;
224 /* Skip whitespace between the header name and value. */
225 while (p < end && *p && g_ascii_isspace(*p)) {
229 if (end - p >= strlen(bytes)
230 && strncmp(p, bytes, strlen(bytes)) == 0) {
232 /* Check that there is nothing but whitespace after the value. */
234 while (p < end && *p && g_ascii_isspace(*p)) {
238 if (p == end || !*p) {
239 s->accept_range = true;
247 /* Called from curl_multi_do_locked, with s->mutex held. */
248 static size_t curl_read_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
250 CURLState *s = ((CURLState*)opaque);
251 size_t realsize = size * nmemb;
253 trace_curl_read_cb(realsize);
255 if (!s || !s->orig_buf) {
259 if (s->buf_off >= s->buf_len) {
260 /* buffer full, read nothing */
263 realsize = MIN(realsize, s->buf_len - s->buf_off);
264 memcpy(s->orig_buf + s->buf_off, ptr, realsize);
265 s->buf_off += realsize;
268 /* curl will error out if we do not return this value */
272 /* Called with s->mutex held. */
273 static bool curl_find_buf(BDRVCURLState *s, uint64_t start, uint64_t len,
277 uint64_t end = start + len;
278 uint64_t clamped_end = MIN(end, s->len);
279 uint64_t clamped_len = clamped_end - start;
281 for (i=0; i<CURL_NUM_STATES; i++) {
282 CURLState *state = &s->states[i];
283 uint64_t buf_end = (state->buf_start + state->buf_off);
284 uint64_t buf_fend = (state->buf_start + state->buf_len);
286 if (!state->orig_buf)
291 // Does the existing buffer cover our section?
292 if ((start >= state->buf_start) &&
293 (start <= buf_end) &&
294 (clamped_end >= state->buf_start) &&
295 (clamped_end <= buf_end))
297 char *buf = state->orig_buf + (start - state->buf_start);
299 qemu_iovec_from_buf(acb->qiov, 0, buf, clamped_len);
300 if (clamped_len < len) {
301 qemu_iovec_memset(acb->qiov, clamped_len, 0, len - clamped_len);
307 // Wait for unfinished chunks
309 (start >= state->buf_start) &&
310 (start <= buf_fend) &&
311 (clamped_end >= state->buf_start) &&
312 (clamped_end <= buf_fend))
316 acb->start = start - state->buf_start;
317 acb->end = acb->start + clamped_len;
319 for (j=0; j<CURL_NUM_ACB; j++) {
320 if (!state->acb[j]) {
331 /* Called with s->mutex held. */
332 static void curl_multi_check_completion(BDRVCURLState *s)
336 /* Try to find done transfers, so we can free the easy
340 msg = curl_multi_info_read(s->multi, &msgs_in_queue);
342 /* Quit when there are no more completions */
346 if (msg->msg == CURLMSG_DONE) {
348 CURLState *state = NULL;
349 bool error = msg->data.result != CURLE_OK;
351 curl_easy_getinfo(msg->easy_handle, CURLINFO_PRIVATE,
355 static int errcount = 100;
357 /* Don't lose the original error message from curl, since
358 * it contains extra data.
361 error_report("curl: %s", state->errmsg);
362 if (--errcount == 0) {
363 error_report("curl: further errors suppressed");
368 for (i = 0; i < CURL_NUM_ACB; i++) {
369 CURLAIOCB *acb = state->acb[i];
376 /* Assert that we have read all data */
377 assert(state->buf_off >= acb->end);
379 qemu_iovec_from_buf(acb->qiov, 0,
380 state->orig_buf + acb->start,
381 acb->end - acb->start);
383 if (acb->end - acb->start < acb->bytes) {
384 size_t offset = acb->end - acb->start;
385 qemu_iovec_memset(acb->qiov, offset, 0,
386 acb->bytes - offset);
390 acb->ret = error ? -EIO : 0;
391 state->acb[i] = NULL;
392 qemu_mutex_unlock(&s->mutex);
393 aio_co_wake(acb->co);
394 qemu_mutex_lock(&s->mutex);
397 curl_clean_state(state);
403 /* Called with s->mutex held. */
404 static void curl_multi_do_locked(CURLSocket *socket)
406 BDRVCURLState *s = socket->s;
415 r = curl_multi_socket_action(s->multi, socket->fd, 0, &running);
416 } while (r == CURLM_CALL_MULTI_PERFORM);
419 static void curl_multi_do(void *arg)
421 CURLSocket *socket = arg;
422 BDRVCURLState *s = socket->s;
424 qemu_mutex_lock(&s->mutex);
425 curl_multi_do_locked(socket);
426 curl_multi_check_completion(s);
427 qemu_mutex_unlock(&s->mutex);
430 static void curl_multi_timeout_do(void *arg)
432 BDRVCURLState *s = (BDRVCURLState *)arg;
439 qemu_mutex_lock(&s->mutex);
440 curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
442 curl_multi_check_completion(s);
443 qemu_mutex_unlock(&s->mutex);
446 /* Called with s->mutex held. */
447 static CURLState *curl_find_state(BDRVCURLState *s)
449 CURLState *state = NULL;
452 for (i = 0; i < CURL_NUM_STATES; i++) {
453 if (!s->states[i].in_use) {
454 state = &s->states[i];
462 static int curl_init_state(BDRVCURLState *s, CURLState *state)
465 state->curl = curl_easy_init();
469 if (curl_easy_setopt(state->curl, CURLOPT_URL, s->url) ||
470 curl_easy_setopt(state->curl, CURLOPT_SSL_VERIFYPEER,
471 (long) s->sslverify) ||
472 curl_easy_setopt(state->curl, CURLOPT_SSL_VERIFYHOST,
473 s->sslverify ? 2L : 0L)) {
477 if (curl_easy_setopt(state->curl, CURLOPT_COOKIE, s->cookie)) {
481 if (curl_easy_setopt(state->curl, CURLOPT_TIMEOUT, (long)s->timeout) ||
482 curl_easy_setopt(state->curl, CURLOPT_WRITEFUNCTION,
483 (void *)curl_read_cb) ||
484 curl_easy_setopt(state->curl, CURLOPT_WRITEDATA, (void *)state) ||
485 curl_easy_setopt(state->curl, CURLOPT_PRIVATE, (void *)state) ||
486 curl_easy_setopt(state->curl, CURLOPT_AUTOREFERER, 1) ||
487 curl_easy_setopt(state->curl, CURLOPT_FOLLOWLOCATION, 1) ||
488 curl_easy_setopt(state->curl, CURLOPT_NOSIGNAL, 1) ||
489 curl_easy_setopt(state->curl, CURLOPT_ERRORBUFFER, state->errmsg) ||
490 curl_easy_setopt(state->curl, CURLOPT_FAILONERROR, 1)) {
494 if (curl_easy_setopt(state->curl, CURLOPT_USERNAME, s->username)) {
499 if (curl_easy_setopt(state->curl, CURLOPT_PASSWORD, s->password)) {
503 if (s->proxyusername) {
504 if (curl_easy_setopt(state->curl,
505 CURLOPT_PROXYUSERNAME, s->proxyusername)) {
509 if (s->proxypassword) {
510 if (curl_easy_setopt(state->curl,
511 CURLOPT_PROXYPASSWORD, s->proxypassword)) {
516 /* Restrict supported protocols to avoid security issues in the more
517 * obscure protocols. For example, do not allow POP3/SMTP/IMAP see
520 * Restricting protocols is only supported from 7.19.4 upwards. Note:
521 * version 7.85.0 deprecates CURLOPT_*PROTOCOLS in favour of a string
522 * based CURLOPT_*PROTOCOLS_STR API.
524 #if LIBCURL_VERSION_NUM >= 0x075500
525 if (curl_easy_setopt(state->curl,
526 CURLOPT_PROTOCOLS_STR, PROTOCOLS) ||
527 curl_easy_setopt(state->curl,
528 CURLOPT_REDIR_PROTOCOLS_STR, PROTOCOLS)) {
531 #elif LIBCURL_VERSION_NUM >= 0x071304
532 if (curl_easy_setopt(state->curl, CURLOPT_PROTOCOLS, PROTOCOLS) ||
533 curl_easy_setopt(state->curl, CURLOPT_REDIR_PROTOCOLS, PROTOCOLS)) {
539 if (curl_easy_setopt(state->curl, CURLOPT_VERBOSE, 1)) {
550 curl_easy_cleanup(state->curl);
555 /* Called with s->mutex held. */
556 static void curl_clean_state(CURLState *s)
559 for (j = 0; j < CURL_NUM_ACB; j++) {
564 curl_multi_remove_handle(s->s->multi, s->curl);
568 qemu_co_enter_next(&s->s->free_state_waitq, &s->s->mutex);
571 static void curl_parse_filename(const char *filename, QDict *options,
574 qdict_put_str(options, CURL_BLOCK_OPT_URL, filename);
577 static void curl_detach_aio_context(BlockDriverState *bs)
579 BDRVCURLState *s = bs->opaque;
582 WITH_QEMU_LOCK_GUARD(&s->mutex) {
583 curl_drop_all_sockets(s->sockets);
584 for (i = 0; i < CURL_NUM_STATES; i++) {
585 if (s->states[i].in_use) {
586 curl_clean_state(&s->states[i]);
588 if (s->states[i].curl) {
589 curl_easy_cleanup(s->states[i].curl);
590 s->states[i].curl = NULL;
592 g_free(s->states[i].orig_buf);
593 s->states[i].orig_buf = NULL;
596 curl_multi_cleanup(s->multi);
601 timer_del(&s->timer);
604 static void curl_attach_aio_context(BlockDriverState *bs,
605 AioContext *new_context)
607 BDRVCURLState *s = bs->opaque;
609 aio_timer_init(new_context, &s->timer,
610 QEMU_CLOCK_REALTIME, SCALE_NS,
611 curl_multi_timeout_do, s);
614 s->multi = curl_multi_init();
615 s->aio_context = new_context;
616 curl_multi_setopt(s->multi, CURLMOPT_SOCKETFUNCTION, curl_sock_cb);
617 curl_multi_setopt(s->multi, CURLMOPT_TIMERDATA, s);
618 curl_multi_setopt(s->multi, CURLMOPT_TIMERFUNCTION, curl_timer_cb);
621 static QemuOptsList runtime_opts = {
623 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
626 .name = CURL_BLOCK_OPT_URL,
627 .type = QEMU_OPT_STRING,
628 .help = "URL to open",
631 .name = CURL_BLOCK_OPT_READAHEAD,
632 .type = QEMU_OPT_SIZE,
633 .help = "Readahead size",
636 .name = CURL_BLOCK_OPT_SSLVERIFY,
637 .type = QEMU_OPT_BOOL,
638 .help = "Verify SSL certificate"
641 .name = CURL_BLOCK_OPT_TIMEOUT,
642 .type = QEMU_OPT_NUMBER,
643 .help = "Curl timeout"
646 .name = CURL_BLOCK_OPT_COOKIE,
647 .type = QEMU_OPT_STRING,
648 .help = "Pass the cookie or list of cookies with each request"
651 .name = CURL_BLOCK_OPT_COOKIE_SECRET,
652 .type = QEMU_OPT_STRING,
653 .help = "ID of secret used as cookie passed with each request"
656 .name = CURL_BLOCK_OPT_USERNAME,
657 .type = QEMU_OPT_STRING,
658 .help = "Username for HTTP auth"
661 .name = CURL_BLOCK_OPT_PASSWORD_SECRET,
662 .type = QEMU_OPT_STRING,
663 .help = "ID of secret used as password for HTTP auth",
666 .name = CURL_BLOCK_OPT_PROXY_USERNAME,
667 .type = QEMU_OPT_STRING,
668 .help = "Username for HTTP proxy auth"
671 .name = CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET,
672 .type = QEMU_OPT_STRING,
673 .help = "ID of secret used as password for HTTP proxy auth",
675 { /* end of list */ }
680 static int curl_open(BlockDriverState *bs, QDict *options, int flags,
683 BDRVCURLState *s = bs->opaque;
684 CURLState *state = NULL;
688 const char *cookie_secret;
689 /* CURL >= 7.55.0 uses curl_off_t for content length instead of a double */
690 #if LIBCURL_VERSION_NUM >= 0x073700
695 const char *secretid;
696 const char *protocol_delimiter;
699 bdrv_graph_rdlock_main_loop();
700 ret = bdrv_apply_auto_read_only(bs, "curl driver does not support writes",
702 bdrv_graph_rdunlock_main_loop();
707 if (!libcurl_initialized) {
708 ret = curl_global_init(CURL_GLOBAL_ALL);
710 error_setg(errp, "libcurl initialization failed with %d", ret);
713 libcurl_initialized = true;
716 qemu_mutex_init(&s->mutex);
717 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
718 if (!qemu_opts_absorb_qdict(opts, options, errp)) {
722 s->readahead_size = qemu_opt_get_size(opts, CURL_BLOCK_OPT_READAHEAD,
723 CURL_BLOCK_OPT_READAHEAD_DEFAULT);
724 if ((s->readahead_size & 0x1ff) != 0) {
725 error_setg(errp, "HTTP_READAHEAD_SIZE %zd is not a multiple of 512",
730 s->timeout = qemu_opt_get_number(opts, CURL_BLOCK_OPT_TIMEOUT,
731 CURL_BLOCK_OPT_TIMEOUT_DEFAULT);
732 if (s->timeout > CURL_TIMEOUT_MAX) {
733 error_setg(errp, "timeout parameter is too large or negative");
737 s->sslverify = qemu_opt_get_bool(opts, CURL_BLOCK_OPT_SSLVERIFY,
738 CURL_BLOCK_OPT_SSLVERIFY_DEFAULT);
740 cookie = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE);
741 cookie_secret = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE_SECRET);
743 if (cookie && cookie_secret) {
745 "curl driver cannot handle both cookie and cookie secret");
750 s->cookie = qcrypto_secret_lookup_as_utf8(cookie_secret, errp);
755 s->cookie = g_strdup(cookie);
758 file = qemu_opt_get(opts, CURL_BLOCK_OPT_URL);
760 error_setg(errp, "curl block driver requires an 'url' option");
764 if (!strstart(file, bs->drv->protocol_name, &protocol_delimiter) ||
765 !strstart(protocol_delimiter, "://", NULL))
767 error_setg(errp, "%s curl driver cannot handle the URL '%s' (does not "
768 "start with '%s://')", bs->drv->protocol_name, file,
769 bs->drv->protocol_name);
773 s->username = g_strdup(qemu_opt_get(opts, CURL_BLOCK_OPT_USERNAME));
774 secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PASSWORD_SECRET);
777 s->password = qcrypto_secret_lookup_as_utf8(secretid, errp);
783 s->proxyusername = g_strdup(
784 qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_USERNAME));
785 secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET);
787 s->proxypassword = qcrypto_secret_lookup_as_utf8(secretid, errp);
788 if (!s->proxypassword) {
793 trace_curl_open(file);
794 qemu_co_queue_init(&s->free_state_waitq);
795 s->aio_context = bdrv_get_aio_context(bs);
796 s->url = g_strdup(file);
797 s->sockets = g_hash_table_new_full(NULL, NULL, NULL, g_free);
798 qemu_mutex_lock(&s->mutex);
799 state = curl_find_state(s);
800 qemu_mutex_unlock(&s->mutex);
807 if (curl_init_state(s, state) < 0) {
808 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
809 "curl library initialization failed.");
813 s->accept_range = false;
814 if (curl_easy_setopt(state->curl, CURLOPT_NOBODY, 1) ||
815 curl_easy_setopt(state->curl, CURLOPT_HEADERFUNCTION, curl_header_cb) ||
816 curl_easy_setopt(state->curl, CURLOPT_HEADERDATA, s)) {
817 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
818 "curl library initialization failed.");
821 if (curl_easy_perform(state->curl))
823 /* CURL 7.55.0 deprecates CURLINFO_CONTENT_LENGTH_DOWNLOAD in favour of
824 * the *_T version which returns a more sensible type for content length.
826 #if LIBCURL_VERSION_NUM >= 0x073700
827 if (curl_easy_getinfo(state->curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD_T, &cl)) {
831 if (curl_easy_getinfo(state->curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &cl)) {
835 /* Prior CURL 7.19.4 return value of 0 could mean that the file size is not
836 * know or the size is zero. From 7.19.4 CURL returns -1 if size is not
837 * known and zero if it is really zero-length file. */
838 #if LIBCURL_VERSION_NUM >= 0x071304
840 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
841 "Server didn't report file size.");
846 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
847 "Unknown file size or zero-length file.");
854 if ((!strncasecmp(s->url, "http://", strlen("http://"))
855 || !strncasecmp(s->url, "https://", strlen("https://")))
856 && !s->accept_range) {
857 pstrcpy(state->errmsg, CURL_ERROR_SIZE,
858 "Server does not support 'range' (byte ranges).");
861 trace_curl_open_size(s->len);
863 qemu_mutex_lock(&s->mutex);
864 curl_clean_state(state);
865 qemu_mutex_unlock(&s->mutex);
866 curl_easy_cleanup(state->curl);
869 curl_attach_aio_context(bs, bdrv_get_aio_context(bs));
875 error_setg(errp, "CURL: Error opening file: %s", state->errmsg);
876 curl_easy_cleanup(state->curl);
879 qemu_mutex_destroy(&s->mutex);
883 g_free(s->proxyusername);
884 g_free(s->proxypassword);
886 curl_drop_all_sockets(s->sockets);
887 g_hash_table_destroy(s->sockets);
893 static void coroutine_fn curl_setup_preadv(BlockDriverState *bs, CURLAIOCB *acb)
898 BDRVCURLState *s = bs->opaque;
900 uint64_t start = acb->offset;
903 qemu_mutex_lock(&s->mutex);
905 // In case we have the requested data already (e.g. read-ahead),
906 // we can just call the callback and be done.
907 if (curl_find_buf(s, start, acb->bytes, acb)) {
911 // No cache found, so let's start a new request
913 state = curl_find_state(s);
917 qemu_co_queue_wait(&s->free_state_waitq, &s->mutex);
920 if (curl_init_state(s, state) < 0) {
921 curl_clean_state(state);
927 acb->end = MIN(acb->bytes, s->len - start);
930 g_free(state->orig_buf);
931 state->buf_start = start;
932 state->buf_len = MIN(acb->end + s->readahead_size, s->len - start);
933 end = start + state->buf_len - 1;
934 state->orig_buf = g_try_malloc(state->buf_len);
935 if (state->buf_len && state->orig_buf == NULL) {
936 curl_clean_state(state);
942 snprintf(state->range, 127, "%" PRIu64 "-%" PRIu64, start, end);
943 trace_curl_setup_preadv(acb->bytes, start, state->range);
944 if (curl_easy_setopt(state->curl, CURLOPT_RANGE, state->range) ||
945 curl_multi_add_handle(s->multi, state->curl) != CURLM_OK) {
946 state->acb[0] = NULL;
949 curl_clean_state(state);
953 /* Tell curl it needs to kick things off */
954 curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
957 qemu_mutex_unlock(&s->mutex);
960 static int coroutine_fn curl_co_preadv(BlockDriverState *bs,
961 int64_t offset, int64_t bytes, QEMUIOVector *qiov,
962 BdrvRequestFlags flags)
965 .co = qemu_coroutine_self(),
972 curl_setup_preadv(bs, &acb);
973 while (acb.ret == -EINPROGRESS) {
974 qemu_coroutine_yield();
979 static void curl_close(BlockDriverState *bs)
981 BDRVCURLState *s = bs->opaque;
984 curl_detach_aio_context(bs);
985 qemu_mutex_destroy(&s->mutex);
987 g_hash_table_destroy(s->sockets);
991 g_free(s->proxyusername);
992 g_free(s->proxypassword);
995 static int64_t coroutine_fn curl_co_getlength(BlockDriverState *bs)
997 BDRVCURLState *s = bs->opaque;
1001 static void curl_refresh_filename(BlockDriverState *bs)
1003 BDRVCURLState *s = bs->opaque;
1005 /* "readahead" and "timeout" do not change the guest-visible data,
1007 if (s->sslverify != CURL_BLOCK_OPT_SSLVERIFY_DEFAULT ||
1008 s->cookie || s->username || s->password || s->proxyusername ||
1014 pstrcpy(bs->exact_filename, sizeof(bs->exact_filename), s->url);
1018 static const char *const curl_strong_runtime_opts[] = {
1020 CURL_BLOCK_OPT_SSLVERIFY,
1021 CURL_BLOCK_OPT_COOKIE,
1022 CURL_BLOCK_OPT_COOKIE_SECRET,
1023 CURL_BLOCK_OPT_USERNAME,
1024 CURL_BLOCK_OPT_PASSWORD_SECRET,
1025 CURL_BLOCK_OPT_PROXY_USERNAME,
1026 CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET,
1031 static BlockDriver bdrv_http = {
1032 .format_name = "http",
1033 .protocol_name = "http",
1035 .instance_size = sizeof(BDRVCURLState),
1036 .bdrv_parse_filename = curl_parse_filename,
1037 .bdrv_file_open = curl_open,
1038 .bdrv_close = curl_close,
1039 .bdrv_co_getlength = curl_co_getlength,
1041 .bdrv_co_preadv = curl_co_preadv,
1043 .bdrv_detach_aio_context = curl_detach_aio_context,
1044 .bdrv_attach_aio_context = curl_attach_aio_context,
1046 .bdrv_refresh_filename = curl_refresh_filename,
1047 .strong_runtime_opts = curl_strong_runtime_opts,
1050 static BlockDriver bdrv_https = {
1051 .format_name = "https",
1052 .protocol_name = "https",
1054 .instance_size = sizeof(BDRVCURLState),
1055 .bdrv_parse_filename = curl_parse_filename,
1056 .bdrv_file_open = curl_open,
1057 .bdrv_close = curl_close,
1058 .bdrv_co_getlength = curl_co_getlength,
1060 .bdrv_co_preadv = curl_co_preadv,
1062 .bdrv_detach_aio_context = curl_detach_aio_context,
1063 .bdrv_attach_aio_context = curl_attach_aio_context,
1065 .bdrv_refresh_filename = curl_refresh_filename,
1066 .strong_runtime_opts = curl_strong_runtime_opts,
1069 static BlockDriver bdrv_ftp = {
1070 .format_name = "ftp",
1071 .protocol_name = "ftp",
1073 .instance_size = sizeof(BDRVCURLState),
1074 .bdrv_parse_filename = curl_parse_filename,
1075 .bdrv_file_open = curl_open,
1076 .bdrv_close = curl_close,
1077 .bdrv_co_getlength = curl_co_getlength,
1079 .bdrv_co_preadv = curl_co_preadv,
1081 .bdrv_detach_aio_context = curl_detach_aio_context,
1082 .bdrv_attach_aio_context = curl_attach_aio_context,
1084 .bdrv_refresh_filename = curl_refresh_filename,
1085 .strong_runtime_opts = curl_strong_runtime_opts,
1088 static BlockDriver bdrv_ftps = {
1089 .format_name = "ftps",
1090 .protocol_name = "ftps",
1092 .instance_size = sizeof(BDRVCURLState),
1093 .bdrv_parse_filename = curl_parse_filename,
1094 .bdrv_file_open = curl_open,
1095 .bdrv_close = curl_close,
1096 .bdrv_co_getlength = curl_co_getlength,
1098 .bdrv_co_preadv = curl_co_preadv,
1100 .bdrv_detach_aio_context = curl_detach_aio_context,
1101 .bdrv_attach_aio_context = curl_attach_aio_context,
1103 .bdrv_refresh_filename = curl_refresh_filename,
1104 .strong_runtime_opts = curl_strong_runtime_opts,
1107 static void curl_block_init(void)
1109 bdrv_register(&bdrv_http);
1110 bdrv_register(&bdrv_https);
1111 bdrv_register(&bdrv_ftp);
1112 bdrv_register(&bdrv_ftps);
1115 block_init(curl_block_init);