ceph/src/spdk/module/bdev/ocf/utils.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (c) Intel Corporation.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef VBDEV_OCF_UTILS_H
  35 #define VBDEV_OCF_UTILS_H
  36
  37 #include <ocf/ocf.h>
  38 #include "vbdev_ocf.h"
  39
  40 ocf_cache_mode_t ocf_get_cache_mode(const char *cache_mode);
  41 const char *ocf_get_cache_modename(ocf_cache_mode_t mode);
  42
  43 /* Initiate management operation
  44  * Receives NULL terminated array of functions (path)
  45  * and callback (cb)
  46  * and callback argument (cb_arg)
  47  * This function may fail with ENOMEM or EBUSY */
  48 int vbdev_ocf_mngt_start(struct vbdev_ocf *vbdev, vbdev_ocf_mngt_fn *path,
  49                          vbdev_ocf_mngt_callback cb, void *cb_arg);
  50
  51 /* Continue execution with polling operation (fn)
  52  * fn must invoke vbdev_ocf_mngt_continue() to stop polling
  53  * Poller has default timeout of 5 seconds */
  54 void vbdev_ocf_mngt_poll(struct vbdev_ocf *vbdev, vbdev_ocf_mngt_fn fn);
  55
  56 /* Continue execution with next function that is on path
  57  * If next function is NULL, finish management operation and invoke callback */
  58 void vbdev_ocf_mngt_continue(struct vbdev_ocf *vbdev, int status);
  59
  60 /* Stop the execution, if status is non zero set it,
  61  * if rollback function is not null invoke rollback
  62  * else invoke callback with last status returned */
  63 void vbdev_ocf_mngt_stop(struct vbdev_ocf *vbdev, vbdev_ocf_mngt_fn *rollback_path, int status);
  64
  65 /* Get status */
  66 int vbdev_ocf_mngt_get_status(struct vbdev_ocf *vbdev);
  67 #endif