qemu-pr-helper.c 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077
  1. /*
  2. * Privileged helper to handle persistent reservation commands for QEMU
  3. *
  4. * Copyright (C) 2017 Red Hat, Inc. <pbonzini@redhat.com>
  5. *
  6. * Author: Paolo Bonzini <pbonzini@redhat.com>
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation; under version 2 of the License.
  11. *
  12. * This program is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. * GNU General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU General Public License
  18. * along with this program; if not, see <http://www.gnu.org/licenses/>.
  19. */
  20. #include "qemu/osdep.h"
  21. #include <getopt.h>
  22. #include <sys/ioctl.h>
  23. #include <linux/dm-ioctl.h>
  24. #include <scsi/sg.h>
  25. #ifdef CONFIG_LIBCAP_NG
  26. #include <cap-ng.h>
  27. #endif
  28. #include <pwd.h>
  29. #include <grp.h>
  30. #ifdef CONFIG_MPATH
  31. #include <libudev.h>
  32. #include <mpath_cmd.h>
  33. #include <mpath_persist.h>
  34. #endif
  35. #include "qemu/help-texts.h"
  36. #include "qapi/error.h"
  37. #include "qemu/cutils.h"
  38. #include "qemu/main-loop.h"
  39. #include "qemu/module.h"
  40. #include "qemu/error-report.h"
  41. #include "qemu/config-file.h"
  42. #include "qemu/bswap.h"
  43. #include "qemu/log.h"
  44. #include "qemu/systemd.h"
  45. #include "qapi/util.h"
  46. #include "qobject/qstring.h"
  47. #include "io/channel-socket.h"
  48. #include "trace/control.h"
  49. #include "qemu-version.h"
  50. #include "block/aio.h"
  51. #include "block/thread-pool.h"
  52. #include "scsi/constants.h"
  53. #include "scsi/utils.h"
  54. #include "pr-helper.h"
  55. #define PR_OUT_FIXED_PARAM_SIZE 24
  56. static char *socket_path;
  57. static char *pidfile;
  58. static enum { RUNNING, TERMINATE, TERMINATING } state;
  59. static QIOChannelSocket *server_ioc;
  60. static int server_watch;
  61. static int num_active_sockets = 1;
  62. static int noisy;
  63. static int verbose;
  64. #ifdef CONFIG_LIBCAP_NG
  65. static int uid = -1;
  66. static int gid = -1;
  67. #endif
  68. static void compute_default_paths(void)
  69. {
  70. g_autofree char *state = qemu_get_local_state_dir();
  71. socket_path = g_build_filename(state, "run", "qemu-pr-helper.sock", NULL);
  72. pidfile = g_build_filename(state, "run", "qemu-pr-helper.pid", NULL);
  73. }
  74. static void usage(const char *name)
  75. {
  76. (printf) (
  77. "Usage: %s [OPTIONS] FILE\n"
  78. "Persistent Reservation helper program for QEMU\n"
  79. "\n"
  80. " -h, --help display this help and exit\n"
  81. " -V, --version output version information and exit\n"
  82. "\n"
  83. " -d, --daemon run in the background\n"
  84. " -f, --pidfile=PATH PID file when running as a daemon\n"
  85. " (default '%s')\n"
  86. " -k, --socket=PATH path to the unix socket\n"
  87. " (default '%s')\n"
  88. " -T, --trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
  89. " specify tracing options\n"
  90. #ifdef CONFIG_LIBCAP_NG
  91. " -u, --user=USER user to drop privileges to\n"
  92. " -g, --group=GROUP group to drop privileges to\n"
  93. #endif
  94. "\n"
  95. QEMU_HELP_BOTTOM "\n"
  96. , name, pidfile, socket_path);
  97. }
  98. static void version(const char *name)
  99. {
  100. printf(
  101. "%s " QEMU_FULL_VERSION "\n"
  102. "Written by Paolo Bonzini.\n"
  103. "\n"
  104. QEMU_COPYRIGHT "\n"
  105. "This is free software; see the source for copying conditions. There is NO\n"
  106. "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"
  107. , name);
  108. }
  109. /* SG_IO support */
  110. typedef struct PRHelperSGIOData {
  111. int fd;
  112. const uint8_t *cdb;
  113. uint8_t *sense;
  114. uint8_t *buf;
  115. int sz; /* input/output */
  116. int dir;
  117. } PRHelperSGIOData;
  118. static int do_sgio_worker(void *opaque)
  119. {
  120. PRHelperSGIOData *data = opaque;
  121. struct sg_io_hdr io_hdr;
  122. int ret;
  123. int status;
  124. SCSISense sense_code;
  125. memset(data->sense, 0, PR_HELPER_SENSE_SIZE);
  126. memset(&io_hdr, 0, sizeof(io_hdr));
  127. io_hdr.interface_id = 'S';
  128. io_hdr.cmd_len = PR_HELPER_CDB_SIZE;
  129. io_hdr.cmdp = (uint8_t *)data->cdb;
  130. io_hdr.sbp = data->sense;
  131. io_hdr.mx_sb_len = PR_HELPER_SENSE_SIZE;
  132. io_hdr.timeout = 1;
  133. io_hdr.dxfer_direction = data->dir;
  134. io_hdr.dxferp = (char *)data->buf;
  135. io_hdr.dxfer_len = data->sz;
  136. ret = ioctl(data->fd, SG_IO, &io_hdr);
  137. if (ret < 0) {
  138. status = scsi_sense_from_errno(errno, &sense_code);
  139. if (status == CHECK_CONDITION) {
  140. scsi_build_sense(data->sense, sense_code);
  141. }
  142. } else if (io_hdr.host_status != SCSI_HOST_OK) {
  143. status = scsi_sense_from_host_status(io_hdr.host_status, &sense_code);
  144. if (status == CHECK_CONDITION) {
  145. scsi_build_sense(data->sense, sense_code);
  146. }
  147. } else if (io_hdr.driver_status & SG_ERR_DRIVER_TIMEOUT) {
  148. status = BUSY;
  149. } else {
  150. status = io_hdr.status;
  151. }
  152. if (status == GOOD) {
  153. data->sz -= io_hdr.resid;
  154. } else {
  155. data->sz = 0;
  156. }
  157. return status;
  158. }
  159. static int coroutine_fn do_sgio(int fd, const uint8_t *cdb, uint8_t *sense,
  160. uint8_t *buf, int *sz, int dir)
  161. {
  162. int r;
  163. PRHelperSGIOData data = {
  164. .fd = fd,
  165. .cdb = cdb,
  166. .sense = sense,
  167. .buf = buf,
  168. .sz = *sz,
  169. .dir = dir,
  170. };
  171. r = thread_pool_submit_co(do_sgio_worker, &data);
  172. *sz = data.sz;
  173. return r;
  174. }
  175. /* Device mapper interface */
  176. #ifdef CONFIG_MPATH
  177. #define CONTROL_PATH "/dev/mapper/control"
  178. typedef struct DMData {
  179. struct dm_ioctl dm;
  180. uint8_t data[1024];
  181. } DMData;
  182. static int control_fd;
  183. static void *dm_ioctl(int ioc, struct dm_ioctl *dm)
  184. {
  185. static DMData d;
  186. memcpy(&d.dm, dm, sizeof(d.dm));
  187. QEMU_BUILD_BUG_ON(sizeof(d.data) < sizeof(struct dm_target_spec));
  188. d.dm.version[0] = DM_VERSION_MAJOR;
  189. d.dm.version[1] = 0;
  190. d.dm.version[2] = 0;
  191. d.dm.data_size = 1024;
  192. d.dm.data_start = offsetof(DMData, data);
  193. if (ioctl(control_fd, ioc, &d) < 0) {
  194. return NULL;
  195. }
  196. memcpy(dm, &d.dm, sizeof(d.dm));
  197. return &d.data;
  198. }
  199. static void *dm_dev_ioctl(int fd, int ioc, struct dm_ioctl *dm)
  200. {
  201. struct stat st;
  202. int r;
  203. r = fstat(fd, &st);
  204. if (r < 0) {
  205. perror("fstat");
  206. exit(1);
  207. }
  208. dm->dev = st.st_rdev;
  209. return dm_ioctl(ioc, dm);
  210. }
  211. static void dm_init(void)
  212. {
  213. control_fd = open(CONTROL_PATH, O_RDWR);
  214. if (control_fd < 0) {
  215. perror("Cannot open " CONTROL_PATH);
  216. exit(1);
  217. }
  218. struct dm_ioctl dm = { };
  219. if (!dm_ioctl(DM_VERSION, &dm)) {
  220. perror("ioctl");
  221. exit(1);
  222. }
  223. if (dm.version[0] != DM_VERSION_MAJOR) {
  224. fprintf(stderr, "Unsupported device mapper interface");
  225. exit(1);
  226. }
  227. }
  228. /* Variables required by libmultipath and libmpathpersist. */
  229. QEMU_BUILD_BUG_ON(PR_HELPER_DATA_SIZE > MPATH_MAX_PARAM_LEN);
  230. static struct config *multipath_conf;
  231. unsigned mpath_mx_alloc_len = PR_HELPER_DATA_SIZE;
  232. int logsink;
  233. struct udev *udev;
  234. extern struct config *get_multipath_config(void);
  235. struct config *get_multipath_config(void)
  236. {
  237. return multipath_conf;
  238. }
  239. extern void put_multipath_config(struct config *conf);
  240. void put_multipath_config(struct config *conf)
  241. {
  242. }
  243. static void multipath_pr_init(void)
  244. {
  245. udev = udev_new();
  246. multipath_conf = mpath_lib_init();
  247. }
  248. static int is_mpath(int fd)
  249. {
  250. struct dm_ioctl dm = { .flags = DM_NOFLUSH_FLAG };
  251. struct dm_target_spec *tgt;
  252. tgt = dm_dev_ioctl(fd, DM_TABLE_STATUS, &dm);
  253. if (!tgt) {
  254. if (errno == ENXIO) {
  255. return 0;
  256. }
  257. perror("ioctl");
  258. exit(EXIT_FAILURE);
  259. }
  260. return !strncmp(tgt->target_type, "multipath", DM_MAX_TYPE_NAME);
  261. }
  262. static SCSISense mpath_generic_sense(int r)
  263. {
  264. switch (r) {
  265. case MPATH_PR_SENSE_NOT_READY:
  266. return SENSE_CODE(NOT_READY);
  267. case MPATH_PR_SENSE_MEDIUM_ERROR:
  268. return SENSE_CODE(READ_ERROR);
  269. case MPATH_PR_SENSE_HARDWARE_ERROR:
  270. return SENSE_CODE(TARGET_FAILURE);
  271. case MPATH_PR_SENSE_ABORTED_COMMAND:
  272. return SENSE_CODE(IO_ERROR);
  273. default:
  274. abort();
  275. }
  276. }
  277. static int coroutine_fn mpath_reconstruct_sense(int fd, int r, uint8_t *sense)
  278. {
  279. switch (r) {
  280. case MPATH_PR_SUCCESS:
  281. return GOOD;
  282. case MPATH_PR_SENSE_NOT_READY:
  283. case MPATH_PR_SENSE_MEDIUM_ERROR:
  284. case MPATH_PR_SENSE_HARDWARE_ERROR:
  285. case MPATH_PR_SENSE_ABORTED_COMMAND:
  286. {
  287. /* libmpathpersist ate the exact sense. Try to find it by
  288. * issuing TEST UNIT READY.
  289. */
  290. uint8_t cdb[6] = { TEST_UNIT_READY };
  291. int sz = 0;
  292. int ret = do_sgio(fd, cdb, sense, NULL, &sz, SG_DXFER_NONE);
  293. if (ret != GOOD) {
  294. return ret;
  295. }
  296. scsi_build_sense(sense, mpath_generic_sense(r));
  297. return CHECK_CONDITION;
  298. }
  299. case MPATH_PR_SENSE_UNIT_ATTENTION:
  300. /* Congratulations libmpathpersist, you ruined the Unit Attention...
  301. * Return a heavyweight one.
  302. */
  303. scsi_build_sense(sense, SENSE_CODE(SCSI_BUS_RESET));
  304. return CHECK_CONDITION;
  305. case MPATH_PR_SENSE_INVALID_OP:
  306. /* Only one valid sense. */
  307. scsi_build_sense(sense, SENSE_CODE(INVALID_OPCODE));
  308. return CHECK_CONDITION;
  309. case MPATH_PR_ILLEGAL_REQ:
  310. /* Guess. */
  311. scsi_build_sense(sense, SENSE_CODE(INVALID_PARAM));
  312. return CHECK_CONDITION;
  313. case MPATH_PR_NO_SENSE:
  314. scsi_build_sense(sense, SENSE_CODE(NO_SENSE));
  315. return CHECK_CONDITION;
  316. case MPATH_PR_RESERV_CONFLICT:
  317. return RESERVATION_CONFLICT;
  318. case MPATH_PR_OTHER:
  319. default:
  320. scsi_build_sense(sense, SENSE_CODE(LUN_COMM_FAILURE));
  321. return CHECK_CONDITION;
  322. }
  323. }
  324. static int coroutine_fn multipath_pr_in(int fd, const uint8_t *cdb, uint8_t *sense,
  325. uint8_t *data, int sz)
  326. {
  327. int rq_servact = cdb[1];
  328. struct prin_resp resp;
  329. size_t written;
  330. int r;
  331. switch (rq_servact) {
  332. case MPATH_PRIN_RKEY_SA:
  333. case MPATH_PRIN_RRES_SA:
  334. case MPATH_PRIN_RCAP_SA:
  335. break;
  336. case MPATH_PRIN_RFSTAT_SA:
  337. /* Nobody implements it anyway, so bail out. */
  338. default:
  339. /* Cannot parse any other output. */
  340. scsi_build_sense(sense, SENSE_CODE(INVALID_FIELD));
  341. return CHECK_CONDITION;
  342. }
  343. r = mpath_persistent_reserve_in(fd, rq_servact, &resp, noisy, verbose);
  344. if (r == MPATH_PR_SUCCESS) {
  345. switch (rq_servact) {
  346. case MPATH_PRIN_RKEY_SA:
  347. case MPATH_PRIN_RRES_SA: {
  348. struct prin_readdescr *out = &resp.prin_descriptor.prin_readkeys;
  349. assert(sz >= 8);
  350. written = MIN(out->additional_length + 8, sz);
  351. stl_be_p(&data[0], out->prgeneration);
  352. stl_be_p(&data[4], out->additional_length);
  353. memcpy(&data[8], out->key_list, written - 8);
  354. break;
  355. }
  356. case MPATH_PRIN_RCAP_SA: {
  357. struct prin_capdescr *out = &resp.prin_descriptor.prin_readcap;
  358. assert(sz >= 6);
  359. written = 6;
  360. stw_be_p(&data[0], out->length);
  361. data[2] = out->flags[0];
  362. data[3] = out->flags[1];
  363. stw_be_p(&data[4], out->pr_type_mask);
  364. break;
  365. }
  366. default:
  367. scsi_build_sense(sense, SENSE_CODE(INVALID_OPCODE));
  368. return CHECK_CONDITION;
  369. }
  370. assert(written <= sz);
  371. memset(data + written, 0, sz - written);
  372. }
  373. return mpath_reconstruct_sense(fd, r, sense);
  374. }
  375. static int coroutine_fn multipath_pr_out(int fd, const uint8_t *cdb, uint8_t *sense,
  376. const uint8_t *param, int sz)
  377. {
  378. int rq_servact = cdb[1];
  379. int rq_scope = cdb[2] >> 4;
  380. int rq_type = cdb[2] & 0xf;
  381. g_autofree struct prout_param_descriptor *paramp = NULL;
  382. char transportids[PR_HELPER_DATA_SIZE];
  383. int r;
  384. paramp = g_malloc0(sizeof(struct prout_param_descriptor)
  385. + sizeof(struct transportid *) * MPATH_MX_TIDS);
  386. if (sz < PR_OUT_FIXED_PARAM_SIZE) {
  387. /* Illegal request, Parameter list length error. This isn't fatal;
  388. * we have read the data, send an error without closing the socket.
  389. */
  390. scsi_build_sense(sense, SENSE_CODE(INVALID_PARAM_LEN));
  391. return CHECK_CONDITION;
  392. }
  393. switch (rq_servact) {
  394. case MPATH_PROUT_REG_SA:
  395. case MPATH_PROUT_RES_SA:
  396. case MPATH_PROUT_REL_SA:
  397. case MPATH_PROUT_CLEAR_SA:
  398. case MPATH_PROUT_PREE_SA:
  399. case MPATH_PROUT_PREE_AB_SA:
  400. case MPATH_PROUT_REG_IGN_SA:
  401. break;
  402. case MPATH_PROUT_REG_MOV_SA:
  403. /* Not supported by struct prout_param_descriptor. */
  404. default:
  405. /* Cannot parse any other input. */
  406. scsi_build_sense(sense, SENSE_CODE(INVALID_FIELD));
  407. return CHECK_CONDITION;
  408. }
  409. /* Convert input data, especially transport IDs, to the structs
  410. * used by libmpathpersist (which, of course, will immediately
  411. * do the opposite).
  412. */
  413. memcpy(&paramp->key, &param[0], 8);
  414. memcpy(&paramp->sa_key, &param[8], 8);
  415. paramp->sa_flags = param[20];
  416. if (sz > PR_OUT_FIXED_PARAM_SIZE) {
  417. size_t transportid_len;
  418. int i, j;
  419. if (sz < PR_OUT_FIXED_PARAM_SIZE + 4) {
  420. scsi_build_sense(sense, SENSE_CODE(INVALID_PARAM_LEN));
  421. return CHECK_CONDITION;
  422. }
  423. transportid_len = ldl_be_p(&param[24]) + PR_OUT_FIXED_PARAM_SIZE + 4;
  424. if (transportid_len > sz) {
  425. scsi_build_sense(sense, SENSE_CODE(INVALID_PARAM));
  426. return CHECK_CONDITION;
  427. }
  428. for (i = PR_OUT_FIXED_PARAM_SIZE + 4, j = 0; i < transportid_len; ) {
  429. struct transportid *id = (struct transportid *) &transportids[j];
  430. int len;
  431. id->format_code = param[i] & 0xc0;
  432. id->protocol_id = param[i] & 0x0f;
  433. switch (param[i] & 0xcf) {
  434. case 0:
  435. /* FC transport. */
  436. if (i + 24 > transportid_len) {
  437. goto illegal_req;
  438. }
  439. memcpy(id->n_port_name, &param[i + 8], 8);
  440. j += offsetof(struct transportid, n_port_name[8]);
  441. i += 24;
  442. break;
  443. case 5:
  444. case 0x45:
  445. /* iSCSI transport. */
  446. len = lduw_be_p(&param[i + 2]);
  447. if (len > 252 || (len & 3) || i + len + 4 > transportid_len) {
  448. /* For format code 00, the standard says the maximum is 223
  449. * plus the NUL terminator. For format code 01 there is no
  450. * maximum length, but libmpathpersist ignores the first
  451. * byte of id->iscsi_name so our maximum is 252.
  452. */
  453. goto illegal_req;
  454. }
  455. if (memchr(&param[i + 4], 0, len) == NULL) {
  456. goto illegal_req;
  457. }
  458. memcpy(id->iscsi_name, &param[i + 2], len + 2);
  459. j += offsetof(struct transportid, iscsi_name[len + 2]);
  460. i += len + 4;
  461. break;
  462. case 6:
  463. /* SAS transport. */
  464. if (i + 24 > transportid_len) {
  465. goto illegal_req;
  466. }
  467. memcpy(id->sas_address, &param[i + 4], 8);
  468. j += offsetof(struct transportid, sas_address[8]);
  469. i += 24;
  470. break;
  471. default:
  472. illegal_req:
  473. scsi_build_sense(sense, SENSE_CODE(INVALID_PARAM));
  474. return CHECK_CONDITION;
  475. }
  476. assert(paramp->num_transportid < MPATH_MX_TIDS);
  477. paramp->trnptid_list[paramp->num_transportid++] = id;
  478. }
  479. }
  480. r = mpath_persistent_reserve_out(fd, rq_servact, rq_scope, rq_type,
  481. paramp, noisy, verbose);
  482. return mpath_reconstruct_sense(fd, r, sense);
  483. }
  484. #endif
  485. static int coroutine_fn do_pr_in(int fd, const uint8_t *cdb, uint8_t *sense,
  486. uint8_t *data, int *resp_sz)
  487. {
  488. #ifdef CONFIG_MPATH
  489. if (is_mpath(fd)) {
  490. /* multipath_pr_in fills the whole input buffer. */
  491. int r = multipath_pr_in(fd, cdb, sense, data, *resp_sz);
  492. if (r != GOOD) {
  493. *resp_sz = 0;
  494. }
  495. return r;
  496. }
  497. #endif
  498. return do_sgio(fd, cdb, sense, data, resp_sz,
  499. SG_DXFER_FROM_DEV);
  500. }
  501. static int coroutine_fn do_pr_out(int fd, const uint8_t *cdb, uint8_t *sense,
  502. const uint8_t *param, int sz)
  503. {
  504. int resp_sz;
  505. if ((fcntl(fd, F_GETFL) & O_ACCMODE) == O_RDONLY) {
  506. scsi_build_sense(sense, SENSE_CODE(INVALID_OPCODE));
  507. return CHECK_CONDITION;
  508. }
  509. #ifdef CONFIG_MPATH
  510. if (is_mpath(fd)) {
  511. return multipath_pr_out(fd, cdb, sense, param, sz);
  512. }
  513. #endif
  514. resp_sz = sz;
  515. return do_sgio(fd, cdb, sense, (uint8_t *)param, &resp_sz,
  516. SG_DXFER_TO_DEV);
  517. }
  518. /* Client */
  519. typedef struct PRHelperClient {
  520. QIOChannelSocket *ioc;
  521. Coroutine *co;
  522. int fd;
  523. uint8_t data[PR_HELPER_DATA_SIZE];
  524. } PRHelperClient;
  525. typedef struct PRHelperRequest {
  526. int fd;
  527. size_t sz;
  528. uint8_t cdb[PR_HELPER_CDB_SIZE];
  529. } PRHelperRequest;
  530. static int coroutine_fn prh_read(PRHelperClient *client, void *buf, int sz,
  531. Error **errp)
  532. {
  533. int ret = 0;
  534. while (sz > 0) {
  535. int *fds = NULL;
  536. size_t nfds = 0;
  537. int i;
  538. struct iovec iov;
  539. ssize_t n_read;
  540. iov.iov_base = buf;
  541. iov.iov_len = sz;
  542. n_read = qio_channel_readv_full(QIO_CHANNEL(client->ioc), &iov, 1,
  543. &fds, &nfds, 0, errp);
  544. if (n_read == QIO_CHANNEL_ERR_BLOCK) {
  545. qio_channel_yield(QIO_CHANNEL(client->ioc), G_IO_IN);
  546. continue;
  547. }
  548. if (n_read <= 0) {
  549. ret = n_read ? n_read : -1;
  550. goto err;
  551. }
  552. /* Stash one file descriptor per request. */
  553. if (nfds) {
  554. bool too_many = false;
  555. for (i = 0; i < nfds; i++) {
  556. if (client->fd == -1) {
  557. client->fd = fds[i];
  558. } else {
  559. close(fds[i]);
  560. too_many = true;
  561. }
  562. }
  563. g_free(fds);
  564. if (too_many) {
  565. ret = -1;
  566. goto err;
  567. }
  568. }
  569. buf += n_read;
  570. sz -= n_read;
  571. }
  572. return 0;
  573. err:
  574. if (client->fd != -1) {
  575. close(client->fd);
  576. client->fd = -1;
  577. }
  578. return ret;
  579. }
  580. static int coroutine_fn prh_read_request(PRHelperClient *client,
  581. PRHelperRequest *req,
  582. PRHelperResponse *resp, Error **errp)
  583. {
  584. uint32_t sz;
  585. if (prh_read(client, req->cdb, sizeof(req->cdb), NULL) < 0) {
  586. return -1;
  587. }
  588. if (client->fd == -1) {
  589. error_setg(errp, "No file descriptor in request.");
  590. return -1;
  591. }
  592. if (req->cdb[0] != PERSISTENT_RESERVE_OUT &&
  593. req->cdb[0] != PERSISTENT_RESERVE_IN) {
  594. error_setg(errp, "Invalid CDB, closing socket.");
  595. goto out_close;
  596. }
  597. sz = scsi_cdb_xfer(req->cdb);
  598. if (sz > sizeof(client->data)) {
  599. goto out_close;
  600. }
  601. if (req->cdb[0] == PERSISTENT_RESERVE_OUT) {
  602. if (qio_channel_read_all(QIO_CHANNEL(client->ioc),
  603. (char *)client->data, sz,
  604. errp) < 0) {
  605. goto out_close;
  606. }
  607. }
  608. req->fd = client->fd;
  609. req->sz = sz;
  610. client->fd = -1;
  611. return sz;
  612. out_close:
  613. close(client->fd);
  614. client->fd = -1;
  615. return -1;
  616. }
  617. static int coroutine_fn prh_write_response(PRHelperClient *client,
  618. PRHelperRequest *req,
  619. PRHelperResponse *resp, Error **errp)
  620. {
  621. ssize_t r;
  622. size_t sz;
  623. if (req->cdb[0] == PERSISTENT_RESERVE_IN && resp->result == GOOD) {
  624. assert(resp->sz <= req->sz && resp->sz <= sizeof(client->data));
  625. } else {
  626. assert(resp->sz == 0);
  627. }
  628. sz = resp->sz;
  629. resp->result = cpu_to_be32(resp->result);
  630. resp->sz = cpu_to_be32(resp->sz);
  631. r = qio_channel_write_all(QIO_CHANNEL(client->ioc),
  632. (char *) resp, sizeof(*resp), errp);
  633. if (r < 0) {
  634. return r;
  635. }
  636. r = qio_channel_write_all(QIO_CHANNEL(client->ioc),
  637. (char *) client->data,
  638. sz, errp);
  639. return r < 0 ? r : 0;
  640. }
  641. static void coroutine_fn prh_co_entry(void *opaque)
  642. {
  643. PRHelperClient *client = opaque;
  644. Error *local_err = NULL;
  645. uint32_t flags;
  646. int r;
  647. qio_channel_set_blocking(QIO_CHANNEL(client->ioc),
  648. false, NULL);
  649. qio_channel_set_follow_coroutine_ctx(QIO_CHANNEL(client->ioc), true);
  650. /* A very simple negotiation for future extensibility. No features
  651. * are defined so write 0.
  652. */
  653. flags = cpu_to_be32(0);
  654. r = qio_channel_write_all(QIO_CHANNEL(client->ioc),
  655. (char *) &flags, sizeof(flags), NULL);
  656. if (r < 0) {
  657. goto out;
  658. }
  659. r = qio_channel_read_all(QIO_CHANNEL(client->ioc),
  660. (char *) &flags, sizeof(flags), NULL);
  661. if (be32_to_cpu(flags) != 0 || r < 0) {
  662. goto out;
  663. }
  664. while (qatomic_read(&state) == RUNNING) {
  665. PRHelperRequest req;
  666. PRHelperResponse resp;
  667. int sz;
  668. sz = prh_read_request(client, &req, &resp, &local_err);
  669. if (sz < 0) {
  670. break;
  671. }
  672. num_active_sockets++;
  673. if (req.cdb[0] == PERSISTENT_RESERVE_OUT) {
  674. r = do_pr_out(req.fd, req.cdb, resp.sense,
  675. client->data, sz);
  676. resp.sz = 0;
  677. } else {
  678. resp.sz = sizeof(client->data);
  679. r = do_pr_in(req.fd, req.cdb, resp.sense,
  680. client->data, &resp.sz);
  681. resp.sz = MIN(resp.sz, sz);
  682. }
  683. num_active_sockets--;
  684. close(req.fd);
  685. if (r == -1) {
  686. break;
  687. }
  688. resp.result = r;
  689. if (prh_write_response(client, &req, &resp, &local_err) < 0) {
  690. break;
  691. }
  692. }
  693. if (local_err) {
  694. if (verbose == 0) {
  695. error_free(local_err);
  696. } else {
  697. error_report_err(local_err);
  698. }
  699. }
  700. out:
  701. object_unref(OBJECT(client->ioc));
  702. g_free(client);
  703. }
  704. static gboolean accept_client(QIOChannel *ioc, GIOCondition cond, gpointer opaque)
  705. {
  706. QIOChannelSocket *cioc;
  707. PRHelperClient *prh;
  708. cioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(ioc),
  709. NULL);
  710. if (!cioc) {
  711. return TRUE;
  712. }
  713. prh = g_new(PRHelperClient, 1);
  714. prh->ioc = cioc;
  715. prh->fd = -1;
  716. prh->co = qemu_coroutine_create(prh_co_entry, prh);
  717. qemu_coroutine_enter(prh->co);
  718. return TRUE;
  719. }
  720. static void termsig_handler(int signum)
  721. {
  722. qatomic_cmpxchg(&state, RUNNING, TERMINATE);
  723. qemu_notify_event();
  724. }
  725. static void close_server_socket(void)
  726. {
  727. assert(server_ioc);
  728. g_source_remove(server_watch);
  729. server_watch = -1;
  730. object_unref(OBJECT(server_ioc));
  731. num_active_sockets--;
  732. }
  733. #ifdef CONFIG_LIBCAP_NG
  734. static int drop_privileges(void)
  735. {
  736. /* clear all capabilities */
  737. capng_clear(CAPNG_SELECT_BOTH);
  738. if (capng_update(CAPNG_ADD, CAPNG_EFFECTIVE | CAPNG_PERMITTED,
  739. CAP_SYS_RAWIO) < 0) {
  740. return -1;
  741. }
  742. #ifdef CONFIG_MPATH
  743. /* For /dev/mapper/control ioctls */
  744. if (capng_update(CAPNG_ADD, CAPNG_EFFECTIVE | CAPNG_PERMITTED,
  745. CAP_SYS_ADMIN) < 0) {
  746. return -1;
  747. }
  748. #endif
  749. /* Change user/group id, retaining the capabilities. Because file descriptors
  750. * are passed via SCM_RIGHTS, we don't need supplementary groups (and in
  751. * fact the helper can run as "nobody").
  752. */
  753. if (capng_change_id(uid != -1 ? uid : getuid(),
  754. gid != -1 ? gid : getgid(),
  755. CAPNG_DROP_SUPP_GRP | CAPNG_CLEAR_BOUNDING)) {
  756. return -1;
  757. }
  758. return 0;
  759. }
  760. #endif
  761. int main(int argc, char **argv)
  762. {
  763. const char *sopt = "hVk:f:dT:u:g:vq";
  764. struct option lopt[] = {
  765. { "help", no_argument, NULL, 'h' },
  766. { "version", no_argument, NULL, 'V' },
  767. { "socket", required_argument, NULL, 'k' },
  768. { "pidfile", required_argument, NULL, 'f' },
  769. { "daemon", no_argument, NULL, 'd' },
  770. { "trace", required_argument, NULL, 'T' },
  771. { "user", required_argument, NULL, 'u' },
  772. { "group", required_argument, NULL, 'g' },
  773. { "verbose", no_argument, NULL, 'v' },
  774. { "quiet", no_argument, NULL, 'q' },
  775. { NULL, 0, NULL, 0 }
  776. };
  777. int opt_ind = 0;
  778. int loglevel = 1;
  779. int quiet = 0;
  780. int ch;
  781. Error *local_err = NULL;
  782. bool daemonize = false;
  783. bool pidfile_specified = false;
  784. bool socket_path_specified = false;
  785. unsigned socket_activation;
  786. struct sigaction sa_sigterm;
  787. memset(&sa_sigterm, 0, sizeof(sa_sigterm));
  788. sa_sigterm.sa_handler = termsig_handler;
  789. sigaction(SIGTERM, &sa_sigterm, NULL);
  790. sigaction(SIGINT, &sa_sigterm, NULL);
  791. sigaction(SIGHUP, &sa_sigterm, NULL);
  792. signal(SIGPIPE, SIG_IGN);
  793. error_init(argv[0]);
  794. module_call_init(MODULE_INIT_TRACE);
  795. module_call_init(MODULE_INIT_QOM);
  796. qemu_add_opts(&qemu_trace_opts);
  797. qemu_init_exec_dir(argv[0]);
  798. compute_default_paths();
  799. while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) {
  800. switch (ch) {
  801. case 'k':
  802. g_free(socket_path);
  803. socket_path = g_strdup(optarg);
  804. socket_path_specified = true;
  805. if (socket_path[0] != '/') {
  806. error_report("socket path must be absolute");
  807. exit(EXIT_FAILURE);
  808. }
  809. break;
  810. case 'f':
  811. g_free(pidfile);
  812. pidfile = g_strdup(optarg);
  813. pidfile_specified = true;
  814. break;
  815. #ifdef CONFIG_LIBCAP_NG
  816. case 'u': {
  817. unsigned long res;
  818. struct passwd *userinfo = getpwnam(optarg);
  819. if (userinfo) {
  820. uid = userinfo->pw_uid;
  821. } else if (qemu_strtoul(optarg, NULL, 10, &res) == 0 &&
  822. (uid_t)res == res) {
  823. uid = res;
  824. } else {
  825. error_report("invalid user '%s'", optarg);
  826. exit(EXIT_FAILURE);
  827. }
  828. break;
  829. }
  830. case 'g': {
  831. unsigned long res;
  832. struct group *groupinfo = getgrnam(optarg);
  833. if (groupinfo) {
  834. gid = groupinfo->gr_gid;
  835. } else if (qemu_strtoul(optarg, NULL, 10, &res) == 0 &&
  836. (gid_t)res == res) {
  837. gid = res;
  838. } else {
  839. error_report("invalid group '%s'", optarg);
  840. exit(EXIT_FAILURE);
  841. }
  842. break;
  843. }
  844. #else
  845. case 'u':
  846. case 'g':
  847. error_report("-%c not supported by this %s", ch, argv[0]);
  848. exit(1);
  849. #endif
  850. case 'd':
  851. daemonize = true;
  852. break;
  853. case 'q':
  854. quiet = 1;
  855. break;
  856. case 'v':
  857. ++loglevel;
  858. break;
  859. case 'T':
  860. trace_opt_parse(optarg);
  861. break;
  862. case 'V':
  863. version(argv[0]);
  864. exit(EXIT_SUCCESS);
  865. break;
  866. case 'h':
  867. usage(argv[0]);
  868. exit(EXIT_SUCCESS);
  869. break;
  870. case '?':
  871. error_report("Try `%s --help' for more information.", argv[0]);
  872. exit(EXIT_FAILURE);
  873. }
  874. }
  875. /* set verbosity */
  876. noisy = !quiet && (loglevel >= 3);
  877. verbose = quiet ? 0 : MIN(loglevel, 3);
  878. if (!trace_init_backends()) {
  879. exit(EXIT_FAILURE);
  880. }
  881. trace_init_file();
  882. qemu_set_log(LOG_TRACE, &error_fatal);
  883. #ifdef CONFIG_MPATH
  884. dm_init();
  885. multipath_pr_init();
  886. #endif
  887. socket_activation = check_socket_activation();
  888. if (socket_activation == 0) {
  889. SocketAddress saddr;
  890. saddr = (SocketAddress){
  891. .type = SOCKET_ADDRESS_TYPE_UNIX,
  892. .u.q_unix.path = socket_path,
  893. };
  894. server_ioc = qio_channel_socket_new();
  895. if (qio_channel_socket_listen_sync(server_ioc, &saddr,
  896. 1, &local_err) < 0) {
  897. object_unref(OBJECT(server_ioc));
  898. error_report_err(local_err);
  899. return 1;
  900. }
  901. } else {
  902. /* Using socket activation - check user didn't use -p etc. */
  903. if (socket_path_specified) {
  904. error_report("Unix socket can't be set when using socket activation");
  905. exit(EXIT_FAILURE);
  906. }
  907. /* Can only listen on a single socket. */
  908. if (socket_activation > 1) {
  909. error_report("%s does not support socket activation with LISTEN_FDS > 1",
  910. argv[0]);
  911. exit(EXIT_FAILURE);
  912. }
  913. server_ioc = qio_channel_socket_new_fd(FIRST_SOCKET_ACTIVATION_FD,
  914. &local_err);
  915. if (server_ioc == NULL) {
  916. error_reportf_err(local_err,
  917. "Failed to use socket activation: ");
  918. exit(EXIT_FAILURE);
  919. }
  920. }
  921. qemu_init_main_loop(&error_fatal);
  922. server_watch = qio_channel_add_watch(QIO_CHANNEL(server_ioc),
  923. G_IO_IN,
  924. accept_client,
  925. NULL, NULL);
  926. if (daemonize) {
  927. if (daemon(0, 0) < 0) {
  928. error_report("Failed to daemonize: %s", strerror(errno));
  929. exit(EXIT_FAILURE);
  930. }
  931. }
  932. if (daemonize || pidfile_specified) {
  933. qemu_write_pidfile(pidfile, &error_fatal);
  934. }
  935. #ifdef CONFIG_LIBCAP_NG
  936. if (drop_privileges() < 0) {
  937. error_report("Failed to drop privileges: %s", strerror(errno));
  938. exit(EXIT_FAILURE);
  939. }
  940. #endif
  941. state = RUNNING;
  942. do {
  943. main_loop_wait(false);
  944. if (state == TERMINATE) {
  945. state = TERMINATING;
  946. close_server_socket();
  947. }
  948. } while (num_active_sockets > 0);
  949. exit(EXIT_SUCCESS);
  950. }