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