usr.bin/iscsictl/iscsictl.h

   1 /*-
   2  * Copyright (c) 2012 The FreeBSD Foundation
   3  * All rights reserved.
   4  *
   5  * This software was developed by Edward Tomasz Napierala under sponsorship
   6  * from the FreeBSD Foundation.
   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  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef ISCSICTL_H
  33 #define ISCSICTL_H
  34
  35 #include <sys/queue.h>
  36 #include <stdbool.h>
  37 #include <libutil.h>
  38
  39 #define DEFAULT_CONFIG_PATH             "/etc/iscsi.conf"
  40 #define DEFAULT_IQN                     "iqn.1994-09.org.freebsd:"
  41
  42 #define MAX_NAME_LEN                    223
  43 #define MAX_DATA_SEGMENT_LENGTH         65536
  44
  45 #define AUTH_METHOD_UNSPECIFIED         0
  46 #define AUTH_METHOD_NONE                1
  47 #define AUTH_METHOD_CHAP                2
  48
  49 #define DIGEST_UNSPECIFIED              0
  50 #define DIGEST_NONE                     1
  51 #define DIGEST_CRC32C                   2
  52
  53 #define SESSION_TYPE_UNSPECIFIED        0
  54 #define SESSION_TYPE_NORMAL             1
  55 #define SESSION_TYPE_DISCOVERY          2
  56
  57 #define PROTOCOL_UNSPECIFIED            0
  58 #define PROTOCOL_ISCSI                  1
  59 #define PROTOCOL_ISER                   2
  60
  61 #define ENABLE_UNSPECIFIED              0
  62 #define ENABLE_ON                       1
  63 #define ENABLE_OFF                      2
  64
  65 struct target {
  66         TAILQ_ENTRY(target)     t_next;
  67         struct conf             *t_conf;
  68         char                    *t_nickname;
  69         char                    *t_name;
  70         char                    *t_address;
  71         char                    *t_initiator_name;
  72         char                    *t_initiator_address;
  73         char                    *t_initiator_alias;
  74         int                     t_header_digest;
  75         int                     t_data_digest;
  76         int                     t_auth_method;
  77         int                     t_session_type;
  78         int                     t_enable;
  79         int                     t_protocol;
  80         char                    *t_offload;
  81         char                    *t_user;
  82         char                    *t_secret;
  83         char                    *t_mutual_user;
  84         char                    *t_mutual_secret;
  85 };
  86
  87 struct conf {
  88         TAILQ_HEAD(, target)    conf_targets;
  89 };
  90
  91 #define CONN_SESSION_TYPE_NONE          0
  92 #define CONN_SESSION_TYPE_DISCOVERY     1
  93 #define CONN_SESSION_TYPE_NORMAL        2
  94
  95 struct connection {
  96         struct target           *conn_target;
  97         int                     conn_socket;
  98         int                     conn_session_type;
  99         uint32_t                conn_cmdsn;
 100         uint32_t                conn_statsn;
 101         size_t                  conn_max_data_segment_length;
 102         size_t                  conn_max_burst_length;
 103         size_t                  conn_max_outstanding_r2t;
 104         int                     conn_header_digest;
 105         int                     conn_data_digest;
 106 };
 107
 108 struct conf     *conf_new(void);
 109 struct conf     *conf_new_from_file(const char *path);
 110 void            conf_delete(struct conf *conf);
 111 void            conf_verify(struct conf *conf);
 112
 113 struct target   *target_new(struct conf *conf);
 114 struct target   *target_find(struct conf *conf, const char *nickname);
 115 void            target_delete(struct target *ic);
 116
 117 void            print_periphs(int session_id);
 118
 119 char            *checked_strdup(const char *);
 120 bool            valid_iscsi_name(const char *name);
 121 int             parse_enable(const char *enable);
 122
 123 #endif /* !ISCSICTL_H */