usr.sbin/ctld/ctld.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 CTLD_H
  33 #define CTLD_H
  34
  35 #include <sys/queue.h>
  36 #include <stdbool.h>
  37 #include <libutil.h>
  38
  39 #define DEFAULT_CONFIG_PATH             "/etc/ctl.conf"
  40 #define DEFAULT_PIDFILE                 "/var/run/ctld.pid"
  41 #define DEFAULT_BLOCKSIZE               512
  42
  43 #define MAX_NAME_LEN                    223
  44 #define MAX_DATA_SEGMENT_LENGTH         (128 * 1024)
  45 #define MAX_BURST_LENGTH                16776192
  46
  47 struct auth {
  48         TAILQ_ENTRY(auth)               a_next;
  49         struct auth_group               *a_auth_group;
  50         char                            *a_user;
  51         char                            *a_secret;
  52         char                            *a_mutual_user;
  53         char                            *a_mutual_secret;
  54 };
  55
  56 struct auth_name {
  57         TAILQ_ENTRY(auth_name)          an_next;
  58         struct auth_group               *an_auth_group;
  59         char                            *an_initator_name;
  60 };
  61
  62 struct auth_portal {
  63         TAILQ_ENTRY(auth_portal)        ap_next;
  64         struct auth_group               *ap_auth_group;
  65         char                            *ap_initator_portal;
  66 };
  67
  68 #define AG_TYPE_UNKNOWN                 0
  69 #define AG_TYPE_DENY                    1
  70 #define AG_TYPE_NO_AUTHENTICATION       2
  71 #define AG_TYPE_CHAP                    3
  72 #define AG_TYPE_CHAP_MUTUAL             4
  73
  74 struct auth_group {
  75         TAILQ_ENTRY(auth_group)         ag_next;
  76         struct conf                     *ag_conf;
  77         char                            *ag_name;
  78         struct target                   *ag_target;
  79         int                             ag_type;
  80         TAILQ_HEAD(, auth)              ag_auths;
  81         TAILQ_HEAD(, auth_name)         ag_names;
  82         TAILQ_HEAD(, auth_portal)       ag_portals;
  83 };
  84
  85 struct portal {
  86         TAILQ_ENTRY(portal)             p_next;
  87         struct portal_group             *p_portal_group;
  88         bool                            p_iser;
  89         char                            *p_listen;
  90         struct addrinfo                 *p_ai;
  91
  92         TAILQ_HEAD(, target)            p_targets;
  93         int                             p_socket;
  94 };
  95
  96 struct portal_group {
  97         TAILQ_ENTRY(portal_group)       pg_next;
  98         struct conf                     *pg_conf;
  99         char                            *pg_name;
 100         struct auth_group               *pg_discovery_auth_group;
 101         bool                            pg_unassigned;
 102         TAILQ_HEAD(, portal)            pg_portals;
 103
 104         uint16_t                        pg_tag;
 105 };
 106
 107 struct lun_option {
 108         TAILQ_ENTRY(lun_option)         lo_next;
 109         struct lun                      *lo_lun;
 110         char                            *lo_name;
 111         char                            *lo_value;
 112 };
 113
 114 struct lun {
 115         TAILQ_ENTRY(lun)                l_next;
 116         TAILQ_HEAD(, lun_option)        l_options;
 117         struct target                   *l_target;
 118         int                             l_lun;
 119         char                            *l_backend;
 120         int                             l_blocksize;
 121         char                            *l_device_id;
 122         char                            *l_path;
 123         char                            *l_serial;
 124         int64_t                         l_size;
 125
 126         int                             l_ctl_lun;
 127 };
 128
 129 struct target {
 130         TAILQ_ENTRY(target)             t_next;
 131         TAILQ_HEAD(, lun)               t_luns;
 132         struct conf                     *t_conf;
 133         struct auth_group               *t_auth_group;
 134         struct portal_group             *t_portal_group;
 135         char                            *t_name;
 136         char                            *t_alias;
 137 };
 138
 139 struct conf {
 140         char                            *conf_pidfile_path;
 141         TAILQ_HEAD(, target)            conf_targets;
 142         TAILQ_HEAD(, auth_group)        conf_auth_groups;
 143         TAILQ_HEAD(, portal_group)      conf_portal_groups;
 144         int                             conf_debug;
 145         int                             conf_timeout;
 146         int                             conf_maxproc;
 147
 148         uint16_t                        conf_last_portal_group_tag;
 149         struct pidfh                    *conf_pidfh;
 150
 151         bool                            conf_default_pg_defined;
 152         bool                            conf_default_ag_defined;
 153 };
 154
 155 #define CONN_SESSION_TYPE_NONE          0
 156 #define CONN_SESSION_TYPE_DISCOVERY     1
 157 #define CONN_SESSION_TYPE_NORMAL        2
 158
 159 #define CONN_DIGEST_NONE                0
 160 #define CONN_DIGEST_CRC32C              1
 161
 162 struct connection {
 163         struct portal           *conn_portal;
 164         struct target           *conn_target;
 165         int                     conn_socket;
 166         int                     conn_session_type;
 167         char                    *conn_initiator_name;
 168         char                    *conn_initiator_addr;
 169         char                    *conn_initiator_alias;
 170         uint32_t                conn_cmdsn;
 171         uint32_t                conn_statsn;
 172         size_t                  conn_max_data_segment_length;
 173         size_t                  conn_max_burst_length;
 174         int                     conn_immediate_data;
 175         int                     conn_header_digest;
 176         int                     conn_data_digest;
 177 };
 178
 179 struct pdu {
 180         struct connection       *pdu_connection;
 181         struct iscsi_bhs        *pdu_bhs;
 182         char                    *pdu_data;
 183         size_t                  pdu_data_len;
 184 };
 185
 186 #define KEYS_MAX        1024
 187
 188 struct keys {
 189         char            *keys_names[KEYS_MAX];
 190         char            *keys_values[KEYS_MAX];
 191         char            *keys_data;
 192         size_t          keys_data_len;
 193 };
 194
 195 struct conf             *conf_new(void);
 196 struct conf             *conf_new_from_file(const char *path);
 197 struct conf             *conf_new_from_kernel(void);
 198 void                    conf_delete(struct conf *conf);
 199 int                     conf_verify(struct conf *conf);
 200
 201 struct auth_group       *auth_group_new(struct conf *conf, const char *name);
 202 void                    auth_group_delete(struct auth_group *ag);
 203 struct auth_group       *auth_group_find(struct conf *conf, const char *name);
 204 int                     auth_group_set_type_str(struct auth_group *ag,
 205                             const char *type);
 206
 207 const struct auth       *auth_new_chap(struct auth_group *ag,
 208                             const char *user, const char *secret);
 209 const struct auth       *auth_new_chap_mutual(struct auth_group *ag,
 210                             const char *user, const char *secret,
 211                             const char *user2, const char *secret2);
 212 const struct auth       *auth_find(struct auth_group *ag,
 213                             const char *user);
 214
 215 const struct auth_name  *auth_name_new(struct auth_group *ag,
 216                             const char *initiator_name);
 217 bool                    auth_name_defined(const struct auth_group *ag);
 218 const struct auth_name  *auth_name_find(const struct auth_group *ag,
 219                             const char *initiator_name);
 220
 221 const struct auth_portal        *auth_portal_new(struct auth_group *ag,
 222                                     const char *initiator_portal);
 223 bool                    auth_portal_defined(const struct auth_group *ag);
 224 const struct auth_portal        *auth_portal_find(const struct auth_group *ag,
 225                                     const char *initiator_portal);
 226
 227 struct portal_group     *portal_group_new(struct conf *conf, const char *name);
 228 void                    portal_group_delete(struct portal_group *pg);
 229 struct portal_group     *portal_group_find(struct conf *conf, const char *name);
 230 int                     portal_group_add_listen(struct portal_group *pg,
 231                             const char *listen, bool iser);
 232
 233 struct target           *target_new(struct conf *conf, const char *name);
 234 void                    target_delete(struct target *target);
 235 struct target           *target_find(struct conf *conf,
 236                             const char *name);
 237
 238 struct lun              *lun_new(struct target *target, int lun_id);
 239 void                    lun_delete(struct lun *lun);
 240 struct lun              *lun_find(struct target *target, int lun_id);
 241 void                    lun_set_backend(struct lun *lun, const char *value);
 242 void                    lun_set_blocksize(struct lun *lun, size_t value);
 243 void                    lun_set_device_id(struct lun *lun, const char *value);
 244 void                    lun_set_path(struct lun *lun, const char *value);
 245 void                    lun_set_serial(struct lun *lun, const char *value);
 246 void                    lun_set_size(struct lun *lun, size_t value);
 247 void                    lun_set_ctl_lun(struct lun *lun, uint32_t value);
 248
 249 struct lun_option       *lun_option_new(struct lun *lun,
 250                             const char *name, const char *value);
 251 void                    lun_option_delete(struct lun_option *clo);
 252 struct lun_option       *lun_option_find(struct lun *lun, const char *name);
 253 void                    lun_option_set(struct lun_option *clo,
 254                             const char *value);
 255
 256 void                    kernel_init(void);
 257 int                     kernel_lun_add(struct lun *lun);
 258 int                     kernel_lun_resize(struct lun *lun);
 259 int                     kernel_lun_remove(struct lun *lun);
 260 void                    kernel_handoff(struct connection *conn);
 261 int                     kernel_port_on(void);
 262 int                     kernel_port_off(void);
 263 void                    kernel_capsicate(void);
 264
 265 /*
 266  * ICL_KERNEL_PROXY
 267  */
 268 void                    kernel_listen(struct addrinfo *ai, bool iser);
 269 int                     kernel_accept(void);
 270 void                    kernel_send(struct pdu *pdu);
 271 void                    kernel_receive(struct pdu *pdu);
 272
 273 struct keys             *keys_new(void);
 274 void                    keys_delete(struct keys *keys);
 275 void                    keys_load(struct keys *keys, const struct pdu *pdu);
 276 void                    keys_save(struct keys *keys, struct pdu *pdu);
 277 const char              *keys_find(struct keys *keys, const char *name);
 278 int                     keys_find_int(struct keys *keys, const char *name);
 279 void                    keys_add(struct keys *keys,
 280                             const char *name, const char *value);
 281 void                    keys_add_int(struct keys *keys,
 282                             const char *name, int value);
 283
 284 struct pdu              *pdu_new(struct connection *conn);
 285 struct pdu              *pdu_new_response(struct pdu *request);
 286 void                    pdu_delete(struct pdu *pdu);
 287 void                    pdu_receive(struct pdu *request);
 288 void                    pdu_send(struct pdu *response);
 289
 290 void                    login(struct connection *conn);
 291
 292 void                    discovery(struct connection *conn);
 293
 294 void                    log_init(int level);
 295 void                    log_set_peer_name(const char *name);
 296 void                    log_set_peer_addr(const char *addr);
 297 void                    log_err(int, const char *, ...)
 298                             __dead2 __printflike(2, 3);
 299 void                    log_errx(int, const char *, ...)
 300                             __dead2 __printflike(2, 3);
 301 void                    log_warn(const char *, ...) __printflike(1, 2);
 302 void                    log_warnx(const char *, ...) __printflike(1, 2);
 303 void                    log_debugx(const char *, ...) __printflike(1, 2);
 304
 305 char                    *checked_strdup(const char *);
 306 bool                    valid_iscsi_name(const char *name);
 307 bool                    timed_out(void);
 308
 309 #endif /* !CTLD_H */