]>
Commit | Line | Data |
---|---|---|
769ce76d AG |
1 | /* |
2 | * QEMU Block driver for CURL images | |
3 | * | |
4 | * Copyright (c) 2009 Alexander Graf <[email protected]> | |
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 | */ | |
24 | #include "qemu-common.h" | |
796a060b | 25 | #include "qemu/error-report.h" |
737e150e | 26 | #include "block/block_int.h" |
97a3ea57 | 27 | #include "qapi/qmp/qbool.h" |
d49b6836 | 28 | #include "qapi/qmp/qstring.h" |
769ce76d AG |
29 | #include <curl/curl.h> |
30 | ||
41c23467 | 31 | // #define DEBUG_CURL |
769ce76d AG |
32 | // #define DEBUG_VERBOSE |
33 | ||
34 | #ifdef DEBUG_CURL | |
d0f2c4c6 | 35 | #define DPRINTF(fmt, ...) do { printf(fmt, ## __VA_ARGS__); } while (0) |
769ce76d | 36 | #else |
d0f2c4c6 | 37 | #define DPRINTF(fmt, ...) do { } while (0) |
769ce76d AG |
38 | #endif |
39 | ||
031fd1be PM |
40 | #if LIBCURL_VERSION_NUM >= 0x071000 |
41 | /* The multi interface timer callback was introduced in 7.16.0 */ | |
42 | #define NEED_CURL_TIMER_CALLBACK | |
9aedd5a5 MB |
43 | #define HAVE_SOCKET_ACTION |
44 | #endif | |
45 | ||
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, | |
51 | curl_socket_t sockfd, | |
52 | int ev_bitmask, | |
53 | int *running_handles) | |
54 | { | |
55 | return curl_multi_socket(multi_handle, sockfd, running_handles); | |
56 | } | |
57 | #define curl_multi_socket_action __curl_multi_socket_action | |
031fd1be PM |
58 | #endif |
59 | ||
fb6d1bbd SH |
60 | #define PROTOCOLS (CURLPROTO_HTTP | CURLPROTO_HTTPS | \ |
61 | CURLPROTO_FTP | CURLPROTO_FTPS | \ | |
62 | CURLPROTO_TFTP) | |
63 | ||
769ce76d AG |
64 | #define CURL_NUM_STATES 8 |
65 | #define CURL_NUM_ACB 8 | |
66 | #define SECTOR_SIZE 512 | |
e3542c67 | 67 | #define READ_AHEAD_DEFAULT (256 * 1024) |
212aefaa | 68 | #define CURL_TIMEOUT_DEFAULT 5 |
f76faeda | 69 | #define CURL_TIMEOUT_MAX 10000 |
769ce76d AG |
70 | |
71 | #define FIND_RET_NONE 0 | |
72 | #define FIND_RET_OK 1 | |
73 | #define FIND_RET_WAIT 2 | |
74 | ||
e3542c67 MB |
75 | #define CURL_BLOCK_OPT_URL "url" |
76 | #define CURL_BLOCK_OPT_READAHEAD "readahead" | |
97a3ea57 | 77 | #define CURL_BLOCK_OPT_SSLVERIFY "sslverify" |
212aefaa | 78 | #define CURL_BLOCK_OPT_TIMEOUT "timeout" |
a94f83d9 | 79 | #define CURL_BLOCK_OPT_COOKIE "cookie" |
e3542c67 | 80 | |
769ce76d AG |
81 | struct BDRVCURLState; |
82 | ||
83 | typedef struct CURLAIOCB { | |
7c84b1b8 | 84 | BlockAIOCB common; |
363c3c85 | 85 | QEMUBH *bh; |
769ce76d | 86 | QEMUIOVector *qiov; |
363c3c85 NT |
87 | |
88 | int64_t sector_num; | |
89 | int nb_sectors; | |
90 | ||
769ce76d AG |
91 | size_t start; |
92 | size_t end; | |
93 | } CURLAIOCB; | |
94 | ||
95 | typedef struct CURLState | |
96 | { | |
97 | struct BDRVCURLState *s; | |
98 | CURLAIOCB *acb[CURL_NUM_ACB]; | |
99 | CURL *curl; | |
838ef602 | 100 | curl_socket_t sock_fd; |
769ce76d AG |
101 | char *orig_buf; |
102 | size_t buf_start; | |
103 | size_t buf_off; | |
104 | size_t buf_len; | |
105 | char range[128]; | |
106 | char errmsg[CURL_ERROR_SIZE]; | |
107 | char in_use; | |
108 | } CURLState; | |
109 | ||
110 | typedef struct BDRVCURLState { | |
111 | CURLM *multi; | |
031fd1be | 112 | QEMUTimer timer; |
769ce76d AG |
113 | size_t len; |
114 | CURLState states[CURL_NUM_STATES]; | |
115 | char *url; | |
c76f4952 | 116 | size_t readahead_size; |
97a3ea57 | 117 | bool sslverify; |
f76faeda | 118 | uint64_t timeout; |
a94f83d9 | 119 | char *cookie; |
3494d650 | 120 | bool accept_range; |
63f0f45f | 121 | AioContext *aio_context; |
769ce76d AG |
122 | } BDRVCURLState; |
123 | ||
124 | static void curl_clean_state(CURLState *s); | |
125 | static void curl_multi_do(void *arg); | |
838ef602 | 126 | static void curl_multi_read(void *arg); |
769ce76d | 127 | |
031fd1be PM |
128 | #ifdef NEED_CURL_TIMER_CALLBACK |
129 | static int curl_timer_cb(CURLM *multi, long timeout_ms, void *opaque) | |
130 | { | |
131 | BDRVCURLState *s = opaque; | |
132 | ||
133 | DPRINTF("CURL: timer callback timeout_ms %ld\n", timeout_ms); | |
134 | if (timeout_ms == -1) { | |
135 | timer_del(&s->timer); | |
136 | } else { | |
137 | int64_t timeout_ns = (int64_t)timeout_ms * 1000 * 1000; | |
138 | timer_mod(&s->timer, | |
139 | qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + timeout_ns); | |
140 | } | |
141 | return 0; | |
142 | } | |
143 | #endif | |
144 | ||
769ce76d | 145 | static int curl_sock_cb(CURL *curl, curl_socket_t fd, int action, |
63f0f45f | 146 | void *userp, void *sp) |
769ce76d | 147 | { |
63f0f45f | 148 | BDRVCURLState *s; |
838ef602 MB |
149 | CURLState *state = NULL; |
150 | curl_easy_getinfo(curl, CURLINFO_PRIVATE, (char **)&state); | |
151 | state->sock_fd = fd; | |
63f0f45f | 152 | s = state->s; |
838ef602 | 153 | |
d0f2c4c6 | 154 | DPRINTF("CURL (AIO): Sock action %d on fd %d\n", action, fd); |
769ce76d AG |
155 | switch (action) { |
156 | case CURL_POLL_IN: | |
dca21ef2 FZ |
157 | aio_set_fd_handler(s->aio_context, fd, false, |
158 | curl_multi_read, NULL, state); | |
769ce76d AG |
159 | break; |
160 | case CURL_POLL_OUT: | |
dca21ef2 FZ |
161 | aio_set_fd_handler(s->aio_context, fd, false, |
162 | NULL, curl_multi_do, state); | |
769ce76d AG |
163 | break; |
164 | case CURL_POLL_INOUT: | |
dca21ef2 FZ |
165 | aio_set_fd_handler(s->aio_context, fd, false, |
166 | curl_multi_read, curl_multi_do, state); | |
769ce76d AG |
167 | break; |
168 | case CURL_POLL_REMOVE: | |
dca21ef2 FZ |
169 | aio_set_fd_handler(s->aio_context, fd, false, |
170 | NULL, NULL, NULL); | |
769ce76d AG |
171 | break; |
172 | } | |
173 | ||
174 | return 0; | |
175 | } | |
176 | ||
3494d650 | 177 | static size_t curl_header_cb(void *ptr, size_t size, size_t nmemb, void *opaque) |
769ce76d | 178 | { |
3494d650 | 179 | BDRVCURLState *s = opaque; |
769ce76d | 180 | size_t realsize = size * nmemb; |
3494d650 | 181 | const char *accept_line = "Accept-Ranges: bytes"; |
769ce76d | 182 | |
3494d650 FZ |
183 | if (realsize >= strlen(accept_line) |
184 | && strncmp((char *)ptr, accept_line, strlen(accept_line)) == 0) { | |
185 | s->accept_range = true; | |
0bfcd599 | 186 | } |
769ce76d AG |
187 | |
188 | return realsize; | |
189 | } | |
190 | ||
191 | static size_t curl_read_cb(void *ptr, size_t size, size_t nmemb, void *opaque) | |
192 | { | |
193 | CURLState *s = ((CURLState*)opaque); | |
194 | size_t realsize = size * nmemb; | |
195 | int i; | |
196 | ||
0bfcd599 | 197 | DPRINTF("CURL: Just reading %zd bytes\n", realsize); |
769ce76d AG |
198 | |
199 | if (!s || !s->orig_buf) | |
38bbc0a5 | 200 | return 0; |
769ce76d | 201 | |
6d4b9e55 FZ |
202 | if (s->buf_off >= s->buf_len) { |
203 | /* buffer full, read nothing */ | |
204 | return 0; | |
205 | } | |
206 | realsize = MIN(realsize, s->buf_len - s->buf_off); | |
769ce76d AG |
207 | memcpy(s->orig_buf + s->buf_off, ptr, realsize); |
208 | s->buf_off += realsize; | |
209 | ||
210 | for(i=0; i<CURL_NUM_ACB; i++) { | |
211 | CURLAIOCB *acb = s->acb[i]; | |
212 | ||
213 | if (!acb) | |
214 | continue; | |
215 | ||
216 | if ((s->buf_off >= acb->end)) { | |
03396148 MT |
217 | qemu_iovec_from_buf(acb->qiov, 0, s->orig_buf + acb->start, |
218 | acb->end - acb->start); | |
769ce76d | 219 | acb->common.cb(acb->common.opaque, 0); |
8007429a | 220 | qemu_aio_unref(acb); |
769ce76d AG |
221 | s->acb[i] = NULL; |
222 | } | |
223 | } | |
224 | ||
769ce76d AG |
225 | return realsize; |
226 | } | |
227 | ||
228 | static int curl_find_buf(BDRVCURLState *s, size_t start, size_t len, | |
229 | CURLAIOCB *acb) | |
230 | { | |
231 | int i; | |
232 | size_t end = start + len; | |
233 | ||
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); | |
238 | ||
239 | if (!state->orig_buf) | |
240 | continue; | |
241 | if (!state->buf_off) | |
242 | continue; | |
243 | ||
244 | // Does the existing buffer cover our section? | |
245 | if ((start >= state->buf_start) && | |
246 | (start <= buf_end) && | |
247 | (end >= state->buf_start) && | |
248 | (end <= buf_end)) | |
249 | { | |
250 | char *buf = state->orig_buf + (start - state->buf_start); | |
251 | ||
03396148 | 252 | qemu_iovec_from_buf(acb->qiov, 0, buf, len); |
769ce76d AG |
253 | acb->common.cb(acb->common.opaque, 0); |
254 | ||
255 | return FIND_RET_OK; | |
256 | } | |
257 | ||
258 | // Wait for unfinished chunks | |
b7079df4 MB |
259 | if (state->in_use && |
260 | (start >= state->buf_start) && | |
769ce76d AG |
261 | (start <= buf_fend) && |
262 | (end >= state->buf_start) && | |
263 | (end <= buf_fend)) | |
264 | { | |
265 | int j; | |
266 | ||
267 | acb->start = start - state->buf_start; | |
268 | acb->end = acb->start + len; | |
269 | ||
270 | for (j=0; j<CURL_NUM_ACB; j++) { | |
271 | if (!state->acb[j]) { | |
272 | state->acb[j] = acb; | |
273 | return FIND_RET_WAIT; | |
274 | } | |
275 | } | |
276 | } | |
277 | } | |
278 | ||
279 | return FIND_RET_NONE; | |
280 | } | |
281 | ||
838ef602 | 282 | static void curl_multi_check_completion(BDRVCURLState *s) |
769ce76d | 283 | { |
769ce76d AG |
284 | int msgs_in_queue; |
285 | ||
769ce76d AG |
286 | /* Try to find done transfers, so we can free the easy |
287 | * handle again. */ | |
1f2cead3 | 288 | for (;;) { |
769ce76d AG |
289 | CURLMsg *msg; |
290 | msg = curl_multi_info_read(s->multi, &msgs_in_queue); | |
291 | ||
1f2cead3 | 292 | /* Quit when there are no more completions */ |
769ce76d AG |
293 | if (!msg) |
294 | break; | |
769ce76d | 295 | |
1f2cead3 MB |
296 | if (msg->msg == CURLMSG_DONE) { |
297 | CURLState *state = NULL; | |
298 | curl_easy_getinfo(msg->easy_handle, CURLINFO_PRIVATE, | |
299 | (char **)&state); | |
300 | ||
301 | /* ACBs for successful messages get completed in curl_read_cb */ | |
302 | if (msg->data.result != CURLE_OK) { | |
303 | int i; | |
796a060b RJ |
304 | static int errcount = 100; |
305 | ||
306 | /* Don't lose the original error message from curl, since | |
307 | * it contains extra data. | |
308 | */ | |
309 | if (errcount > 0) { | |
310 | error_report("curl: %s", state->errmsg); | |
311 | if (--errcount == 0) { | |
312 | error_report("curl: further errors suppressed"); | |
313 | } | |
314 | } | |
315 | ||
1f2cead3 MB |
316 | for (i = 0; i < CURL_NUM_ACB; i++) { |
317 | CURLAIOCB *acb = state->acb[i]; | |
318 | ||
319 | if (acb == NULL) { | |
320 | continue; | |
f785a5ae | 321 | } |
f785a5ae | 322 | |
796a060b | 323 | acb->common.cb(acb->common.opaque, -EPROTO); |
8007429a | 324 | qemu_aio_unref(acb); |
1f2cead3 MB |
325 | state->acb[i] = NULL; |
326 | } | |
769ce76d | 327 | } |
1f2cead3 MB |
328 | |
329 | curl_clean_state(state); | |
330 | break; | |
769ce76d | 331 | } |
1f2cead3 | 332 | } |
769ce76d AG |
333 | } |
334 | ||
031fd1be PM |
335 | static void curl_multi_do(void *arg) |
336 | { | |
838ef602 | 337 | CURLState *s = (CURLState *)arg; |
031fd1be PM |
338 | int running; |
339 | int r; | |
340 | ||
838ef602 | 341 | if (!s->s->multi) { |
031fd1be PM |
342 | return; |
343 | } | |
344 | ||
345 | do { | |
838ef602 | 346 | r = curl_multi_socket_action(s->s->multi, s->sock_fd, 0, &running); |
031fd1be PM |
347 | } while(r == CURLM_CALL_MULTI_PERFORM); |
348 | ||
838ef602 MB |
349 | } |
350 | ||
351 | static void curl_multi_read(void *arg) | |
352 | { | |
353 | CURLState *s = (CURLState *)arg; | |
354 | ||
355 | curl_multi_do(arg); | |
356 | curl_multi_check_completion(s->s); | |
031fd1be PM |
357 | } |
358 | ||
359 | static void curl_multi_timeout_do(void *arg) | |
360 | { | |
361 | #ifdef NEED_CURL_TIMER_CALLBACK | |
362 | BDRVCURLState *s = (BDRVCURLState *)arg; | |
363 | int running; | |
364 | ||
365 | if (!s->multi) { | |
366 | return; | |
367 | } | |
368 | ||
369 | curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running); | |
370 | ||
838ef602 | 371 | curl_multi_check_completion(s); |
031fd1be PM |
372 | #else |
373 | abort(); | |
374 | #endif | |
375 | } | |
376 | ||
a2f468e4 | 377 | static CURLState *curl_init_state(BlockDriverState *bs, BDRVCURLState *s) |
769ce76d AG |
378 | { |
379 | CURLState *state = NULL; | |
380 | int i, j; | |
381 | ||
382 | do { | |
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]) | |
386 | continue; | |
387 | if (s->states[i].in_use) | |
388 | continue; | |
389 | ||
390 | state = &s->states[i]; | |
391 | state->in_use = 1; | |
392 | break; | |
393 | } | |
394 | if (!state) { | |
a2f468e4 | 395 | aio_poll(bdrv_get_aio_context(bs), true); |
769ce76d AG |
396 | } |
397 | } while(!state); | |
398 | ||
9e550b32 MB |
399 | if (!state->curl) { |
400 | state->curl = curl_easy_init(); | |
401 | if (!state->curl) { | |
402 | return NULL; | |
403 | } | |
404 | curl_easy_setopt(state->curl, CURLOPT_URL, s->url); | |
97a3ea57 MB |
405 | curl_easy_setopt(state->curl, CURLOPT_SSL_VERIFYPEER, |
406 | (long) s->sslverify); | |
a94f83d9 RJ |
407 | if (s->cookie) { |
408 | curl_easy_setopt(state->curl, CURLOPT_COOKIE, s->cookie); | |
409 | } | |
f76faeda | 410 | curl_easy_setopt(state->curl, CURLOPT_TIMEOUT, (long)s->timeout); |
9e550b32 MB |
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); | |
420 | ||
421 | /* Restrict supported protocols to avoid security issues in the more | |
422 | * obscure protocols. For example, do not allow POP3/SMTP/IMAP see | |
423 | * CVE-2013-0249. | |
424 | * | |
425 | * Restricting protocols is only supported from 7.19.4 upwards. | |
426 | */ | |
8a8f5840 | 427 | #if LIBCURL_VERSION_NUM >= 0x071304 |
9e550b32 MB |
428 | curl_easy_setopt(state->curl, CURLOPT_PROTOCOLS, PROTOCOLS); |
429 | curl_easy_setopt(state->curl, CURLOPT_REDIR_PROTOCOLS, PROTOCOLS); | |
8a8f5840 | 430 | #endif |
fb6d1bbd | 431 | |
769ce76d | 432 | #ifdef DEBUG_VERBOSE |
9e550b32 | 433 | curl_easy_setopt(state->curl, CURLOPT_VERBOSE, 1); |
769ce76d | 434 | #endif |
9e550b32 | 435 | } |
769ce76d AG |
436 | |
437 | state->s = s; | |
438 | ||
439 | return state; | |
440 | } | |
441 | ||
442 | static void curl_clean_state(CURLState *s) | |
443 | { | |
444 | if (s->s->multi) | |
445 | curl_multi_remove_handle(s->s->multi, s->curl); | |
446 | s->in_use = 0; | |
447 | } | |
448 | ||
8e6d58cd KW |
449 | static void curl_parse_filename(const char *filename, QDict *options, |
450 | Error **errp) | |
769ce76d | 451 | { |
e3542c67 | 452 | qdict_put(options, CURL_BLOCK_OPT_URL, qstring_from_str(filename)); |
8e6d58cd KW |
453 | } |
454 | ||
63f0f45f SH |
455 | static void curl_detach_aio_context(BlockDriverState *bs) |
456 | { | |
457 | BDRVCURLState *s = bs->opaque; | |
458 | int i; | |
459 | ||
460 | for (i = 0; i < CURL_NUM_STATES; i++) { | |
461 | if (s->states[i].in_use) { | |
462 | curl_clean_state(&s->states[i]); | |
463 | } | |
464 | if (s->states[i].curl) { | |
465 | curl_easy_cleanup(s->states[i].curl); | |
466 | s->states[i].curl = NULL; | |
467 | } | |
f7047c2d MA |
468 | g_free(s->states[i].orig_buf); |
469 | s->states[i].orig_buf = NULL; | |
63f0f45f SH |
470 | } |
471 | if (s->multi) { | |
472 | curl_multi_cleanup(s->multi); | |
473 | s->multi = NULL; | |
474 | } | |
475 | ||
476 | timer_del(&s->timer); | |
477 | } | |
478 | ||
479 | static void curl_attach_aio_context(BlockDriverState *bs, | |
480 | AioContext *new_context) | |
481 | { | |
482 | BDRVCURLState *s = bs->opaque; | |
483 | ||
484 | aio_timer_init(new_context, &s->timer, | |
485 | QEMU_CLOCK_REALTIME, SCALE_NS, | |
486 | curl_multi_timeout_do, s); | |
487 | ||
488 | assert(!s->multi); | |
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); | |
495 | #endif | |
496 | } | |
497 | ||
8e6d58cd KW |
498 | static QemuOptsList runtime_opts = { |
499 | .name = "curl", | |
500 | .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head), | |
501 | .desc = { | |
502 | { | |
e3542c67 | 503 | .name = CURL_BLOCK_OPT_URL, |
8e6d58cd KW |
504 | .type = QEMU_OPT_STRING, |
505 | .help = "URL to open", | |
506 | }, | |
507 | { | |
e3542c67 | 508 | .name = CURL_BLOCK_OPT_READAHEAD, |
8e6d58cd KW |
509 | .type = QEMU_OPT_SIZE, |
510 | .help = "Readahead size", | |
511 | }, | |
97a3ea57 MB |
512 | { |
513 | .name = CURL_BLOCK_OPT_SSLVERIFY, | |
514 | .type = QEMU_OPT_BOOL, | |
515 | .help = "Verify SSL certificate" | |
516 | }, | |
212aefaa DHB |
517 | { |
518 | .name = CURL_BLOCK_OPT_TIMEOUT, | |
519 | .type = QEMU_OPT_NUMBER, | |
520 | .help = "Curl timeout" | |
521 | }, | |
a94f83d9 RJ |
522 | { |
523 | .name = CURL_BLOCK_OPT_COOKIE, | |
524 | .type = QEMU_OPT_STRING, | |
525 | .help = "Pass the cookie or list of cookies with each request" | |
526 | }, | |
8e6d58cd KW |
527 | { /* end of list */ } |
528 | }, | |
529 | }; | |
530 | ||
015a1036 HR |
531 | static int curl_open(BlockDriverState *bs, QDict *options, int flags, |
532 | Error **errp) | |
8e6d58cd KW |
533 | { |
534 | BDRVCURLState *s = bs->opaque; | |
535 | CURLState *state = NULL; | |
536 | QemuOpts *opts; | |
537 | Error *local_err = NULL; | |
538 | const char *file; | |
a94f83d9 | 539 | const char *cookie; |
8e6d58cd KW |
540 | double d; |
541 | ||
542 | static int inited = 0; | |
543 | ||
a7cea2ba | 544 | if (flags & BDRV_O_RDWR) { |
2a94fee3 | 545 | error_setg(errp, "curl block device does not support writes"); |
a7cea2ba RJ |
546 | return -EROFS; |
547 | } | |
548 | ||
87ea75d5 | 549 | opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort); |
8e6d58cd | 550 | qemu_opts_absorb_qdict(opts, options, &local_err); |
84d18f06 | 551 | if (local_err) { |
2a94fee3 | 552 | error_propagate(errp, local_err); |
8e6d58cd KW |
553 | goto out_noclean; |
554 | } | |
555 | ||
e3542c67 MB |
556 | s->readahead_size = qemu_opt_get_size(opts, CURL_BLOCK_OPT_READAHEAD, |
557 | READ_AHEAD_DEFAULT); | |
c76f4952 | 558 | if ((s->readahead_size & 0x1ff) != 0) { |
2a94fee3 PB |
559 | error_setg(errp, "HTTP_READAHEAD_SIZE %zd is not a multiple of 512", |
560 | s->readahead_size); | |
c76f4952 N |
561 | goto out_noclean; |
562 | } | |
563 | ||
212aefaa DHB |
564 | s->timeout = qemu_opt_get_number(opts, CURL_BLOCK_OPT_TIMEOUT, |
565 | CURL_TIMEOUT_DEFAULT); | |
f76faeda RJ |
566 | if (s->timeout > CURL_TIMEOUT_MAX) { |
567 | error_setg(errp, "timeout parameter is too large or negative"); | |
568 | goto out_noclean; | |
569 | } | |
212aefaa | 570 | |
97a3ea57 MB |
571 | s->sslverify = qemu_opt_get_bool(opts, CURL_BLOCK_OPT_SSLVERIFY, true); |
572 | ||
a94f83d9 RJ |
573 | cookie = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE); |
574 | s->cookie = g_strdup(cookie); | |
575 | ||
e3542c67 | 576 | file = qemu_opt_get(opts, CURL_BLOCK_OPT_URL); |
8e6d58cd | 577 | if (file == NULL) { |
2a94fee3 | 578 | error_setg(errp, "curl block driver requires an 'url' option"); |
8e6d58cd KW |
579 | goto out_noclean; |
580 | } | |
581 | ||
769ce76d AG |
582 | if (!inited) { |
583 | curl_global_init(CURL_GLOBAL_ALL); | |
584 | inited = 1; | |
585 | } | |
586 | ||
d0f2c4c6 | 587 | DPRINTF("CURL: Opening %s\n", file); |
63f0f45f | 588 | s->aio_context = bdrv_get_aio_context(bs); |
8e6d58cd | 589 | s->url = g_strdup(file); |
a2f468e4 | 590 | state = curl_init_state(bs, s); |
769ce76d AG |
591 | if (!state) |
592 | goto out_noclean; | |
593 | ||
594 | // Get file size | |
595 | ||
3494d650 | 596 | s->accept_range = false; |
769ce76d | 597 | curl_easy_setopt(state->curl, CURLOPT_NOBODY, 1); |
3494d650 FZ |
598 | curl_easy_setopt(state->curl, CURLOPT_HEADERFUNCTION, |
599 | curl_header_cb); | |
600 | curl_easy_setopt(state->curl, CURLOPT_HEADERDATA, s); | |
769ce76d AG |
601 | if (curl_easy_perform(state->curl)) |
602 | goto out; | |
603 | curl_easy_getinfo(state->curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &d); | |
769ce76d AG |
604 | if (d) |
605 | s->len = (size_t)d; | |
606 | else if(!s->len) | |
607 | goto out; | |
3494d650 FZ |
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)."); | |
613 | goto out; | |
614 | } | |
0bfcd599 | 615 | DPRINTF("CURL: Size = %zd\n", s->len); |
769ce76d AG |
616 | |
617 | curl_clean_state(state); | |
618 | curl_easy_cleanup(state->curl); | |
619 | state->curl = NULL; | |
620 | ||
63f0f45f | 621 | curl_attach_aio_context(bs, bdrv_get_aio_context(bs)); |
769ce76d | 622 | |
8e6d58cd | 623 | qemu_opts_del(opts); |
769ce76d AG |
624 | return 0; |
625 | ||
626 | out: | |
acd7fdc6 | 627 | error_setg(errp, "CURL: Error opening file: %s", state->errmsg); |
769ce76d AG |
628 | curl_easy_cleanup(state->curl); |
629 | state->curl = NULL; | |
630 | out_noclean: | |
a94f83d9 | 631 | g_free(s->cookie); |
8e6d58cd KW |
632 | g_free(s->url); |
633 | qemu_opts_del(opts); | |
769ce76d AG |
634 | return -EINVAL; |
635 | } | |
636 | ||
d7331bed | 637 | static const AIOCBInfo curl_aiocb_info = { |
c16b5a2c | 638 | .aiocb_size = sizeof(CURLAIOCB), |
c16b5a2c CH |
639 | }; |
640 | ||
363c3c85 NT |
641 | |
642 | static void curl_readv_bh_cb(void *p) | |
769ce76d | 643 | { |
769ce76d | 644 | CURLState *state; |
b69cdef8 | 645 | int running; |
769ce76d | 646 | |
363c3c85 NT |
647 | CURLAIOCB *acb = p; |
648 | BDRVCURLState *s = acb->common.bs->opaque; | |
769ce76d | 649 | |
363c3c85 NT |
650 | qemu_bh_delete(acb->bh); |
651 | acb->bh = NULL; | |
652 | ||
653 | size_t start = acb->sector_num * SECTOR_SIZE; | |
654 | size_t end; | |
769ce76d AG |
655 | |
656 | // In case we have the requested data already (e.g. read-ahead), | |
657 | // we can just call the callback and be done. | |
363c3c85 | 658 | switch (curl_find_buf(s, start, acb->nb_sectors * SECTOR_SIZE, acb)) { |
769ce76d | 659 | case FIND_RET_OK: |
8007429a | 660 | qemu_aio_unref(acb); |
769ce76d AG |
661 | // fall through |
662 | case FIND_RET_WAIT: | |
363c3c85 | 663 | return; |
769ce76d AG |
664 | default: |
665 | break; | |
666 | } | |
667 | ||
668 | // No cache found, so let's start a new request | |
a2f468e4 | 669 | state = curl_init_state(acb->common.bs, s); |
363c3c85 NT |
670 | if (!state) { |
671 | acb->common.cb(acb->common.opaque, -EIO); | |
8007429a | 672 | qemu_aio_unref(acb); |
363c3c85 NT |
673 | return; |
674 | } | |
769ce76d AG |
675 | |
676 | acb->start = 0; | |
363c3c85 | 677 | acb->end = (acb->nb_sectors * SECTOR_SIZE); |
769ce76d AG |
678 | |
679 | state->buf_off = 0; | |
f7047c2d | 680 | g_free(state->orig_buf); |
769ce76d | 681 | state->buf_start = start; |
c76f4952 | 682 | state->buf_len = acb->end + s->readahead_size; |
769ce76d | 683 | end = MIN(start + state->buf_len, s->len) - 1; |
8dc7a772 KW |
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); | |
8007429a | 688 | qemu_aio_unref(acb); |
8dc7a772 KW |
689 | return; |
690 | } | |
769ce76d AG |
691 | state->acb[0] = acb; |
692 | ||
0bfcd599 BS |
693 | snprintf(state->range, 127, "%zd-%zd", start, end); |
694 | DPRINTF("CURL (AIO): Reading %d at %zd (%s)\n", | |
363c3c85 | 695 | (acb->nb_sectors * SECTOR_SIZE), start, state->range); |
769ce76d AG |
696 | curl_easy_setopt(state->curl, CURLOPT_RANGE, state->range); |
697 | ||
698 | curl_multi_add_handle(s->multi, state->curl); | |
769ce76d | 699 | |
b69cdef8 MB |
700 | /* Tell curl it needs to kick things off */ |
701 | curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running); | |
363c3c85 NT |
702 | } |
703 | ||
7c84b1b8 | 704 | static BlockAIOCB *curl_aio_readv(BlockDriverState *bs, |
363c3c85 | 705 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, |
097310b5 | 706 | BlockCompletionFunc *cb, void *opaque) |
363c3c85 NT |
707 | { |
708 | CURLAIOCB *acb; | |
709 | ||
d7331bed | 710 | acb = qemu_aio_get(&curl_aiocb_info, bs, cb, opaque); |
363c3c85 | 711 | |
363c3c85 NT |
712 | acb->qiov = qiov; |
713 | acb->sector_num = sector_num; | |
714 | acb->nb_sectors = nb_sectors; | |
715 | ||
63f0f45f | 716 | acb->bh = aio_bh_new(bdrv_get_aio_context(bs), curl_readv_bh_cb, acb); |
363c3c85 | 717 | qemu_bh_schedule(acb->bh); |
769ce76d AG |
718 | return &acb->common; |
719 | } | |
720 | ||
769ce76d AG |
721 | static void curl_close(BlockDriverState *bs) |
722 | { | |
723 | BDRVCURLState *s = bs->opaque; | |
769ce76d | 724 | |
d0f2c4c6 | 725 | DPRINTF("CURL: Close\n"); |
63f0f45f | 726 | curl_detach_aio_context(bs); |
031fd1be | 727 | |
a94f83d9 | 728 | g_free(s->cookie); |
45724d6d | 729 | g_free(s->url); |
769ce76d AG |
730 | } |
731 | ||
732 | static int64_t curl_getlength(BlockDriverState *bs) | |
733 | { | |
734 | BDRVCURLState *s = bs->opaque; | |
735 | return s->len; | |
736 | } | |
737 | ||
738 | static BlockDriver bdrv_http = { | |
63f0f45f SH |
739 | .format_name = "http", |
740 | .protocol_name = "http", | |
741 | ||
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, | |
769ce76d | 747 | |
63f0f45f | 748 | .bdrv_aio_readv = curl_aio_readv, |
769ce76d | 749 | |
63f0f45f SH |
750 | .bdrv_detach_aio_context = curl_detach_aio_context, |
751 | .bdrv_attach_aio_context = curl_attach_aio_context, | |
769ce76d AG |
752 | }; |
753 | ||
754 | static BlockDriver bdrv_https = { | |
63f0f45f SH |
755 | .format_name = "https", |
756 | .protocol_name = "https", | |
769ce76d | 757 | |
63f0f45f SH |
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, | |
769ce76d | 763 | |
63f0f45f SH |
764 | .bdrv_aio_readv = curl_aio_readv, |
765 | ||
766 | .bdrv_detach_aio_context = curl_detach_aio_context, | |
767 | .bdrv_attach_aio_context = curl_attach_aio_context, | |
769ce76d AG |
768 | }; |
769 | ||
770 | static BlockDriver bdrv_ftp = { | |
63f0f45f SH |
771 | .format_name = "ftp", |
772 | .protocol_name = "ftp", | |
773 | ||
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, | |
769ce76d | 779 | |
63f0f45f | 780 | .bdrv_aio_readv = curl_aio_readv, |
769ce76d | 781 | |
63f0f45f SH |
782 | .bdrv_detach_aio_context = curl_detach_aio_context, |
783 | .bdrv_attach_aio_context = curl_attach_aio_context, | |
769ce76d AG |
784 | }; |
785 | ||
786 | static BlockDriver bdrv_ftps = { | |
63f0f45f SH |
787 | .format_name = "ftps", |
788 | .protocol_name = "ftps", | |
769ce76d | 789 | |
63f0f45f SH |
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, | |
769ce76d | 795 | |
63f0f45f SH |
796 | .bdrv_aio_readv = curl_aio_readv, |
797 | ||
798 | .bdrv_detach_aio_context = curl_detach_aio_context, | |
799 | .bdrv_attach_aio_context = curl_attach_aio_context, | |
769ce76d AG |
800 | }; |
801 | ||
802 | static BlockDriver bdrv_tftp = { | |
63f0f45f SH |
803 | .format_name = "tftp", |
804 | .protocol_name = "tftp", | |
805 | ||
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, | |
769ce76d | 811 | |
63f0f45f | 812 | .bdrv_aio_readv = curl_aio_readv, |
769ce76d | 813 | |
63f0f45f SH |
814 | .bdrv_detach_aio_context = curl_detach_aio_context, |
815 | .bdrv_attach_aio_context = curl_attach_aio_context, | |
769ce76d AG |
816 | }; |
817 | ||
818 | static void curl_block_init(void) | |
819 | { | |
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); | |
825 | } | |
826 | ||
827 | block_init(curl_block_init); |