224a2617031587960c07944dd4e1b7c02194b455
[mirror/scst/.git] / scst / src / scst_priv.h
1 /*
2  *  scst_priv.h
3  *  
4  *  Copyright (C) 2004-2006 Vladislav Bolkhovitin <vst@vlnb.net>
5  *                 and Leonid Stoljar
6  *  
7  *  This program is free software; you can redistribute it and/or
8  *  modify it under the terms of the GNU General Public License
9  *  as published by the Free Software Foundation, version 2
10  *  of the License.
11  * 
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  *  GNU General Public License for more details.
16  */
17
18 #ifndef __SCST_PRIV_H
19 #define __SCST_PRIV_H
20
21 #include <linux/types.h>
22
23 #include <scsi/scsi.h>
24 #include <scsi/scsi_cmnd.h>
25 #include <scsi/scsi_driver.h>
26 #include <scsi/scsi_device.h>
27 #include <scsi/scsi_host.h>
28
29 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,18)
30 #include <scsi/scsi_request.h>
31 #endif
32
33 #define SCST_MAJOR              177
34
35 #define TRACE_RETRY             0x80000000
36 #define TRACE_SCSI_SERIALIZING  0x40000000
37 #define TRACE_SEND_TOP          0x20000000 /** top being the edge away from the interupt */
38 #define TRACE_RECV_TOP          0x01000000 
39 #define TRACE_SEND_BOT          0x08000000 /** bottom being the edge toward the interupt */
40 #define TRACE_RECV_BOT          0x04000000
41
42 #define LOG_PREFIX "scst"
43
44 #ifdef DEBUG
45 /*#define SCST_DEFAULT_LOG_FLAGS (TRACE_ALL & ~TRACE_MEMORY & ~TRACE_BUFF \
46          & ~TRACE_FUNCTION)
47 #define SCST_DEFAULT_LOG_FLAGS (TRACE_ALL & ~TRACE_MEMORY & ~TRACE_BUFF & \
48         ~TRACE_SCSI & ~TRACE_SCSI_SERIALIZING & ~TRACE_DEBUG)
49 */
50 #define SCST_DEFAULT_LOG_FLAGS (TRACE_OUT_OF_MEM | TRACE_MINOR | TRACE_PID | \
51         TRACE_FUNCTION | TRACE_SPECIAL | TRACE_MGMT | TRACE_MGMT_DEBUG | \
52         TRACE_RETRY)
53 #else
54 # ifdef TRACING
55 #define SCST_DEFAULT_LOG_FLAGS (TRACE_OUT_OF_MEM | TRACE_MINOR | TRACE_PID | \
56         TRACE_SPECIAL)
57 # else
58 #define SCST_DEFAULT_LOG_FLAGS 0
59 # endif
60 #endif
61
62 /**
63  ** Bits for scst_flags 
64  **/
65
66 /* Set if new commands initialization should be suspended for a while */
67 #define SCST_FLAG_SUSPENDED                  0
68
69 /*
70  * If set, SCST's threads exit immediately not performing any
71  * sessions' shutdown tasks, therefore at this point all the sessions
72  * must be already down.
73  */
74 #define SCST_FLAG_SHUTDOWN                   1
75
76 /* Set if a TM command is being performed */
77 #define SCST_FLAG_TM_ACTIVE                  2
78
79 /* Set if scst_cmd_mem_work is scheduled */
80 #define SCST_FLAG_CMD_MEM_WORK_SCHEDULED     3
81
82 /** 
83  ** Return codes for cmd state process functions 
84  **/
85 #define SCST_CMD_STATE_RES_CONT_SAME         0
86 #define SCST_CMD_STATE_RES_CONT_NEXT         1
87 #define SCST_CMD_STATE_RES_NEED_THREAD       2
88 #define SCST_CMD_STATE_RES_RESTART           3
89
90 /** Name of the "default" security group **/
91 #define SCST_DEFAULT_ACG_NAME                "Default"
92
93 /**
94  ** Maximum count of uncompleted commands that an initiator could 
95  ** queue on any device. Then it will take TASK QUEUE FULL status.
96  **/
97 #define SCST_MAX_DEVICE_COMMANDS           128
98
99 #define SCST_THREAD_FLAGS                  CLONE_KERNEL
100
101 #define SCST_TGT_RETRY_TIMEOUT             (3/2*HZ)
102 #define SCST_CMD_MEM_TIMEOUT               (120*HZ)
103
104 static inline int scst_get_context(void) {
105         if (in_irq())
106                 return SCST_CONTEXT_TASKLET;
107         if (in_softirq())
108                 return SCST_CONTEXT_DIRECT_ATOMIC;
109         if (in_interrupt()) /* Is it possible? */
110                 return SCST_CONTEXT_THREAD;
111         if (in_atomic())
112                 return SCST_CONTEXT_DIRECT_ATOMIC;
113         return SCST_CONTEXT_DIRECT;
114 }
115
116 #define SCST_MGMT_CMD_CACHE_STRING "scst_mgmt_cmd"
117 extern kmem_cache_t *scst_mgmt_cachep;
118 extern mempool_t *scst_mgmt_mempool;
119
120 #define SCST_UA_CACHE_STRING "scst_ua"
121 extern kmem_cache_t *scst_ua_cachep;
122 extern mempool_t *scst_ua_mempool;
123
124 #define SCST_CMD_CACHE_STRING "scst_cmd"
125 extern kmem_cache_t *scst_cmd_cachep;
126
127 #define SCST_SESSION_CACHE_STRING "scst_session"
128 extern kmem_cache_t *scst_sess_cachep;
129
130 #define SCST_TGT_DEV_CACHE_STRING "scst_tgt_dev"
131 extern kmem_cache_t *scst_tgtd_cachep;
132
133 #define SCST_ACG_DEV_CACHE_STRING "scst_acg_dev"
134 extern kmem_cache_t *scst_acgd_cachep;
135
136 extern struct scst_sgv_pools scst_sgv;
137
138 extern int scst_num_cpus;
139 extern unsigned long scst_flags;
140 extern struct semaphore scst_mutex;
141 extern atomic_t scst_cmd_count;
142 extern spinlock_t scst_list_lock;
143 extern struct list_head scst_dev_wait_sess_list; /* protected by scst_list_lock */
144 extern struct list_head scst_template_list; /* protected by scst_mutex */
145 extern struct list_head scst_dev_list; /* protected by scst_mutex */
146 extern struct list_head scst_dev_type_list; /* protected by scst_mutex */
147 extern wait_queue_head_t scst_dev_cmd_waitQ;
148
149 extern struct list_head scst_acg_list;
150 extern struct scst_acg *scst_default_acg;
151
152 /* The following lists protected by scst_list_lock */
153 extern struct list_head scst_active_cmd_list;
154 extern struct list_head scst_init_cmd_list;
155 extern struct list_head scst_cmd_list;
156
157 extern spinlock_t scst_cmd_mem_lock;
158 extern unsigned long scst_max_cmd_mem, scst_cur_max_cmd_mem, scst_cur_cmd_mem;
159 extern struct work_struct scst_cmd_mem_work;
160
161 /* The following lists protected by scst_list_lock as well */
162 extern struct list_head scst_mgmt_cmd_list;
163 extern struct list_head scst_active_mgmt_cmd_list;
164 extern struct list_head scst_delayed_mgmt_cmd_list;
165
166 extern struct tasklet_struct scst_tasklets[NR_CPUS];
167 extern wait_queue_head_t scst_list_waitQ;
168
169 extern wait_queue_head_t scst_mgmt_cmd_list_waitQ;
170
171 extern wait_queue_head_t scst_mgmt_waitQ;
172 extern spinlock_t scst_mgmt_lock;
173 extern struct list_head scst_sess_mgmt_list;
174
175 extern int scst_threads;
176 extern int scst_shut_threads_count;
177 extern atomic_t scst_threads_count;
178 extern int scst_thread_num;
179
180 extern struct semaphore *scst_shutdown_mutex;
181
182 extern spinlock_t scst_temp_UA_lock;
183 extern uint8_t scst_temp_UA[SCSI_SENSE_BUFFERSIZE];
184
185 extern struct scst_cmd *__scst_check_deferred_commands(
186         struct scst_tgt_dev *tgt_dev, int expected_sn);
187
188 /* Used to save the function call on th fast path */
189 static inline struct scst_cmd *scst_check_deferred_commands(
190         struct scst_tgt_dev *tgt_dev, int expected_sn)
191 {
192         if (tgt_dev->def_cmd_count == 0)
193                 return NULL;
194         else
195                 return __scst_check_deferred_commands(tgt_dev, expected_sn);
196 }
197
198 static inline int __scst_inc_expected_sn(struct scst_tgt_dev *tgt_dev)
199 {
200         /*
201          * No locks is needed, because only one thread at time can 
202          * call it (serialized by sn). Also it is supposed that there
203          * could not be half-incremented halves.
204          */
205
206         typeof(tgt_dev->expected_sn) e;
207
208         e = tgt_dev->expected_sn;
209         tgt_dev->expected_sn++;
210         smp_mb(); /* write must be before def_cmd_count read */
211         e++;
212         TRACE(TRACE_DEBUG/*TRACE_SCSI_SERIALIZING*/, "Next expected_sn: %d", e);
213         return e;
214 }
215
216 void scst_inc_expected_sn_unblock(struct scst_tgt_dev *tgt_dev,
217         struct scst_cmd *cmd_sn, int locked);
218
219 int scst_cmd_thread(void *arg);
220 void scst_cmd_tasklet(long p);
221 int scst_mgmt_cmd_thread(void *arg);
222 int scst_mgmt_thread(void *arg);
223 void scst_cmd_mem_work_fn(void *p);
224
225 struct scst_device *scst_alloc_device(int gfp_mask);
226 void scst_free_device(struct scst_device *tgt_dev);
227
228 struct scst_acg *scst_alloc_add_acg(const char *acg_name);
229 int scst_destroy_acg(struct scst_acg *acg);
230
231 int scst_sess_alloc_tgt_devs(struct scst_session *sess);
232 void scst_sess_free_tgt_devs(struct scst_session *sess);
233 void scst_reset_tgt_dev(struct scst_tgt_dev *tgt_dev, int nexus_loss);
234
235 int scst_acg_add_dev(struct scst_acg *acg, struct scst_device *dev, lun_t lun,
236         int read_only);
237 int scst_acg_remove_dev(struct scst_acg *acg, struct scst_device *dev);
238
239 int scst_acg_add_name(struct scst_acg *acg, const char *name);
240 int scst_acg_remove_name(struct scst_acg *acg, const char *name);
241
242 int scst_assign_dev_handler(struct scst_device *dev, 
243         struct scst_dev_type *handler);
244
245 struct scst_session *scst_alloc_session(struct scst_tgt *tgt, int gfp_mask,
246         const char *initiator_name);
247 void scst_free_session(struct scst_session *sess);
248 void scst_free_session_callback(struct scst_session *sess);
249
250 struct scst_cmd *scst_alloc_cmd(int gfp_mask);
251 void scst_free_cmd(struct scst_cmd *cmd);
252 static inline void scst_destroy_cmd(struct scst_cmd *cmd)
253 {
254         kmem_cache_free(scst_cmd_cachep, cmd);
255         return;
256 }
257
258 void scst_proccess_redirect_cmd(struct scst_cmd *cmd, int context,
259         int check_retries);
260 void scst_check_retries(struct scst_tgt *tgt, int processible_env);
261 void scst_tgt_retry_timer_fn(unsigned long arg);
262
263 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,18)
264 int scst_alloc_request(struct scst_cmd *cmd);
265 void scst_release_request(struct scst_cmd *cmd);
266
267 static inline void scst_do_req(struct scsi_request *sreq, 
268         const void *cmnd, void *buffer, unsigned bufflen, 
269         void (*done)(struct scsi_cmnd *), int timeout, int retries)
270 {
271     #ifdef STRICT_SERIALIZING
272         scsi_do_req(sreq, cmnd, buffer, bufflen, done, timeout, retries);
273     #elif defined(FILEIO_ONLY)
274         BUG();
275     #else
276         scsi_do_req_fifo(sreq, cmnd, buffer, bufflen, done, timeout, retries);
277     #endif
278 }
279 #else
280 static inline int scst_exec_req(struct scsi_device *sdev,
281         const unsigned char *cmd, int cmd_len, int data_direction,
282         void *buffer, unsigned bufflen, int use_sg, int timeout, int retries,
283         void *privdata, void (*done)(void *, char *, int, int), gfp_t gfp)
284 {
285     #ifdef STRICT_SERIALIZING
286         return scsi_execute_async(sdev, cmd, cmd_len, data_direction, buffer,
287                 bufflen, use_sg, timeout, retries, privdata, done, gfp);
288     #elif defined(FILEIO_ONLY)
289         BUG();
290         return -1;
291     #else
292         return scsi_execute_async_fifo(sdev, cmd, cmd_len, data_direction,
293                 buffer, bufflen, use_sg, timeout, retries, privdata, done, gfp);
294     #endif
295 }
296 #endif
297
298 int scst_alloc_space(struct scst_cmd *cmd);
299 void scst_release_space(struct scst_cmd *cmd);
300 void scst_scsi_op_list_init(void);
301
302 lun_t scst_unpack_lun(const uint8_t *lun, int len);
303
304 struct scst_cmd *__scst_find_cmd_by_tag(struct scst_session *sess, 
305         uint32_t tag);
306
307 struct scst_mgmt_cmd *scst_alloc_mgmt_cmd(int gfp_mask);
308 void scst_free_mgmt_cmd(struct scst_mgmt_cmd *mcmd, int del);
309
310 /* /proc support */
311 int scst_proc_init_module(void);
312 void scst_proc_cleanup_module(void);
313 int scst_build_proc_target_dir_entries(struct scst_tgt_template *vtt);
314 void scst_cleanup_proc_target_dir_entries(struct scst_tgt_template *vtt);
315 int scst_build_proc_target_entries(struct scst_tgt *vtt);
316 void scst_cleanup_proc_target_entries(struct scst_tgt *vtt);
317 int scst_build_proc_dev_handler_dir_entries(struct scst_dev_type *dev_type);
318 void scst_cleanup_proc_dev_handler_dir_entries(struct scst_dev_type *dev_type);
319
320 int scst_get_cdb_len(const uint8_t *cdb);
321
322 void __scst_process_UA(struct scst_device *dev, struct scst_cmd *exclude,
323         const uint8_t *sense, int sense_len, int internal);
324 static inline void scst_process_UA(struct scst_device *dev,
325         struct scst_cmd *exclude, const uint8_t *sense, int sense_len,
326         int internal)
327 {
328         spin_lock_bh(&dev->dev_lock);
329         __scst_process_UA(dev, exclude, sense, sense_len, internal);
330         spin_unlock_bh(&dev->dev_lock);
331         return;
332 }
333 void scst_alloc_set_UA(struct scst_tgt_dev *tgt_dev, const uint8_t *sense,
334         int sense_len);
335 void scst_check_set_UA(struct scst_tgt_dev *tgt_dev,
336         const uint8_t *sense, int sense_len);
337 int scst_set_pending_UA(struct scst_cmd *cmd);
338 void scst_free_all_UA(struct scst_tgt_dev *tgt_dev);
339
340 void scst_abort_cmd(struct scst_cmd *cmd, struct scst_mgmt_cmd *mcmd,
341         int other_ini, int call_dev_task_mgmt_fn);
342 void scst_process_reset(struct scst_device *dev,
343         struct scst_session *originator, struct scst_cmd *exclude_cmd,
344         struct scst_mgmt_cmd *mcmd);
345
346 static inline int scst_is_ua_command(struct scst_cmd *cmd)
347 {
348         return ((cmd->cdb[0] != INQUIRY) && 
349                 (cmd->cdb[0] != REQUEST_SENSE) &&
350                 (cmd->cdb[0] != REPORT_LUNS));
351 }
352
353 /*
354  * Returns 1, if cmd's CDB is locally handled by SCST and 0 otherwise.
355  * Dev handlers parse() and dev_done() not called for such commands.
356  */
357 static inline int scst_is_cmd_local(struct scst_cmd *cmd)
358 {
359         int res = 0;
360         switch (cmd->cdb[0]) {
361         case REPORT_LUNS:
362                 res = 1;
363         }
364         return res;
365 }
366
367 /*
368  * Some notes on devices "blocking". Blocking means that no
369  * commands will go from SCST to underlying SCSI device until it 
370  * is unblocked. But we don't care about all commands that 
371  * already on the device.
372  */
373
374 extern int scst_inc_on_dev_cmd(struct scst_cmd *cmd);
375 extern void scst_unblock_cmds(struct scst_device *dev);
376
377 static inline void __scst_block_dev(struct scst_device *dev)
378 {
379         dev->block_count++;
380         smp_mb();
381         TRACE_MGMT_DBG("Device BLOCK(%d), dev %p", dev->block_count, dev);
382 }
383
384 static inline void scst_block_dev(struct scst_device *dev, 
385         unsigned int outstanding)
386 {
387         spin_lock_bh(&dev->dev_lock);
388         __scst_block_dev(dev);
389         spin_unlock_bh(&dev->dev_lock);
390
391         TRACE_MGMT_DBG("Waiting during blocking outstanding %d (on_dev_count "
392                 "%d)", outstanding, atomic_read(&dev->on_dev_count));
393         wait_event(dev->on_dev_waitQ, 
394                 atomic_read(&dev->on_dev_count) <= outstanding);
395         TRACE_MGMT_DBG("%s", "wait_event() returned");
396 }
397
398 static inline void scst_unblock_dev(struct scst_device *dev)
399 {
400         spin_lock_bh(&dev->dev_lock);
401         TRACE_MGMT_DBG("Device UNBLOCK(%d), dev %p",
402                 dev->block_count-1, dev);
403         if (--dev->block_count == 0)
404                 scst_unblock_cmds(dev);
405         spin_unlock_bh(&dev->dev_lock);
406 }
407
408 static inline void scst_dec_on_dev_cmd(struct scst_cmd *cmd)
409 {
410         if (cmd->blocking) {
411                 TRACE_MGMT_DBG("cmd %p (tag %d): unblocking dev %p", cmd,
412                         cmd->tag, cmd->dev);
413                 cmd->blocking = 0;
414                 scst_unblock_dev(cmd->dev);
415         }
416         atomic_dec(&cmd->dev->on_dev_count);
417         smp_mb__after_atomic_dec();
418         if (unlikely(cmd->dev->block_count != 0))
419                 wake_up_all(&cmd->dev->on_dev_waitQ);
420 }
421
422 static inline void scst_inc_cmd_count(void)
423 {
424         atomic_inc(&scst_cmd_count);
425         smp_mb__after_atomic_inc();
426         TRACE_DBG("Incrementing scst_cmd_count(%d)",
427               atomic_read(&scst_cmd_count));
428 }
429
430 static inline void scst_dec_cmd_count(void)
431 {
432         int f;
433         f = atomic_dec_and_test(&scst_cmd_count);
434         smp_mb__after_atomic_dec();
435         if (f && unlikely(test_bit(SCST_FLAG_SUSPENDED, &scst_flags)))
436                 wake_up_all(&scst_dev_cmd_waitQ);
437         TRACE_DBG("Decrementing scst_cmd_count(%d)",
438               atomic_read(&scst_cmd_count));
439 }
440
441 void scst_sched_session_free(struct scst_session *sess);
442
443 static inline void scst_sess_get(struct scst_session *sess)
444 {
445         atomic_inc(&sess->refcnt);
446 }
447
448 static inline void scst_sess_put(struct scst_session *sess)
449 {
450         if (atomic_dec_and_test(&sess->refcnt))
451                 scst_sched_session_free(sess);
452 }
453
454 void __scst_suspend_activity(void);
455 void __scst_resume_activity(void);
456
457 extern void scst_throttle_cmd(struct scst_cmd *cmd);
458 extern void scst_unthrottle_cmd(struct scst_cmd *cmd);
459
460 static inline void scst_set_sense(uint8_t *buffer, int len, int key,
461         int asc, int ascq)
462 {
463         memset(buffer, 0, len);
464         buffer[0] = 0x70;       /* Error Code                   */
465         buffer[2] = key;        /* Sense Key                    */
466         buffer[7] = 0x0a;       /* Additional Sense Length      */
467         buffer[12] = asc;       /* ASC                          */
468         buffer[13] = ascq;      /* ASCQ                         */
469         TRACE_BUFFER("Sense set", buffer, len);
470         return;
471 }
472
473 static inline void scst_check_restore_sg_buff(struct scst_cmd *cmd)
474 {
475         if (cmd->sg_buff_modified) {
476                 cmd->sg[cmd->orig_sg_entry].length = cmd->orig_entry_len;
477                 cmd->sg_cnt = cmd->orig_sg_cnt;
478         }
479 }
480
481 #ifdef DEBUG_TM
482 extern void tm_dbg_init_tgt_dev(struct scst_tgt_dev *tgt_dev,
483         struct scst_acg_dev *acg_dev);
484 extern void tm_dbg_deinit_tgt_dev(struct scst_tgt_dev *tgt_dev);
485 extern void tm_dbg_check_released_cmds(void);
486 extern int tm_dbg_check_cmd(struct scst_cmd *cmd);
487 extern void tm_dbg_release_cmd(struct scst_cmd *cmd);
488 extern void tm_dbg_task_mgmt(const char *fn);
489 extern int tm_dbg_is_release(void);
490 #else
491 static inline void tm_dbg_init_tgt_dev(struct scst_tgt_dev *tgt_dev,
492         struct scst_acg_dev *acg_dev) {}
493 static inline void tm_dbg_deinit_tgt_dev(struct scst_tgt_dev *tgt_dev) {}
494 static inline void tm_dbg_check_released_cmds(void) {}
495 static inline int tm_dbg_check_cmd(struct scst_cmd *cmd)
496 {
497         return 0;
498 }
499 static inline void tm_dbg_release_cmd(struct scst_cmd *cmd) {}
500 static inline void tm_dbg_task_mgmt(const char *fn) {}
501 static inline int tm_dbg_is_release(void)
502 {
503         return 0;
504 }
505 #endif /* DEBUG_TM */
506
507 #endif /* __SCST_PRIV_H */