ceph/src/spdk/lib/iscsi/portal_grp.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (C) 2008-2012 Daisuke Aoyama <aoyama@peach.ne.jp>.
   5  *   Copyright (c) Intel Corporation.
   6  *   All rights reserved.
   7  *
   8  *   Redistribution and use in source and binary forms, with or without
   9  *   modification, are permitted provided that the following conditions
  10  *   are met:
  11  *
  12  *     * Redistributions of source code must retain the above copyright
  13  *       notice, this list of conditions and the following disclaimer.
  14  *     * Redistributions in binary form must reproduce the above copyright
  15  *       notice, this list of conditions and the following disclaimer in
  16  *       the documentation and/or other materials provided with the
  17  *       distribution.
  18  *     * Neither the name of Intel Corporation nor the names of its
  19  *       contributors may be used to endorse or promote products derived
  20  *       from this software without specific prior written permission.
  21  *
  22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #ifndef SPDK_PORTAL_GRP_H
  36 #define SPDK_PORTAL_GRP_H
  37
  38 #include "iscsi/init_grp.h"
  39
  40 struct spdk_iscsi_portal {
  41         struct spdk_iscsi_portal_grp    *group;
  42         char                            *host;
  43         char                            *port;
  44         int                             sock;
  45         uint64_t                        cpumask;
  46         TAILQ_ENTRY(spdk_iscsi_portal)  tailq;
  47 };
  48
  49 struct spdk_iscsi_portal_grp {
  50         int ref;
  51         int tag;
  52         enum group_state state;
  53         TAILQ_ENTRY(spdk_iscsi_portal_grp)      tailq;
  54         TAILQ_HEAD(, spdk_iscsi_portal)         head;
  55 };
  56
  57 /* SPDK iSCSI Portal Group management API */
  58
  59 struct spdk_iscsi_portal *spdk_iscsi_portal_create(const char *host, const char *port,
  60                 uint64_t cpumask);
  61 void spdk_iscsi_portal_destroy(struct spdk_iscsi_portal *p);
  62
  63 struct spdk_iscsi_portal_grp *spdk_iscsi_portal_grp_create(int tag);
  64 int spdk_iscsi_portal_grp_create_from_configfile(struct spdk_conf_section *sp);
  65 int spdk_iscsi_portal_grp_create_from_portal_list(int tag,
  66                 struct spdk_iscsi_portal **portal_list,
  67                 int num_portals);
  68 void spdk_iscsi_portal_grp_destroy(struct spdk_iscsi_portal_grp *pg);
  69 void spdk_iscsi_portal_grp_destroy_by_tag(int tag);
  70 void spdk_iscsi_portal_grp_release(struct spdk_iscsi_portal_grp *pg);
  71
  72 void spdk_iscsi_portal_grp_add_portal(struct spdk_iscsi_portal_grp *pg,
  73                                       struct spdk_iscsi_portal *p);
  74 void spdk_iscsi_portal_grp_delete_portal(struct spdk_iscsi_portal_grp *pg,
  75                 struct spdk_iscsi_portal *p);
  76
  77
  78 int spdk_iscsi_portal_grp_array_create(void);
  79 void spdk_iscsi_portal_grp_array_destroy(void);
  80
  81 struct spdk_iscsi_portal_grp *spdk_iscsi_portal_grp_find_by_tag(int tag);
  82
  83 int spdk_iscsi_portal_grp_open_all(void);
  84 int spdk_iscsi_portal_grp_close_all(void);
  85
  86 int spdk_iscsi_portal_grp_deletable(int tag);
  87 #endif // SPDK_PORTAL_GRP_H