usr/iscsi_ipc.h

   1 /*
   2  * User/Kernel Transport IPC API Ioctl/NETLINK/etc
   3  *
   4  * Copyright (C) 2005 Dmitry Yusupov, Alex Aizman
   5  * maintained by open-iscsi@googlegroups.com
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published
   9  * by the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15  * General Public License for more details.
  16  *
  17  * See the file COPYING included with this distribution for more details.
  18  *
  19  * NOTE: OSes must implement this API in terms of user's control-plane re-use.
  20  */
  21
  22 #ifndef ISCSI_IPC_H
  23 #define ISCSI_IPC_H
  24
  25 #if defined(FreeBSD)
  26 #include <sys/_iovec.h>
  27 #endif
  28
  29 #include "iscsi_if.h"
  30
  31 enum {
  32         ISCSI_INT,
  33         ISCSI_STRING,
  34 };
  35
  36 struct iscsi_conn;
  37 struct iscsi_ev_context;
  38
  39 /*
  40  * When handling async events, the initiator may not be able to
  41  * handle the event in the same context, so this allows the interface
  42  * code to call into the initiator to shedule handling.
  43  */
  44 struct iscsi_ipc_ev_clbk {
  45         void (*create_session) (uint32_t host_no, uint32_t sid);
  46         void (*destroy_session) (uint32_t host_no, uint32_t sid);
  47
  48         struct iscsi_ev_context *(*get_ev_context) (struct iscsi_conn *conn,
  49                                                     int ev_size);
  50         void (*put_ev_context) (struct iscsi_ev_context *ev_context);
  51         int (*sched_ev_context) (struct iscsi_ev_context *ev_context,
  52                                  struct iscsi_conn *conn,
  53                                  unsigned long tmo, int event);
  54 };
  55
  56 extern void ipc_register_ev_callback(struct iscsi_ipc_ev_clbk *ipc_ev_clbk);
  57
  58 /**
  59  * struct iscsi_ipc - Open-iSCSI Interface for Kernel IPC
  60  *
  61  * All functions allowed to return POSIX kind of error. i.e. 0 - OK, non-zero
  62  * means IPC error and errno set.
  63  */
  64 struct iscsi_ipc {
  65         char *name;
  66
  67         int ctldev_bufmax;
  68
  69         int (*ctldev_open) (void);
  70
  71         void (*ctldev_close) (void);
  72
  73         int (*ctldev_handle) (void);
  74
  75         int (*sendtargets) (uint64_t transport_handle, uint32_t host_no,
  76                             struct sockaddr *addr);
  77
  78         int (*create_session) (uint64_t transport_handle, uint64_t ep_handle,
  79                                uint32_t initial_cmdsn, uint16_t cmds_max,
  80                                uint16_t qdepth, uint32_t *out_sid,
  81                                uint32_t *hostno);
  82
  83         int (*destroy_session) (uint64_t transport_handle, uint32_t sid);
  84
  85         int (*unbind_session) (uint64_t transport_handle, uint32_t sid);
  86
  87         int (*create_conn) (uint64_t transport_handle,
  88                             uint32_t sid, uint32_t cid, uint32_t *out_cid);
  89
  90         int (*destroy_conn) (uint64_t transport_handle, uint32_t sid,
  91                              uint32_t cid);
  92
  93         int (*bind_conn) (uint64_t transport_handle, uint32_t sid,
  94                           uint32_t cid, uint64_t transport_eph,
  95                           int is_leading, int *retcode);
  96
  97         int (*set_param) (uint64_t transport_handle, uint32_t sid,
  98                           uint32_t cid, enum iscsi_param param,
  99                           void *value, int type);
 100
 101         int (*set_host_param) (uint64_t transport_handle, uint32_t host_no,
 102                                enum iscsi_host_param param,
 103                                void *value, int type);
 104
 105         /* not implemented yet */
 106         int (*get_param) (uint64_t transport_handle, uint32_t sid,
 107                           uint32_t cid, enum iscsi_param param,
 108                           uint32_t *value, int *retcode);
 109
 110         int (*get_stats) (uint64_t transport_handle, uint32_t sid,
 111                           uint32_t cid, char *statsbuf, int statsbuf_max);
 112
 113         int (*start_conn) (uint64_t transport_handle, uint32_t sid,
 114                            uint32_t cid, int *retcode);
 115
 116         int (*stop_conn) (uint64_t transport_handle, uint32_t sid,
 117                           uint32_t cid, int flag);
 118
 119         int (*read) (char *data, int count);
 120
 121         void (*send_pdu_begin) (uint64_t transport_handle, uint32_t sid,
 122                                 uint32_t cid, int hdr_size, int data_size);
 123
 124         int (*send_pdu_end) (uint64_t transport_handle, uint32_t sid,
 125                              uint32_t cid, int *retcode);
 126
 127         int (*writev) (enum iscsi_uevent_e type, struct iovec *iovp, int count);
 128
 129         int (*recv_pdu_begin) (struct iscsi_conn *conn);
 130
 131         int (*recv_pdu_end) (struct iscsi_conn *conn);
 132 };
 133
 134 #endif /* ISCSI_IPC_H */