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