cls_lock_client.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431
  1. // SPDX-License-Identifier: GPL-2.0
  2. #include <linux/ceph/ceph_debug.h>
  3. #include <linux/types.h>
  4. #include <linux/slab.h>
  5. #include <linux/ceph/cls_lock_client.h>
  6. #include <linux/ceph/decode.h>
  7. #include <linux/ceph/libceph.h>
  8. /**
  9. * ceph_cls_lock - grab rados lock for object
  10. * @osdc: OSD client instance
  11. * @oid: object to lock
  12. * @oloc: object to lock
  13. * @lock_name: the name of the lock
  14. * @type: lock type (CEPH_CLS_LOCK_EXCLUSIVE or CEPH_CLS_LOCK_SHARED)
  15. * @cookie: user-defined identifier for this instance of the lock
  16. * @tag: user-defined tag
  17. * @desc: user-defined lock description
  18. * @flags: lock flags
  19. *
  20. * All operations on the same lock should use the same tag.
  21. */
  22. int ceph_cls_lock(struct ceph_osd_client *osdc,
  23. struct ceph_object_id *oid,
  24. struct ceph_object_locator *oloc,
  25. char *lock_name, u8 type, char *cookie,
  26. char *tag, char *desc, u8 flags)
  27. {
  28. int lock_op_buf_size;
  29. int name_len = strlen(lock_name);
  30. int cookie_len = strlen(cookie);
  31. int tag_len = strlen(tag);
  32. int desc_len = strlen(desc);
  33. void *p, *end;
  34. struct page *lock_op_page;
  35. struct timespec64 mtime;
  36. int ret;
  37. lock_op_buf_size = name_len + sizeof(__le32) +
  38. cookie_len + sizeof(__le32) +
  39. tag_len + sizeof(__le32) +
  40. desc_len + sizeof(__le32) +
  41. sizeof(struct ceph_timespec) +
  42. /* flag and type */
  43. sizeof(u8) + sizeof(u8) +
  44. CEPH_ENCODING_START_BLK_LEN;
  45. if (lock_op_buf_size > PAGE_SIZE)
  46. return -E2BIG;
  47. lock_op_page = alloc_page(GFP_NOIO);
  48. if (!lock_op_page)
  49. return -ENOMEM;
  50. p = page_address(lock_op_page);
  51. end = p + lock_op_buf_size;
  52. /* encode cls_lock_lock_op struct */
  53. ceph_start_encoding(&p, 1, 1,
  54. lock_op_buf_size - CEPH_ENCODING_START_BLK_LEN);
  55. ceph_encode_string(&p, end, lock_name, name_len);
  56. ceph_encode_8(&p, type);
  57. ceph_encode_string(&p, end, cookie, cookie_len);
  58. ceph_encode_string(&p, end, tag, tag_len);
  59. ceph_encode_string(&p, end, desc, desc_len);
  60. /* only support infinite duration */
  61. memset(&mtime, 0, sizeof(mtime));
  62. ceph_encode_timespec64(p, &mtime);
  63. p += sizeof(struct ceph_timespec);
  64. ceph_encode_8(&p, flags);
  65. dout("%s lock_name %s type %d cookie %s tag %s desc %s flags 0x%x\n",
  66. __func__, lock_name, type, cookie, tag, desc, flags);
  67. ret = ceph_osdc_call(osdc, oid, oloc, "lock", "lock",
  68. CEPH_OSD_FLAG_WRITE, lock_op_page,
  69. lock_op_buf_size, NULL, NULL);
  70. dout("%s: status %d\n", __func__, ret);
  71. __free_page(lock_op_page);
  72. return ret;
  73. }
  74. EXPORT_SYMBOL(ceph_cls_lock);
  75. /**
  76. * ceph_cls_unlock - release rados lock for object
  77. * @osdc: OSD client instance
  78. * @oid: object to lock
  79. * @oloc: object to lock
  80. * @lock_name: the name of the lock
  81. * @cookie: user-defined identifier for this instance of the lock
  82. */
  83. int ceph_cls_unlock(struct ceph_osd_client *osdc,
  84. struct ceph_object_id *oid,
  85. struct ceph_object_locator *oloc,
  86. char *lock_name, char *cookie)
  87. {
  88. int unlock_op_buf_size;
  89. int name_len = strlen(lock_name);
  90. int cookie_len = strlen(cookie);
  91. void *p, *end;
  92. struct page *unlock_op_page;
  93. int ret;
  94. unlock_op_buf_size = name_len + sizeof(__le32) +
  95. cookie_len + sizeof(__le32) +
  96. CEPH_ENCODING_START_BLK_LEN;
  97. if (unlock_op_buf_size > PAGE_SIZE)
  98. return -E2BIG;
  99. unlock_op_page = alloc_page(GFP_NOIO);
  100. if (!unlock_op_page)
  101. return -ENOMEM;
  102. p = page_address(unlock_op_page);
  103. end = p + unlock_op_buf_size;
  104. /* encode cls_lock_unlock_op struct */
  105. ceph_start_encoding(&p, 1, 1,
  106. unlock_op_buf_size - CEPH_ENCODING_START_BLK_LEN);
  107. ceph_encode_string(&p, end, lock_name, name_len);
  108. ceph_encode_string(&p, end, cookie, cookie_len);
  109. dout("%s lock_name %s cookie %s\n", __func__, lock_name, cookie);
  110. ret = ceph_osdc_call(osdc, oid, oloc, "lock", "unlock",
  111. CEPH_OSD_FLAG_WRITE, unlock_op_page,
  112. unlock_op_buf_size, NULL, NULL);
  113. dout("%s: status %d\n", __func__, ret);
  114. __free_page(unlock_op_page);
  115. return ret;
  116. }
  117. EXPORT_SYMBOL(ceph_cls_unlock);
  118. /**
  119. * ceph_cls_break_lock - release rados lock for object for specified client
  120. * @osdc: OSD client instance
  121. * @oid: object to lock
  122. * @oloc: object to lock
  123. * @lock_name: the name of the lock
  124. * @cookie: user-defined identifier for this instance of the lock
  125. * @locker: current lock owner
  126. */
  127. int ceph_cls_break_lock(struct ceph_osd_client *osdc,
  128. struct ceph_object_id *oid,
  129. struct ceph_object_locator *oloc,
  130. char *lock_name, char *cookie,
  131. struct ceph_entity_name *locker)
  132. {
  133. int break_op_buf_size;
  134. int name_len = strlen(lock_name);
  135. int cookie_len = strlen(cookie);
  136. struct page *break_op_page;
  137. void *p, *end;
  138. int ret;
  139. break_op_buf_size = name_len + sizeof(__le32) +
  140. cookie_len + sizeof(__le32) +
  141. sizeof(u8) + sizeof(__le64) +
  142. CEPH_ENCODING_START_BLK_LEN;
  143. if (break_op_buf_size > PAGE_SIZE)
  144. return -E2BIG;
  145. break_op_page = alloc_page(GFP_NOIO);
  146. if (!break_op_page)
  147. return -ENOMEM;
  148. p = page_address(break_op_page);
  149. end = p + break_op_buf_size;
  150. /* encode cls_lock_break_op struct */
  151. ceph_start_encoding(&p, 1, 1,
  152. break_op_buf_size - CEPH_ENCODING_START_BLK_LEN);
  153. ceph_encode_string(&p, end, lock_name, name_len);
  154. ceph_encode_copy(&p, locker, sizeof(*locker));
  155. ceph_encode_string(&p, end, cookie, cookie_len);
  156. dout("%s lock_name %s cookie %s locker %s%llu\n", __func__, lock_name,
  157. cookie, ENTITY_NAME(*locker));
  158. ret = ceph_osdc_call(osdc, oid, oloc, "lock", "break_lock",
  159. CEPH_OSD_FLAG_WRITE, break_op_page,
  160. break_op_buf_size, NULL, NULL);
  161. dout("%s: status %d\n", __func__, ret);
  162. __free_page(break_op_page);
  163. return ret;
  164. }
  165. EXPORT_SYMBOL(ceph_cls_break_lock);
  166. int ceph_cls_set_cookie(struct ceph_osd_client *osdc,
  167. struct ceph_object_id *oid,
  168. struct ceph_object_locator *oloc,
  169. char *lock_name, u8 type, char *old_cookie,
  170. char *tag, char *new_cookie)
  171. {
  172. int cookie_op_buf_size;
  173. int name_len = strlen(lock_name);
  174. int old_cookie_len = strlen(old_cookie);
  175. int tag_len = strlen(tag);
  176. int new_cookie_len = strlen(new_cookie);
  177. void *p, *end;
  178. struct page *cookie_op_page;
  179. int ret;
  180. cookie_op_buf_size = name_len + sizeof(__le32) +
  181. old_cookie_len + sizeof(__le32) +
  182. tag_len + sizeof(__le32) +
  183. new_cookie_len + sizeof(__le32) +
  184. sizeof(u8) + CEPH_ENCODING_START_BLK_LEN;
  185. if (cookie_op_buf_size > PAGE_SIZE)
  186. return -E2BIG;
  187. cookie_op_page = alloc_page(GFP_NOIO);
  188. if (!cookie_op_page)
  189. return -ENOMEM;
  190. p = page_address(cookie_op_page);
  191. end = p + cookie_op_buf_size;
  192. /* encode cls_lock_set_cookie_op struct */
  193. ceph_start_encoding(&p, 1, 1,
  194. cookie_op_buf_size - CEPH_ENCODING_START_BLK_LEN);
  195. ceph_encode_string(&p, end, lock_name, name_len);
  196. ceph_encode_8(&p, type);
  197. ceph_encode_string(&p, end, old_cookie, old_cookie_len);
  198. ceph_encode_string(&p, end, tag, tag_len);
  199. ceph_encode_string(&p, end, new_cookie, new_cookie_len);
  200. dout("%s lock_name %s type %d old_cookie %s tag %s new_cookie %s\n",
  201. __func__, lock_name, type, old_cookie, tag, new_cookie);
  202. ret = ceph_osdc_call(osdc, oid, oloc, "lock", "set_cookie",
  203. CEPH_OSD_FLAG_WRITE, cookie_op_page,
  204. cookie_op_buf_size, NULL, NULL);
  205. dout("%s: status %d\n", __func__, ret);
  206. __free_page(cookie_op_page);
  207. return ret;
  208. }
  209. EXPORT_SYMBOL(ceph_cls_set_cookie);
  210. void ceph_free_lockers(struct ceph_locker *lockers, u32 num_lockers)
  211. {
  212. int i;
  213. for (i = 0; i < num_lockers; i++)
  214. kfree(lockers[i].id.cookie);
  215. kfree(lockers);
  216. }
  217. EXPORT_SYMBOL(ceph_free_lockers);
  218. static int decode_locker(void **p, void *end, struct ceph_locker *locker)
  219. {
  220. u8 struct_v;
  221. u32 len;
  222. char *s;
  223. int ret;
  224. ret = ceph_start_decoding(p, end, 1, "locker_id_t", &struct_v, &len);
  225. if (ret)
  226. return ret;
  227. ceph_decode_copy(p, &locker->id.name, sizeof(locker->id.name));
  228. s = ceph_extract_encoded_string(p, end, NULL, GFP_NOIO);
  229. if (IS_ERR(s))
  230. return PTR_ERR(s);
  231. locker->id.cookie = s;
  232. ret = ceph_start_decoding(p, end, 1, "locker_info_t", &struct_v, &len);
  233. if (ret)
  234. return ret;
  235. *p += sizeof(struct ceph_timespec); /* skip expiration */
  236. ret = ceph_decode_entity_addr(p, end, &locker->info.addr);
  237. if (ret)
  238. return ret;
  239. len = ceph_decode_32(p);
  240. *p += len; /* skip description */
  241. dout("%s %s%llu cookie %s addr %s\n", __func__,
  242. ENTITY_NAME(locker->id.name), locker->id.cookie,
  243. ceph_pr_addr(&locker->info.addr));
  244. return 0;
  245. }
  246. static int decode_lockers(void **p, void *end, u8 *type, char **tag,
  247. struct ceph_locker **lockers, u32 *num_lockers)
  248. {
  249. u8 struct_v;
  250. u32 struct_len;
  251. char *s;
  252. int i;
  253. int ret;
  254. ret = ceph_start_decoding(p, end, 1, "cls_lock_get_info_reply",
  255. &struct_v, &struct_len);
  256. if (ret)
  257. return ret;
  258. *num_lockers = ceph_decode_32(p);
  259. *lockers = kcalloc(*num_lockers, sizeof(**lockers), GFP_NOIO);
  260. if (!*lockers)
  261. return -ENOMEM;
  262. for (i = 0; i < *num_lockers; i++) {
  263. ret = decode_locker(p, end, *lockers + i);
  264. if (ret)
  265. goto err_free_lockers;
  266. }
  267. *type = ceph_decode_8(p);
  268. s = ceph_extract_encoded_string(p, end, NULL, GFP_NOIO);
  269. if (IS_ERR(s)) {
  270. ret = PTR_ERR(s);
  271. goto err_free_lockers;
  272. }
  273. *tag = s;
  274. return 0;
  275. err_free_lockers:
  276. ceph_free_lockers(*lockers, *num_lockers);
  277. return ret;
  278. }
  279. /*
  280. * On success, the caller is responsible for:
  281. *
  282. * kfree(tag);
  283. * ceph_free_lockers(lockers, num_lockers);
  284. */
  285. int ceph_cls_lock_info(struct ceph_osd_client *osdc,
  286. struct ceph_object_id *oid,
  287. struct ceph_object_locator *oloc,
  288. char *lock_name, u8 *type, char **tag,
  289. struct ceph_locker **lockers, u32 *num_lockers)
  290. {
  291. int get_info_op_buf_size;
  292. int name_len = strlen(lock_name);
  293. struct page *get_info_op_page, *reply_page;
  294. size_t reply_len = PAGE_SIZE;
  295. void *p, *end;
  296. int ret;
  297. get_info_op_buf_size = name_len + sizeof(__le32) +
  298. CEPH_ENCODING_START_BLK_LEN;
  299. if (get_info_op_buf_size > PAGE_SIZE)
  300. return -E2BIG;
  301. get_info_op_page = alloc_page(GFP_NOIO);
  302. if (!get_info_op_page)
  303. return -ENOMEM;
  304. reply_page = alloc_page(GFP_NOIO);
  305. if (!reply_page) {
  306. __free_page(get_info_op_page);
  307. return -ENOMEM;
  308. }
  309. p = page_address(get_info_op_page);
  310. end = p + get_info_op_buf_size;
  311. /* encode cls_lock_get_info_op struct */
  312. ceph_start_encoding(&p, 1, 1,
  313. get_info_op_buf_size - CEPH_ENCODING_START_BLK_LEN);
  314. ceph_encode_string(&p, end, lock_name, name_len);
  315. dout("%s lock_name %s\n", __func__, lock_name);
  316. ret = ceph_osdc_call(osdc, oid, oloc, "lock", "get_info",
  317. CEPH_OSD_FLAG_READ, get_info_op_page,
  318. get_info_op_buf_size, &reply_page, &reply_len);
  319. dout("%s: status %d\n", __func__, ret);
  320. if (ret >= 0) {
  321. p = page_address(reply_page);
  322. end = p + reply_len;
  323. ret = decode_lockers(&p, end, type, tag, lockers, num_lockers);
  324. }
  325. __free_page(get_info_op_page);
  326. __free_page(reply_page);
  327. return ret;
  328. }
  329. EXPORT_SYMBOL(ceph_cls_lock_info);
  330. int ceph_cls_assert_locked(struct ceph_osd_request *req, int which,
  331. char *lock_name, u8 type, char *cookie, char *tag)
  332. {
  333. int assert_op_buf_size;
  334. int name_len = strlen(lock_name);
  335. int cookie_len = strlen(cookie);
  336. int tag_len = strlen(tag);
  337. struct page **pages;
  338. void *p, *end;
  339. int ret;
  340. assert_op_buf_size = name_len + sizeof(__le32) +
  341. cookie_len + sizeof(__le32) +
  342. tag_len + sizeof(__le32) +
  343. sizeof(u8) + CEPH_ENCODING_START_BLK_LEN;
  344. if (assert_op_buf_size > PAGE_SIZE)
  345. return -E2BIG;
  346. ret = osd_req_op_cls_init(req, which, "lock", "assert_locked");
  347. if (ret)
  348. return ret;
  349. pages = ceph_alloc_page_vector(1, GFP_NOIO);
  350. if (IS_ERR(pages))
  351. return PTR_ERR(pages);
  352. p = page_address(pages[0]);
  353. end = p + assert_op_buf_size;
  354. /* encode cls_lock_assert_op struct */
  355. ceph_start_encoding(&p, 1, 1,
  356. assert_op_buf_size - CEPH_ENCODING_START_BLK_LEN);
  357. ceph_encode_string(&p, end, lock_name, name_len);
  358. ceph_encode_8(&p, type);
  359. ceph_encode_string(&p, end, cookie, cookie_len);
  360. ceph_encode_string(&p, end, tag, tag_len);
  361. WARN_ON(p != end);
  362. osd_req_op_cls_request_data_pages(req, which, pages, assert_op_buf_size,
  363. 0, false, true);
  364. return 0;
  365. }
  366. EXPORT_SYMBOL(ceph_cls_assert_locked);