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
24 #include "qemu-common.h"
25 #include "block/block_int.h"
26 #include "qapi/qmp/qbool.h"
27 #include <curl/curl.h>
30 // #define DEBUG_VERBOSE
33 #define DPRINTF(fmt, ...) do { printf(fmt, ## __VA_ARGS__); } while (0)
35 #define DPRINTF(fmt, ...) do { } while (0)
38 #if LIBCURL_VERSION_NUM >= 0x071000
39 /* The multi interface timer callback was introduced in 7.16.0 */
40 #define NEED_CURL_TIMER_CALLBACK
41 #define HAVE_SOCKET_ACTION
44 #ifndef HAVE_SOCKET_ACTION
45 /* If curl_multi_socket_action isn't available, define it statically here in
46 * terms of curl_multi_socket. Note that ev_bitmask will be ignored, which is
47 * less efficient but still safe. */
48 static CURLMcode
__curl_multi_socket_action(CURLM
*multi_handle
,
53 return curl_multi_socket(multi_handle
, sockfd
, running_handles
);
55 #define curl_multi_socket_action __curl_multi_socket_action
58 #define PROTOCOLS (CURLPROTO_HTTP | CURLPROTO_HTTPS | \
59 CURLPROTO_FTP | CURLPROTO_FTPS | \
62 #define CURL_NUM_STATES 8
63 #define CURL_NUM_ACB 8
64 #define SECTOR_SIZE 512
65 #define READ_AHEAD_DEFAULT (256 * 1024)
66 #define CURL_TIMEOUT_DEFAULT 5
68 #define FIND_RET_NONE 0
70 #define FIND_RET_WAIT 2
72 #define CURL_BLOCK_OPT_URL "url"
73 #define CURL_BLOCK_OPT_READAHEAD "readahead"
74 #define CURL_BLOCK_OPT_SSLVERIFY "sslverify"
75 #define CURL_BLOCK_OPT_TIMEOUT "timeout"
79 typedef struct CURLAIOCB
{
80 BlockDriverAIOCB common
;
91 typedef struct CURLState
93 struct BDRVCURLState
*s
;
94 CURLAIOCB
*acb
[CURL_NUM_ACB
];
96 curl_socket_t sock_fd
;
102 char errmsg
[CURL_ERROR_SIZE
];
106 typedef struct BDRVCURLState
{
110 CURLState states
[CURL_NUM_STATES
];
112 size_t readahead_size
;
116 AioContext
*aio_context
;
119 static void curl_clean_state(CURLState
*s
);
120 static void curl_multi_do(void *arg
);
121 static void curl_multi_read(void *arg
);
123 #ifdef NEED_CURL_TIMER_CALLBACK
124 static int curl_timer_cb(CURLM
*multi
, long timeout_ms
, void *opaque
)
126 BDRVCURLState
*s
= opaque
;
128 DPRINTF("CURL: timer callback timeout_ms %ld\n", timeout_ms
);
129 if (timeout_ms
== -1) {
130 timer_del(&s
->timer
);
132 int64_t timeout_ns
= (int64_t)timeout_ms
* 1000 * 1000;
134 qemu_clock_get_ns(QEMU_CLOCK_REALTIME
) + timeout_ns
);
140 static int curl_sock_cb(CURL
*curl
, curl_socket_t fd
, int action
,
141 void *userp
, void *sp
)
144 CURLState
*state
= NULL
;
145 curl_easy_getinfo(curl
, CURLINFO_PRIVATE
, (char **)&state
);
149 DPRINTF("CURL (AIO): Sock action %d on fd %d\n", action
, fd
);
152 aio_set_fd_handler(s
->aio_context
, fd
, curl_multi_read
,
156 aio_set_fd_handler(s
->aio_context
, fd
, NULL
, curl_multi_do
, state
);
158 case CURL_POLL_INOUT
:
159 aio_set_fd_handler(s
->aio_context
, fd
, curl_multi_read
,
160 curl_multi_do
, state
);
162 case CURL_POLL_REMOVE
:
163 aio_set_fd_handler(s
->aio_context
, fd
, NULL
, NULL
, NULL
);
170 static size_t curl_header_cb(void *ptr
, size_t size
, size_t nmemb
, void *opaque
)
172 BDRVCURLState
*s
= opaque
;
173 size_t realsize
= size
* nmemb
;
174 const char *accept_line
= "Accept-Ranges: bytes";
176 if (realsize
>= strlen(accept_line
)
177 && strncmp((char *)ptr
, accept_line
, strlen(accept_line
)) == 0) {
178 s
->accept_range
= true;
184 static size_t curl_read_cb(void *ptr
, size_t size
, size_t nmemb
, void *opaque
)
186 CURLState
*s
= ((CURLState
*)opaque
);
187 size_t realsize
= size
* nmemb
;
190 DPRINTF("CURL: Just reading %zd bytes\n", realsize
);
192 if (!s
|| !s
->orig_buf
)
195 if (s
->buf_off
>= s
->buf_len
) {
196 /* buffer full, read nothing */
199 realsize
= MIN(realsize
, s
->buf_len
- s
->buf_off
);
200 memcpy(s
->orig_buf
+ s
->buf_off
, ptr
, realsize
);
201 s
->buf_off
+= realsize
;
203 for(i
=0; i
<CURL_NUM_ACB
; i
++) {
204 CURLAIOCB
*acb
= s
->acb
[i
];
209 if ((s
->buf_off
>= acb
->end
)) {
210 qemu_iovec_from_buf(acb
->qiov
, 0, s
->orig_buf
+ acb
->start
,
211 acb
->end
- acb
->start
);
212 acb
->common
.cb(acb
->common
.opaque
, 0);
213 qemu_aio_release(acb
);
221 static int curl_find_buf(BDRVCURLState
*s
, size_t start
, size_t len
,
225 size_t end
= start
+ len
;
227 for (i
=0; i
<CURL_NUM_STATES
; i
++) {
228 CURLState
*state
= &s
->states
[i
];
229 size_t buf_end
= (state
->buf_start
+ state
->buf_off
);
230 size_t buf_fend
= (state
->buf_start
+ state
->buf_len
);
232 if (!state
->orig_buf
)
237 // Does the existing buffer cover our section?
238 if ((start
>= state
->buf_start
) &&
239 (start
<= buf_end
) &&
240 (end
>= state
->buf_start
) &&
243 char *buf
= state
->orig_buf
+ (start
- state
->buf_start
);
245 qemu_iovec_from_buf(acb
->qiov
, 0, buf
, len
);
246 acb
->common
.cb(acb
->common
.opaque
, 0);
251 // Wait for unfinished chunks
253 (start
>= state
->buf_start
) &&
254 (start
<= buf_fend
) &&
255 (end
>= state
->buf_start
) &&
260 acb
->start
= start
- state
->buf_start
;
261 acb
->end
= acb
->start
+ len
;
263 for (j
=0; j
<CURL_NUM_ACB
; j
++) {
264 if (!state
->acb
[j
]) {
266 return FIND_RET_WAIT
;
272 return FIND_RET_NONE
;
275 static void curl_multi_check_completion(BDRVCURLState
*s
)
279 /* Try to find done transfers, so we can free the easy
283 msg
= curl_multi_info_read(s
->multi
, &msgs_in_queue
);
285 /* Quit when there are no more completions */
289 if (msg
->msg
== CURLMSG_DONE
) {
290 CURLState
*state
= NULL
;
291 curl_easy_getinfo(msg
->easy_handle
, CURLINFO_PRIVATE
,
294 /* ACBs for successful messages get completed in curl_read_cb */
295 if (msg
->data
.result
!= CURLE_OK
) {
297 for (i
= 0; i
< CURL_NUM_ACB
; i
++) {
298 CURLAIOCB
*acb
= state
->acb
[i
];
304 acb
->common
.cb(acb
->common
.opaque
, -EIO
);
305 qemu_aio_release(acb
);
306 state
->acb
[i
] = NULL
;
310 curl_clean_state(state
);
316 static void curl_multi_do(void *arg
)
318 CURLState
*s
= (CURLState
*)arg
;
327 r
= curl_multi_socket_action(s
->s
->multi
, s
->sock_fd
, 0, &running
);
328 } while(r
== CURLM_CALL_MULTI_PERFORM
);
332 static void curl_multi_read(void *arg
)
334 CURLState
*s
= (CURLState
*)arg
;
337 curl_multi_check_completion(s
->s
);
340 static void curl_multi_timeout_do(void *arg
)
342 #ifdef NEED_CURL_TIMER_CALLBACK
343 BDRVCURLState
*s
= (BDRVCURLState
*)arg
;
350 curl_multi_socket_action(s
->multi
, CURL_SOCKET_TIMEOUT
, 0, &running
);
352 curl_multi_check_completion(s
);
358 static CURLState
*curl_init_state(BDRVCURLState
*s
)
360 CURLState
*state
= NULL
;
364 for (i
=0; i
<CURL_NUM_STATES
; i
++) {
365 for (j
=0; j
<CURL_NUM_ACB
; j
++)
366 if (s
->states
[i
].acb
[j
])
368 if (s
->states
[i
].in_use
)
371 state
= &s
->states
[i
];
376 aio_poll(state
->s
->aio_context
, true);
381 state
->curl
= curl_easy_init();
385 curl_easy_setopt(state
->curl
, CURLOPT_URL
, s
->url
);
386 curl_easy_setopt(state
->curl
, CURLOPT_SSL_VERIFYPEER
,
387 (long) s
->sslverify
);
388 curl_easy_setopt(state
->curl
, CURLOPT_TIMEOUT
, s
->timeout
);
389 curl_easy_setopt(state
->curl
, CURLOPT_WRITEFUNCTION
,
390 (void *)curl_read_cb
);
391 curl_easy_setopt(state
->curl
, CURLOPT_WRITEDATA
, (void *)state
);
392 curl_easy_setopt(state
->curl
, CURLOPT_PRIVATE
, (void *)state
);
393 curl_easy_setopt(state
->curl
, CURLOPT_AUTOREFERER
, 1);
394 curl_easy_setopt(state
->curl
, CURLOPT_FOLLOWLOCATION
, 1);
395 curl_easy_setopt(state
->curl
, CURLOPT_NOSIGNAL
, 1);
396 curl_easy_setopt(state
->curl
, CURLOPT_ERRORBUFFER
, state
->errmsg
);
397 curl_easy_setopt(state
->curl
, CURLOPT_FAILONERROR
, 1);
399 /* Restrict supported protocols to avoid security issues in the more
400 * obscure protocols. For example, do not allow POP3/SMTP/IMAP see
403 * Restricting protocols is only supported from 7.19.4 upwards.
405 #if LIBCURL_VERSION_NUM >= 0x071304
406 curl_easy_setopt(state
->curl
, CURLOPT_PROTOCOLS
, PROTOCOLS
);
407 curl_easy_setopt(state
->curl
, CURLOPT_REDIR_PROTOCOLS
, PROTOCOLS
);
411 curl_easy_setopt(state
->curl
, CURLOPT_VERBOSE
, 1);
420 static void curl_clean_state(CURLState
*s
)
423 curl_multi_remove_handle(s
->s
->multi
, s
->curl
);
427 static void curl_parse_filename(const char *filename
, QDict
*options
,
430 qdict_put(options
, CURL_BLOCK_OPT_URL
, qstring_from_str(filename
));
433 static void curl_detach_aio_context(BlockDriverState
*bs
)
435 BDRVCURLState
*s
= bs
->opaque
;
438 for (i
= 0; i
< CURL_NUM_STATES
; i
++) {
439 if (s
->states
[i
].in_use
) {
440 curl_clean_state(&s
->states
[i
]);
442 if (s
->states
[i
].curl
) {
443 curl_easy_cleanup(s
->states
[i
].curl
);
444 s
->states
[i
].curl
= NULL
;
446 g_free(s
->states
[i
].orig_buf
);
447 s
->states
[i
].orig_buf
= NULL
;
450 curl_multi_cleanup(s
->multi
);
454 timer_del(&s
->timer
);
457 static void curl_attach_aio_context(BlockDriverState
*bs
,
458 AioContext
*new_context
)
460 BDRVCURLState
*s
= bs
->opaque
;
462 aio_timer_init(new_context
, &s
->timer
,
463 QEMU_CLOCK_REALTIME
, SCALE_NS
,
464 curl_multi_timeout_do
, s
);
467 s
->multi
= curl_multi_init();
468 s
->aio_context
= new_context
;
469 curl_multi_setopt(s
->multi
, CURLMOPT_SOCKETFUNCTION
, curl_sock_cb
);
470 #ifdef NEED_CURL_TIMER_CALLBACK
471 curl_multi_setopt(s
->multi
, CURLMOPT_TIMERDATA
, s
);
472 curl_multi_setopt(s
->multi
, CURLMOPT_TIMERFUNCTION
, curl_timer_cb
);
476 static QemuOptsList runtime_opts
= {
478 .head
= QTAILQ_HEAD_INITIALIZER(runtime_opts
.head
),
481 .name
= CURL_BLOCK_OPT_URL
,
482 .type
= QEMU_OPT_STRING
,
483 .help
= "URL to open",
486 .name
= CURL_BLOCK_OPT_READAHEAD
,
487 .type
= QEMU_OPT_SIZE
,
488 .help
= "Readahead size",
491 .name
= CURL_BLOCK_OPT_SSLVERIFY
,
492 .type
= QEMU_OPT_BOOL
,
493 .help
= "Verify SSL certificate"
496 .name
= CURL_BLOCK_OPT_TIMEOUT
,
497 .type
= QEMU_OPT_NUMBER
,
498 .help
= "Curl timeout"
500 { /* end of list */ }
504 static int curl_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
507 BDRVCURLState
*s
= bs
->opaque
;
508 CURLState
*state
= NULL
;
510 Error
*local_err
= NULL
;
514 static int inited
= 0;
516 if (flags
& BDRV_O_RDWR
) {
517 error_setg(errp
, "curl block device does not support writes");
521 opts
= qemu_opts_create(&runtime_opts
, NULL
, 0, &error_abort
);
522 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
524 error_propagate(errp
, local_err
);
528 s
->readahead_size
= qemu_opt_get_size(opts
, CURL_BLOCK_OPT_READAHEAD
,
530 if ((s
->readahead_size
& 0x1ff) != 0) {
531 error_setg(errp
, "HTTP_READAHEAD_SIZE %zd is not a multiple of 512",
536 s
->timeout
= qemu_opt_get_number(opts
, CURL_BLOCK_OPT_TIMEOUT
,
537 CURL_TIMEOUT_DEFAULT
);
539 s
->sslverify
= qemu_opt_get_bool(opts
, CURL_BLOCK_OPT_SSLVERIFY
, true);
541 file
= qemu_opt_get(opts
, CURL_BLOCK_OPT_URL
);
543 error_setg(errp
, "curl block driver requires an 'url' option");
548 curl_global_init(CURL_GLOBAL_ALL
);
552 DPRINTF("CURL: Opening %s\n", file
);
553 s
->aio_context
= bdrv_get_aio_context(bs
);
554 s
->url
= g_strdup(file
);
555 state
= curl_init_state(s
);
561 s
->accept_range
= false;
562 curl_easy_setopt(state
->curl
, CURLOPT_NOBODY
, 1);
563 curl_easy_setopt(state
->curl
, CURLOPT_HEADERFUNCTION
,
565 curl_easy_setopt(state
->curl
, CURLOPT_HEADERDATA
, s
);
566 if (curl_easy_perform(state
->curl
))
568 curl_easy_getinfo(state
->curl
, CURLINFO_CONTENT_LENGTH_DOWNLOAD
, &d
);
573 if ((!strncasecmp(s
->url
, "http://", strlen("http://"))
574 || !strncasecmp(s
->url
, "https://", strlen("https://")))
575 && !s
->accept_range
) {
576 pstrcpy(state
->errmsg
, CURL_ERROR_SIZE
,
577 "Server does not support 'range' (byte ranges).");
580 DPRINTF("CURL: Size = %zd\n", s
->len
);
582 curl_clean_state(state
);
583 curl_easy_cleanup(state
->curl
);
586 curl_attach_aio_context(bs
, bdrv_get_aio_context(bs
));
592 error_setg(errp
, "CURL: Error opening file: %s", state
->errmsg
);
593 curl_easy_cleanup(state
->curl
);
601 static void curl_aio_cancel(BlockDriverAIOCB
*blockacb
)
603 // Do we have to implement canceling? Seems to work without...
606 static const AIOCBInfo curl_aiocb_info
= {
607 .aiocb_size
= sizeof(CURLAIOCB
),
608 .cancel
= curl_aio_cancel
,
612 static void curl_readv_bh_cb(void *p
)
618 BDRVCURLState
*s
= acb
->common
.bs
->opaque
;
620 qemu_bh_delete(acb
->bh
);
623 size_t start
= acb
->sector_num
* SECTOR_SIZE
;
626 // In case we have the requested data already (e.g. read-ahead),
627 // we can just call the callback and be done.
628 switch (curl_find_buf(s
, start
, acb
->nb_sectors
* SECTOR_SIZE
, acb
)) {
630 qemu_aio_release(acb
);
638 // No cache found, so let's start a new request
639 state
= curl_init_state(s
);
641 acb
->common
.cb(acb
->common
.opaque
, -EIO
);
642 qemu_aio_release(acb
);
647 acb
->end
= (acb
->nb_sectors
* SECTOR_SIZE
);
650 g_free(state
->orig_buf
);
651 state
->buf_start
= start
;
652 state
->buf_len
= acb
->end
+ s
->readahead_size
;
653 end
= MIN(start
+ state
->buf_len
, s
->len
) - 1;
654 state
->orig_buf
= g_try_malloc(state
->buf_len
);
655 if (state
->buf_len
&& state
->orig_buf
== NULL
) {
656 curl_clean_state(state
);
657 acb
->common
.cb(acb
->common
.opaque
, -ENOMEM
);
658 qemu_aio_release(acb
);
663 snprintf(state
->range
, 127, "%zd-%zd", start
, end
);
664 DPRINTF("CURL (AIO): Reading %d at %zd (%s)\n",
665 (acb
->nb_sectors
* SECTOR_SIZE
), start
, state
->range
);
666 curl_easy_setopt(state
->curl
, CURLOPT_RANGE
, state
->range
);
668 curl_multi_add_handle(s
->multi
, state
->curl
);
670 /* Tell curl it needs to kick things off */
671 curl_multi_socket_action(s
->multi
, CURL_SOCKET_TIMEOUT
, 0, &running
);
674 static BlockDriverAIOCB
*curl_aio_readv(BlockDriverState
*bs
,
675 int64_t sector_num
, QEMUIOVector
*qiov
, int nb_sectors
,
676 BlockDriverCompletionFunc
*cb
, void *opaque
)
680 acb
= qemu_aio_get(&curl_aiocb_info
, bs
, cb
, opaque
);
683 acb
->sector_num
= sector_num
;
684 acb
->nb_sectors
= nb_sectors
;
686 acb
->bh
= aio_bh_new(bdrv_get_aio_context(bs
), curl_readv_bh_cb
, acb
);
687 qemu_bh_schedule(acb
->bh
);
691 static void curl_close(BlockDriverState
*bs
)
693 BDRVCURLState
*s
= bs
->opaque
;
695 DPRINTF("CURL: Close\n");
696 curl_detach_aio_context(bs
);
701 static int64_t curl_getlength(BlockDriverState
*bs
)
703 BDRVCURLState
*s
= bs
->opaque
;
707 static BlockDriver bdrv_http
= {
708 .format_name
= "http",
709 .protocol_name
= "http",
711 .instance_size
= sizeof(BDRVCURLState
),
712 .bdrv_parse_filename
= curl_parse_filename
,
713 .bdrv_file_open
= curl_open
,
714 .bdrv_close
= curl_close
,
715 .bdrv_getlength
= curl_getlength
,
717 .bdrv_aio_readv
= curl_aio_readv
,
719 .bdrv_detach_aio_context
= curl_detach_aio_context
,
720 .bdrv_attach_aio_context
= curl_attach_aio_context
,
723 static BlockDriver bdrv_https
= {
724 .format_name
= "https",
725 .protocol_name
= "https",
727 .instance_size
= sizeof(BDRVCURLState
),
728 .bdrv_parse_filename
= curl_parse_filename
,
729 .bdrv_file_open
= curl_open
,
730 .bdrv_close
= curl_close
,
731 .bdrv_getlength
= curl_getlength
,
733 .bdrv_aio_readv
= curl_aio_readv
,
735 .bdrv_detach_aio_context
= curl_detach_aio_context
,
736 .bdrv_attach_aio_context
= curl_attach_aio_context
,
739 static BlockDriver bdrv_ftp
= {
740 .format_name
= "ftp",
741 .protocol_name
= "ftp",
743 .instance_size
= sizeof(BDRVCURLState
),
744 .bdrv_parse_filename
= curl_parse_filename
,
745 .bdrv_file_open
= curl_open
,
746 .bdrv_close
= curl_close
,
747 .bdrv_getlength
= curl_getlength
,
749 .bdrv_aio_readv
= curl_aio_readv
,
751 .bdrv_detach_aio_context
= curl_detach_aio_context
,
752 .bdrv_attach_aio_context
= curl_attach_aio_context
,
755 static BlockDriver bdrv_ftps
= {
756 .format_name
= "ftps",
757 .protocol_name
= "ftps",
759 .instance_size
= sizeof(BDRVCURLState
),
760 .bdrv_parse_filename
= curl_parse_filename
,
761 .bdrv_file_open
= curl_open
,
762 .bdrv_close
= curl_close
,
763 .bdrv_getlength
= curl_getlength
,
765 .bdrv_aio_readv
= curl_aio_readv
,
767 .bdrv_detach_aio_context
= curl_detach_aio_context
,
768 .bdrv_attach_aio_context
= curl_attach_aio_context
,
771 static BlockDriver bdrv_tftp
= {
772 .format_name
= "tftp",
773 .protocol_name
= "tftp",
775 .instance_size
= sizeof(BDRVCURLState
),
776 .bdrv_parse_filename
= curl_parse_filename
,
777 .bdrv_file_open
= curl_open
,
778 .bdrv_close
= curl_close
,
779 .bdrv_getlength
= curl_getlength
,
781 .bdrv_aio_readv
= curl_aio_readv
,
783 .bdrv_detach_aio_context
= curl_detach_aio_context
,
784 .bdrv_attach_aio_context
= curl_attach_aio_context
,
787 static void curl_block_init(void)
789 bdrv_register(&bdrv_http
);
790 bdrv_register(&bdrv_https
);
791 bdrv_register(&bdrv_ftp
);
792 bdrv_register(&bdrv_ftps
);
793 bdrv_register(&bdrv_tftp
);
796 block_init(curl_block_init
);