cls_lock_client.c 10 KB

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