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 "qemu/error-report.h"
26 #include "block/block_int.h"
27 #include "qapi/qmp/qbool.h"
28 #include "qapi/qmp/qstring.h"
29 #include <curl/curl.h>
32 // #define DEBUG_VERBOSE
35 #define DPRINTF(fmt, ...) do { printf(fmt, ## __VA_ARGS__); } while (0)
37 #define DPRINTF(fmt, ...) do { } while (0)
40 #if LIBCURL_VERSION_NUM >= 0x071000
41 /* The multi interface timer callback was introduced in 7.16.0 */
42 #define NEED_CURL_TIMER_CALLBACK
43 #define HAVE_SOCKET_ACTION
46 #ifndef HAVE_SOCKET_ACTION
47 /* If curl_multi_socket_action isn't available, define it statically here in
48 * terms of curl_multi_socket. Note that ev_bitmask will be ignored, which is
49 * less efficient but still safe. */
50 static CURLMcode
__curl_multi_socket_action(CURLM
*multi_handle
,
55 return curl_multi_socket(multi_handle
, sockfd
, running_handles
);
57 #define curl_multi_socket_action __curl_multi_socket_action
60 #define PROTOCOLS (CURLPROTO_HTTP | CURLPROTO_HTTPS | \
61 CURLPROTO_FTP | CURLPROTO_FTPS | \
64 #define CURL_NUM_STATES 8
65 #define CURL_NUM_ACB 8
66 #define SECTOR_SIZE 512
67 #define READ_AHEAD_DEFAULT (256 * 1024)
68 #define CURL_TIMEOUT_DEFAULT 5
69 #define CURL_TIMEOUT_MAX 10000
71 #define FIND_RET_NONE 0
73 #define FIND_RET_WAIT 2
75 #define CURL_BLOCK_OPT_URL "url"
76 #define CURL_BLOCK_OPT_READAHEAD "readahead"
77 #define CURL_BLOCK_OPT_SSLVERIFY "sslverify"
78 #define CURL_BLOCK_OPT_TIMEOUT "timeout"
79 #define CURL_BLOCK_OPT_COOKIE "cookie"
83 typedef struct CURLAIOCB
{
95 typedef struct CURLState
97 struct BDRVCURLState
*s
;
98 CURLAIOCB
*acb
[CURL_NUM_ACB
];
100 curl_socket_t sock_fd
;
106 char errmsg
[CURL_ERROR_SIZE
];
110 typedef struct BDRVCURLState
{
114 CURLState states
[CURL_NUM_STATES
];
116 size_t readahead_size
;
121 AioContext
*aio_context
;
124 static void curl_clean_state(CURLState
*s
);
125 static void curl_multi_do(void *arg
);
126 static void curl_multi_read(void *arg
);
128 #ifdef NEED_CURL_TIMER_CALLBACK
129 static int curl_timer_cb(CURLM
*multi
, long timeout_ms
, void *opaque
)
131 BDRVCURLState
*s
= opaque
;
133 DPRINTF("CURL: timer callback timeout_ms %ld\n", timeout_ms
);
134 if (timeout_ms
== -1) {
135 timer_del(&s
->timer
);
137 int64_t timeout_ns
= (int64_t)timeout_ms
* 1000 * 1000;
139 qemu_clock_get_ns(QEMU_CLOCK_REALTIME
) + timeout_ns
);
145 static int curl_sock_cb(CURL
*curl
, curl_socket_t fd
, int action
,
146 void *userp
, void *sp
)
149 CURLState
*state
= NULL
;
150 curl_easy_getinfo(curl
, CURLINFO_PRIVATE
, (char **)&state
);
154 DPRINTF("CURL (AIO): Sock action %d on fd %d\n", action
, fd
);
157 aio_set_fd_handler(s
->aio_context
, fd
, false,
158 curl_multi_read
, NULL
, state
);
161 aio_set_fd_handler(s
->aio_context
, fd
, false,
162 NULL
, curl_multi_do
, state
);
164 case CURL_POLL_INOUT
:
165 aio_set_fd_handler(s
->aio_context
, fd
, false,
166 curl_multi_read
, curl_multi_do
, state
);
168 case CURL_POLL_REMOVE
:
169 aio_set_fd_handler(s
->aio_context
, fd
, false,
177 static size_t curl_header_cb(void *ptr
, size_t size
, size_t nmemb
, void *opaque
)
179 BDRVCURLState
*s
= opaque
;
180 size_t realsize
= size
* nmemb
;
181 const char *accept_line
= "Accept-Ranges: bytes";
183 if (realsize
>= strlen(accept_line
)
184 && strncmp((char *)ptr
, accept_line
, strlen(accept_line
)) == 0) {
185 s
->accept_range
= true;
191 static size_t curl_read_cb(void *ptr
, size_t size
, size_t nmemb
, void *opaque
)
193 CURLState
*s
= ((CURLState
*)opaque
);
194 size_t realsize
= size
* nmemb
;
197 DPRINTF("CURL: Just reading %zd bytes\n", realsize
);
199 if (!s
|| !s
->orig_buf
)
202 if (s
->buf_off
>= s
->buf_len
) {
203 /* buffer full, read nothing */
206 realsize
= MIN(realsize
, s
->buf_len
- s
->buf_off
);
207 memcpy(s
->orig_buf
+ s
->buf_off
, ptr
, realsize
);
208 s
->buf_off
+= realsize
;
210 for(i
=0; i
<CURL_NUM_ACB
; i
++) {
211 CURLAIOCB
*acb
= s
->acb
[i
];
216 if ((s
->buf_off
>= acb
->end
)) {
217 qemu_iovec_from_buf(acb
->qiov
, 0, s
->orig_buf
+ acb
->start
,
218 acb
->end
- acb
->start
);
219 acb
->common
.cb(acb
->common
.opaque
, 0);
228 static int curl_find_buf(BDRVCURLState
*s
, size_t start
, size_t len
,
232 size_t end
= start
+ len
;
234 for (i
=0; i
<CURL_NUM_STATES
; i
++) {
235 CURLState
*state
= &s
->states
[i
];
236 size_t buf_end
= (state
->buf_start
+ state
->buf_off
);
237 size_t buf_fend
= (state
->buf_start
+ state
->buf_len
);
239 if (!state
->orig_buf
)
244 // Does the existing buffer cover our section?
245 if ((start
>= state
->buf_start
) &&
246 (start
<= buf_end
) &&
247 (end
>= state
->buf_start
) &&
250 char *buf
= state
->orig_buf
+ (start
- state
->buf_start
);
252 qemu_iovec_from_buf(acb
->qiov
, 0, buf
, len
);
253 acb
->common
.cb(acb
->common
.opaque
, 0);
258 // Wait for unfinished chunks
260 (start
>= state
->buf_start
) &&
261 (start
<= buf_fend
) &&
262 (end
>= state
->buf_start
) &&
267 acb
->start
= start
- state
->buf_start
;
268 acb
->end
= acb
->start
+ len
;
270 for (j
=0; j
<CURL_NUM_ACB
; j
++) {
271 if (!state
->acb
[j
]) {
273 return FIND_RET_WAIT
;
279 return FIND_RET_NONE
;
282 static void curl_multi_check_completion(BDRVCURLState
*s
)
286 /* Try to find done transfers, so we can free the easy
290 msg
= curl_multi_info_read(s
->multi
, &msgs_in_queue
);
292 /* Quit when there are no more completions */
296 if (msg
->msg
== CURLMSG_DONE
) {
297 CURLState
*state
= NULL
;
298 curl_easy_getinfo(msg
->easy_handle
, CURLINFO_PRIVATE
,
301 /* ACBs for successful messages get completed in curl_read_cb */
302 if (msg
->data
.result
!= CURLE_OK
) {
304 static int errcount
= 100;
306 /* Don't lose the original error message from curl, since
307 * it contains extra data.
310 error_report("curl: %s", state
->errmsg
);
311 if (--errcount
== 0) {
312 error_report("curl: further errors suppressed");
316 for (i
= 0; i
< CURL_NUM_ACB
; i
++) {
317 CURLAIOCB
*acb
= state
->acb
[i
];
323 acb
->common
.cb(acb
->common
.opaque
, -EPROTO
);
325 state
->acb
[i
] = NULL
;
329 curl_clean_state(state
);
335 static void curl_multi_do(void *arg
)
337 CURLState
*s
= (CURLState
*)arg
;
346 r
= curl_multi_socket_action(s
->s
->multi
, s
->sock_fd
, 0, &running
);
347 } while(r
== CURLM_CALL_MULTI_PERFORM
);
351 static void curl_multi_read(void *arg
)
353 CURLState
*s
= (CURLState
*)arg
;
356 curl_multi_check_completion(s
->s
);
359 static void curl_multi_timeout_do(void *arg
)
361 #ifdef NEED_CURL_TIMER_CALLBACK
362 BDRVCURLState
*s
= (BDRVCURLState
*)arg
;
369 curl_multi_socket_action(s
->multi
, CURL_SOCKET_TIMEOUT
, 0, &running
);
371 curl_multi_check_completion(s
);
377 static CURLState
*curl_init_state(BlockDriverState
*bs
, BDRVCURLState
*s
)
379 CURLState
*state
= NULL
;
383 for (i
=0; i
<CURL_NUM_STATES
; i
++) {
384 for (j
=0; j
<CURL_NUM_ACB
; j
++)
385 if (s
->states
[i
].acb
[j
])
387 if (s
->states
[i
].in_use
)
390 state
= &s
->states
[i
];
395 aio_poll(bdrv_get_aio_context(bs
), true);
400 state
->curl
= curl_easy_init();
404 curl_easy_setopt(state
->curl
, CURLOPT_URL
, s
->url
);
405 curl_easy_setopt(state
->curl
, CURLOPT_SSL_VERIFYPEER
,
406 (long) s
->sslverify
);
408 curl_easy_setopt(state
->curl
, CURLOPT_COOKIE
, s
->cookie
);
410 curl_easy_setopt(state
->curl
, CURLOPT_TIMEOUT
, (long)s
->timeout
);
411 curl_easy_setopt(state
->curl
, CURLOPT_WRITEFUNCTION
,
412 (void *)curl_read_cb
);
413 curl_easy_setopt(state
->curl
, CURLOPT_WRITEDATA
, (void *)state
);
414 curl_easy_setopt(state
->curl
, CURLOPT_PRIVATE
, (void *)state
);
415 curl_easy_setopt(state
->curl
, CURLOPT_AUTOREFERER
, 1);
416 curl_easy_setopt(state
->curl
, CURLOPT_FOLLOWLOCATION
, 1);
417 curl_easy_setopt(state
->curl
, CURLOPT_NOSIGNAL
, 1);
418 curl_easy_setopt(state
->curl
, CURLOPT_ERRORBUFFER
, state
->errmsg
);
419 curl_easy_setopt(state
->curl
, CURLOPT_FAILONERROR
, 1);
421 /* Restrict supported protocols to avoid security issues in the more
422 * obscure protocols. For example, do not allow POP3/SMTP/IMAP see
425 * Restricting protocols is only supported from 7.19.4 upwards.
427 #if LIBCURL_VERSION_NUM >= 0x071304
428 curl_easy_setopt(state
->curl
, CURLOPT_PROTOCOLS
, PROTOCOLS
);
429 curl_easy_setopt(state
->curl
, CURLOPT_REDIR_PROTOCOLS
, PROTOCOLS
);
433 curl_easy_setopt(state
->curl
, CURLOPT_VERBOSE
, 1);
442 static void curl_clean_state(CURLState
*s
)
445 curl_multi_remove_handle(s
->s
->multi
, s
->curl
);
449 static void curl_parse_filename(const char *filename
, QDict
*options
,
452 qdict_put(options
, CURL_BLOCK_OPT_URL
, qstring_from_str(filename
));
455 static void curl_detach_aio_context(BlockDriverState
*bs
)
457 BDRVCURLState
*s
= bs
->opaque
;
460 for (i
= 0; i
< CURL_NUM_STATES
; i
++) {
461 if (s
->states
[i
].in_use
) {
462 curl_clean_state(&s
->states
[i
]);
464 if (s
->states
[i
].curl
) {
465 curl_easy_cleanup(s
->states
[i
].curl
);
466 s
->states
[i
].curl
= NULL
;
468 g_free(s
->states
[i
].orig_buf
);
469 s
->states
[i
].orig_buf
= NULL
;
472 curl_multi_cleanup(s
->multi
);
476 timer_del(&s
->timer
);
479 static void curl_attach_aio_context(BlockDriverState
*bs
,
480 AioContext
*new_context
)
482 BDRVCURLState
*s
= bs
->opaque
;
484 aio_timer_init(new_context
, &s
->timer
,
485 QEMU_CLOCK_REALTIME
, SCALE_NS
,
486 curl_multi_timeout_do
, s
);
489 s
->multi
= curl_multi_init();
490 s
->aio_context
= new_context
;
491 curl_multi_setopt(s
->multi
, CURLMOPT_SOCKETFUNCTION
, curl_sock_cb
);
492 #ifdef NEED_CURL_TIMER_CALLBACK
493 curl_multi_setopt(s
->multi
, CURLMOPT_TIMERDATA
, s
);
494 curl_multi_setopt(s
->multi
, CURLMOPT_TIMERFUNCTION
, curl_timer_cb
);
498 static QemuOptsList runtime_opts
= {
500 .head
= QTAILQ_HEAD_INITIALIZER(runtime_opts
.head
),
503 .name
= CURL_BLOCK_OPT_URL
,
504 .type
= QEMU_OPT_STRING
,
505 .help
= "URL to open",
508 .name
= CURL_BLOCK_OPT_READAHEAD
,
509 .type
= QEMU_OPT_SIZE
,
510 .help
= "Readahead size",
513 .name
= CURL_BLOCK_OPT_SSLVERIFY
,
514 .type
= QEMU_OPT_BOOL
,
515 .help
= "Verify SSL certificate"
518 .name
= CURL_BLOCK_OPT_TIMEOUT
,
519 .type
= QEMU_OPT_NUMBER
,
520 .help
= "Curl timeout"
523 .name
= CURL_BLOCK_OPT_COOKIE
,
524 .type
= QEMU_OPT_STRING
,
525 .help
= "Pass the cookie or list of cookies with each request"
527 { /* end of list */ }
531 static int curl_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
534 BDRVCURLState
*s
= bs
->opaque
;
535 CURLState
*state
= NULL
;
537 Error
*local_err
= NULL
;
542 static int inited
= 0;
544 if (flags
& BDRV_O_RDWR
) {
545 error_setg(errp
, "curl block device does not support writes");
549 opts
= qemu_opts_create(&runtime_opts
, NULL
, 0, &error_abort
);
550 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
552 error_propagate(errp
, local_err
);
556 s
->readahead_size
= qemu_opt_get_size(opts
, CURL_BLOCK_OPT_READAHEAD
,
558 if ((s
->readahead_size
& 0x1ff) != 0) {
559 error_setg(errp
, "HTTP_READAHEAD_SIZE %zd is not a multiple of 512",
564 s
->timeout
= qemu_opt_get_number(opts
, CURL_BLOCK_OPT_TIMEOUT
,
565 CURL_TIMEOUT_DEFAULT
);
566 if (s
->timeout
> CURL_TIMEOUT_MAX
) {
567 error_setg(errp
, "timeout parameter is too large or negative");
571 s
->sslverify
= qemu_opt_get_bool(opts
, CURL_BLOCK_OPT_SSLVERIFY
, true);
573 cookie
= qemu_opt_get(opts
, CURL_BLOCK_OPT_COOKIE
);
574 s
->cookie
= g_strdup(cookie
);
576 file
= qemu_opt_get(opts
, CURL_BLOCK_OPT_URL
);
578 error_setg(errp
, "curl block driver requires an 'url' option");
583 curl_global_init(CURL_GLOBAL_ALL
);
587 DPRINTF("CURL: Opening %s\n", file
);
588 s
->aio_context
= bdrv_get_aio_context(bs
);
589 s
->url
= g_strdup(file
);
590 state
= curl_init_state(bs
, s
);
596 s
->accept_range
= false;
597 curl_easy_setopt(state
->curl
, CURLOPT_NOBODY
, 1);
598 curl_easy_setopt(state
->curl
, CURLOPT_HEADERFUNCTION
,
600 curl_easy_setopt(state
->curl
, CURLOPT_HEADERDATA
, s
);
601 if (curl_easy_perform(state
->curl
))
603 curl_easy_getinfo(state
->curl
, CURLINFO_CONTENT_LENGTH_DOWNLOAD
, &d
);
608 if ((!strncasecmp(s
->url
, "http://", strlen("http://"))
609 || !strncasecmp(s
->url
, "https://", strlen("https://")))
610 && !s
->accept_range
) {
611 pstrcpy(state
->errmsg
, CURL_ERROR_SIZE
,
612 "Server does not support 'range' (byte ranges).");
615 DPRINTF("CURL: Size = %zd\n", s
->len
);
617 curl_clean_state(state
);
618 curl_easy_cleanup(state
->curl
);
621 curl_attach_aio_context(bs
, bdrv_get_aio_context(bs
));
627 error_setg(errp
, "CURL: Error opening file: %s", state
->errmsg
);
628 curl_easy_cleanup(state
->curl
);
637 static const AIOCBInfo curl_aiocb_info
= {
638 .aiocb_size
= sizeof(CURLAIOCB
),
642 static void curl_readv_bh_cb(void *p
)
648 BDRVCURLState
*s
= acb
->common
.bs
->opaque
;
650 qemu_bh_delete(acb
->bh
);
653 size_t start
= acb
->sector_num
* SECTOR_SIZE
;
656 // In case we have the requested data already (e.g. read-ahead),
657 // we can just call the callback and be done.
658 switch (curl_find_buf(s
, start
, acb
->nb_sectors
* SECTOR_SIZE
, acb
)) {
668 // No cache found, so let's start a new request
669 state
= curl_init_state(acb
->common
.bs
, s
);
671 acb
->common
.cb(acb
->common
.opaque
, -EIO
);
677 acb
->end
= (acb
->nb_sectors
* SECTOR_SIZE
);
680 g_free(state
->orig_buf
);
681 state
->buf_start
= start
;
682 state
->buf_len
= acb
->end
+ s
->readahead_size
;
683 end
= MIN(start
+ state
->buf_len
, s
->len
) - 1;
684 state
->orig_buf
= g_try_malloc(state
->buf_len
);
685 if (state
->buf_len
&& state
->orig_buf
== NULL
) {
686 curl_clean_state(state
);
687 acb
->common
.cb(acb
->common
.opaque
, -ENOMEM
);
693 snprintf(state
->range
, 127, "%zd-%zd", start
, end
);
694 DPRINTF("CURL (AIO): Reading %d at %zd (%s)\n",
695 (acb
->nb_sectors
* SECTOR_SIZE
), start
, state
->range
);
696 curl_easy_setopt(state
->curl
, CURLOPT_RANGE
, state
->range
);
698 curl_multi_add_handle(s
->multi
, state
->curl
);
700 /* Tell curl it needs to kick things off */
701 curl_multi_socket_action(s
->multi
, CURL_SOCKET_TIMEOUT
, 0, &running
);
704 static BlockAIOCB
*curl_aio_readv(BlockDriverState
*bs
,
705 int64_t sector_num
, QEMUIOVector
*qiov
, int nb_sectors
,
706 BlockCompletionFunc
*cb
, void *opaque
)
710 acb
= qemu_aio_get(&curl_aiocb_info
, bs
, cb
, opaque
);
713 acb
->sector_num
= sector_num
;
714 acb
->nb_sectors
= nb_sectors
;
716 acb
->bh
= aio_bh_new(bdrv_get_aio_context(bs
), curl_readv_bh_cb
, acb
);
717 qemu_bh_schedule(acb
->bh
);
721 static void curl_close(BlockDriverState
*bs
)
723 BDRVCURLState
*s
= bs
->opaque
;
725 DPRINTF("CURL: Close\n");
726 curl_detach_aio_context(bs
);
732 static int64_t curl_getlength(BlockDriverState
*bs
)
734 BDRVCURLState
*s
= bs
->opaque
;
738 static BlockDriver bdrv_http
= {
739 .format_name
= "http",
740 .protocol_name
= "http",
742 .instance_size
= sizeof(BDRVCURLState
),
743 .bdrv_parse_filename
= curl_parse_filename
,
744 .bdrv_file_open
= curl_open
,
745 .bdrv_close
= curl_close
,
746 .bdrv_getlength
= curl_getlength
,
748 .bdrv_aio_readv
= curl_aio_readv
,
750 .bdrv_detach_aio_context
= curl_detach_aio_context
,
751 .bdrv_attach_aio_context
= curl_attach_aio_context
,
754 static BlockDriver bdrv_https
= {
755 .format_name
= "https",
756 .protocol_name
= "https",
758 .instance_size
= sizeof(BDRVCURLState
),
759 .bdrv_parse_filename
= curl_parse_filename
,
760 .bdrv_file_open
= curl_open
,
761 .bdrv_close
= curl_close
,
762 .bdrv_getlength
= curl_getlength
,
764 .bdrv_aio_readv
= curl_aio_readv
,
766 .bdrv_detach_aio_context
= curl_detach_aio_context
,
767 .bdrv_attach_aio_context
= curl_attach_aio_context
,
770 static BlockDriver bdrv_ftp
= {
771 .format_name
= "ftp",
772 .protocol_name
= "ftp",
774 .instance_size
= sizeof(BDRVCURLState
),
775 .bdrv_parse_filename
= curl_parse_filename
,
776 .bdrv_file_open
= curl_open
,
777 .bdrv_close
= curl_close
,
778 .bdrv_getlength
= curl_getlength
,
780 .bdrv_aio_readv
= curl_aio_readv
,
782 .bdrv_detach_aio_context
= curl_detach_aio_context
,
783 .bdrv_attach_aio_context
= curl_attach_aio_context
,
786 static BlockDriver bdrv_ftps
= {
787 .format_name
= "ftps",
788 .protocol_name
= "ftps",
790 .instance_size
= sizeof(BDRVCURLState
),
791 .bdrv_parse_filename
= curl_parse_filename
,
792 .bdrv_file_open
= curl_open
,
793 .bdrv_close
= curl_close
,
794 .bdrv_getlength
= curl_getlength
,
796 .bdrv_aio_readv
= curl_aio_readv
,
798 .bdrv_detach_aio_context
= curl_detach_aio_context
,
799 .bdrv_attach_aio_context
= curl_attach_aio_context
,
802 static BlockDriver bdrv_tftp
= {
803 .format_name
= "tftp",
804 .protocol_name
= "tftp",
806 .instance_size
= sizeof(BDRVCURLState
),
807 .bdrv_parse_filename
= curl_parse_filename
,
808 .bdrv_file_open
= curl_open
,
809 .bdrv_close
= curl_close
,
810 .bdrv_getlength
= curl_getlength
,
812 .bdrv_aio_readv
= curl_aio_readv
,
814 .bdrv_detach_aio_context
= curl_detach_aio_context
,
815 .bdrv_attach_aio_context
= curl_attach_aio_context
,
818 static void curl_block_init(void)
820 bdrv_register(&bdrv_http
);
821 bdrv_register(&bdrv_https
);
822 bdrv_register(&bdrv_ftp
);
823 bdrv_register(&bdrv_ftps
);
824 bdrv_register(&bdrv_tftp
);
827 block_init(curl_block_init
);