char-socket.c 47 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561
  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. s->listener = NULL;
  923. }
  924. if (s->tls_creds) {
  925. object_unref(OBJECT(s->tls_creds));
  926. }
  927. g_free(s->tls_authz);
  928. if (s->registered_yank) {
  929. /*
  930. * In the chardev-change special-case, we shouldn't unregister the yank
  931. * instance, as it still may be needed.
  932. */
  933. if (!chr->handover_yank_instance) {
  934. yank_unregister_instance(CHARDEV_YANK_INSTANCE(chr->label));
  935. }
  936. }
  937. qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
  938. }
  939. static void qemu_chr_socket_connected(QIOTask *task, void *opaque)
  940. {
  941. QIOChannelSocket *sioc = QIO_CHANNEL_SOCKET(qio_task_get_source(task));
  942. Chardev *chr = CHARDEV(opaque);
  943. SocketChardev *s = SOCKET_CHARDEV(chr);
  944. Error *err = NULL;
  945. s->connect_task = NULL;
  946. if (qio_task_propagate_error(task, &err)) {
  947. tcp_chr_change_state(s, TCP_CHARDEV_STATE_DISCONNECTED);
  948. if (s->registered_yank) {
  949. yank_unregister_function(CHARDEV_YANK_INSTANCE(chr->label),
  950. char_socket_yank_iochannel,
  951. QIO_CHANNEL(sioc));
  952. }
  953. check_report_connect_error(chr, err);
  954. goto cleanup;
  955. }
  956. s->connect_err_reported = false;
  957. tcp_chr_new_client(chr, sioc);
  958. cleanup:
  959. object_unref(OBJECT(sioc));
  960. }
  961. static void tcp_chr_connect_client_task(QIOTask *task,
  962. gpointer opaque)
  963. {
  964. QIOChannelSocket *ioc = QIO_CHANNEL_SOCKET(qio_task_get_source(task));
  965. SocketAddress *addr = opaque;
  966. Error *err = NULL;
  967. qio_channel_socket_connect_sync(ioc, addr, &err);
  968. qio_task_set_error(task, err);
  969. }
  970. static void tcp_chr_connect_client_async(Chardev *chr)
  971. {
  972. SocketChardev *s = SOCKET_CHARDEV(chr);
  973. QIOChannelSocket *sioc;
  974. tcp_chr_change_state(s, TCP_CHARDEV_STATE_CONNECTING);
  975. sioc = qio_channel_socket_new();
  976. tcp_chr_set_client_ioc_name(chr, sioc);
  977. if (s->registered_yank) {
  978. yank_register_function(CHARDEV_YANK_INSTANCE(chr->label),
  979. char_socket_yank_iochannel,
  980. QIO_CHANNEL(sioc));
  981. }
  982. /*
  983. * Normally code would use the qio_channel_socket_connect_async
  984. * method which uses a QIOTask + qio_task_set_error internally
  985. * to avoid blocking. The tcp_chr_wait_connected method, however,
  986. * needs a way to synchronize with completion of the background
  987. * connect task which can't be done with the QIOChannelSocket
  988. * async APIs. Thus we must use QIOTask directly to implement
  989. * the non-blocking concept locally.
  990. */
  991. s->connect_task = qio_task_new(OBJECT(sioc),
  992. qemu_chr_socket_connected,
  993. object_ref(OBJECT(chr)),
  994. (GDestroyNotify)object_unref);
  995. qio_task_run_in_thread(s->connect_task,
  996. tcp_chr_connect_client_task,
  997. s->addr,
  998. NULL,
  999. chr->gcontext);
  1000. }
  1001. static gboolean socket_reconnect_timeout(gpointer opaque)
  1002. {
  1003. Chardev *chr = CHARDEV(opaque);
  1004. SocketChardev *s = SOCKET_CHARDEV(opaque);
  1005. qemu_mutex_lock(&chr->chr_write_lock);
  1006. g_source_unref(s->reconnect_timer);
  1007. s->reconnect_timer = NULL;
  1008. qemu_mutex_unlock(&chr->chr_write_lock);
  1009. if (chr->be_open) {
  1010. return false;
  1011. }
  1012. tcp_chr_connect_client_async(chr);
  1013. return false;
  1014. }
  1015. static int qmp_chardev_open_socket_server(Chardev *chr,
  1016. bool is_telnet,
  1017. bool is_waitconnect,
  1018. Error **errp)
  1019. {
  1020. SocketChardev *s = SOCKET_CHARDEV(chr);
  1021. char *name;
  1022. if (is_telnet) {
  1023. s->do_telnetopt = 1;
  1024. }
  1025. s->listener = qio_net_listener_new();
  1026. name = g_strdup_printf("chardev-tcp-listener-%s", chr->label);
  1027. qio_net_listener_set_name(s->listener, name);
  1028. g_free(name);
  1029. if (s->addr->type == SOCKET_ADDRESS_TYPE_FD && !*s->addr->u.fd.str) {
  1030. goto skip_listen;
  1031. }
  1032. if (qio_net_listener_open_sync(s->listener, s->addr, 1, errp) < 0) {
  1033. object_unref(OBJECT(s->listener));
  1034. s->listener = NULL;
  1035. return -1;
  1036. }
  1037. qapi_free_SocketAddress(s->addr);
  1038. s->addr = socket_local_address(s->listener->sioc[0]->fd, errp);
  1039. skip_listen:
  1040. update_disconnected_filename(s);
  1041. if (is_waitconnect) {
  1042. tcp_chr_accept_server_sync(chr);
  1043. } else {
  1044. qio_net_listener_set_client_func_full(s->listener,
  1045. tcp_chr_accept,
  1046. chr, NULL,
  1047. chr->gcontext);
  1048. }
  1049. return 0;
  1050. }
  1051. static int qmp_chardev_open_socket_client(Chardev *chr,
  1052. int64_t reconnect,
  1053. Error **errp)
  1054. {
  1055. SocketChardev *s = SOCKET_CHARDEV(chr);
  1056. if (reconnect > 0) {
  1057. s->reconnect_time = reconnect;
  1058. tcp_chr_connect_client_async(chr);
  1059. return 0;
  1060. } else {
  1061. return tcp_chr_connect_client_sync(chr, errp);
  1062. }
  1063. }
  1064. static bool qmp_chardev_validate_socket(ChardevSocket *sock,
  1065. SocketAddress *addr,
  1066. Error **errp)
  1067. {
  1068. /* Validate any options which have a dependency on address type */
  1069. switch (addr->type) {
  1070. case SOCKET_ADDRESS_TYPE_FD:
  1071. if (sock->has_reconnect) {
  1072. error_setg(errp,
  1073. "'reconnect' option is incompatible with "
  1074. "'fd' address type");
  1075. return false;
  1076. }
  1077. if (sock->tls_creds &&
  1078. !(sock->has_server && sock->server)) {
  1079. error_setg(errp,
  1080. "'tls_creds' option is incompatible with "
  1081. "'fd' address type as client");
  1082. return false;
  1083. }
  1084. break;
  1085. case SOCKET_ADDRESS_TYPE_UNIX:
  1086. if (sock->tls_creds) {
  1087. error_setg(errp,
  1088. "'tls_creds' option is incompatible with "
  1089. "'unix' address type");
  1090. return false;
  1091. }
  1092. break;
  1093. case SOCKET_ADDRESS_TYPE_INET:
  1094. break;
  1095. case SOCKET_ADDRESS_TYPE_VSOCK:
  1096. if (sock->tls_creds) {
  1097. error_setg(errp,
  1098. "'tls_creds' option is incompatible with "
  1099. "'vsock' address type");
  1100. return false;
  1101. }
  1102. default:
  1103. break;
  1104. }
  1105. if (sock->tls_authz && !sock->tls_creds) {
  1106. error_setg(errp, "'tls_authz' option requires 'tls_creds' option");
  1107. return false;
  1108. }
  1109. /* Validate any options which have a dependancy on client vs server */
  1110. if (!sock->has_server || sock->server) {
  1111. if (sock->has_reconnect) {
  1112. error_setg(errp,
  1113. "'reconnect' option is incompatible with "
  1114. "socket in server listen mode");
  1115. return false;
  1116. }
  1117. } else {
  1118. if (sock->has_websocket && sock->websocket) {
  1119. error_setg(errp, "%s", "Websocket client is not implemented");
  1120. return false;
  1121. }
  1122. if (sock->has_wait) {
  1123. error_setg(errp, "%s",
  1124. "'wait' option is incompatible with "
  1125. "socket in client connect mode");
  1126. return false;
  1127. }
  1128. }
  1129. return true;
  1130. }
  1131. static void qmp_chardev_open_socket(Chardev *chr,
  1132. ChardevBackend *backend,
  1133. bool *be_opened,
  1134. Error **errp)
  1135. {
  1136. SocketChardev *s = SOCKET_CHARDEV(chr);
  1137. ChardevSocket *sock = backend->u.socket.data;
  1138. bool do_nodelay = sock->has_nodelay ? sock->nodelay : false;
  1139. bool is_listen = sock->has_server ? sock->server : true;
  1140. bool is_telnet = sock->has_telnet ? sock->telnet : false;
  1141. bool is_tn3270 = sock->has_tn3270 ? sock->tn3270 : false;
  1142. bool is_waitconnect = sock->has_wait ? sock->wait : false;
  1143. bool is_websock = sock->has_websocket ? sock->websocket : false;
  1144. int64_t reconnect = sock->has_reconnect ? sock->reconnect : 0;
  1145. SocketAddress *addr;
  1146. s->is_listen = is_listen;
  1147. s->is_telnet = is_telnet;
  1148. s->is_tn3270 = is_tn3270;
  1149. s->is_websock = is_websock;
  1150. s->do_nodelay = do_nodelay;
  1151. if (sock->tls_creds) {
  1152. Object *creds;
  1153. creds = object_resolve_path_component(
  1154. object_get_objects_root(), sock->tls_creds);
  1155. if (!creds) {
  1156. error_setg(errp, "No TLS credentials with id '%s'",
  1157. sock->tls_creds);
  1158. return;
  1159. }
  1160. s->tls_creds = (QCryptoTLSCreds *)
  1161. object_dynamic_cast(creds,
  1162. TYPE_QCRYPTO_TLS_CREDS);
  1163. if (!s->tls_creds) {
  1164. error_setg(errp, "Object with id '%s' is not TLS credentials",
  1165. sock->tls_creds);
  1166. return;
  1167. }
  1168. object_ref(OBJECT(s->tls_creds));
  1169. if (!qcrypto_tls_creds_check_endpoint(s->tls_creds,
  1170. is_listen
  1171. ? QCRYPTO_TLS_CREDS_ENDPOINT_SERVER
  1172. : QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT,
  1173. errp)) {
  1174. return;
  1175. }
  1176. }
  1177. s->tls_authz = g_strdup(sock->tls_authz);
  1178. s->addr = addr = socket_address_flatten(sock->addr);
  1179. if (!qmp_chardev_validate_socket(sock, addr, errp)) {
  1180. return;
  1181. }
  1182. qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_RECONNECTABLE);
  1183. #ifndef _WIN32
  1184. /* TODO SOCKET_ADDRESS_FD where fd has AF_UNIX */
  1185. if (addr->type == SOCKET_ADDRESS_TYPE_UNIX) {
  1186. qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_FD_PASS);
  1187. }
  1188. #endif
  1189. /*
  1190. * In the chardev-change special-case, we shouldn't register a new yank
  1191. * instance, as there already may be one.
  1192. */
  1193. if (!chr->handover_yank_instance) {
  1194. if (!yank_register_instance(CHARDEV_YANK_INSTANCE(chr->label), errp)) {
  1195. return;
  1196. }
  1197. }
  1198. s->registered_yank = true;
  1199. /* be isn't opened until we get a connection */
  1200. *be_opened = false;
  1201. update_disconnected_filename(s);
  1202. if (s->is_listen) {
  1203. if (qmp_chardev_open_socket_server(chr, is_telnet || is_tn3270,
  1204. is_waitconnect, errp) < 0) {
  1205. return;
  1206. }
  1207. } else {
  1208. if (qmp_chardev_open_socket_client(chr, reconnect, errp) < 0) {
  1209. return;
  1210. }
  1211. }
  1212. }
  1213. static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
  1214. Error **errp)
  1215. {
  1216. const char *path = qemu_opt_get(opts, "path");
  1217. const char *host = qemu_opt_get(opts, "host");
  1218. const char *port = qemu_opt_get(opts, "port");
  1219. const char *fd = qemu_opt_get(opts, "fd");
  1220. #ifdef CONFIG_LINUX
  1221. bool tight = qemu_opt_get_bool(opts, "tight", true);
  1222. bool abstract = qemu_opt_get_bool(opts, "abstract", false);
  1223. #endif
  1224. SocketAddressLegacy *addr;
  1225. ChardevSocket *sock;
  1226. if ((!!path + !!fd + !!host) > 1) {
  1227. error_setg(errp,
  1228. "None or one of 'path', 'fd' or 'host' option required.");
  1229. return;
  1230. }
  1231. if (host && !port) {
  1232. error_setg(errp, "chardev: socket: no port given");
  1233. return;
  1234. }
  1235. backend->type = CHARDEV_BACKEND_KIND_SOCKET;
  1236. sock = backend->u.socket.data = g_new0(ChardevSocket, 1);
  1237. qemu_chr_parse_common(opts, qapi_ChardevSocket_base(sock));
  1238. if (qemu_opt_get(opts, "delay") && qemu_opt_get(opts, "nodelay")) {
  1239. error_setg(errp, "'delay' and 'nodelay' are mutually exclusive");
  1240. return;
  1241. }
  1242. sock->has_nodelay =
  1243. qemu_opt_get(opts, "delay") ||
  1244. qemu_opt_get(opts, "nodelay");
  1245. sock->nodelay =
  1246. !qemu_opt_get_bool(opts, "delay", true) ||
  1247. qemu_opt_get_bool(opts, "nodelay", false);
  1248. /*
  1249. * We have different default to QMP for 'server', hence
  1250. * we can't just check for existence of 'server'
  1251. */
  1252. sock->has_server = true;
  1253. sock->server = qemu_opt_get_bool(opts, "server", false);
  1254. sock->has_telnet = qemu_opt_get(opts, "telnet");
  1255. sock->telnet = qemu_opt_get_bool(opts, "telnet", false);
  1256. sock->has_tn3270 = qemu_opt_get(opts, "tn3270");
  1257. sock->tn3270 = qemu_opt_get_bool(opts, "tn3270", false);
  1258. sock->has_websocket = qemu_opt_get(opts, "websocket");
  1259. sock->websocket = qemu_opt_get_bool(opts, "websocket", false);
  1260. /*
  1261. * We have different default to QMP for 'wait' when 'server'
  1262. * is set, hence we can't just check for existence of 'wait'
  1263. */
  1264. sock->has_wait = qemu_opt_find(opts, "wait") || sock->server;
  1265. sock->wait = qemu_opt_get_bool(opts, "wait", true);
  1266. sock->has_reconnect = qemu_opt_find(opts, "reconnect");
  1267. sock->reconnect = qemu_opt_get_number(opts, "reconnect", 0);
  1268. sock->tls_creds = g_strdup(qemu_opt_get(opts, "tls-creds"));
  1269. sock->tls_authz = g_strdup(qemu_opt_get(opts, "tls-authz"));
  1270. addr = g_new0(SocketAddressLegacy, 1);
  1271. if (path) {
  1272. UnixSocketAddress *q_unix;
  1273. addr->type = SOCKET_ADDRESS_TYPE_UNIX;
  1274. q_unix = addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
  1275. q_unix->path = g_strdup(path);
  1276. #ifdef CONFIG_LINUX
  1277. q_unix->has_tight = true;
  1278. q_unix->tight = tight;
  1279. q_unix->has_abstract = true;
  1280. q_unix->abstract = abstract;
  1281. #endif
  1282. } else if (host) {
  1283. addr->type = SOCKET_ADDRESS_TYPE_INET;
  1284. addr->u.inet.data = g_new(InetSocketAddress, 1);
  1285. *addr->u.inet.data = (InetSocketAddress) {
  1286. .host = g_strdup(host),
  1287. .port = g_strdup(port),
  1288. .has_to = qemu_opt_get(opts, "to"),
  1289. .to = qemu_opt_get_number(opts, "to", 0),
  1290. .has_ipv4 = qemu_opt_get(opts, "ipv4"),
  1291. .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
  1292. .has_ipv6 = qemu_opt_get(opts, "ipv6"),
  1293. .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
  1294. };
  1295. } else {
  1296. addr->type = SOCKET_ADDRESS_TYPE_FD;
  1297. addr->u.fd.data = g_new(String, 1);
  1298. addr->u.fd.data->str = g_strdup(fd);
  1299. }
  1300. sock->addr = addr;
  1301. }
  1302. static void
  1303. char_socket_get_addr(Object *obj, Visitor *v, const char *name,
  1304. void *opaque, Error **errp)
  1305. {
  1306. SocketChardev *s = SOCKET_CHARDEV(obj);
  1307. visit_type_SocketAddress(v, name, &s->addr, errp);
  1308. }
  1309. static bool
  1310. char_socket_get_connected(Object *obj, Error **errp)
  1311. {
  1312. SocketChardev *s = SOCKET_CHARDEV(obj);
  1313. return s->state == TCP_CHARDEV_STATE_CONNECTED;
  1314. }
  1315. static void char_socket_class_init(ObjectClass *oc, void *data)
  1316. {
  1317. ChardevClass *cc = CHARDEV_CLASS(oc);
  1318. cc->supports_yank = true;
  1319. cc->parse = qemu_chr_parse_socket;
  1320. cc->open = qmp_chardev_open_socket;
  1321. cc->chr_wait_connected = tcp_chr_wait_connected;
  1322. cc->chr_write = tcp_chr_write;
  1323. cc->chr_sync_read = tcp_chr_sync_read;
  1324. cc->chr_disconnect = tcp_chr_disconnect;
  1325. cc->get_msgfds = tcp_get_msgfds;
  1326. cc->set_msgfds = tcp_set_msgfds;
  1327. cc->chr_add_client = tcp_chr_add_client;
  1328. cc->chr_add_watch = tcp_chr_add_watch;
  1329. cc->chr_update_read_handler = tcp_chr_update_read_handler;
  1330. object_class_property_add(oc, "addr", "SocketAddress",
  1331. char_socket_get_addr, NULL,
  1332. NULL, NULL);
  1333. object_class_property_add_bool(oc, "connected", char_socket_get_connected,
  1334. NULL);
  1335. }
  1336. static const TypeInfo char_socket_type_info = {
  1337. .name = TYPE_CHARDEV_SOCKET,
  1338. .parent = TYPE_CHARDEV,
  1339. .instance_size = sizeof(SocketChardev),
  1340. .instance_finalize = char_socket_finalize,
  1341. .class_init = char_socket_class_init,
  1342. };
  1343. static void register_types(void)
  1344. {
  1345. type_register_static(&char_socket_type_info);
  1346. }
  1347. type_init(register_types);