include/scsi/osd_initiator.h

   1 /*
   2  * osd_initiator.h - OSD initiator API definition
   3  *
   4  * Copyright (C) 2008 Panasas Inc.  All rights reserved.
   5  *
   6  * Authors:
   7  *   Boaz Harrosh <bharrosh@panasas.com>
   8  *   Benny Halevy <bhalevy@panasas.com>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 2
  12  *
  13  */
  14 #ifndef __OSD_INITIATOR_H__
  15 #define __OSD_INITIATOR_H__
  16
  17 #include "osd_protocol.h"
  18 #include "osd_types.h"
  19
  20 #include <linux/blkdev.h>
  21
  22 /* Note: "NI" in comments below means "Not Implemented yet" */
  23
  24 /* Configure of code:
  25  * #undef if you *don't* want OSD v1 support in runtime.
  26  * If #defined the initiator will dynamically configure to encode OSD v1
  27  * CDB's if the target is detected to be OSD v1 only.
  28  * OSD v2 only commands, options, and attributes will be ignored if target
  29  * is v1 only.
  30  * If #defined will result in bigger/slower code (OK Slower maybe not)
  31  * Q: Should this be CONFIG_SCSI_OSD_VER1_SUPPORT and set from Kconfig?
  32  */
  33 #define OSD_VER1_SUPPORT y
  34
  35 enum osd_std_version {
  36         OSD_VER_NONE = 0,
  37         OSD_VER1 = 1,
  38         OSD_VER2 = 2,
  39 };
  40
  41 /*
  42  * Object-based Storage Device.
  43  * This object represents an OSD device.
  44  * It is not a full linux device in any way. It is only
  45  * a place to hang resources associated with a Linux
  46  * request Q and some default properties.
  47  */
  48 struct osd_dev {
  49         struct scsi_device *scsi_device;
  50         unsigned def_timeout;
  51
  52 #ifdef OSD_VER1_SUPPORT
  53         enum osd_std_version version;
  54 #endif
  55 };
  56
  57 /* Retrieve/return osd_dev(s) for use by Kernel clients */
  58 struct osd_dev *osduld_path_lookup(const char *dev_name); /*Use IS_ERR/ERR_PTR*/
  59 void osduld_put_device(struct osd_dev *od);
  60
  61 /* Add/remove test ioctls from external modules */
  62 typedef int (do_test_fn)(struct osd_dev *od, unsigned cmd, unsigned long arg);
  63 int osduld_register_test(unsigned ioctl, do_test_fn *do_test);
  64 void osduld_unregister_test(unsigned ioctl);
  65
  66 /* These are called by uld at probe time */
  67 void osd_dev_init(struct osd_dev *od, struct scsi_device *scsi_device);
  68 void osd_dev_fini(struct osd_dev *od);
  69
  70 /* some hi level device operations */
  71 int osd_auto_detect_ver(struct osd_dev *od, void *caps);    /* GFP_KERNEL */
  72
  73 /* we might want to use function vector in the future */
  74 static inline void osd_dev_set_ver(struct osd_dev *od, enum osd_std_version v)
  75 {
  76 #ifdef OSD_VER1_SUPPORT
  77         od->version = v;
  78 #endif
  79 }
  80
  81 struct osd_request;
  82 typedef void (osd_req_done_fn)(struct osd_request *or, void *private);
  83
  84 struct osd_request {
  85         struct osd_cdb cdb;
  86         struct osd_data_out_integrity_info out_data_integ;
  87         struct osd_data_in_integrity_info in_data_integ;
  88
  89         struct osd_dev *osd_dev;
  90         struct request *request;
  91
  92         struct _osd_req_data_segment {
  93                 void *buff;
  94                 unsigned alloc_size; /* 0 here means: don't call kfree */
  95                 unsigned total_bytes;
  96         } set_attr, enc_get_attr, get_attr;
  97
  98         struct _osd_io_info {
  99                 struct bio *bio;
 100                 u64 total_bytes;
 101                 struct request *req;
 102                 struct _osd_req_data_segment *last_seg;
 103                 u8 *pad_buff;
 104         } out, in;
 105
 106         gfp_t alloc_flags;
 107         unsigned timeout;
 108         unsigned retries;
 109         u8 sense[OSD_MAX_SENSE_LEN];
 110         enum osd_attributes_mode attributes_mode;
 111
 112         osd_req_done_fn *async_done;
 113         void *async_private;
 114         int async_error;
 115 };
 116
 117 /* OSD Version control */
 118 static inline bool osd_req_is_ver1(struct osd_request *or)
 119 {
 120 #ifdef OSD_VER1_SUPPORT
 121         return or->osd_dev->version == OSD_VER1;
 122 #else
 123         return false;
 124 #endif
 125 }
 126
 127 /*
 128  * How to use the osd library:
 129  *
 130  * osd_start_request
 131  *      Allocates a request.
 132  *
 133  * osd_req_*
 134  *      Call one of, to encode the desired operation.
 135  *
 136  * osd_add_{get,set}_attr
 137  *      Optionally add attributes to the CDB, list or page mode.
 138  *
 139  * osd_finalize_request
 140  *      Computes final data out/in offsets and signs the request,
 141  *      making it ready for execution.
 142  *
 143  * osd_execute_request
 144  *      May be called to execute it through the block layer. Other wise submit
 145  *      the associated block request in some other way.
 146  *
 147  * After execution:
 148  * osd_req_decode_sense
 149  *      Decodes sense information to verify execution results.
 150  *
 151  * osd_req_decode_get_attr
 152  *      Retrieve osd_add_get_attr_list() values if used.
 153  *
 154  * osd_end_request
 155  *      Must be called to deallocate the request.
 156  */
 157
 158 /**
 159  * osd_start_request - Allocate and initialize an osd_request
 160  *
 161  * @osd_dev:    OSD device that holds the scsi-device and default values
 162  *              that the request is associated with.
 163  * @gfp:        The allocation flags to use for request allocation, and all
 164  *              subsequent allocations. This will be stored at
 165  *              osd_request->alloc_flags, can be changed by user later
 166  *
 167  * Allocate osd_request and initialize all members to the
 168  * default/initial state.
 169  */
 170 struct osd_request *osd_start_request(struct osd_dev *od, gfp_t gfp);
 171
 172 enum osd_req_options {
 173         OSD_REQ_FUA = 0x08,     /* Force Unit Access */
 174         OSD_REQ_DPO = 0x10,     /* Disable Page Out */
 175
 176         OSD_REQ_BYPASS_TIMESTAMPS = 0x80,
 177 };
 178
 179 /**
 180  * osd_finalize_request - Sign request and prepare request for execution
 181  *
 182  * @or:         osd_request to prepare
 183  * @options:    combination of osd_req_options bit flags or 0.
 184  * @cap:        A Pointer to an OSD_CAP_LEN bytes buffer that is received from
 185  *              The security manager as capabilities for this cdb.
 186  * @cap_key:    The cryptographic key used to sign the cdb/data. Can be null
 187  *              if NOSEC is used.
 188  *
 189  * The actual request and bios are only allocated here, so are the get_attr
 190  * buffers that will receive the returned attributes. Copy's @cap to cdb.
 191  * Sign the cdb/data with @cap_key.
 192  */
 193 int osd_finalize_request(struct osd_request *or,
 194         u8 options, const void *cap, const u8 *cap_key);
 195
 196 /**
 197  * osd_execute_request - Execute the request synchronously through block-layer
 198  *
 199  * @or:         osd_request to Executed
 200  *
 201  * Calls blk_execute_rq to q the command and waits for completion.
 202  */
 203 int osd_execute_request(struct osd_request *or);
 204
 205 /**
 206  * osd_execute_request_async - Execute the request without waitting.
 207  *
 208  * @or:                      - osd_request to Executed
 209  * @done: (Optional)         - Called at end of execution
 210  * @private:                 - Will be passed to @done function
 211  *
 212  * Calls blk_execute_rq_nowait to queue the command. When execution is done
 213  * optionally calls @done with @private as parameter. @or->async_error will
 214  * have the return code
 215  */
 216 int osd_execute_request_async(struct osd_request *or,
 217         osd_req_done_fn *done, void *private);
 218
 219 /**
 220  * osd_end_request - return osd_request to free store
 221  *
 222  * @or:         osd_request to free
 223  *
 224  * Deallocate all osd_request resources (struct req's, BIOs, buffers, etc.)
 225  */
 226 void osd_end_request(struct osd_request *or);
 227
 228 /*
 229  * CDB Encoding
 230  *
 231  * Note: call only one of the following methods.
 232  */
 233
 234 /*
 235  * Device commands
 236  */
 237 void osd_req_set_master_seed_xchg(struct osd_request *or, ...);/* NI */
 238 void osd_req_set_master_key(struct osd_request *or, ...);/* NI */
 239
 240 void osd_req_format(struct osd_request *or, u64 tot_capacity);
 241
 242 /* list all partitions
 243  * @list header must be initialized to zero on first run.
 244  *
 245  * Call osd_is_obj_list_done() to find if we got the complete list.
 246  */
 247 int osd_req_list_dev_partitions(struct osd_request *or,
 248         osd_id initial_id, struct osd_obj_id_list *list, unsigned nelem);
 249
 250 void osd_req_flush_obsd(struct osd_request *or,
 251         enum osd_options_flush_scope_values);
 252
 253 void osd_req_perform_scsi_command(struct osd_request *or,
 254         const u8 *cdb, ...);/* NI */
 255 void osd_req_task_management(struct osd_request *or, ...);/* NI */
 256
 257 /*
 258  * Partition commands
 259  */
 260 void osd_req_create_partition(struct osd_request *or, osd_id partition);
 261 void osd_req_remove_partition(struct osd_request *or, osd_id partition);
 262
 263 void osd_req_set_partition_key(struct osd_request *or,
 264         osd_id partition, u8 new_key_id[OSD_CRYPTO_KEYID_SIZE],
 265         u8 seed[OSD_CRYPTO_SEED_SIZE]);/* NI */
 266
 267 /* list all collections in the partition
 268  * @list header must be init to zero on first run.
 269  *
 270  * Call osd_is_obj_list_done() to find if we got the complete list.
 271  */
 272 int osd_req_list_partition_collections(struct osd_request *or,
 273         osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
 274         unsigned nelem);
 275
 276 /* list all objects in the partition
 277  * @list header must be init to zero on first run.
 278  *
 279  * Call osd_is_obj_list_done() to find if we got the complete list.
 280  */
 281 int osd_req_list_partition_objects(struct osd_request *or,
 282         osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
 283         unsigned nelem);
 284
 285 void osd_req_flush_partition(struct osd_request *or,
 286         osd_id partition, enum osd_options_flush_scope_values);
 287
 288 /*
 289  * Collection commands
 290  */
 291 void osd_req_create_collection(struct osd_request *or,
 292         const struct osd_obj_id *);/* NI */
 293 void osd_req_remove_collection(struct osd_request *or,
 294         const struct osd_obj_id *);/* NI */
 295
 296 /* list all objects in the collection */
 297 int osd_req_list_collection_objects(struct osd_request *or,
 298         const struct osd_obj_id *, osd_id initial_id,
 299         struct osd_obj_id_list *list, unsigned nelem);
 300
 301 /* V2 only filtered list of objects in the collection */
 302 void osd_req_query(struct osd_request *or, ...);/* NI */
 303
 304 void osd_req_flush_collection(struct osd_request *or,
 305         const struct osd_obj_id *, enum osd_options_flush_scope_values);
 306
 307 void osd_req_get_member_attrs(struct osd_request *or, ...);/* V2-only NI */
 308 void osd_req_set_member_attrs(struct osd_request *or, ...);/* V2-only NI */
 309
 310 /*
 311  * Object commands
 312  */
 313 void osd_req_create_object(struct osd_request *or, struct osd_obj_id *);
 314 void osd_req_remove_object(struct osd_request *or, struct osd_obj_id *);
 315
 316 void osd_req_write(struct osd_request *or,
 317         const struct osd_obj_id *, struct bio *data_out, u64 offset);
 318 void osd_req_append(struct osd_request *or,
 319         const struct osd_obj_id *, struct bio *data_out);/* NI */
 320 void osd_req_create_write(struct osd_request *or,
 321         const struct osd_obj_id *, struct bio *data_out, u64 offset);/* NI */
 322 void osd_req_clear(struct osd_request *or,
 323         const struct osd_obj_id *, u64 offset, u64 len);/* NI */
 324 void osd_req_punch(struct osd_request *or,
 325         const struct osd_obj_id *, u64 offset, u64 len);/* V2-only NI */
 326
 327 void osd_req_flush_object(struct osd_request *or,
 328         const struct osd_obj_id *, enum osd_options_flush_scope_values,
 329         /*V2*/ u64 offset, /*V2*/ u64 len);
 330
 331 void osd_req_read(struct osd_request *or,
 332         const struct osd_obj_id *, struct bio *data_in, u64 offset);
 333
 334 /*
 335  * Root/Partition/Collection/Object Attributes commands
 336  */
 337
 338 /* get before set */
 339 void osd_req_get_attributes(struct osd_request *or, const struct osd_obj_id *);
 340
 341 /* set before get */
 342 void osd_req_set_attributes(struct osd_request *or, const struct osd_obj_id *);
 343
 344 /*
 345  * Attributes appended to most commands
 346  */
 347
 348 /* Attributes List mode (or V2 CDB) */
 349   /*
 350    * TODO: In ver2 if at finalize time only one attr was set and no gets,
 351    * then the Attributes CDB mode is used automatically to save IO.
 352    */
 353
 354 /* set a list of attributes. */
 355 int osd_req_add_set_attr_list(struct osd_request *or,
 356         const struct osd_attr *, unsigned nelem);
 357
 358 /* get a list of attributes */
 359 int osd_req_add_get_attr_list(struct osd_request *or,
 360         const struct osd_attr *, unsigned nelem);
 361
 362 /*
 363  * Attributes list decoding
 364  * Must be called after osd_request.request was executed
 365  * It is called in a loop to decode the returned get_attr
 366  * (see osd_add_get_attr)
 367  */
 368 int osd_req_decode_get_attr_list(struct osd_request *or,
 369         struct osd_attr *, int *nelem, void **iterator);
 370
 371 /* Attributes Page mode */
 372
 373 /*
 374  * Read an attribute page and optionally set one attribute
 375  *
 376  * Retrieves the attribute page directly to a user buffer.
 377  * @attr_page_data shall stay valid until end of execution.
 378  * See osd_attributes.h for common page structures
 379  */
 380 int osd_req_add_get_attr_page(struct osd_request *or,
 381         u32 page_id, void *attr_page_data, unsigned max_page_len,
 382         const struct osd_attr *set_one);
 383
 384 #endif /* __OSD_LIB_H__ */