osd_initiator.c 56 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067
  1. /*
  2. * osd_initiator - Main body of the osd initiator library.
  3. *
  4. * Note: The file does not contain the advanced security functionality which
  5. * is only needed by the security_manager's initiators.
  6. *
  7. * Copyright (C) 2008 Panasas Inc. All rights reserved.
  8. *
  9. * Authors:
  10. * Boaz Harrosh <bharrosh@panasas.com>
  11. * Benny Halevy <bhalevy@panasas.com>
  12. *
  13. * This program is free software; you can redistribute it and/or modify
  14. * it under the terms of the GNU General Public License version 2
  15. *
  16. * Redistribution and use in source and binary forms, with or without
  17. * modification, are permitted provided that the following conditions
  18. * are met:
  19. *
  20. * 1. Redistributions of source code must retain the above copyright
  21. * notice, this list of conditions and the following disclaimer.
  22. * 2. Redistributions in binary form must reproduce the above copyright
  23. * notice, this list of conditions and the following disclaimer in the
  24. * documentation and/or other materials provided with the distribution.
  25. * 3. Neither the name of the Panasas company nor the names of its
  26. * contributors may be used to endorse or promote products derived
  27. * from this software without specific prior written permission.
  28. *
  29. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  30. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  31. * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  32. * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  33. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  34. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  35. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  36. * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  37. * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  38. * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  39. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40. */
  41. #include <linux/slab.h>
  42. #include <scsi/osd_initiator.h>
  43. #include <scsi/osd_sec.h>
  44. #include <scsi/osd_attributes.h>
  45. #include <scsi/osd_sense.h>
  46. #include <scsi/scsi_device.h>
  47. #include "osd_debug.h"
  48. #ifndef __unused
  49. # define __unused __attribute__((unused))
  50. #endif
  51. enum { OSD_REQ_RETRIES = 1 };
  52. MODULE_AUTHOR("Boaz Harrosh <bharrosh@panasas.com>");
  53. MODULE_DESCRIPTION("open-osd initiator library libosd.ko");
  54. MODULE_LICENSE("GPL");
  55. static inline void build_test(void)
  56. {
  57. /* structures were not packed */
  58. BUILD_BUG_ON(sizeof(struct osd_capability) != OSD_CAP_LEN);
  59. BUILD_BUG_ON(sizeof(struct osdv2_cdb) != OSD_TOTAL_CDB_LEN);
  60. BUILD_BUG_ON(sizeof(struct osdv1_cdb) != OSDv1_TOTAL_CDB_LEN);
  61. }
  62. static const char *_osd_ver_desc(struct osd_request *or)
  63. {
  64. return osd_req_is_ver1(or) ? "OSD1" : "OSD2";
  65. }
  66. #define ATTR_DEF_RI(id, len) ATTR_DEF(OSD_APAGE_ROOT_INFORMATION, id, len)
  67. static int _osd_get_print_system_info(struct osd_dev *od,
  68. void *caps, struct osd_dev_info *odi)
  69. {
  70. struct osd_request *or;
  71. struct osd_attr get_attrs[] = {
  72. ATTR_DEF_RI(OSD_ATTR_RI_VENDOR_IDENTIFICATION, 8),
  73. ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_IDENTIFICATION, 16),
  74. ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_MODEL, 32),
  75. ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_REVISION_LEVEL, 4),
  76. ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_SERIAL_NUMBER, 64 /*variable*/),
  77. ATTR_DEF_RI(OSD_ATTR_RI_OSD_NAME, 64 /*variable*/),
  78. ATTR_DEF_RI(OSD_ATTR_RI_TOTAL_CAPACITY, 8),
  79. ATTR_DEF_RI(OSD_ATTR_RI_USED_CAPACITY, 8),
  80. ATTR_DEF_RI(OSD_ATTR_RI_NUMBER_OF_PARTITIONS, 8),
  81. ATTR_DEF_RI(OSD_ATTR_RI_CLOCK, 6),
  82. /* IBM-OSD-SIM Has a bug with this one put it last */
  83. ATTR_DEF_RI(OSD_ATTR_RI_OSD_SYSTEM_ID, 20),
  84. };
  85. void *iter = NULL, *pFirst;
  86. int nelem = ARRAY_SIZE(get_attrs), a = 0;
  87. int ret;
  88. or = osd_start_request(od, GFP_KERNEL);
  89. if (!or)
  90. return -ENOMEM;
  91. /* get attrs */
  92. osd_req_get_attributes(or, &osd_root_object);
  93. osd_req_add_get_attr_list(or, get_attrs, ARRAY_SIZE(get_attrs));
  94. ret = osd_finalize_request(or, 0, caps, NULL);
  95. if (ret)
  96. goto out;
  97. ret = osd_execute_request(or);
  98. if (ret) {
  99. OSD_ERR("Failed to detect %s => %d\n", _osd_ver_desc(or), ret);
  100. goto out;
  101. }
  102. osd_req_decode_get_attr_list(or, get_attrs, &nelem, &iter);
  103. OSD_INFO("Detected %s device\n",
  104. _osd_ver_desc(or));
  105. pFirst = get_attrs[a++].val_ptr;
  106. OSD_INFO("VENDOR_IDENTIFICATION [%s]\n",
  107. (char *)pFirst);
  108. pFirst = get_attrs[a++].val_ptr;
  109. OSD_INFO("PRODUCT_IDENTIFICATION [%s]\n",
  110. (char *)pFirst);
  111. pFirst = get_attrs[a++].val_ptr;
  112. OSD_INFO("PRODUCT_MODEL [%s]\n",
  113. (char *)pFirst);
  114. pFirst = get_attrs[a++].val_ptr;
  115. OSD_INFO("PRODUCT_REVISION_LEVEL [%u]\n",
  116. pFirst ? get_unaligned_be32(pFirst) : ~0U);
  117. pFirst = get_attrs[a++].val_ptr;
  118. OSD_INFO("PRODUCT_SERIAL_NUMBER [%s]\n",
  119. (char *)pFirst);
  120. odi->osdname_len = get_attrs[a].len;
  121. /* Avoid NULL for memcmp optimization 0-length is good enough */
  122. odi->osdname = kzalloc(odi->osdname_len + 1, GFP_KERNEL);
  123. if (odi->osdname_len)
  124. memcpy(odi->osdname, get_attrs[a].val_ptr, odi->osdname_len);
  125. OSD_INFO("OSD_NAME [%s]\n", odi->osdname);
  126. a++;
  127. pFirst = get_attrs[a++].val_ptr;
  128. OSD_INFO("TOTAL_CAPACITY [0x%llx]\n",
  129. pFirst ? _LLU(get_unaligned_be64(pFirst)) : ~0ULL);
  130. pFirst = get_attrs[a++].val_ptr;
  131. OSD_INFO("USED_CAPACITY [0x%llx]\n",
  132. pFirst ? _LLU(get_unaligned_be64(pFirst)) : ~0ULL);
  133. pFirst = get_attrs[a++].val_ptr;
  134. OSD_INFO("NUMBER_OF_PARTITIONS [%llu]\n",
  135. pFirst ? _LLU(get_unaligned_be64(pFirst)) : ~0ULL);
  136. if (a >= nelem)
  137. goto out;
  138. /* FIXME: Where are the time utilities */
  139. pFirst = get_attrs[a++].val_ptr;
  140. OSD_INFO("CLOCK [0x%02x%02x%02x%02x%02x%02x]\n",
  141. ((char *)pFirst)[0], ((char *)pFirst)[1],
  142. ((char *)pFirst)[2], ((char *)pFirst)[3],
  143. ((char *)pFirst)[4], ((char *)pFirst)[5]);
  144. if (a < nelem) { /* IBM-OSD-SIM bug, Might not have it */
  145. unsigned len = get_attrs[a].len;
  146. char sid_dump[32*4 + 2]; /* 2nibbles+space+ASCII */
  147. hex_dump_to_buffer(get_attrs[a].val_ptr, len, 32, 1,
  148. sid_dump, sizeof(sid_dump), true);
  149. OSD_INFO("OSD_SYSTEM_ID(%d)\n"
  150. " [%s]\n", len, sid_dump);
  151. if (unlikely(len > sizeof(odi->systemid))) {
  152. OSD_ERR("OSD Target error: OSD_SYSTEM_ID too long(%d). "
  153. "device idetification might not work\n", len);
  154. len = sizeof(odi->systemid);
  155. }
  156. odi->systemid_len = len;
  157. memcpy(odi->systemid, get_attrs[a].val_ptr, len);
  158. a++;
  159. }
  160. out:
  161. osd_end_request(or);
  162. return ret;
  163. }
  164. int osd_auto_detect_ver(struct osd_dev *od,
  165. void *caps, struct osd_dev_info *odi)
  166. {
  167. int ret;
  168. /* Auto-detect the osd version */
  169. ret = _osd_get_print_system_info(od, caps, odi);
  170. if (ret) {
  171. osd_dev_set_ver(od, OSD_VER1);
  172. OSD_DEBUG("converting to OSD1\n");
  173. ret = _osd_get_print_system_info(od, caps, odi);
  174. }
  175. return ret;
  176. }
  177. EXPORT_SYMBOL(osd_auto_detect_ver);
  178. static unsigned _osd_req_cdb_len(struct osd_request *or)
  179. {
  180. return osd_req_is_ver1(or) ? OSDv1_TOTAL_CDB_LEN : OSD_TOTAL_CDB_LEN;
  181. }
  182. static unsigned _osd_req_alist_elem_size(struct osd_request *or, unsigned len)
  183. {
  184. return osd_req_is_ver1(or) ?
  185. osdv1_attr_list_elem_size(len) :
  186. osdv2_attr_list_elem_size(len);
  187. }
  188. static void _osd_req_alist_elem_encode(struct osd_request *or,
  189. void *attr_last, const struct osd_attr *oa)
  190. {
  191. if (osd_req_is_ver1(or)) {
  192. struct osdv1_attributes_list_element *attr = attr_last;
  193. attr->attr_page = cpu_to_be32(oa->attr_page);
  194. attr->attr_id = cpu_to_be32(oa->attr_id);
  195. attr->attr_bytes = cpu_to_be16(oa->len);
  196. memcpy(attr->attr_val, oa->val_ptr, oa->len);
  197. } else {
  198. struct osdv2_attributes_list_element *attr = attr_last;
  199. attr->attr_page = cpu_to_be32(oa->attr_page);
  200. attr->attr_id = cpu_to_be32(oa->attr_id);
  201. attr->attr_bytes = cpu_to_be16(oa->len);
  202. memcpy(attr->attr_val, oa->val_ptr, oa->len);
  203. }
  204. }
  205. static int _osd_req_alist_elem_decode(struct osd_request *or,
  206. void *cur_p, struct osd_attr *oa, unsigned max_bytes)
  207. {
  208. unsigned inc;
  209. if (osd_req_is_ver1(or)) {
  210. struct osdv1_attributes_list_element *attr = cur_p;
  211. if (max_bytes < sizeof(*attr))
  212. return -1;
  213. oa->len = be16_to_cpu(attr->attr_bytes);
  214. inc = _osd_req_alist_elem_size(or, oa->len);
  215. if (inc > max_bytes)
  216. return -1;
  217. oa->attr_page = be32_to_cpu(attr->attr_page);
  218. oa->attr_id = be32_to_cpu(attr->attr_id);
  219. /* OSD1: On empty attributes we return a pointer to 2 bytes
  220. * of zeros. This keeps similar behaviour with OSD2.
  221. * (See below)
  222. */
  223. oa->val_ptr = likely(oa->len) ? attr->attr_val :
  224. (u8 *)&attr->attr_bytes;
  225. } else {
  226. struct osdv2_attributes_list_element *attr = cur_p;
  227. if (max_bytes < sizeof(*attr))
  228. return -1;
  229. oa->len = be16_to_cpu(attr->attr_bytes);
  230. inc = _osd_req_alist_elem_size(or, oa->len);
  231. if (inc > max_bytes)
  232. return -1;
  233. oa->attr_page = be32_to_cpu(attr->attr_page);
  234. oa->attr_id = be32_to_cpu(attr->attr_id);
  235. /* OSD2: For convenience, on empty attributes, we return 8 bytes
  236. * of zeros here. This keeps the same behaviour with OSD2r04,
  237. * and is nice with null terminating ASCII fields.
  238. * oa->val_ptr == NULL marks the end-of-list, or error.
  239. */
  240. oa->val_ptr = likely(oa->len) ? attr->attr_val : attr->reserved;
  241. }
  242. return inc;
  243. }
  244. static unsigned _osd_req_alist_size(struct osd_request *or, void *list_head)
  245. {
  246. return osd_req_is_ver1(or) ?
  247. osdv1_list_size(list_head) :
  248. osdv2_list_size(list_head);
  249. }
  250. static unsigned _osd_req_sizeof_alist_header(struct osd_request *or)
  251. {
  252. return osd_req_is_ver1(or) ?
  253. sizeof(struct osdv1_attributes_list_header) :
  254. sizeof(struct osdv2_attributes_list_header);
  255. }
  256. static void _osd_req_set_alist_type(struct osd_request *or,
  257. void *list, int list_type)
  258. {
  259. if (osd_req_is_ver1(or)) {
  260. struct osdv1_attributes_list_header *attr_list = list;
  261. memset(attr_list, 0, sizeof(*attr_list));
  262. attr_list->type = list_type;
  263. } else {
  264. struct osdv2_attributes_list_header *attr_list = list;
  265. memset(attr_list, 0, sizeof(*attr_list));
  266. attr_list->type = list_type;
  267. }
  268. }
  269. static bool _osd_req_is_alist_type(struct osd_request *or,
  270. void *list, int list_type)
  271. {
  272. if (!list)
  273. return false;
  274. if (osd_req_is_ver1(or)) {
  275. struct osdv1_attributes_list_header *attr_list = list;
  276. return attr_list->type == list_type;
  277. } else {
  278. struct osdv2_attributes_list_header *attr_list = list;
  279. return attr_list->type == list_type;
  280. }
  281. }
  282. /* This is for List-objects not Attributes-Lists */
  283. static void _osd_req_encode_olist(struct osd_request *or,
  284. struct osd_obj_id_list *list)
  285. {
  286. struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
  287. if (osd_req_is_ver1(or)) {
  288. cdbh->v1.list_identifier = list->list_identifier;
  289. cdbh->v1.start_address = list->continuation_id;
  290. } else {
  291. cdbh->v2.list_identifier = list->list_identifier;
  292. cdbh->v2.start_address = list->continuation_id;
  293. }
  294. }
  295. static osd_cdb_offset osd_req_encode_offset(struct osd_request *or,
  296. u64 offset, unsigned *padding)
  297. {
  298. return __osd_encode_offset(offset, padding,
  299. osd_req_is_ver1(or) ?
  300. OSDv1_OFFSET_MIN_SHIFT : OSD_OFFSET_MIN_SHIFT,
  301. OSD_OFFSET_MAX_SHIFT);
  302. }
  303. static struct osd_security_parameters *
  304. _osd_req_sec_params(struct osd_request *or)
  305. {
  306. struct osd_cdb *ocdb = &or->cdb;
  307. if (osd_req_is_ver1(or))
  308. return (struct osd_security_parameters *)&ocdb->v1.sec_params;
  309. else
  310. return (struct osd_security_parameters *)&ocdb->v2.sec_params;
  311. }
  312. void osd_dev_init(struct osd_dev *osdd, struct scsi_device *scsi_device)
  313. {
  314. memset(osdd, 0, sizeof(*osdd));
  315. osdd->scsi_device = scsi_device;
  316. osdd->def_timeout = BLK_DEFAULT_SG_TIMEOUT;
  317. #ifdef OSD_VER1_SUPPORT
  318. osdd->version = OSD_VER2;
  319. #endif
  320. /* TODO: Allocate pools for osd_request attributes ... */
  321. }
  322. EXPORT_SYMBOL(osd_dev_init);
  323. void osd_dev_fini(struct osd_dev *osdd)
  324. {
  325. /* TODO: De-allocate pools */
  326. osdd->scsi_device = NULL;
  327. }
  328. EXPORT_SYMBOL(osd_dev_fini);
  329. static struct osd_request *_osd_request_alloc(gfp_t gfp)
  330. {
  331. struct osd_request *or;
  332. /* TODO: Use mempool with one saved request */
  333. or = kzalloc(sizeof(*or), gfp);
  334. return or;
  335. }
  336. static void _osd_request_free(struct osd_request *or)
  337. {
  338. kfree(or);
  339. }
  340. struct osd_request *osd_start_request(struct osd_dev *dev, gfp_t gfp)
  341. {
  342. struct osd_request *or;
  343. or = _osd_request_alloc(gfp);
  344. if (!or)
  345. return NULL;
  346. or->osd_dev = dev;
  347. or->alloc_flags = gfp;
  348. or->timeout = dev->def_timeout;
  349. or->retries = OSD_REQ_RETRIES;
  350. return or;
  351. }
  352. EXPORT_SYMBOL(osd_start_request);
  353. static void _osd_free_seg(struct osd_request *or __unused,
  354. struct _osd_req_data_segment *seg)
  355. {
  356. if (!seg->buff || !seg->alloc_size)
  357. return;
  358. kfree(seg->buff);
  359. seg->buff = NULL;
  360. seg->alloc_size = 0;
  361. }
  362. static void _put_request(struct request *rq)
  363. {
  364. /*
  365. * If osd_finalize_request() was called but the request was not
  366. * executed through the block layer, then we must release BIOs.
  367. * TODO: Keep error code in or->async_error. Need to audit all
  368. * code paths.
  369. */
  370. if (unlikely(rq->bio))
  371. blk_end_request(rq, -ENOMEM, blk_rq_bytes(rq));
  372. else
  373. blk_put_request(rq);
  374. }
  375. void osd_end_request(struct osd_request *or)
  376. {
  377. struct request *rq = or->request;
  378. if (rq) {
  379. if (rq->next_rq) {
  380. _put_request(rq->next_rq);
  381. rq->next_rq = NULL;
  382. }
  383. _put_request(rq);
  384. }
  385. _osd_free_seg(or, &or->get_attr);
  386. _osd_free_seg(or, &or->enc_get_attr);
  387. _osd_free_seg(or, &or->set_attr);
  388. _osd_free_seg(or, &or->cdb_cont);
  389. _osd_request_free(or);
  390. }
  391. EXPORT_SYMBOL(osd_end_request);
  392. static void _set_error_resid(struct osd_request *or, struct request *req,
  393. int error)
  394. {
  395. or->async_error = error;
  396. or->req_errors = req->errors ? : error;
  397. or->sense_len = req->sense_len;
  398. if (or->out.req)
  399. or->out.residual = or->out.req->resid_len;
  400. if (or->in.req)
  401. or->in.residual = or->in.req->resid_len;
  402. }
  403. int osd_execute_request(struct osd_request *or)
  404. {
  405. int error = blk_execute_rq(or->request->q, NULL, or->request, 0);
  406. _set_error_resid(or, or->request, error);
  407. return error;
  408. }
  409. EXPORT_SYMBOL(osd_execute_request);
  410. static void osd_request_async_done(struct request *req, int error)
  411. {
  412. struct osd_request *or = req->end_io_data;
  413. _set_error_resid(or, req, error);
  414. if (req->next_rq) {
  415. __blk_put_request(req->q, req->next_rq);
  416. req->next_rq = NULL;
  417. }
  418. __blk_put_request(req->q, req);
  419. or->request = NULL;
  420. or->in.req = NULL;
  421. or->out.req = NULL;
  422. if (or->async_done)
  423. or->async_done(or, or->async_private);
  424. else
  425. osd_end_request(or);
  426. }
  427. int osd_execute_request_async(struct osd_request *or,
  428. osd_req_done_fn *done, void *private)
  429. {
  430. or->request->end_io_data = or;
  431. or->async_private = private;
  432. or->async_done = done;
  433. blk_execute_rq_nowait(or->request->q, NULL, or->request, 0,
  434. osd_request_async_done);
  435. return 0;
  436. }
  437. EXPORT_SYMBOL(osd_execute_request_async);
  438. u8 sg_out_pad_buffer[1 << OSDv1_OFFSET_MIN_SHIFT];
  439. u8 sg_in_pad_buffer[1 << OSDv1_OFFSET_MIN_SHIFT];
  440. static int _osd_realloc_seg(struct osd_request *or,
  441. struct _osd_req_data_segment *seg, unsigned max_bytes)
  442. {
  443. void *buff;
  444. if (seg->alloc_size >= max_bytes)
  445. return 0;
  446. buff = krealloc(seg->buff, max_bytes, or->alloc_flags);
  447. if (!buff) {
  448. OSD_ERR("Failed to Realloc %d-bytes was-%d\n", max_bytes,
  449. seg->alloc_size);
  450. return -ENOMEM;
  451. }
  452. memset(buff + seg->alloc_size, 0, max_bytes - seg->alloc_size);
  453. seg->buff = buff;
  454. seg->alloc_size = max_bytes;
  455. return 0;
  456. }
  457. static int _alloc_cdb_cont(struct osd_request *or, unsigned total_bytes)
  458. {
  459. OSD_DEBUG("total_bytes=%d\n", total_bytes);
  460. return _osd_realloc_seg(or, &or->cdb_cont, total_bytes);
  461. }
  462. static int _alloc_set_attr_list(struct osd_request *or,
  463. const struct osd_attr *oa, unsigned nelem, unsigned add_bytes)
  464. {
  465. unsigned total_bytes = add_bytes;
  466. for (; nelem; --nelem, ++oa)
  467. total_bytes += _osd_req_alist_elem_size(or, oa->len);
  468. OSD_DEBUG("total_bytes=%d\n", total_bytes);
  469. return _osd_realloc_seg(or, &or->set_attr, total_bytes);
  470. }
  471. static int _alloc_get_attr_desc(struct osd_request *or, unsigned max_bytes)
  472. {
  473. OSD_DEBUG("total_bytes=%d\n", max_bytes);
  474. return _osd_realloc_seg(or, &or->enc_get_attr, max_bytes);
  475. }
  476. static int _alloc_get_attr_list(struct osd_request *or)
  477. {
  478. OSD_DEBUG("total_bytes=%d\n", or->get_attr.total_bytes);
  479. return _osd_realloc_seg(or, &or->get_attr, or->get_attr.total_bytes);
  480. }
  481. /*
  482. * Common to all OSD commands
  483. */
  484. static void _osdv1_req_encode_common(struct osd_request *or,
  485. __be16 act, const struct osd_obj_id *obj, u64 offset, u64 len)
  486. {
  487. struct osdv1_cdb *ocdb = &or->cdb.v1;
  488. /*
  489. * For speed, the commands
  490. * OSD_ACT_PERFORM_SCSI_COMMAND , V1 0x8F7E, V2 0x8F7C
  491. * OSD_ACT_SCSI_TASK_MANAGEMENT , V1 0x8F7F, V2 0x8F7D
  492. * are not supported here. Should pass zero and set after the call
  493. */
  494. act &= cpu_to_be16(~0x0080); /* V1 action code */
  495. OSD_DEBUG("OSDv1 execute opcode 0x%x\n", be16_to_cpu(act));
  496. ocdb->h.varlen_cdb.opcode = VARIABLE_LENGTH_CMD;
  497. ocdb->h.varlen_cdb.additional_cdb_length = OSD_ADDITIONAL_CDB_LENGTH;
  498. ocdb->h.varlen_cdb.service_action = act;
  499. ocdb->h.partition = cpu_to_be64(obj->partition);
  500. ocdb->h.object = cpu_to_be64(obj->id);
  501. ocdb->h.v1.length = cpu_to_be64(len);
  502. ocdb->h.v1.start_address = cpu_to_be64(offset);
  503. }
  504. static void _osdv2_req_encode_common(struct osd_request *or,
  505. __be16 act, const struct osd_obj_id *obj, u64 offset, u64 len)
  506. {
  507. struct osdv2_cdb *ocdb = &or->cdb.v2;
  508. OSD_DEBUG("OSDv2 execute opcode 0x%x\n", be16_to_cpu(act));
  509. ocdb->h.varlen_cdb.opcode = VARIABLE_LENGTH_CMD;
  510. ocdb->h.varlen_cdb.additional_cdb_length = OSD_ADDITIONAL_CDB_LENGTH;
  511. ocdb->h.varlen_cdb.service_action = act;
  512. ocdb->h.partition = cpu_to_be64(obj->partition);
  513. ocdb->h.object = cpu_to_be64(obj->id);
  514. ocdb->h.v2.length = cpu_to_be64(len);
  515. ocdb->h.v2.start_address = cpu_to_be64(offset);
  516. }
  517. static void _osd_req_encode_common(struct osd_request *or,
  518. __be16 act, const struct osd_obj_id *obj, u64 offset, u64 len)
  519. {
  520. if (osd_req_is_ver1(or))
  521. _osdv1_req_encode_common(or, act, obj, offset, len);
  522. else
  523. _osdv2_req_encode_common(or, act, obj, offset, len);
  524. }
  525. /*
  526. * Device commands
  527. */
  528. /*TODO: void osd_req_set_master_seed_xchg(struct osd_request *, ...); */
  529. /*TODO: void osd_req_set_master_key(struct osd_request *, ...); */
  530. void osd_req_format(struct osd_request *or, u64 tot_capacity)
  531. {
  532. _osd_req_encode_common(or, OSD_ACT_FORMAT_OSD, &osd_root_object, 0,
  533. tot_capacity);
  534. }
  535. EXPORT_SYMBOL(osd_req_format);
  536. int osd_req_list_dev_partitions(struct osd_request *or,
  537. osd_id initial_id, struct osd_obj_id_list *list, unsigned nelem)
  538. {
  539. return osd_req_list_partition_objects(or, 0, initial_id, list, nelem);
  540. }
  541. EXPORT_SYMBOL(osd_req_list_dev_partitions);
  542. static void _osd_req_encode_flush(struct osd_request *or,
  543. enum osd_options_flush_scope_values op)
  544. {
  545. struct osd_cdb_head *ocdb = osd_cdb_head(&or->cdb);
  546. ocdb->command_specific_options = op;
  547. }
  548. void osd_req_flush_obsd(struct osd_request *or,
  549. enum osd_options_flush_scope_values op)
  550. {
  551. _osd_req_encode_common(or, OSD_ACT_FLUSH_OSD, &osd_root_object, 0, 0);
  552. _osd_req_encode_flush(or, op);
  553. }
  554. EXPORT_SYMBOL(osd_req_flush_obsd);
  555. /*TODO: void osd_req_perform_scsi_command(struct osd_request *,
  556. const u8 *cdb, ...); */
  557. /*TODO: void osd_req_task_management(struct osd_request *, ...); */
  558. /*
  559. * Partition commands
  560. */
  561. static void _osd_req_encode_partition(struct osd_request *or,
  562. __be16 act, osd_id partition)
  563. {
  564. struct osd_obj_id par = {
  565. .partition = partition,
  566. .id = 0,
  567. };
  568. _osd_req_encode_common(or, act, &par, 0, 0);
  569. }
  570. void osd_req_create_partition(struct osd_request *or, osd_id partition)
  571. {
  572. _osd_req_encode_partition(or, OSD_ACT_CREATE_PARTITION, partition);
  573. }
  574. EXPORT_SYMBOL(osd_req_create_partition);
  575. void osd_req_remove_partition(struct osd_request *or, osd_id partition)
  576. {
  577. _osd_req_encode_partition(or, OSD_ACT_REMOVE_PARTITION, partition);
  578. }
  579. EXPORT_SYMBOL(osd_req_remove_partition);
  580. /*TODO: void osd_req_set_partition_key(struct osd_request *,
  581. osd_id partition, u8 new_key_id[OSD_CRYPTO_KEYID_SIZE],
  582. u8 seed[OSD_CRYPTO_SEED_SIZE]); */
  583. static int _osd_req_list_objects(struct osd_request *or,
  584. __be16 action, const struct osd_obj_id *obj, osd_id initial_id,
  585. struct osd_obj_id_list *list, unsigned nelem)
  586. {
  587. struct request_queue *q = osd_request_queue(or->osd_dev);
  588. u64 len = nelem * sizeof(osd_id) + sizeof(*list);
  589. struct bio *bio;
  590. _osd_req_encode_common(or, action, obj, (u64)initial_id, len);
  591. if (list->list_identifier)
  592. _osd_req_encode_olist(or, list);
  593. WARN_ON(or->in.bio);
  594. bio = bio_map_kern(q, list, len, or->alloc_flags);
  595. if (IS_ERR(bio)) {
  596. OSD_ERR("!!! Failed to allocate list_objects BIO\n");
  597. return PTR_ERR(bio);
  598. }
  599. bio->bi_rw &= ~REQ_WRITE;
  600. or->in.bio = bio;
  601. or->in.total_bytes = bio->bi_size;
  602. return 0;
  603. }
  604. int osd_req_list_partition_collections(struct osd_request *or,
  605. osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
  606. unsigned nelem)
  607. {
  608. struct osd_obj_id par = {
  609. .partition = partition,
  610. .id = 0,
  611. };
  612. return osd_req_list_collection_objects(or, &par, initial_id, list,
  613. nelem);
  614. }
  615. EXPORT_SYMBOL(osd_req_list_partition_collections);
  616. int osd_req_list_partition_objects(struct osd_request *or,
  617. osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
  618. unsigned nelem)
  619. {
  620. struct osd_obj_id par = {
  621. .partition = partition,
  622. .id = 0,
  623. };
  624. return _osd_req_list_objects(or, OSD_ACT_LIST, &par, initial_id, list,
  625. nelem);
  626. }
  627. EXPORT_SYMBOL(osd_req_list_partition_objects);
  628. void osd_req_flush_partition(struct osd_request *or,
  629. osd_id partition, enum osd_options_flush_scope_values op)
  630. {
  631. _osd_req_encode_partition(or, OSD_ACT_FLUSH_PARTITION, partition);
  632. _osd_req_encode_flush(or, op);
  633. }
  634. EXPORT_SYMBOL(osd_req_flush_partition);
  635. /*
  636. * Collection commands
  637. */
  638. /*TODO: void osd_req_create_collection(struct osd_request *,
  639. const struct osd_obj_id *); */
  640. /*TODO: void osd_req_remove_collection(struct osd_request *,
  641. const struct osd_obj_id *); */
  642. int osd_req_list_collection_objects(struct osd_request *or,
  643. const struct osd_obj_id *obj, osd_id initial_id,
  644. struct osd_obj_id_list *list, unsigned nelem)
  645. {
  646. return _osd_req_list_objects(or, OSD_ACT_LIST_COLLECTION, obj,
  647. initial_id, list, nelem);
  648. }
  649. EXPORT_SYMBOL(osd_req_list_collection_objects);
  650. /*TODO: void query(struct osd_request *, ...); V2 */
  651. void osd_req_flush_collection(struct osd_request *or,
  652. const struct osd_obj_id *obj, enum osd_options_flush_scope_values op)
  653. {
  654. _osd_req_encode_common(or, OSD_ACT_FLUSH_PARTITION, obj, 0, 0);
  655. _osd_req_encode_flush(or, op);
  656. }
  657. EXPORT_SYMBOL(osd_req_flush_collection);
  658. /*TODO: void get_member_attrs(struct osd_request *, ...); V2 */
  659. /*TODO: void set_member_attrs(struct osd_request *, ...); V2 */
  660. /*
  661. * Object commands
  662. */
  663. void osd_req_create_object(struct osd_request *or, struct osd_obj_id *obj)
  664. {
  665. _osd_req_encode_common(or, OSD_ACT_CREATE, obj, 0, 0);
  666. }
  667. EXPORT_SYMBOL(osd_req_create_object);
  668. void osd_req_remove_object(struct osd_request *or, struct osd_obj_id *obj)
  669. {
  670. _osd_req_encode_common(or, OSD_ACT_REMOVE, obj, 0, 0);
  671. }
  672. EXPORT_SYMBOL(osd_req_remove_object);
  673. /*TODO: void osd_req_create_multi(struct osd_request *or,
  674. struct osd_obj_id *first, struct osd_obj_id_list *list, unsigned nelem);
  675. */
  676. void osd_req_write(struct osd_request *or,
  677. const struct osd_obj_id *obj, u64 offset,
  678. struct bio *bio, u64 len)
  679. {
  680. _osd_req_encode_common(or, OSD_ACT_WRITE, obj, offset, len);
  681. WARN_ON(or->out.bio || or->out.total_bytes);
  682. WARN_ON(0 == (bio->bi_rw & REQ_WRITE));
  683. or->out.bio = bio;
  684. or->out.total_bytes = len;
  685. }
  686. EXPORT_SYMBOL(osd_req_write);
  687. int osd_req_write_kern(struct osd_request *or,
  688. const struct osd_obj_id *obj, u64 offset, void* buff, u64 len)
  689. {
  690. struct request_queue *req_q = osd_request_queue(or->osd_dev);
  691. struct bio *bio = bio_map_kern(req_q, buff, len, GFP_KERNEL);
  692. if (IS_ERR(bio))
  693. return PTR_ERR(bio);
  694. bio->bi_rw |= REQ_WRITE; /* FIXME: bio_set_dir() */
  695. osd_req_write(or, obj, offset, bio, len);
  696. return 0;
  697. }
  698. EXPORT_SYMBOL(osd_req_write_kern);
  699. /*TODO: void osd_req_append(struct osd_request *,
  700. const struct osd_obj_id *, struct bio *data_out); */
  701. /*TODO: void osd_req_create_write(struct osd_request *,
  702. const struct osd_obj_id *, struct bio *data_out, u64 offset); */
  703. /*TODO: void osd_req_clear(struct osd_request *,
  704. const struct osd_obj_id *, u64 offset, u64 len); */
  705. /*TODO: void osd_req_punch(struct osd_request *,
  706. const struct osd_obj_id *, u64 offset, u64 len); V2 */
  707. void osd_req_flush_object(struct osd_request *or,
  708. const struct osd_obj_id *obj, enum osd_options_flush_scope_values op,
  709. /*V2*/ u64 offset, /*V2*/ u64 len)
  710. {
  711. if (unlikely(osd_req_is_ver1(or) && (offset || len))) {
  712. OSD_DEBUG("OSD Ver1 flush on specific range ignored\n");
  713. offset = 0;
  714. len = 0;
  715. }
  716. _osd_req_encode_common(or, OSD_ACT_FLUSH, obj, offset, len);
  717. _osd_req_encode_flush(or, op);
  718. }
  719. EXPORT_SYMBOL(osd_req_flush_object);
  720. void osd_req_read(struct osd_request *or,
  721. const struct osd_obj_id *obj, u64 offset,
  722. struct bio *bio, u64 len)
  723. {
  724. _osd_req_encode_common(or, OSD_ACT_READ, obj, offset, len);
  725. WARN_ON(or->in.bio || or->in.total_bytes);
  726. WARN_ON(bio->bi_rw & REQ_WRITE);
  727. or->in.bio = bio;
  728. or->in.total_bytes = len;
  729. }
  730. EXPORT_SYMBOL(osd_req_read);
  731. int osd_req_read_kern(struct osd_request *or,
  732. const struct osd_obj_id *obj, u64 offset, void* buff, u64 len)
  733. {
  734. struct request_queue *req_q = osd_request_queue(or->osd_dev);
  735. struct bio *bio = bio_map_kern(req_q, buff, len, GFP_KERNEL);
  736. if (IS_ERR(bio))
  737. return PTR_ERR(bio);
  738. osd_req_read(or, obj, offset, bio, len);
  739. return 0;
  740. }
  741. EXPORT_SYMBOL(osd_req_read_kern);
  742. static int _add_sg_continuation_descriptor(struct osd_request *or,
  743. const struct osd_sg_entry *sglist, unsigned numentries, u64 *len)
  744. {
  745. struct osd_sg_continuation_descriptor *oscd;
  746. u32 oscd_size;
  747. unsigned i;
  748. int ret;
  749. oscd_size = sizeof(*oscd) + numentries * sizeof(oscd->entries[0]);
  750. if (!or->cdb_cont.total_bytes) {
  751. /* First time, jump over the header, we will write to:
  752. * cdb_cont.buff + cdb_cont.total_bytes
  753. */
  754. or->cdb_cont.total_bytes =
  755. sizeof(struct osd_continuation_segment_header);
  756. }
  757. ret = _alloc_cdb_cont(or, or->cdb_cont.total_bytes + oscd_size);
  758. if (unlikely(ret))
  759. return ret;
  760. oscd = or->cdb_cont.buff + or->cdb_cont.total_bytes;
  761. oscd->hdr.type = cpu_to_be16(SCATTER_GATHER_LIST);
  762. oscd->hdr.pad_length = 0;
  763. oscd->hdr.length = cpu_to_be32(oscd_size - sizeof(*oscd));
  764. *len = 0;
  765. /* copy the sg entries and convert to network byte order */
  766. for (i = 0; i < numentries; i++) {
  767. oscd->entries[i].offset = cpu_to_be64(sglist[i].offset);
  768. oscd->entries[i].len = cpu_to_be64(sglist[i].len);
  769. *len += sglist[i].len;
  770. }
  771. or->cdb_cont.total_bytes += oscd_size;
  772. OSD_DEBUG("total_bytes=%d oscd_size=%d numentries=%d\n",
  773. or->cdb_cont.total_bytes, oscd_size, numentries);
  774. return 0;
  775. }
  776. static int _osd_req_finalize_cdb_cont(struct osd_request *or, const u8 *cap_key)
  777. {
  778. struct request_queue *req_q = osd_request_queue(or->osd_dev);
  779. struct bio *bio;
  780. struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
  781. struct osd_continuation_segment_header *cont_seg_hdr;
  782. if (!or->cdb_cont.total_bytes)
  783. return 0;
  784. cont_seg_hdr = or->cdb_cont.buff;
  785. cont_seg_hdr->format = CDB_CONTINUATION_FORMAT_V2;
  786. cont_seg_hdr->service_action = cdbh->varlen_cdb.service_action;
  787. /* create a bio for continuation segment */
  788. bio = bio_map_kern(req_q, or->cdb_cont.buff, or->cdb_cont.total_bytes,
  789. GFP_KERNEL);
  790. if (IS_ERR(bio))
  791. return PTR_ERR(bio);
  792. bio->bi_rw |= REQ_WRITE;
  793. /* integrity check the continuation before the bio is linked
  794. * with the other data segments since the continuation
  795. * integrity is separate from the other data segments.
  796. */
  797. osd_sec_sign_data(cont_seg_hdr->integrity_check, bio, cap_key);
  798. cdbh->v2.cdb_continuation_length = cpu_to_be32(or->cdb_cont.total_bytes);
  799. /* we can't use _req_append_segment, because we need to link in the
  800. * continuation bio to the head of the bio list - the
  801. * continuation segment (if it exists) is always the first segment in
  802. * the out data buffer.
  803. */
  804. bio->bi_next = or->out.bio;
  805. or->out.bio = bio;
  806. or->out.total_bytes += or->cdb_cont.total_bytes;
  807. return 0;
  808. }
  809. /* osd_req_write_sg: Takes a @bio that points to the data out buffer and an
  810. * @sglist that has the scatter gather entries. Scatter-gather enables a write
  811. * of multiple none-contiguous areas of an object, in a single call. The extents
  812. * may overlap and/or be in any order. The only constrain is that:
  813. * total_bytes(sglist) >= total_bytes(bio)
  814. */
  815. int osd_req_write_sg(struct osd_request *or,
  816. const struct osd_obj_id *obj, struct bio *bio,
  817. const struct osd_sg_entry *sglist, unsigned numentries)
  818. {
  819. u64 len;
  820. int ret = _add_sg_continuation_descriptor(or, sglist, numentries, &len);
  821. if (ret)
  822. return ret;
  823. osd_req_write(or, obj, 0, bio, len);
  824. return 0;
  825. }
  826. EXPORT_SYMBOL(osd_req_write_sg);
  827. /* osd_req_read_sg: Read multiple extents of an object into @bio
  828. * See osd_req_write_sg
  829. */
  830. int osd_req_read_sg(struct osd_request *or,
  831. const struct osd_obj_id *obj, struct bio *bio,
  832. const struct osd_sg_entry *sglist, unsigned numentries)
  833. {
  834. u64 len;
  835. u64 off;
  836. int ret;
  837. if (numentries > 1) {
  838. off = 0;
  839. ret = _add_sg_continuation_descriptor(or, sglist, numentries,
  840. &len);
  841. if (ret)
  842. return ret;
  843. } else {
  844. /* Optimize the case of single segment, read_sg is a
  845. * bidi operation.
  846. */
  847. len = sglist->len;
  848. off = sglist->offset;
  849. }
  850. osd_req_read(or, obj, off, bio, len);
  851. return 0;
  852. }
  853. EXPORT_SYMBOL(osd_req_read_sg);
  854. /* SG-list write/read Kern API
  855. *
  856. * osd_req_{write,read}_sg_kern takes an array of @buff pointers and an array
  857. * of sg_entries. @numentries indicates how many pointers and sg_entries there
  858. * are. By requiring an array of buff pointers. This allows a caller to do a
  859. * single write/read and scatter into multiple buffers.
  860. * NOTE: Each buffer + len should not cross a page boundary.
  861. */
  862. static struct bio *_create_sg_bios(struct osd_request *or,
  863. void **buff, const struct osd_sg_entry *sglist, unsigned numentries)
  864. {
  865. struct request_queue *q = osd_request_queue(or->osd_dev);
  866. struct bio *bio;
  867. unsigned i;
  868. bio = bio_kmalloc(GFP_KERNEL, numentries);
  869. if (unlikely(!bio)) {
  870. OSD_DEBUG("Faild to allocate BIO size=%u\n", numentries);
  871. return ERR_PTR(-ENOMEM);
  872. }
  873. for (i = 0; i < numentries; i++) {
  874. unsigned offset = offset_in_page(buff[i]);
  875. struct page *page = virt_to_page(buff[i]);
  876. unsigned len = sglist[i].len;
  877. unsigned added_len;
  878. BUG_ON(offset + len > PAGE_SIZE);
  879. added_len = bio_add_pc_page(q, bio, page, len, offset);
  880. if (unlikely(len != added_len)) {
  881. OSD_DEBUG("bio_add_pc_page len(%d) != added_len(%d)\n",
  882. len, added_len);
  883. bio_put(bio);
  884. return ERR_PTR(-ENOMEM);
  885. }
  886. }
  887. return bio;
  888. }
  889. int osd_req_write_sg_kern(struct osd_request *or,
  890. const struct osd_obj_id *obj, void **buff,
  891. const struct osd_sg_entry *sglist, unsigned numentries)
  892. {
  893. struct bio *bio = _create_sg_bios(or, buff, sglist, numentries);
  894. if (IS_ERR(bio))
  895. return PTR_ERR(bio);
  896. bio->bi_rw |= REQ_WRITE;
  897. osd_req_write_sg(or, obj, bio, sglist, numentries);
  898. return 0;
  899. }
  900. EXPORT_SYMBOL(osd_req_write_sg_kern);
  901. int osd_req_read_sg_kern(struct osd_request *or,
  902. const struct osd_obj_id *obj, void **buff,
  903. const struct osd_sg_entry *sglist, unsigned numentries)
  904. {
  905. struct bio *bio = _create_sg_bios(or, buff, sglist, numentries);
  906. if (IS_ERR(bio))
  907. return PTR_ERR(bio);
  908. osd_req_read_sg(or, obj, bio, sglist, numentries);
  909. return 0;
  910. }
  911. EXPORT_SYMBOL(osd_req_read_sg_kern);
  912. void osd_req_get_attributes(struct osd_request *or,
  913. const struct osd_obj_id *obj)
  914. {
  915. _osd_req_encode_common(or, OSD_ACT_GET_ATTRIBUTES, obj, 0, 0);
  916. }
  917. EXPORT_SYMBOL(osd_req_get_attributes);
  918. void osd_req_set_attributes(struct osd_request *or,
  919. const struct osd_obj_id *obj)
  920. {
  921. _osd_req_encode_common(or, OSD_ACT_SET_ATTRIBUTES, obj, 0, 0);
  922. }
  923. EXPORT_SYMBOL(osd_req_set_attributes);
  924. /*
  925. * Attributes List-mode
  926. */
  927. int osd_req_add_set_attr_list(struct osd_request *or,
  928. const struct osd_attr *oa, unsigned nelem)
  929. {
  930. unsigned total_bytes = or->set_attr.total_bytes;
  931. void *attr_last;
  932. int ret;
  933. if (or->attributes_mode &&
  934. or->attributes_mode != OSD_CDB_GET_SET_ATTR_LISTS) {
  935. WARN_ON(1);
  936. return -EINVAL;
  937. }
  938. or->attributes_mode = OSD_CDB_GET_SET_ATTR_LISTS;
  939. if (!total_bytes) { /* first-time: allocate and put list header */
  940. total_bytes = _osd_req_sizeof_alist_header(or);
  941. ret = _alloc_set_attr_list(or, oa, nelem, total_bytes);
  942. if (ret)
  943. return ret;
  944. _osd_req_set_alist_type(or, or->set_attr.buff,
  945. OSD_ATTR_LIST_SET_RETRIEVE);
  946. }
  947. attr_last = or->set_attr.buff + total_bytes;
  948. for (; nelem; --nelem) {
  949. unsigned elem_size = _osd_req_alist_elem_size(or, oa->len);
  950. total_bytes += elem_size;
  951. if (unlikely(or->set_attr.alloc_size < total_bytes)) {
  952. or->set_attr.total_bytes = total_bytes - elem_size;
  953. ret = _alloc_set_attr_list(or, oa, nelem, total_bytes);
  954. if (ret)
  955. return ret;
  956. attr_last =
  957. or->set_attr.buff + or->set_attr.total_bytes;
  958. }
  959. _osd_req_alist_elem_encode(or, attr_last, oa);
  960. attr_last += elem_size;
  961. ++oa;
  962. }
  963. or->set_attr.total_bytes = total_bytes;
  964. return 0;
  965. }
  966. EXPORT_SYMBOL(osd_req_add_set_attr_list);
  967. static int _req_append_segment(struct osd_request *or,
  968. unsigned padding, struct _osd_req_data_segment *seg,
  969. struct _osd_req_data_segment *last_seg, struct _osd_io_info *io)
  970. {
  971. void *pad_buff;
  972. int ret;
  973. if (padding) {
  974. /* check if we can just add it to last buffer */
  975. if (last_seg &&
  976. (padding <= last_seg->alloc_size - last_seg->total_bytes))
  977. pad_buff = last_seg->buff + last_seg->total_bytes;
  978. else
  979. pad_buff = io->pad_buff;
  980. ret = blk_rq_map_kern(io->req->q, io->req, pad_buff, padding,
  981. or->alloc_flags);
  982. if (ret)
  983. return ret;
  984. io->total_bytes += padding;
  985. }
  986. ret = blk_rq_map_kern(io->req->q, io->req, seg->buff, seg->total_bytes,
  987. or->alloc_flags);
  988. if (ret)
  989. return ret;
  990. io->total_bytes += seg->total_bytes;
  991. OSD_DEBUG("padding=%d buff=%p total_bytes=%d\n", padding, seg->buff,
  992. seg->total_bytes);
  993. return 0;
  994. }
  995. static int _osd_req_finalize_set_attr_list(struct osd_request *or)
  996. {
  997. struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
  998. unsigned padding;
  999. int ret;
  1000. if (!or->set_attr.total_bytes) {
  1001. cdbh->attrs_list.set_attr_offset = OSD_OFFSET_UNUSED;
  1002. return 0;
  1003. }
  1004. cdbh->attrs_list.set_attr_bytes = cpu_to_be32(or->set_attr.total_bytes);
  1005. cdbh->attrs_list.set_attr_offset =
  1006. osd_req_encode_offset(or, or->out.total_bytes, &padding);
  1007. ret = _req_append_segment(or, padding, &or->set_attr,
  1008. or->out.last_seg, &or->out);
  1009. if (ret)
  1010. return ret;
  1011. or->out.last_seg = &or->set_attr;
  1012. return 0;
  1013. }
  1014. int osd_req_add_get_attr_list(struct osd_request *or,
  1015. const struct osd_attr *oa, unsigned nelem)
  1016. {
  1017. unsigned total_bytes = or->enc_get_attr.total_bytes;
  1018. void *attr_last;
  1019. int ret;
  1020. if (or->attributes_mode &&
  1021. or->attributes_mode != OSD_CDB_GET_SET_ATTR_LISTS) {
  1022. WARN_ON(1);
  1023. return -EINVAL;
  1024. }
  1025. or->attributes_mode = OSD_CDB_GET_SET_ATTR_LISTS;
  1026. /* first time calc data-in list header size */
  1027. if (!or->get_attr.total_bytes)
  1028. or->get_attr.total_bytes = _osd_req_sizeof_alist_header(or);
  1029. /* calc data-out info */
  1030. if (!total_bytes) { /* first-time: allocate and put list header */
  1031. unsigned max_bytes;
  1032. total_bytes = _osd_req_sizeof_alist_header(or);
  1033. max_bytes = total_bytes +
  1034. nelem * sizeof(struct osd_attributes_list_attrid);
  1035. ret = _alloc_get_attr_desc(or, max_bytes);
  1036. if (ret)
  1037. return ret;
  1038. _osd_req_set_alist_type(or, or->enc_get_attr.buff,
  1039. OSD_ATTR_LIST_GET);
  1040. }
  1041. attr_last = or->enc_get_attr.buff + total_bytes;
  1042. for (; nelem; --nelem) {
  1043. struct osd_attributes_list_attrid *attrid;
  1044. const unsigned cur_size = sizeof(*attrid);
  1045. total_bytes += cur_size;
  1046. if (unlikely(or->enc_get_attr.alloc_size < total_bytes)) {
  1047. or->enc_get_attr.total_bytes = total_bytes - cur_size;
  1048. ret = _alloc_get_attr_desc(or,
  1049. total_bytes + nelem * sizeof(*attrid));
  1050. if (ret)
  1051. return ret;
  1052. attr_last = or->enc_get_attr.buff +
  1053. or->enc_get_attr.total_bytes;
  1054. }
  1055. attrid = attr_last;
  1056. attrid->attr_page = cpu_to_be32(oa->attr_page);
  1057. attrid->attr_id = cpu_to_be32(oa->attr_id);
  1058. attr_last += cur_size;
  1059. /* calc data-in size */
  1060. or->get_attr.total_bytes +=
  1061. _osd_req_alist_elem_size(or, oa->len);
  1062. ++oa;
  1063. }
  1064. or->enc_get_attr.total_bytes = total_bytes;
  1065. OSD_DEBUG(
  1066. "get_attr.total_bytes=%u(%u) enc_get_attr.total_bytes=%u(%Zu)\n",
  1067. or->get_attr.total_bytes,
  1068. or->get_attr.total_bytes - _osd_req_sizeof_alist_header(or),
  1069. or->enc_get_attr.total_bytes,
  1070. (or->enc_get_attr.total_bytes - _osd_req_sizeof_alist_header(or))
  1071. / sizeof(struct osd_attributes_list_attrid));
  1072. return 0;
  1073. }
  1074. EXPORT_SYMBOL(osd_req_add_get_attr_list);
  1075. static int _osd_req_finalize_get_attr_list(struct osd_request *or)
  1076. {
  1077. struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
  1078. unsigned out_padding;
  1079. unsigned in_padding;
  1080. int ret;
  1081. if (!or->enc_get_attr.total_bytes) {
  1082. cdbh->attrs_list.get_attr_desc_offset = OSD_OFFSET_UNUSED;
  1083. cdbh->attrs_list.get_attr_offset = OSD_OFFSET_UNUSED;
  1084. return 0;
  1085. }
  1086. ret = _alloc_get_attr_list(or);
  1087. if (ret)
  1088. return ret;
  1089. /* The out-going buffer info update */
  1090. OSD_DEBUG("out-going\n");
  1091. cdbh->attrs_list.get_attr_desc_bytes =
  1092. cpu_to_be32(or->enc_get_attr.total_bytes);
  1093. cdbh->attrs_list.get_attr_desc_offset =
  1094. osd_req_encode_offset(or, or->out.total_bytes, &out_padding);
  1095. ret = _req_append_segment(or, out_padding, &or->enc_get_attr,
  1096. or->out.last_seg, &or->out);
  1097. if (ret)
  1098. return ret;
  1099. or->out.last_seg = &or->enc_get_attr;
  1100. /* The incoming buffer info update */
  1101. OSD_DEBUG("in-coming\n");
  1102. cdbh->attrs_list.get_attr_alloc_length =
  1103. cpu_to_be32(or->get_attr.total_bytes);
  1104. cdbh->attrs_list.get_attr_offset =
  1105. osd_req_encode_offset(or, or->in.total_bytes, &in_padding);
  1106. ret = _req_append_segment(or, in_padding, &or->get_attr, NULL,
  1107. &or->in);
  1108. if (ret)
  1109. return ret;
  1110. or->in.last_seg = &or->get_attr;
  1111. return 0;
  1112. }
  1113. int osd_req_decode_get_attr_list(struct osd_request *or,
  1114. struct osd_attr *oa, int *nelem, void **iterator)
  1115. {
  1116. unsigned cur_bytes, returned_bytes;
  1117. int n;
  1118. const unsigned sizeof_attr_list = _osd_req_sizeof_alist_header(or);
  1119. void *cur_p;
  1120. if (!_osd_req_is_alist_type(or, or->get_attr.buff,
  1121. OSD_ATTR_LIST_SET_RETRIEVE)) {
  1122. oa->attr_page = 0;
  1123. oa->attr_id = 0;
  1124. oa->val_ptr = NULL;
  1125. oa->len = 0;
  1126. *iterator = NULL;
  1127. return 0;
  1128. }
  1129. if (*iterator) {
  1130. BUG_ON((*iterator < or->get_attr.buff) ||
  1131. (or->get_attr.buff + or->get_attr.alloc_size < *iterator));
  1132. cur_p = *iterator;
  1133. cur_bytes = (*iterator - or->get_attr.buff) - sizeof_attr_list;
  1134. returned_bytes = or->get_attr.total_bytes;
  1135. } else { /* first time decode the list header */
  1136. cur_bytes = sizeof_attr_list;
  1137. returned_bytes = _osd_req_alist_size(or, or->get_attr.buff) +
  1138. sizeof_attr_list;
  1139. cur_p = or->get_attr.buff + sizeof_attr_list;
  1140. if (returned_bytes > or->get_attr.alloc_size) {
  1141. OSD_DEBUG("target report: space was not big enough! "
  1142. "Allocate=%u Needed=%u\n",
  1143. or->get_attr.alloc_size,
  1144. returned_bytes + sizeof_attr_list);
  1145. returned_bytes =
  1146. or->get_attr.alloc_size - sizeof_attr_list;
  1147. }
  1148. or->get_attr.total_bytes = returned_bytes;
  1149. }
  1150. for (n = 0; (n < *nelem) && (cur_bytes < returned_bytes); ++n) {
  1151. int inc = _osd_req_alist_elem_decode(or, cur_p, oa,
  1152. returned_bytes - cur_bytes);
  1153. if (inc < 0) {
  1154. OSD_ERR("BAD FOOD from target. list not valid!"
  1155. "c=%d r=%d n=%d\n",
  1156. cur_bytes, returned_bytes, n);
  1157. oa->val_ptr = NULL;
  1158. cur_bytes = returned_bytes; /* break the caller loop */
  1159. break;
  1160. }
  1161. cur_bytes += inc;
  1162. cur_p += inc;
  1163. ++oa;
  1164. }
  1165. *iterator = (returned_bytes - cur_bytes) ? cur_p : NULL;
  1166. *nelem = n;
  1167. return returned_bytes - cur_bytes;
  1168. }
  1169. EXPORT_SYMBOL(osd_req_decode_get_attr_list);
  1170. /*
  1171. * Attributes Page-mode
  1172. */
  1173. int osd_req_add_get_attr_page(struct osd_request *or,
  1174. u32 page_id, void *attar_page, unsigned max_page_len,
  1175. const struct osd_attr *set_one_attr)
  1176. {
  1177. struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
  1178. if (or->attributes_mode &&
  1179. or->attributes_mode != OSD_CDB_GET_ATTR_PAGE_SET_ONE) {
  1180. WARN_ON(1);
  1181. return -EINVAL;
  1182. }
  1183. or->attributes_mode = OSD_CDB_GET_ATTR_PAGE_SET_ONE;
  1184. or->get_attr.buff = attar_page;
  1185. or->get_attr.total_bytes = max_page_len;
  1186. cdbh->attrs_page.get_attr_page = cpu_to_be32(page_id);
  1187. cdbh->attrs_page.get_attr_alloc_length = cpu_to_be32(max_page_len);
  1188. if (!set_one_attr || !set_one_attr->attr_page)
  1189. return 0; /* The set is optional */
  1190. or->set_attr.buff = set_one_attr->val_ptr;
  1191. or->set_attr.total_bytes = set_one_attr->len;
  1192. cdbh->attrs_page.set_attr_page = cpu_to_be32(set_one_attr->attr_page);
  1193. cdbh->attrs_page.set_attr_id = cpu_to_be32(set_one_attr->attr_id);
  1194. cdbh->attrs_page.set_attr_length = cpu_to_be32(set_one_attr->len);
  1195. return 0;
  1196. }
  1197. EXPORT_SYMBOL(osd_req_add_get_attr_page);
  1198. static int _osd_req_finalize_attr_page(struct osd_request *or)
  1199. {
  1200. struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
  1201. unsigned in_padding, out_padding;
  1202. int ret;
  1203. /* returned page */
  1204. cdbh->attrs_page.get_attr_offset =
  1205. osd_req_encode_offset(or, or->in.total_bytes, &in_padding);
  1206. ret = _req_append_segment(or, in_padding, &or->get_attr, NULL,
  1207. &or->in);
  1208. if (ret)
  1209. return ret;
  1210. if (or->set_attr.total_bytes == 0)
  1211. return 0;
  1212. /* set one value */
  1213. cdbh->attrs_page.set_attr_offset =
  1214. osd_req_encode_offset(or, or->out.total_bytes, &out_padding);
  1215. ret = _req_append_segment(or, out_padding, &or->set_attr, NULL,
  1216. &or->out);
  1217. return ret;
  1218. }
  1219. static inline void osd_sec_parms_set_out_offset(bool is_v1,
  1220. struct osd_security_parameters *sec_parms, osd_cdb_offset offset)
  1221. {
  1222. if (is_v1)
  1223. sec_parms->v1.data_out_integrity_check_offset = offset;
  1224. else
  1225. sec_parms->v2.data_out_integrity_check_offset = offset;
  1226. }
  1227. static inline void osd_sec_parms_set_in_offset(bool is_v1,
  1228. struct osd_security_parameters *sec_parms, osd_cdb_offset offset)
  1229. {
  1230. if (is_v1)
  1231. sec_parms->v1.data_in_integrity_check_offset = offset;
  1232. else
  1233. sec_parms->v2.data_in_integrity_check_offset = offset;
  1234. }
  1235. static int _osd_req_finalize_data_integrity(struct osd_request *or,
  1236. bool has_in, bool has_out, struct bio *out_data_bio, u64 out_data_bytes,
  1237. const u8 *cap_key)
  1238. {
  1239. struct osd_security_parameters *sec_parms = _osd_req_sec_params(or);
  1240. int ret;
  1241. if (!osd_is_sec_alldata(sec_parms))
  1242. return 0;
  1243. if (has_out) {
  1244. struct _osd_req_data_segment seg = {
  1245. .buff = &or->out_data_integ,
  1246. .total_bytes = sizeof(or->out_data_integ),
  1247. };
  1248. unsigned pad;
  1249. or->out_data_integ.data_bytes = cpu_to_be64(out_data_bytes);
  1250. or->out_data_integ.set_attributes_bytes = cpu_to_be64(
  1251. or->set_attr.total_bytes);
  1252. or->out_data_integ.get_attributes_bytes = cpu_to_be64(
  1253. or->enc_get_attr.total_bytes);
  1254. osd_sec_parms_set_out_offset(osd_req_is_ver1(or), sec_parms,
  1255. osd_req_encode_offset(or, or->out.total_bytes, &pad));
  1256. ret = _req_append_segment(or, pad, &seg, or->out.last_seg,
  1257. &or->out);
  1258. if (ret)
  1259. return ret;
  1260. or->out.last_seg = NULL;
  1261. /* they are now all chained to request sign them all together */
  1262. osd_sec_sign_data(&or->out_data_integ, out_data_bio,
  1263. cap_key);
  1264. }
  1265. if (has_in) {
  1266. struct _osd_req_data_segment seg = {
  1267. .buff = &or->in_data_integ,
  1268. .total_bytes = sizeof(or->in_data_integ),
  1269. };
  1270. unsigned pad;
  1271. osd_sec_parms_set_in_offset(osd_req_is_ver1(or), sec_parms,
  1272. osd_req_encode_offset(or, or->in.total_bytes, &pad));
  1273. ret = _req_append_segment(or, pad, &seg, or->in.last_seg,
  1274. &or->in);
  1275. if (ret)
  1276. return ret;
  1277. or->in.last_seg = NULL;
  1278. }
  1279. return 0;
  1280. }
  1281. /*
  1282. * osd_finalize_request and helpers
  1283. */
  1284. static struct request *_make_request(struct request_queue *q, bool has_write,
  1285. struct _osd_io_info *oii, gfp_t flags)
  1286. {
  1287. if (oii->bio)
  1288. return blk_make_request(q, oii->bio, flags);
  1289. else {
  1290. struct request *req;
  1291. req = blk_get_request(q, has_write ? WRITE : READ, flags);
  1292. if (unlikely(!req))
  1293. return ERR_PTR(-ENOMEM);
  1294. return req;
  1295. }
  1296. }
  1297. static int _init_blk_request(struct osd_request *or,
  1298. bool has_in, bool has_out)
  1299. {
  1300. gfp_t flags = or->alloc_flags;
  1301. struct scsi_device *scsi_device = or->osd_dev->scsi_device;
  1302. struct request_queue *q = scsi_device->request_queue;
  1303. struct request *req;
  1304. int ret;
  1305. req = _make_request(q, has_out, has_out ? &or->out : &or->in, flags);
  1306. if (IS_ERR(req)) {
  1307. ret = PTR_ERR(req);
  1308. goto out;
  1309. }
  1310. or->request = req;
  1311. req->cmd_type = REQ_TYPE_BLOCK_PC;
  1312. req->cmd_flags |= REQ_QUIET;
  1313. req->timeout = or->timeout;
  1314. req->retries = or->retries;
  1315. req->sense = or->sense;
  1316. req->sense_len = 0;
  1317. if (has_out) {
  1318. or->out.req = req;
  1319. if (has_in) {
  1320. /* allocate bidi request */
  1321. req = _make_request(q, false, &or->in, flags);
  1322. if (IS_ERR(req)) {
  1323. OSD_DEBUG("blk_get_request for bidi failed\n");
  1324. ret = PTR_ERR(req);
  1325. goto out;
  1326. }
  1327. req->cmd_type = REQ_TYPE_BLOCK_PC;
  1328. or->in.req = or->request->next_rq = req;
  1329. }
  1330. } else if (has_in)
  1331. or->in.req = req;
  1332. ret = 0;
  1333. out:
  1334. OSD_DEBUG("or=%p has_in=%d has_out=%d => %d, %p\n",
  1335. or, has_in, has_out, ret, or->request);
  1336. return ret;
  1337. }
  1338. int osd_finalize_request(struct osd_request *or,
  1339. u8 options, const void *cap, const u8 *cap_key)
  1340. {
  1341. struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
  1342. bool has_in, has_out;
  1343. /* Save for data_integrity without the cdb_continuation */
  1344. struct bio *out_data_bio = or->out.bio;
  1345. u64 out_data_bytes = or->out.total_bytes;
  1346. int ret;
  1347. if (options & OSD_REQ_FUA)
  1348. cdbh->options |= OSD_CDB_FUA;
  1349. if (options & OSD_REQ_DPO)
  1350. cdbh->options |= OSD_CDB_DPO;
  1351. if (options & OSD_REQ_BYPASS_TIMESTAMPS)
  1352. cdbh->timestamp_control = OSD_CDB_BYPASS_TIMESTAMPS;
  1353. osd_set_caps(&or->cdb, cap);
  1354. has_in = or->in.bio || or->get_attr.total_bytes;
  1355. has_out = or->out.bio || or->cdb_cont.total_bytes ||
  1356. or->set_attr.total_bytes || or->enc_get_attr.total_bytes;
  1357. ret = _osd_req_finalize_cdb_cont(or, cap_key);
  1358. if (ret) {
  1359. OSD_DEBUG("_osd_req_finalize_cdb_cont failed\n");
  1360. return ret;
  1361. }
  1362. ret = _init_blk_request(or, has_in, has_out);
  1363. if (ret) {
  1364. OSD_DEBUG("_init_blk_request failed\n");
  1365. return ret;
  1366. }
  1367. or->out.pad_buff = sg_out_pad_buffer;
  1368. or->in.pad_buff = sg_in_pad_buffer;
  1369. if (!or->attributes_mode)
  1370. or->attributes_mode = OSD_CDB_GET_SET_ATTR_LISTS;
  1371. cdbh->command_specific_options |= or->attributes_mode;
  1372. if (or->attributes_mode == OSD_CDB_GET_ATTR_PAGE_SET_ONE) {
  1373. ret = _osd_req_finalize_attr_page(or);
  1374. if (ret) {
  1375. OSD_DEBUG("_osd_req_finalize_attr_page failed\n");
  1376. return ret;
  1377. }
  1378. } else {
  1379. /* TODO: I think that for the GET_ATTR command these 2 should
  1380. * be reversed to keep them in execution order (for embeded
  1381. * targets with low memory footprint)
  1382. */
  1383. ret = _osd_req_finalize_set_attr_list(or);
  1384. if (ret) {
  1385. OSD_DEBUG("_osd_req_finalize_set_attr_list failed\n");
  1386. return ret;
  1387. }
  1388. ret = _osd_req_finalize_get_attr_list(or);
  1389. if (ret) {
  1390. OSD_DEBUG("_osd_req_finalize_get_attr_list failed\n");
  1391. return ret;
  1392. }
  1393. }
  1394. ret = _osd_req_finalize_data_integrity(or, has_in, has_out,
  1395. out_data_bio, out_data_bytes,
  1396. cap_key);
  1397. if (ret)
  1398. return ret;
  1399. osd_sec_sign_cdb(&or->cdb, cap_key);
  1400. or->request->cmd = or->cdb.buff;
  1401. or->request->cmd_len = _osd_req_cdb_len(or);
  1402. return 0;
  1403. }
  1404. EXPORT_SYMBOL(osd_finalize_request);
  1405. static bool _is_osd_security_code(int code)
  1406. {
  1407. return (code == osd_security_audit_value_frozen) ||
  1408. (code == osd_security_working_key_frozen) ||
  1409. (code == osd_nonce_not_unique) ||
  1410. (code == osd_nonce_timestamp_out_of_range) ||
  1411. (code == osd_invalid_dataout_buffer_integrity_check_value);
  1412. }
  1413. #define OSD_SENSE_PRINT1(fmt, a...) \
  1414. do { \
  1415. if (__cur_sense_need_output) \
  1416. OSD_ERR(fmt, ##a); \
  1417. } while (0)
  1418. #define OSD_SENSE_PRINT2(fmt, a...) OSD_SENSE_PRINT1(" " fmt, ##a)
  1419. int osd_req_decode_sense_full(struct osd_request *or,
  1420. struct osd_sense_info *osi, bool silent,
  1421. struct osd_obj_id *bad_obj_list __unused, int max_obj __unused,
  1422. struct osd_attr *bad_attr_list, int max_attr)
  1423. {
  1424. int sense_len, original_sense_len;
  1425. struct osd_sense_info local_osi;
  1426. struct scsi_sense_descriptor_based *ssdb;
  1427. void *cur_descriptor;
  1428. #if (CONFIG_SCSI_OSD_DPRINT_SENSE == 0)
  1429. const bool __cur_sense_need_output = false;
  1430. #else
  1431. bool __cur_sense_need_output = !silent;
  1432. #endif
  1433. int ret;
  1434. if (likely(!or->req_errors))
  1435. return 0;
  1436. osi = osi ? : &local_osi;
  1437. memset(osi, 0, sizeof(*osi));
  1438. ssdb = (typeof(ssdb))or->sense;
  1439. sense_len = or->sense_len;
  1440. if ((sense_len < (int)sizeof(*ssdb) || !ssdb->sense_key)) {
  1441. OSD_ERR("Block-layer returned error(0x%x) but "
  1442. "sense_len(%u) || key(%d) is empty\n",
  1443. or->req_errors, sense_len, ssdb->sense_key);
  1444. goto analyze;
  1445. }
  1446. if ((ssdb->response_code != 0x72) && (ssdb->response_code != 0x73)) {
  1447. OSD_ERR("Unrecognized scsi sense: rcode=%x length=%d\n",
  1448. ssdb->response_code, sense_len);
  1449. goto analyze;
  1450. }
  1451. osi->key = ssdb->sense_key;
  1452. osi->additional_code = be16_to_cpu(ssdb->additional_sense_code);
  1453. original_sense_len = ssdb->additional_sense_length + 8;
  1454. #if (CONFIG_SCSI_OSD_DPRINT_SENSE == 1)
  1455. if (__cur_sense_need_output)
  1456. __cur_sense_need_output = (osi->key > scsi_sk_recovered_error);
  1457. #endif
  1458. OSD_SENSE_PRINT1("Main Sense information key=0x%x length(%d, %d) "
  1459. "additional_code=0x%x async_error=%d errors=0x%x\n",
  1460. osi->key, original_sense_len, sense_len,
  1461. osi->additional_code, or->async_error,
  1462. or->req_errors);
  1463. if (original_sense_len < sense_len)
  1464. sense_len = original_sense_len;
  1465. cur_descriptor = ssdb->ssd;
  1466. sense_len -= sizeof(*ssdb);
  1467. while (sense_len > 0) {
  1468. struct scsi_sense_descriptor *ssd = cur_descriptor;
  1469. int cur_len = ssd->additional_length + 2;
  1470. sense_len -= cur_len;
  1471. if (sense_len < 0)
  1472. break; /* sense was truncated */
  1473. switch (ssd->descriptor_type) {
  1474. case scsi_sense_information:
  1475. case scsi_sense_command_specific_information:
  1476. {
  1477. struct scsi_sense_command_specific_data_descriptor
  1478. *sscd = cur_descriptor;
  1479. osi->command_info =
  1480. get_unaligned_be64(&sscd->information) ;
  1481. OSD_SENSE_PRINT2(
  1482. "command_specific_information 0x%llx \n",
  1483. _LLU(osi->command_info));
  1484. break;
  1485. }
  1486. case scsi_sense_key_specific:
  1487. {
  1488. struct scsi_sense_key_specific_data_descriptor
  1489. *ssks = cur_descriptor;
  1490. osi->sense_info = get_unaligned_be16(&ssks->value);
  1491. OSD_SENSE_PRINT2(
  1492. "sense_key_specific_information %u"
  1493. "sksv_cd_bpv_bp (0x%x)\n",
  1494. osi->sense_info, ssks->sksv_cd_bpv_bp);
  1495. break;
  1496. }
  1497. case osd_sense_object_identification:
  1498. { /*FIXME: Keep first not last, Store in array*/
  1499. struct osd_sense_identification_data_descriptor
  1500. *osidd = cur_descriptor;
  1501. osi->not_initiated_command_functions =
  1502. le32_to_cpu(osidd->not_initiated_functions);
  1503. osi->completed_command_functions =
  1504. le32_to_cpu(osidd->completed_functions);
  1505. osi->obj.partition = be64_to_cpu(osidd->partition_id);
  1506. osi->obj.id = be64_to_cpu(osidd->object_id);
  1507. OSD_SENSE_PRINT2(
  1508. "object_identification pid=0x%llx oid=0x%llx\n",
  1509. _LLU(osi->obj.partition), _LLU(osi->obj.id));
  1510. OSD_SENSE_PRINT2(
  1511. "not_initiated_bits(%x) "
  1512. "completed_command_bits(%x)\n",
  1513. osi->not_initiated_command_functions,
  1514. osi->completed_command_functions);
  1515. break;
  1516. }
  1517. case osd_sense_response_integrity_check:
  1518. {
  1519. struct osd_sense_response_integrity_check_descriptor
  1520. *osricd = cur_descriptor;
  1521. const unsigned len =
  1522. sizeof(osricd->integrity_check_value);
  1523. char key_dump[len*4 + 2]; /* 2nibbles+space+ASCII */
  1524. hex_dump_to_buffer(osricd->integrity_check_value, len,
  1525. 32, 1, key_dump, sizeof(key_dump), true);
  1526. OSD_SENSE_PRINT2("response_integrity [%s]\n", key_dump);
  1527. }
  1528. case osd_sense_attribute_identification:
  1529. {
  1530. struct osd_sense_attributes_data_descriptor
  1531. *osadd = cur_descriptor;
  1532. unsigned len = min(cur_len, sense_len);
  1533. struct osd_sense_attr *pattr = osadd->sense_attrs;
  1534. while (len >= sizeof(*pattr)) {
  1535. u32 attr_page = be32_to_cpu(pattr->attr_page);
  1536. u32 attr_id = be32_to_cpu(pattr->attr_id);
  1537. if (!osi->attr.attr_page) {
  1538. osi->attr.attr_page = attr_page;
  1539. osi->attr.attr_id = attr_id;
  1540. }
  1541. if (bad_attr_list && max_attr) {
  1542. bad_attr_list->attr_page = attr_page;
  1543. bad_attr_list->attr_id = attr_id;
  1544. bad_attr_list++;
  1545. max_attr--;
  1546. }
  1547. len -= sizeof(*pattr);
  1548. OSD_SENSE_PRINT2(
  1549. "osd_sense_attribute_identification"
  1550. "attr_page=0x%x attr_id=0x%x\n",
  1551. attr_page, attr_id);
  1552. }
  1553. }
  1554. /*These are not legal for OSD*/
  1555. case scsi_sense_field_replaceable_unit:
  1556. OSD_SENSE_PRINT2("scsi_sense_field_replaceable_unit\n");
  1557. break;
  1558. case scsi_sense_stream_commands:
  1559. OSD_SENSE_PRINT2("scsi_sense_stream_commands\n");
  1560. break;
  1561. case scsi_sense_block_commands:
  1562. OSD_SENSE_PRINT2("scsi_sense_block_commands\n");
  1563. break;
  1564. case scsi_sense_ata_return:
  1565. OSD_SENSE_PRINT2("scsi_sense_ata_return\n");
  1566. break;
  1567. default:
  1568. if (ssd->descriptor_type <= scsi_sense_Reserved_last)
  1569. OSD_SENSE_PRINT2(
  1570. "scsi_sense Reserved descriptor (0x%x)",
  1571. ssd->descriptor_type);
  1572. else
  1573. OSD_SENSE_PRINT2(
  1574. "scsi_sense Vendor descriptor (0x%x)",
  1575. ssd->descriptor_type);
  1576. }
  1577. cur_descriptor += cur_len;
  1578. }
  1579. analyze:
  1580. if (!osi->key) {
  1581. /* scsi sense is Empty, the request was never issued to target
  1582. * linux return code might tell us what happened.
  1583. */
  1584. if (or->async_error == -ENOMEM)
  1585. osi->osd_err_pri = OSD_ERR_PRI_RESOURCE;
  1586. else
  1587. osi->osd_err_pri = OSD_ERR_PRI_UNREACHABLE;
  1588. ret = or->async_error;
  1589. } else if (osi->key <= scsi_sk_recovered_error) {
  1590. osi->osd_err_pri = 0;
  1591. ret = 0;
  1592. } else if (osi->additional_code == scsi_invalid_field_in_cdb) {
  1593. if (osi->cdb_field_offset == OSD_CFO_STARTING_BYTE) {
  1594. osi->osd_err_pri = OSD_ERR_PRI_CLEAR_PAGES;
  1595. ret = -EFAULT; /* caller should recover from this */
  1596. } else if (osi->cdb_field_offset == OSD_CFO_OBJECT_ID) {
  1597. osi->osd_err_pri = OSD_ERR_PRI_NOT_FOUND;
  1598. ret = -ENOENT;
  1599. } else if (osi->cdb_field_offset == OSD_CFO_PERMISSIONS) {
  1600. osi->osd_err_pri = OSD_ERR_PRI_NO_ACCESS;
  1601. ret = -EACCES;
  1602. } else {
  1603. osi->osd_err_pri = OSD_ERR_PRI_BAD_CRED;
  1604. ret = -EINVAL;
  1605. }
  1606. } else if (osi->additional_code == osd_quota_error) {
  1607. osi->osd_err_pri = OSD_ERR_PRI_NO_SPACE;
  1608. ret = -ENOSPC;
  1609. } else if (_is_osd_security_code(osi->additional_code)) {
  1610. osi->osd_err_pri = OSD_ERR_PRI_BAD_CRED;
  1611. ret = -EINVAL;
  1612. } else {
  1613. osi->osd_err_pri = OSD_ERR_PRI_EIO;
  1614. ret = -EIO;
  1615. }
  1616. if (!or->out.residual)
  1617. or->out.residual = or->out.total_bytes;
  1618. if (!or->in.residual)
  1619. or->in.residual = or->in.total_bytes;
  1620. return ret;
  1621. }
  1622. EXPORT_SYMBOL(osd_req_decode_sense_full);
  1623. /*
  1624. * Implementation of osd_sec.h API
  1625. * TODO: Move to a separate osd_sec.c file at a later stage.
  1626. */
  1627. enum { OSD_SEC_CAP_V1_ALL_CAPS =
  1628. OSD_SEC_CAP_APPEND | OSD_SEC_CAP_OBJ_MGMT | OSD_SEC_CAP_REMOVE |
  1629. OSD_SEC_CAP_CREATE | OSD_SEC_CAP_SET_ATTR | OSD_SEC_CAP_GET_ATTR |
  1630. OSD_SEC_CAP_WRITE | OSD_SEC_CAP_READ | OSD_SEC_CAP_POL_SEC |
  1631. OSD_SEC_CAP_GLOBAL | OSD_SEC_CAP_DEV_MGMT
  1632. };
  1633. enum { OSD_SEC_CAP_V2_ALL_CAPS =
  1634. OSD_SEC_CAP_V1_ALL_CAPS | OSD_SEC_CAP_QUERY | OSD_SEC_CAP_M_OBJECT
  1635. };
  1636. void osd_sec_init_nosec_doall_caps(void *caps,
  1637. const struct osd_obj_id *obj, bool is_collection, const bool is_v1)
  1638. {
  1639. struct osd_capability *cap = caps;
  1640. u8 type;
  1641. u8 descriptor_type;
  1642. if (likely(obj->id)) {
  1643. if (unlikely(is_collection)) {
  1644. type = OSD_SEC_OBJ_COLLECTION;
  1645. descriptor_type = is_v1 ? OSD_SEC_OBJ_DESC_OBJ :
  1646. OSD_SEC_OBJ_DESC_COL;
  1647. } else {
  1648. type = OSD_SEC_OBJ_USER;
  1649. descriptor_type = OSD_SEC_OBJ_DESC_OBJ;
  1650. }
  1651. WARN_ON(!obj->partition);
  1652. } else {
  1653. type = obj->partition ? OSD_SEC_OBJ_PARTITION :
  1654. OSD_SEC_OBJ_ROOT;
  1655. descriptor_type = OSD_SEC_OBJ_DESC_PAR;
  1656. }
  1657. memset(cap, 0, sizeof(*cap));
  1658. cap->h.format = OSD_SEC_CAP_FORMAT_VER1;
  1659. cap->h.integrity_algorithm__key_version = 0; /* MAKE_BYTE(0, 0); */
  1660. cap->h.security_method = OSD_SEC_NOSEC;
  1661. /* cap->expiration_time;
  1662. cap->AUDIT[30-10];
  1663. cap->discriminator[42-30];
  1664. cap->object_created_time; */
  1665. cap->h.object_type = type;
  1666. osd_sec_set_caps(&cap->h, OSD_SEC_CAP_V1_ALL_CAPS);
  1667. cap->h.object_descriptor_type = descriptor_type;
  1668. cap->od.obj_desc.policy_access_tag = 0;
  1669. cap->od.obj_desc.allowed_partition_id = cpu_to_be64(obj->partition);
  1670. cap->od.obj_desc.allowed_object_id = cpu_to_be64(obj->id);
  1671. }
  1672. EXPORT_SYMBOL(osd_sec_init_nosec_doall_caps);
  1673. /* FIXME: Extract version from caps pointer.
  1674. * Also Pete's target only supports caps from OSDv1 for now
  1675. */
  1676. void osd_set_caps(struct osd_cdb *cdb, const void *caps)
  1677. {
  1678. bool is_ver1 = true;
  1679. /* NOTE: They start at same address */
  1680. memcpy(&cdb->v1.caps, caps, is_ver1 ? OSDv1_CAP_LEN : OSD_CAP_LEN);
  1681. }
  1682. bool osd_is_sec_alldata(struct osd_security_parameters *sec_parms __unused)
  1683. {
  1684. return false;
  1685. }
  1686. void osd_sec_sign_cdb(struct osd_cdb *ocdb __unused, const u8 *cap_key __unused)
  1687. {
  1688. }
  1689. void osd_sec_sign_data(void *data_integ __unused,
  1690. struct bio *bio __unused, const u8 *cap_key __unused)
  1691. {
  1692. }
  1693. /*
  1694. * Declared in osd_protocol.h
  1695. * 4.12.5 Data-In and Data-Out buffer offsets
  1696. * byte offset = mantissa * (2^(exponent+8))
  1697. * Returns the smallest allowed encoded offset that contains given @offset
  1698. * The actual encoded offset returned is @offset + *@padding.
  1699. */
  1700. osd_cdb_offset __osd_encode_offset(
  1701. u64 offset, unsigned *padding, int min_shift, int max_shift)
  1702. {
  1703. u64 try_offset = -1, mod, align;
  1704. osd_cdb_offset be32_offset;
  1705. int shift;
  1706. *padding = 0;
  1707. if (!offset)
  1708. return 0;
  1709. for (shift = min_shift; shift < max_shift; ++shift) {
  1710. try_offset = offset >> shift;
  1711. if (try_offset < (1 << OSD_OFFSET_MAX_BITS))
  1712. break;
  1713. }
  1714. BUG_ON(shift == max_shift);
  1715. align = 1 << shift;
  1716. mod = offset & (align - 1);
  1717. if (mod) {
  1718. *padding = align - mod;
  1719. try_offset += 1;
  1720. }
  1721. try_offset |= ((shift - 8) & 0xf) << 28;
  1722. be32_offset = cpu_to_be32((u32)try_offset);
  1723. OSD_DEBUG("offset=%llu mantissa=%llu exp=%d encoded=%x pad=%d\n",
  1724. _LLU(offset), _LLU(try_offset & 0x0FFFFFFF), shift,
  1725. be32_offset, *padding);
  1726. return be32_offset;
  1727. }