xref: /openbmc/qemu/block/curl.c (revision 675a775633e68bf8b426a896fea5b93a4f4ff1cc)
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
151031fd1beSPeter Maydell static int curl_timer_cb(CURLM *multi, long timeout_ms, void *opaque)
152031fd1beSPeter Maydell {
153031fd1beSPeter Maydell     BDRVCURLState *s = opaque;
154031fd1beSPeter Maydell 
155031fd1beSPeter Maydell     DPRINTF("CURL: timer callback timeout_ms %ld\n", timeout_ms);
156031fd1beSPeter Maydell     if (timeout_ms == -1) {
157031fd1beSPeter Maydell         timer_del(&s->timer);
158031fd1beSPeter Maydell     } else {
159031fd1beSPeter Maydell         int64_t timeout_ns = (int64_t)timeout_ms * 1000 * 1000;
160031fd1beSPeter Maydell         timer_mod(&s->timer,
161031fd1beSPeter Maydell                   qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + timeout_ns);
162031fd1beSPeter Maydell     }
163031fd1beSPeter Maydell     return 0;
164031fd1beSPeter Maydell }
165031fd1beSPeter Maydell #endif
166031fd1beSPeter Maydell 
167769ce76dSAlexander Graf static int curl_sock_cb(CURL *curl, curl_socket_t fd, int action,
16863f0f45fSStefan Hajnoczi                         void *userp, void *sp)
169769ce76dSAlexander Graf {
17063f0f45fSStefan Hajnoczi     BDRVCURLState *s;
171838ef602SMatthew Booth     CURLState *state = NULL;
172ff5ca166SMax Reitz     CURLSocket *socket;
173ff5ca166SMax Reitz 
174838ef602SMatthew Booth     curl_easy_getinfo(curl, CURLINFO_PRIVATE, (char **)&state);
17563f0f45fSStefan Hajnoczi     s = state->s;
176838ef602SMatthew Booth 
177ff5ca166SMax Reitz     QLIST_FOREACH(socket, &state->sockets, next) {
178ff5ca166SMax Reitz         if (socket->fd == fd) {
179ff5ca166SMax Reitz             if (action == CURL_POLL_REMOVE) {
180ff5ca166SMax Reitz                 QLIST_REMOVE(socket, next);
181ff5ca166SMax Reitz                 g_free(socket);
182ff5ca166SMax Reitz             }
183ff5ca166SMax Reitz             break;
184ff5ca166SMax Reitz         }
185ff5ca166SMax Reitz     }
186ff5ca166SMax Reitz     if (!socket) {
187ff5ca166SMax Reitz         socket = g_new0(CURLSocket, 1);
188ff5ca166SMax Reitz         socket->fd = fd;
189ff5ca166SMax Reitz         QLIST_INSERT_HEAD(&state->sockets, socket, next);
190ff5ca166SMax Reitz     }
191ff5ca166SMax Reitz     socket = NULL;
192ff5ca166SMax Reitz 
19392b6a160SFam Zheng     DPRINTF("CURL (AIO): Sock action %d on fd %d\n", action, (int)fd);
194769ce76dSAlexander Graf     switch (action) {
195769ce76dSAlexander Graf         case CURL_POLL_IN:
196dca21ef2SFam Zheng             aio_set_fd_handler(s->aio_context, fd, false,
197f6a51c84SStefan Hajnoczi                                curl_multi_read, NULL, NULL, state);
198769ce76dSAlexander Graf             break;
199769ce76dSAlexander Graf         case CURL_POLL_OUT:
200dca21ef2SFam Zheng             aio_set_fd_handler(s->aio_context, fd, false,
201f6a51c84SStefan Hajnoczi                                NULL, curl_multi_do, NULL, state);
202769ce76dSAlexander Graf             break;
203769ce76dSAlexander Graf         case CURL_POLL_INOUT:
204dca21ef2SFam Zheng             aio_set_fd_handler(s->aio_context, fd, false,
205f6a51c84SStefan Hajnoczi                                curl_multi_read, curl_multi_do, NULL, state);
206769ce76dSAlexander Graf             break;
207769ce76dSAlexander Graf         case CURL_POLL_REMOVE:
208dca21ef2SFam Zheng             aio_set_fd_handler(s->aio_context, fd, false,
209f6a51c84SStefan Hajnoczi                                NULL, NULL, NULL, NULL);
210769ce76dSAlexander Graf             break;
211769ce76dSAlexander Graf     }
212769ce76dSAlexander Graf 
213769ce76dSAlexander Graf     return 0;
214769ce76dSAlexander Graf }
215769ce76dSAlexander Graf 
2163494d650SFam Zheng static size_t curl_header_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
217769ce76dSAlexander Graf {
2183494d650SFam Zheng     BDRVCURLState *s = opaque;
219769ce76dSAlexander Graf     size_t realsize = size * nmemb;
2203494d650SFam Zheng     const char *accept_line = "Accept-Ranges: bytes";
221769ce76dSAlexander Graf 
2223494d650SFam Zheng     if (realsize >= strlen(accept_line)
2233494d650SFam Zheng         && strncmp((char *)ptr, accept_line, strlen(accept_line)) == 0) {
2243494d650SFam Zheng         s->accept_range = true;
2250bfcd599SBlue Swirl     }
226769ce76dSAlexander Graf 
227769ce76dSAlexander Graf     return realsize;
228769ce76dSAlexander Graf }
229769ce76dSAlexander Graf 
230769ce76dSAlexander Graf static size_t curl_read_cb(void *ptr, size_t size, size_t nmemb, void *opaque)
231769ce76dSAlexander Graf {
232769ce76dSAlexander Graf     CURLState *s = ((CURLState*)opaque);
233769ce76dSAlexander Graf     size_t realsize = size * nmemb;
234769ce76dSAlexander Graf     int i;
235769ce76dSAlexander Graf 
2360bfcd599SBlue Swirl     DPRINTF("CURL: Just reading %zd bytes\n", realsize);
237769ce76dSAlexander Graf 
2384e767657SMax Reitz     if (!s || !s->orig_buf) {
2394e767657SMax Reitz         goto read_end;
2404e767657SMax Reitz     }
241769ce76dSAlexander Graf 
2426d4b9e55SFam Zheng     if (s->buf_off >= s->buf_len) {
2436d4b9e55SFam Zheng         /* buffer full, read nothing */
2444e767657SMax Reitz         goto read_end;
2456d4b9e55SFam Zheng     }
2466d4b9e55SFam Zheng     realsize = MIN(realsize, s->buf_len - s->buf_off);
247769ce76dSAlexander Graf     memcpy(s->orig_buf + s->buf_off, ptr, realsize);
248769ce76dSAlexander Graf     s->buf_off += realsize;
249769ce76dSAlexander Graf 
250769ce76dSAlexander Graf     for(i=0; i<CURL_NUM_ACB; i++) {
251769ce76dSAlexander Graf         CURLAIOCB *acb = s->acb[i];
252769ce76dSAlexander Graf 
253769ce76dSAlexander Graf         if (!acb)
254769ce76dSAlexander Graf             continue;
255769ce76dSAlexander Graf 
256769ce76dSAlexander Graf         if ((s->buf_off >= acb->end)) {
2574e504535SMax Reitz             size_t request_length = acb->nb_sectors * BDRV_SECTOR_SIZE;
2584e504535SMax Reitz 
25903396148SMichael Tokarev             qemu_iovec_from_buf(acb->qiov, 0, s->orig_buf + acb->start,
260769ce76dSAlexander Graf                                 acb->end - acb->start);
2614e504535SMax Reitz 
2624e504535SMax Reitz             if (acb->end - acb->start < request_length) {
2634e504535SMax Reitz                 size_t offset = acb->end - acb->start;
2644e504535SMax Reitz                 qemu_iovec_memset(acb->qiov, offset, 0,
2654e504535SMax Reitz                                   request_length - offset);
2664e504535SMax Reitz             }
2674e504535SMax Reitz 
268769ce76dSAlexander Graf             acb->common.cb(acb->common.opaque, 0);
2698007429aSFam Zheng             qemu_aio_unref(acb);
270769ce76dSAlexander Graf             s->acb[i] = NULL;
271769ce76dSAlexander Graf         }
272769ce76dSAlexander Graf     }
273769ce76dSAlexander Graf 
2744e767657SMax Reitz read_end:
2754e767657SMax Reitz     /* curl will error out if we do not return this value */
2764e767657SMax Reitz     return size * nmemb;
277769ce76dSAlexander Graf }
278769ce76dSAlexander Graf 
279769ce76dSAlexander Graf static int curl_find_buf(BDRVCURLState *s, size_t start, size_t len,
280769ce76dSAlexander Graf                          CURLAIOCB *acb)
281769ce76dSAlexander Graf {
282769ce76dSAlexander Graf     int i;
283769ce76dSAlexander Graf     size_t end = start + len;
2844e504535SMax Reitz     size_t clamped_end = MIN(end, s->len);
2854e504535SMax Reitz     size_t clamped_len = clamped_end - start;
286769ce76dSAlexander Graf 
287769ce76dSAlexander Graf     for (i=0; i<CURL_NUM_STATES; i++) {
288769ce76dSAlexander Graf         CURLState *state = &s->states[i];
289769ce76dSAlexander Graf         size_t buf_end = (state->buf_start + state->buf_off);
290769ce76dSAlexander Graf         size_t buf_fend = (state->buf_start + state->buf_len);
291769ce76dSAlexander Graf 
292769ce76dSAlexander Graf         if (!state->orig_buf)
293769ce76dSAlexander Graf             continue;
294769ce76dSAlexander Graf         if (!state->buf_off)
295769ce76dSAlexander Graf             continue;
296769ce76dSAlexander Graf 
297769ce76dSAlexander Graf         // Does the existing buffer cover our section?
298769ce76dSAlexander Graf         if ((start >= state->buf_start) &&
299769ce76dSAlexander Graf             (start <= buf_end) &&
3004e504535SMax Reitz             (clamped_end >= state->buf_start) &&
3014e504535SMax Reitz             (clamped_end <= buf_end))
302769ce76dSAlexander Graf         {
303769ce76dSAlexander Graf             char *buf = state->orig_buf + (start - state->buf_start);
304769ce76dSAlexander Graf 
3054e504535SMax Reitz             qemu_iovec_from_buf(acb->qiov, 0, buf, clamped_len);
3064e504535SMax Reitz             if (clamped_len < len) {
3074e504535SMax Reitz                 qemu_iovec_memset(acb->qiov, clamped_len, 0, len - clamped_len);
3084e504535SMax Reitz             }
309769ce76dSAlexander Graf             acb->common.cb(acb->common.opaque, 0);
310769ce76dSAlexander Graf 
311769ce76dSAlexander Graf             return FIND_RET_OK;
312769ce76dSAlexander Graf         }
313769ce76dSAlexander Graf 
314769ce76dSAlexander Graf         // Wait for unfinished chunks
315b7079df4SMatthew Booth         if (state->in_use &&
316b7079df4SMatthew Booth             (start >= state->buf_start) &&
317769ce76dSAlexander Graf             (start <= buf_fend) &&
3184e504535SMax Reitz             (clamped_end >= state->buf_start) &&
3194e504535SMax Reitz             (clamped_end <= buf_fend))
320769ce76dSAlexander Graf         {
321769ce76dSAlexander Graf             int j;
322769ce76dSAlexander Graf 
323769ce76dSAlexander Graf             acb->start = start - state->buf_start;
3244e504535SMax Reitz             acb->end = acb->start + clamped_len;
325769ce76dSAlexander Graf 
326769ce76dSAlexander Graf             for (j=0; j<CURL_NUM_ACB; j++) {
327769ce76dSAlexander Graf                 if (!state->acb[j]) {
328769ce76dSAlexander Graf                     state->acb[j] = acb;
329769ce76dSAlexander Graf                     return FIND_RET_WAIT;
330769ce76dSAlexander Graf                 }
331769ce76dSAlexander Graf             }
332769ce76dSAlexander Graf         }
333769ce76dSAlexander Graf     }
334769ce76dSAlexander Graf 
335769ce76dSAlexander Graf     return FIND_RET_NONE;
336769ce76dSAlexander Graf }
337769ce76dSAlexander Graf 
338ba3186c4SPaolo Bonzini /* Called with s->mutex held.  */
339838ef602SMatthew Booth static void curl_multi_check_completion(BDRVCURLState *s)
340769ce76dSAlexander Graf {
341769ce76dSAlexander Graf     int msgs_in_queue;
342769ce76dSAlexander Graf 
343769ce76dSAlexander Graf     /* Try to find done transfers, so we can free the easy
344769ce76dSAlexander Graf      * handle again. */
3451f2cead3SMatthew Booth     for (;;) {
346769ce76dSAlexander Graf         CURLMsg *msg;
347769ce76dSAlexander Graf         msg = curl_multi_info_read(s->multi, &msgs_in_queue);
348769ce76dSAlexander Graf 
3491f2cead3SMatthew Booth         /* Quit when there are no more completions */
350769ce76dSAlexander Graf         if (!msg)
351769ce76dSAlexander Graf             break;
352769ce76dSAlexander Graf 
3531f2cead3SMatthew Booth         if (msg->msg == CURLMSG_DONE) {
354769ce76dSAlexander Graf             CURLState *state = NULL;
355f6246509SMatthew Booth             curl_easy_getinfo(msg->easy_handle, CURLINFO_PRIVATE,
356f6246509SMatthew Booth                               (char **)&state);
357f785a5aeSNicholas Thomas 
358f785a5aeSNicholas Thomas             /* ACBs for successful messages get completed in curl_read_cb */
359f785a5aeSNicholas Thomas             if (msg->data.result != CURLE_OK) {
360f785a5aeSNicholas Thomas                 int i;
361796a060bSRichard W.M. Jones                 static int errcount = 100;
362796a060bSRichard W.M. Jones 
363796a060bSRichard W.M. Jones                 /* Don't lose the original error message from curl, since
364796a060bSRichard W.M. Jones                  * it contains extra data.
365796a060bSRichard W.M. Jones                  */
366796a060bSRichard W.M. Jones                 if (errcount > 0) {
367796a060bSRichard W.M. Jones                     error_report("curl: %s", state->errmsg);
368796a060bSRichard W.M. Jones                     if (--errcount == 0) {
369796a060bSRichard W.M. Jones                         error_report("curl: further errors suppressed");
370796a060bSRichard W.M. Jones                     }
371796a060bSRichard W.M. Jones                 }
372796a060bSRichard W.M. Jones 
373f785a5aeSNicholas Thomas                 for (i = 0; i < CURL_NUM_ACB; i++) {
374f785a5aeSNicholas Thomas                     CURLAIOCB *acb = state->acb[i];
375f785a5aeSNicholas Thomas 
376f785a5aeSNicholas Thomas                     if (acb == NULL) {
377f785a5aeSNicholas Thomas                         continue;
378f785a5aeSNicholas Thomas                     }
379f785a5aeSNicholas Thomas 
380ba3186c4SPaolo Bonzini                     qemu_mutex_unlock(&s->mutex);
381eb048026SPaolo Bonzini                     acb->common.cb(acb->common.opaque, -EIO);
382ba3186c4SPaolo Bonzini                     qemu_mutex_lock(&s->mutex);
3838007429aSFam Zheng                     qemu_aio_unref(acb);
384f785a5aeSNicholas Thomas                     state->acb[i] = NULL;
385f785a5aeSNicholas Thomas                 }
386f785a5aeSNicholas Thomas             }
387f785a5aeSNicholas Thomas 
388769ce76dSAlexander Graf             curl_clean_state(state);
389769ce76dSAlexander Graf             break;
390769ce76dSAlexander Graf         }
391769ce76dSAlexander Graf     }
392769ce76dSAlexander Graf }
393769ce76dSAlexander Graf 
394ba3186c4SPaolo Bonzini /* Called with s->mutex held.  */
3959d456654SPaolo Bonzini static void curl_multi_do_locked(CURLState *s)
396031fd1beSPeter Maydell {
397ff5ca166SMax Reitz     CURLSocket *socket, *next_socket;
398031fd1beSPeter Maydell     int running;
399031fd1beSPeter Maydell     int r;
400031fd1beSPeter Maydell 
401838ef602SMatthew Booth     if (!s->s->multi) {
402031fd1beSPeter Maydell         return;
403031fd1beSPeter Maydell     }
404031fd1beSPeter Maydell 
405ff5ca166SMax Reitz     /* Need to use _SAFE because curl_multi_socket_action() may trigger
406ff5ca166SMax Reitz      * curl_sock_cb() which might modify this list */
407ff5ca166SMax Reitz     QLIST_FOREACH_SAFE(socket, &s->sockets, next, next_socket) {
408031fd1beSPeter Maydell         do {
409ff5ca166SMax Reitz             r = curl_multi_socket_action(s->s->multi, socket->fd, 0, &running);
410031fd1beSPeter Maydell         } while (r == CURLM_CALL_MULTI_PERFORM);
411ff5ca166SMax Reitz     }
412838ef602SMatthew Booth }
413838ef602SMatthew Booth 
4149d456654SPaolo Bonzini static void curl_multi_do(void *arg)
4159d456654SPaolo Bonzini {
4169d456654SPaolo Bonzini     CURLState *s = (CURLState *)arg;
4179d456654SPaolo Bonzini 
418ba3186c4SPaolo Bonzini     qemu_mutex_lock(&s->s->mutex);
4199d456654SPaolo Bonzini     curl_multi_do_locked(s);
420ba3186c4SPaolo Bonzini     qemu_mutex_unlock(&s->s->mutex);
4219d456654SPaolo Bonzini }
4229d456654SPaolo Bonzini 
423838ef602SMatthew Booth static void curl_multi_read(void *arg)
424838ef602SMatthew Booth {
425838ef602SMatthew Booth     CURLState *s = (CURLState *)arg;
426838ef602SMatthew Booth 
427ba3186c4SPaolo Bonzini     qemu_mutex_lock(&s->s->mutex);
4289d456654SPaolo Bonzini     curl_multi_do_locked(s);
429838ef602SMatthew Booth     curl_multi_check_completion(s->s);
430ba3186c4SPaolo Bonzini     qemu_mutex_unlock(&s->s->mutex);
431031fd1beSPeter Maydell }
432031fd1beSPeter Maydell 
433031fd1beSPeter Maydell static void curl_multi_timeout_do(void *arg)
434031fd1beSPeter Maydell {
435031fd1beSPeter Maydell #ifdef NEED_CURL_TIMER_CALLBACK
436031fd1beSPeter Maydell     BDRVCURLState *s = (BDRVCURLState *)arg;
437031fd1beSPeter Maydell     int running;
438031fd1beSPeter Maydell 
439031fd1beSPeter Maydell     if (!s->multi) {
440031fd1beSPeter Maydell         return;
441031fd1beSPeter Maydell     }
442031fd1beSPeter Maydell 
443ba3186c4SPaolo Bonzini     qemu_mutex_lock(&s->mutex);
444031fd1beSPeter Maydell     curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
445031fd1beSPeter Maydell 
446838ef602SMatthew Booth     curl_multi_check_completion(s);
447ba3186c4SPaolo Bonzini     qemu_mutex_unlock(&s->mutex);
448031fd1beSPeter Maydell #else
449031fd1beSPeter Maydell     abort();
450031fd1beSPeter Maydell #endif
451031fd1beSPeter Maydell }
452031fd1beSPeter Maydell 
453a2f468e4SRichard W.M. Jones static CURLState *curl_init_state(BlockDriverState *bs, BDRVCURLState *s)
454769ce76dSAlexander Graf {
455769ce76dSAlexander Graf     CURLState *state = NULL;
456769ce76dSAlexander Graf     int i, j;
457769ce76dSAlexander Graf 
458769ce76dSAlexander Graf     do {
459769ce76dSAlexander Graf         for (i=0; i<CURL_NUM_STATES; i++) {
460769ce76dSAlexander Graf             for (j=0; j<CURL_NUM_ACB; j++)
461769ce76dSAlexander Graf                 if (s->states[i].acb[j])
462769ce76dSAlexander Graf                     continue;
463769ce76dSAlexander Graf             if (s->states[i].in_use)
464769ce76dSAlexander Graf                 continue;
465769ce76dSAlexander Graf 
466769ce76dSAlexander Graf             state = &s->states[i];
467769ce76dSAlexander Graf             state->in_use = 1;
468769ce76dSAlexander Graf             break;
469769ce76dSAlexander Graf         }
470769ce76dSAlexander Graf         if (!state) {
471a2f468e4SRichard W.M. Jones             aio_poll(bdrv_get_aio_context(bs), true);
472769ce76dSAlexander Graf         }
473769ce76dSAlexander Graf     } while(!state);
474769ce76dSAlexander Graf 
4759e550b32SMatthew Booth     if (!state->curl) {
476769ce76dSAlexander Graf         state->curl = curl_easy_init();
4779e550b32SMatthew Booth         if (!state->curl) {
478769ce76dSAlexander Graf             return NULL;
4799e550b32SMatthew Booth         }
480769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_URL, s->url);
48197a3ea57SMatthew Booth         curl_easy_setopt(state->curl, CURLOPT_SSL_VERIFYPEER,
48297a3ea57SMatthew Booth                          (long) s->sslverify);
483a94f83d9SRichard W.M. Jones         if (s->cookie) {
484a94f83d9SRichard W.M. Jones             curl_easy_setopt(state->curl, CURLOPT_COOKIE, s->cookie);
485a94f83d9SRichard W.M. Jones         }
486f76faedaSRichard W.M. Jones         curl_easy_setopt(state->curl, CURLOPT_TIMEOUT, (long)s->timeout);
4879e550b32SMatthew Booth         curl_easy_setopt(state->curl, CURLOPT_WRITEFUNCTION,
4889e550b32SMatthew Booth                          (void *)curl_read_cb);
489769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_WRITEDATA, (void *)state);
490769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_PRIVATE, (void *)state);
491769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_AUTOREFERER, 1);
492769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_FOLLOWLOCATION, 1);
493769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_NOSIGNAL, 1);
494769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_ERRORBUFFER, state->errmsg);
495f785a5aeSNicholas Thomas         curl_easy_setopt(state->curl, CURLOPT_FAILONERROR, 1);
496769ce76dSAlexander Graf 
4971bff9606SDaniel P. Berrange         if (s->username) {
4981bff9606SDaniel P. Berrange             curl_easy_setopt(state->curl, CURLOPT_USERNAME, s->username);
4991bff9606SDaniel P. Berrange         }
5001bff9606SDaniel P. Berrange         if (s->password) {
5011bff9606SDaniel P. Berrange             curl_easy_setopt(state->curl, CURLOPT_PASSWORD, s->password);
5021bff9606SDaniel P. Berrange         }
5031bff9606SDaniel P. Berrange         if (s->proxyusername) {
5041bff9606SDaniel P. Berrange             curl_easy_setopt(state->curl,
5051bff9606SDaniel P. Berrange                              CURLOPT_PROXYUSERNAME, s->proxyusername);
5061bff9606SDaniel P. Berrange         }
5071bff9606SDaniel P. Berrange         if (s->proxypassword) {
5081bff9606SDaniel P. Berrange             curl_easy_setopt(state->curl,
5091bff9606SDaniel P. Berrange                              CURLOPT_PROXYPASSWORD, s->proxypassword);
5101bff9606SDaniel P. Berrange         }
5111bff9606SDaniel P. Berrange 
512fb6d1bbdSStefan Hajnoczi         /* Restrict supported protocols to avoid security issues in the more
513fb6d1bbdSStefan Hajnoczi          * obscure protocols.  For example, do not allow POP3/SMTP/IMAP see
514fb6d1bbdSStefan Hajnoczi          * CVE-2013-0249.
5158a8f5840SStefan Hajnoczi          *
5168a8f5840SStefan Hajnoczi          * Restricting protocols is only supported from 7.19.4 upwards.
517fb6d1bbdSStefan Hajnoczi          */
5188a8f5840SStefan Hajnoczi #if LIBCURL_VERSION_NUM >= 0x071304
519fb6d1bbdSStefan Hajnoczi         curl_easy_setopt(state->curl, CURLOPT_PROTOCOLS, PROTOCOLS);
520fb6d1bbdSStefan Hajnoczi         curl_easy_setopt(state->curl, CURLOPT_REDIR_PROTOCOLS, PROTOCOLS);
5218a8f5840SStefan Hajnoczi #endif
522fb6d1bbdSStefan Hajnoczi 
523769ce76dSAlexander Graf #ifdef DEBUG_VERBOSE
524769ce76dSAlexander Graf         curl_easy_setopt(state->curl, CURLOPT_VERBOSE, 1);
525769ce76dSAlexander Graf #endif
5269e550b32SMatthew Booth     }
527769ce76dSAlexander Graf 
528ff5ca166SMax Reitz     QLIST_INIT(&state->sockets);
529769ce76dSAlexander Graf     state->s = s;
530769ce76dSAlexander Graf 
531769ce76dSAlexander Graf     return state;
532769ce76dSAlexander Graf }
533769ce76dSAlexander Graf 
534769ce76dSAlexander Graf static void curl_clean_state(CURLState *s)
535769ce76dSAlexander Graf {
536*675a7756SPaolo Bonzini     int j;
537*675a7756SPaolo Bonzini     for (j = 0; j < CURL_NUM_ACB; j++) {
538*675a7756SPaolo Bonzini         assert(!s->acb[j]);
539*675a7756SPaolo Bonzini     }
540*675a7756SPaolo Bonzini 
541769ce76dSAlexander Graf     if (s->s->multi)
542769ce76dSAlexander Graf         curl_multi_remove_handle(s->s->multi, s->curl);
543ff5ca166SMax Reitz 
544ff5ca166SMax Reitz     while (!QLIST_EMPTY(&s->sockets)) {
545ff5ca166SMax Reitz         CURLSocket *socket = QLIST_FIRST(&s->sockets);
546ff5ca166SMax Reitz 
547ff5ca166SMax Reitz         QLIST_REMOVE(socket, next);
548ff5ca166SMax Reitz         g_free(socket);
549ff5ca166SMax Reitz     }
550ff5ca166SMax Reitz 
551769ce76dSAlexander Graf     s->in_use = 0;
552769ce76dSAlexander Graf }
553769ce76dSAlexander Graf 
5548e6d58cdSKevin Wolf static void curl_parse_filename(const char *filename, QDict *options,
5558e6d58cdSKevin Wolf                                 Error **errp)
556769ce76dSAlexander Graf {
55746f5ac20SEric Blake     qdict_put_str(options, CURL_BLOCK_OPT_URL, filename);
5588e6d58cdSKevin Wolf }
5598e6d58cdSKevin Wolf 
56063f0f45fSStefan Hajnoczi static void curl_detach_aio_context(BlockDriverState *bs)
56163f0f45fSStefan Hajnoczi {
56263f0f45fSStefan Hajnoczi     BDRVCURLState *s = bs->opaque;
56363f0f45fSStefan Hajnoczi     int i;
56463f0f45fSStefan Hajnoczi 
56563f0f45fSStefan Hajnoczi     for (i = 0; i < CURL_NUM_STATES; i++) {
56663f0f45fSStefan Hajnoczi         if (s->states[i].in_use) {
56763f0f45fSStefan Hajnoczi             curl_clean_state(&s->states[i]);
56863f0f45fSStefan Hajnoczi         }
56963f0f45fSStefan Hajnoczi         if (s->states[i].curl) {
57063f0f45fSStefan Hajnoczi             curl_easy_cleanup(s->states[i].curl);
57163f0f45fSStefan Hajnoczi             s->states[i].curl = NULL;
57263f0f45fSStefan Hajnoczi         }
57363f0f45fSStefan Hajnoczi         g_free(s->states[i].orig_buf);
57463f0f45fSStefan Hajnoczi         s->states[i].orig_buf = NULL;
57563f0f45fSStefan Hajnoczi     }
57663f0f45fSStefan Hajnoczi     if (s->multi) {
57763f0f45fSStefan Hajnoczi         curl_multi_cleanup(s->multi);
57863f0f45fSStefan Hajnoczi         s->multi = NULL;
57963f0f45fSStefan Hajnoczi     }
58063f0f45fSStefan Hajnoczi 
58163f0f45fSStefan Hajnoczi     timer_del(&s->timer);
58263f0f45fSStefan Hajnoczi }
58363f0f45fSStefan Hajnoczi 
58463f0f45fSStefan Hajnoczi static void curl_attach_aio_context(BlockDriverState *bs,
58563f0f45fSStefan Hajnoczi                                     AioContext *new_context)
58663f0f45fSStefan Hajnoczi {
58763f0f45fSStefan Hajnoczi     BDRVCURLState *s = bs->opaque;
58863f0f45fSStefan Hajnoczi 
58963f0f45fSStefan Hajnoczi     aio_timer_init(new_context, &s->timer,
59063f0f45fSStefan Hajnoczi                    QEMU_CLOCK_REALTIME, SCALE_NS,
59163f0f45fSStefan Hajnoczi                    curl_multi_timeout_do, s);
59263f0f45fSStefan Hajnoczi 
59363f0f45fSStefan Hajnoczi     assert(!s->multi);
59463f0f45fSStefan Hajnoczi     s->multi = curl_multi_init();
59563f0f45fSStefan Hajnoczi     s->aio_context = new_context;
59663f0f45fSStefan Hajnoczi     curl_multi_setopt(s->multi, CURLMOPT_SOCKETFUNCTION, curl_sock_cb);
59763f0f45fSStefan Hajnoczi #ifdef NEED_CURL_TIMER_CALLBACK
59863f0f45fSStefan Hajnoczi     curl_multi_setopt(s->multi, CURLMOPT_TIMERDATA, s);
59963f0f45fSStefan Hajnoczi     curl_multi_setopt(s->multi, CURLMOPT_TIMERFUNCTION, curl_timer_cb);
60063f0f45fSStefan Hajnoczi #endif
60163f0f45fSStefan Hajnoczi }
60263f0f45fSStefan Hajnoczi 
6038e6d58cdSKevin Wolf static QemuOptsList runtime_opts = {
6048e6d58cdSKevin Wolf     .name = "curl",
6058e6d58cdSKevin Wolf     .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
6068e6d58cdSKevin Wolf     .desc = {
6078e6d58cdSKevin Wolf         {
608e3542c67SMatthew Booth             .name = CURL_BLOCK_OPT_URL,
6098e6d58cdSKevin Wolf             .type = QEMU_OPT_STRING,
6108e6d58cdSKevin Wolf             .help = "URL to open",
6118e6d58cdSKevin Wolf         },
6128e6d58cdSKevin Wolf         {
613e3542c67SMatthew Booth             .name = CURL_BLOCK_OPT_READAHEAD,
6148e6d58cdSKevin Wolf             .type = QEMU_OPT_SIZE,
6158e6d58cdSKevin Wolf             .help = "Readahead size",
6168e6d58cdSKevin Wolf         },
61797a3ea57SMatthew Booth         {
61897a3ea57SMatthew Booth             .name = CURL_BLOCK_OPT_SSLVERIFY,
61997a3ea57SMatthew Booth             .type = QEMU_OPT_BOOL,
62097a3ea57SMatthew Booth             .help = "Verify SSL certificate"
62197a3ea57SMatthew Booth         },
622212aefaaSDaniel Henrique Barboza         {
623212aefaaSDaniel Henrique Barboza             .name = CURL_BLOCK_OPT_TIMEOUT,
624212aefaaSDaniel Henrique Barboza             .type = QEMU_OPT_NUMBER,
625212aefaaSDaniel Henrique Barboza             .help = "Curl timeout"
626212aefaaSDaniel Henrique Barboza         },
627a94f83d9SRichard W.M. Jones         {
628a94f83d9SRichard W.M. Jones             .name = CURL_BLOCK_OPT_COOKIE,
629a94f83d9SRichard W.M. Jones             .type = QEMU_OPT_STRING,
630a94f83d9SRichard W.M. Jones             .help = "Pass the cookie or list of cookies with each request"
631a94f83d9SRichard W.M. Jones         },
6321bff9606SDaniel P. Berrange         {
633327c8ebdSPeter Krempa             .name = CURL_BLOCK_OPT_COOKIE_SECRET,
634327c8ebdSPeter Krempa             .type = QEMU_OPT_STRING,
635327c8ebdSPeter Krempa             .help = "ID of secret used as cookie passed with each request"
636327c8ebdSPeter Krempa         },
637327c8ebdSPeter Krempa         {
6381bff9606SDaniel P. Berrange             .name = CURL_BLOCK_OPT_USERNAME,
6391bff9606SDaniel P. Berrange             .type = QEMU_OPT_STRING,
6401bff9606SDaniel P. Berrange             .help = "Username for HTTP auth"
6411bff9606SDaniel P. Berrange         },
6421bff9606SDaniel P. Berrange         {
6431bff9606SDaniel P. Berrange             .name = CURL_BLOCK_OPT_PASSWORD_SECRET,
6441bff9606SDaniel P. Berrange             .type = QEMU_OPT_STRING,
6451bff9606SDaniel P. Berrange             .help = "ID of secret used as password for HTTP auth",
6461bff9606SDaniel P. Berrange         },
6471bff9606SDaniel P. Berrange         {
6481bff9606SDaniel P. Berrange             .name = CURL_BLOCK_OPT_PROXY_USERNAME,
6491bff9606SDaniel P. Berrange             .type = QEMU_OPT_STRING,
6501bff9606SDaniel P. Berrange             .help = "Username for HTTP proxy auth"
6511bff9606SDaniel P. Berrange         },
6521bff9606SDaniel P. Berrange         {
6531bff9606SDaniel P. Berrange             .name = CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET,
6541bff9606SDaniel P. Berrange             .type = QEMU_OPT_STRING,
6551bff9606SDaniel P. Berrange             .help = "ID of secret used as password for HTTP proxy auth",
6561bff9606SDaniel P. Berrange         },
6578e6d58cdSKevin Wolf         { /* end of list */ }
6588e6d58cdSKevin Wolf     },
6598e6d58cdSKevin Wolf };
6608e6d58cdSKevin Wolf 
6611bff9606SDaniel P. Berrange 
662015a1036SMax Reitz static int curl_open(BlockDriverState *bs, QDict *options, int flags,
663015a1036SMax Reitz                      Error **errp)
6648e6d58cdSKevin Wolf {
6658e6d58cdSKevin Wolf     BDRVCURLState *s = bs->opaque;
6668e6d58cdSKevin Wolf     CURLState *state = NULL;
6678e6d58cdSKevin Wolf     QemuOpts *opts;
6688e6d58cdSKevin Wolf     Error *local_err = NULL;
6698e6d58cdSKevin Wolf     const char *file;
670a94f83d9SRichard W.M. Jones     const char *cookie;
671327c8ebdSPeter Krempa     const char *cookie_secret;
6728e6d58cdSKevin Wolf     double d;
6731bff9606SDaniel P. Berrange     const char *secretid;
67434634ca2SMax Reitz     const char *protocol_delimiter;
6758e6d58cdSKevin Wolf 
6768e6d58cdSKevin Wolf     static int inited = 0;
6778e6d58cdSKevin Wolf 
678a7cea2baSRichard W.M. Jones     if (flags & BDRV_O_RDWR) {
6792a94fee3SPaolo Bonzini         error_setg(errp, "curl block device does not support writes");
680a7cea2baSRichard W.M. Jones         return -EROFS;
681a7cea2baSRichard W.M. Jones     }
682a7cea2baSRichard W.M. Jones 
68387ea75d5SPeter Crosthwaite     opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
6848e6d58cdSKevin Wolf     qemu_opts_absorb_qdict(opts, options, &local_err);
68584d18f06SMarkus Armbruster     if (local_err) {
6862a94fee3SPaolo Bonzini         error_propagate(errp, local_err);
6878e6d58cdSKevin Wolf         goto out_noclean;
6888e6d58cdSKevin Wolf     }
6898e6d58cdSKevin Wolf 
690e3542c67SMatthew Booth     s->readahead_size = qemu_opt_get_size(opts, CURL_BLOCK_OPT_READAHEAD,
691e3542c67SMatthew Booth                                           READ_AHEAD_DEFAULT);
692c76f4952SNolan     if ((s->readahead_size & 0x1ff) != 0) {
6932a94fee3SPaolo Bonzini         error_setg(errp, "HTTP_READAHEAD_SIZE %zd is not a multiple of 512",
694c76f4952SNolan                    s->readahead_size);
695c76f4952SNolan         goto out_noclean;
696c76f4952SNolan     }
697c76f4952SNolan 
698212aefaaSDaniel Henrique Barboza     s->timeout = qemu_opt_get_number(opts, CURL_BLOCK_OPT_TIMEOUT,
699212aefaaSDaniel Henrique Barboza                                      CURL_TIMEOUT_DEFAULT);
700f76faedaSRichard W.M. Jones     if (s->timeout > CURL_TIMEOUT_MAX) {
701f76faedaSRichard W.M. Jones         error_setg(errp, "timeout parameter is too large or negative");
702f76faedaSRichard W.M. Jones         goto out_noclean;
703f76faedaSRichard W.M. Jones     }
704212aefaaSDaniel Henrique Barboza 
70597a3ea57SMatthew Booth     s->sslverify = qemu_opt_get_bool(opts, CURL_BLOCK_OPT_SSLVERIFY, true);
70697a3ea57SMatthew Booth 
707a94f83d9SRichard W.M. Jones     cookie = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE);
708327c8ebdSPeter Krempa     cookie_secret = qemu_opt_get(opts, CURL_BLOCK_OPT_COOKIE_SECRET);
709327c8ebdSPeter Krempa 
710327c8ebdSPeter Krempa     if (cookie && cookie_secret) {
711327c8ebdSPeter Krempa         error_setg(errp,
712327c8ebdSPeter Krempa                    "curl driver cannot handle both cookie and cookie secret");
713327c8ebdSPeter Krempa         goto out_noclean;
714327c8ebdSPeter Krempa     }
715327c8ebdSPeter Krempa 
716327c8ebdSPeter Krempa     if (cookie_secret) {
717327c8ebdSPeter Krempa         s->cookie = qcrypto_secret_lookup_as_utf8(cookie_secret, errp);
718327c8ebdSPeter Krempa         if (!s->cookie) {
719327c8ebdSPeter Krempa             goto out_noclean;
720327c8ebdSPeter Krempa         }
721327c8ebdSPeter Krempa     } else {
722a94f83d9SRichard W.M. Jones         s->cookie = g_strdup(cookie);
723327c8ebdSPeter Krempa     }
724a94f83d9SRichard W.M. Jones 
725e3542c67SMatthew Booth     file = qemu_opt_get(opts, CURL_BLOCK_OPT_URL);
7268e6d58cdSKevin Wolf     if (file == NULL) {
7272a94fee3SPaolo Bonzini         error_setg(errp, "curl block driver requires an 'url' option");
7288e6d58cdSKevin Wolf         goto out_noclean;
7298e6d58cdSKevin Wolf     }
7308e6d58cdSKevin Wolf 
73134634ca2SMax Reitz     if (!strstart(file, bs->drv->protocol_name, &protocol_delimiter) ||
73234634ca2SMax Reitz         !strstart(protocol_delimiter, "://", NULL))
73334634ca2SMax Reitz     {
73434634ca2SMax Reitz         error_setg(errp, "%s curl driver cannot handle the URL '%s' (does not "
73534634ca2SMax Reitz                    "start with '%s://')", bs->drv->protocol_name, file,
73634634ca2SMax Reitz                    bs->drv->protocol_name);
73734634ca2SMax Reitz         goto out_noclean;
73834634ca2SMax Reitz     }
73934634ca2SMax Reitz 
7401bff9606SDaniel P. Berrange     s->username = g_strdup(qemu_opt_get(opts, CURL_BLOCK_OPT_USERNAME));
7411bff9606SDaniel P. Berrange     secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PASSWORD_SECRET);
7421bff9606SDaniel P. Berrange 
7431bff9606SDaniel P. Berrange     if (secretid) {
7441bff9606SDaniel P. Berrange         s->password = qcrypto_secret_lookup_as_utf8(secretid, errp);
7451bff9606SDaniel P. Berrange         if (!s->password) {
7461bff9606SDaniel P. Berrange             goto out_noclean;
7471bff9606SDaniel P. Berrange         }
7481bff9606SDaniel P. Berrange     }
7491bff9606SDaniel P. Berrange 
7501bff9606SDaniel P. Berrange     s->proxyusername = g_strdup(
7511bff9606SDaniel P. Berrange         qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_USERNAME));
7521bff9606SDaniel P. Berrange     secretid = qemu_opt_get(opts, CURL_BLOCK_OPT_PROXY_PASSWORD_SECRET);
7531bff9606SDaniel P. Berrange     if (secretid) {
7541bff9606SDaniel P. Berrange         s->proxypassword = qcrypto_secret_lookup_as_utf8(secretid, errp);
7551bff9606SDaniel P. Berrange         if (!s->proxypassword) {
7561bff9606SDaniel P. Berrange             goto out_noclean;
7571bff9606SDaniel P. Berrange         }
7581bff9606SDaniel P. Berrange     }
7591bff9606SDaniel P. Berrange 
760769ce76dSAlexander Graf     if (!inited) {
761769ce76dSAlexander Graf         curl_global_init(CURL_GLOBAL_ALL);
762769ce76dSAlexander Graf         inited = 1;
763769ce76dSAlexander Graf     }
764769ce76dSAlexander Graf 
765d0f2c4c6Smalc     DPRINTF("CURL: Opening %s\n", file);
76663f0f45fSStefan Hajnoczi     s->aio_context = bdrv_get_aio_context(bs);
7678e6d58cdSKevin Wolf     s->url = g_strdup(file);
768a2f468e4SRichard W.M. Jones     state = curl_init_state(bs, s);
769769ce76dSAlexander Graf     if (!state)
770769ce76dSAlexander Graf         goto out_noclean;
771769ce76dSAlexander Graf 
772769ce76dSAlexander Graf     // Get file size
773769ce76dSAlexander Graf 
7743494d650SFam Zheng     s->accept_range = false;
775769ce76dSAlexander Graf     curl_easy_setopt(state->curl, CURLOPT_NOBODY, 1);
7763494d650SFam Zheng     curl_easy_setopt(state->curl, CURLOPT_HEADERFUNCTION,
7773494d650SFam Zheng                      curl_header_cb);
7783494d650SFam Zheng     curl_easy_setopt(state->curl, CURLOPT_HEADERDATA, s);
779769ce76dSAlexander Graf     if (curl_easy_perform(state->curl))
780769ce76dSAlexander Graf         goto out;
781a41c4578STomáš Golembiovský     if (curl_easy_getinfo(state->curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &d)) {
782769ce76dSAlexander Graf         goto out;
783a41c4578STomáš Golembiovský     }
784a41c4578STomáš Golembiovský     /* Prior CURL 7.19.4 return value of 0 could mean that the file size is not
785a41c4578STomáš Golembiovský      * know or the size is zero. From 7.19.4 CURL returns -1 if size is not
786a41c4578STomáš Golembiovský      * known and zero if it is realy zero-length file. */
787a41c4578STomáš Golembiovský #if LIBCURL_VERSION_NUM >= 0x071304
788a41c4578STomáš Golembiovský     if (d < 0) {
789a41c4578STomáš Golembiovský         pstrcpy(state->errmsg, CURL_ERROR_SIZE,
790a41c4578STomáš Golembiovský                 "Server didn't report file size.");
791a41c4578STomáš Golembiovský         goto out;
792a41c4578STomáš Golembiovský     }
793a41c4578STomáš Golembiovský #else
794a41c4578STomáš Golembiovský     if (d <= 0) {
795a41c4578STomáš Golembiovský         pstrcpy(state->errmsg, CURL_ERROR_SIZE,
796a41c4578STomáš Golembiovský                 "Unknown file size or zero-length file.");
797a41c4578STomáš Golembiovský         goto out;
798a41c4578STomáš Golembiovský     }
799a41c4578STomáš Golembiovský #endif
800a41c4578STomáš Golembiovský 
801a41c4578STomáš Golembiovský     s->len = (size_t)d;
802a41c4578STomáš Golembiovský 
8033494d650SFam Zheng     if ((!strncasecmp(s->url, "http://", strlen("http://"))
8043494d650SFam Zheng         || !strncasecmp(s->url, "https://", strlen("https://")))
8053494d650SFam Zheng         && !s->accept_range) {
8063494d650SFam Zheng         pstrcpy(state->errmsg, CURL_ERROR_SIZE,
8073494d650SFam Zheng                 "Server does not support 'range' (byte ranges).");
8083494d650SFam Zheng         goto out;
8093494d650SFam Zheng     }
8100bfcd599SBlue Swirl     DPRINTF("CURL: Size = %zd\n", s->len);
811769ce76dSAlexander Graf 
812769ce76dSAlexander Graf     curl_clean_state(state);
813769ce76dSAlexander Graf     curl_easy_cleanup(state->curl);
814769ce76dSAlexander Graf     state->curl = NULL;
815769ce76dSAlexander Graf 
816ba3186c4SPaolo Bonzini     qemu_mutex_init(&s->mutex);
81763f0f45fSStefan Hajnoczi     curl_attach_aio_context(bs, bdrv_get_aio_context(bs));
818769ce76dSAlexander Graf 
8198e6d58cdSKevin Wolf     qemu_opts_del(opts);
820769ce76dSAlexander Graf     return 0;
821769ce76dSAlexander Graf 
822769ce76dSAlexander Graf out:
823acd7fdc6SMaria Kustova     error_setg(errp, "CURL: Error opening file: %s", state->errmsg);
824769ce76dSAlexander Graf     curl_easy_cleanup(state->curl);
825769ce76dSAlexander Graf     state->curl = NULL;
826769ce76dSAlexander Graf out_noclean:
827a94f83d9SRichard W.M. Jones     g_free(s->cookie);
8288e6d58cdSKevin Wolf     g_free(s->url);
8298e6d58cdSKevin Wolf     qemu_opts_del(opts);
830769ce76dSAlexander Graf     return -EINVAL;
831769ce76dSAlexander Graf }
832769ce76dSAlexander Graf 
833d7331bedSStefan Hajnoczi static const AIOCBInfo curl_aiocb_info = {
834c16b5a2cSChristoph Hellwig     .aiocb_size         = sizeof(CURLAIOCB),
835c16b5a2cSChristoph Hellwig };
836c16b5a2cSChristoph Hellwig 
837363c3c85SNick Thomas 
838363c3c85SNick Thomas static void curl_readv_bh_cb(void *p)
839769ce76dSAlexander Graf {
840769ce76dSAlexander Graf     CURLState *state;
841b69cdef8SMatthew Booth     int running;
8421919631eSPaolo Bonzini     int ret = -EINPROGRESS;
843769ce76dSAlexander Graf 
844363c3c85SNick Thomas     CURLAIOCB *acb = p;
8451919631eSPaolo Bonzini     BlockDriverState *bs = acb->common.bs;
8461919631eSPaolo Bonzini     BDRVCURLState *s = bs->opaque;
847769ce76dSAlexander Graf 
8489054d9f6SMax Reitz     size_t start = acb->sector_num * BDRV_SECTOR_SIZE;
849363c3c85SNick Thomas     size_t end;
850769ce76dSAlexander Graf 
851ba3186c4SPaolo Bonzini     qemu_mutex_lock(&s->mutex);
8521919631eSPaolo Bonzini 
853769ce76dSAlexander Graf     // In case we have the requested data already (e.g. read-ahead),
854769ce76dSAlexander Graf     // we can just call the callback and be done.
8559054d9f6SMax Reitz     switch (curl_find_buf(s, start, acb->nb_sectors * BDRV_SECTOR_SIZE, acb)) {
856769ce76dSAlexander Graf         case FIND_RET_OK:
8578007429aSFam Zheng             qemu_aio_unref(acb);
858769ce76dSAlexander Graf             // fall through
859769ce76dSAlexander Graf         case FIND_RET_WAIT:
8601919631eSPaolo Bonzini             goto out;
861769ce76dSAlexander Graf         default:
862769ce76dSAlexander Graf             break;
863769ce76dSAlexander Graf     }
864769ce76dSAlexander Graf 
865769ce76dSAlexander Graf     // No cache found, so let's start a new request
866a2f468e4SRichard W.M. Jones     state = curl_init_state(acb->common.bs, s);
867363c3c85SNick Thomas     if (!state) {
8681919631eSPaolo Bonzini         ret = -EIO;
8691919631eSPaolo Bonzini         goto out;
870363c3c85SNick Thomas     }
871769ce76dSAlexander Graf 
872769ce76dSAlexander Graf     acb->start = 0;
8734e504535SMax Reitz     acb->end = MIN(acb->nb_sectors * BDRV_SECTOR_SIZE, s->len - start);
874769ce76dSAlexander Graf 
875769ce76dSAlexander Graf     state->buf_off = 0;
8767267c094SAnthony Liguori     g_free(state->orig_buf);
877769ce76dSAlexander Graf     state->buf_start = start;
8784e504535SMax Reitz     state->buf_len = MIN(acb->end + s->readahead_size, s->len - start);
8794e504535SMax Reitz     end = start + state->buf_len - 1;
8808dc7a772SKevin Wolf     state->orig_buf = g_try_malloc(state->buf_len);
8818dc7a772SKevin Wolf     if (state->buf_len && state->orig_buf == NULL) {
8828dc7a772SKevin Wolf         curl_clean_state(state);
8831919631eSPaolo Bonzini         ret = -ENOMEM;
8841919631eSPaolo Bonzini         goto out;
8858dc7a772SKevin Wolf     }
886769ce76dSAlexander Graf     state->acb[0] = acb;
887769ce76dSAlexander Graf 
8880bfcd599SBlue Swirl     snprintf(state->range, 127, "%zd-%zd", start, end);
8899054d9f6SMax Reitz     DPRINTF("CURL (AIO): Reading %llu at %zd (%s)\n",
8909054d9f6SMax Reitz             (acb->nb_sectors * BDRV_SECTOR_SIZE), start, state->range);
891769ce76dSAlexander Graf     curl_easy_setopt(state->curl, CURLOPT_RANGE, state->range);
892769ce76dSAlexander Graf 
893769ce76dSAlexander Graf     curl_multi_add_handle(s->multi, state->curl);
894769ce76dSAlexander Graf 
895b69cdef8SMatthew Booth     /* Tell curl it needs to kick things off */
896b69cdef8SMatthew Booth     curl_multi_socket_action(s->multi, CURL_SOCKET_TIMEOUT, 0, &running);
8971919631eSPaolo Bonzini 
8981919631eSPaolo Bonzini out:
899ba3186c4SPaolo Bonzini     qemu_mutex_unlock(&s->mutex);
9001919631eSPaolo Bonzini     if (ret != -EINPROGRESS) {
9011919631eSPaolo Bonzini         acb->common.cb(acb->common.opaque, ret);
9021919631eSPaolo Bonzini         qemu_aio_unref(acb);
9031919631eSPaolo Bonzini     }
904363c3c85SNick Thomas }
905363c3c85SNick Thomas 
9067c84b1b8SMarkus Armbruster static BlockAIOCB *curl_aio_readv(BlockDriverState *bs,
907363c3c85SNick Thomas         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
908097310b5SMarkus Armbruster         BlockCompletionFunc *cb, void *opaque)
909363c3c85SNick Thomas {
910363c3c85SNick Thomas     CURLAIOCB *acb;
911363c3c85SNick Thomas 
912d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&curl_aiocb_info, bs, cb, opaque);
913363c3c85SNick Thomas 
914363c3c85SNick Thomas     acb->qiov = qiov;
915363c3c85SNick Thomas     acb->sector_num = sector_num;
916363c3c85SNick Thomas     acb->nb_sectors = nb_sectors;
917363c3c85SNick Thomas 
918fffb6e12SPaolo Bonzini     aio_bh_schedule_oneshot(bdrv_get_aio_context(bs), curl_readv_bh_cb, acb);
919769ce76dSAlexander Graf     return &acb->common;
920769ce76dSAlexander Graf }
921769ce76dSAlexander Graf 
922769ce76dSAlexander Graf static void curl_close(BlockDriverState *bs)
923769ce76dSAlexander Graf {
924769ce76dSAlexander Graf     BDRVCURLState *s = bs->opaque;
925769ce76dSAlexander Graf 
926d0f2c4c6Smalc     DPRINTF("CURL: Close\n");
92763f0f45fSStefan Hajnoczi     curl_detach_aio_context(bs);
928ba3186c4SPaolo Bonzini     qemu_mutex_destroy(&s->mutex);
929031fd1beSPeter Maydell 
930a94f83d9SRichard W.M. Jones     g_free(s->cookie);
93145724d6dSStefan Weil     g_free(s->url);
932769ce76dSAlexander Graf }
933769ce76dSAlexander Graf 
934769ce76dSAlexander Graf static int64_t curl_getlength(BlockDriverState *bs)
935769ce76dSAlexander Graf {
936769ce76dSAlexander Graf     BDRVCURLState *s = bs->opaque;
937769ce76dSAlexander Graf     return s->len;
938769ce76dSAlexander Graf }
939769ce76dSAlexander Graf 
940769ce76dSAlexander Graf static BlockDriver bdrv_http = {
941769ce76dSAlexander Graf     .format_name                = "http",
942769ce76dSAlexander Graf     .protocol_name              = "http",
943769ce76dSAlexander Graf 
944769ce76dSAlexander Graf     .instance_size              = sizeof(BDRVCURLState),
9458e6d58cdSKevin Wolf     .bdrv_parse_filename        = curl_parse_filename,
94666f82ceeSKevin Wolf     .bdrv_file_open             = curl_open,
947769ce76dSAlexander Graf     .bdrv_close                 = curl_close,
948769ce76dSAlexander Graf     .bdrv_getlength             = curl_getlength,
949769ce76dSAlexander Graf 
950769ce76dSAlexander Graf     .bdrv_aio_readv             = curl_aio_readv,
95163f0f45fSStefan Hajnoczi 
95263f0f45fSStefan Hajnoczi     .bdrv_detach_aio_context    = curl_detach_aio_context,
95363f0f45fSStefan Hajnoczi     .bdrv_attach_aio_context    = curl_attach_aio_context,
954769ce76dSAlexander Graf };
955769ce76dSAlexander Graf 
956769ce76dSAlexander Graf static BlockDriver bdrv_https = {
957769ce76dSAlexander Graf     .format_name                = "https",
958769ce76dSAlexander Graf     .protocol_name              = "https",
959769ce76dSAlexander Graf 
960769ce76dSAlexander Graf     .instance_size              = sizeof(BDRVCURLState),
9618e6d58cdSKevin Wolf     .bdrv_parse_filename        = curl_parse_filename,
96266f82ceeSKevin Wolf     .bdrv_file_open             = curl_open,
963769ce76dSAlexander Graf     .bdrv_close                 = curl_close,
964769ce76dSAlexander Graf     .bdrv_getlength             = curl_getlength,
965769ce76dSAlexander Graf 
966769ce76dSAlexander Graf     .bdrv_aio_readv             = curl_aio_readv,
96763f0f45fSStefan Hajnoczi 
96863f0f45fSStefan Hajnoczi     .bdrv_detach_aio_context    = curl_detach_aio_context,
96963f0f45fSStefan Hajnoczi     .bdrv_attach_aio_context    = curl_attach_aio_context,
970769ce76dSAlexander Graf };
971769ce76dSAlexander Graf 
972769ce76dSAlexander Graf static BlockDriver bdrv_ftp = {
973769ce76dSAlexander Graf     .format_name                = "ftp",
974769ce76dSAlexander Graf     .protocol_name              = "ftp",
975769ce76dSAlexander Graf 
976769ce76dSAlexander Graf     .instance_size              = sizeof(BDRVCURLState),
9778e6d58cdSKevin Wolf     .bdrv_parse_filename        = curl_parse_filename,
97866f82ceeSKevin Wolf     .bdrv_file_open             = curl_open,
979769ce76dSAlexander Graf     .bdrv_close                 = curl_close,
980769ce76dSAlexander Graf     .bdrv_getlength             = curl_getlength,
981769ce76dSAlexander Graf 
982769ce76dSAlexander Graf     .bdrv_aio_readv             = curl_aio_readv,
98363f0f45fSStefan Hajnoczi 
98463f0f45fSStefan Hajnoczi     .bdrv_detach_aio_context    = curl_detach_aio_context,
98563f0f45fSStefan Hajnoczi     .bdrv_attach_aio_context    = curl_attach_aio_context,
986769ce76dSAlexander Graf };
987769ce76dSAlexander Graf 
988769ce76dSAlexander Graf static BlockDriver bdrv_ftps = {
989769ce76dSAlexander Graf     .format_name                = "ftps",
990769ce76dSAlexander Graf     .protocol_name              = "ftps",
991769ce76dSAlexander Graf 
992769ce76dSAlexander Graf     .instance_size              = sizeof(BDRVCURLState),
9938e6d58cdSKevin Wolf     .bdrv_parse_filename        = curl_parse_filename,
99466f82ceeSKevin Wolf     .bdrv_file_open             = curl_open,
995769ce76dSAlexander Graf     .bdrv_close                 = curl_close,
996769ce76dSAlexander Graf     .bdrv_getlength             = curl_getlength,
997769ce76dSAlexander Graf 
998769ce76dSAlexander Graf     .bdrv_aio_readv             = curl_aio_readv,
99963f0f45fSStefan Hajnoczi 
100063f0f45fSStefan Hajnoczi     .bdrv_detach_aio_context    = curl_detach_aio_context,
100163f0f45fSStefan Hajnoczi     .bdrv_attach_aio_context    = curl_attach_aio_context,
1002769ce76dSAlexander Graf };
1003769ce76dSAlexander Graf 
1004769ce76dSAlexander Graf static void curl_block_init(void)
1005769ce76dSAlexander Graf {
1006769ce76dSAlexander Graf     bdrv_register(&bdrv_http);
1007769ce76dSAlexander Graf     bdrv_register(&bdrv_https);
1008769ce76dSAlexander Graf     bdrv_register(&bdrv_ftp);
1009769ce76dSAlexander Graf     bdrv_register(&bdrv_ftps);
1010769ce76dSAlexander Graf }
1011769ce76dSAlexander Graf 
1012769ce76dSAlexander Graf block_init(curl_block_init);
1013