2
0

char-socket.c 50 KB

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