char-socket.c 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560
  1. /*
  2. * QEMU System Emulator
  3. *
  4. * Copyright (c) 2003-2008 Fabrice Bellard
  5. *
  6. * Permission is hereby granted, free of charge, to any person obtaining a copy
  7. * of this software and associated documentation files (the "Software"), to deal
  8. * in the Software without restriction, including without limitation the rights
  9. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. * copies of the Software, and to permit persons to whom the Software is
  11. * furnished to do so, subject to the following conditions:
  12. *
  13. * The above copyright notice and this permission notice shall be included in
  14. * all copies or substantial portions of the Software.
  15. *
  16. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19. * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22. * THE SOFTWARE.
  23. */
  24. #include "qemu/osdep.h"
  25. #include "chardev/char.h"
  26. #include "io/channel-socket.h"
  27. #include "io/channel-websock.h"
  28. #include "qemu/error-report.h"
  29. #include "qemu/module.h"
  30. #include "qemu/option.h"
  31. #include "qapi/error.h"
  32. #include "qapi/clone-visitor.h"
  33. #include "qapi/qapi-visit-sockets.h"
  34. #include "qemu/yank.h"
  35. #include "chardev/char-io.h"
  36. #include "chardev/char-socket.h"
  37. static gboolean socket_reconnect_timeout(gpointer opaque);
  38. static void tcp_chr_telnet_init(Chardev *chr);
  39. static void tcp_chr_change_state(SocketChardev *s, TCPChardevState state)
  40. {
  41. switch (state) {
  42. case TCP_CHARDEV_STATE_DISCONNECTED:
  43. break;
  44. case TCP_CHARDEV_STATE_CONNECTING:
  45. assert(s->state == TCP_CHARDEV_STATE_DISCONNECTED);
  46. break;
  47. case TCP_CHARDEV_STATE_CONNECTED:
  48. assert(s->state == TCP_CHARDEV_STATE_CONNECTING);
  49. break;
  50. }
  51. s->state = state;
  52. }
  53. static void tcp_chr_reconn_timer_cancel(SocketChardev *s)
  54. {
  55. if (s->reconnect_timer) {
  56. g_source_destroy(s->reconnect_timer);
  57. g_source_unref(s->reconnect_timer);
  58. s->reconnect_timer = NULL;
  59. }
  60. }
  61. static void qemu_chr_socket_restart_timer(Chardev *chr)
  62. {
  63. SocketChardev *s = SOCKET_CHARDEV(chr);
  64. char *name;
  65. assert(s->state == TCP_CHARDEV_STATE_DISCONNECTED);
  66. assert(!s->reconnect_timer);
  67. name = g_strdup_printf("chardev-socket-reconnect-%s", chr->label);
  68. s->reconnect_timer = qemu_chr_timeout_add_ms(chr,
  69. s->reconnect_time * 1000,
  70. socket_reconnect_timeout,
  71. chr);
  72. g_source_set_name(s->reconnect_timer, name);
  73. g_free(name);
  74. }
  75. static void check_report_connect_error(Chardev *chr,
  76. Error *err)
  77. {
  78. SocketChardev *s = SOCKET_CHARDEV(chr);
  79. if (!s->connect_err_reported) {
  80. error_reportf_err(err,
  81. "Unable to connect character device %s: ",
  82. chr->label);
  83. s->connect_err_reported = true;
  84. } else {
  85. error_free(err);
  86. }
  87. qemu_chr_socket_restart_timer(chr);
  88. }
  89. static void tcp_chr_accept(QIONetListener *listener,
  90. QIOChannelSocket *cioc,
  91. void *opaque);
  92. static int tcp_chr_read_poll(void *opaque);
  93. static void tcp_chr_disconnect_locked(Chardev *chr);
  94. /* Called with chr_write_lock held. */
  95. static int tcp_chr_write(Chardev *chr, const uint8_t *buf, int len)
  96. {
  97. SocketChardev *s = SOCKET_CHARDEV(chr);
  98. if (s->state == TCP_CHARDEV_STATE_CONNECTED) {
  99. int ret = io_channel_send_full(s->ioc, buf, len,
  100. s->write_msgfds,
  101. s->write_msgfds_num);
  102. /* free the written msgfds in any cases
  103. * other than ret < 0 && errno == EAGAIN
  104. */
  105. if (!(ret < 0 && EAGAIN == errno)
  106. && s->write_msgfds_num) {
  107. g_free(s->write_msgfds);
  108. s->write_msgfds = 0;
  109. s->write_msgfds_num = 0;
  110. }
  111. if (ret < 0 && errno != EAGAIN) {
  112. if (tcp_chr_read_poll(chr) <= 0) {
  113. /* Perform disconnect and return error. */
  114. tcp_chr_disconnect_locked(chr);
  115. } /* else let the read handler finish it properly */
  116. }
  117. return ret;
  118. } else {
  119. /* Indicate an error. */
  120. errno = EIO;
  121. return -1;
  122. }
  123. }
  124. static int tcp_chr_read_poll(void *opaque)
  125. {
  126. Chardev *chr = CHARDEV(opaque);
  127. SocketChardev *s = SOCKET_CHARDEV(opaque);
  128. if (s->state != TCP_CHARDEV_STATE_CONNECTED) {
  129. return 0;
  130. }
  131. s->max_size = qemu_chr_be_can_write(chr);
  132. return s->max_size;
  133. }
  134. static void tcp_chr_process_IAC_bytes(Chardev *chr,
  135. SocketChardev *s,
  136. uint8_t *buf, int *size)
  137. {
  138. /* Handle any telnet or tn3270 client's basic IAC options.
  139. * For telnet options, it satisfies char by char mode with no echo.
  140. * For tn3270 options, it satisfies binary mode with EOR.
  141. * All IAC options will be removed from the buf and the do_opt
  142. * pointer will be used to track the state of the width of the
  143. * IAC information.
  144. *
  145. * RFC854: "All TELNET commands consist of at least a two byte sequence.
  146. * The commands dealing with option negotiation are three byte sequences,
  147. * the third byte being the code for the option referenced."
  148. * "IAC BREAK", "IAC IP", "IAC NOP" and the double IAC are two bytes.
  149. * "IAC SB", "IAC SE" and "IAC EOR" are saved to split up data boundary
  150. * for tn3270.
  151. * NOP, Break and Interrupt Process(IP) might be encountered during a TN3270
  152. * session, and NOP and IP need to be done later.
  153. */
  154. int i;
  155. int j = 0;
  156. for (i = 0; i < *size; i++) {
  157. if (s->do_telnetopt > 1) {
  158. if ((unsigned char)buf[i] == IAC && s->do_telnetopt == 2) {
  159. /* Double IAC means send an IAC */
  160. if (j != i) {
  161. buf[j] = buf[i];
  162. }
  163. j++;
  164. s->do_telnetopt = 1;
  165. } else {
  166. if ((unsigned char)buf[i] == IAC_BREAK
  167. && s->do_telnetopt == 2) {
  168. /* Handle IAC break commands by sending a serial break */
  169. qemu_chr_be_event(chr, CHR_EVENT_BREAK);
  170. s->do_telnetopt++;
  171. } else if (s->is_tn3270 && ((unsigned char)buf[i] == IAC_EOR
  172. || (unsigned char)buf[i] == IAC_SB
  173. || (unsigned char)buf[i] == IAC_SE)
  174. && s->do_telnetopt == 2) {
  175. buf[j++] = IAC;
  176. buf[j++] = buf[i];
  177. s->do_telnetopt++;
  178. } else if (s->is_tn3270 && ((unsigned char)buf[i] == IAC_IP
  179. || (unsigned char)buf[i] == IAC_NOP)
  180. && s->do_telnetopt == 2) {
  181. /* TODO: IP and NOP need to be implemented later. */
  182. s->do_telnetopt++;
  183. }
  184. s->do_telnetopt++;
  185. }
  186. if (s->do_telnetopt >= 4) {
  187. s->do_telnetopt = 1;
  188. }
  189. } else {
  190. if ((unsigned char)buf[i] == IAC) {
  191. s->do_telnetopt = 2;
  192. } else {
  193. if (j != i) {
  194. buf[j] = buf[i];
  195. }
  196. j++;
  197. }
  198. }
  199. }
  200. *size = j;
  201. }
  202. static int tcp_get_msgfds(Chardev *chr, int *fds, int num)
  203. {
  204. SocketChardev *s = SOCKET_CHARDEV(chr);
  205. int to_copy = (s->read_msgfds_num < num) ? s->read_msgfds_num : num;
  206. assert(num <= TCP_MAX_FDS);
  207. if (to_copy) {
  208. int i;
  209. memcpy(fds, s->read_msgfds, to_copy * sizeof(int));
  210. /* Close unused fds */
  211. for (i = to_copy; i < s->read_msgfds_num; i++) {
  212. close(s->read_msgfds[i]);
  213. }
  214. g_free(s->read_msgfds);
  215. s->read_msgfds = 0;
  216. s->read_msgfds_num = 0;
  217. }
  218. return to_copy;
  219. }
  220. static int tcp_set_msgfds(Chardev *chr, int *fds, int num)
  221. {
  222. SocketChardev *s = SOCKET_CHARDEV(chr);
  223. /* clear old pending fd array */
  224. g_free(s->write_msgfds);
  225. s->write_msgfds = NULL;
  226. s->write_msgfds_num = 0;
  227. if ((s->state != TCP_CHARDEV_STATE_CONNECTED) ||
  228. !qio_channel_has_feature(s->ioc,
  229. QIO_CHANNEL_FEATURE_FD_PASS)) {
  230. return -1;
  231. }
  232. if (num) {
  233. s->write_msgfds = g_new(int, num);
  234. memcpy(s->write_msgfds, fds, num * sizeof(int));
  235. }
  236. s->write_msgfds_num = num;
  237. return 0;
  238. }
  239. static ssize_t tcp_chr_recv(Chardev *chr, char *buf, size_t len)
  240. {
  241. SocketChardev *s = SOCKET_CHARDEV(chr);
  242. struct iovec iov = { .iov_base = buf, .iov_len = len };
  243. int ret;
  244. size_t i;
  245. int *msgfds = NULL;
  246. size_t msgfds_num = 0;
  247. if (qio_channel_has_feature(s->ioc, QIO_CHANNEL_FEATURE_FD_PASS)) {
  248. ret = qio_channel_readv_full(s->ioc, &iov, 1,
  249. &msgfds, &msgfds_num,
  250. 0, NULL);
  251. } else {
  252. ret = qio_channel_readv_full(s->ioc, &iov, 1,
  253. NULL, NULL,
  254. 0, NULL);
  255. }
  256. if (msgfds_num) {
  257. /* close and clean read_msgfds */
  258. for (i = 0; i < s->read_msgfds_num; i++) {
  259. close(s->read_msgfds[i]);
  260. }
  261. if (s->read_msgfds_num) {
  262. g_free(s->read_msgfds);
  263. }
  264. s->read_msgfds = msgfds;
  265. s->read_msgfds_num = msgfds_num;
  266. }
  267. for (i = 0; i < s->read_msgfds_num; i++) {
  268. int fd = s->read_msgfds[i];
  269. if (fd < 0) {
  270. continue;
  271. }
  272. /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
  273. qemu_socket_set_block(fd);
  274. #ifndef MSG_CMSG_CLOEXEC
  275. qemu_set_cloexec(fd);
  276. #endif
  277. }
  278. if (ret == QIO_CHANNEL_ERR_BLOCK) {
  279. errno = EAGAIN;
  280. ret = -1;
  281. } else if (ret == -1) {
  282. errno = EIO;
  283. }
  284. return ret;
  285. }
  286. static GSource *tcp_chr_add_watch(Chardev *chr, GIOCondition cond)
  287. {
  288. SocketChardev *s = SOCKET_CHARDEV(chr);
  289. if (!s->ioc) {
  290. return NULL;
  291. }
  292. return qio_channel_create_watch(s->ioc, cond);
  293. }
  294. static void remove_hup_source(SocketChardev *s)
  295. {
  296. if (s->hup_source != NULL) {
  297. g_source_destroy(s->hup_source);
  298. g_source_unref(s->hup_source);
  299. s->hup_source = NULL;
  300. }
  301. }
  302. static void char_socket_yank_iochannel(void *opaque)
  303. {
  304. QIOChannel *ioc = QIO_CHANNEL(opaque);
  305. qio_channel_shutdown(ioc, QIO_CHANNEL_SHUTDOWN_BOTH, NULL);
  306. }
  307. static void tcp_chr_free_connection(Chardev *chr)
  308. {
  309. SocketChardev *s = SOCKET_CHARDEV(chr);
  310. int i;
  311. if (s->read_msgfds_num) {
  312. for (i = 0; i < s->read_msgfds_num; i++) {
  313. close(s->read_msgfds[i]);
  314. }
  315. g_free(s->read_msgfds);
  316. s->read_msgfds = NULL;
  317. s->read_msgfds_num = 0;
  318. }
  319. remove_hup_source(s);
  320. tcp_set_msgfds(chr, NULL, 0);
  321. remove_fd_in_watch(chr);
  322. if (s->registered_yank &&
  323. (s->state == TCP_CHARDEV_STATE_CONNECTING
  324. || s->state == TCP_CHARDEV_STATE_CONNECTED)) {
  325. yank_unregister_function(CHARDEV_YANK_INSTANCE(chr->label),
  326. char_socket_yank_iochannel,
  327. QIO_CHANNEL(s->sioc));
  328. }
  329. object_unref(OBJECT(s->sioc));
  330. s->sioc = NULL;
  331. object_unref(OBJECT(s->ioc));
  332. s->ioc = NULL;
  333. g_free(chr->filename);
  334. chr->filename = NULL;
  335. tcp_chr_change_state(s, TCP_CHARDEV_STATE_DISCONNECTED);
  336. }
  337. static const char *qemu_chr_socket_protocol(SocketChardev *s)
  338. {
  339. if (s->is_telnet) {
  340. return "telnet";
  341. }
  342. return s->is_websock ? "websocket" : "tcp";
  343. }
  344. static char *qemu_chr_socket_address(SocketChardev *s, const char *prefix)
  345. {
  346. switch (s->addr->type) {
  347. case SOCKET_ADDRESS_TYPE_INET:
  348. return g_strdup_printf("%s%s:%s:%s%s", prefix,
  349. qemu_chr_socket_protocol(s),
  350. s->addr->u.inet.host,
  351. s->addr->u.inet.port,
  352. s->is_listen ? ",server=on" : "");
  353. break;
  354. case SOCKET_ADDRESS_TYPE_UNIX:
  355. {
  356. const char *tight = "", *abstract = "";
  357. UnixSocketAddress *sa = &s->addr->u.q_unix;
  358. #ifdef CONFIG_LINUX
  359. if (sa->has_abstract && sa->abstract) {
  360. abstract = ",abstract=on";
  361. if (sa->has_tight && sa->tight) {
  362. tight = ",tight=on";
  363. }
  364. }
  365. #endif
  366. return g_strdup_printf("%sunix:%s%s%s%s", prefix, sa->path,
  367. abstract, tight,
  368. s->is_listen ? ",server=on" : "");
  369. break;
  370. }
  371. case SOCKET_ADDRESS_TYPE_FD:
  372. return g_strdup_printf("%sfd:%s%s", prefix, s->addr->u.fd.str,
  373. s->is_listen ? ",server=on" : "");
  374. break;
  375. case SOCKET_ADDRESS_TYPE_VSOCK:
  376. return g_strdup_printf("%svsock:%s:%s", prefix,
  377. s->addr->u.vsock.cid,
  378. s->addr->u.vsock.port);
  379. default:
  380. abort();
  381. }
  382. }
  383. static void update_disconnected_filename(SocketChardev *s)
  384. {
  385. Chardev *chr = CHARDEV(s);
  386. g_free(chr->filename);
  387. if (s->addr) {
  388. chr->filename = qemu_chr_socket_address(s, "disconnected:");
  389. } else {
  390. chr->filename = g_strdup("disconnected:socket");
  391. }
  392. }
  393. /* NB may be called even if tcp_chr_connect has not been
  394. * reached, due to TLS or telnet initialization failure,
  395. * so can *not* assume s->state == TCP_CHARDEV_STATE_CONNECTED
  396. * This must be called with chr->chr_write_lock held.
  397. */
  398. static void tcp_chr_disconnect_locked(Chardev *chr)
  399. {
  400. SocketChardev *s = SOCKET_CHARDEV(chr);
  401. bool emit_close = s->state == TCP_CHARDEV_STATE_CONNECTED;
  402. tcp_chr_free_connection(chr);
  403. if (s->listener) {
  404. qio_net_listener_set_client_func_full(s->listener, tcp_chr_accept,
  405. chr, NULL, chr->gcontext);
  406. }
  407. update_disconnected_filename(s);
  408. if (emit_close) {
  409. qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
  410. }
  411. if (s->reconnect_time && !s->reconnect_timer) {
  412. qemu_chr_socket_restart_timer(chr);
  413. }
  414. }
  415. static void tcp_chr_disconnect(Chardev *chr)
  416. {
  417. qemu_mutex_lock(&chr->chr_write_lock);
  418. tcp_chr_disconnect_locked(chr);
  419. qemu_mutex_unlock(&chr->chr_write_lock);
  420. }
  421. static gboolean tcp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
  422. {
  423. Chardev *chr = CHARDEV(opaque);
  424. SocketChardev *s = SOCKET_CHARDEV(opaque);
  425. uint8_t buf[CHR_READ_BUF_LEN];
  426. int len, size;
  427. if ((s->state != TCP_CHARDEV_STATE_CONNECTED) ||
  428. s->max_size <= 0) {
  429. return TRUE;
  430. }
  431. len = sizeof(buf);
  432. if (len > s->max_size) {
  433. len = s->max_size;
  434. }
  435. size = tcp_chr_recv(chr, (void *)buf, len);
  436. if (size == 0 || (size == -1 && errno != EAGAIN)) {
  437. /* connection closed */
  438. tcp_chr_disconnect(chr);
  439. } else if (size > 0) {
  440. if (s->do_telnetopt) {
  441. tcp_chr_process_IAC_bytes(chr, s, buf, &size);
  442. }
  443. if (size > 0) {
  444. qemu_chr_be_write(chr, buf, size);
  445. }
  446. }
  447. return TRUE;
  448. }
  449. static gboolean tcp_chr_hup(QIOChannel *channel,
  450. GIOCondition cond,
  451. void *opaque)
  452. {
  453. Chardev *chr = CHARDEV(opaque);
  454. tcp_chr_disconnect(chr);
  455. return G_SOURCE_REMOVE;
  456. }
  457. static int tcp_chr_sync_read(Chardev *chr, const uint8_t *buf, int len)
  458. {
  459. SocketChardev *s = SOCKET_CHARDEV(chr);
  460. int size;
  461. int saved_errno;
  462. if (s->state != TCP_CHARDEV_STATE_CONNECTED) {
  463. return 0;
  464. }
  465. qio_channel_set_blocking(s->ioc, true, NULL);
  466. size = tcp_chr_recv(chr, (void *) buf, len);
  467. saved_errno = errno;
  468. if (s->state != TCP_CHARDEV_STATE_DISCONNECTED) {
  469. qio_channel_set_blocking(s->ioc, false, NULL);
  470. }
  471. if (size == 0) {
  472. /* connection closed */
  473. tcp_chr_disconnect(chr);
  474. }
  475. errno = saved_errno;
  476. return size;
  477. }
  478. static char *qemu_chr_compute_filename(SocketChardev *s)
  479. {
  480. struct sockaddr_storage *ss = &s->sioc->localAddr;
  481. struct sockaddr_storage *ps = &s->sioc->remoteAddr;
  482. socklen_t ss_len = s->sioc->localAddrLen;
  483. socklen_t ps_len = s->sioc->remoteAddrLen;
  484. char shost[NI_MAXHOST], sserv[NI_MAXSERV];
  485. char phost[NI_MAXHOST], pserv[NI_MAXSERV];
  486. const char *left = "", *right = "";
  487. switch (ss->ss_family) {
  488. case AF_UNIX:
  489. return g_strdup_printf("unix:%s%s",
  490. ((struct sockaddr_un *)(ss))->sun_path,
  491. s->is_listen ? ",server=on" : "");
  492. case AF_INET6:
  493. left = "[";
  494. right = "]";
  495. /* fall through */
  496. case AF_INET:
  497. getnameinfo((struct sockaddr *) ss, ss_len, shost, sizeof(shost),
  498. sserv, sizeof(sserv), NI_NUMERICHOST | NI_NUMERICSERV);
  499. getnameinfo((struct sockaddr *) ps, ps_len, phost, sizeof(phost),
  500. pserv, sizeof(pserv), NI_NUMERICHOST | NI_NUMERICSERV);
  501. return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",
  502. qemu_chr_socket_protocol(s),
  503. left, shost, right, sserv,
  504. s->is_listen ? ",server=on" : "",
  505. left, phost, right, pserv);
  506. default:
  507. return g_strdup_printf("unknown");
  508. }
  509. }
  510. static void update_ioc_handlers(SocketChardev *s)
  511. {
  512. Chardev *chr = CHARDEV(s);
  513. if (s->state != TCP_CHARDEV_STATE_CONNECTED) {
  514. return;
  515. }
  516. remove_fd_in_watch(chr);
  517. chr->gsource = io_add_watch_poll(chr, s->ioc,
  518. tcp_chr_read_poll,
  519. tcp_chr_read, chr,
  520. chr->gcontext);
  521. remove_hup_source(s);
  522. s->hup_source = qio_channel_create_watch(s->ioc, G_IO_HUP);
  523. g_source_set_callback(s->hup_source, (GSourceFunc)tcp_chr_hup,
  524. chr, NULL);
  525. g_source_attach(s->hup_source, chr->gcontext);
  526. }
  527. static void tcp_chr_connect(void *opaque)
  528. {
  529. Chardev *chr = CHARDEV(opaque);
  530. SocketChardev *s = SOCKET_CHARDEV(opaque);
  531. g_free(chr->filename);
  532. chr->filename = qemu_chr_compute_filename(s);
  533. tcp_chr_change_state(s, TCP_CHARDEV_STATE_CONNECTED);
  534. update_ioc_handlers(s);
  535. qemu_chr_be_event(chr, CHR_EVENT_OPENED);
  536. }
  537. static void tcp_chr_telnet_destroy(SocketChardev *s)
  538. {
  539. if (s->telnet_source) {
  540. g_source_destroy(s->telnet_source);
  541. g_source_unref(s->telnet_source);
  542. s->telnet_source = NULL;
  543. }
  544. }
  545. static void tcp_chr_update_read_handler(Chardev *chr)
  546. {
  547. SocketChardev *s = SOCKET_CHARDEV(chr);
  548. if (s->listener && s->state == TCP_CHARDEV_STATE_DISCONNECTED) {
  549. /*
  550. * It's possible that chardev context is changed in
  551. * qemu_chr_be_update_read_handlers(). Reset it for QIO net
  552. * listener if there is.
  553. */
  554. qio_net_listener_set_client_func_full(s->listener, tcp_chr_accept,
  555. chr, NULL, chr->gcontext);
  556. }
  557. if (s->telnet_source) {
  558. tcp_chr_telnet_init(CHARDEV(s));
  559. }
  560. update_ioc_handlers(s);
  561. }
  562. static gboolean tcp_chr_telnet_init_io(QIOChannel *ioc,
  563. GIOCondition cond G_GNUC_UNUSED,
  564. gpointer user_data)
  565. {
  566. SocketChardev *s = user_data;
  567. Chardev *chr = CHARDEV(s);
  568. TCPChardevTelnetInit *init = s->telnet_init;
  569. ssize_t ret;
  570. assert(init);
  571. ret = qio_channel_write(ioc, init->buf, init->buflen, NULL);
  572. if (ret < 0) {
  573. if (ret == QIO_CHANNEL_ERR_BLOCK) {
  574. ret = 0;
  575. } else {
  576. tcp_chr_disconnect(chr);
  577. goto end;
  578. }
  579. }
  580. init->buflen -= ret;
  581. if (init->buflen == 0) {
  582. tcp_chr_connect(chr);
  583. goto end;
  584. }
  585. memmove(init->buf, init->buf + ret, init->buflen);
  586. return G_SOURCE_CONTINUE;
  587. end:
  588. g_free(s->telnet_init);
  589. s->telnet_init = NULL;
  590. g_source_unref(s->telnet_source);
  591. s->telnet_source = NULL;
  592. return G_SOURCE_REMOVE;
  593. }
  594. static void tcp_chr_telnet_init(Chardev *chr)
  595. {
  596. SocketChardev *s = SOCKET_CHARDEV(chr);
  597. TCPChardevTelnetInit *init;
  598. size_t n = 0;
  599. /* Destroy existing task */
  600. tcp_chr_telnet_destroy(s);
  601. if (s->telnet_init) {
  602. /* We are possibly during a handshake already */
  603. goto cont;
  604. }
  605. s->telnet_init = g_new0(TCPChardevTelnetInit, 1);
  606. init = s->telnet_init;
  607. #define IACSET(x, a, b, c) \
  608. do { \
  609. x[n++] = a; \
  610. x[n++] = b; \
  611. x[n++] = c; \
  612. } while (0)
  613. if (!s->is_tn3270) {
  614. init->buflen = 12;
  615. /* Prep the telnet negotion to put telnet in binary,
  616. * no echo, single char mode */
  617. IACSET(init->buf, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
  618. IACSET(init->buf, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
  619. IACSET(init->buf, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
  620. IACSET(init->buf, 0xff, 0xfd, 0x00); /* IAC DO Binary */
  621. } else {
  622. init->buflen = 21;
  623. /* Prep the TN3270 negotion based on RFC1576 */
  624. IACSET(init->buf, 0xff, 0xfd, 0x19); /* IAC DO EOR */
  625. IACSET(init->buf, 0xff, 0xfb, 0x19); /* IAC WILL EOR */
  626. IACSET(init->buf, 0xff, 0xfd, 0x00); /* IAC DO BINARY */
  627. IACSET(init->buf, 0xff, 0xfb, 0x00); /* IAC WILL BINARY */
  628. IACSET(init->buf, 0xff, 0xfd, 0x18); /* IAC DO TERMINAL TYPE */
  629. IACSET(init->buf, 0xff, 0xfa, 0x18); /* IAC SB TERMINAL TYPE */
  630. IACSET(init->buf, 0x01, 0xff, 0xf0); /* SEND IAC SE */
  631. }
  632. #undef IACSET
  633. cont:
  634. s->telnet_source = qio_channel_add_watch_source(s->ioc, G_IO_OUT,
  635. tcp_chr_telnet_init_io,
  636. s, NULL,
  637. chr->gcontext);
  638. }
  639. static void tcp_chr_websock_handshake(QIOTask *task, gpointer user_data)
  640. {
  641. Chardev *chr = user_data;
  642. SocketChardev *s = user_data;
  643. if (qio_task_propagate_error(task, NULL)) {
  644. tcp_chr_disconnect(chr);
  645. } else {
  646. if (s->do_telnetopt) {
  647. tcp_chr_telnet_init(chr);
  648. } else {
  649. tcp_chr_connect(chr);
  650. }
  651. }
  652. }
  653. static void tcp_chr_websock_init(Chardev *chr)
  654. {
  655. SocketChardev *s = SOCKET_CHARDEV(chr);
  656. QIOChannelWebsock *wioc = NULL;
  657. gchar *name;
  658. wioc = qio_channel_websock_new_server(s->ioc);
  659. name = g_strdup_printf("chardev-websocket-server-%s", chr->label);
  660. qio_channel_set_name(QIO_CHANNEL(wioc), name);
  661. g_free(name);
  662. object_unref(OBJECT(s->ioc));
  663. s->ioc = QIO_CHANNEL(wioc);
  664. qio_channel_websock_handshake(wioc, tcp_chr_websock_handshake, chr, NULL);
  665. }
  666. static void tcp_chr_tls_handshake(QIOTask *task,
  667. gpointer user_data)
  668. {
  669. Chardev *chr = user_data;
  670. SocketChardev *s = user_data;
  671. if (qio_task_propagate_error(task, NULL)) {
  672. tcp_chr_disconnect(chr);
  673. } else {
  674. if (s->is_websock) {
  675. tcp_chr_websock_init(chr);
  676. } else if (s->do_telnetopt) {
  677. tcp_chr_telnet_init(chr);
  678. } else {
  679. tcp_chr_connect(chr);
  680. }
  681. }
  682. }
  683. static void tcp_chr_tls_init(Chardev *chr)
  684. {
  685. SocketChardev *s = SOCKET_CHARDEV(chr);
  686. QIOChannelTLS *tioc;
  687. gchar *name;
  688. if (s->is_listen) {
  689. tioc = qio_channel_tls_new_server(
  690. s->ioc, s->tls_creds,
  691. s->tls_authz,
  692. NULL);
  693. } else {
  694. tioc = qio_channel_tls_new_client(
  695. s->ioc, s->tls_creds,
  696. s->addr->u.inet.host,
  697. NULL);
  698. }
  699. if (tioc == NULL) {
  700. tcp_chr_disconnect(chr);
  701. return;
  702. }
  703. name = g_strdup_printf("chardev-tls-%s-%s",
  704. s->is_listen ? "server" : "client",
  705. chr->label);
  706. qio_channel_set_name(QIO_CHANNEL(tioc), name);
  707. g_free(name);
  708. object_unref(OBJECT(s->ioc));
  709. s->ioc = QIO_CHANNEL(tioc);
  710. qio_channel_tls_handshake(tioc,
  711. tcp_chr_tls_handshake,
  712. chr,
  713. NULL,
  714. chr->gcontext);
  715. }
  716. static void tcp_chr_set_client_ioc_name(Chardev *chr,
  717. QIOChannelSocket *sioc)
  718. {
  719. SocketChardev *s = SOCKET_CHARDEV(chr);
  720. char *name;
  721. name = g_strdup_printf("chardev-tcp-%s-%s",
  722. s->is_listen ? "server" : "client",
  723. chr->label);
  724. qio_channel_set_name(QIO_CHANNEL(sioc), name);
  725. g_free(name);
  726. }
  727. static int tcp_chr_new_client(Chardev *chr, QIOChannelSocket *sioc)
  728. {
  729. SocketChardev *s = SOCKET_CHARDEV(chr);
  730. if (s->state != TCP_CHARDEV_STATE_CONNECTING) {
  731. return -1;
  732. }
  733. s->ioc = QIO_CHANNEL(sioc);
  734. object_ref(OBJECT(sioc));
  735. s->sioc = sioc;
  736. object_ref(OBJECT(sioc));
  737. qio_channel_set_blocking(s->ioc, false, NULL);
  738. if (s->do_nodelay) {
  739. qio_channel_set_delay(s->ioc, false);
  740. }
  741. if (s->listener) {
  742. qio_net_listener_set_client_func_full(s->listener, NULL, NULL,
  743. NULL, chr->gcontext);
  744. }
  745. if (s->tls_creds) {
  746. tcp_chr_tls_init(chr);
  747. } else if (s->is_websock) {
  748. tcp_chr_websock_init(chr);
  749. } else if (s->do_telnetopt) {
  750. tcp_chr_telnet_init(chr);
  751. } else {
  752. tcp_chr_connect(chr);
  753. }
  754. return 0;
  755. }
  756. static int tcp_chr_add_client(Chardev *chr, int fd)
  757. {
  758. int ret;
  759. QIOChannelSocket *sioc;
  760. SocketChardev *s = SOCKET_CHARDEV(chr);
  761. if (s->state != TCP_CHARDEV_STATE_DISCONNECTED) {
  762. return -1;
  763. }
  764. sioc = qio_channel_socket_new_fd(fd, NULL);
  765. if (!sioc) {
  766. return -1;
  767. }
  768. tcp_chr_change_state(s, TCP_CHARDEV_STATE_CONNECTING);
  769. tcp_chr_set_client_ioc_name(chr, sioc);
  770. if (s->registered_yank) {
  771. yank_register_function(CHARDEV_YANK_INSTANCE(chr->label),
  772. char_socket_yank_iochannel,
  773. QIO_CHANNEL(sioc));
  774. }
  775. ret = tcp_chr_new_client(chr, sioc);
  776. object_unref(OBJECT(sioc));
  777. return ret;
  778. }
  779. static void tcp_chr_accept(QIONetListener *listener,
  780. QIOChannelSocket *cioc,
  781. void *opaque)
  782. {
  783. Chardev *chr = CHARDEV(opaque);
  784. SocketChardev *s = SOCKET_CHARDEV(chr);
  785. tcp_chr_change_state(s, TCP_CHARDEV_STATE_CONNECTING);
  786. tcp_chr_set_client_ioc_name(chr, cioc);
  787. if (s->registered_yank) {
  788. yank_register_function(CHARDEV_YANK_INSTANCE(chr->label),
  789. char_socket_yank_iochannel,
  790. QIO_CHANNEL(cioc));
  791. }
  792. tcp_chr_new_client(chr, cioc);
  793. }
  794. static int tcp_chr_connect_client_sync(Chardev *chr, Error **errp)
  795. {
  796. SocketChardev *s = SOCKET_CHARDEV(chr);
  797. QIOChannelSocket *sioc = qio_channel_socket_new();
  798. tcp_chr_change_state(s, TCP_CHARDEV_STATE_CONNECTING);
  799. tcp_chr_set_client_ioc_name(chr, sioc);
  800. if (qio_channel_socket_connect_sync(sioc, s->addr, errp) < 0) {
  801. tcp_chr_change_state(s, TCP_CHARDEV_STATE_DISCONNECTED);
  802. object_unref(OBJECT(sioc));
  803. return -1;
  804. }
  805. if (s->registered_yank) {
  806. yank_register_function(CHARDEV_YANK_INSTANCE(chr->label),
  807. char_socket_yank_iochannel,
  808. QIO_CHANNEL(sioc));
  809. }
  810. tcp_chr_new_client(chr, sioc);
  811. object_unref(OBJECT(sioc));
  812. return 0;
  813. }
  814. static void tcp_chr_accept_server_sync(Chardev *chr)
  815. {
  816. SocketChardev *s = SOCKET_CHARDEV(chr);
  817. QIOChannelSocket *sioc;
  818. info_report("QEMU waiting for connection on: %s",
  819. chr->filename);
  820. tcp_chr_change_state(s, TCP_CHARDEV_STATE_CONNECTING);
  821. sioc = qio_net_listener_wait_client(s->listener);
  822. tcp_chr_set_client_ioc_name(chr, sioc);
  823. if (s->registered_yank) {
  824. yank_register_function(CHARDEV_YANK_INSTANCE(chr->label),
  825. char_socket_yank_iochannel,
  826. QIO_CHANNEL(sioc));
  827. }
  828. tcp_chr_new_client(chr, sioc);
  829. object_unref(OBJECT(sioc));
  830. }
  831. static int tcp_chr_wait_connected(Chardev *chr, Error **errp)
  832. {
  833. SocketChardev *s = SOCKET_CHARDEV(chr);
  834. const char *opts[] = { "telnet", "tn3270", "websock", "tls-creds" };
  835. bool optset[] = { s->is_telnet, s->is_tn3270, s->is_websock, s->tls_creds };
  836. size_t i;
  837. QEMU_BUILD_BUG_ON(G_N_ELEMENTS(opts) != G_N_ELEMENTS(optset));
  838. for (i = 0; i < G_N_ELEMENTS(opts); i++) {
  839. if (optset[i]) {
  840. error_setg(errp,
  841. "'%s' option is incompatible with waiting for "
  842. "connection completion", opts[i]);
  843. return -1;
  844. }
  845. }
  846. tcp_chr_reconn_timer_cancel(s);
  847. /*
  848. * We expect states to be as follows:
  849. *
  850. * - server
  851. * - wait -> CONNECTED
  852. * - nowait -> DISCONNECTED
  853. * - client
  854. * - reconnect == 0 -> CONNECTED
  855. * - reconnect != 0 -> CONNECTING
  856. *
  857. */
  858. if (s->state == TCP_CHARDEV_STATE_CONNECTING) {
  859. if (!s->connect_task) {
  860. error_setg(errp,
  861. "Unexpected 'connecting' state without connect task "
  862. "while waiting for connection completion");
  863. return -1;
  864. }
  865. /*
  866. * tcp_chr_wait_connected should only ever be run from the
  867. * main loop thread associated with chr->gcontext, otherwise
  868. * qio_task_wait_thread has a dangerous race condition with
  869. * free'ing of the s->connect_task object.
  870. *
  871. * Acquiring the main context doesn't 100% prove we're in
  872. * the main loop thread, but it does at least guarantee
  873. * that the main loop won't be executed by another thread
  874. * avoiding the race condition with the task idle callback.
  875. */
  876. g_main_context_acquire(chr->gcontext);
  877. qio_task_wait_thread(s->connect_task);
  878. g_main_context_release(chr->gcontext);
  879. /*
  880. * The completion callback (qemu_chr_socket_connected) for
  881. * s->connect_task should have set this to NULL by the time
  882. * qio_task_wait_thread has returned.
  883. */
  884. assert(!s->connect_task);
  885. /*
  886. * NB we are *not* guaranteed to have "s->state == ..CONNECTED"
  887. * at this point as this first connect may be failed, so
  888. * allow the next loop to run regardless.
  889. */
  890. }
  891. while (s->state != TCP_CHARDEV_STATE_CONNECTED) {
  892. if (s->is_listen) {
  893. tcp_chr_accept_server_sync(chr);
  894. } else {
  895. Error *err = NULL;
  896. if (tcp_chr_connect_client_sync(chr, &err) < 0) {
  897. if (s->reconnect_time) {
  898. error_free(err);
  899. g_usleep(s->reconnect_time * 1000ULL * 1000ULL);
  900. } else {
  901. error_propagate(errp, err);
  902. return -1;
  903. }
  904. }
  905. }
  906. }
  907. return 0;
  908. }
  909. static void char_socket_finalize(Object *obj)
  910. {
  911. Chardev *chr = CHARDEV(obj);
  912. SocketChardev *s = SOCKET_CHARDEV(obj);
  913. tcp_chr_free_connection(chr);
  914. tcp_chr_reconn_timer_cancel(s);
  915. qapi_free_SocketAddress(s->addr);
  916. tcp_chr_telnet_destroy(s);
  917. g_free(s->telnet_init);
  918. if (s->listener) {
  919. qio_net_listener_set_client_func_full(s->listener, NULL, NULL,
  920. NULL, chr->gcontext);
  921. object_unref(OBJECT(s->listener));
  922. }
  923. if (s->tls_creds) {
  924. object_unref(OBJECT(s->tls_creds));
  925. }
  926. g_free(s->tls_authz);
  927. if (s->registered_yank) {
  928. /*
  929. * In the chardev-change special-case, we shouldn't unregister the yank
  930. * instance, as it still may be needed.
  931. */
  932. if (!chr->handover_yank_instance) {
  933. yank_unregister_instance(CHARDEV_YANK_INSTANCE(chr->label));
  934. }
  935. }
  936. qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
  937. }
  938. static void qemu_chr_socket_connected(QIOTask *task, void *opaque)
  939. {
  940. QIOChannelSocket *sioc = QIO_CHANNEL_SOCKET(qio_task_get_source(task));
  941. Chardev *chr = CHARDEV(opaque);
  942. SocketChardev *s = SOCKET_CHARDEV(chr);
  943. Error *err = NULL;
  944. s->connect_task = NULL;
  945. if (qio_task_propagate_error(task, &err)) {
  946. tcp_chr_change_state(s, TCP_CHARDEV_STATE_DISCONNECTED);
  947. if (s->registered_yank) {
  948. yank_unregister_function(CHARDEV_YANK_INSTANCE(chr->label),
  949. char_socket_yank_iochannel,
  950. QIO_CHANNEL(sioc));
  951. }
  952. check_report_connect_error(chr, err);
  953. goto cleanup;
  954. }
  955. s->connect_err_reported = false;
  956. tcp_chr_new_client(chr, sioc);
  957. cleanup:
  958. object_unref(OBJECT(sioc));
  959. }
  960. static void tcp_chr_connect_client_task(QIOTask *task,
  961. gpointer opaque)
  962. {
  963. QIOChannelSocket *ioc = QIO_CHANNEL_SOCKET(qio_task_get_source(task));
  964. SocketAddress *addr = opaque;
  965. Error *err = NULL;
  966. qio_channel_socket_connect_sync(ioc, addr, &err);
  967. qio_task_set_error(task, err);
  968. }
  969. static void tcp_chr_connect_client_async(Chardev *chr)
  970. {
  971. SocketChardev *s = SOCKET_CHARDEV(chr);
  972. QIOChannelSocket *sioc;
  973. tcp_chr_change_state(s, TCP_CHARDEV_STATE_CONNECTING);
  974. sioc = qio_channel_socket_new();
  975. tcp_chr_set_client_ioc_name(chr, sioc);
  976. if (s->registered_yank) {
  977. yank_register_function(CHARDEV_YANK_INSTANCE(chr->label),
  978. char_socket_yank_iochannel,
  979. QIO_CHANNEL(sioc));
  980. }
  981. /*
  982. * Normally code would use the qio_channel_socket_connect_async
  983. * method which uses a QIOTask + qio_task_set_error internally
  984. * to avoid blocking. The tcp_chr_wait_connected method, however,
  985. * needs a way to synchronize with completion of the background
  986. * connect task which can't be done with the QIOChannelSocket
  987. * async APIs. Thus we must use QIOTask directly to implement
  988. * the non-blocking concept locally.
  989. */
  990. s->connect_task = qio_task_new(OBJECT(sioc),
  991. qemu_chr_socket_connected,
  992. object_ref(OBJECT(chr)),
  993. (GDestroyNotify)object_unref);
  994. qio_task_run_in_thread(s->connect_task,
  995. tcp_chr_connect_client_task,
  996. s->addr,
  997. NULL,
  998. chr->gcontext);
  999. }
  1000. static gboolean socket_reconnect_timeout(gpointer opaque)
  1001. {
  1002. Chardev *chr = CHARDEV(opaque);
  1003. SocketChardev *s = SOCKET_CHARDEV(opaque);
  1004. qemu_mutex_lock(&chr->chr_write_lock);
  1005. g_source_unref(s->reconnect_timer);
  1006. s->reconnect_timer = NULL;
  1007. qemu_mutex_unlock(&chr->chr_write_lock);
  1008. if (chr->be_open) {
  1009. return false;
  1010. }
  1011. tcp_chr_connect_client_async(chr);
  1012. return false;
  1013. }
  1014. static int qmp_chardev_open_socket_server(Chardev *chr,
  1015. bool is_telnet,
  1016. bool is_waitconnect,
  1017. Error **errp)
  1018. {
  1019. SocketChardev *s = SOCKET_CHARDEV(chr);
  1020. char *name;
  1021. if (is_telnet) {
  1022. s->do_telnetopt = 1;
  1023. }
  1024. s->listener = qio_net_listener_new();
  1025. name = g_strdup_printf("chardev-tcp-listener-%s", chr->label);
  1026. qio_net_listener_set_name(s->listener, name);
  1027. g_free(name);
  1028. if (s->addr->type == SOCKET_ADDRESS_TYPE_FD && !*s->addr->u.fd.str) {
  1029. goto skip_listen;
  1030. }
  1031. if (qio_net_listener_open_sync(s->listener, s->addr, 1, errp) < 0) {
  1032. object_unref(OBJECT(s->listener));
  1033. s->listener = NULL;
  1034. return -1;
  1035. }
  1036. qapi_free_SocketAddress(s->addr);
  1037. s->addr = socket_local_address(s->listener->sioc[0]->fd, errp);
  1038. skip_listen:
  1039. update_disconnected_filename(s);
  1040. if (is_waitconnect) {
  1041. tcp_chr_accept_server_sync(chr);
  1042. } else {
  1043. qio_net_listener_set_client_func_full(s->listener,
  1044. tcp_chr_accept,
  1045. chr, NULL,
  1046. chr->gcontext);
  1047. }
  1048. return 0;
  1049. }
  1050. static int qmp_chardev_open_socket_client(Chardev *chr,
  1051. int64_t reconnect,
  1052. Error **errp)
  1053. {
  1054. SocketChardev *s = SOCKET_CHARDEV(chr);
  1055. if (reconnect > 0) {
  1056. s->reconnect_time = reconnect;
  1057. tcp_chr_connect_client_async(chr);
  1058. return 0;
  1059. } else {
  1060. return tcp_chr_connect_client_sync(chr, errp);
  1061. }
  1062. }
  1063. static bool qmp_chardev_validate_socket(ChardevSocket *sock,
  1064. SocketAddress *addr,
  1065. Error **errp)
  1066. {
  1067. /* Validate any options which have a dependency on address type */
  1068. switch (addr->type) {
  1069. case SOCKET_ADDRESS_TYPE_FD:
  1070. if (sock->has_reconnect) {
  1071. error_setg(errp,
  1072. "'reconnect' option is incompatible with "
  1073. "'fd' address type");
  1074. return false;
  1075. }
  1076. if (sock->tls_creds &&
  1077. !(sock->has_server && sock->server)) {
  1078. error_setg(errp,
  1079. "'tls_creds' option is incompatible with "
  1080. "'fd' address type as client");
  1081. return false;
  1082. }
  1083. break;
  1084. case SOCKET_ADDRESS_TYPE_UNIX:
  1085. if (sock->tls_creds) {
  1086. error_setg(errp,
  1087. "'tls_creds' option is incompatible with "
  1088. "'unix' address type");
  1089. return false;
  1090. }
  1091. break;
  1092. case SOCKET_ADDRESS_TYPE_INET:
  1093. break;
  1094. case SOCKET_ADDRESS_TYPE_VSOCK:
  1095. if (sock->tls_creds) {
  1096. error_setg(errp,
  1097. "'tls_creds' option is incompatible with "
  1098. "'vsock' address type");
  1099. return false;
  1100. }
  1101. default:
  1102. break;
  1103. }
  1104. if (sock->tls_authz && !sock->tls_creds) {
  1105. error_setg(errp, "'tls_authz' option requires 'tls_creds' option");
  1106. return false;
  1107. }
  1108. /* Validate any options which have a dependancy on client vs server */
  1109. if (!sock->has_server || sock->server) {
  1110. if (sock->has_reconnect) {
  1111. error_setg(errp,
  1112. "'reconnect' option is incompatible with "
  1113. "socket in server listen mode");
  1114. return false;
  1115. }
  1116. } else {
  1117. if (sock->has_websocket && sock->websocket) {
  1118. error_setg(errp, "%s", "Websocket client is not implemented");
  1119. return false;
  1120. }
  1121. if (sock->has_wait) {
  1122. error_setg(errp, "%s",
  1123. "'wait' option is incompatible with "
  1124. "socket in client connect mode");
  1125. return false;
  1126. }
  1127. }
  1128. return true;
  1129. }
  1130. static void qmp_chardev_open_socket(Chardev *chr,
  1131. ChardevBackend *backend,
  1132. bool *be_opened,
  1133. Error **errp)
  1134. {
  1135. SocketChardev *s = SOCKET_CHARDEV(chr);
  1136. ChardevSocket *sock = backend->u.socket.data;
  1137. bool do_nodelay = sock->has_nodelay ? sock->nodelay : false;
  1138. bool is_listen = sock->has_server ? sock->server : true;
  1139. bool is_telnet = sock->has_telnet ? sock->telnet : false;
  1140. bool is_tn3270 = sock->has_tn3270 ? sock->tn3270 : false;
  1141. bool is_waitconnect = sock->has_wait ? sock->wait : false;
  1142. bool is_websock = sock->has_websocket ? sock->websocket : false;
  1143. int64_t reconnect = sock->has_reconnect ? sock->reconnect : 0;
  1144. SocketAddress *addr;
  1145. s->is_listen = is_listen;
  1146. s->is_telnet = is_telnet;
  1147. s->is_tn3270 = is_tn3270;
  1148. s->is_websock = is_websock;
  1149. s->do_nodelay = do_nodelay;
  1150. if (sock->tls_creds) {
  1151. Object *creds;
  1152. creds = object_resolve_path_component(
  1153. object_get_objects_root(), sock->tls_creds);
  1154. if (!creds) {
  1155. error_setg(errp, "No TLS credentials with id '%s'",
  1156. sock->tls_creds);
  1157. return;
  1158. }
  1159. s->tls_creds = (QCryptoTLSCreds *)
  1160. object_dynamic_cast(creds,
  1161. TYPE_QCRYPTO_TLS_CREDS);
  1162. if (!s->tls_creds) {
  1163. error_setg(errp, "Object with id '%s' is not TLS credentials",
  1164. sock->tls_creds);
  1165. return;
  1166. }
  1167. object_ref(OBJECT(s->tls_creds));
  1168. if (!qcrypto_tls_creds_check_endpoint(s->tls_creds,
  1169. is_listen
  1170. ? QCRYPTO_TLS_CREDS_ENDPOINT_SERVER
  1171. : QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT,
  1172. errp)) {
  1173. return;
  1174. }
  1175. }
  1176. s->tls_authz = g_strdup(sock->tls_authz);
  1177. s->addr = addr = socket_address_flatten(sock->addr);
  1178. if (!qmp_chardev_validate_socket(sock, addr, errp)) {
  1179. return;
  1180. }
  1181. qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_RECONNECTABLE);
  1182. #ifndef _WIN32
  1183. /* TODO SOCKET_ADDRESS_FD where fd has AF_UNIX */
  1184. if (addr->type == SOCKET_ADDRESS_TYPE_UNIX) {
  1185. qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_FD_PASS);
  1186. }
  1187. #endif
  1188. /*
  1189. * In the chardev-change special-case, we shouldn't register a new yank
  1190. * instance, as there already may be one.
  1191. */
  1192. if (!chr->handover_yank_instance) {
  1193. if (!yank_register_instance(CHARDEV_YANK_INSTANCE(chr->label), errp)) {
  1194. return;
  1195. }
  1196. }
  1197. s->registered_yank = true;
  1198. /* be isn't opened until we get a connection */
  1199. *be_opened = false;
  1200. update_disconnected_filename(s);
  1201. if (s->is_listen) {
  1202. if (qmp_chardev_open_socket_server(chr, is_telnet || is_tn3270,
  1203. is_waitconnect, errp) < 0) {
  1204. return;
  1205. }
  1206. } else {
  1207. if (qmp_chardev_open_socket_client(chr, reconnect, errp) < 0) {
  1208. return;
  1209. }
  1210. }
  1211. }
  1212. static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
  1213. Error **errp)
  1214. {
  1215. const char *path = qemu_opt_get(opts, "path");
  1216. const char *host = qemu_opt_get(opts, "host");
  1217. const char *port = qemu_opt_get(opts, "port");
  1218. const char *fd = qemu_opt_get(opts, "fd");
  1219. #ifdef CONFIG_LINUX
  1220. bool tight = qemu_opt_get_bool(opts, "tight", true);
  1221. bool abstract = qemu_opt_get_bool(opts, "abstract", false);
  1222. #endif
  1223. SocketAddressLegacy *addr;
  1224. ChardevSocket *sock;
  1225. if ((!!path + !!fd + !!host) > 1) {
  1226. error_setg(errp,
  1227. "None or one of 'path', 'fd' or 'host' option required.");
  1228. return;
  1229. }
  1230. if (host && !port) {
  1231. error_setg(errp, "chardev: socket: no port given");
  1232. return;
  1233. }
  1234. backend->type = CHARDEV_BACKEND_KIND_SOCKET;
  1235. sock = backend->u.socket.data = g_new0(ChardevSocket, 1);
  1236. qemu_chr_parse_common(opts, qapi_ChardevSocket_base(sock));
  1237. if (qemu_opt_get(opts, "delay") && qemu_opt_get(opts, "nodelay")) {
  1238. error_setg(errp, "'delay' and 'nodelay' are mutually exclusive");
  1239. return;
  1240. }
  1241. sock->has_nodelay =
  1242. qemu_opt_get(opts, "delay") ||
  1243. qemu_opt_get(opts, "nodelay");
  1244. sock->nodelay =
  1245. !qemu_opt_get_bool(opts, "delay", true) ||
  1246. qemu_opt_get_bool(opts, "nodelay", false);
  1247. /*
  1248. * We have different default to QMP for 'server', hence
  1249. * we can't just check for existence of 'server'
  1250. */
  1251. sock->has_server = true;
  1252. sock->server = qemu_opt_get_bool(opts, "server", false);
  1253. sock->has_telnet = qemu_opt_get(opts, "telnet");
  1254. sock->telnet = qemu_opt_get_bool(opts, "telnet", false);
  1255. sock->has_tn3270 = qemu_opt_get(opts, "tn3270");
  1256. sock->tn3270 = qemu_opt_get_bool(opts, "tn3270", false);
  1257. sock->has_websocket = qemu_opt_get(opts, "websocket");
  1258. sock->websocket = qemu_opt_get_bool(opts, "websocket", false);
  1259. /*
  1260. * We have different default to QMP for 'wait' when 'server'
  1261. * is set, hence we can't just check for existence of 'wait'
  1262. */
  1263. sock->has_wait = qemu_opt_find(opts, "wait") || sock->server;
  1264. sock->wait = qemu_opt_get_bool(opts, "wait", true);
  1265. sock->has_reconnect = qemu_opt_find(opts, "reconnect");
  1266. sock->reconnect = qemu_opt_get_number(opts, "reconnect", 0);
  1267. sock->tls_creds = g_strdup(qemu_opt_get(opts, "tls-creds"));
  1268. sock->tls_authz = g_strdup(qemu_opt_get(opts, "tls-authz"));
  1269. addr = g_new0(SocketAddressLegacy, 1);
  1270. if (path) {
  1271. UnixSocketAddress *q_unix;
  1272. addr->type = SOCKET_ADDRESS_TYPE_UNIX;
  1273. q_unix = addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
  1274. q_unix->path = g_strdup(path);
  1275. #ifdef CONFIG_LINUX
  1276. q_unix->has_tight = true;
  1277. q_unix->tight = tight;
  1278. q_unix->has_abstract = true;
  1279. q_unix->abstract = abstract;
  1280. #endif
  1281. } else if (host) {
  1282. addr->type = SOCKET_ADDRESS_TYPE_INET;
  1283. addr->u.inet.data = g_new(InetSocketAddress, 1);
  1284. *addr->u.inet.data = (InetSocketAddress) {
  1285. .host = g_strdup(host),
  1286. .port = g_strdup(port),
  1287. .has_to = qemu_opt_get(opts, "to"),
  1288. .to = qemu_opt_get_number(opts, "to", 0),
  1289. .has_ipv4 = qemu_opt_get(opts, "ipv4"),
  1290. .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
  1291. .has_ipv6 = qemu_opt_get(opts, "ipv6"),
  1292. .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
  1293. };
  1294. } else {
  1295. addr->type = SOCKET_ADDRESS_TYPE_FD;
  1296. addr->u.fd.data = g_new(String, 1);
  1297. addr->u.fd.data->str = g_strdup(fd);
  1298. }
  1299. sock->addr = addr;
  1300. }
  1301. static void
  1302. char_socket_get_addr(Object *obj, Visitor *v, const char *name,
  1303. void *opaque, Error **errp)
  1304. {
  1305. SocketChardev *s = SOCKET_CHARDEV(obj);
  1306. visit_type_SocketAddress(v, name, &s->addr, errp);
  1307. }
  1308. static bool
  1309. char_socket_get_connected(Object *obj, Error **errp)
  1310. {
  1311. SocketChardev *s = SOCKET_CHARDEV(obj);
  1312. return s->state == TCP_CHARDEV_STATE_CONNECTED;
  1313. }
  1314. static void char_socket_class_init(ObjectClass *oc, void *data)
  1315. {
  1316. ChardevClass *cc = CHARDEV_CLASS(oc);
  1317. cc->supports_yank = true;
  1318. cc->parse = qemu_chr_parse_socket;
  1319. cc->open = qmp_chardev_open_socket;
  1320. cc->chr_wait_connected = tcp_chr_wait_connected;
  1321. cc->chr_write = tcp_chr_write;
  1322. cc->chr_sync_read = tcp_chr_sync_read;
  1323. cc->chr_disconnect = tcp_chr_disconnect;
  1324. cc->get_msgfds = tcp_get_msgfds;
  1325. cc->set_msgfds = tcp_set_msgfds;
  1326. cc->chr_add_client = tcp_chr_add_client;
  1327. cc->chr_add_watch = tcp_chr_add_watch;
  1328. cc->chr_update_read_handler = tcp_chr_update_read_handler;
  1329. object_class_property_add(oc, "addr", "SocketAddress",
  1330. char_socket_get_addr, NULL,
  1331. NULL, NULL);
  1332. object_class_property_add_bool(oc, "connected", char_socket_get_connected,
  1333. NULL);
  1334. }
  1335. static const TypeInfo char_socket_type_info = {
  1336. .name = TYPE_CHARDEV_SOCKET,
  1337. .parent = TYPE_CHARDEV,
  1338. .instance_size = sizeof(SocketChardev),
  1339. .instance_finalize = char_socket_finalize,
  1340. .class_init = char_socket_class_init,
  1341. };
  1342. static void register_types(void)
  1343. {
  1344. type_register_static(&char_socket_type_info);
  1345. }
  1346. type_init(register_types);