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-common.h"
28 #include "qemu/error-report.h"
29 #include "block/block_int.h"
30 #include "qapi/qmp/qbool.h"
31 #include "qapi/qmp/qdict.h"
32 #include "qapi/qmp/qstring.h"
33 #include "crypto/secret.h"
34 #include <curl/curl.h>
35 #include "qemu/cutils.h"
38 // #define DEBUG_VERBOSE
41 #define DEBUG_CURL_PRINT 1
43 #define DEBUG_CURL_PRINT 0
45 #define DPRINTF(fmt, ...) \
47 if (DEBUG_CURL_PRINT) { \
48 fprintf(stderr, fmt, ## __VA_ARGS__); \
52 #if LIBCURL_VERSION_NUM >= 0x071000
53 /* The multi interface timer callback was introduced in 7.16.0 */
54 #define NEED_CURL_TIMER_CALLBACK
55 #define HAVE_SOCKET_ACTION
58 #ifndef HAVE_SOCKET_ACTION
59 /* If curl_multi_socket_action isn't available, define it statically here in
60 * terms of curl_multi_socket. Note that ev_bitmask will be ignored, which is
61 * less efficient but still safe. */
62 static CURLMcode
__curl_multi_socket_action(CURLM
*multi_handle
,
67 return curl_multi_socket(multi_handle
, sockfd
, running_handles
);
69 #define curl_multi_socket_action __curl_multi_socket_action
72 #define PROTOCOLS (CURLPROTO_HTTP | CURLPROTO_HTTPS | \
73 CURLPROTO_FTP | CURLPROTO_FTPS)
75 #define CURL_NUM_STATES 8
76 #define CURL_NUM_ACB 8
77 #define READ_AHEAD_DEFAULT (256 * 1024)
78 #define CURL_TIMEOUT_DEFAULT 5
79 #define CURL_TIMEOUT_MAX 10000
81 #define CURL_BLOCK_OPT_URL "url"
82 #define CURL_BLOCK_OPT_READAHEAD "readahead"
83 #define CURL_BLOCK_OPT_SSLVERIFY "sslverify"
84 #define CURL_BLOCK_OPT_TIMEOUT "timeout"
85 #define CURL_BLOCK_OPT_COOKIE "cookie"
86 #define CURL_BLOCK_OPT_COOKIE_SECRET "cookie-secret"
87 #define CURL_BLOCK_OPT_USERNAME "username"
88 #define CURL_BLOCK_OPT_PASSWORD_SECRET "password-secret"
89 #define CURL_BLOCK_OPT_PROXY_USERNAME "proxy-username"
90 #define CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET "proxy-password-secret"
94 static bool libcurl_initialized
;
96 typedef struct CURLAIOCB
{
108 typedef struct CURLSocket
{
110 QLIST_ENTRY(CURLSocket
) next
;
113 typedef struct CURLState
115 struct BDRVCURLState
*s
;
116 CURLAIOCB
*acb
[CURL_NUM_ACB
];
118 QLIST_HEAD(, CURLSocket
) sockets
;
124 char errmsg
[CURL_ERROR_SIZE
];
128 typedef struct BDRVCURLState
{
132 CURLState states
[CURL_NUM_STATES
];
134 size_t readahead_size
;
139 AioContext
*aio_context
;
141 CoQueue free_state_waitq
;
148 static void curl_clean_state(CURLState
*s
);
149 static void curl_multi_do(void *arg
);
150 static void curl_multi_read(void *arg
);
152 #ifdef NEED_CURL_TIMER_CALLBACK
153 /* Called from curl_multi_do_locked, with s->mutex held. */
154 static int curl_timer_cb(CURLM
*multi
, long timeout_ms
, void *opaque
)
156 BDRVCURLState
*s
= opaque
;
158 DPRINTF("CURL: timer callback timeout_ms %ld\n", timeout_ms
);
159 if (timeout_ms
== -1) {
160 timer_del(&s
->timer
);
162 int64_t timeout_ns
= (int64_t)timeout_ms
* 1000 * 1000;
164 qemu_clock_get_ns(QEMU_CLOCK_REALTIME
) + timeout_ns
);
170 /* Called from curl_multi_do_locked, with s->mutex held. */
171 static int curl_sock_cb(CURL
*curl
, curl_socket_t fd
, int action
,
172 void *userp
, void *sp
)
175 CURLState
*state
= NULL
;
178 curl_easy_getinfo(curl
, CURLINFO_PRIVATE
, (char **)&state
);
181 QLIST_FOREACH(socket
, &state
->sockets
, next
) {
182 if (socket
->fd
== fd
) {
183 if (action
== CURL_POLL_REMOVE
) {
184 QLIST_REMOVE(socket
, next
);
191 socket
= g_new0(CURLSocket
, 1);
193 QLIST_INSERT_HEAD(&state
->sockets
, socket
, next
);
197 DPRINTF("CURL (AIO): Sock action %d on fd %d\n", action
, (int)fd
);
200 aio_set_fd_handler(s
->aio_context
, fd
, false,
201 curl_multi_read
, NULL
, NULL
, state
);
204 aio_set_fd_handler(s
->aio_context
, fd
, false,
205 NULL
, curl_multi_do
, NULL
, state
);
207 case CURL_POLL_INOUT
:
208 aio_set_fd_handler(s
->aio_context
, fd
, false,
209 curl_multi_read
, curl_multi_do
, NULL
, state
);
211 case CURL_POLL_REMOVE
:
212 aio_set_fd_handler(s
->aio_context
, fd
, false,
213 NULL
, NULL
, NULL
, NULL
);
220 /* Called from curl_multi_do_locked, with s->mutex held. */
221 static size_t curl_header_cb(void *ptr
, size_t size
, size_t nmemb
, void *opaque
)
223 BDRVCURLState
*s
= opaque
;
224 size_t realsize
= size
* nmemb
;
225 const char *accept_line
= "Accept-Ranges: bytes";
227 if (realsize
>= strlen(accept_line
)
228 && strncmp((char *)ptr
, accept_line
, strlen(accept_line
)) == 0) {
229 s
->accept_range
= true;
235 /* Called from curl_multi_do_locked, with s->mutex held. */
236 static size_t curl_read_cb(void *ptr
, size_t size
, size_t nmemb
, void *opaque
)
238 CURLState
*s
= ((CURLState
*)opaque
);
239 size_t realsize
= size
* nmemb
;
242 DPRINTF("CURL: Just reading %zd bytes\n", realsize
);
244 if (!s
|| !s
->orig_buf
) {
248 if (s
->buf_off
>= s
->buf_len
) {
249 /* buffer full, read nothing */
252 realsize
= MIN(realsize
, s
->buf_len
- s
->buf_off
);
253 memcpy(s
->orig_buf
+ s
->buf_off
, ptr
, realsize
);
254 s
->buf_off
+= realsize
;
256 for(i
=0; i
<CURL_NUM_ACB
; i
++) {
257 CURLAIOCB
*acb
= s
->acb
[i
];
262 if ((s
->buf_off
>= acb
->end
)) {
263 size_t request_length
= acb
->bytes
;
265 qemu_iovec_from_buf(acb
->qiov
, 0, s
->orig_buf
+ acb
->start
,
266 acb
->end
- acb
->start
);
268 if (acb
->end
- acb
->start
< request_length
) {
269 size_t offset
= acb
->end
- acb
->start
;
270 qemu_iovec_memset(acb
->qiov
, offset
, 0,
271 request_length
- offset
);
276 qemu_mutex_unlock(&s
->s
->mutex
);
277 aio_co_wake(acb
->co
);
278 qemu_mutex_lock(&s
->s
->mutex
);
283 /* curl will error out if we do not return this value */
287 /* Called with s->mutex held. */
288 static bool curl_find_buf(BDRVCURLState
*s
, uint64_t start
, uint64_t len
,
292 uint64_t end
= start
+ len
;
293 uint64_t clamped_end
= MIN(end
, s
->len
);
294 uint64_t clamped_len
= clamped_end
- start
;
296 for (i
=0; i
<CURL_NUM_STATES
; i
++) {
297 CURLState
*state
= &s
->states
[i
];
298 uint64_t buf_end
= (state
->buf_start
+ state
->buf_off
);
299 uint64_t buf_fend
= (state
->buf_start
+ state
->buf_len
);
301 if (!state
->orig_buf
)
306 // Does the existing buffer cover our section?
307 if ((start
>= state
->buf_start
) &&
308 (start
<= buf_end
) &&
309 (clamped_end
>= state
->buf_start
) &&
310 (clamped_end
<= buf_end
))
312 char *buf
= state
->orig_buf
+ (start
- state
->buf_start
);
314 qemu_iovec_from_buf(acb
->qiov
, 0, buf
, clamped_len
);
315 if (clamped_len
< len
) {
316 qemu_iovec_memset(acb
->qiov
, clamped_len
, 0, len
- clamped_len
);
322 // Wait for unfinished chunks
324 (start
>= state
->buf_start
) &&
325 (start
<= buf_fend
) &&
326 (clamped_end
>= state
->buf_start
) &&
327 (clamped_end
<= buf_fend
))
331 acb
->start
= start
- state
->buf_start
;
332 acb
->end
= acb
->start
+ clamped_len
;
334 for (j
=0; j
<CURL_NUM_ACB
; j
++) {
335 if (!state
->acb
[j
]) {
346 /* Called with s->mutex held. */
347 static void curl_multi_check_completion(BDRVCURLState
*s
)
351 /* Try to find done transfers, so we can free the easy
355 msg
= curl_multi_info_read(s
->multi
, &msgs_in_queue
);
357 /* Quit when there are no more completions */
361 if (msg
->msg
== CURLMSG_DONE
) {
362 CURLState
*state
= NULL
;
363 curl_easy_getinfo(msg
->easy_handle
, CURLINFO_PRIVATE
,
366 /* ACBs for successful messages get completed in curl_read_cb */
367 if (msg
->data
.result
!= CURLE_OK
) {
369 static int errcount
= 100;
371 /* Don't lose the original error message from curl, since
372 * it contains extra data.
375 error_report("curl: %s", state
->errmsg
);
376 if (--errcount
== 0) {
377 error_report("curl: further errors suppressed");
381 for (i
= 0; i
< CURL_NUM_ACB
; i
++) {
382 CURLAIOCB
*acb
= state
->acb
[i
];
389 state
->acb
[i
] = NULL
;
390 qemu_mutex_unlock(&s
->mutex
);
391 aio_co_wake(acb
->co
);
392 qemu_mutex_lock(&s
->mutex
);
396 curl_clean_state(state
);
402 /* Called with s->mutex held. */
403 static void curl_multi_do_locked(CURLState
*s
)
405 CURLSocket
*socket
, *next_socket
;
413 /* Need to use _SAFE because curl_multi_socket_action() may trigger
414 * curl_sock_cb() which might modify this list */
415 QLIST_FOREACH_SAFE(socket
, &s
->sockets
, next
, next_socket
) {
417 r
= curl_multi_socket_action(s
->s
->multi
, socket
->fd
, 0, &running
);
418 } while (r
== CURLM_CALL_MULTI_PERFORM
);
422 static void curl_multi_do(void *arg
)
424 CURLState
*s
= (CURLState
*)arg
;
426 qemu_mutex_lock(&s
->s
->mutex
);
427 curl_multi_do_locked(s
);
428 qemu_mutex_unlock(&s
->s
->mutex
);
431 static void curl_multi_read(void *arg
)
433 CURLState
*s
= (CURLState
*)arg
;
435 qemu_mutex_lock(&s
->s
->mutex
);
436 curl_multi_do_locked(s
);
437 curl_multi_check_completion(s
->s
);
438 qemu_mutex_unlock(&s
->s
->mutex
);
441 static void curl_multi_timeout_do(void *arg
)
443 #ifdef NEED_CURL_TIMER_CALLBACK
444 BDRVCURLState
*s
= (BDRVCURLState
*)arg
;
451 qemu_mutex_lock(&s
->mutex
);
452 curl_multi_socket_action(s
->multi
, CURL_SOCKET_TIMEOUT
, 0, &running
);
454 curl_multi_check_completion(s
);
455 qemu_mutex_unlock(&s
->mutex
);
461 /* Called with s->mutex held. */
462 static CURLState
*curl_find_state(BDRVCURLState
*s
)
464 CURLState
*state
= NULL
;
467 for (i
= 0; i
< CURL_NUM_STATES
; i
++) {
468 if (!s
->states
[i
].in_use
) {
469 state
= &s
->states
[i
];
477 static int curl_init_state(BDRVCURLState
*s
, CURLState
*state
)
480 state
->curl
= curl_easy_init();
484 curl_easy_setopt(state
->curl
, CURLOPT_URL
, s
->url
);
485 curl_easy_setopt(state
->curl
, CURLOPT_SSL_VERIFYPEER
,
486 (long) s
->sslverify
);
488 curl_easy_setopt(state
->curl
, CURLOPT_COOKIE
, s
->cookie
);
490 curl_easy_setopt(state
->curl
, CURLOPT_TIMEOUT
, (long)s
->timeout
);
491 curl_easy_setopt(state
->curl
, CURLOPT_WRITEFUNCTION
,
492 (void *)curl_read_cb
);
493 curl_easy_setopt(state
->curl
, CURLOPT_WRITEDATA
, (void *)state
);
494 curl_easy_setopt(state
->curl
, CURLOPT_PRIVATE
, (void *)state
);
495 curl_easy_setopt(state
->curl
, CURLOPT_AUTOREFERER
, 1);
496 curl_easy_setopt(state
->curl
, CURLOPT_FOLLOWLOCATION
, 1);
497 curl_easy_setopt(state
->curl
, CURLOPT_NOSIGNAL
, 1);
498 curl_easy_setopt(state
->curl
, CURLOPT_ERRORBUFFER
, state
->errmsg
);
499 curl_easy_setopt(state
->curl
, CURLOPT_FAILONERROR
, 1);
502 curl_easy_setopt(state
->curl
, CURLOPT_USERNAME
, s
->username
);
505 curl_easy_setopt(state
->curl
, CURLOPT_PASSWORD
, s
->password
);
507 if (s
->proxyusername
) {
508 curl_easy_setopt(state
->curl
,
509 CURLOPT_PROXYUSERNAME
, s
->proxyusername
);
511 if (s
->proxypassword
) {
512 curl_easy_setopt(state
->curl
,
513 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.
522 #if LIBCURL_VERSION_NUM >= 0x071304
523 curl_easy_setopt(state
->curl
, CURLOPT_PROTOCOLS
, PROTOCOLS
);
524 curl_easy_setopt(state
->curl
, CURLOPT_REDIR_PROTOCOLS
, PROTOCOLS
);
528 curl_easy_setopt(state
->curl
, CURLOPT_VERBOSE
, 1);
532 QLIST_INIT(&state
->sockets
);
538 /* Called with s->mutex held. */
539 static void curl_clean_state(CURLState
*s
)
542 for (j
= 0; j
< CURL_NUM_ACB
; j
++) {
547 curl_multi_remove_handle(s
->s
->multi
, s
->curl
);
549 while (!QLIST_EMPTY(&s
->sockets
)) {
550 CURLSocket
*socket
= QLIST_FIRST(&s
->sockets
);
552 QLIST_REMOVE(socket
, next
);
558 qemu_co_enter_next(&s
->s
->free_state_waitq
, &s
->s
->mutex
);
561 static void curl_parse_filename(const char *filename
, QDict
*options
,
564 qdict_put_str(options
, CURL_BLOCK_OPT_URL
, filename
);
567 static void curl_detach_aio_context(BlockDriverState
*bs
)
569 BDRVCURLState
*s
= bs
->opaque
;
572 qemu_mutex_lock(&s
->mutex
);
573 for (i
= 0; i
< CURL_NUM_STATES
; i
++) {
574 if (s
->states
[i
].in_use
) {
575 curl_clean_state(&s
->states
[i
]);
577 if (s
->states
[i
].curl
) {
578 curl_easy_cleanup(s
->states
[i
].curl
);
579 s
->states
[i
].curl
= NULL
;
581 g_free(s
->states
[i
].orig_buf
);
582 s
->states
[i
].orig_buf
= NULL
;
585 curl_multi_cleanup(s
->multi
);
588 qemu_mutex_unlock(&s
->mutex
);
590 timer_del(&s
->timer
);
593 static void curl_attach_aio_context(BlockDriverState
*bs
,
594 AioContext
*new_context
)
596 BDRVCURLState
*s
= bs
->opaque
;
598 aio_timer_init(new_context
, &s
->timer
,
599 QEMU_CLOCK_REALTIME
, SCALE_NS
,
600 curl_multi_timeout_do
, s
);
603 s
->multi
= curl_multi_init();
604 s
->aio_context
= new_context
;
605 curl_multi_setopt(s
->multi
, CURLMOPT_SOCKETFUNCTION
, curl_sock_cb
);
606 #ifdef NEED_CURL_TIMER_CALLBACK
607 curl_multi_setopt(s
->multi
, CURLMOPT_TIMERDATA
, s
);
608 curl_multi_setopt(s
->multi
, CURLMOPT_TIMERFUNCTION
, curl_timer_cb
);
612 static QemuOptsList runtime_opts
= {
614 .head
= QTAILQ_HEAD_INITIALIZER(runtime_opts
.head
),
617 .name
= CURL_BLOCK_OPT_URL
,
618 .type
= QEMU_OPT_STRING
,
619 .help
= "URL to open",
622 .name
= CURL_BLOCK_OPT_READAHEAD
,
623 .type
= QEMU_OPT_SIZE
,
624 .help
= "Readahead size",
627 .name
= CURL_BLOCK_OPT_SSLVERIFY
,
628 .type
= QEMU_OPT_BOOL
,
629 .help
= "Verify SSL certificate"
632 .name
= CURL_BLOCK_OPT_TIMEOUT
,
633 .type
= QEMU_OPT_NUMBER
,
634 .help
= "Curl timeout"
637 .name
= CURL_BLOCK_OPT_COOKIE
,
638 .type
= QEMU_OPT_STRING
,
639 .help
= "Pass the cookie or list of cookies with each request"
642 .name
= CURL_BLOCK_OPT_COOKIE_SECRET
,
643 .type
= QEMU_OPT_STRING
,
644 .help
= "ID of secret used as cookie passed with each request"
647 .name
= CURL_BLOCK_OPT_USERNAME
,
648 .type
= QEMU_OPT_STRING
,
649 .help
= "Username for HTTP auth"
652 .name
= CURL_BLOCK_OPT_PASSWORD_SECRET
,
653 .type
= QEMU_OPT_STRING
,
654 .help
= "ID of secret used as password for HTTP auth",
657 .name
= CURL_BLOCK_OPT_PROXY_USERNAME
,
658 .type
= QEMU_OPT_STRING
,
659 .help
= "Username for HTTP proxy auth"
662 .name
= CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET
,
663 .type
= QEMU_OPT_STRING
,
664 .help
= "ID of secret used as password for HTTP proxy auth",
666 { /* end of list */ }
671 static int curl_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
674 BDRVCURLState
*s
= bs
->opaque
;
675 CURLState
*state
= NULL
;
677 Error
*local_err
= NULL
;
680 const char *cookie_secret
;
682 const char *secretid
;
683 const char *protocol_delimiter
;
687 if (flags
& BDRV_O_RDWR
) {
688 error_setg(errp
, "curl block device does not support writes");
692 if (!libcurl_initialized
) {
693 ret
= curl_global_init(CURL_GLOBAL_ALL
);
695 error_setg(errp
, "libcurl initialization failed with %d", ret
);
698 libcurl_initialized
= true;
701 qemu_mutex_init(&s
->mutex
);
702 opts
= qemu_opts_create(&runtime_opts
, NULL
, 0, &error_abort
);
703 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
705 error_propagate(errp
, local_err
);
709 s
->readahead_size
= qemu_opt_get_size(opts
, CURL_BLOCK_OPT_READAHEAD
,
711 if ((s
->readahead_size
& 0x1ff) != 0) {
712 error_setg(errp
, "HTTP_READAHEAD_SIZE %zd is not a multiple of 512",
717 s
->timeout
= qemu_opt_get_number(opts
, CURL_BLOCK_OPT_TIMEOUT
,
718 CURL_TIMEOUT_DEFAULT
);
719 if (s
->timeout
> CURL_TIMEOUT_MAX
) {
720 error_setg(errp
, "timeout parameter is too large or negative");
724 s
->sslverify
= qemu_opt_get_bool(opts
, CURL_BLOCK_OPT_SSLVERIFY
, true);
726 cookie
= qemu_opt_get(opts
, CURL_BLOCK_OPT_COOKIE
);
727 cookie_secret
= qemu_opt_get(opts
, CURL_BLOCK_OPT_COOKIE_SECRET
);
729 if (cookie
&& cookie_secret
) {
731 "curl driver cannot handle both cookie and cookie secret");
736 s
->cookie
= qcrypto_secret_lookup_as_utf8(cookie_secret
, errp
);
741 s
->cookie
= g_strdup(cookie
);
744 file
= qemu_opt_get(opts
, CURL_BLOCK_OPT_URL
);
746 error_setg(errp
, "curl block driver requires an 'url' option");
750 if (!strstart(file
, bs
->drv
->protocol_name
, &protocol_delimiter
) ||
751 !strstart(protocol_delimiter
, "://", NULL
))
753 error_setg(errp
, "%s curl driver cannot handle the URL '%s' (does not "
754 "start with '%s://')", bs
->drv
->protocol_name
, file
,
755 bs
->drv
->protocol_name
);
759 s
->username
= g_strdup(qemu_opt_get(opts
, CURL_BLOCK_OPT_USERNAME
));
760 secretid
= qemu_opt_get(opts
, CURL_BLOCK_OPT_PASSWORD_SECRET
);
763 s
->password
= qcrypto_secret_lookup_as_utf8(secretid
, errp
);
769 s
->proxyusername
= g_strdup(
770 qemu_opt_get(opts
, CURL_BLOCK_OPT_PROXY_USERNAME
));
771 secretid
= qemu_opt_get(opts
, CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET
);
773 s
->proxypassword
= qcrypto_secret_lookup_as_utf8(secretid
, errp
);
774 if (!s
->proxypassword
) {
779 DPRINTF("CURL: Opening %s\n", file
);
780 qemu_co_queue_init(&s
->free_state_waitq
);
781 s
->aio_context
= bdrv_get_aio_context(bs
);
782 s
->url
= g_strdup(file
);
783 qemu_mutex_lock(&s
->mutex
);
784 state
= curl_find_state(s
);
785 qemu_mutex_unlock(&s
->mutex
);
792 if (curl_init_state(s
, state
) < 0) {
796 s
->accept_range
= false;
797 curl_easy_setopt(state
->curl
, CURLOPT_NOBODY
, 1);
798 curl_easy_setopt(state
->curl
, CURLOPT_HEADERFUNCTION
,
800 curl_easy_setopt(state
->curl
, CURLOPT_HEADERDATA
, s
);
801 if (curl_easy_perform(state
->curl
))
803 if (curl_easy_getinfo(state
->curl
, CURLINFO_CONTENT_LENGTH_DOWNLOAD
, &d
)) {
806 /* Prior CURL 7.19.4 return value of 0 could mean that the file size is not
807 * know or the size is zero. From 7.19.4 CURL returns -1 if size is not
808 * known and zero if it is realy zero-length file. */
809 #if LIBCURL_VERSION_NUM >= 0x071304
811 pstrcpy(state
->errmsg
, CURL_ERROR_SIZE
,
812 "Server didn't report file size.");
817 pstrcpy(state
->errmsg
, CURL_ERROR_SIZE
,
818 "Unknown file size or zero-length file.");
825 if ((!strncasecmp(s
->url
, "http://", strlen("http://"))
826 || !strncasecmp(s
->url
, "https://", strlen("https://")))
827 && !s
->accept_range
) {
828 pstrcpy(state
->errmsg
, CURL_ERROR_SIZE
,
829 "Server does not support 'range' (byte ranges).");
832 DPRINTF("CURL: Size = %" PRIu64
"\n", s
->len
);
834 qemu_mutex_lock(&s
->mutex
);
835 curl_clean_state(state
);
836 qemu_mutex_unlock(&s
->mutex
);
837 curl_easy_cleanup(state
->curl
);
840 curl_attach_aio_context(bs
, bdrv_get_aio_context(bs
));
846 error_setg(errp
, "CURL: Error opening file: %s", state
->errmsg
);
847 curl_easy_cleanup(state
->curl
);
850 qemu_mutex_destroy(&s
->mutex
);
854 g_free(s
->proxyusername
);
855 g_free(s
->proxypassword
);
860 static void curl_setup_preadv(BlockDriverState
*bs
, CURLAIOCB
*acb
)
865 BDRVCURLState
*s
= bs
->opaque
;
867 uint64_t start
= acb
->offset
;
870 qemu_mutex_lock(&s
->mutex
);
872 // In case we have the requested data already (e.g. read-ahead),
873 // we can just call the callback and be done.
874 if (curl_find_buf(s
, start
, acb
->bytes
, acb
)) {
878 // No cache found, so let's start a new request
880 state
= curl_find_state(s
);
884 qemu_co_queue_wait(&s
->free_state_waitq
, &s
->mutex
);
887 if (curl_init_state(s
, state
) < 0) {
888 curl_clean_state(state
);
894 acb
->end
= MIN(acb
->bytes
, s
->len
- start
);
897 g_free(state
->orig_buf
);
898 state
->buf_start
= start
;
899 state
->buf_len
= MIN(acb
->end
+ s
->readahead_size
, s
->len
- start
);
900 end
= start
+ state
->buf_len
- 1;
901 state
->orig_buf
= g_try_malloc(state
->buf_len
);
902 if (state
->buf_len
&& state
->orig_buf
== NULL
) {
903 curl_clean_state(state
);
909 snprintf(state
->range
, 127, "%" PRIu64
"-%" PRIu64
, start
, end
);
910 DPRINTF("CURL (AIO): Reading %" PRIu64
" at %" PRIu64
" (%s)\n",
911 acb
->bytes
, start
, state
->range
);
912 curl_easy_setopt(state
->curl
, CURLOPT_RANGE
, state
->range
);
914 curl_multi_add_handle(s
->multi
, state
->curl
);
916 /* Tell curl it needs to kick things off */
917 curl_multi_socket_action(s
->multi
, CURL_SOCKET_TIMEOUT
, 0, &running
);
920 qemu_mutex_unlock(&s
->mutex
);
923 static int coroutine_fn
curl_co_preadv(BlockDriverState
*bs
,
924 uint64_t offset
, uint64_t bytes
, QEMUIOVector
*qiov
, int flags
)
927 .co
= qemu_coroutine_self(),
934 curl_setup_preadv(bs
, &acb
);
935 while (acb
.ret
== -EINPROGRESS
) {
936 qemu_coroutine_yield();
941 static void curl_close(BlockDriverState
*bs
)
943 BDRVCURLState
*s
= bs
->opaque
;
945 DPRINTF("CURL: Close\n");
946 curl_detach_aio_context(bs
);
947 qemu_mutex_destroy(&s
->mutex
);
952 g_free(s
->proxyusername
);
953 g_free(s
->proxypassword
);
956 static int64_t curl_getlength(BlockDriverState
*bs
)
958 BDRVCURLState
*s
= bs
->opaque
;
962 static BlockDriver bdrv_http
= {
963 .format_name
= "http",
964 .protocol_name
= "http",
966 .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
,
972 .bdrv_co_preadv
= curl_co_preadv
,
974 .bdrv_detach_aio_context
= curl_detach_aio_context
,
975 .bdrv_attach_aio_context
= curl_attach_aio_context
,
978 static BlockDriver bdrv_https
= {
979 .format_name
= "https",
980 .protocol_name
= "https",
982 .instance_size
= sizeof(BDRVCURLState
),
983 .bdrv_parse_filename
= curl_parse_filename
,
984 .bdrv_file_open
= curl_open
,
985 .bdrv_close
= curl_close
,
986 .bdrv_getlength
= curl_getlength
,
988 .bdrv_co_preadv
= curl_co_preadv
,
990 .bdrv_detach_aio_context
= curl_detach_aio_context
,
991 .bdrv_attach_aio_context
= curl_attach_aio_context
,
994 static BlockDriver bdrv_ftp
= {
995 .format_name
= "ftp",
996 .protocol_name
= "ftp",
998 .instance_size
= sizeof(BDRVCURLState
),
999 .bdrv_parse_filename
= curl_parse_filename
,
1000 .bdrv_file_open
= curl_open
,
1001 .bdrv_close
= curl_close
,
1002 .bdrv_getlength
= curl_getlength
,
1004 .bdrv_co_preadv
= curl_co_preadv
,
1006 .bdrv_detach_aio_context
= curl_detach_aio_context
,
1007 .bdrv_attach_aio_context
= curl_attach_aio_context
,
1010 static BlockDriver bdrv_ftps
= {
1011 .format_name
= "ftps",
1012 .protocol_name
= "ftps",
1014 .instance_size
= sizeof(BDRVCURLState
),
1015 .bdrv_parse_filename
= curl_parse_filename
,
1016 .bdrv_file_open
= curl_open
,
1017 .bdrv_close
= curl_close
,
1018 .bdrv_getlength
= curl_getlength
,
1020 .bdrv_co_preadv
= curl_co_preadv
,
1022 .bdrv_detach_aio_context
= curl_detach_aio_context
,
1023 .bdrv_attach_aio_context
= curl_attach_aio_context
,
1026 static void curl_block_init(void)
1028 bdrv_register(&bdrv_http
);
1029 bdrv_register(&bdrv_https
);
1030 bdrv_register(&bdrv_ftp
);
1031 bdrv_register(&bdrv_ftps
);
1034 block_init(curl_block_init
);