xref: /openbmc/qemu/block/curl.c (revision 46f5ac205a9dc5e2c24274c7df371509a286281f)
1769ce76dSAlexander Graf /*
2769ce76dSAlexander Graf  * QEMU Block driver for CURL images
3769ce76dSAlexander Graf  *
4769ce76dSAlexander Graf  * Copyright (c) 2009 Alexander Graf <agraf@suse.de>
5769ce76dSAlexander Graf  *
6769ce76dSAlexander Graf  * Permission is hereby granted, free of charge, to any person obtaining a copy
7769ce76dSAlexander Graf  * of this software and associated documentation files (the "Software"), to deal
8769ce76dSAlexander Graf  * in the Software without restriction, including without limitation the rights
9769ce76dSAlexander Graf  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10769ce76dSAlexander Graf  * copies of the Software, and to permit persons to whom the Software is
11769ce76dSAlexander Graf  * furnished to do so, subject to the following conditions:
12769ce76dSAlexander Graf  *
13769ce76dSAlexander Graf  * The above copyright notice and this permission notice shall be included in
14769ce76dSAlexander Graf  * all copies or substantial portions of the Software.
15769ce76dSAlexander Graf  *
16769ce76dSAlexander Graf  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17769ce76dSAlexander Graf  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18769ce76dSAlexander Graf  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19769ce76dSAlexander Graf  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20769ce76dSAlexander Graf  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21769ce76dSAlexander Graf  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22769ce76dSAlexander Graf  * THE SOFTWARE.
23769ce76dSAlexander Graf  */
2480c71a24SPeter Maydell #include "qemu/osdep.h"
25da34e65cSMarkus Armbruster #include "qapi/error.h"
26769ce76dSAlexander Graf #include "qemu-common.h"
27796a060bSRichard W.M. Jones #include "qemu/error-report.h"
28737e150eSPaolo Bonzini #include "block/block_int.h"
2997a3ea57SMatthew Booth #include "qapi/qmp/qbool.h"
30d49b6836SMarkus Armbruster #include "qapi/qmp/qstring.h"
311bff9606SDaniel P. Berrange #include "crypto/secret.h"
32769ce76dSAlexander Graf #include <curl/curl.h>
33f348b6d1SVeronia Bahaa #include "qemu/cutils.h"
34769ce76dSAlexander Graf 
3541c23467SRichard W.M. Jones // #define DEBUG_CURL
36769ce76dSAlexander Graf // #define DEBUG_VERBOSE
37769ce76dSAlexander Graf 
38769ce76dSAlexander Graf #ifdef DEBUG_CURL
39ed79f37dSZhou Jie #define DEBUG_CURL_PRINT 1
40769ce76dSAlexander Graf #else
41ed79f37dSZhou Jie #define DEBUG_CURL_PRINT 0
42769ce76dSAlexander Graf #endif
43ed79f37dSZhou Jie #define DPRINTF(fmt, ...)                                            \
44ed79f37dSZhou Jie     do {                                                             \
45ed79f37dSZhou Jie         if (DEBUG_CURL_PRINT) {                                      \
46ed79f37dSZhou Jie             fprintf(stderr, fmt, ## __VA_ARGS__);                    \
47ed79f37dSZhou Jie         }                                                            \
48ed79f37dSZhou Jie     } while (0)
49769ce76dSAlexander Graf 
50031fd1beSPeter Maydell #if LIBCURL_VERSION_NUM >= 0x071000
51031fd1beSPeter Maydell /* The multi interface timer callback was introduced in 7.16.0 */
52031fd1beSPeter Maydell #define NEED_CURL_TIMER_CALLBACK
539aedd5a5SMatthew Booth #define HAVE_SOCKET_ACTION
549aedd5a5SMatthew Booth #endif
559aedd5a5SMatthew Booth 
569aedd5a5SMatthew Booth #ifndef HAVE_SOCKET_ACTION
579aedd5a5SMatthew Booth /* If curl_multi_socket_action isn't available, define it statically here in
589aedd5a5SMatthew Booth  * terms of curl_multi_socket. Note that ev_bitmask will be ignored, which is
599aedd5a5SMatthew Booth  * less efficient but still safe. */
609aedd5a5SMatthew Booth static CURLMcode __curl_multi_socket_action(CURLM *multi_handle,
619aedd5a5SMatthew Booth                                             curl_socket_t sockfd,
629aedd5a5SMatthew Booth                                             int ev_bitmask,
639aedd5a5SMatthew Booth                                             int *running_handles)
649aedd5a5SMatthew Booth {
659aedd5a5SMatthew Booth     return curl_multi_socket(multi_handle, sockfd, running_handles);
669aedd5a5SMatthew Booth }
679aedd5a5SMatthew Booth #define curl_multi_socket_action __curl_multi_socket_action
68031fd1beSPeter Maydell #endif
69031fd1beSPeter Maydell 
70fb6d1bbdSStefan Hajnoczi #define PROTOCOLS (CURLPROTO_HTTP | CURLPROTO_HTTPS | \
7123dce387SMax Reitz                    CURLPROTO_FTP | CURLPROTO_FTPS)
72fb6d1bbdSStefan Hajnoczi 
73769ce76dSAlexander Graf #define CURL_NUM_STATES 8
74769ce76dSAlexander Graf #define CURL_NUM_ACB    8
75e3542c67SMatthew Booth #define READ_AHEAD_DEFAULT (256 * 1024)
76212aefaaSDaniel Henrique Barboza #define CURL_TIMEOUT_DEFAULT 5
77f76faedaSRichard W.M. Jones #define CURL_TIMEOUT_MAX 10000
78769ce76dSAlexander Graf 
79769ce76dSAlexander Graf #define FIND_RET_NONE   0
80769ce76dSAlexander Graf #define FIND_RET_OK     1
81769ce76dSAlexander Graf #define FIND_RET_WAIT   2
82769ce76dSAlexander Graf 
83e3542c67SMatthew Booth #define CURL_BLOCK_OPT_URL       "url"
84e3542c67SMatthew Booth #define CURL_BLOCK_OPT_READAHEAD "readahead"
8597a3ea57SMatthew Booth #define CURL_BLOCK_OPT_SSLVERIFY "sslverify"
86212aefaaSDaniel Henrique Barboza #define CURL_BLOCK_OPT_TIMEOUT "timeout"
87a94f83d9SRichard W.M. Jones #define CURL_BLOCK_OPT_COOKIE    "cookie"
881bff9606SDaniel P. Berrange #define CURL_BLOCK_OPT_USERNAME "username"
891bff9606SDaniel P. Berrange #define CURL_BLOCK_OPT_PASSWORD_SECRET "password-secret"
901bff9606SDaniel P. Berrange #define CURL_BLOCK_OPT_PROXY_USERNAME "proxy-username"
911bff9606SDaniel P. Berrange #define CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET "proxy-password-secret"
92e3542c67SMatthew Booth 
93769ce76dSAlexander Graf struct BDRVCURLState;
94769ce76dSAlexander Graf 
95769ce76dSAlexander Graf typedef struct CURLAIOCB {
967c84b1b8SMarkus Armbruster     BlockAIOCB common;
97769ce76dSAlexander Graf     QEMUIOVector *qiov;
98363c3c85SNick Thomas 
99363c3c85SNick Thomas     int64_t sector_num;
100363c3c85SNick Thomas     int nb_sectors;
101363c3c85SNick Thomas 
102769ce76dSAlexander Graf     size_t start;
103769ce76dSAlexander Graf     size_t end;
104769ce76dSAlexander Graf } CURLAIOCB;
105769ce76dSAlexander Graf 
106ff5ca166SMax Reitz typedef struct CURLSocket {
107ff5ca166SMax Reitz     int fd;
108ff5ca166SMax Reitz     QLIST_ENTRY(CURLSocket) next;
109ff5ca166SMax Reitz } CURLSocket;
110ff5ca166SMax Reitz 
111769ce76dSAlexander Graf typedef struct CURLState
112769ce76dSAlexander Graf {
113769ce76dSAlexander Graf     struct BDRVCURLState *s;
114769ce76dSAlexander Graf     CURLAIOCB *acb[CURL_NUM_ACB];
115769ce76dSAlexander Graf     CURL *curl;
116ff5ca166SMax Reitz     QLIST_HEAD(, CURLSocket) sockets;
117769ce76dSAlexander Graf     char *orig_buf;
118769ce76dSAlexander Graf     size_t buf_start;
119769ce76dSAlexander Graf     size_t buf_off;
120769ce76dSAlexander Graf     size_t buf_len;
121769ce76dSAlexander Graf     char range[128];
122769ce76dSAlexander Graf     char errmsg[CURL_ERROR_SIZE];
123769ce76dSAlexander Graf     char in_use;
124769ce76dSAlexander Graf } CURLState;
125769ce76dSAlexander Graf 
126769ce76dSAlexander Graf typedef struct BDRVCURLState {
127769ce76dSAlexander Graf     CURLM *multi;
128031fd1beSPeter Maydell     QEMUTimer timer;
129769ce76dSAlexander Graf     size_t len;
130769ce76dSAlexander Graf     CURLState states[CURL_NUM_STATES];
131769ce76dSAlexander Graf     char *url;
132c76f4952SNolan     size_t readahead_size;
13397a3ea57SMatthew Booth     bool sslverify;
134f76faedaSRichard W.M. Jones     uint64_t timeout;
135a94f83d9SRichard W.M. Jones     char *cookie;
1363494d650SFam Zheng     bool accept_range;
13763f0f45fSStefan Hajnoczi     AioContext *aio_context;
138ba3186c4SPaolo Bonzini     QemuMutex mutex;
1391bff9606SDaniel P. Berrange     char *username;
1401bff9606SDaniel P. Berrange     char *password;
1411bff9606SDaniel P. Berrange     char *proxyusername;
1421bff9606SDaniel P. Berrange     char *proxypassword;
143769ce76dSAlexander Graf } BDRVCURLState;
144769ce76dSAlexander Graf 
145769ce76dSAlexander Graf static void curl_clean_state(CURLState *s);
146769ce76dSAlexander Graf static void curl_multi_do(void *arg);
147838ef602SMatthew Booth static void curl_multi_read(void *arg);
148769ce76dSAlexander Graf 
149031fd1beSPeter Maydell #ifdef NEED_CURL_TIMER_CALLBACK
150031fd1beSPeter Maydell static int curl_timer_cb(CURLM *multi, long timeout_ms, void *opaque)
151031fd1beSPeter Maydell {
152031fd1beSPeter Maydell     BDRVCURLState *s = opaque;
153031fd1beSPeter Maydell 
154031fd1beSPeter Maydell     DPRINTF("CURL: timer callback timeout_ms %ld\n", timeout_ms);
155031fd1beSPeter Maydell     if (timeout_ms == -1) {
156031fd1beSPeter Maydell         timer_del(&s->timer);
157031fd1beSPeter Maydell     } else {
158031fd1beSPeter Maydell         int64_t timeout_ns = (int64_t)timeout_ms * 1000 * 1000;
159031fd1beSPeter Maydell         timer_mod(&s->timer,
160031fd1beSPeter Maydell                   qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + timeout_ns);
161031fd1beSPeter Maydell     }
162031fd1beSPeter Maydell     return 0;
163031fd1beSPeter Maydell }
164031fd1beSPeter Maydell #endif
165031fd1beSPeter Maydell 
166769ce76dSAlexander Graf static int curl_sock_cb(CURL *curl, curl_socket_t fd, int action,
16763f0f45fSStefan Hajnoczi                         void *userp, void *sp)
168769ce76dSAlexander Graf {
16963f0f45fSStefan Hajnoczi     BDRVCURLState *s;
170838ef602SMatthew Booth     CURLState *state = NULL;
171ff5ca166SMax Reitz     CURLSocket *socket;
172ff5ca166SMax Reitz 
173838ef602SMatthew Booth     curl_easy_getinfo(curl, CURLINFO_PRIVATE, (char **)&state);
17463f0f45fSStefan Hajnoczi     s = state->s;
175838ef602SMatthew Booth 
176ff5ca166SMax Reitz     QLIST_FOREACH(socket, &state->sockets, next) {
177ff5ca166SMax Reitz         if (socket->fd == fd) {
178ff5ca166SMax Reitz             if (action == CURL_POLL_REMOVE) {
179ff5ca166SMax Reitz                 QLIST_REMOVE(socket, next);
180ff5ca166SMax Reitz                 g_free(socket);
181ff5ca166SMax Reitz             }
182ff5ca166SMax Reitz             break;
183ff5ca166SMax Reitz         }
184ff5ca166SMax Reitz     }
185ff5ca166SMax Reitz     if (!socket) {
186ff5ca166SMax Reitz         socket = g_new0(CURLSocket, 1);
187ff5ca166SMax Reitz         socket->fd = fd;
188ff5ca166SMax Reitz         QLIST_INSERT_HEAD(&state->sockets, socket, next);
189ff5ca166SMax Reitz     }
190ff5ca166SMax Reitz     socket = NULL;
191ff5ca166SMax Reitz 
19292b6a160SFam Zheng     DPRINTF("CURL (AIO): Sock action %d on fd %d\n", action, (int)fd);
193769ce76dSAlexander Graf     switch (action) {
194769ce76dSAlexander Graf         case CURL_POLL_IN:
195dca21ef2SFam Zheng             aio_set_fd_handler(s->aio_context, fd, false,
196f6a51c84SStefan Hajnoczi                                curl_multi_read, NULL, NULL, state);
197769ce76dSAlexander Graf             break;
198769ce76dSAlexander Graf         case CURL_POLL_OUT:
199dca21ef2SFam Zheng             aio_set_fd_handler(s->aio_context, fd, false,
200f6a51c84SStefan Hajnoczi                                NULL, curl_multi_do, NULL, state);
201769ce76dSAlexander Graf             break;
202769ce76dSAlexander Graf         case CURL_POLL_INOUT:
203dca21ef2SFam Zheng             aio_set_fd_handler(s->aio_context, fd, false,
204f6a51c84SStefan Hajnoczi                                curl_multi_read, curl_multi_do, NULL, state);
205769ce76dSAlexander Graf             break;
206769ce76dSAlexander Graf         case CURL_POLL_REMOVE:
207dca21ef2SFam Zheng             aio_set_fd_handler(s->aio_context, fd, false,
208f6a51c84SStefan Hajnoczi                                NULL, NULL, NULL, NULL);
209769ce76dSAlexander Graf             break;
210769ce76dSAlexander Graf     }
211769ce76dSAlexander Graf 
212769ce76dSAlexander Graf     return 0;
213769ce76dSAlexander Graf }
214769ce76dSAlexander Graf 
2153494d650SFam Zheng static size_t curl_header_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
216769ce76dSAlexander Graf {
2173494d650SFam Zheng     BDRVCURLState *s = opaque;
218769ce76dSAlexander Graf     size_t realsize = size * nmemb;
2193494d650SFam Zheng     const char *accept_line = "Accept-Ranges: bytes";
220769ce76dSAlexander Graf 
2213494d650SFam Zheng     if (realsize >= strlen(accept_line)
2223494d650SFam Zheng         && strncmp((char *)ptr, accept_line, strlen(accept_line)) == 0) {
2233494d650SFam Zheng         s->accept_range = true;
2240bfcd599SBlue Swirl     }
225769ce76dSAlexander Graf 
226769ce76dSAlexander Graf     return realsize;
227769ce76dSAlexander Graf }
228769ce76dSAlexander Graf 
229769ce76dSAlexander Graf static size_t curl_read_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
230769ce76dSAlexander Graf {
231769ce76dSAlexander Graf     CURLState *s = ((CURLState*)opaque);
232769ce76dSAlexander Graf     size_t realsize = size * nmemb;
233769ce76dSAlexander Graf     int i;
234769ce76dSAlexander Graf 
2350bfcd599SBlue Swirl     DPRINTF("CURL: Just reading %zd bytes\n", realsize);
236769ce76dSAlexander Graf 
2374e767657SMax Reitz     if (!s || !s->orig_buf) {
2384e767657SMax Reitz         goto read_end;
2394e767657SMax Reitz     }
240769ce76dSAlexander Graf 
2416d4b9e55SFam Zheng     if (s->buf_off >= s->buf_len) {
2426d4b9e55SFam Zheng         /* buffer full, read nothing */
2434e767657SMax Reitz         goto read_end;
2446d4b9e55SFam Zheng     }
2456d4b9e55SFam Zheng     realsize = MIN(realsize, s->buf_len - s->buf_off);
246769ce76dSAlexander Graf     memcpy(s->orig_buf + s->buf_off, ptr, realsize);
247769ce76dSAlexander Graf     s->buf_off += realsize;
248769ce76dSAlexander Graf 
249769ce76dSAlexander Graf     for(i=0; i<CURL_NUM_ACB; i++) {
250769ce76dSAlexander Graf         CURLAIOCB *acb = s->acb[i];
251769ce76dSAlexander Graf 
252769ce76dSAlexander Graf         if (!acb)
253769ce76dSAlexander Graf             continue;
254769ce76dSAlexander Graf 
255769ce76dSAlexander Graf         if ((s->buf_off >= acb->end)) {
2564e504535SMax Reitz             size_t request_length = acb->nb_sectors * BDRV_SECTOR_SIZE;
2574e504535SMax Reitz 
25803396148SMichael Tokarev             qemu_iovec_from_buf(acb->qiov, 0, s->orig_buf + acb->start,
259769ce76dSAlexander Graf                                 acb->end - acb->start);
2604e504535SMax Reitz 
2614e504535SMax Reitz             if (acb->end - acb->start < request_length) {
2624e504535SMax Reitz                 size_t offset = acb->end - acb->start;
2634e504535SMax Reitz                 qemu_iovec_memset(acb->qiov, offset, 0,
2644e504535SMax Reitz                                   request_length - offset);
2654e504535SMax Reitz             }
2664e504535SMax Reitz 
267769ce76dSAlexander Graf             acb->common.cb(acb->common.opaque, 0);
2688007429aSFam Zheng             qemu_aio_unref(acb);
269769ce76dSAlexander Graf             s->acb[i] = NULL;
270769ce76dSAlexander Graf         }
271769ce76dSAlexander Graf     }
272769ce76dSAlexander Graf 
2734e767657SMax Reitz read_end:
2744e767657SMax Reitz     /* curl will error out if we do not return this value */
2754e767657SMax Reitz     return size * nmemb;
276769ce76dSAlexander Graf }
277769ce76dSAlexander Graf 
278769ce76dSAlexander Graf static int curl_find_buf(BDRVCURLState *s, size_t start, size_t len,
279769ce76dSAlexander Graf                          CURLAIOCB *acb)
280769ce76dSAlexander Graf {
281769ce76dSAlexander Graf     int i;
282769ce76dSAlexander Graf     size_t end = start + len;
2834e504535SMax Reitz     size_t clamped_end = MIN(end, s->len);
2844e504535SMax Reitz     size_t clamped_len = clamped_end - start;
285769ce76dSAlexander Graf 
286769ce76dSAlexander Graf     for (i=0; i<CURL_NUM_STATES; i++) {
287769ce76dSAlexander Graf         CURLState *state = &s->states[i];
288769ce76dSAlexander Graf         size_t buf_end = (state->buf_start + state->buf_off);
289769ce76dSAlexander Graf         size_t buf_fend = (state->buf_start + state->buf_len);
290769ce76dSAlexander Graf 
291769ce76dSAlexander Graf         if (!state->orig_buf)
292769ce76dSAlexander Graf             continue;
293769ce76dSAlexander Graf         if (!state->buf_off)
294769ce76dSAlexander Graf             continue;
295769ce76dSAlexander Graf 
296769ce76dSAlexander Graf         // Does the existing buffer cover our section?
297769ce76dSAlexander Graf         if ((start >= state->buf_start) &&
298769ce76dSAlexander Graf             (start <= buf_end) &&
2994e504535SMax Reitz             (clamped_end >= state->buf_start) &&
3004e504535SMax Reitz             (clamped_end <= buf_end))
301769ce76dSAlexander Graf         {
302769ce76dSAlexander Graf             char *buf = state->orig_buf + (start - state->buf_start);
303769ce76dSAlexander Graf 
3044e504535SMax Reitz             qemu_iovec_from_buf(acb->qiov, 0, buf, clamped_len);
3054e504535SMax Reitz             if (clamped_len < len) {
3064e504535SMax Reitz                 qemu_iovec_memset(acb->qiov, clamped_len, 0, len - clamped_len);
3074e504535SMax Reitz             }
308769ce76dSAlexander Graf             acb->common.cb(acb->common.opaque, 0);
309769ce76dSAlexander Graf 
310769ce76dSAlexander Graf             return FIND_RET_OK;
311769ce76dSAlexander Graf         }
312769ce76dSAlexander Graf 
313769ce76dSAlexander Graf         // Wait for unfinished chunks
314b7079df4SMatthew Booth         if (state->in_use &&
315b7079df4SMatthew Booth             (start >= state->buf_start) &&
316769ce76dSAlexander Graf             (start <= buf_fend) &&
3174e504535SMax Reitz             (clamped_end >= state->buf_start) &&
3184e504535SMax Reitz             (clamped_end <= buf_fend))
319769ce76dSAlexander Graf         {
320769ce76dSAlexander Graf             int j;
321769ce76dSAlexander Graf 
322769ce76dSAlexander Graf             acb->start = start - state->buf_start;
3234e504535SMax Reitz             acb->end = acb->start + clamped_len;
324769ce76dSAlexander Graf 
325769ce76dSAlexander Graf             for (j=0; j<CURL_NUM_ACB; j++) {
326769ce76dSAlexander Graf                 if (!state->acb[j]) {
327769ce76dSAlexander Graf                     state->acb[j] = acb;
328769ce76dSAlexander Graf                     return FIND_RET_WAIT;
329769ce76dSAlexander Graf                 }
330769ce76dSAlexander Graf             }
331769ce76dSAlexander Graf         }
332769ce76dSAlexander Graf     }
333769ce76dSAlexander Graf 
334769ce76dSAlexander Graf     return FIND_RET_NONE;
335769ce76dSAlexander Graf }
336769ce76dSAlexander Graf 
337ba3186c4SPaolo Bonzini /* Called with s->mutex held.  */
338838ef602SMatthew Booth static void curl_multi_check_completion(BDRVCURLState *s)
339769ce76dSAlexander Graf {
340769ce76dSAlexander Graf     int msgs_in_queue;
341769ce76dSAlexander Graf 
342769ce76dSAlexander Graf     /* Try to find done transfers, so we can free the easy
343769ce76dSAlexander Graf      * handle again. */
3441f2cead3SMatthew Booth     for (;;) {
345769ce76dSAlexander Graf         CURLMsg *msg;
346769ce76dSAlexander Graf         msg = curl_multi_info_read(s->multi, &msgs_in_queue);
347769ce76dSAlexander Graf 
3481f2cead3SMatthew Booth         /* Quit when there are no more completions */
349769ce76dSAlexander Graf         if (!msg)
350769ce76dSAlexander Graf             break;
351769ce76dSAlexander Graf 
3521f2cead3SMatthew Booth         if (msg->msg == CURLMSG_DONE) {
353769ce76dSAlexander Graf             CURLState *state = NULL;
354f6246509SMatthew Booth             curl_easy_getinfo(msg->easy_handle, CURLINFO_PRIVATE,
355f6246509SMatthew Booth                               (char **)&state);
356f785a5aeSNicholas Thomas 
357f785a5aeSNicholas Thomas             /* ACBs for successful messages get completed in curl_read_cb */
358f785a5aeSNicholas Thomas             if (msg->data.result != CURLE_OK) {
359f785a5aeSNicholas Thomas                 int i;
360796a060bSRichard W.M. Jones                 static int errcount = 100;
361796a060bSRichard W.M. Jones 
362796a060bSRichard W.M. Jones                 /* Don't lose the original error message from curl, since
363796a060bSRichard W.M. Jones                  * it contains extra data.
364796a060bSRichard W.M. Jones                  */
365796a060bSRichard W.M. Jones                 if (errcount > 0) {
366796a060bSRichard W.M. Jones                     error_report("curl: %s", state->errmsg);
367796a060bSRichard W.M. Jones                     if (--errcount == 0) {
368796a060bSRichard W.M. Jones                         error_report("curl: further errors suppressed");
369796a060bSRichard W.M. Jones                     }
370796a060bSRichard W.M. Jones                 }
371796a060bSRichard W.M. Jones 
372f785a5aeSNicholas Thomas                 for (i = 0; i < CURL_NUM_ACB; i++) {
373f785a5aeSNicholas Thomas                     CURLAIOCB *acb = state->acb[i];
374f785a5aeSNicholas Thomas 
375f785a5aeSNicholas Thomas                     if (acb == NULL) {
376f785a5aeSNicholas Thomas                         continue;
377f785a5aeSNicholas Thomas                     }
378f785a5aeSNicholas Thomas 
379ba3186c4SPaolo Bonzini                     qemu_mutex_unlock(&s->mutex);
380eb048026SPaolo Bonzini                     acb->common.cb(acb->common.opaque, -EIO);
381ba3186c4SPaolo Bonzini                     qemu_mutex_lock(&s->mutex);
3828007429aSFam Zheng                     qemu_aio_unref(acb);
383f785a5aeSNicholas Thomas                     state->acb[i] = NULL;
384f785a5aeSNicholas Thomas                 }
385f785a5aeSNicholas Thomas             }
386f785a5aeSNicholas Thomas 
387769ce76dSAlexander Graf             curl_clean_state(state);
388769ce76dSAlexander Graf             break;
389769ce76dSAlexander Graf         }
390769ce76dSAlexander Graf     }
391769ce76dSAlexander Graf }
392769ce76dSAlexander Graf 
393ba3186c4SPaolo Bonzini /* Called with s->mutex held.  */
3949d456654SPaolo Bonzini static void curl_multi_do_locked(CURLState *s)
395031fd1beSPeter Maydell {
396ff5ca166SMax Reitz     CURLSocket *socket, *next_socket;
397031fd1beSPeter Maydell     int running;
398031fd1beSPeter Maydell     int r;
399031fd1beSPeter Maydell 
400838ef602SMatthew Booth     if (!s->s->multi) {
401031fd1beSPeter Maydell         return;
402031fd1beSPeter Maydell     }
403031fd1beSPeter Maydell 
404ff5ca166SMax Reitz     /* Need to use _SAFE because curl_multi_socket_action() may trigger
405ff5ca166SMax Reitz      * curl_sock_cb() which might modify this list */
406ff5ca166SMax Reitz     QLIST_FOREACH_SAFE(socket, &s->sockets, next, next_socket) {
407031fd1beSPeter Maydell         do {
408ff5ca166SMax Reitz             r = curl_multi_socket_action(s->s->multi, socket->fd, 0, &running);
409031fd1beSPeter Maydell         } while (r == CURLM_CALL_MULTI_PERFORM);
410ff5ca166SMax Reitz     }
411838ef602SMatthew Booth }
412838ef602SMatthew Booth 
4139d456654SPaolo Bonzini static void curl_multi_do(void *arg)
4149d456654SPaolo Bonzini {
4159d456654SPaolo Bonzini     CURLState *s = (CURLState *)arg;
4169d456654SPaolo Bonzini 
417ba3186c4SPaolo Bonzini     qemu_mutex_lock(&s->s->mutex);
4189d456654SPaolo Bonzini     curl_multi_do_locked(s);
419ba3186c4SPaolo Bonzini     qemu_mutex_unlock(&s->s->mutex);
4209d456654SPaolo Bonzini }
4219d456654SPaolo Bonzini 
422838ef602SMatthew Booth static void curl_multi_read(void *arg)
423838ef602SMatthew Booth {
424838ef602SMatthew Booth     CURLState *s = (CURLState *)arg;
425838ef602SMatthew Booth 
426ba3186c4SPaolo Bonzini     qemu_mutex_lock(&s->s->mutex);
4279d456654SPaolo Bonzini     curl_multi_do_locked(s);
428838ef602SMatthew Booth     curl_multi_check_completion(s->s);
429ba3186c4SPaolo Bonzini     qemu_mutex_unlock(&s->s->mutex);
430031fd1beSPeter Maydell }
431031fd1beSPeter Maydell 
432031fd1beSPeter Maydell static void curl_multi_timeout_do(void *arg)
433031fd1beSPeter Maydell {
434031fd1beSPeter Maydell #ifdef NEED_CURL_TIMER_CALLBACK
435031fd1beSPeter Maydell     BDRVCURLState *s = (BDRVCURLState *)arg;
436031fd1beSPeter Maydell     int running;
437031fd1beSPeter Maydell 
438031fd1beSPeter Maydell     if (!s->multi) {
439031fd1beSPeter Maydell         return;
440031fd1beSPeter Maydell     }
441031fd1beSPeter Maydell 
442ba3186c4SPaolo Bonzini     qemu_mutex_lock(&s->mutex);
443031fd1beSPeter Maydell     curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
444031fd1beSPeter Maydell 
445838ef602SMatthew Booth     curl_multi_check_completion(s);
446ba3186c4SPaolo Bonzini     qemu_mutex_unlock(&s->mutex);
447031fd1beSPeter Maydell #else
448031fd1beSPeter Maydell     abort();
449031fd1beSPeter Maydell #endif
450031fd1beSPeter Maydell }
451031fd1beSPeter Maydell 
452a2f468e4SRichard W.M. Jones static CURLState *curl_init_state(BlockDriverState *bs, BDRVCURLState *s)
453769ce76dSAlexander Graf {
454769ce76dSAlexander Graf     CURLState *state = NULL;
455769ce76dSAlexander Graf     int i, j;
456769ce76dSAlexander Graf 
457769ce76dSAlexander Graf     do {
458769ce76dSAlexander Graf         for (i=0; i<CURL_NUM_STATES; i++) {
459769ce76dSAlexander Graf             for (j=0; j<CURL_NUM_ACB; j++)
460769ce76dSAlexander Graf                 if (s->states[i].acb[j])
461769ce76dSAlexander Graf                     continue;
462769ce76dSAlexander Graf             if (s->states[i].in_use)
463769ce76dSAlexander Graf                 continue;
464769ce76dSAlexander Graf 
465769ce76dSAlexander Graf             state = &s->states[i];
466769ce76dSAlexander Graf             state->in_use = 1;
467769ce76dSAlexander Graf             break;
468769ce76dSAlexander Graf         }
469769ce76dSAlexander Graf         if (!state) {
470a2f468e4SRichard W.M. Jones             aio_poll(bdrv_get_aio_context(bs), true);
471769ce76dSAlexander Graf         }
472769ce76dSAlexander Graf     } while(!state);
473769ce76dSAlexander Graf 
4749e550b32SMatthew Booth     if (!state->curl) {
475769ce76dSAlexander Graf         state->curl = curl_easy_init();
4769e550b32SMatthew Booth         if (!state->curl) {
477769ce76dSAlexander Graf             return NULL;
4789e550b32SMatthew Booth         }
479769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_URL, s->url);
48097a3ea57SMatthew Booth         curl_easy_setopt(state->curl, CURLOPT_SSL_VERIFYPEER,
48197a3ea57SMatthew Booth                          (long) s->sslverify);
482a94f83d9SRichard W.M. Jones         if (s->cookie) {
483a94f83d9SRichard W.M. Jones             curl_easy_setopt(state->curl, CURLOPT_COOKIE, s->cookie);
484a94f83d9SRichard W.M. Jones         }
485f76faedaSRichard W.M. Jones         curl_easy_setopt(state->curl, CURLOPT_TIMEOUT, (long)s->timeout);
4869e550b32SMatthew Booth         curl_easy_setopt(state->curl, CURLOPT_WRITEFUNCTION,
4879e550b32SMatthew Booth                          (void *)curl_read_cb);
488769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_WRITEDATA, (void *)state);
489769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_PRIVATE, (void *)state);
490769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_AUTOREFERER, 1);
491769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_FOLLOWLOCATION, 1);
492769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_NOSIGNAL, 1);
493769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_ERRORBUFFER, state->errmsg);
494f785a5aeSNicholas Thomas         curl_easy_setopt(state->curl, CURLOPT_FAILONERROR, 1);
495769ce76dSAlexander Graf 
4961bff9606SDaniel P. Berrange         if (s->username) {
4971bff9606SDaniel P. Berrange             curl_easy_setopt(state->curl, CURLOPT_USERNAME, s->username);
4981bff9606SDaniel P. Berrange         }
4991bff9606SDaniel P. Berrange         if (s->password) {
5001bff9606SDaniel P. Berrange             curl_easy_setopt(state->curl, CURLOPT_PASSWORD, s->password);
5011bff9606SDaniel P. Berrange         }
5021bff9606SDaniel P. Berrange         if (s->proxyusername) {
5031bff9606SDaniel P. Berrange             curl_easy_setopt(state->curl,
5041bff9606SDaniel P. Berrange                              CURLOPT_PROXYUSERNAME, s->proxyusername);
5051bff9606SDaniel P. Berrange         }
5061bff9606SDaniel P. Berrange         if (s->proxypassword) {
5071bff9606SDaniel P. Berrange             curl_easy_setopt(state->curl,
5081bff9606SDaniel P. Berrange                              CURLOPT_PROXYPASSWORD, s->proxypassword);
5091bff9606SDaniel P. Berrange         }
5101bff9606SDaniel P. Berrange 
511fb6d1bbdSStefan Hajnoczi         /* Restrict supported protocols to avoid security issues in the more
512fb6d1bbdSStefan Hajnoczi          * obscure protocols.  For example, do not allow POP3/SMTP/IMAP see
513fb6d1bbdSStefan Hajnoczi          * CVE-2013-0249.
5148a8f5840SStefan Hajnoczi          *
5158a8f5840SStefan Hajnoczi          * Restricting protocols is only supported from 7.19.4 upwards.
516fb6d1bbdSStefan Hajnoczi          */
5178a8f5840SStefan Hajnoczi #if LIBCURL_VERSION_NUM >= 0x071304
518fb6d1bbdSStefan Hajnoczi         curl_easy_setopt(state->curl, CURLOPT_PROTOCOLS, PROTOCOLS);
519fb6d1bbdSStefan Hajnoczi         curl_easy_setopt(state->curl, CURLOPT_REDIR_PROTOCOLS, PROTOCOLS);
5208a8f5840SStefan Hajnoczi #endif
521fb6d1bbdSStefan Hajnoczi 
522769ce76dSAlexander Graf #ifdef DEBUG_VERBOSE
523769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_VERBOSE, 1);
524769ce76dSAlexander Graf #endif
5259e550b32SMatthew Booth     }
526769ce76dSAlexander Graf 
527ff5ca166SMax Reitz     QLIST_INIT(&state->sockets);
528769ce76dSAlexander Graf     state->s = s;
529769ce76dSAlexander Graf 
530769ce76dSAlexander Graf     return state;
531769ce76dSAlexander Graf }
532769ce76dSAlexander Graf 
533769ce76dSAlexander Graf static void curl_clean_state(CURLState *s)
534769ce76dSAlexander Graf {
535769ce76dSAlexander Graf     if (s->s->multi)
536769ce76dSAlexander Graf         curl_multi_remove_handle(s->s->multi, s->curl);
537ff5ca166SMax Reitz 
538ff5ca166SMax Reitz     while (!QLIST_EMPTY(&s->sockets)) {
539ff5ca166SMax Reitz         CURLSocket *socket = QLIST_FIRST(&s->sockets);
540ff5ca166SMax Reitz 
541ff5ca166SMax Reitz         QLIST_REMOVE(socket, next);
542ff5ca166SMax Reitz         g_free(socket);
543ff5ca166SMax Reitz     }
544ff5ca166SMax Reitz 
545769ce76dSAlexander Graf     s->in_use = 0;
546769ce76dSAlexander Graf }
547769ce76dSAlexander Graf 
5488e6d58cdSKevin Wolf static void curl_parse_filename(const char *filename, QDict *options,
5498e6d58cdSKevin Wolf                                 Error **errp)
550769ce76dSAlexander Graf {
551*46f5ac20SEric Blake     qdict_put_str(options, CURL_BLOCK_OPT_URL, filename);
5528e6d58cdSKevin Wolf }
5538e6d58cdSKevin Wolf 
55463f0f45fSStefan Hajnoczi static void curl_detach_aio_context(BlockDriverState *bs)
55563f0f45fSStefan Hajnoczi {
55663f0f45fSStefan Hajnoczi     BDRVCURLState *s = bs->opaque;
55763f0f45fSStefan Hajnoczi     int i;
55863f0f45fSStefan Hajnoczi 
55963f0f45fSStefan Hajnoczi     for (i = 0; i < CURL_NUM_STATES; i++) {
56063f0f45fSStefan Hajnoczi         if (s->states[i].in_use) {
56163f0f45fSStefan Hajnoczi             curl_clean_state(&s->states[i]);
56263f0f45fSStefan Hajnoczi         }
56363f0f45fSStefan Hajnoczi         if (s->states[i].curl) {
56463f0f45fSStefan Hajnoczi             curl_easy_cleanup(s->states[i].curl);
56563f0f45fSStefan Hajnoczi             s->states[i].curl = NULL;
56663f0f45fSStefan Hajnoczi         }
56763f0f45fSStefan Hajnoczi         g_free(s->states[i].orig_buf);
56863f0f45fSStefan Hajnoczi         s->states[i].orig_buf = NULL;
56963f0f45fSStefan Hajnoczi     }
57063f0f45fSStefan Hajnoczi     if (s->multi) {
57163f0f45fSStefan Hajnoczi         curl_multi_cleanup(s->multi);
57263f0f45fSStefan Hajnoczi         s->multi = NULL;
57363f0f45fSStefan Hajnoczi     }
57463f0f45fSStefan Hajnoczi 
57563f0f45fSStefan Hajnoczi     timer_del(&s->timer);
57663f0f45fSStefan Hajnoczi }
57763f0f45fSStefan Hajnoczi 
57863f0f45fSStefan Hajnoczi static void curl_attach_aio_context(BlockDriverState *bs,
57963f0f45fSStefan Hajnoczi                                     AioContext *new_context)
58063f0f45fSStefan Hajnoczi {
58163f0f45fSStefan Hajnoczi     BDRVCURLState *s = bs->opaque;
58263f0f45fSStefan Hajnoczi 
58363f0f45fSStefan Hajnoczi     aio_timer_init(new_context, &s->timer,
58463f0f45fSStefan Hajnoczi                    QEMU_CLOCK_REALTIME, SCALE_NS,
58563f0f45fSStefan Hajnoczi                    curl_multi_timeout_do, s);
58663f0f45fSStefan Hajnoczi 
58763f0f45fSStefan Hajnoczi     assert(!s->multi);
58863f0f45fSStefan Hajnoczi     s->multi = curl_multi_init();
58963f0f45fSStefan Hajnoczi     s->aio_context = new_context;
59063f0f45fSStefan Hajnoczi     curl_multi_setopt(s->multi, CURLMOPT_SOCKETFUNCTION, curl_sock_cb);
59163f0f45fSStefan Hajnoczi #ifdef NEED_CURL_TIMER_CALLBACK
59263f0f45fSStefan Hajnoczi     curl_multi_setopt(s->multi, CURLMOPT_TIMERDATA, s);
59363f0f45fSStefan Hajnoczi     curl_multi_setopt(s->multi, CURLMOPT_TIMERFUNCTION, curl_timer_cb);
59463f0f45fSStefan Hajnoczi #endif
59563f0f45fSStefan Hajnoczi }
59663f0f45fSStefan Hajnoczi 
5978e6d58cdSKevin Wolf static QemuOptsList runtime_opts = {
5988e6d58cdSKevin Wolf     .name = "curl",
5998e6d58cdSKevin Wolf     .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
6008e6d58cdSKevin Wolf     .desc = {
6018e6d58cdSKevin Wolf         {
602e3542c67SMatthew Booth             .name = CURL_BLOCK_OPT_URL,
6038e6d58cdSKevin Wolf             .type = QEMU_OPT_STRING,
6048e6d58cdSKevin Wolf             .help = "URL to open",
6058e6d58cdSKevin Wolf         },
6068e6d58cdSKevin Wolf         {
607e3542c67SMatthew Booth             .name = CURL_BLOCK_OPT_READAHEAD,
6088e6d58cdSKevin Wolf             .type = QEMU_OPT_SIZE,
6098e6d58cdSKevin Wolf             .help = "Readahead size",
6108e6d58cdSKevin Wolf         },
61197a3ea57SMatthew Booth         {
61297a3ea57SMatthew Booth             .name = CURL_BLOCK_OPT_SSLVERIFY,
61397a3ea57SMatthew Booth             .type = QEMU_OPT_BOOL,
61497a3ea57SMatthew Booth             .help = "Verify SSL certificate"
61597a3ea57SMatthew Booth         },
616212aefaaSDaniel Henrique Barboza         {
617212aefaaSDaniel Henrique Barboza             .name = CURL_BLOCK_OPT_TIMEOUT,
618212aefaaSDaniel Henrique Barboza             .type = QEMU_OPT_NUMBER,
619212aefaaSDaniel Henrique Barboza             .help = "Curl timeout"
620212aefaaSDaniel Henrique Barboza         },
621a94f83d9SRichard W.M. Jones         {
622a94f83d9SRichard W.M. Jones             .name = CURL_BLOCK_OPT_COOKIE,
623a94f83d9SRichard W.M. Jones             .type = QEMU_OPT_STRING,
624a94f83d9SRichard W.M. Jones             .help = "Pass the cookie or list of cookies with each request"
625a94f83d9SRichard W.M. Jones         },
6261bff9606SDaniel P. Berrange         {
6271bff9606SDaniel P. Berrange             .name = CURL_BLOCK_OPT_USERNAME,
6281bff9606SDaniel P. Berrange             .type = QEMU_OPT_STRING,
6291bff9606SDaniel P. Berrange             .help = "Username for HTTP auth"
6301bff9606SDaniel P. Berrange         },
6311bff9606SDaniel P. Berrange         {
6321bff9606SDaniel P. Berrange             .name = CURL_BLOCK_OPT_PASSWORD_SECRET,
6331bff9606SDaniel P. Berrange             .type = QEMU_OPT_STRING,
6341bff9606SDaniel P. Berrange             .help = "ID of secret used as password for HTTP auth",
6351bff9606SDaniel P. Berrange         },
6361bff9606SDaniel P. Berrange         {
6371bff9606SDaniel P. Berrange             .name = CURL_BLOCK_OPT_PROXY_USERNAME,
6381bff9606SDaniel P. Berrange             .type = QEMU_OPT_STRING,
6391bff9606SDaniel P. Berrange             .help = "Username for HTTP proxy auth"
6401bff9606SDaniel P. Berrange         },
6411bff9606SDaniel P. Berrange         {
6421bff9606SDaniel P. Berrange             .name = CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET,
6431bff9606SDaniel P. Berrange             .type = QEMU_OPT_STRING,
6441bff9606SDaniel P. Berrange             .help = "ID of secret used as password for HTTP proxy auth",
6451bff9606SDaniel P. Berrange         },
6468e6d58cdSKevin Wolf         { /* end of list */ }
6478e6d58cdSKevin Wolf     },
6488e6d58cdSKevin Wolf };
6498e6d58cdSKevin Wolf 
6501bff9606SDaniel P. Berrange 
651015a1036SMax Reitz static int curl_open(BlockDriverState *bs, QDict *options, int flags,
652015a1036SMax Reitz                      Error **errp)
6538e6d58cdSKevin Wolf {
6548e6d58cdSKevin Wolf     BDRVCURLState *s = bs->opaque;
6558e6d58cdSKevin Wolf     CURLState *state = NULL;
6568e6d58cdSKevin Wolf     QemuOpts *opts;
6578e6d58cdSKevin Wolf     Error *local_err = NULL;
6588e6d58cdSKevin Wolf     const char *file;
659a94f83d9SRichard W.M. Jones     const char *cookie;
6608e6d58cdSKevin Wolf     double d;
6611bff9606SDaniel P. Berrange     const char *secretid;
66234634ca2SMax Reitz     const char *protocol_delimiter;
6638e6d58cdSKevin Wolf 
6648e6d58cdSKevin Wolf     static int inited = 0;
6658e6d58cdSKevin Wolf 
666a7cea2baSRichard W.M. Jones     if (flags & BDRV_O_RDWR) {
6672a94fee3SPaolo Bonzini         error_setg(errp, "curl block device does not support writes");
668a7cea2baSRichard W.M. Jones         return -EROFS;
669a7cea2baSRichard W.M. Jones     }
670a7cea2baSRichard W.M. Jones 
67187ea75d5SPeter Crosthwaite     opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
6728e6d58cdSKevin Wolf     qemu_opts_absorb_qdict(opts, options, &local_err);
67384d18f06SMarkus Armbruster     if (local_err) {
6742a94fee3SPaolo Bonzini         error_propagate(errp, local_err);
6758e6d58cdSKevin Wolf         goto out_noclean;
6768e6d58cdSKevin Wolf     }
6778e6d58cdSKevin Wolf 
678e3542c67SMatthew Booth     s->readahead_size = qemu_opt_get_size(opts, CURL_BLOCK_OPT_READAHEAD,
679e3542c67SMatthew Booth                                           READ_AHEAD_DEFAULT);
680c76f4952SNolan     if ((s->readahead_size & 0x1ff) != 0) {
6812a94fee3SPaolo Bonzini         error_setg(errp, "HTTP_READAHEAD_SIZE %zd is not a multiple of 512",
682c76f4952SNolan                    s->readahead_size);
683c76f4952SNolan         goto out_noclean;
684c76f4952SNolan     }
685c76f4952SNolan 
686212aefaaSDaniel Henrique Barboza     s->timeout = qemu_opt_get_number(opts, CURL_BLOCK_OPT_TIMEOUT,
687212aefaaSDaniel Henrique Barboza                                      CURL_TIMEOUT_DEFAULT);
688f76faedaSRichard W.M. Jones     if (s->timeout > CURL_TIMEOUT_MAX) {
689f76faedaSRichard W.M. Jones         error_setg(errp, "timeout parameter is too large or negative");
690f76faedaSRichard W.M. Jones         goto out_noclean;
691f76faedaSRichard W.M. Jones     }
692212aefaaSDaniel Henrique Barboza 
69397a3ea57SMatthew Booth     s->sslverify = qemu_opt_get_bool(opts, CURL_BLOCK_OPT_SSLVERIFY, true);
69497a3ea57SMatthew Booth 
695a94f83d9SRichard W.M. Jones     cookie = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE);
696a94f83d9SRichard W.M. Jones     s->cookie = g_strdup(cookie);
697a94f83d9SRichard W.M. Jones 
698e3542c67SMatthew Booth     file = qemu_opt_get(opts, CURL_BLOCK_OPT_URL);
6998e6d58cdSKevin Wolf     if (file == NULL) {
7002a94fee3SPaolo Bonzini         error_setg(errp, "curl block driver requires an 'url' option");
7018e6d58cdSKevin Wolf         goto out_noclean;
7028e6d58cdSKevin Wolf     }
7038e6d58cdSKevin Wolf 
70434634ca2SMax Reitz     if (!strstart(file, bs->drv->protocol_name, &protocol_delimiter) ||
70534634ca2SMax Reitz         !strstart(protocol_delimiter, "://", NULL))
70634634ca2SMax Reitz     {
70734634ca2SMax Reitz         error_setg(errp, "%s curl driver cannot handle the URL '%s' (does not "
70834634ca2SMax Reitz                    "start with '%s://')", bs->drv->protocol_name, file,
70934634ca2SMax Reitz                    bs->drv->protocol_name);
71034634ca2SMax Reitz         goto out_noclean;
71134634ca2SMax Reitz     }
71234634ca2SMax Reitz 
7131bff9606SDaniel P. Berrange     s->username = g_strdup(qemu_opt_get(opts, CURL_BLOCK_OPT_USERNAME));
7141bff9606SDaniel P. Berrange     secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PASSWORD_SECRET);
7151bff9606SDaniel P. Berrange 
7161bff9606SDaniel P. Berrange     if (secretid) {
7171bff9606SDaniel P. Berrange         s->password = qcrypto_secret_lookup_as_utf8(secretid, errp);
7181bff9606SDaniel P. Berrange         if (!s->password) {
7191bff9606SDaniel P. Berrange             goto out_noclean;
7201bff9606SDaniel P. Berrange         }
7211bff9606SDaniel P. Berrange     }
7221bff9606SDaniel P. Berrange 
7231bff9606SDaniel P. Berrange     s->proxyusername = g_strdup(
7241bff9606SDaniel P. Berrange         qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_USERNAME));
7251bff9606SDaniel P. Berrange     secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET);
7261bff9606SDaniel P. Berrange     if (secretid) {
7271bff9606SDaniel P. Berrange         s->proxypassword = qcrypto_secret_lookup_as_utf8(secretid, errp);
7281bff9606SDaniel P. Berrange         if (!s->proxypassword) {
7291bff9606SDaniel P. Berrange             goto out_noclean;
7301bff9606SDaniel P. Berrange         }
7311bff9606SDaniel P. Berrange     }
7321bff9606SDaniel P. Berrange 
733769ce76dSAlexander Graf     if (!inited) {
734769ce76dSAlexander Graf         curl_global_init(CURL_GLOBAL_ALL);
735769ce76dSAlexander Graf         inited = 1;
736769ce76dSAlexander Graf     }
737769ce76dSAlexander Graf 
738d0f2c4c6Smalc     DPRINTF("CURL: Opening %s\n", file);
73963f0f45fSStefan Hajnoczi     s->aio_context = bdrv_get_aio_context(bs);
7408e6d58cdSKevin Wolf     s->url = g_strdup(file);
741a2f468e4SRichard W.M. Jones     state = curl_init_state(bs, s);
742769ce76dSAlexander Graf     if (!state)
743769ce76dSAlexander Graf         goto out_noclean;
744769ce76dSAlexander Graf 
745769ce76dSAlexander Graf     // Get file size
746769ce76dSAlexander Graf 
7473494d650SFam Zheng     s->accept_range = false;
748769ce76dSAlexander Graf     curl_easy_setopt(state->curl, CURLOPT_NOBODY, 1);
7493494d650SFam Zheng     curl_easy_setopt(state->curl, CURLOPT_HEADERFUNCTION,
7503494d650SFam Zheng                      curl_header_cb);
7513494d650SFam Zheng     curl_easy_setopt(state->curl, CURLOPT_HEADERDATA, s);
752769ce76dSAlexander Graf     if (curl_easy_perform(state->curl))
753769ce76dSAlexander Graf         goto out;
754a41c4578STomáš Golembiovský     if (curl_easy_getinfo(state->curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &d)) {
755769ce76dSAlexander Graf         goto out;
756a41c4578STomáš Golembiovský     }
757a41c4578STomáš Golembiovský     /* Prior CURL 7.19.4 return value of 0 could mean that the file size is not
758a41c4578STomáš Golembiovský      * know or the size is zero. From 7.19.4 CURL returns -1 if size is not
759a41c4578STomáš Golembiovský      * known and zero if it is realy zero-length file. */
760a41c4578STomáš Golembiovský #if LIBCURL_VERSION_NUM >= 0x071304
761a41c4578STomáš Golembiovský     if (d < 0) {
762a41c4578STomáš Golembiovský         pstrcpy(state->errmsg, CURL_ERROR_SIZE,
763a41c4578STomáš Golembiovský                 "Server didn't report file size.");
764a41c4578STomáš Golembiovský         goto out;
765a41c4578STomáš Golembiovský     }
766a41c4578STomáš Golembiovský #else
767a41c4578STomáš Golembiovský     if (d <= 0) {
768a41c4578STomáš Golembiovský         pstrcpy(state->errmsg, CURL_ERROR_SIZE,
769a41c4578STomáš Golembiovský                 "Unknown file size or zero-length file.");
770a41c4578STomáš Golembiovský         goto out;
771a41c4578STomáš Golembiovský     }
772a41c4578STomáš Golembiovský #endif
773a41c4578STomáš Golembiovský 
774a41c4578STomáš Golembiovský     s->len = (size_t)d;
775a41c4578STomáš Golembiovský 
7763494d650SFam Zheng     if ((!strncasecmp(s->url, "http://", strlen("http://"))
7773494d650SFam Zheng         || !strncasecmp(s->url, "https://", strlen("https://")))
7783494d650SFam Zheng         && !s->accept_range) {
7793494d650SFam Zheng         pstrcpy(state->errmsg, CURL_ERROR_SIZE,
7803494d650SFam Zheng                 "Server does not support 'range' (byte ranges).");
7813494d650SFam Zheng         goto out;
7823494d650SFam Zheng     }
7830bfcd599SBlue Swirl     DPRINTF("CURL: Size = %zd\n", s->len);
784769ce76dSAlexander Graf 
785769ce76dSAlexander Graf     curl_clean_state(state);
786769ce76dSAlexander Graf     curl_easy_cleanup(state->curl);
787769ce76dSAlexander Graf     state->curl = NULL;
788769ce76dSAlexander Graf 
789ba3186c4SPaolo Bonzini     qemu_mutex_init(&s->mutex);
79063f0f45fSStefan Hajnoczi     curl_attach_aio_context(bs, bdrv_get_aio_context(bs));
791769ce76dSAlexander Graf 
7928e6d58cdSKevin Wolf     qemu_opts_del(opts);
793769ce76dSAlexander Graf     return 0;
794769ce76dSAlexander Graf 
795769ce76dSAlexander Graf out:
796acd7fdc6SMaria Kustova     error_setg(errp, "CURL: Error opening file: %s", state->errmsg);
797769ce76dSAlexander Graf     curl_easy_cleanup(state->curl);
798769ce76dSAlexander Graf     state->curl = NULL;
799769ce76dSAlexander Graf out_noclean:
800a94f83d9SRichard W.M. Jones     g_free(s->cookie);
8018e6d58cdSKevin Wolf     g_free(s->url);
8028e6d58cdSKevin Wolf     qemu_opts_del(opts);
803769ce76dSAlexander Graf     return -EINVAL;
804769ce76dSAlexander Graf }
805769ce76dSAlexander Graf 
806d7331bedSStefan Hajnoczi static const AIOCBInfo curl_aiocb_info = {
807c16b5a2cSChristoph Hellwig     .aiocb_size         = sizeof(CURLAIOCB),
808c16b5a2cSChristoph Hellwig };
809c16b5a2cSChristoph Hellwig 
810363c3c85SNick Thomas 
811363c3c85SNick Thomas static void curl_readv_bh_cb(void *p)
812769ce76dSAlexander Graf {
813769ce76dSAlexander Graf     CURLState *state;
814b69cdef8SMatthew Booth     int running;
8151919631eSPaolo Bonzini     int ret = -EINPROGRESS;
816769ce76dSAlexander Graf 
817363c3c85SNick Thomas     CURLAIOCB *acb = p;
8181919631eSPaolo Bonzini     BlockDriverState *bs = acb->common.bs;
8191919631eSPaolo Bonzini     BDRVCURLState *s = bs->opaque;
820769ce76dSAlexander Graf 
8219054d9f6SMax Reitz     size_t start = acb->sector_num * BDRV_SECTOR_SIZE;
822363c3c85SNick Thomas     size_t end;
823769ce76dSAlexander Graf 
824ba3186c4SPaolo Bonzini     qemu_mutex_lock(&s->mutex);
8251919631eSPaolo Bonzini 
826769ce76dSAlexander Graf     // In case we have the requested data already (e.g. read-ahead),
827769ce76dSAlexander Graf     // we can just call the callback and be done.
8289054d9f6SMax Reitz     switch (curl_find_buf(s, start, acb->nb_sectors * BDRV_SECTOR_SIZE, acb)) {
829769ce76dSAlexander Graf         case FIND_RET_OK:
8308007429aSFam Zheng             qemu_aio_unref(acb);
831769ce76dSAlexander Graf             // fall through
832769ce76dSAlexander Graf         case FIND_RET_WAIT:
8331919631eSPaolo Bonzini             goto out;
834769ce76dSAlexander Graf         default:
835769ce76dSAlexander Graf             break;
836769ce76dSAlexander Graf     }
837769ce76dSAlexander Graf 
838769ce76dSAlexander Graf     // No cache found, so let's start a new request
839a2f468e4SRichard W.M. Jones     state = curl_init_state(acb->common.bs, s);
840363c3c85SNick Thomas     if (!state) {
8411919631eSPaolo Bonzini         ret = -EIO;
8421919631eSPaolo Bonzini         goto out;
843363c3c85SNick Thomas     }
844769ce76dSAlexander Graf 
845769ce76dSAlexander Graf     acb->start = 0;
8464e504535SMax Reitz     acb->end = MIN(acb->nb_sectors * BDRV_SECTOR_SIZE, s->len - start);
847769ce76dSAlexander Graf 
848769ce76dSAlexander Graf     state->buf_off = 0;
8497267c094SAnthony Liguori     g_free(state->orig_buf);
850769ce76dSAlexander Graf     state->buf_start = start;
8514e504535SMax Reitz     state->buf_len = MIN(acb->end + s->readahead_size, s->len - start);
8524e504535SMax Reitz     end = start + state->buf_len - 1;
8538dc7a772SKevin Wolf     state->orig_buf = g_try_malloc(state->buf_len);
8548dc7a772SKevin Wolf     if (state->buf_len && state->orig_buf == NULL) {
8558dc7a772SKevin Wolf         curl_clean_state(state);
8561919631eSPaolo Bonzini         ret = -ENOMEM;
8571919631eSPaolo Bonzini         goto out;
8588dc7a772SKevin Wolf     }
859769ce76dSAlexander Graf     state->acb[0] = acb;
860769ce76dSAlexander Graf 
8610bfcd599SBlue Swirl     snprintf(state->range, 127, "%zd-%zd", start, end);
8629054d9f6SMax Reitz     DPRINTF("CURL (AIO): Reading %llu at %zd (%s)\n",
8639054d9f6SMax Reitz             (acb->nb_sectors * BDRV_SECTOR_SIZE), start, state->range);
864769ce76dSAlexander Graf     curl_easy_setopt(state->curl, CURLOPT_RANGE, state->range);
865769ce76dSAlexander Graf 
866769ce76dSAlexander Graf     curl_multi_add_handle(s->multi, state->curl);
867769ce76dSAlexander Graf 
868b69cdef8SMatthew Booth     /* Tell curl it needs to kick things off */
869b69cdef8SMatthew Booth     curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
8701919631eSPaolo Bonzini 
8711919631eSPaolo Bonzini out:
872ba3186c4SPaolo Bonzini     qemu_mutex_unlock(&s->mutex);
8731919631eSPaolo Bonzini     if (ret != -EINPROGRESS) {
8741919631eSPaolo Bonzini         acb->common.cb(acb->common.opaque, ret);
8751919631eSPaolo Bonzini         qemu_aio_unref(acb);
8761919631eSPaolo Bonzini     }
877363c3c85SNick Thomas }
878363c3c85SNick Thomas 
8797c84b1b8SMarkus Armbruster static BlockAIOCB *curl_aio_readv(BlockDriverState *bs,
880363c3c85SNick Thomas         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
881097310b5SMarkus Armbruster         BlockCompletionFunc *cb, void *opaque)
882363c3c85SNick Thomas {
883363c3c85SNick Thomas     CURLAIOCB *acb;
884363c3c85SNick Thomas 
885d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&curl_aiocb_info, bs, cb, opaque);
886363c3c85SNick Thomas 
887363c3c85SNick Thomas     acb->qiov = qiov;
888363c3c85SNick Thomas     acb->sector_num = sector_num;
889363c3c85SNick Thomas     acb->nb_sectors = nb_sectors;
890363c3c85SNick Thomas 
891fffb6e12SPaolo Bonzini     aio_bh_schedule_oneshot(bdrv_get_aio_context(bs), curl_readv_bh_cb, acb);
892769ce76dSAlexander Graf     return &acb->common;
893769ce76dSAlexander Graf }
894769ce76dSAlexander Graf 
895769ce76dSAlexander Graf static void curl_close(BlockDriverState *bs)
896769ce76dSAlexander Graf {
897769ce76dSAlexander Graf     BDRVCURLState *s = bs->opaque;
898769ce76dSAlexander Graf 
899d0f2c4c6Smalc     DPRINTF("CURL: Close\n");
90063f0f45fSStefan Hajnoczi     curl_detach_aio_context(bs);
901ba3186c4SPaolo Bonzini     qemu_mutex_destroy(&s->mutex);
902031fd1beSPeter Maydell 
903a94f83d9SRichard W.M. Jones     g_free(s->cookie);
90445724d6dSStefan Weil     g_free(s->url);
905769ce76dSAlexander Graf }
906769ce76dSAlexander Graf 
907769ce76dSAlexander Graf static int64_t curl_getlength(BlockDriverState *bs)
908769ce76dSAlexander Graf {
909769ce76dSAlexander Graf     BDRVCURLState *s = bs->opaque;
910769ce76dSAlexander Graf     return s->len;
911769ce76dSAlexander Graf }
912769ce76dSAlexander Graf 
913769ce76dSAlexander Graf static BlockDriver bdrv_http = {
914769ce76dSAlexander Graf     .format_name                = "http",
915769ce76dSAlexander Graf     .protocol_name              = "http",
916769ce76dSAlexander Graf 
917769ce76dSAlexander Graf     .instance_size              = sizeof(BDRVCURLState),
9188e6d58cdSKevin Wolf     .bdrv_parse_filename        = curl_parse_filename,
91966f82ceeSKevin Wolf     .bdrv_file_open             = curl_open,
920769ce76dSAlexander Graf     .bdrv_close                 = curl_close,
921769ce76dSAlexander Graf     .bdrv_getlength             = curl_getlength,
922769ce76dSAlexander Graf 
923769ce76dSAlexander Graf     .bdrv_aio_readv             = curl_aio_readv,
92463f0f45fSStefan Hajnoczi 
92563f0f45fSStefan Hajnoczi     .bdrv_detach_aio_context    = curl_detach_aio_context,
92663f0f45fSStefan Hajnoczi     .bdrv_attach_aio_context    = curl_attach_aio_context,
927769ce76dSAlexander Graf };
928769ce76dSAlexander Graf 
929769ce76dSAlexander Graf static BlockDriver bdrv_https = {
930769ce76dSAlexander Graf     .format_name                = "https",
931769ce76dSAlexander Graf     .protocol_name              = "https",
932769ce76dSAlexander Graf 
933769ce76dSAlexander Graf     .instance_size              = sizeof(BDRVCURLState),
9348e6d58cdSKevin Wolf     .bdrv_parse_filename        = curl_parse_filename,
93566f82ceeSKevin Wolf     .bdrv_file_open             = curl_open,
936769ce76dSAlexander Graf     .bdrv_close                 = curl_close,
937769ce76dSAlexander Graf     .bdrv_getlength             = curl_getlength,
938769ce76dSAlexander Graf 
939769ce76dSAlexander Graf     .bdrv_aio_readv             = curl_aio_readv,
94063f0f45fSStefan Hajnoczi 
94163f0f45fSStefan Hajnoczi     .bdrv_detach_aio_context    = curl_detach_aio_context,
94263f0f45fSStefan Hajnoczi     .bdrv_attach_aio_context    = curl_attach_aio_context,
943769ce76dSAlexander Graf };
944769ce76dSAlexander Graf 
945769ce76dSAlexander Graf static BlockDriver bdrv_ftp = {
946769ce76dSAlexander Graf     .format_name                = "ftp",
947769ce76dSAlexander Graf     .protocol_name              = "ftp",
948769ce76dSAlexander Graf 
949769ce76dSAlexander Graf     .instance_size              = sizeof(BDRVCURLState),
9508e6d58cdSKevin Wolf     .bdrv_parse_filename        = curl_parse_filename,
95166f82ceeSKevin Wolf     .bdrv_file_open             = curl_open,
952769ce76dSAlexander Graf     .bdrv_close                 = curl_close,
953769ce76dSAlexander Graf     .bdrv_getlength             = curl_getlength,
954769ce76dSAlexander Graf 
955769ce76dSAlexander Graf     .bdrv_aio_readv             = curl_aio_readv,
95663f0f45fSStefan Hajnoczi 
95763f0f45fSStefan Hajnoczi     .bdrv_detach_aio_context    = curl_detach_aio_context,
95863f0f45fSStefan Hajnoczi     .bdrv_attach_aio_context    = curl_attach_aio_context,
959769ce76dSAlexander Graf };
960769ce76dSAlexander Graf 
961769ce76dSAlexander Graf static BlockDriver bdrv_ftps = {
962769ce76dSAlexander Graf     .format_name                = "ftps",
963769ce76dSAlexander Graf     .protocol_name              = "ftps",
964769ce76dSAlexander Graf 
965769ce76dSAlexander Graf     .instance_size              = sizeof(BDRVCURLState),
9668e6d58cdSKevin Wolf     .bdrv_parse_filename        = curl_parse_filename,
96766f82ceeSKevin Wolf     .bdrv_file_open             = curl_open,
968769ce76dSAlexander Graf     .bdrv_close                 = curl_close,
969769ce76dSAlexander Graf     .bdrv_getlength             = curl_getlength,
970769ce76dSAlexander Graf 
971769ce76dSAlexander Graf     .bdrv_aio_readv             = curl_aio_readv,
97263f0f45fSStefan Hajnoczi 
97363f0f45fSStefan Hajnoczi     .bdrv_detach_aio_context    = curl_detach_aio_context,
97463f0f45fSStefan Hajnoczi     .bdrv_attach_aio_context    = curl_attach_aio_context,
975769ce76dSAlexander Graf };
976769ce76dSAlexander Graf 
977769ce76dSAlexander Graf static void curl_block_init(void)
978769ce76dSAlexander Graf {
979769ce76dSAlexander Graf     bdrv_register(&bdrv_http);
980769ce76dSAlexander Graf     bdrv_register(&bdrv_https);
981769ce76dSAlexander Graf     bdrv_register(&bdrv_ftp);
982769ce76dSAlexander Graf     bdrv_register(&bdrv_ftps);
983769ce76dSAlexander Graf }
984769ce76dSAlexander Graf 
985769ce76dSAlexander Graf block_init(curl_block_init);
986