qemu-pr-helper.c 30 KB

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