xref: /openbmc/qemu/block/curl.c (revision 3ce6a729b5d78b13283ddc6c529811f67519a62d)
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"
88327c8ebdSPeter Krempa #define CURL_BLOCK_OPT_COOKIE_SECRET "cookie-secret"
891bff9606SDaniel P. Berrange #define CURL_BLOCK_OPT_USERNAME "username"
901bff9606SDaniel P. Berrange #define CURL_BLOCK_OPT_PASSWORD_SECRET "password-secret"
911bff9606SDaniel P. Berrange #define CURL_BLOCK_OPT_PROXY_USERNAME "proxy-username"
921bff9606SDaniel P. Berrange #define CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET "proxy-password-secret"
93e3542c67SMatthew Booth 
94769ce76dSAlexander Graf struct BDRVCURLState;
95769ce76dSAlexander Graf 
96769ce76dSAlexander Graf typedef struct CURLAIOCB {
977c84b1b8SMarkus Armbruster     BlockAIOCB common;
98769ce76dSAlexander Graf     QEMUIOVector *qiov;
99363c3c85SNick Thomas 
100363c3c85SNick Thomas     int64_t sector_num;
101363c3c85SNick Thomas     int nb_sectors;
102363c3c85SNick Thomas 
103769ce76dSAlexander Graf     size_t start;
104769ce76dSAlexander Graf     size_t end;
105769ce76dSAlexander Graf } CURLAIOCB;
106769ce76dSAlexander Graf 
107ff5ca166SMax Reitz typedef struct CURLSocket {
108ff5ca166SMax Reitz     int fd;
109ff5ca166SMax Reitz     QLIST_ENTRY(CURLSocket) next;
110ff5ca166SMax Reitz } CURLSocket;
111ff5ca166SMax Reitz 
112769ce76dSAlexander Graf typedef struct CURLState
113769ce76dSAlexander Graf {
114769ce76dSAlexander Graf     struct BDRVCURLState *s;
115769ce76dSAlexander Graf     CURLAIOCB *acb[CURL_NUM_ACB];
116769ce76dSAlexander Graf     CURL *curl;
117ff5ca166SMax Reitz     QLIST_HEAD(, CURLSocket) sockets;
118769ce76dSAlexander Graf     char *orig_buf;
119769ce76dSAlexander Graf     size_t buf_start;
120769ce76dSAlexander Graf     size_t buf_off;
121769ce76dSAlexander Graf     size_t buf_len;
122769ce76dSAlexander Graf     char range[128];
123769ce76dSAlexander Graf     char errmsg[CURL_ERROR_SIZE];
124769ce76dSAlexander Graf     char in_use;
125769ce76dSAlexander Graf } CURLState;
126769ce76dSAlexander Graf 
127769ce76dSAlexander Graf typedef struct BDRVCURLState {
128769ce76dSAlexander Graf     CURLM *multi;
129031fd1beSPeter Maydell     QEMUTimer timer;
130769ce76dSAlexander Graf     size_t len;
131769ce76dSAlexander Graf     CURLState states[CURL_NUM_STATES];
132769ce76dSAlexander Graf     char *url;
133c76f4952SNolan     size_t readahead_size;
13497a3ea57SMatthew Booth     bool sslverify;
135f76faedaSRichard W.M. Jones     uint64_t timeout;
136a94f83d9SRichard W.M. Jones     char *cookie;
1373494d650SFam Zheng     bool accept_range;
13863f0f45fSStefan Hajnoczi     AioContext *aio_context;
139ba3186c4SPaolo Bonzini     QemuMutex mutex;
1401bff9606SDaniel P. Berrange     char *username;
1411bff9606SDaniel P. Berrange     char *password;
1421bff9606SDaniel P. Berrange     char *proxyusername;
1431bff9606SDaniel P. Berrange     char *proxypassword;
144769ce76dSAlexander Graf } BDRVCURLState;
145769ce76dSAlexander Graf 
146769ce76dSAlexander Graf static void curl_clean_state(CURLState *s);
147769ce76dSAlexander Graf static void curl_multi_do(void *arg);
148838ef602SMatthew Booth static void curl_multi_read(void *arg);
149769ce76dSAlexander Graf 
150031fd1beSPeter Maydell #ifdef NEED_CURL_TIMER_CALLBACK
15134db05e7SPaolo Bonzini /* Called from curl_multi_do_locked, with s->mutex held.  */
152031fd1beSPeter Maydell static int curl_timer_cb(CURLM *multi, long timeout_ms, void *opaque)
153031fd1beSPeter Maydell {
154031fd1beSPeter Maydell     BDRVCURLState *s = opaque;
155031fd1beSPeter Maydell 
156031fd1beSPeter Maydell     DPRINTF("CURL: timer callback timeout_ms %ld\n", timeout_ms);
157031fd1beSPeter Maydell     if (timeout_ms == -1) {
158031fd1beSPeter Maydell         timer_del(&s->timer);
159031fd1beSPeter Maydell     } else {
160031fd1beSPeter Maydell         int64_t timeout_ns = (int64_t)timeout_ms * 1000 * 1000;
161031fd1beSPeter Maydell         timer_mod(&s->timer,
162031fd1beSPeter Maydell                   qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + timeout_ns);
163031fd1beSPeter Maydell     }
164031fd1beSPeter Maydell     return 0;
165031fd1beSPeter Maydell }
166031fd1beSPeter Maydell #endif
167031fd1beSPeter Maydell 
16834db05e7SPaolo Bonzini /* Called from curl_multi_do_locked, with s->mutex held.  */
169769ce76dSAlexander Graf static int curl_sock_cb(CURL *curl, curl_socket_t fd, int action,
17063f0f45fSStefan Hajnoczi                         void *userp, void *sp)
171769ce76dSAlexander Graf {
17263f0f45fSStefan Hajnoczi     BDRVCURLState *s;
173838ef602SMatthew Booth     CURLState *state = NULL;
174ff5ca166SMax Reitz     CURLSocket *socket;
175ff5ca166SMax Reitz 
176838ef602SMatthew Booth     curl_easy_getinfo(curl, CURLINFO_PRIVATE, (char **)&state);
17763f0f45fSStefan Hajnoczi     s = state->s;
178838ef602SMatthew Booth 
179ff5ca166SMax Reitz     QLIST_FOREACH(socket, &state->sockets, next) {
180ff5ca166SMax Reitz         if (socket->fd == fd) {
181ff5ca166SMax Reitz             if (action == CURL_POLL_REMOVE) {
182ff5ca166SMax Reitz                 QLIST_REMOVE(socket, next);
183ff5ca166SMax Reitz                 g_free(socket);
184ff5ca166SMax Reitz             }
185ff5ca166SMax Reitz             break;
186ff5ca166SMax Reitz         }
187ff5ca166SMax Reitz     }
188ff5ca166SMax Reitz     if (!socket) {
189ff5ca166SMax Reitz         socket = g_new0(CURLSocket, 1);
190ff5ca166SMax Reitz         socket->fd = fd;
191ff5ca166SMax Reitz         QLIST_INSERT_HEAD(&state->sockets, socket, next);
192ff5ca166SMax Reitz     }
193ff5ca166SMax Reitz     socket = NULL;
194ff5ca166SMax Reitz 
19592b6a160SFam Zheng     DPRINTF("CURL (AIO): Sock action %d on fd %d\n", action, (int)fd);
196769ce76dSAlexander Graf     switch (action) {
197769ce76dSAlexander Graf         case CURL_POLL_IN:
198dca21ef2SFam Zheng             aio_set_fd_handler(s->aio_context, fd, false,
199f6a51c84SStefan Hajnoczi                                curl_multi_read, NULL, NULL, state);
200769ce76dSAlexander Graf             break;
201769ce76dSAlexander Graf         case CURL_POLL_OUT:
202dca21ef2SFam Zheng             aio_set_fd_handler(s->aio_context, fd, false,
203f6a51c84SStefan Hajnoczi                                NULL, curl_multi_do, NULL, state);
204769ce76dSAlexander Graf             break;
205769ce76dSAlexander Graf         case CURL_POLL_INOUT:
206dca21ef2SFam Zheng             aio_set_fd_handler(s->aio_context, fd, false,
207f6a51c84SStefan Hajnoczi                                curl_multi_read, curl_multi_do, NULL, state);
208769ce76dSAlexander Graf             break;
209769ce76dSAlexander Graf         case CURL_POLL_REMOVE:
210dca21ef2SFam Zheng             aio_set_fd_handler(s->aio_context, fd, false,
211f6a51c84SStefan Hajnoczi                                NULL, NULL, NULL, NULL);
212769ce76dSAlexander Graf             break;
213769ce76dSAlexander Graf     }
214769ce76dSAlexander Graf 
215769ce76dSAlexander Graf     return 0;
216769ce76dSAlexander Graf }
217769ce76dSAlexander Graf 
21834db05e7SPaolo Bonzini /* Called from curl_multi_do_locked, with s->mutex held.  */
2193494d650SFam Zheng static size_t curl_header_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
220769ce76dSAlexander Graf {
2213494d650SFam Zheng     BDRVCURLState *s = opaque;
222769ce76dSAlexander Graf     size_t realsize = size * nmemb;
2233494d650SFam Zheng     const char *accept_line = "Accept-Ranges: bytes";
224769ce76dSAlexander Graf 
2253494d650SFam Zheng     if (realsize >= strlen(accept_line)
2263494d650SFam Zheng         && strncmp((char *)ptr, accept_line, strlen(accept_line)) == 0) {
2273494d650SFam Zheng         s->accept_range = true;
2280bfcd599SBlue Swirl     }
229769ce76dSAlexander Graf 
230769ce76dSAlexander Graf     return realsize;
231769ce76dSAlexander Graf }
232769ce76dSAlexander Graf 
23334db05e7SPaolo Bonzini /* Called from curl_multi_do_locked, with s->mutex held.  */
234769ce76dSAlexander Graf static size_t curl_read_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
235769ce76dSAlexander Graf {
236769ce76dSAlexander Graf     CURLState *s = ((CURLState*)opaque);
237769ce76dSAlexander Graf     size_t realsize = size * nmemb;
238769ce76dSAlexander Graf     int i;
239769ce76dSAlexander Graf 
2400bfcd599SBlue Swirl     DPRINTF("CURL: Just reading %zd bytes\n", realsize);
241769ce76dSAlexander Graf 
2424e767657SMax Reitz     if (!s || !s->orig_buf) {
2434e767657SMax Reitz         goto read_end;
2444e767657SMax Reitz     }
245769ce76dSAlexander Graf 
2466d4b9e55SFam Zheng     if (s->buf_off >= s->buf_len) {
2476d4b9e55SFam Zheng         /* buffer full, read nothing */
2484e767657SMax Reitz         goto read_end;
2496d4b9e55SFam Zheng     }
2506d4b9e55SFam Zheng     realsize = MIN(realsize, s->buf_len - s->buf_off);
251769ce76dSAlexander Graf     memcpy(s->orig_buf + s->buf_off, ptr, realsize);
252769ce76dSAlexander Graf     s->buf_off += realsize;
253769ce76dSAlexander Graf 
254769ce76dSAlexander Graf     for(i=0; i<CURL_NUM_ACB; i++) {
255769ce76dSAlexander Graf         CURLAIOCB *acb = s->acb[i];
256769ce76dSAlexander Graf 
257769ce76dSAlexander Graf         if (!acb)
258769ce76dSAlexander Graf             continue;
259769ce76dSAlexander Graf 
260769ce76dSAlexander Graf         if ((s->buf_off >= acb->end)) {
2614e504535SMax Reitz             size_t request_length = acb->nb_sectors * BDRV_SECTOR_SIZE;
2624e504535SMax Reitz 
26303396148SMichael Tokarev             qemu_iovec_from_buf(acb->qiov, 0, s->orig_buf + acb->start,
264769ce76dSAlexander Graf                                 acb->end - acb->start);
2654e504535SMax Reitz 
2664e504535SMax Reitz             if (acb->end - acb->start < request_length) {
2674e504535SMax Reitz                 size_t offset = acb->end - acb->start;
2684e504535SMax Reitz                 qemu_iovec_memset(acb->qiov, offset, 0,
2694e504535SMax Reitz                                   request_length - offset);
2704e504535SMax Reitz             }
2714e504535SMax Reitz 
27234db05e7SPaolo Bonzini             qemu_mutex_unlock(&s->s->mutex);
273769ce76dSAlexander Graf             acb->common.cb(acb->common.opaque, 0);
27434db05e7SPaolo Bonzini             qemu_mutex_lock(&s->s->mutex);
2758007429aSFam Zheng             qemu_aio_unref(acb);
276769ce76dSAlexander Graf             s->acb[i] = NULL;
277769ce76dSAlexander Graf         }
278769ce76dSAlexander Graf     }
279769ce76dSAlexander Graf 
2804e767657SMax Reitz read_end:
2814e767657SMax Reitz     /* curl will error out if we do not return this value */
2824e767657SMax Reitz     return size * nmemb;
283769ce76dSAlexander Graf }
284769ce76dSAlexander Graf 
285456af346SPaolo Bonzini /* Called with s->mutex held.  */
286769ce76dSAlexander Graf static int curl_find_buf(BDRVCURLState *s, size_t start, size_t len,
287769ce76dSAlexander Graf                          CURLAIOCB *acb)
288769ce76dSAlexander Graf {
289769ce76dSAlexander Graf     int i;
290769ce76dSAlexander Graf     size_t end = start + len;
2914e504535SMax Reitz     size_t clamped_end = MIN(end, s->len);
2924e504535SMax Reitz     size_t clamped_len = clamped_end - start;
293769ce76dSAlexander Graf 
294769ce76dSAlexander Graf     for (i=0; i<CURL_NUM_STATES; i++) {
295769ce76dSAlexander Graf         CURLState *state = &s->states[i];
296769ce76dSAlexander Graf         size_t buf_end = (state->buf_start + state->buf_off);
297769ce76dSAlexander Graf         size_t buf_fend = (state->buf_start + state->buf_len);
298769ce76dSAlexander Graf 
299769ce76dSAlexander Graf         if (!state->orig_buf)
300769ce76dSAlexander Graf             continue;
301769ce76dSAlexander Graf         if (!state->buf_off)
302769ce76dSAlexander Graf             continue;
303769ce76dSAlexander Graf 
304769ce76dSAlexander Graf         // Does the existing buffer cover our section?
305769ce76dSAlexander Graf         if ((start >= state->buf_start) &&
306769ce76dSAlexander Graf             (start <= buf_end) &&
3074e504535SMax Reitz             (clamped_end >= state->buf_start) &&
3084e504535SMax Reitz             (clamped_end <= buf_end))
309769ce76dSAlexander Graf         {
310769ce76dSAlexander Graf             char *buf = state->orig_buf + (start - state->buf_start);
311769ce76dSAlexander Graf 
3124e504535SMax Reitz             qemu_iovec_from_buf(acb->qiov, 0, buf, clamped_len);
3134e504535SMax Reitz             if (clamped_len < len) {
3144e504535SMax Reitz                 qemu_iovec_memset(acb->qiov, clamped_len, 0, len - clamped_len);
3154e504535SMax Reitz             }
316769ce76dSAlexander Graf             return FIND_RET_OK;
317769ce76dSAlexander Graf         }
318769ce76dSAlexander Graf 
319769ce76dSAlexander Graf         // Wait for unfinished chunks
320b7079df4SMatthew Booth         if (state->in_use &&
321b7079df4SMatthew Booth             (start >= state->buf_start) &&
322769ce76dSAlexander Graf             (start <= buf_fend) &&
3234e504535SMax Reitz             (clamped_end >= state->buf_start) &&
3244e504535SMax Reitz             (clamped_end <= buf_fend))
325769ce76dSAlexander Graf         {
326769ce76dSAlexander Graf             int j;
327769ce76dSAlexander Graf 
328769ce76dSAlexander Graf             acb->start = start - state->buf_start;
3294e504535SMax Reitz             acb->end = acb->start + clamped_len;
330769ce76dSAlexander Graf 
331769ce76dSAlexander Graf             for (j=0; j<CURL_NUM_ACB; j++) {
332769ce76dSAlexander Graf                 if (!state->acb[j]) {
333769ce76dSAlexander Graf                     state->acb[j] = acb;
334769ce76dSAlexander Graf                     return FIND_RET_WAIT;
335769ce76dSAlexander Graf                 }
336769ce76dSAlexander Graf             }
337769ce76dSAlexander Graf         }
338769ce76dSAlexander Graf     }
339769ce76dSAlexander Graf 
340769ce76dSAlexander Graf     return FIND_RET_NONE;
341769ce76dSAlexander Graf }
342769ce76dSAlexander Graf 
343ba3186c4SPaolo Bonzini /* Called with s->mutex held.  */
344838ef602SMatthew Booth static void curl_multi_check_completion(BDRVCURLState *s)
345769ce76dSAlexander Graf {
346769ce76dSAlexander Graf     int msgs_in_queue;
347769ce76dSAlexander Graf 
348769ce76dSAlexander Graf     /* Try to find done transfers, so we can free the easy
349769ce76dSAlexander Graf      * handle again. */
3501f2cead3SMatthew Booth     for (;;) {
351769ce76dSAlexander Graf         CURLMsg *msg;
352769ce76dSAlexander Graf         msg = curl_multi_info_read(s->multi, &msgs_in_queue);
353769ce76dSAlexander Graf 
3541f2cead3SMatthew Booth         /* Quit when there are no more completions */
355769ce76dSAlexander Graf         if (!msg)
356769ce76dSAlexander Graf             break;
357769ce76dSAlexander Graf 
3581f2cead3SMatthew Booth         if (msg->msg == CURLMSG_DONE) {
359769ce76dSAlexander Graf             CURLState *state = NULL;
360f6246509SMatthew Booth             curl_easy_getinfo(msg->easy_handle, CURLINFO_PRIVATE,
361f6246509SMatthew Booth                               (char **)&state);
362f785a5aeSNicholas Thomas 
363f785a5aeSNicholas Thomas             /* ACBs for successful messages get completed in curl_read_cb */
364f785a5aeSNicholas Thomas             if (msg->data.result != CURLE_OK) {
365f785a5aeSNicholas Thomas                 int i;
366796a060bSRichard W.M. Jones                 static int errcount = 100;
367796a060bSRichard W.M. Jones 
368796a060bSRichard W.M. Jones                 /* Don't lose the original error message from curl, since
369796a060bSRichard W.M. Jones                  * it contains extra data.
370796a060bSRichard W.M. Jones                  */
371796a060bSRichard W.M. Jones                 if (errcount > 0) {
372796a060bSRichard W.M. Jones                     error_report("curl: %s", state->errmsg);
373796a060bSRichard W.M. Jones                     if (--errcount == 0) {
374796a060bSRichard W.M. Jones                         error_report("curl: further errors suppressed");
375796a060bSRichard W.M. Jones                     }
376796a060bSRichard W.M. Jones                 }
377796a060bSRichard W.M. Jones 
378f785a5aeSNicholas Thomas                 for (i = 0; i < CURL_NUM_ACB; i++) {
379f785a5aeSNicholas Thomas                     CURLAIOCB *acb = state->acb[i];
380f785a5aeSNicholas Thomas 
381f785a5aeSNicholas Thomas                     if (acb == NULL) {
382f785a5aeSNicholas Thomas                         continue;
383f785a5aeSNicholas Thomas                     }
384f785a5aeSNicholas Thomas 
385ba3186c4SPaolo Bonzini                     qemu_mutex_unlock(&s->mutex);
386eb048026SPaolo Bonzini                     acb->common.cb(acb->common.opaque, -EIO);
387ba3186c4SPaolo Bonzini                     qemu_mutex_lock(&s->mutex);
3888007429aSFam Zheng                     qemu_aio_unref(acb);
389f785a5aeSNicholas Thomas                     state->acb[i] = NULL;
390f785a5aeSNicholas Thomas                 }
391f785a5aeSNicholas Thomas             }
392f785a5aeSNicholas Thomas 
393769ce76dSAlexander Graf             curl_clean_state(state);
394769ce76dSAlexander Graf             break;
395769ce76dSAlexander Graf         }
396769ce76dSAlexander Graf     }
397769ce76dSAlexander Graf }
398769ce76dSAlexander Graf 
399ba3186c4SPaolo Bonzini /* Called with s->mutex held.  */
4009d456654SPaolo Bonzini static void curl_multi_do_locked(CURLState *s)
401031fd1beSPeter Maydell {
402ff5ca166SMax Reitz     CURLSocket *socket, *next_socket;
403031fd1beSPeter Maydell     int running;
404031fd1beSPeter Maydell     int r;
405031fd1beSPeter Maydell 
406838ef602SMatthew Booth     if (!s->s->multi) {
407031fd1beSPeter Maydell         return;
408031fd1beSPeter Maydell     }
409031fd1beSPeter Maydell 
410ff5ca166SMax Reitz     /* Need to use _SAFE because curl_multi_socket_action() may trigger
411ff5ca166SMax Reitz      * curl_sock_cb() which might modify this list */
412ff5ca166SMax Reitz     QLIST_FOREACH_SAFE(socket, &s->sockets, next, next_socket) {
413031fd1beSPeter Maydell         do {
414ff5ca166SMax Reitz             r = curl_multi_socket_action(s->s->multi, socket->fd, 0, &running);
415031fd1beSPeter Maydell         } while (r == CURLM_CALL_MULTI_PERFORM);
416ff5ca166SMax Reitz     }
417838ef602SMatthew Booth }
418838ef602SMatthew Booth 
4199d456654SPaolo Bonzini static void curl_multi_do(void *arg)
4209d456654SPaolo Bonzini {
4219d456654SPaolo Bonzini     CURLState *s = (CURLState *)arg;
4229d456654SPaolo Bonzini 
423ba3186c4SPaolo Bonzini     qemu_mutex_lock(&s->s->mutex);
4249d456654SPaolo Bonzini     curl_multi_do_locked(s);
425ba3186c4SPaolo Bonzini     qemu_mutex_unlock(&s->s->mutex);
4269d456654SPaolo Bonzini }
4279d456654SPaolo Bonzini 
428838ef602SMatthew Booth static void curl_multi_read(void *arg)
429838ef602SMatthew Booth {
430838ef602SMatthew Booth     CURLState *s = (CURLState *)arg;
431838ef602SMatthew Booth 
432ba3186c4SPaolo Bonzini     qemu_mutex_lock(&s->s->mutex);
4339d456654SPaolo Bonzini     curl_multi_do_locked(s);
434838ef602SMatthew Booth     curl_multi_check_completion(s->s);
435ba3186c4SPaolo Bonzini     qemu_mutex_unlock(&s->s->mutex);
436031fd1beSPeter Maydell }
437031fd1beSPeter Maydell 
438031fd1beSPeter Maydell static void curl_multi_timeout_do(void *arg)
439031fd1beSPeter Maydell {
440031fd1beSPeter Maydell #ifdef NEED_CURL_TIMER_CALLBACK
441031fd1beSPeter Maydell     BDRVCURLState *s = (BDRVCURLState *)arg;
442031fd1beSPeter Maydell     int running;
443031fd1beSPeter Maydell 
444031fd1beSPeter Maydell     if (!s->multi) {
445031fd1beSPeter Maydell         return;
446031fd1beSPeter Maydell     }
447031fd1beSPeter Maydell 
448ba3186c4SPaolo Bonzini     qemu_mutex_lock(&s->mutex);
449031fd1beSPeter Maydell     curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
450031fd1beSPeter Maydell 
451838ef602SMatthew Booth     curl_multi_check_completion(s);
452ba3186c4SPaolo Bonzini     qemu_mutex_unlock(&s->mutex);
453031fd1beSPeter Maydell #else
454031fd1beSPeter Maydell     abort();
455031fd1beSPeter Maydell #endif
456031fd1beSPeter Maydell }
457031fd1beSPeter Maydell 
458456af346SPaolo Bonzini /* Called with s->mutex held.  */
459*3ce6a729SPaolo Bonzini static CURLState *curl_find_state(BDRVCURLState *s)
460769ce76dSAlexander Graf {
461769ce76dSAlexander Graf     CURLState *state = NULL;
462*3ce6a729SPaolo Bonzini     int i;
463769ce76dSAlexander Graf 
464769ce76dSAlexander Graf     for (i = 0; i < CURL_NUM_STATES; i++) {
465*3ce6a729SPaolo Bonzini         if (!s->states[i].in_use) {
466769ce76dSAlexander Graf             state = &s->states[i];
467769ce76dSAlexander Graf             state->in_use = 1;
468769ce76dSAlexander Graf             break;
469769ce76dSAlexander Graf         }
470769ce76dSAlexander Graf     }
471*3ce6a729SPaolo Bonzini     return state;
472*3ce6a729SPaolo Bonzini }
473769ce76dSAlexander Graf 
474*3ce6a729SPaolo Bonzini static int curl_init_state(BDRVCURLState *s, CURLState *state)
475*3ce6a729SPaolo Bonzini {
4769e550b32SMatthew Booth     if (!state->curl) {
477769ce76dSAlexander Graf         state->curl = curl_easy_init();
4789e550b32SMatthew Booth         if (!state->curl) {
479*3ce6a729SPaolo Bonzini             return -EIO;
4809e550b32SMatthew Booth         }
481769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_URL, s->url);
48297a3ea57SMatthew Booth         curl_easy_setopt(state->curl, CURLOPT_SSL_VERIFYPEER,
48397a3ea57SMatthew Booth                          (long) s->sslverify);
484a94f83d9SRichard W.M. Jones         if (s->cookie) {
485a94f83d9SRichard W.M. Jones             curl_easy_setopt(state->curl, CURLOPT_COOKIE, s->cookie);
486a94f83d9SRichard W.M. Jones         }
487f76faedaSRichard W.M. Jones         curl_easy_setopt(state->curl, CURLOPT_TIMEOUT, (long)s->timeout);
4889e550b32SMatthew Booth         curl_easy_setopt(state->curl, CURLOPT_WRITEFUNCTION,
4899e550b32SMatthew Booth                          (void *)curl_read_cb);
490769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_WRITEDATA, (void *)state);
491769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_PRIVATE, (void *)state);
492769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_AUTOREFERER, 1);
493769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_FOLLOWLOCATION, 1);
494769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_NOSIGNAL, 1);
495769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_ERRORBUFFER, state->errmsg);
496f785a5aeSNicholas Thomas         curl_easy_setopt(state->curl, CURLOPT_FAILONERROR, 1);
497769ce76dSAlexander Graf 
4981bff9606SDaniel P. Berrange         if (s->username) {
4991bff9606SDaniel P. Berrange             curl_easy_setopt(state->curl, CURLOPT_USERNAME, s->username);
5001bff9606SDaniel P. Berrange         }
5011bff9606SDaniel P. Berrange         if (s->password) {
5021bff9606SDaniel P. Berrange             curl_easy_setopt(state->curl, CURLOPT_PASSWORD, s->password);
5031bff9606SDaniel P. Berrange         }
5041bff9606SDaniel P. Berrange         if (s->proxyusername) {
5051bff9606SDaniel P. Berrange             curl_easy_setopt(state->curl,
5061bff9606SDaniel P. Berrange                              CURLOPT_PROXYUSERNAME, s->proxyusername);
5071bff9606SDaniel P. Berrange         }
5081bff9606SDaniel P. Berrange         if (s->proxypassword) {
5091bff9606SDaniel P. Berrange             curl_easy_setopt(state->curl,
5101bff9606SDaniel P. Berrange                              CURLOPT_PROXYPASSWORD, s->proxypassword);
5111bff9606SDaniel P. Berrange         }
5121bff9606SDaniel P. Berrange 
513fb6d1bbdSStefan Hajnoczi         /* Restrict supported protocols to avoid security issues in the more
514fb6d1bbdSStefan Hajnoczi          * obscure protocols.  For example, do not allow POP3/SMTP/IMAP see
515fb6d1bbdSStefan Hajnoczi          * CVE-2013-0249.
5168a8f5840SStefan Hajnoczi          *
5178a8f5840SStefan Hajnoczi          * Restricting protocols is only supported from 7.19.4 upwards.
518fb6d1bbdSStefan Hajnoczi          */
5198a8f5840SStefan Hajnoczi #if LIBCURL_VERSION_NUM >= 0x071304
520fb6d1bbdSStefan Hajnoczi         curl_easy_setopt(state->curl, CURLOPT_PROTOCOLS, PROTOCOLS);
521fb6d1bbdSStefan Hajnoczi         curl_easy_setopt(state->curl, CURLOPT_REDIR_PROTOCOLS, PROTOCOLS);
5228a8f5840SStefan Hajnoczi #endif
523fb6d1bbdSStefan Hajnoczi 
524769ce76dSAlexander Graf #ifdef DEBUG_VERBOSE
525769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_VERBOSE, 1);
526769ce76dSAlexander Graf #endif
5279e550b32SMatthew Booth     }
528769ce76dSAlexander Graf 
529ff5ca166SMax Reitz     QLIST_INIT(&state->sockets);
530769ce76dSAlexander Graf     state->s = s;
531769ce76dSAlexander Graf 
532*3ce6a729SPaolo Bonzini     return 0;
533769ce76dSAlexander Graf }
534769ce76dSAlexander Graf 
535456af346SPaolo Bonzini /* Called with s->mutex held.  */
536769ce76dSAlexander Graf static void curl_clean_state(CURLState *s)
537769ce76dSAlexander Graf {
538675a7756SPaolo Bonzini     int j;
539675a7756SPaolo Bonzini     for (j = 0; j < CURL_NUM_ACB; j++) {
540675a7756SPaolo Bonzini         assert(!s->acb[j]);
541675a7756SPaolo Bonzini     }
542675a7756SPaolo Bonzini 
543769ce76dSAlexander Graf     if (s->s->multi)
544769ce76dSAlexander Graf         curl_multi_remove_handle(s->s->multi, s->curl);
545ff5ca166SMax Reitz 
546ff5ca166SMax Reitz     while (!QLIST_EMPTY(&s->sockets)) {
547ff5ca166SMax Reitz         CURLSocket *socket = QLIST_FIRST(&s->sockets);
548ff5ca166SMax Reitz 
549ff5ca166SMax Reitz         QLIST_REMOVE(socket, next);
550ff5ca166SMax Reitz         g_free(socket);
551ff5ca166SMax Reitz     }
552ff5ca166SMax Reitz 
553769ce76dSAlexander Graf     s->in_use = 0;
554769ce76dSAlexander Graf }
555769ce76dSAlexander Graf 
5568e6d58cdSKevin Wolf static void curl_parse_filename(const char *filename, QDict *options,
5578e6d58cdSKevin Wolf                                 Error **errp)
558769ce76dSAlexander Graf {
55946f5ac20SEric Blake     qdict_put_str(options, CURL_BLOCK_OPT_URL, filename);
5608e6d58cdSKevin Wolf }
5618e6d58cdSKevin Wolf 
56263f0f45fSStefan Hajnoczi static void curl_detach_aio_context(BlockDriverState *bs)
56363f0f45fSStefan Hajnoczi {
56463f0f45fSStefan Hajnoczi     BDRVCURLState *s = bs->opaque;
56563f0f45fSStefan Hajnoczi     int i;
56663f0f45fSStefan Hajnoczi 
567456af346SPaolo Bonzini     qemu_mutex_lock(&s->mutex);
56863f0f45fSStefan Hajnoczi     for (i = 0; i < CURL_NUM_STATES; i++) {
56963f0f45fSStefan Hajnoczi         if (s->states[i].in_use) {
57063f0f45fSStefan Hajnoczi             curl_clean_state(&s->states[i]);
57163f0f45fSStefan Hajnoczi         }
57263f0f45fSStefan Hajnoczi         if (s->states[i].curl) {
57363f0f45fSStefan Hajnoczi             curl_easy_cleanup(s->states[i].curl);
57463f0f45fSStefan Hajnoczi             s->states[i].curl = NULL;
57563f0f45fSStefan Hajnoczi         }
57663f0f45fSStefan Hajnoczi         g_free(s->states[i].orig_buf);
57763f0f45fSStefan Hajnoczi         s->states[i].orig_buf = NULL;
57863f0f45fSStefan Hajnoczi     }
57963f0f45fSStefan Hajnoczi     if (s->multi) {
58063f0f45fSStefan Hajnoczi         curl_multi_cleanup(s->multi);
58163f0f45fSStefan Hajnoczi         s->multi = NULL;
58263f0f45fSStefan Hajnoczi     }
583456af346SPaolo Bonzini     qemu_mutex_unlock(&s->mutex);
58463f0f45fSStefan Hajnoczi 
58563f0f45fSStefan Hajnoczi     timer_del(&s->timer);
58663f0f45fSStefan Hajnoczi }
58763f0f45fSStefan Hajnoczi 
58863f0f45fSStefan Hajnoczi static void curl_attach_aio_context(BlockDriverState *bs,
58963f0f45fSStefan Hajnoczi                                     AioContext *new_context)
59063f0f45fSStefan Hajnoczi {
59163f0f45fSStefan Hajnoczi     BDRVCURLState *s = bs->opaque;
59263f0f45fSStefan Hajnoczi 
59363f0f45fSStefan Hajnoczi     aio_timer_init(new_context, &s->timer,
59463f0f45fSStefan Hajnoczi                    QEMU_CLOCK_REALTIME, SCALE_NS,
59563f0f45fSStefan Hajnoczi                    curl_multi_timeout_do, s);
59663f0f45fSStefan Hajnoczi 
59763f0f45fSStefan Hajnoczi     assert(!s->multi);
59863f0f45fSStefan Hajnoczi     s->multi = curl_multi_init();
59963f0f45fSStefan Hajnoczi     s->aio_context = new_context;
60063f0f45fSStefan Hajnoczi     curl_multi_setopt(s->multi, CURLMOPT_SOCKETFUNCTION, curl_sock_cb);
60163f0f45fSStefan Hajnoczi #ifdef NEED_CURL_TIMER_CALLBACK
60263f0f45fSStefan Hajnoczi     curl_multi_setopt(s->multi, CURLMOPT_TIMERDATA, s);
60363f0f45fSStefan Hajnoczi     curl_multi_setopt(s->multi, CURLMOPT_TIMERFUNCTION, curl_timer_cb);
60463f0f45fSStefan Hajnoczi #endif
60563f0f45fSStefan Hajnoczi }
60663f0f45fSStefan Hajnoczi 
6078e6d58cdSKevin Wolf static QemuOptsList runtime_opts = {
6088e6d58cdSKevin Wolf     .name = "curl",
6098e6d58cdSKevin Wolf     .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
6108e6d58cdSKevin Wolf     .desc = {
6118e6d58cdSKevin Wolf         {
612e3542c67SMatthew Booth             .name = CURL_BLOCK_OPT_URL,
6138e6d58cdSKevin Wolf             .type = QEMU_OPT_STRING,
6148e6d58cdSKevin Wolf             .help = "URL to open",
6158e6d58cdSKevin Wolf         },
6168e6d58cdSKevin Wolf         {
617e3542c67SMatthew Booth             .name = CURL_BLOCK_OPT_READAHEAD,
6188e6d58cdSKevin Wolf             .type = QEMU_OPT_SIZE,
6198e6d58cdSKevin Wolf             .help = "Readahead size",
6208e6d58cdSKevin Wolf         },
62197a3ea57SMatthew Booth         {
62297a3ea57SMatthew Booth             .name = CURL_BLOCK_OPT_SSLVERIFY,
62397a3ea57SMatthew Booth             .type = QEMU_OPT_BOOL,
62497a3ea57SMatthew Booth             .help = "Verify SSL certificate"
62597a3ea57SMatthew Booth         },
626212aefaaSDaniel Henrique Barboza         {
627212aefaaSDaniel Henrique Barboza             .name = CURL_BLOCK_OPT_TIMEOUT,
628212aefaaSDaniel Henrique Barboza             .type = QEMU_OPT_NUMBER,
629212aefaaSDaniel Henrique Barboza             .help = "Curl timeout"
630212aefaaSDaniel Henrique Barboza         },
631a94f83d9SRichard W.M. Jones         {
632a94f83d9SRichard W.M. Jones             .name = CURL_BLOCK_OPT_COOKIE,
633a94f83d9SRichard W.M. Jones             .type = QEMU_OPT_STRING,
634a94f83d9SRichard W.M. Jones             .help = "Pass the cookie or list of cookies with each request"
635a94f83d9SRichard W.M. Jones         },
6361bff9606SDaniel P. Berrange         {
637327c8ebdSPeter Krempa             .name = CURL_BLOCK_OPT_COOKIE_SECRET,
638327c8ebdSPeter Krempa             .type = QEMU_OPT_STRING,
639327c8ebdSPeter Krempa             .help = "ID of secret used as cookie passed with each request"
640327c8ebdSPeter Krempa         },
641327c8ebdSPeter Krempa         {
6421bff9606SDaniel P. Berrange             .name = CURL_BLOCK_OPT_USERNAME,
6431bff9606SDaniel P. Berrange             .type = QEMU_OPT_STRING,
6441bff9606SDaniel P. Berrange             .help = "Username for HTTP auth"
6451bff9606SDaniel P. Berrange         },
6461bff9606SDaniel P. Berrange         {
6471bff9606SDaniel P. Berrange             .name = CURL_BLOCK_OPT_PASSWORD_SECRET,
6481bff9606SDaniel P. Berrange             .type = QEMU_OPT_STRING,
6491bff9606SDaniel P. Berrange             .help = "ID of secret used as password for HTTP auth",
6501bff9606SDaniel P. Berrange         },
6511bff9606SDaniel P. Berrange         {
6521bff9606SDaniel P. Berrange             .name = CURL_BLOCK_OPT_PROXY_USERNAME,
6531bff9606SDaniel P. Berrange             .type = QEMU_OPT_STRING,
6541bff9606SDaniel P. Berrange             .help = "Username for HTTP proxy auth"
6551bff9606SDaniel P. Berrange         },
6561bff9606SDaniel P. Berrange         {
6571bff9606SDaniel P. Berrange             .name = CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET,
6581bff9606SDaniel P. Berrange             .type = QEMU_OPT_STRING,
6591bff9606SDaniel P. Berrange             .help = "ID of secret used as password for HTTP proxy auth",
6601bff9606SDaniel P. Berrange         },
6618e6d58cdSKevin Wolf         { /* end of list */ }
6628e6d58cdSKevin Wolf     },
6638e6d58cdSKevin Wolf };
6648e6d58cdSKevin Wolf 
6651bff9606SDaniel P. Berrange 
666015a1036SMax Reitz static int curl_open(BlockDriverState *bs, QDict *options, int flags,
667015a1036SMax Reitz                      Error **errp)
6688e6d58cdSKevin Wolf {
6698e6d58cdSKevin Wolf     BDRVCURLState *s = bs->opaque;
6708e6d58cdSKevin Wolf     CURLState *state = NULL;
6718e6d58cdSKevin Wolf     QemuOpts *opts;
6728e6d58cdSKevin Wolf     Error *local_err = NULL;
6738e6d58cdSKevin Wolf     const char *file;
674a94f83d9SRichard W.M. Jones     const char *cookie;
675327c8ebdSPeter Krempa     const char *cookie_secret;
6768e6d58cdSKevin Wolf     double d;
6771bff9606SDaniel P. Berrange     const char *secretid;
67834634ca2SMax Reitz     const char *protocol_delimiter;
6798e6d58cdSKevin Wolf 
6808e6d58cdSKevin Wolf     static int inited = 0;
6818e6d58cdSKevin Wolf 
682a7cea2baSRichard W.M. Jones     if (flags & BDRV_O_RDWR) {
6832a94fee3SPaolo Bonzini         error_setg(errp, "curl block device does not support writes");
684a7cea2baSRichard W.M. Jones         return -EROFS;
685a7cea2baSRichard W.M. Jones     }
686a7cea2baSRichard W.M. Jones 
687456af346SPaolo Bonzini     qemu_mutex_init(&s->mutex);
68887ea75d5SPeter Crosthwaite     opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
6898e6d58cdSKevin Wolf     qemu_opts_absorb_qdict(opts, options, &local_err);
69084d18f06SMarkus Armbruster     if (local_err) {
6912a94fee3SPaolo Bonzini         error_propagate(errp, local_err);
6928e6d58cdSKevin Wolf         goto out_noclean;
6938e6d58cdSKevin Wolf     }
6948e6d58cdSKevin Wolf 
695e3542c67SMatthew Booth     s->readahead_size = qemu_opt_get_size(opts, CURL_BLOCK_OPT_READAHEAD,
696e3542c67SMatthew Booth                                           READ_AHEAD_DEFAULT);
697c76f4952SNolan     if ((s->readahead_size & 0x1ff) != 0) {
6982a94fee3SPaolo Bonzini         error_setg(errp, "HTTP_READAHEAD_SIZE %zd is not a multiple of 512",
699c76f4952SNolan                    s->readahead_size);
700c76f4952SNolan         goto out_noclean;
701c76f4952SNolan     }
702c76f4952SNolan 
703212aefaaSDaniel Henrique Barboza     s->timeout = qemu_opt_get_number(opts, CURL_BLOCK_OPT_TIMEOUT,
704212aefaaSDaniel Henrique Barboza                                      CURL_TIMEOUT_DEFAULT);
705f76faedaSRichard W.M. Jones     if (s->timeout > CURL_TIMEOUT_MAX) {
706f76faedaSRichard W.M. Jones         error_setg(errp, "timeout parameter is too large or negative");
707f76faedaSRichard W.M. Jones         goto out_noclean;
708f76faedaSRichard W.M. Jones     }
709212aefaaSDaniel Henrique Barboza 
71097a3ea57SMatthew Booth     s->sslverify = qemu_opt_get_bool(opts, CURL_BLOCK_OPT_SSLVERIFY, true);
71197a3ea57SMatthew Booth 
712a94f83d9SRichard W.M. Jones     cookie = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE);
713327c8ebdSPeter Krempa     cookie_secret = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE_SECRET);
714327c8ebdSPeter Krempa 
715327c8ebdSPeter Krempa     if (cookie && cookie_secret) {
716327c8ebdSPeter Krempa         error_setg(errp,
717327c8ebdSPeter Krempa                    "curl driver cannot handle both cookie and cookie secret");
718327c8ebdSPeter Krempa         goto out_noclean;
719327c8ebdSPeter Krempa     }
720327c8ebdSPeter Krempa 
721327c8ebdSPeter Krempa     if (cookie_secret) {
722327c8ebdSPeter Krempa         s->cookie = qcrypto_secret_lookup_as_utf8(cookie_secret, errp);
723327c8ebdSPeter Krempa         if (!s->cookie) {
724327c8ebdSPeter Krempa             goto out_noclean;
725327c8ebdSPeter Krempa         }
726327c8ebdSPeter Krempa     } else {
727a94f83d9SRichard W.M. Jones         s->cookie = g_strdup(cookie);
728327c8ebdSPeter Krempa     }
729a94f83d9SRichard W.M. Jones 
730e3542c67SMatthew Booth     file = qemu_opt_get(opts, CURL_BLOCK_OPT_URL);
7318e6d58cdSKevin Wolf     if (file == NULL) {
7322a94fee3SPaolo Bonzini         error_setg(errp, "curl block driver requires an 'url' option");
7338e6d58cdSKevin Wolf         goto out_noclean;
7348e6d58cdSKevin Wolf     }
7358e6d58cdSKevin Wolf 
73634634ca2SMax Reitz     if (!strstart(file, bs->drv->protocol_name, &protocol_delimiter) ||
73734634ca2SMax Reitz         !strstart(protocol_delimiter, "://", NULL))
73834634ca2SMax Reitz     {
73934634ca2SMax Reitz         error_setg(errp, "%s curl driver cannot handle the URL '%s' (does not "
74034634ca2SMax Reitz                    "start with '%s://')", bs->drv->protocol_name, file,
74134634ca2SMax Reitz                    bs->drv->protocol_name);
74234634ca2SMax Reitz         goto out_noclean;
74334634ca2SMax Reitz     }
74434634ca2SMax Reitz 
7451bff9606SDaniel P. Berrange     s->username = g_strdup(qemu_opt_get(opts, CURL_BLOCK_OPT_USERNAME));
7461bff9606SDaniel P. Berrange     secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PASSWORD_SECRET);
7471bff9606SDaniel P. Berrange 
7481bff9606SDaniel P. Berrange     if (secretid) {
7491bff9606SDaniel P. Berrange         s->password = qcrypto_secret_lookup_as_utf8(secretid, errp);
7501bff9606SDaniel P. Berrange         if (!s->password) {
7511bff9606SDaniel P. Berrange             goto out_noclean;
7521bff9606SDaniel P. Berrange         }
7531bff9606SDaniel P. Berrange     }
7541bff9606SDaniel P. Berrange 
7551bff9606SDaniel P. Berrange     s->proxyusername = g_strdup(
7561bff9606SDaniel P. Berrange         qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_USERNAME));
7571bff9606SDaniel P. Berrange     secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET);
7581bff9606SDaniel P. Berrange     if (secretid) {
7591bff9606SDaniel P. Berrange         s->proxypassword = qcrypto_secret_lookup_as_utf8(secretid, errp);
7601bff9606SDaniel P. Berrange         if (!s->proxypassword) {
7611bff9606SDaniel P. Berrange             goto out_noclean;
7621bff9606SDaniel P. Berrange         }
7631bff9606SDaniel P. Berrange     }
7641bff9606SDaniel P. Berrange 
765769ce76dSAlexander Graf     if (!inited) {
766769ce76dSAlexander Graf         curl_global_init(CURL_GLOBAL_ALL);
767769ce76dSAlexander Graf         inited = 1;
768769ce76dSAlexander Graf     }
769769ce76dSAlexander Graf 
770d0f2c4c6Smalc     DPRINTF("CURL: Opening %s\n", file);
77163f0f45fSStefan Hajnoczi     s->aio_context = bdrv_get_aio_context(bs);
7728e6d58cdSKevin Wolf     s->url = g_strdup(file);
773456af346SPaolo Bonzini     qemu_mutex_lock(&s->mutex);
774*3ce6a729SPaolo Bonzini     state = curl_find_state(s);
775456af346SPaolo Bonzini     qemu_mutex_unlock(&s->mutex);
776*3ce6a729SPaolo Bonzini     if (!state) {
777769ce76dSAlexander Graf         goto out_noclean;
778*3ce6a729SPaolo Bonzini     }
779769ce76dSAlexander Graf 
780769ce76dSAlexander Graf     // Get file size
781769ce76dSAlexander Graf 
782*3ce6a729SPaolo Bonzini     if (curl_init_state(s, state) < 0) {
783*3ce6a729SPaolo Bonzini         goto out;
784*3ce6a729SPaolo Bonzini     }
785*3ce6a729SPaolo Bonzini 
7863494d650SFam Zheng     s->accept_range = false;
787769ce76dSAlexander Graf     curl_easy_setopt(state->curl, CURLOPT_NOBODY, 1);
7883494d650SFam Zheng     curl_easy_setopt(state->curl, CURLOPT_HEADERFUNCTION,
7893494d650SFam Zheng                      curl_header_cb);
7903494d650SFam Zheng     curl_easy_setopt(state->curl, CURLOPT_HEADERDATA, s);
791769ce76dSAlexander Graf     if (curl_easy_perform(state->curl))
792769ce76dSAlexander Graf         goto out;
793a41c4578STomáš Golembiovský     if (curl_easy_getinfo(state->curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &d)) {
794769ce76dSAlexander Graf         goto out;
795a41c4578STomáš Golembiovský     }
796a41c4578STomáš Golembiovský     /* Prior CURL 7.19.4 return value of 0 could mean that the file size is not
797a41c4578STomáš Golembiovský      * know or the size is zero. From 7.19.4 CURL returns -1 if size is not
798a41c4578STomáš Golembiovský      * known and zero if it is realy zero-length file. */
799a41c4578STomáš Golembiovský #if LIBCURL_VERSION_NUM >= 0x071304
800a41c4578STomáš Golembiovský     if (d < 0) {
801a41c4578STomáš Golembiovský         pstrcpy(state->errmsg, CURL_ERROR_SIZE,
802a41c4578STomáš Golembiovský                 "Server didn't report file size.");
803a41c4578STomáš Golembiovský         goto out;
804a41c4578STomáš Golembiovský     }
805a41c4578STomáš Golembiovský #else
806a41c4578STomáš Golembiovský     if (d <= 0) {
807a41c4578STomáš Golembiovský         pstrcpy(state->errmsg, CURL_ERROR_SIZE,
808a41c4578STomáš Golembiovský                 "Unknown file size or zero-length file.");
809a41c4578STomáš Golembiovský         goto out;
810a41c4578STomáš Golembiovský     }
811a41c4578STomáš Golembiovský #endif
812a41c4578STomáš Golembiovský 
813a41c4578STomáš Golembiovský     s->len = (size_t)d;
814a41c4578STomáš Golembiovský 
8153494d650SFam Zheng     if ((!strncasecmp(s->url, "http://", strlen("http://"))
8163494d650SFam Zheng         || !strncasecmp(s->url, "https://", strlen("https://")))
8173494d650SFam Zheng         && !s->accept_range) {
8183494d650SFam Zheng         pstrcpy(state->errmsg, CURL_ERROR_SIZE,
8193494d650SFam Zheng                 "Server does not support 'range' (byte ranges).");
8203494d650SFam Zheng         goto out;
8213494d650SFam Zheng     }
8220bfcd599SBlue Swirl     DPRINTF("CURL: Size = %zd\n", s->len);
823769ce76dSAlexander Graf 
824456af346SPaolo Bonzini     qemu_mutex_lock(&s->mutex);
825769ce76dSAlexander Graf     curl_clean_state(state);
826456af346SPaolo Bonzini     qemu_mutex_unlock(&s->mutex);
827769ce76dSAlexander Graf     curl_easy_cleanup(state->curl);
828769ce76dSAlexander Graf     state->curl = NULL;
829769ce76dSAlexander Graf 
83063f0f45fSStefan Hajnoczi     curl_attach_aio_context(bs, bdrv_get_aio_context(bs));
831769ce76dSAlexander Graf 
8328e6d58cdSKevin Wolf     qemu_opts_del(opts);
833769ce76dSAlexander Graf     return 0;
834769ce76dSAlexander Graf 
835769ce76dSAlexander Graf out:
836acd7fdc6SMaria Kustova     error_setg(errp, "CURL: Error opening file: %s", state->errmsg);
837769ce76dSAlexander Graf     curl_easy_cleanup(state->curl);
838769ce76dSAlexander Graf     state->curl = NULL;
839769ce76dSAlexander Graf out_noclean:
840456af346SPaolo Bonzini     qemu_mutex_destroy(&s->mutex);
841a94f83d9SRichard W.M. Jones     g_free(s->cookie);
8428e6d58cdSKevin Wolf     g_free(s->url);
8438e6d58cdSKevin Wolf     qemu_opts_del(opts);
844769ce76dSAlexander Graf     return -EINVAL;
845769ce76dSAlexander Graf }
846769ce76dSAlexander Graf 
847d7331bedSStefan Hajnoczi static const AIOCBInfo curl_aiocb_info = {
848c16b5a2cSChristoph Hellwig     .aiocb_size         = sizeof(CURLAIOCB),
849c16b5a2cSChristoph Hellwig };
850c16b5a2cSChristoph Hellwig 
851363c3c85SNick Thomas 
852363c3c85SNick Thomas static void curl_readv_bh_cb(void *p)
853769ce76dSAlexander Graf {
854769ce76dSAlexander Graf     CURLState *state;
855b69cdef8SMatthew Booth     int running;
8561919631eSPaolo Bonzini     int ret = -EINPROGRESS;
857769ce76dSAlexander Graf 
858363c3c85SNick Thomas     CURLAIOCB *acb = p;
8591919631eSPaolo Bonzini     BlockDriverState *bs = acb->common.bs;
8601919631eSPaolo Bonzini     BDRVCURLState *s = bs->opaque;
861769ce76dSAlexander Graf 
8629054d9f6SMax Reitz     size_t start = acb->sector_num * BDRV_SECTOR_SIZE;
863363c3c85SNick Thomas     size_t end;
864769ce76dSAlexander Graf 
865ba3186c4SPaolo Bonzini     qemu_mutex_lock(&s->mutex);
8661919631eSPaolo Bonzini 
867769ce76dSAlexander Graf     // In case we have the requested data already (e.g. read-ahead),
868769ce76dSAlexander Graf     // we can just call the callback and be done.
8699054d9f6SMax Reitz     switch (curl_find_buf(s, start, acb->nb_sectors * BDRV_SECTOR_SIZE, acb)) {
870769ce76dSAlexander Graf         case FIND_RET_OK:
87134db05e7SPaolo Bonzini             ret = 0;
87234db05e7SPaolo Bonzini             goto out;
873769ce76dSAlexander Graf         case FIND_RET_WAIT:
8741919631eSPaolo Bonzini             goto out;
875769ce76dSAlexander Graf         default:
876769ce76dSAlexander Graf             break;
877769ce76dSAlexander Graf     }
878769ce76dSAlexander Graf 
879769ce76dSAlexander Graf     // No cache found, so let's start a new request
880*3ce6a729SPaolo Bonzini     for (;;) {
881*3ce6a729SPaolo Bonzini         state = curl_find_state(s);
882*3ce6a729SPaolo Bonzini         if (state) {
883*3ce6a729SPaolo Bonzini             break;
884*3ce6a729SPaolo Bonzini         }
885*3ce6a729SPaolo Bonzini         qemu_mutex_unlock(&s->mutex);
886*3ce6a729SPaolo Bonzini         aio_poll(bdrv_get_aio_context(bs), true);
887*3ce6a729SPaolo Bonzini         qemu_mutex_lock(&s->mutex);
888*3ce6a729SPaolo Bonzini     }
889*3ce6a729SPaolo Bonzini 
890*3ce6a729SPaolo Bonzini     if (curl_init_state(s, state) < 0) {
891*3ce6a729SPaolo Bonzini         curl_clean_state(state);
8921919631eSPaolo Bonzini         ret = -EIO;
8931919631eSPaolo Bonzini         goto out;
894363c3c85SNick Thomas     }
895769ce76dSAlexander Graf 
896769ce76dSAlexander Graf     acb->start = 0;
8974e504535SMax Reitz     acb->end = MIN(acb->nb_sectors * BDRV_SECTOR_SIZE, s->len - start);
898769ce76dSAlexander Graf 
899769ce76dSAlexander Graf     state->buf_off = 0;
9007267c094SAnthony Liguori     g_free(state->orig_buf);
901769ce76dSAlexander Graf     state->buf_start = start;
9024e504535SMax Reitz     state->buf_len = MIN(acb->end + s->readahead_size, s->len - start);
9034e504535SMax Reitz     end = start + state->buf_len - 1;
9048dc7a772SKevin Wolf     state->orig_buf = g_try_malloc(state->buf_len);
9058dc7a772SKevin Wolf     if (state->buf_len && state->orig_buf == NULL) {
9068dc7a772SKevin Wolf         curl_clean_state(state);
9071919631eSPaolo Bonzini         ret = -ENOMEM;
9081919631eSPaolo Bonzini         goto out;
9098dc7a772SKevin Wolf     }
910769ce76dSAlexander Graf     state->acb[0] = acb;
911769ce76dSAlexander Graf 
9120bfcd599SBlue Swirl     snprintf(state->range, 127, "%zd-%zd", start, end);
9139054d9f6SMax Reitz     DPRINTF("CURL (AIO): Reading %llu at %zd (%s)\n",
9149054d9f6SMax Reitz             (acb->nb_sectors * BDRV_SECTOR_SIZE), start, state->range);
915769ce76dSAlexander Graf     curl_easy_setopt(state->curl, CURLOPT_RANGE, state->range);
916769ce76dSAlexander Graf 
917769ce76dSAlexander Graf     curl_multi_add_handle(s->multi, state->curl);
918769ce76dSAlexander Graf 
919b69cdef8SMatthew Booth     /* Tell curl it needs to kick things off */
920b69cdef8SMatthew Booth     curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
9211919631eSPaolo Bonzini 
9221919631eSPaolo Bonzini out:
923ba3186c4SPaolo Bonzini     qemu_mutex_unlock(&s->mutex);
9241919631eSPaolo Bonzini     if (ret != -EINPROGRESS) {
9251919631eSPaolo Bonzini         acb->common.cb(acb->common.opaque, ret);
9261919631eSPaolo Bonzini         qemu_aio_unref(acb);
9271919631eSPaolo Bonzini     }
928363c3c85SNick Thomas }
929363c3c85SNick Thomas 
9307c84b1b8SMarkus Armbruster static BlockAIOCB *curl_aio_readv(BlockDriverState *bs,
931363c3c85SNick Thomas         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
932097310b5SMarkus Armbruster         BlockCompletionFunc *cb, void *opaque)
933363c3c85SNick Thomas {
934363c3c85SNick Thomas     CURLAIOCB *acb;
935363c3c85SNick Thomas 
936d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&curl_aiocb_info, bs, cb, opaque);
937363c3c85SNick Thomas 
938363c3c85SNick Thomas     acb->qiov = qiov;
939363c3c85SNick Thomas     acb->sector_num = sector_num;
940363c3c85SNick Thomas     acb->nb_sectors = nb_sectors;
941363c3c85SNick Thomas 
942fffb6e12SPaolo Bonzini     aio_bh_schedule_oneshot(bdrv_get_aio_context(bs), curl_readv_bh_cb, acb);
943769ce76dSAlexander Graf     return &acb->common;
944769ce76dSAlexander Graf }
945769ce76dSAlexander Graf 
946769ce76dSAlexander Graf static void curl_close(BlockDriverState *bs)
947769ce76dSAlexander Graf {
948769ce76dSAlexander Graf     BDRVCURLState *s = bs->opaque;
949769ce76dSAlexander Graf 
950d0f2c4c6Smalc     DPRINTF("CURL: Close\n");
95163f0f45fSStefan Hajnoczi     curl_detach_aio_context(bs);
952ba3186c4SPaolo Bonzini     qemu_mutex_destroy(&s->mutex);
953031fd1beSPeter Maydell 
954a94f83d9SRichard W.M. Jones     g_free(s->cookie);
95545724d6dSStefan Weil     g_free(s->url);
956769ce76dSAlexander Graf }
957769ce76dSAlexander Graf 
958769ce76dSAlexander Graf static int64_t curl_getlength(BlockDriverState *bs)
959769ce76dSAlexander Graf {
960769ce76dSAlexander Graf     BDRVCURLState *s = bs->opaque;
961769ce76dSAlexander Graf     return s->len;
962769ce76dSAlexander Graf }
963769ce76dSAlexander Graf 
964769ce76dSAlexander Graf static BlockDriver bdrv_http = {
965769ce76dSAlexander Graf     .format_name                = "http",
966769ce76dSAlexander Graf     .protocol_name              = "http",
967769ce76dSAlexander Graf 
968769ce76dSAlexander Graf     .instance_size              = sizeof(BDRVCURLState),
9698e6d58cdSKevin Wolf     .bdrv_parse_filename        = curl_parse_filename,
97066f82ceeSKevin Wolf     .bdrv_file_open             = curl_open,
971769ce76dSAlexander Graf     .bdrv_close                 = curl_close,
972769ce76dSAlexander Graf     .bdrv_getlength             = curl_getlength,
973769ce76dSAlexander Graf 
974769ce76dSAlexander Graf     .bdrv_aio_readv             = curl_aio_readv,
97563f0f45fSStefan Hajnoczi 
97663f0f45fSStefan Hajnoczi     .bdrv_detach_aio_context    = curl_detach_aio_context,
97763f0f45fSStefan Hajnoczi     .bdrv_attach_aio_context    = curl_attach_aio_context,
978769ce76dSAlexander Graf };
979769ce76dSAlexander Graf 
980769ce76dSAlexander Graf static BlockDriver bdrv_https = {
981769ce76dSAlexander Graf     .format_name                = "https",
982769ce76dSAlexander Graf     .protocol_name              = "https",
983769ce76dSAlexander Graf 
984769ce76dSAlexander Graf     .instance_size              = sizeof(BDRVCURLState),
9858e6d58cdSKevin Wolf     .bdrv_parse_filename        = curl_parse_filename,
98666f82ceeSKevin Wolf     .bdrv_file_open             = curl_open,
987769ce76dSAlexander Graf     .bdrv_close                 = curl_close,
988769ce76dSAlexander Graf     .bdrv_getlength             = curl_getlength,
989769ce76dSAlexander Graf 
990769ce76dSAlexander Graf     .bdrv_aio_readv             = curl_aio_readv,
99163f0f45fSStefan Hajnoczi 
99263f0f45fSStefan Hajnoczi     .bdrv_detach_aio_context    = curl_detach_aio_context,
99363f0f45fSStefan Hajnoczi     .bdrv_attach_aio_context    = curl_attach_aio_context,
994769ce76dSAlexander Graf };
995769ce76dSAlexander Graf 
996769ce76dSAlexander Graf static BlockDriver bdrv_ftp = {
997769ce76dSAlexander Graf     .format_name                = "ftp",
998769ce76dSAlexander Graf     .protocol_name              = "ftp",
999769ce76dSAlexander Graf 
1000769ce76dSAlexander Graf     .instance_size              = sizeof(BDRVCURLState),
10018e6d58cdSKevin Wolf     .bdrv_parse_filename        = curl_parse_filename,
100266f82ceeSKevin Wolf     .bdrv_file_open             = curl_open,
1003769ce76dSAlexander Graf     .bdrv_close                 = curl_close,
1004769ce76dSAlexander Graf     .bdrv_getlength             = curl_getlength,
1005769ce76dSAlexander Graf 
1006769ce76dSAlexander Graf     .bdrv_aio_readv             = curl_aio_readv,
100763f0f45fSStefan Hajnoczi 
100863f0f45fSStefan Hajnoczi     .bdrv_detach_aio_context    = curl_detach_aio_context,
100963f0f45fSStefan Hajnoczi     .bdrv_attach_aio_context    = curl_attach_aio_context,
1010769ce76dSAlexander Graf };
1011769ce76dSAlexander Graf 
1012769ce76dSAlexander Graf static BlockDriver bdrv_ftps = {
1013769ce76dSAlexander Graf     .format_name                = "ftps",
1014769ce76dSAlexander Graf     .protocol_name              = "ftps",
1015769ce76dSAlexander Graf 
1016769ce76dSAlexander Graf     .instance_size              = sizeof(BDRVCURLState),
10178e6d58cdSKevin Wolf     .bdrv_parse_filename        = curl_parse_filename,
101866f82ceeSKevin Wolf     .bdrv_file_open             = curl_open,
1019769ce76dSAlexander Graf     .bdrv_close                 = curl_close,
1020769ce76dSAlexander Graf     .bdrv_getlength             = curl_getlength,
1021769ce76dSAlexander Graf 
1022769ce76dSAlexander Graf     .bdrv_aio_readv             = curl_aio_readv,
102363f0f45fSStefan Hajnoczi 
102463f0f45fSStefan Hajnoczi     .bdrv_detach_aio_context    = curl_detach_aio_context,
102563f0f45fSStefan Hajnoczi     .bdrv_attach_aio_context    = curl_attach_aio_context,
1026769ce76dSAlexander Graf };
1027769ce76dSAlexander Graf 
1028769ce76dSAlexander Graf static void curl_block_init(void)
1029769ce76dSAlexander Graf {
1030769ce76dSAlexander Graf     bdrv_register(&bdrv_http);
1031769ce76dSAlexander Graf     bdrv_register(&bdrv_https);
1032769ce76dSAlexander Graf     bdrv_register(&bdrv_ftp);
1033769ce76dSAlexander Graf     bdrv_register(&bdrv_ftps);
1034769ce76dSAlexander Graf }
1035769ce76dSAlexander Graf 
1036769ce76dSAlexander Graf block_init(curl_block_init);
1037