aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorNicholas Bellinger <nab@linux-iscsi.org>2010-12-17 14:11:26 -0500
committerJames Bottomley <James.Bottomley@suse.de>2011-01-14 11:12:29 -0500
commitc66ac9db8d4ad9994a02b3e933ea2ccc643e1fe5 (patch)
tree71c6344688bf56ea6aaf18c586ab69ff4f077ade /include
parentf4013c3879d1bbd9f3ab8351185decd049502368 (diff)
[SCSI] target: Add LIO target core v4.0.0-rc6
LIO target is a full featured in-kernel target framework with the following feature set: High-performance, non-blocking, multithreaded architecture with SIMD support. Advanced SCSI feature set: * Persistent Reservations (PRs) * Asymmetric Logical Unit Assignment (ALUA) * Protocol and intra-nexus multiplexing, load-balancing and failover (MC/S) * Full Error Recovery (ERL=0,1,2) * Active/active task migration and session continuation (ERL=2) * Thin LUN provisioning (UNMAP and WRITE_SAMExx) Multiprotocol target plugins Storage media independence: * Virtualization of all storage media; transparent mapping of IO to LUNs * No hard limits on number of LUNs per Target; maximum LUN size ~750 TB * Backstores: SATA, SAS, SCSI, BluRay, DVD, FLASH, USB, ramdisk, etc. Standards compliance: * Full compliance with IETF (RFC 3720) * Full implementation of SPC-4 PRs and ALUA Significant code cleanups done by Christoph Hellwig. [jejb: fix up for new block bdev exclusive interface. Minor fixes from Randy Dunlap and Dan Carpenter.] Signed-off-by: Nicholas A. Bellinger <nab@linux-iscsi.org> Signed-off-by: James Bottomley <James.Bottomley@suse.de>
Diffstat (limited to 'include')
-rw-r--r--include/target/configfs_macros.h147
-rw-r--r--include/target/target_core_base.h937
-rw-r--r--include/target/target_core_configfs.h52
-rw-r--r--include/target/target_core_device.h61
-rw-r--r--include/target/target_core_fabric_configfs.h106
-rw-r--r--include/target/target_core_fabric_lib.h28
-rw-r--r--include/target/target_core_fabric_ops.h100
-rw-r--r--include/target/target_core_tmr.h43
-rw-r--r--include/target/target_core_tpg.h35
-rw-r--r--include/target/target_core_transport.h351
10 files changed, 1860 insertions, 0 deletions
diff --git a/include/target/configfs_macros.h b/include/target/configfs_macros.h
new file mode 100644
index 000000000000..7fe74608b437
--- /dev/null
+++ b/include/target/configfs_macros.h
@@ -0,0 +1,147 @@
1/* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
3 *
4 * configfs_macros.h - extends macros for configfs
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public
17 * License along with this program; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 021110-1307, USA.
20 *
21 * Based on sysfs:
22 * sysfs is Copyright (C) 2001, 2002, 2003 Patrick Mochel
23 *
24 * Based on kobject.h:
25 * Copyright (c) 2002-2003 Patrick Mochel
26 * Copyright (c) 2002-2003 Open Source Development Labs
27 *
28 * configfs Copyright (C) 2005 Oracle. All rights reserved.
29 *
30 * Added CONFIGFS_EATTR() macros from original configfs.h macros
31 * Copright (C) 2008-2009 Nicholas A. Bellinger <nab@linux-iscsi.org>
32 *
33 * Please read Documentation/filesystems/configfs.txt before using the
34 * configfs interface, ESPECIALLY the parts about reference counts and
35 * item destructors.
36 */
37
38#ifndef _CONFIGFS_MACROS_H_
39#define _CONFIGFS_MACROS_H_
40
41#include <linux/configfs.h>
42
43/*
44 * Users often need to create attribute structures for their configurable
45 * attributes, containing a configfs_attribute member and function pointers
46 * for the show() and store() operations on that attribute. If they don't
47 * need anything else on the extended attribute structure, they can use
48 * this macro to define it. The argument _name isends up as
49 * 'struct _name_attribute, as well as names of to CONFIGFS_ATTR_OPS() below.
50 * The argument _item is the name of the structure containing the
51 * struct config_item or struct config_group structure members
52 */
53#define CONFIGFS_EATTR_STRUCT(_name, _item) \
54struct _name##_attribute { \
55 struct configfs_attribute attr; \
56 ssize_t (*show)(struct _item *, char *); \
57 ssize_t (*store)(struct _item *, const char *, size_t); \
58}
59
60/*
61 * With the extended attribute structure, users can use this macro
62 * (similar to sysfs' __ATTR) to make defining attributes easier.
63 * An example:
64 * #define MYITEM_EATTR(_name, _mode, _show, _store) \
65 * struct myitem_attribute childless_attr_##_name = \
66 * __CONFIGFS_EATTR(_name, _mode, _show, _store)
67 */
68#define __CONFIGFS_EATTR(_name, _mode, _show, _store) \
69{ \
70 .attr = { \
71 .ca_name = __stringify(_name), \
72 .ca_mode = _mode, \
73 .ca_owner = THIS_MODULE, \
74 }, \
75 .show = _show, \
76 .store = _store, \
77}
78/* Here is a readonly version, only requiring a show() operation */
79#define __CONFIGFS_EATTR_RO(_name, _show) \
80{ \
81 .attr = { \
82 .ca_name = __stringify(_name), \
83 .ca_mode = 0444, \
84 .ca_owner = THIS_MODULE, \
85 }, \
86 .show = _show, \
87}
88
89/*
90 * With these extended attributes, the simple show_attribute() and
91 * store_attribute() operations need to call the show() and store() of the
92 * attributes. This is a common pattern, so we provide a macro to define
93 * them. The argument _name is the name of the attribute defined by
94 * CONFIGFS_ATTR_STRUCT(). The argument _item is the name of the structure
95 * containing the struct config_item or struct config_group structure member.
96 * The argument _item_member is the actual name of the struct config_* struct
97 * in your _item structure. Meaning my_structure->some_config_group.
98 * ^^_item^^^^^ ^^_item_member^^^
99 * This macro expects the attributes to be named "struct <name>_attribute".
100 */
101#define CONFIGFS_EATTR_OPS_TO_FUNC(_name, _item, _item_member) \
102static struct _item *to_##_name(struct config_item *ci) \
103{ \
104 return (ci) ? container_of(to_config_group(ci), struct _item, \
105 _item_member) : NULL; \
106}
107
108#define CONFIGFS_EATTR_OPS_SHOW(_name, _item) \
109static ssize_t _name##_attr_show(struct config_item *item, \
110 struct configfs_attribute *attr, \
111 char *page) \
112{ \
113 struct _item *_item = to_##_name(item); \
114 struct _name##_attribute * _name##_attr = \
115 container_of(attr, struct _name##_attribute, attr); \
116 ssize_t ret = 0; \
117 \
118 if (_name##_attr->show) \
119 ret = _name##_attr->show(_item, page); \
120 return ret; \
121}
122
123#define CONFIGFS_EATTR_OPS_STORE(_name, _item) \
124static ssize_t _name##_attr_store(struct config_item *item, \
125 struct configfs_attribute *attr, \
126 const char *page, size_t count) \
127{ \
128 struct _item *_item = to_##_name(item); \
129 struct _name##_attribute * _name##_attr = \
130 container_of(attr, struct _name##_attribute, attr); \
131 ssize_t ret = -EINVAL; \
132 \
133 if (_name##_attr->store) \
134 ret = _name##_attr->store(_item, page, count); \
135 return ret; \
136}
137
138#define CONFIGFS_EATTR_OPS(_name, _item, _item_member) \
139 CONFIGFS_EATTR_OPS_TO_FUNC(_name, _item, _item_member); \
140 CONFIGFS_EATTR_OPS_SHOW(_name, _item); \
141 CONFIGFS_EATTR_OPS_STORE(_name, _item);
142
143#define CONFIGFS_EATTR_OPS_RO(_name, _item, _item_member) \
144 CONFIGFS_EATTR_OPS_TO_FUNC(_name, _item, _item_member); \
145 CONFIGFS_EATTR_OPS_SHOW(_name, _item);
146
147#endif /* _CONFIGFS_MACROS_H_ */
diff --git a/include/target/target_core_base.h b/include/target/target_core_base.h
new file mode 100644
index 000000000000..07fdfb6b9a9a
--- /dev/null
+++ b/include/target/target_core_base.h
@@ -0,0 +1,937 @@
1#ifndef TARGET_CORE_BASE_H
2#define TARGET_CORE_BASE_H
3
4#include <linux/in.h>
5#include <linux/configfs.h>
6#include <linux/dma-mapping.h>
7#include <linux/blkdev.h>
8#include <scsi/scsi_cmnd.h>
9#include <net/sock.h>
10#include <net/tcp.h>
11#include "target_core_mib.h"
12
13#define TARGET_CORE_MOD_VERSION "v4.0.0-rc6"
14#define SHUTDOWN_SIGS (sigmask(SIGKILL)|sigmask(SIGINT)|sigmask(SIGABRT))
15
16/* Used by transport_generic_allocate_iovecs() */
17#define TRANSPORT_IOV_DATA_BUFFER 5
18/* Maximum Number of LUNs per Target Portal Group */
19#define TRANSPORT_MAX_LUNS_PER_TPG 256
20/*
21 * By default we use 32-byte CDBs in TCM Core and subsystem plugin code.
22 *
23 * Note that both include/scsi/scsi_cmnd.h:MAX_COMMAND_SIZE and
24 * include/linux/blkdev.h:BLOCK_MAX_CDB as of v2.6.36-rc4 still use
25 * 16-byte CDBs by default and require an extra allocation for
26 * 32-byte CDBs to becasue of legacy issues.
27 *
28 * Within TCM Core there are no such legacy limitiations, so we go ahead
29 * use 32-byte CDBs by default and use include/scsi/scsi.h:scsi_command_size()
30 * within all TCM Core and subsystem plugin code.
31 */
32#define TCM_MAX_COMMAND_SIZE 32
33/*
34 * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently
35 * defined 96, but the real limit is 252 (or 260 including the header)
36 */
37#define TRANSPORT_SENSE_BUFFER SCSI_SENSE_BUFFERSIZE
38/* Used by transport_send_check_condition_and_sense() */
39#define SPC_SENSE_KEY_OFFSET 2
40#define SPC_ASC_KEY_OFFSET 12
41#define SPC_ASCQ_KEY_OFFSET 13
42#define TRANSPORT_IQN_LEN 224
43/* Used by target_core_store_alua_lu_gp() and target_core_alua_lu_gp_show_attr_members() */
44#define LU_GROUP_NAME_BUF 256
45/* Used by core_alua_store_tg_pt_gp_info() and target_core_alua_tg_pt_gp_show_attr_members() */
46#define TG_PT_GROUP_NAME_BUF 256
47/* Used to parse VPD into struct t10_vpd */
48#define VPD_TMP_BUF_SIZE 128
49/* Used by transport_generic_cmd_sequencer() */
50#define READ_BLOCK_LEN 6
51#define READ_CAP_LEN 8
52#define READ_POSITION_LEN 20
53#define INQUIRY_LEN 36
54/* Used by transport_get_inquiry_vpd_serial() */
55#define INQUIRY_VPD_SERIAL_LEN 254
56/* Used by transport_get_inquiry_vpd_device_ident() */
57#define INQUIRY_VPD_DEVICE_IDENTIFIER_LEN 254
58
59/* struct se_hba->hba_flags */
60enum hba_flags_table {
61 HBA_FLAGS_INTERNAL_USE = 0x01,
62 HBA_FLAGS_PSCSI_MODE = 0x02,
63};
64
65/* struct se_lun->lun_status */
66enum transport_lun_status_table {
67 TRANSPORT_LUN_STATUS_FREE = 0,
68 TRANSPORT_LUN_STATUS_ACTIVE = 1,
69};
70
71/* struct se_portal_group->se_tpg_type */
72enum transport_tpg_type_table {
73 TRANSPORT_TPG_TYPE_NORMAL = 0,
74 TRANSPORT_TPG_TYPE_DISCOVERY = 1,
75};
76
77/* Used for generate timer flags */
78enum timer_flags_table {
79 TF_RUNNING = 0x01,
80 TF_STOP = 0x02,
81};
82
83/* Special transport agnostic struct se_cmd->t_states */
84enum transport_state_table {
85 TRANSPORT_NO_STATE = 0,
86 TRANSPORT_NEW_CMD = 1,
87 TRANSPORT_DEFERRED_CMD = 2,
88 TRANSPORT_WRITE_PENDING = 3,
89 TRANSPORT_PROCESS_WRITE = 4,
90 TRANSPORT_PROCESSING = 5,
91 TRANSPORT_COMPLETE_OK = 6,
92 TRANSPORT_COMPLETE_FAILURE = 7,
93 TRANSPORT_COMPLETE_TIMEOUT = 8,
94 TRANSPORT_PROCESS_TMR = 9,
95 TRANSPORT_TMR_COMPLETE = 10,
96 TRANSPORT_ISTATE_PROCESSING = 11,
97 TRANSPORT_ISTATE_PROCESSED = 12,
98 TRANSPORT_KILL = 13,
99 TRANSPORT_REMOVE = 14,
100 TRANSPORT_FREE = 15,
101 TRANSPORT_NEW_CMD_MAP = 16,
102};
103
104/* Used for struct se_cmd->se_cmd_flags */
105enum se_cmd_flags_table {
106 SCF_SUPPORTED_SAM_OPCODE = 0x00000001,
107 SCF_TRANSPORT_TASK_SENSE = 0x00000002,
108 SCF_EMULATED_TASK_SENSE = 0x00000004,
109 SCF_SCSI_DATA_SG_IO_CDB = 0x00000008,
110 SCF_SCSI_CONTROL_SG_IO_CDB = 0x00000010,
111 SCF_SCSI_CONTROL_NONSG_IO_CDB = 0x00000020,
112 SCF_SCSI_NON_DATA_CDB = 0x00000040,
113 SCF_SCSI_CDB_EXCEPTION = 0x00000080,
114 SCF_SCSI_RESERVATION_CONFLICT = 0x00000100,
115 SCF_CMD_PASSTHROUGH_NOALLOC = 0x00000200,
116 SCF_SE_CMD_FAILED = 0x00000400,
117 SCF_SE_LUN_CMD = 0x00000800,
118 SCF_SE_ALLOW_EOO = 0x00001000,
119 SCF_SE_DISABLE_ONLINE_CHECK = 0x00002000,
120 SCF_SENT_CHECK_CONDITION = 0x00004000,
121 SCF_OVERFLOW_BIT = 0x00008000,
122 SCF_UNDERFLOW_BIT = 0x00010000,
123 SCF_SENT_DELAYED_TAS = 0x00020000,
124 SCF_ALUA_NON_OPTIMIZED = 0x00040000,
125 SCF_DELAYED_CMD_FROM_SAM_ATTR = 0x00080000,
126 SCF_PASSTHROUGH_SG_TO_MEM = 0x00100000,
127 SCF_PASSTHROUGH_CONTIG_TO_SG = 0x00200000,
128 SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00400000,
129 SCF_EMULATE_SYNC_CACHE = 0x00800000,
130 SCF_EMULATE_CDB_ASYNC = 0x01000000,
131 SCF_EMULATE_SYNC_UNMAP = 0x02000000
132};
133
134/* struct se_dev_entry->lun_flags and struct se_lun->lun_access */
135enum transport_lunflags_table {
136 TRANSPORT_LUNFLAGS_NO_ACCESS = 0x00,
137 TRANSPORT_LUNFLAGS_INITIATOR_ACCESS = 0x01,
138 TRANSPORT_LUNFLAGS_READ_ONLY = 0x02,
139 TRANSPORT_LUNFLAGS_READ_WRITE = 0x04,
140};
141
142/* struct se_device->dev_status */
143enum transport_device_status_table {
144 TRANSPORT_DEVICE_ACTIVATED = 0x01,
145 TRANSPORT_DEVICE_DEACTIVATED = 0x02,
146 TRANSPORT_DEVICE_QUEUE_FULL = 0x04,
147 TRANSPORT_DEVICE_SHUTDOWN = 0x08,
148 TRANSPORT_DEVICE_OFFLINE_ACTIVATED = 0x10,
149 TRANSPORT_DEVICE_OFFLINE_DEACTIVATED = 0x20,
150};
151
152/*
153 * Used by transport_send_check_condition_and_sense() and se_cmd->scsi_sense_reason
154 * to signal which ASC/ASCQ sense payload should be built.
155 */
156enum tcm_sense_reason_table {
157 TCM_NON_EXISTENT_LUN = 0x01,
158 TCM_UNSUPPORTED_SCSI_OPCODE = 0x02,
159 TCM_INCORRECT_AMOUNT_OF_DATA = 0x03,
160 TCM_UNEXPECTED_UNSOLICITED_DATA = 0x04,
161 TCM_SERVICE_CRC_ERROR = 0x05,
162 TCM_SNACK_REJECTED = 0x06,
163 TCM_SECTOR_COUNT_TOO_MANY = 0x07,
164 TCM_INVALID_CDB_FIELD = 0x08,
165 TCM_INVALID_PARAMETER_LIST = 0x09,
166 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE = 0x0a,
167 TCM_UNKNOWN_MODE_PAGE = 0x0b,
168 TCM_WRITE_PROTECTED = 0x0c,
169 TCM_CHECK_CONDITION_ABORT_CMD = 0x0d,
170 TCM_CHECK_CONDITION_UNIT_ATTENTION = 0x0e,
171 TCM_CHECK_CONDITION_NOT_READY = 0x0f,
172};
173
174struct se_obj {
175 atomic_t obj_access_count;
176} ____cacheline_aligned;
177
178/*
179 * Used by TCM Core internally to signal if ALUA emulation is enabled or
180 * disabled, or running in with TCM/pSCSI passthrough mode
181 */
182typedef enum {
183 SPC_ALUA_PASSTHROUGH,
184 SPC2_ALUA_DISABLED,
185 SPC3_ALUA_EMULATED
186} t10_alua_index_t;
187
188/*
189 * Used by TCM Core internally to signal if SAM Task Attribute emulation
190 * is enabled or disabled, or running in with TCM/pSCSI passthrough mode
191 */
192typedef enum {
193 SAM_TASK_ATTR_PASSTHROUGH,
194 SAM_TASK_ATTR_UNTAGGED,
195 SAM_TASK_ATTR_EMULATED
196} t10_task_attr_index_t;
197
198struct se_cmd;
199
200struct t10_alua {
201 t10_alua_index_t alua_type;
202 /* ALUA Target Port Group ID */
203 u16 alua_tg_pt_gps_counter;
204 u32 alua_tg_pt_gps_count;
205 spinlock_t tg_pt_gps_lock;
206 struct se_subsystem_dev *t10_sub_dev;
207 /* Used for default ALUA Target Port Group */
208 struct t10_alua_tg_pt_gp *default_tg_pt_gp;
209 /* Used for default ALUA Target Port Group ConfigFS group */
210 struct config_group alua_tg_pt_gps_group;
211 int (*alua_state_check)(struct se_cmd *, unsigned char *, u8 *);
212 struct list_head tg_pt_gps_list;
213} ____cacheline_aligned;
214
215struct t10_alua_lu_gp {
216 u16 lu_gp_id;
217 int lu_gp_valid_id;
218 u32 lu_gp_members;
219 atomic_t lu_gp_shutdown;
220 atomic_t lu_gp_ref_cnt;
221 spinlock_t lu_gp_lock;
222 struct config_group lu_gp_group;
223 struct list_head lu_gp_list;
224 struct list_head lu_gp_mem_list;
225} ____cacheline_aligned;
226
227struct t10_alua_lu_gp_member {
228 int lu_gp_assoc:1;
229 atomic_t lu_gp_mem_ref_cnt;
230 spinlock_t lu_gp_mem_lock;
231 struct t10_alua_lu_gp *lu_gp;
232 struct se_device *lu_gp_mem_dev;
233 struct list_head lu_gp_mem_list;
234} ____cacheline_aligned;
235
236struct t10_alua_tg_pt_gp {
237 u16 tg_pt_gp_id;
238 int tg_pt_gp_valid_id;
239 int tg_pt_gp_alua_access_status;
240 int tg_pt_gp_alua_access_type;
241 int tg_pt_gp_nonop_delay_msecs;
242 int tg_pt_gp_trans_delay_msecs;
243 int tg_pt_gp_pref;
244 int tg_pt_gp_write_metadata;
245 /* Used by struct t10_alua_tg_pt_gp->tg_pt_gp_md_buf_len */
246#define ALUA_MD_BUF_LEN 1024
247 u32 tg_pt_gp_md_buf_len;
248 u32 tg_pt_gp_members;
249 atomic_t tg_pt_gp_alua_access_state;
250 atomic_t tg_pt_gp_ref_cnt;
251 spinlock_t tg_pt_gp_lock;
252 struct mutex tg_pt_gp_md_mutex;
253 struct se_subsystem_dev *tg_pt_gp_su_dev;
254 struct config_group tg_pt_gp_group;
255 struct list_head tg_pt_gp_list;
256 struct list_head tg_pt_gp_mem_list;
257} ____cacheline_aligned;
258
259struct t10_alua_tg_pt_gp_member {
260 int tg_pt_gp_assoc:1;
261 atomic_t tg_pt_gp_mem_ref_cnt;
262 spinlock_t tg_pt_gp_mem_lock;
263 struct t10_alua_tg_pt_gp *tg_pt_gp;
264 struct se_port *tg_pt;
265 struct list_head tg_pt_gp_mem_list;
266} ____cacheline_aligned;
267
268struct t10_vpd {
269 unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
270 int protocol_identifier_set;
271 u32 protocol_identifier;
272 u32 device_identifier_code_set;
273 u32 association;
274 u32 device_identifier_type;
275 struct list_head vpd_list;
276} ____cacheline_aligned;
277
278struct t10_wwn {
279 unsigned char vendor[8];
280 unsigned char model[16];
281 unsigned char revision[4];
282 unsigned char unit_serial[INQUIRY_VPD_SERIAL_LEN];
283 spinlock_t t10_vpd_lock;
284 struct se_subsystem_dev *t10_sub_dev;
285 struct config_group t10_wwn_group;
286 struct list_head t10_vpd_list;
287} ____cacheline_aligned;
288
289
290/*
291 * Used by TCM Core internally to signal if >= SPC-3 peristent reservations
292 * emulation is enabled or disabled, or running in with TCM/pSCSI passthrough
293 * mode
294 */
295typedef enum {
296 SPC_PASSTHROUGH,
297 SPC2_RESERVATIONS,
298 SPC3_PERSISTENT_RESERVATIONS
299} t10_reservations_index_t;
300
301struct t10_pr_registration {
302 /* Used for fabrics that contain WWN+ISID */
303#define PR_REG_ISID_LEN 16
304 /* PR_REG_ISID_LEN + ',i,0x' */
305#define PR_REG_ISID_ID_LEN (PR_REG_ISID_LEN + 5)
306 char pr_reg_isid[PR_REG_ISID_LEN];
307 /* Used during APTPL metadata reading */
308#define PR_APTPL_MAX_IPORT_LEN 256
309 unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
310 /* Used during APTPL metadata reading */
311#define PR_APTPL_MAX_TPORT_LEN 256
312 unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
313 /* For writing out live meta data */
314 unsigned char *pr_aptpl_buf;
315 u16 pr_aptpl_rpti;
316 u16 pr_reg_tpgt;
317 /* Reservation effects all target ports */
318 int pr_reg_all_tg_pt;
319 /* Activate Persistence across Target Power Loss */
320 int pr_reg_aptpl;
321 int pr_res_holder;
322 int pr_res_type;
323 int pr_res_scope;
324 /* Used for fabric initiator WWPNs using a ISID */
325 int isid_present_at_reg:1;
326 u32 pr_res_mapped_lun;
327 u32 pr_aptpl_target_lun;
328 u32 pr_res_generation;
329 u64 pr_reg_bin_isid;
330 u64 pr_res_key;
331 atomic_t pr_res_holders;
332 struct se_node_acl *pr_reg_nacl;
333 struct se_dev_entry *pr_reg_deve;
334 struct se_lun *pr_reg_tg_pt_lun;
335 struct list_head pr_reg_list;
336 struct list_head pr_reg_abort_list;
337 struct list_head pr_reg_aptpl_list;
338 struct list_head pr_reg_atp_list;
339 struct list_head pr_reg_atp_mem_list;
340} ____cacheline_aligned;
341
342/*
343 * This set of function pointer ops is set based upon SPC3_PERSISTENT_RESERVATIONS,
344 * SPC2_RESERVATIONS or SPC_PASSTHROUGH in drivers/target/target_core_pr.c:
345 * core_setup_reservations()
346 */
347struct t10_reservation_ops {
348 int (*t10_reservation_check)(struct se_cmd *, u32 *);
349 int (*t10_seq_non_holder)(struct se_cmd *, unsigned char *, u32);
350 int (*t10_pr_register)(struct se_cmd *);
351 int (*t10_pr_clear)(struct se_cmd *);
352};
353
354struct t10_reservation_template {
355 /* Reservation effects all target ports */
356 int pr_all_tg_pt;
357 /* Activate Persistence across Target Power Loss enabled
358 * for SCSI device */
359 int pr_aptpl_active;
360 /* Used by struct t10_reservation_template->pr_aptpl_buf_len */
361#define PR_APTPL_BUF_LEN 8192
362 u32 pr_aptpl_buf_len;
363 u32 pr_generation;
364 t10_reservations_index_t res_type;
365 spinlock_t registration_lock;
366 spinlock_t aptpl_reg_lock;
367 /*
368 * This will always be set by one individual I_T Nexus.
369 * However with all_tg_pt=1, other I_T Nexus from the
370 * same initiator can access PR reg/res info on a different
371 * target port.
372 *
373 * There is also the 'All Registrants' case, where there is
374 * a single *pr_res_holder of the reservation, but all
375 * registrations are considered reservation holders.
376 */
377 struct se_node_acl *pr_res_holder;
378 struct list_head registration_list;
379 struct list_head aptpl_reg_list;
380 struct t10_reservation_ops pr_ops;
381} ____cacheline_aligned;
382
383struct se_queue_req {
384 int state;
385 void *cmd;
386 struct list_head qr_list;
387} ____cacheline_aligned;
388
389struct se_queue_obj {
390 atomic_t queue_cnt;
391 spinlock_t cmd_queue_lock;
392 struct list_head qobj_list;
393 wait_queue_head_t thread_wq;
394} ____cacheline_aligned;
395
396/*
397 * Used one per struct se_cmd to hold all extra struct se_task
398 * metadata. This structure is setup and allocated in
399 * drivers/target/target_core_transport.c:__transport_alloc_se_cmd()
400 */
401struct se_transport_task {
402 unsigned char *t_task_cdb;
403 unsigned char __t_task_cdb[TCM_MAX_COMMAND_SIZE];
404 unsigned long long t_task_lba;
405 int t_tasks_failed;
406 int t_tasks_fua;
407 int t_tasks_bidi:1;
408 u32 t_task_cdbs;
409 u32 t_tasks_check;
410 u32 t_tasks_no;
411 u32 t_tasks_sectors;
412 u32 t_tasks_se_num;
413 u32 t_tasks_se_bidi_num;
414 u32 t_tasks_sg_chained_no;
415 atomic_t t_fe_count;
416 atomic_t t_se_count;
417 atomic_t t_task_cdbs_left;
418 atomic_t t_task_cdbs_ex_left;
419 atomic_t t_task_cdbs_timeout_left;
420 atomic_t t_task_cdbs_sent;
421 atomic_t t_transport_aborted;
422 atomic_t t_transport_active;
423 atomic_t t_transport_complete;
424 atomic_t t_transport_queue_active;
425 atomic_t t_transport_sent;
426 atomic_t t_transport_stop;
427 atomic_t t_transport_timeout;
428 atomic_t transport_dev_active;
429 atomic_t transport_lun_active;
430 atomic_t transport_lun_fe_stop;
431 atomic_t transport_lun_stop;
432 spinlock_t t_state_lock;
433 struct completion t_transport_stop_comp;
434 struct completion transport_lun_fe_stop_comp;
435 struct completion transport_lun_stop_comp;
436 struct scatterlist *t_tasks_sg_chained;
437 struct scatterlist t_tasks_sg_bounce;
438 void *t_task_buf;
439 /*
440 * Used for pre-registered fabric SGL passthrough WRITE and READ
441 * with the special SCF_PASSTHROUGH_CONTIG_TO_SG case for TCM_Loop
442 * and other HW target mode fabric modules.
443 */
444 struct scatterlist *t_task_pt_sgl;
445 struct list_head *t_mem_list;
446 /* Used for BIDI READ */
447 struct list_head *t_mem_bidi_list;
448 struct list_head t_task_list;
449} ____cacheline_aligned;
450
451struct se_task {
452 unsigned char task_sense;
453 struct scatterlist *task_sg;
454 struct scatterlist *task_sg_bidi;
455 u8 task_scsi_status;
456 u8 task_flags;
457 int task_error_status;
458 int task_state_flags;
459 int task_padded_sg:1;
460 unsigned long long task_lba;
461 u32 task_no;
462 u32 task_sectors;
463 u32 task_size;
464 u32 task_sg_num;
465 u32 task_sg_offset;
466 enum dma_data_direction task_data_direction;
467 struct se_cmd *task_se_cmd;
468 struct se_device *se_dev;
469 struct completion task_stop_comp;
470 atomic_t task_active;
471 atomic_t task_execute_queue;
472 atomic_t task_timeout;
473 atomic_t task_sent;
474 atomic_t task_stop;
475 atomic_t task_state_active;
476 struct timer_list task_timer;
477 struct se_device *se_obj_ptr;
478 struct list_head t_list;
479 struct list_head t_execute_list;
480 struct list_head t_state_list;
481} ____cacheline_aligned;
482
483#define TASK_CMD(task) ((struct se_cmd *)task->task_se_cmd)
484#define TASK_DEV(task) ((struct se_device *)task->se_dev)
485
486struct se_cmd {
487 /* SAM response code being sent to initiator */
488 u8 scsi_status;
489 u8 scsi_asc;
490 u8 scsi_ascq;
491 u8 scsi_sense_reason;
492 u16 scsi_sense_length;
493 /* Delay for ALUA Active/NonOptimized state access in milliseconds */
494 int alua_nonop_delay;
495 /* See include/linux/dma-mapping.h */
496 enum dma_data_direction data_direction;
497 /* For SAM Task Attribute */
498 int sam_task_attr;
499 /* Transport protocol dependent state, see transport_state_table */
500 enum transport_state_table t_state;
501 /* Transport protocol dependent state for out of order CmdSNs */
502 int deferred_t_state;
503 /* Transport specific error status */
504 int transport_error_status;
505 /* See se_cmd_flags_table */
506 u32 se_cmd_flags;
507 u32 se_ordered_id;
508 /* Total size in bytes associated with command */
509 u32 data_length;
510 /* SCSI Presented Data Transfer Length */
511 u32 cmd_spdtl;
512 u32 residual_count;
513 u32 orig_fe_lun;
514 /* Persistent Reservation key */
515 u64 pr_res_key;
516 atomic_t transport_sent;
517 /* Used for sense data */
518 void *sense_buffer;
519 struct list_head se_delayed_list;
520 struct list_head se_ordered_list;
521 struct list_head se_lun_list;
522 struct se_device *se_dev;
523 struct se_dev_entry *se_deve;
524 struct se_device *se_obj_ptr;
525 struct se_device *se_orig_obj_ptr;
526 struct se_lun *se_lun;
527 /* Only used for internal passthrough and legacy TCM fabric modules */
528 struct se_session *se_sess;
529 struct se_tmr_req *se_tmr_req;
530 /* t_task is setup to t_task_backstore in transport_init_se_cmd() */
531 struct se_transport_task *t_task;
532 struct se_transport_task t_task_backstore;
533 struct target_core_fabric_ops *se_tfo;
534 int (*transport_emulate_cdb)(struct se_cmd *);
535 void (*transport_split_cdb)(unsigned long long, u32 *, unsigned char *);
536 void (*transport_wait_for_tasks)(struct se_cmd *, int, int);
537 void (*transport_complete_callback)(struct se_cmd *);
538} ____cacheline_aligned;
539
540#define T_TASK(cmd) ((struct se_transport_task *)(cmd->t_task))
541#define CMD_TFO(cmd) ((struct target_core_fabric_ops *)cmd->se_tfo)
542
543struct se_tmr_req {
544 /* Task Management function to be preformed */
545 u8 function;
546 /* Task Management response to send */
547 u8 response;
548 int call_transport;
549 /* Reference to ITT that Task Mgmt should be preformed */
550 u32 ref_task_tag;
551 /* 64-bit encoded SAM LUN from $FABRIC_MOD TMR header */
552 u64 ref_task_lun;
553 void *fabric_tmr_ptr;
554 struct se_cmd *task_cmd;
555 struct se_cmd *ref_cmd;
556 struct se_device *tmr_dev;
557 struct se_lun *tmr_lun;
558 struct list_head tmr_list;
559} ____cacheline_aligned;
560
561struct se_ua {
562 u8 ua_asc;
563 u8 ua_ascq;
564 struct se_node_acl *ua_nacl;
565 struct list_head ua_dev_list;
566 struct list_head ua_nacl_list;
567} ____cacheline_aligned;
568
569struct se_node_acl {
570 char initiatorname[TRANSPORT_IQN_LEN];
571 /* Used to signal demo mode created ACL, disabled by default */
572 int dynamic_node_acl:1;
573 u32 queue_depth;
574 u32 acl_index;
575 u64 num_cmds;
576 u64 read_bytes;
577 u64 write_bytes;
578 spinlock_t stats_lock;
579 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
580 atomic_t acl_pr_ref_count;
581 /* Used for MIB access */
582 atomic_t mib_ref_count;
583 struct se_dev_entry *device_list;
584 struct se_session *nacl_sess;
585 struct se_portal_group *se_tpg;
586 spinlock_t device_list_lock;
587 spinlock_t nacl_sess_lock;
588 struct config_group acl_group;
589 struct config_group acl_attrib_group;
590 struct config_group acl_auth_group;
591 struct config_group acl_param_group;
592 struct config_group *acl_default_groups[4];
593 struct list_head acl_list;
594 struct list_head acl_sess_list;
595} ____cacheline_aligned;
596
597struct se_session {
598 /* Used for MIB access */
599 atomic_t mib_ref_count;
600 u64 sess_bin_isid;
601 struct se_node_acl *se_node_acl;
602 struct se_portal_group *se_tpg;
603 void *fabric_sess_ptr;
604 struct list_head sess_list;
605 struct list_head sess_acl_list;
606} ____cacheline_aligned;
607
608#define SE_SESS(cmd) ((struct se_session *)(cmd)->se_sess)
609#define SE_NODE_ACL(sess) ((struct se_node_acl *)(sess)->se_node_acl)
610
611struct se_device;
612struct se_transform_info;
613struct scatterlist;
614
615struct se_lun_acl {
616 char initiatorname[TRANSPORT_IQN_LEN];
617 u32 mapped_lun;
618 struct se_node_acl *se_lun_nacl;
619 struct se_lun *se_lun;
620 struct list_head lacl_list;
621 struct config_group se_lun_group;
622} ____cacheline_aligned;
623
624struct se_dev_entry {
625 int def_pr_registered:1;
626 /* See transport_lunflags_table */
627 u32 lun_flags;
628 u32 deve_cmds;
629 u32 mapped_lun;
630 u32 average_bytes;
631 u32 last_byte_count;
632 u32 total_cmds;
633 u32 total_bytes;
634 u64 pr_res_key;
635 u64 creation_time;
636 u32 attach_count;
637 u64 read_bytes;
638 u64 write_bytes;
639 atomic_t ua_count;
640 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
641 atomic_t pr_ref_count;
642 struct se_lun_acl *se_lun_acl;
643 spinlock_t ua_lock;
644 struct se_lun *se_lun;
645 struct list_head alua_port_list;
646 struct list_head ua_list;
647} ____cacheline_aligned;
648
649struct se_dev_limits {
650 /* Max supported HW queue depth */
651 u32 hw_queue_depth;
652 /* Max supported virtual queue depth */
653 u32 queue_depth;
654 /* From include/linux/blkdev.h for the other HW/SW limits. */
655 struct queue_limits limits;
656} ____cacheline_aligned;
657
658struct se_dev_attrib {
659 int emulate_dpo;
660 int emulate_fua_write;
661 int emulate_fua_read;
662 int emulate_write_cache;
663 int emulate_ua_intlck_ctrl;
664 int emulate_tas;
665 int emulate_tpu;
666 int emulate_tpws;
667 int emulate_reservations;
668 int emulate_alua;
669 int enforce_pr_isids;
670 u32 hw_block_size;
671 u32 block_size;
672 u32 hw_max_sectors;
673 u32 max_sectors;
674 u32 optimal_sectors;
675 u32 hw_queue_depth;
676 u32 queue_depth;
677 u32 task_timeout;
678 u32 max_unmap_lba_count;
679 u32 max_unmap_block_desc_count;
680 u32 unmap_granularity;
681 u32 unmap_granularity_alignment;
682 struct se_subsystem_dev *da_sub_dev;
683 struct config_group da_group;
684} ____cacheline_aligned;
685
686struct se_subsystem_dev {
687/* Used for struct se_subsystem_dev-->se_dev_alias, must be less than PAGE_SIZE */
688#define SE_DEV_ALIAS_LEN 512
689 unsigned char se_dev_alias[SE_DEV_ALIAS_LEN];
690/* Used for struct se_subsystem_dev->se_dev_udev_path[], must be less than PAGE_SIZE */
691#define SE_UDEV_PATH_LEN 512
692 unsigned char se_dev_udev_path[SE_UDEV_PATH_LEN];
693 u32 su_dev_flags;
694 struct se_hba *se_dev_hba;
695 struct se_device *se_dev_ptr;
696 struct se_dev_attrib se_dev_attrib;
697 /* T10 Asymmetric Logical Unit Assignment for Target Ports */
698 struct t10_alua t10_alua;
699 /* T10 Inquiry and VPD WWN Information */
700 struct t10_wwn t10_wwn;
701 /* T10 SPC-2 + SPC-3 Reservations */
702 struct t10_reservation_template t10_reservation;
703 spinlock_t se_dev_lock;
704 void *se_dev_su_ptr;
705 struct list_head g_se_dev_list;
706 struct config_group se_dev_group;
707 /* For T10 Reservations */
708 struct config_group se_dev_pr_group;
709} ____cacheline_aligned;
710
711#define T10_ALUA(su_dev) (&(su_dev)->t10_alua)
712#define T10_RES(su_dev) (&(su_dev)->t10_reservation)
713#define T10_PR_OPS(su_dev) (&(su_dev)->t10_reservation.pr_ops)
714
715struct se_device {
716 /* Set to 1 if thread is NOT sleeping on thread_sem */
717 u8 thread_active;
718 u8 dev_status_timer_flags;
719 /* RELATIVE TARGET PORT IDENTIFER Counter */
720 u16 dev_rpti_counter;
721 /* Used for SAM Task Attribute ordering */
722 u32 dev_cur_ordered_id;
723 u32 dev_flags;
724 u32 dev_port_count;
725 /* See transport_device_status_table */
726 u32 dev_status;
727 u32 dev_tcq_window_closed;
728 /* Physical device queue depth */
729 u32 queue_depth;
730 /* Used for SPC-2 reservations enforce of ISIDs */
731 u64 dev_res_bin_isid;
732 t10_task_attr_index_t dev_task_attr_type;
733 /* Pointer to transport specific device structure */
734 void *dev_ptr;
735 u32 dev_index;
736 u64 creation_time;
737 u32 num_resets;
738 u64 num_cmds;
739 u64 read_bytes;
740 u64 write_bytes;
741 spinlock_t stats_lock;
742 /* Active commands on this virtual SE device */
743 atomic_t active_cmds;
744 atomic_t simple_cmds;
745 atomic_t depth_left;
746 atomic_t dev_ordered_id;
747 atomic_t dev_tur_active;
748 atomic_t execute_tasks;
749 atomic_t dev_status_thr_count;
750 atomic_t dev_hoq_count;
751 atomic_t dev_ordered_sync;
752 struct se_obj dev_obj;
753 struct se_obj dev_access_obj;
754 struct se_obj dev_export_obj;
755 struct se_queue_obj *dev_queue_obj;
756 struct se_queue_obj *dev_status_queue_obj;
757 spinlock_t delayed_cmd_lock;
758 spinlock_t ordered_cmd_lock;
759 spinlock_t execute_task_lock;
760 spinlock_t state_task_lock;
761 spinlock_t dev_alua_lock;
762 spinlock_t dev_reservation_lock;
763 spinlock_t dev_state_lock;
764 spinlock_t dev_status_lock;
765 spinlock_t dev_status_thr_lock;
766 spinlock_t se_port_lock;
767 spinlock_t se_tmr_lock;
768 /* Used for legacy SPC-2 reservationsa */
769 struct se_node_acl *dev_reserved_node_acl;
770 /* Used for ALUA Logical Unit Group membership */
771 struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
772 /* Used for SPC-3 Persistent Reservations */
773 struct t10_pr_registration *dev_pr_res_holder;
774 struct list_head dev_sep_list;
775 struct list_head dev_tmr_list;
776 struct timer_list dev_status_timer;
777 /* Pointer to descriptor for processing thread */
778 struct task_struct *process_thread;
779 pid_t process_thread_pid;
780 struct task_struct *dev_mgmt_thread;
781 struct list_head delayed_cmd_list;
782 struct list_head ordered_cmd_list;
783 struct list_head execute_task_list;
784 struct list_head state_task_list;
785 /* Pointer to associated SE HBA */
786 struct se_hba *se_hba;
787 struct se_subsystem_dev *se_sub_dev;
788 /* Pointer to template of function pointers for transport */
789 struct se_subsystem_api *transport;
790 /* Linked list for struct se_hba struct se_device list */
791 struct list_head dev_list;
792 /* Linked list for struct se_global->g_se_dev_list */
793 struct list_head g_se_dev_list;
794} ____cacheline_aligned;
795
796#define SE_DEV(cmd) ((struct se_device *)(cmd)->se_lun->lun_se_dev)
797#define SU_DEV(dev) ((struct se_subsystem_dev *)(dev)->se_sub_dev)
798#define DEV_ATTRIB(dev) (&(dev)->se_sub_dev->se_dev_attrib)
799#define DEV_T10_WWN(dev) (&(dev)->se_sub_dev->t10_wwn)
800
801struct se_hba {
802 u16 hba_tpgt;
803 u32 hba_id;
804 /* See hba_flags_table */
805 u32 hba_flags;
806 /* Virtual iSCSI devices attached. */
807 u32 dev_count;
808 u32 hba_index;
809 atomic_t dev_mib_access_count;
810 atomic_t load_balance_queue;
811 atomic_t left_queue_depth;
812 /* Maximum queue depth the HBA can handle. */
813 atomic_t max_queue_depth;
814 /* Pointer to transport specific host structure. */
815 void *hba_ptr;
816 /* Linked list for struct se_device */
817 struct list_head hba_dev_list;
818 struct list_head hba_list;
819 spinlock_t device_lock;
820 spinlock_t hba_queue_lock;
821 struct config_group hba_group;
822 struct mutex hba_access_mutex;
823 struct se_subsystem_api *transport;
824} ____cacheline_aligned;
825
826#define SE_HBA(d) ((struct se_hba *)(d)->se_hba)
827
828struct se_lun {
829 /* See transport_lun_status_table */
830 enum transport_lun_status_table lun_status;
831 u32 lun_access;
832 u32 lun_flags;
833 u32 unpacked_lun;
834 atomic_t lun_acl_count;
835 spinlock_t lun_acl_lock;
836 spinlock_t lun_cmd_lock;
837 spinlock_t lun_sep_lock;
838 struct completion lun_shutdown_comp;
839 struct list_head lun_cmd_list;
840 struct list_head lun_acl_list;
841 struct se_device *lun_se_dev;
842 struct config_group lun_group;
843 struct se_port *lun_sep;
844} ____cacheline_aligned;
845
846#define SE_LUN(c) ((struct se_lun *)(c)->se_lun)
847
848struct se_port {
849 /* RELATIVE TARGET PORT IDENTIFER */
850 u16 sep_rtpi;
851 int sep_tg_pt_secondary_stat;
852 int sep_tg_pt_secondary_write_md;
853 u32 sep_index;
854 struct scsi_port_stats sep_stats;
855 /* Used for ALUA Target Port Groups membership */
856 atomic_t sep_tg_pt_gp_active;
857 atomic_t sep_tg_pt_secondary_offline;
858 /* Used for PR ALL_TG_PT=1 */
859 atomic_t sep_tg_pt_ref_cnt;
860 spinlock_t sep_alua_lock;
861 struct mutex sep_tg_pt_md_mutex;
862 struct t10_alua_tg_pt_gp_member *sep_alua_tg_pt_gp_mem;
863 struct se_lun *sep_lun;
864 struct se_portal_group *sep_tpg;
865 struct list_head sep_alua_list;
866 struct list_head sep_list;
867} ____cacheline_aligned;
868
869struct se_tpg_np {
870 struct config_group tpg_np_group;
871} ____cacheline_aligned;
872
873struct se_portal_group {
874 /* Type of target portal group, see transport_tpg_type_table */
875 enum transport_tpg_type_table se_tpg_type;
876 /* Number of ACLed Initiator Nodes for this TPG */
877 u32 num_node_acls;
878 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
879 atomic_t tpg_pr_ref_count;
880 /* Spinlock for adding/removing ACLed Nodes */
881 spinlock_t acl_node_lock;
882 /* Spinlock for adding/removing sessions */
883 spinlock_t session_lock;
884 spinlock_t tpg_lun_lock;
885 /* Pointer to $FABRIC_MOD portal group */
886 void *se_tpg_fabric_ptr;
887 struct list_head se_tpg_list;
888 /* linked list for initiator ACL list */
889 struct list_head acl_node_list;
890 struct se_lun *tpg_lun_list;
891 struct se_lun tpg_virt_lun0;
892 /* List of TCM sessions assoicated wth this TPG */
893 struct list_head tpg_sess_list;
894 /* Pointer to $FABRIC_MOD dependent code */
895 struct target_core_fabric_ops *se_tpg_tfo;
896 struct se_wwn *se_tpg_wwn;
897 struct config_group tpg_group;
898 struct config_group *tpg_default_groups[6];
899 struct config_group tpg_lun_group;
900 struct config_group tpg_np_group;
901 struct config_group tpg_acl_group;
902 struct config_group tpg_attrib_group;
903 struct config_group tpg_param_group;
904} ____cacheline_aligned;
905
906#define TPG_TFO(se_tpg) ((struct target_core_fabric_ops *)(se_tpg)->se_tpg_tfo)
907
908struct se_wwn {
909 struct target_fabric_configfs *wwn_tf;
910 struct config_group wwn_group;
911} ____cacheline_aligned;
912
913struct se_global {
914 u16 alua_lu_gps_counter;
915 int g_sub_api_initialized;
916 u32 in_shutdown;
917 u32 alua_lu_gps_count;
918 u32 g_hba_id_counter;
919 struct config_group target_core_hbagroup;
920 struct config_group alua_group;
921 struct config_group alua_lu_gps_group;
922 struct list_head g_lu_gps_list;
923 struct list_head g_se_tpg_list;
924 struct list_head g_hba_list;
925 struct list_head g_se_dev_list;
926 struct se_hba *g_lun0_hba;
927 struct se_subsystem_dev *g_lun0_su_dev;
928 struct se_device *g_lun0_dev;
929 struct t10_alua_lu_gp *default_lu_gp;
930 spinlock_t g_device_lock;
931 spinlock_t hba_lock;
932 spinlock_t se_tpg_lock;
933 spinlock_t lu_gps_lock;
934 spinlock_t plugin_class_lock;
935} ____cacheline_aligned;
936
937#endif /* TARGET_CORE_BASE_H */
diff --git a/include/target/target_core_configfs.h b/include/target/target_core_configfs.h
new file mode 100644
index 000000000000..40e6e740527c
--- /dev/null
+++ b/include/target/target_core_configfs.h
@@ -0,0 +1,52 @@
1#define TARGET_CORE_CONFIGFS_VERSION TARGET_CORE_MOD_VERSION
2
3#define TARGET_CORE_CONFIG_ROOT "/sys/kernel/config"
4
5#define TARGET_CORE_NAME_MAX_LEN 64
6#define TARGET_FABRIC_NAME_SIZE 32
7
8extern struct target_fabric_configfs *target_fabric_configfs_init(
9 struct module *, const char *);
10extern void target_fabric_configfs_free(struct target_fabric_configfs *);
11extern int target_fabric_configfs_register(struct target_fabric_configfs *);
12extern void target_fabric_configfs_deregister(struct target_fabric_configfs *);
13
14struct target_fabric_configfs_template {
15 struct config_item_type tfc_discovery_cit;
16 struct config_item_type tfc_wwn_cit;
17 struct config_item_type tfc_tpg_cit;
18 struct config_item_type tfc_tpg_base_cit;
19 struct config_item_type tfc_tpg_lun_cit;
20 struct config_item_type tfc_tpg_port_cit;
21 struct config_item_type tfc_tpg_np_cit;
22 struct config_item_type tfc_tpg_np_base_cit;
23 struct config_item_type tfc_tpg_attrib_cit;
24 struct config_item_type tfc_tpg_param_cit;
25 struct config_item_type tfc_tpg_nacl_cit;
26 struct config_item_type tfc_tpg_nacl_base_cit;
27 struct config_item_type tfc_tpg_nacl_attrib_cit;
28 struct config_item_type tfc_tpg_nacl_auth_cit;
29 struct config_item_type tfc_tpg_nacl_param_cit;
30 struct config_item_type tfc_tpg_mappedlun_cit;
31};
32
33struct target_fabric_configfs {
34 char tf_name[TARGET_FABRIC_NAME_SIZE];
35 atomic_t tf_access_cnt;
36 struct list_head tf_list;
37 struct config_group tf_group;
38 struct config_group tf_disc_group;
39 struct config_group *tf_default_groups[2];
40 /* Pointer to fabric's config_item */
41 struct config_item *tf_fabric;
42 /* Passed from fabric modules */
43 struct config_item_type *tf_fabric_cit;
44 /* Pointer to target core subsystem */
45 struct configfs_subsystem *tf_subsys;
46 /* Pointer to fabric's struct module */
47 struct module *tf_module;
48 struct target_core_fabric_ops tf_ops;
49 struct target_fabric_configfs_template tf_cit_tmpl;
50};
51
52#define TF_CIT_TMPL(tf) (&(tf)->tf_cit_tmpl)
diff --git a/include/target/target_core_device.h b/include/target/target_core_device.h
new file mode 100644
index 000000000000..52b18a5752c9
--- /dev/null
+++ b/include/target/target_core_device.h
@@ -0,0 +1,61 @@
1#ifndef TARGET_CORE_DEVICE_H
2#define TARGET_CORE_DEVICE_H
3
4extern int transport_get_lun_for_cmd(struct se_cmd *, unsigned char *, u32);
5extern int transport_get_lun_for_tmr(struct se_cmd *, u32);
6extern struct se_dev_entry *core_get_se_deve_from_rtpi(
7 struct se_node_acl *, u16);
8extern int core_free_device_list_for_node(struct se_node_acl *,
9 struct se_portal_group *);
10extern void core_dec_lacl_count(struct se_node_acl *, struct se_cmd *);
11extern void core_update_device_list_access(u32, u32, struct se_node_acl *);
12extern int core_update_device_list_for_node(struct se_lun *, struct se_lun_acl *, u32,
13 u32, struct se_node_acl *,
14 struct se_portal_group *, int);
15extern void core_clear_lun_from_tpg(struct se_lun *, struct se_portal_group *);
16extern int core_dev_export(struct se_device *, struct se_portal_group *,
17 struct se_lun *);
18extern void core_dev_unexport(struct se_device *, struct se_portal_group *,
19 struct se_lun *);
20extern int transport_core_report_lun_response(struct se_cmd *);
21extern void se_release_device_for_hba(struct se_device *);
22extern void se_release_vpd_for_dev(struct se_device *);
23extern void se_clear_dev_ports(struct se_device *);
24extern int se_free_virtual_device(struct se_device *, struct se_hba *);
25extern int se_dev_check_online(struct se_device *);
26extern int se_dev_check_shutdown(struct se_device *);
27extern void se_dev_set_default_attribs(struct se_device *, struct se_dev_limits *);
28extern int se_dev_set_task_timeout(struct se_device *, u32);
29extern int se_dev_set_max_unmap_lba_count(struct se_device *, u32);
30extern int se_dev_set_max_unmap_block_desc_count(struct se_device *, u32);
31extern int se_dev_set_unmap_granularity(struct se_device *, u32);
32extern int se_dev_set_unmap_granularity_alignment(struct se_device *, u32);
33extern int se_dev_set_emulate_dpo(struct se_device *, int);
34extern int se_dev_set_emulate_fua_write(struct se_device *, int);
35extern int se_dev_set_emulate_fua_read(struct se_device *, int);
36extern int se_dev_set_emulate_write_cache(struct se_device *, int);
37extern int se_dev_set_emulate_ua_intlck_ctrl(struct se_device *, int);
38extern int se_dev_set_emulate_tas(struct se_device *, int);
39extern int se_dev_set_emulate_tpu(struct se_device *, int);
40extern int se_dev_set_emulate_tpws(struct se_device *, int);
41extern int se_dev_set_enforce_pr_isids(struct se_device *, int);
42extern int se_dev_set_queue_depth(struct se_device *, u32);
43extern int se_dev_set_max_sectors(struct se_device *, u32);
44extern int se_dev_set_optimal_sectors(struct se_device *, u32);
45extern int se_dev_set_block_size(struct se_device *, u32);
46extern struct se_lun *core_dev_add_lun(struct se_portal_group *, struct se_hba *,
47 struct se_device *, u32);
48extern int core_dev_del_lun(struct se_portal_group *, u32);
49extern struct se_lun *core_get_lun_from_tpg(struct se_portal_group *, u32);
50extern struct se_lun_acl *core_dev_init_initiator_node_lun_acl(struct se_portal_group *,
51 u32, char *, int *);
52extern int core_dev_add_initiator_node_lun_acl(struct se_portal_group *,
53 struct se_lun_acl *, u32, u32);
54extern int core_dev_del_initiator_node_lun_acl(struct se_portal_group *,
55 struct se_lun *, struct se_lun_acl *);
56extern void core_dev_free_initiator_node_lun_acl(struct se_portal_group *,
57 struct se_lun_acl *lacl);
58extern int core_dev_setup_virtual_lun0(void);
59extern void core_dev_release_virtual_lun0(void);
60
61#endif /* TARGET_CORE_DEVICE_H */
diff --git a/include/target/target_core_fabric_configfs.h b/include/target/target_core_fabric_configfs.h
new file mode 100644
index 000000000000..a26fb7586a09
--- /dev/null
+++ b/include/target/target_core_fabric_configfs.h
@@ -0,0 +1,106 @@
1/*
2 * Used for tfc_wwn_cit attributes
3 */
4
5#include <target/configfs_macros.h>
6
7CONFIGFS_EATTR_STRUCT(target_fabric_nacl_attrib, se_node_acl);
8#define TF_NACL_ATTRIB_ATTR(_fabric, _name, _mode) \
9static struct target_fabric_nacl_attrib_attribute _fabric##_nacl_attrib_##_name = \
10 __CONFIGFS_EATTR(_name, _mode, \
11 _fabric##_nacl_attrib_show_##_name, \
12 _fabric##_nacl_attrib_store_##_name);
13
14CONFIGFS_EATTR_STRUCT(target_fabric_nacl_auth, se_node_acl);
15#define TF_NACL_AUTH_ATTR(_fabric, _name, _mode) \
16static struct target_fabric_nacl_auth_attribute _fabric##_nacl_auth_##_name = \
17 __CONFIGFS_EATTR(_name, _mode, \
18 _fabric##_nacl_auth_show_##_name, \
19 _fabric##_nacl_auth_store_##_name);
20
21#define TF_NACL_AUTH_ATTR_RO(_fabric, _name) \
22static struct target_fabric_nacl_auth_attribute _fabric##_nacl_auth_##_name = \
23 __CONFIGFS_EATTR_RO(_name, \
24 _fabric##_nacl_auth_show_##_name);
25
26CONFIGFS_EATTR_STRUCT(target_fabric_nacl_param, se_node_acl);
27#define TF_NACL_PARAM_ATTR(_fabric, _name, _mode) \
28static struct target_fabric_nacl_param_attribute _fabric##_nacl_param_##_name = \
29 __CONFIGFS_EATTR(_name, _mode, \
30 _fabric##_nacl_param_show_##_name, \
31 _fabric##_nacl_param_store_##_name);
32
33#define TF_NACL_PARAM_ATTR_RO(_fabric, _name) \
34static struct target_fabric_nacl_param_attribute _fabric##_nacl_param_##_name = \
35 __CONFIGFS_EATTR_RO(_name, \
36 _fabric##_nacl_param_show_##_name);
37
38
39CONFIGFS_EATTR_STRUCT(target_fabric_nacl_base, se_node_acl);
40#define TF_NACL_BASE_ATTR(_fabric, _name, _mode) \
41static struct target_fabric_nacl_base_attribute _fabric##_nacl_##_name = \
42 __CONFIGFS_EATTR(_name, _mode, \
43 _fabric##_nacl_show_##_name, \
44 _fabric##_nacl_store_##_name);
45
46#define TF_NACL_BASE_ATTR_RO(_fabric, _name) \
47static struct target_fabric_nacl_base_attribute _fabric##_nacl_##_name = \
48 __CONFIGFS_EATTR_RO(_name, \
49 _fabric##_nacl_show_##_name);
50
51CONFIGFS_EATTR_STRUCT(target_fabric_np_base, se_tpg_np);
52#define TF_NP_BASE_ATTR(_fabric, _name, _mode) \
53static struct target_fabric_np_base_attribute _fabric##_np_##_name = \
54 __CONFIGFS_EATTR(_name, _mode, \
55 _fabric##_np_show_##_name, \
56 _fabric##_np_store_##_name);
57
58CONFIGFS_EATTR_STRUCT(target_fabric_tpg_attrib, se_portal_group);
59#define TF_TPG_ATTRIB_ATTR(_fabric, _name, _mode) \
60static struct target_fabric_tpg_attrib_attribute _fabric##_tpg_attrib_##_name = \
61 __CONFIGFS_EATTR(_name, _mode, \
62 _fabric##_tpg_attrib_show_##_name, \
63 _fabric##_tpg_attrib_store_##_name);
64
65
66CONFIGFS_EATTR_STRUCT(target_fabric_tpg_param, se_portal_group);
67#define TF_TPG_PARAM_ATTR(_fabric, _name, _mode) \
68static struct target_fabric_tpg_param_attribute _fabric##_tpg_param_##_name = \
69 __CONFIGFS_EATTR(_name, _mode, \
70 _fabric##_tpg_param_show_##_name, \
71 _fabric##_tpg_param_store_##_name);
72
73
74CONFIGFS_EATTR_STRUCT(target_fabric_tpg, se_portal_group);
75#define TF_TPG_BASE_ATTR(_fabric, _name, _mode) \
76static struct target_fabric_tpg_attribute _fabric##_tpg_##_name = \
77 __CONFIGFS_EATTR(_name, _mode, \
78 _fabric##_tpg_show_##_name, \
79 _fabric##_tpg_store_##_name);
80
81
82CONFIGFS_EATTR_STRUCT(target_fabric_wwn, target_fabric_configfs);
83#define TF_WWN_ATTR(_fabric, _name, _mode) \
84static struct target_fabric_wwn_attribute _fabric##_wwn_##_name = \
85 __CONFIGFS_EATTR(_name, _mode, \
86 _fabric##_wwn_show_attr_##_name, \
87 _fabric##_wwn_store_attr_##_name);
88
89#define TF_WWN_ATTR_RO(_fabric, _name) \
90static struct target_fabric_wwn_attribute _fabric##_wwn_##_name = \
91 __CONFIGFS_EATTR_RO(_name, \
92 _fabric##_wwn_show_attr_##_name);
93
94CONFIGFS_EATTR_STRUCT(target_fabric_discovery, target_fabric_configfs);
95#define TF_DISC_ATTR(_fabric, _name, _mode) \
96static struct target_fabric_discovery_attribute _fabric##_disc_##_name = \
97 __CONFIGFS_EATTR(_name, _mode, \
98 _fabric##_disc_show_##_name, \
99 _fabric##_disc_store_##_name);
100
101#define TF_DISC_ATTR_RO(_fabric, _name) \
102static struct target_fabric_discovery_attribute _fabric##_disc_##_name = \
103 __CONFIGFS_EATTR_RO(_name, \
104 _fabric##_disc_show_##_name);
105
106extern int target_fabric_setup_cits(struct target_fabric_configfs *);
diff --git a/include/target/target_core_fabric_lib.h b/include/target/target_core_fabric_lib.h
new file mode 100644
index 000000000000..c2f8d0e3a03b
--- /dev/null
+++ b/include/target/target_core_fabric_lib.h
@@ -0,0 +1,28 @@
1#ifndef TARGET_CORE_FABRIC_LIB_H
2#define TARGET_CORE_FABRIC_LIB_H
3
4extern u8 sas_get_fabric_proto_ident(struct se_portal_group *);
5extern u32 sas_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
6 struct t10_pr_registration *, int *, unsigned char *);
7extern u32 sas_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
8 struct t10_pr_registration *, int *);
9extern char *sas_parse_pr_out_transport_id(struct se_portal_group *,
10 const char *, u32 *, char **);
11
12extern u8 fc_get_fabric_proto_ident(struct se_portal_group *);
13extern u32 fc_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
14 struct t10_pr_registration *, int *, unsigned char *);
15extern u32 fc_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
16 struct t10_pr_registration *, int *);
17extern char *fc_parse_pr_out_transport_id(struct se_portal_group *,
18 const char *, u32 *, char **);
19
20extern u8 iscsi_get_fabric_proto_ident(struct se_portal_group *);
21extern u32 iscsi_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
22 struct t10_pr_registration *, int *, unsigned char *);
23extern u32 iscsi_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
24 struct t10_pr_registration *, int *);
25extern char *iscsi_parse_pr_out_transport_id(struct se_portal_group *,
26 const char *, u32 *, char **);
27
28#endif /* TARGET_CORE_FABRIC_LIB_H */
diff --git a/include/target/target_core_fabric_ops.h b/include/target/target_core_fabric_ops.h
new file mode 100644
index 000000000000..f3ac12b019c2
--- /dev/null
+++ b/include/target/target_core_fabric_ops.h
@@ -0,0 +1,100 @@
1/* Defined in target_core_configfs.h */
2struct target_fabric_configfs;
3
4struct target_core_fabric_ops {
5 struct configfs_subsystem *tf_subsys;
6 /*
7 * Optional to signal struct se_task->task_sg[] padding entries
8 * for scatterlist chaining using transport_do_task_sg_link(),
9 * disabled by default
10 */
11 int task_sg_chaining:1;
12 char *(*get_fabric_name)(void);
13 u8 (*get_fabric_proto_ident)(struct se_portal_group *);
14 char *(*tpg_get_wwn)(struct se_portal_group *);
15 u16 (*tpg_get_tag)(struct se_portal_group *);
16 u32 (*tpg_get_default_depth)(struct se_portal_group *);
17 u32 (*tpg_get_pr_transport_id)(struct se_portal_group *,
18 struct se_node_acl *,
19 struct t10_pr_registration *, int *,
20 unsigned char *);
21 u32 (*tpg_get_pr_transport_id_len)(struct se_portal_group *,
22 struct se_node_acl *,
23 struct t10_pr_registration *, int *);
24 char *(*tpg_parse_pr_out_transport_id)(struct se_portal_group *,
25 const char *, u32 *, char **);
26 int (*tpg_check_demo_mode)(struct se_portal_group *);
27 int (*tpg_check_demo_mode_cache)(struct se_portal_group *);
28 int (*tpg_check_demo_mode_write_protect)(struct se_portal_group *);
29 int (*tpg_check_prod_mode_write_protect)(struct se_portal_group *);
30 struct se_node_acl *(*tpg_alloc_fabric_acl)(
31 struct se_portal_group *);
32 void (*tpg_release_fabric_acl)(struct se_portal_group *,
33 struct se_node_acl *);
34 u32 (*tpg_get_inst_index)(struct se_portal_group *);
35 /*
36 * Optional function pointer for TCM to perform command map
37 * from TCM processing thread context, for those struct se_cmd
38 * initally allocated in interrupt context.
39 */
40 int (*new_cmd_map)(struct se_cmd *);
41 /*
42 * Optional function pointer for TCM fabric modules that use
43 * Linux/NET sockets to allocate struct iovec array to struct se_cmd
44 */
45 int (*alloc_cmd_iovecs)(struct se_cmd *);
46 /*
47 * Optional to release struct se_cmd and fabric dependent allocated
48 * I/O descriptor in transport_cmd_check_stop()
49 */
50 void (*check_stop_free)(struct se_cmd *);
51 void (*release_cmd_to_pool)(struct se_cmd *);
52 void (*release_cmd_direct)(struct se_cmd *);
53 /*
54 * Called with spin_lock_bh(struct se_portal_group->session_lock held.
55 */
56 int (*shutdown_session)(struct se_session *);
57 void (*close_session)(struct se_session *);
58 void (*stop_session)(struct se_session *, int, int);
59 void (*fall_back_to_erl0)(struct se_session *);
60 int (*sess_logged_in)(struct se_session *);
61 u32 (*sess_get_index)(struct se_session *);
62 /*
63 * Used only for SCSI fabrics that contain multi-value TransportIDs
64 * (like iSCSI). All other SCSI fabrics should set this to NULL.
65 */
66 u32 (*sess_get_initiator_sid)(struct se_session *,
67 unsigned char *, u32);
68 int (*write_pending)(struct se_cmd *);
69 int (*write_pending_status)(struct se_cmd *);
70 void (*set_default_node_attributes)(struct se_node_acl *);
71 u32 (*get_task_tag)(struct se_cmd *);
72 int (*get_cmd_state)(struct se_cmd *);
73 void (*new_cmd_failure)(struct se_cmd *);
74 int (*queue_data_in)(struct se_cmd *);
75 int (*queue_status)(struct se_cmd *);
76 int (*queue_tm_rsp)(struct se_cmd *);
77 u16 (*set_fabric_sense_len)(struct se_cmd *, u32);
78 u16 (*get_fabric_sense_len)(void);
79 int (*is_state_remove)(struct se_cmd *);
80 u64 (*pack_lun)(unsigned int);
81 /*
82 * fabric module calls for target_core_fabric_configfs.c
83 */
84 struct se_wwn *(*fabric_make_wwn)(struct target_fabric_configfs *,
85 struct config_group *, const char *);
86 void (*fabric_drop_wwn)(struct se_wwn *);
87 struct se_portal_group *(*fabric_make_tpg)(struct se_wwn *,
88 struct config_group *, const char *);
89 void (*fabric_drop_tpg)(struct se_portal_group *);
90 int (*fabric_post_link)(struct se_portal_group *,
91 struct se_lun *);
92 void (*fabric_pre_unlink)(struct se_portal_group *,
93 struct se_lun *);
94 struct se_tpg_np *(*fabric_make_np)(struct se_portal_group *,
95 struct config_group *, const char *);
96 void (*fabric_drop_np)(struct se_tpg_np *);
97 struct se_node_acl *(*fabric_make_nodeacl)(struct se_portal_group *,
98 struct config_group *, const char *);
99 void (*fabric_drop_nodeacl)(struct se_node_acl *);
100};
diff --git a/include/target/target_core_tmr.h b/include/target/target_core_tmr.h
new file mode 100644
index 000000000000..6c8248bc2c66
--- /dev/null
+++ b/include/target/target_core_tmr.h
@@ -0,0 +1,43 @@
1#ifndef TARGET_CORE_TMR_H
2#define TARGET_CORE_TMR_H
3
4/* task management function values */
5#ifdef ABORT_TASK
6#undef ABORT_TASK
7#endif /* ABORT_TASK */
8#define ABORT_TASK 1
9#ifdef ABORT_TASK_SET
10#undef ABORT_TASK_SET
11#endif /* ABORT_TASK_SET */
12#define ABORT_TASK_SET 2
13#ifdef CLEAR_ACA
14#undef CLEAR_ACA
15#endif /* CLEAR_ACA */
16#define CLEAR_ACA 3
17#ifdef CLEAR_TASK_SET
18#undef CLEAR_TASK_SET
19#endif /* CLEAR_TASK_SET */
20#define CLEAR_TASK_SET 4
21#define LUN_RESET 5
22#define TARGET_WARM_RESET 6
23#define TARGET_COLD_RESET 7
24#define TASK_REASSIGN 8
25
26/* task management response values */
27#define TMR_FUNCTION_COMPLETE 0
28#define TMR_TASK_DOES_NOT_EXIST 1
29#define TMR_LUN_DOES_NOT_EXIST 2
30#define TMR_TASK_STILL_ALLEGIANT 3
31#define TMR_TASK_FAILOVER_NOT_SUPPORTED 4
32#define TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED 5
33#define TMR_FUNCTION_AUTHORIZATION_FAILED 6
34#define TMR_FUNCTION_REJECTED 255
35
36extern struct kmem_cache *se_tmr_req_cache;
37
38extern struct se_tmr_req *core_tmr_alloc_req(struct se_cmd *, void *, u8);
39extern void core_tmr_release_req(struct se_tmr_req *);
40extern int core_tmr_lun_reset(struct se_device *, struct se_tmr_req *,
41 struct list_head *, struct se_cmd *);
42
43#endif /* TARGET_CORE_TMR_H */
diff --git a/include/target/target_core_tpg.h b/include/target/target_core_tpg.h
new file mode 100644
index 000000000000..77e18729c4c1
--- /dev/null
+++ b/include/target/target_core_tpg.h
@@ -0,0 +1,35 @@
1#ifndef TARGET_CORE_TPG_H
2#define TARGET_CORE_TPG_H
3
4extern struct se_node_acl *__core_tpg_get_initiator_node_acl(struct se_portal_group *tpg,
5 const char *);
6extern struct se_node_acl *core_tpg_get_initiator_node_acl(struct se_portal_group *tpg,
7 unsigned char *);
8extern void core_tpg_add_node_to_devs(struct se_node_acl *,
9 struct se_portal_group *);
10extern struct se_node_acl *core_tpg_check_initiator_node_acl(
11 struct se_portal_group *,
12 unsigned char *);
13extern void core_tpg_wait_for_nacl_pr_ref(struct se_node_acl *);
14extern void core_tpg_wait_for_mib_ref(struct se_node_acl *);
15extern void core_tpg_clear_object_luns(struct se_portal_group *);
16extern struct se_node_acl *core_tpg_add_initiator_node_acl(
17 struct se_portal_group *,
18 struct se_node_acl *,
19 const char *, u32);
20extern int core_tpg_del_initiator_node_acl(struct se_portal_group *,
21 struct se_node_acl *, int);
22extern int core_tpg_set_initiator_node_queue_depth(struct se_portal_group *,
23 unsigned char *, u32, int);
24extern int core_tpg_register(struct target_core_fabric_ops *,
25 struct se_wwn *,
26 struct se_portal_group *, void *,
27 int);
28extern int core_tpg_deregister(struct se_portal_group *);
29extern struct se_lun *core_tpg_pre_addlun(struct se_portal_group *, u32);
30extern int core_tpg_post_addlun(struct se_portal_group *, struct se_lun *, u32,
31 void *);
32extern struct se_lun *core_tpg_pre_dellun(struct se_portal_group *, u32, int *);
33extern int core_tpg_post_dellun(struct se_portal_group *, struct se_lun *);
34
35#endif /* TARGET_CORE_TPG_H */
diff --git a/include/target/target_core_transport.h b/include/target/target_core_transport.h
new file mode 100644
index 000000000000..66f44e56eb80
--- /dev/null
+++ b/include/target/target_core_transport.h
@@ -0,0 +1,351 @@
1#ifndef TARGET_CORE_TRANSPORT_H
2#define TARGET_CORE_TRANSPORT_H
3
4#define TARGET_CORE_VERSION TARGET_CORE_MOD_VERSION
5
6/* Attempts before moving from SHORT to LONG */
7#define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD 3
8#define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT 3 /* In milliseconds */
9#define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG 10 /* In milliseconds */
10
11#define PYX_TRANSPORT_STATUS_INTERVAL 5 /* In seconds */
12
13#define PYX_TRANSPORT_SENT_TO_TRANSPORT 0
14#define PYX_TRANSPORT_WRITE_PENDING 1
15
16#define PYX_TRANSPORT_UNKNOWN_SAM_OPCODE -1
17#define PYX_TRANSPORT_HBA_QUEUE_FULL -2
18#define PYX_TRANSPORT_REQ_TOO_MANY_SECTORS -3
19#define PYX_TRANSPORT_OUT_OF_MEMORY_RESOURCES -4
20#define PYX_TRANSPORT_INVALID_CDB_FIELD -5
21#define PYX_TRANSPORT_INVALID_PARAMETER_LIST -6
22#define PYX_TRANSPORT_LU_COMM_FAILURE -7
23#define PYX_TRANSPORT_UNKNOWN_MODE_PAGE -8
24#define PYX_TRANSPORT_WRITE_PROTECTED -9
25#define PYX_TRANSPORT_TASK_TIMEOUT -10
26#define PYX_TRANSPORT_RESERVATION_CONFLICT -11
27#define PYX_TRANSPORT_ILLEGAL_REQUEST -12
28#define PYX_TRANSPORT_USE_SENSE_REASON -13
29
30#ifndef SAM_STAT_RESERVATION_CONFLICT
31#define SAM_STAT_RESERVATION_CONFLICT 0x18
32#endif
33
34#define TRANSPORT_PLUGIN_FREE 0
35#define TRANSPORT_PLUGIN_REGISTERED 1
36
37#define TRANSPORT_PLUGIN_PHBA_PDEV 1
38#define TRANSPORT_PLUGIN_VHBA_PDEV 2
39#define TRANSPORT_PLUGIN_VHBA_VDEV 3
40
41/* For SE OBJ Plugins, in seconds */
42#define TRANSPORT_TIMEOUT_TUR 10
43#define TRANSPORT_TIMEOUT_TYPE_DISK 60
44#define TRANSPORT_TIMEOUT_TYPE_ROM 120
45#define TRANSPORT_TIMEOUT_TYPE_TAPE 600
46#define TRANSPORT_TIMEOUT_TYPE_OTHER 300
47
48/* For se_task->task_state_flags */
49#define TSF_EXCEPTION_CLEARED 0x01
50
51/*
52 * struct se_subsystem_dev->su_dev_flags
53*/
54#define SDF_FIRMWARE_VPD_UNIT_SERIAL 0x00000001
55#define SDF_EMULATED_VPD_UNIT_SERIAL 0x00000002
56#define SDF_USING_UDEV_PATH 0x00000004
57#define SDF_USING_ALIAS 0x00000008
58
59/*
60 * struct se_device->dev_flags
61 */
62#define DF_READ_ONLY 0x00000001
63#define DF_SPC2_RESERVATIONS 0x00000002
64#define DF_SPC2_RESERVATIONS_WITH_ISID 0x00000004
65
66/* struct se_dev_attrib sanity values */
67/* 10 Minutes */
68#define DA_TASK_TIMEOUT_MAX 600
69/* Default max_unmap_lba_count */
70#define DA_MAX_UNMAP_LBA_COUNT 0
71/* Default max_unmap_block_desc_count */
72#define DA_MAX_UNMAP_BLOCK_DESC_COUNT 0
73/* Default unmap_granularity */
74#define DA_UNMAP_GRANULARITY_DEFAULT 0
75/* Default unmap_granularity_alignment */
76#define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT 0
77/* Emulation for Direct Page Out */
78#define DA_EMULATE_DPO 0
79/* Emulation for Forced Unit Access WRITEs */
80#define DA_EMULATE_FUA_WRITE 1
81/* Emulation for Forced Unit Access READs */
82#define DA_EMULATE_FUA_READ 0
83/* Emulation for WriteCache and SYNCHRONIZE_CACHE */
84#define DA_EMULATE_WRITE_CACHE 0
85/* Emulation for UNIT ATTENTION Interlock Control */
86#define DA_EMULATE_UA_INTLLCK_CTRL 0
87/* Emulation for TASK_ABORTED status (TAS) by default */
88#define DA_EMULATE_TAS 1
89/* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */
90#define DA_EMULATE_TPU 0
91/*
92 * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
93 * block/blk-lib.c:blkdev_issue_discard()
94 */
95#define DA_EMULATE_TPWS 0
96/* No Emulation for PSCSI by default */
97#define DA_EMULATE_RESERVATIONS 0
98/* No Emulation for PSCSI by default */
99#define DA_EMULATE_ALUA 0
100/* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */
101#define DA_ENFORCE_PR_ISIDS 1
102#define DA_STATUS_MAX_SECTORS_MIN 16
103#define DA_STATUS_MAX_SECTORS_MAX 8192
104
105#define SE_MODE_PAGE_BUF 512
106
107#define MOD_MAX_SECTORS(ms, bs) (ms % (PAGE_SIZE / bs))
108
109struct se_mem;
110struct se_subsystem_api;
111
112extern int init_se_global(void);
113extern void release_se_global(void);
114extern void transport_init_queue_obj(struct se_queue_obj *);
115extern int transport_subsystem_check_init(void);
116extern int transport_subsystem_register(struct se_subsystem_api *);
117extern void transport_subsystem_release(struct se_subsystem_api *);
118extern void transport_load_plugins(void);
119extern struct se_session *transport_init_session(void);
120extern void __transport_register_session(struct se_portal_group *,
121 struct se_node_acl *,
122 struct se_session *, void *);
123extern void transport_register_session(struct se_portal_group *,
124 struct se_node_acl *,
125 struct se_session *, void *);
126extern void transport_free_session(struct se_session *);
127extern void transport_deregister_session_configfs(struct se_session *);
128extern void transport_deregister_session(struct se_session *);
129extern void transport_cmd_finish_abort(struct se_cmd *, int);
130extern void transport_cmd_finish_abort_tmr(struct se_cmd *);
131extern void transport_complete_sync_cache(struct se_cmd *, int);
132extern void transport_complete_task(struct se_task *, int);
133extern void transport_add_task_to_execute_queue(struct se_task *,
134 struct se_task *,
135 struct se_device *);
136unsigned char *transport_dump_cmd_direction(struct se_cmd *);
137extern void transport_dump_dev_state(struct se_device *, char *, int *);
138extern void transport_dump_dev_info(struct se_device *, struct se_lun *,
139 unsigned long long, char *, int *);
140extern void transport_dump_vpd_proto_id(struct t10_vpd *,
141 unsigned char *, int);
142extern void transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
143extern int transport_dump_vpd_assoc(struct t10_vpd *,
144 unsigned char *, int);
145extern int transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
146extern int transport_dump_vpd_ident_type(struct t10_vpd *,
147 unsigned char *, int);
148extern int transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
149extern int transport_dump_vpd_ident(struct t10_vpd *,
150 unsigned char *, int);
151extern int transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
152extern struct se_device *transport_add_device_to_core_hba(struct se_hba *,
153 struct se_subsystem_api *,
154 struct se_subsystem_dev *, u32,
155 void *, struct se_dev_limits *,
156 const char *, const char *);
157extern void transport_device_setup_cmd(struct se_cmd *);
158extern void transport_init_se_cmd(struct se_cmd *,
159 struct target_core_fabric_ops *,
160 struct se_session *, u32, int, int,
161 unsigned char *);
162extern void transport_free_se_cmd(struct se_cmd *);
163extern int transport_generic_allocate_tasks(struct se_cmd *, unsigned char *);
164extern int transport_generic_handle_cdb(struct se_cmd *);
165extern int transport_generic_handle_cdb_map(struct se_cmd *);
166extern int transport_generic_handle_data(struct se_cmd *);
167extern void transport_new_cmd_failure(struct se_cmd *);
168extern int transport_generic_handle_tmr(struct se_cmd *);
169extern void __transport_stop_task_timer(struct se_task *, unsigned long *);
170extern unsigned char transport_asciihex_to_binaryhex(unsigned char val[2]);
171extern int transport_generic_map_mem_to_cmd(struct se_cmd *cmd, struct scatterlist *, u32,
172 struct scatterlist *, u32);
173extern int transport_clear_lun_from_sessions(struct se_lun *);
174extern int transport_check_aborted_status(struct se_cmd *, int);
175extern int transport_send_check_condition_and_sense(struct se_cmd *, u8, int);
176extern void transport_send_task_abort(struct se_cmd *);
177extern void transport_release_cmd_to_pool(struct se_cmd *);
178extern void transport_generic_free_cmd(struct se_cmd *, int, int, int);
179extern void transport_generic_wait_for_cmds(struct se_cmd *, int);
180extern u32 transport_calc_sg_num(struct se_task *, struct se_mem *, u32);
181extern int transport_map_mem_to_sg(struct se_task *, struct list_head *,
182 void *, struct se_mem *,
183 struct se_mem **, u32 *, u32 *);
184extern void transport_do_task_sg_chain(struct se_cmd *);
185extern void transport_generic_process_write(struct se_cmd *);
186extern int transport_generic_do_tmr(struct se_cmd *);
187/* From target_core_alua.c */
188extern int core_alua_check_nonop_delay(struct se_cmd *);
189
190/*
191 * Each se_transport_task_t can have N number of possible struct se_task's
192 * for the storage transport(s) to possibly execute.
193 * Used primarily for splitting up CDBs that exceed the physical storage
194 * HBA's maximum sector count per task.
195 */
196struct se_mem {
197 struct page *se_page;
198 u32 se_len;
199 u32 se_off;
200 struct list_head se_list;
201} ____cacheline_aligned;
202
203/*
204 * Each type of disk transport supported MUST have a template defined
205 * within its .h file.
206 */
207struct se_subsystem_api {
208 /*
209 * The Name. :-)
210 */
211 char name[16];
212 /*
213 * Transport Type.
214 */
215 u8 transport_type;
216 /*
217 * struct module for struct se_hba references
218 */
219 struct module *owner;
220 /*
221 * Used for global se_subsystem_api list_head
222 */
223 struct list_head sub_api_list;
224 /*
225 * For SCF_SCSI_NON_DATA_CDB
226 */
227 int (*cdb_none)(struct se_task *);
228 /*
229 * For SCF_SCSI_CONTROL_NONSG_IO_CDB
230 */
231 int (*map_task_non_SG)(struct se_task *);
232 /*
233 * For SCF_SCSI_DATA_SG_IO_CDB and SCF_SCSI_CONTROL_SG_IO_CDB
234 */
235 int (*map_task_SG)(struct se_task *);
236 /*
237 * attach_hba():
238 */
239 int (*attach_hba)(struct se_hba *, u32);
240 /*
241 * detach_hba():
242 */
243 void (*detach_hba)(struct se_hba *);
244 /*
245 * pmode_hba(): Used for TCM/pSCSI subsystem plugin HBA ->
246 * Linux/SCSI struct Scsi_Host passthrough
247 */
248 int (*pmode_enable_hba)(struct se_hba *, unsigned long);
249 /*
250 * allocate_virtdevice():
251 */
252 void *(*allocate_virtdevice)(struct se_hba *, const char *);
253 /*
254 * create_virtdevice(): Only for Virtual HBAs
255 */
256 struct se_device *(*create_virtdevice)(struct se_hba *,
257 struct se_subsystem_dev *, void *);
258 /*
259 * free_device():
260 */
261 void (*free_device)(void *);
262
263 /*
264 * dpo_emulated():
265 */
266 int (*dpo_emulated)(struct se_device *);
267 /*
268 * fua_write_emulated():
269 */
270 int (*fua_write_emulated)(struct se_device *);
271 /*
272 * fua_read_emulated():
273 */
274 int (*fua_read_emulated)(struct se_device *);
275 /*
276 * write_cache_emulated():
277 */
278 int (*write_cache_emulated)(struct se_device *);
279 /*
280 * transport_complete():
281 *
282 * Use transport_generic_complete() for majority of DAS transport
283 * drivers. Provided out of convenience.
284 */
285 int (*transport_complete)(struct se_task *task);
286 struct se_task *(*alloc_task)(struct se_cmd *);
287 /*
288 * do_task():
289 */
290 int (*do_task)(struct se_task *);
291 /*
292 * Used by virtual subsystem plugins IBLOCK and FILEIO to emulate
293 * UNMAP and WRITE_SAME_* w/ UNMAP=1 <-> Linux/Block Discard
294 */
295 int (*do_discard)(struct se_device *, sector_t, u32);
296 /*
297 * Used by virtual subsystem plugins IBLOCK and FILEIO to emulate
298 * SYNCHRONIZE_CACHE_* <-> Linux/Block blkdev_issue_flush()
299 */
300 void (*do_sync_cache)(struct se_task *);
301 /*
302 * free_task():
303 */
304 void (*free_task)(struct se_task *);
305 /*
306 * check_configfs_dev_params():
307 */
308 ssize_t (*check_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *);
309 /*
310 * set_configfs_dev_params():
311 */
312 ssize_t (*set_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *,
313 const char *, ssize_t);
314 /*
315 * show_configfs_dev_params():
316 */
317 ssize_t (*show_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *,
318 char *);
319 /*
320 * get_cdb():
321 */
322 unsigned char *(*get_cdb)(struct se_task *);
323 /*
324 * get_device_rev():
325 */
326 u32 (*get_device_rev)(struct se_device *);
327 /*
328 * get_device_type():
329 */
330 u32 (*get_device_type)(struct se_device *);
331 /*
332 * Get the sector_t from a subsystem backstore..
333 */
334 sector_t (*get_blocks)(struct se_device *);
335 /*
336 * do_se_mem_map():
337 */
338 int (*do_se_mem_map)(struct se_task *, struct list_head *, void *,
339 struct se_mem *, struct se_mem **, u32 *, u32 *);
340 /*
341 * get_sense_buffer():
342 */
343 unsigned char *(*get_sense_buffer)(struct se_task *);
344} ____cacheline_aligned;
345
346#define TRANSPORT(dev) ((dev)->transport)
347#define HBA_TRANSPORT(hba) ((hba)->transport)
348
349extern struct se_global *se_global;
350
351#endif /* TARGET_CORE_TRANSPORT_H */
generated by cgit v1.2.2 (git 2.25.0) at 2026-01-03 07:35:57 -0500