isc_cam.c revision 196352 
1/*-
2 * Copyright (c) 2005-2008 Daniel Braniss <danny@cs.huji.ac.il>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 */
27
28#include <sys/cdefs.h>
29__FBSDID("$FreeBSD: head/sys/dev/iscsi/initiator/isc_cam.c 196352 2009-08-18 08:46:54Z mav $");
30
31#include "opt_iscsi_initiator.h"
32
33#include <sys/param.h>
34#include <sys/kernel.h>
35#include <sys/callout.h>
36#if __FreeBSD_version >= 700000
37#include <sys/lock.h>
38#include <sys/mutex.h>
39#endif
40#include <sys/conf.h>
41#include <sys/systm.h>
42#include <sys/malloc.h>
43#include <sys/mbuf.h>
44#include <sys/uio.h>
45#include <sys/sysctl.h>
46
47#include <cam/cam.h>
48#include <cam/cam_ccb.h>
49#include <cam/cam_sim.h>
50#include <cam/cam_xpt_sim.h>
51#include <cam/cam_periph.h>
52
53#include <dev/iscsi/initiator/iscsi.h>
54#include <dev/iscsi/initiator/iscsivar.h>
55
56// XXX: untested/incomplete
57void
58ic_freeze(isc_session_t *sp)
59{
60     debug_called(8);
61#if 0
62     sdebug(2, "freezing path=%p", sp->cam_path == NULL? 0: sp->cam_path);
63     if((sp->cam_path != NULL) && !(sp->flags & ISC_FROZEN)) {
64	  xpt_freeze_devq(sp->cam_path, 1);
65     }
66#endif
67     sp->flags |= ISC_FROZEN;
68}
69
70// XXX: untested/incomplete
71void
72ic_release(isc_session_t *sp)
73{
74     debug_called(8);
75#if 0
76     sdebug(2, "release path=%p", sp->cam_path == NULL? 0: sp->cam_path);
77     if((sp->cam_path != NULL) && (sp->flags & ISC_FROZEN)) {
78	  xpt_release_devq(sp->cam_path, 1, TRUE);
79     }
80#endif
81     sp->flags &= ~ISC_FROZEN;
82}
83
84void
85ic_lost_target(isc_session_t *sp, int target)
86{
87     struct isc_softc   *isp = sp->isc;
88
89     debug_called(8);
90     sdebug(2, "target=%d", target);
91     if(sp->cam_path != NULL) {
92	  mtx_lock(&isp->cam_mtx);
93	  xpt_async(AC_LOST_DEVICE, sp->cam_path, NULL);
94	  xpt_free_path(sp->cam_path);
95	  mtx_unlock(&isp->cam_mtx);
96	  sp->cam_path = 0; // XXX
97     }
98}
99
100static void
101_scan_callback(struct cam_periph *periph, union ccb *ccb)
102{
103     isc_session_t *sp = (isc_session_t *)ccb->ccb_h.spriv_ptr0;
104
105     debug_called(8);
106
107     free(ccb, M_TEMP);
108
109     if(sp->flags & ISC_FFPWAIT) {
110	  sp->flags &= ~ISC_FFPWAIT;
111	  wakeup(sp);
112     }
113}
114
115static void
116_scan_target(isc_session_t *sp, int target)
117{
118     union ccb		*ccb;
119
120     debug_called(8);
121     sdebug(2, "target=%d", target);
122
123     if((ccb = malloc(sizeof(union ccb), M_TEMP, M_WAITOK | M_ZERO)) == NULL) {
124	  xdebug("scan failed (can't allocate CCB)");
125	  return;
126     }
127     CAM_LOCK(sp->isc);
128     xpt_setup_ccb(&ccb->ccb_h, sp->cam_path, 5/*priority (low)*/);
129     ccb->ccb_h.func_code	= XPT_SCAN_BUS;
130     ccb->ccb_h.cbfcnp		= _scan_callback;
131     ccb->crcn.flags		= CAM_FLAG_NONE;
132     ccb->ccb_h.spriv_ptr0	= sp;
133
134     xpt_action(ccb);
135     CAM_UNLOCK(sp->isc);
136}
137
138int
139ic_fullfeature(struct cdev *dev)
140{
141     struct isc_softc 	*isp = dev->si_drv1;
142     isc_session_t	*sp = (isc_session_t *)dev->si_drv2;
143
144     debug_called(8);
145     sdebug(3, "dev=%d sc=%p", dev2unit(dev), isp);
146
147     sp->flags &= ~ISC_FFPHASE;
148     sp->flags |= ISC_FFPWAIT;
149
150     CAM_LOCK(isp);
151     if(xpt_create_path(&sp->cam_path, xpt_periph, cam_sim_path(sp->isc->cam_sim),
152			sp->sid, CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
153	  xdebug("can't create cam path");
154	  CAM_UNLOCK(isp);
155	  return ENODEV; // XXX
156     }
157     CAM_UNLOCK(isp);
158
159     _scan_target(sp, sp->sid);
160
161     while(sp->flags & ISC_FFPWAIT)
162	  tsleep(sp, PRIBIO, "ffp", 5*hz); // the timeout time should
163					    // be configurable
164     if(sp->target_nluns > 0) {
165	  sp->flags |= ISC_FFPHASE;
166	  return 0;
167     }
168
169     return ENODEV;
170}
171
172static void
173_inq(struct cam_sim *sim, union ccb *ccb, int maxluns)
174{
175     struct ccb_pathinq *cpi = &ccb->cpi;
176
177     debug_called(4);
178
179     cpi->version_num = 1; /* XXX??? */
180     cpi->hba_inquiry = PI_SDTR_ABLE | PI_TAG_ABLE | PI_WIDE_32;
181     cpi->target_sprt = 0;
182     cpi->hba_misc = 0;
183     cpi->hba_eng_cnt = 0;
184     cpi->max_target = ISCSI_MAX_TARGETS - 1;
185     cpi->initiator_id = ISCSI_MAX_TARGETS;
186     cpi->max_lun = maxluns;
187     cpi->bus_id = cam_sim_bus(sim);
188     cpi->base_transfer_speed = 3300;
189     strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
190     strncpy(cpi->hba_vid, "iSCSI", HBA_IDLEN);
191     strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
192     cpi->unit_number = cam_sim_unit(sim);
193     cpi->transport = XPORT_ISCSI;
194     cpi->transport_version = 0;
195     cpi->ccb_h.status = CAM_REQ_CMP;
196}
197
198static __inline int
199_scsi_encap(struct cam_sim *sim, union ccb *ccb)
200{
201     int		ret;
202
203#if __FreeBSD_version < 700000
204     ret = scsi_encap(sim, ccb);
205#else
206     struct isc_softc	*isp = (struct isc_softc *)cam_sim_softc(sim);
207
208     mtx_unlock(&isp->cam_mtx);
209     ret = scsi_encap(sim, ccb);
210     mtx_lock(&isp->cam_mtx);
211#endif
212     return ret;
213}
214
215static void
216ic_action(struct cam_sim *sim, union ccb *ccb)
217{
218     struct ccb_hdr	*ccb_h = &ccb->ccb_h;
219     struct isc_softc	*isp = (struct isc_softc *)cam_sim_softc(sim);
220     isc_session_t	*sp;
221
222     debug_called(8);
223
224     if((ccb_h->target_id != CAM_TARGET_WILDCARD) && (ccb_h->target_id < MAX_SESSIONS))
225	  sp = isp->sessions[ccb_h->target_id];
226     else
227	  sp = NULL;
228
229     ccb_h->spriv_ptr0 = sp;
230
231     debug(4, "func_code=0x%x flags=0x%x status=0x%x target=%d lun=%d retry_count=%d timeout=%d",
232	   ccb_h->func_code, ccb->ccb_h.flags, ccb->ccb_h.status,
233	   ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
234	   ccb->ccb_h.retry_count, ccb_h->timeout);
235     /*
236      | first quick check
237      */
238     switch(ccb_h->func_code) {
239     default:
240	  // XXX: maybe check something else?
241	  break;
242
243     case XPT_SCSI_IO:
244     case XPT_RESET_DEV:
245     case XPT_GET_TRAN_SETTINGS:
246     case XPT_SET_TRAN_SETTINGS:
247     case XPT_CALC_GEOMETRY:
248	  if(sp == NULL) {
249	       ccb->ccb_h.status = CAM_DEV_NOT_THERE;
250#if __FreeBSD_version < 700000
251	       XPT_DONE(isp, ccb);
252#else
253	       xpt_done(ccb);
254#endif
255	       return;
256	  }
257	  break;
258
259     case XPT_PATH_INQ:
260     case XPT_NOOP:
261	  if(sp == NULL && ccb->ccb_h.target_id != CAM_TARGET_WILDCARD) {
262	       ccb->ccb_h.status = CAM_DEV_NOT_THERE;
263#if __FreeBSD_version < 700000
264	       XPT_DONE(isp, ccb);
265#else
266	       xpt_done(ccb);
267#endif
268	       debug(4, "status = CAM_DEV_NOT_THERE");
269	       return;
270	  }
271     }
272
273     switch(ccb_h->func_code) {
274
275     case XPT_PATH_INQ:
276	  _inq(sim, ccb, (sp? sp->opt.maxluns: ISCSI_MAX_LUNS) - 1);
277	  break;
278
279     case XPT_RESET_BUS: // (can just be a stub that does nothing and completes)
280     {
281	  struct ccb_pathinq *cpi = &ccb->cpi;
282
283	  debug(3, "XPT_RESET_BUS");
284	  cpi->ccb_h.status = CAM_REQ_CMP;
285	  break;
286     }
287
288     case XPT_SCSI_IO:
289     {
290	  struct ccb_scsiio* csio = &ccb->csio;
291
292	  debug(4, "XPT_SCSI_IO cmd=0x%x", csio->cdb_io.cdb_bytes[0]);
293	  if(sp == NULL) {
294	       ccb_h->status = CAM_REQ_INVALID; //CAM_NO_NEXUS;
295	       debug(4, "xpt_done.status=%d", ccb_h->status);
296	       break;
297	  }
298	  if(ccb_h->target_lun == CAM_LUN_WILDCARD) {
299	       debug(3, "target=%d: bad lun (-1)", ccb_h->target_id);
300	       ccb_h->status = CAM_LUN_INVALID;
301	       break;
302	  }
303	  if(_scsi_encap(sim, ccb) != 0)
304	       return;
305	  break;
306     }
307
308     case XPT_CALC_GEOMETRY:
309     {
310	  struct	ccb_calc_geometry *ccg;
311
312	  ccg = &ccb->ccg;
313	  debug(6, "XPT_CALC_GEOMETRY vsize=%jd bsize=%d", ccg->volume_size, ccg->block_size);
314	  if(ccg->block_size == 0 ||
315	     (ccg->volume_size < ccg->block_size)) {
316	       // print error message  ...
317	       /* XXX: what error is appropiate? */
318	       break;
319	  } else
320	       cam_calc_geometry(ccg, /*extended*/1);
321	  break;
322     }
323
324     case XPT_GET_TRAN_SETTINGS:
325     default:
326	  ccb_h->status = CAM_REQ_INVALID;
327	  break;
328     }
329#if __FreeBSD_version < 700000
330     XPT_DONE(isp, ccb);
331#else
332     xpt_done(ccb);
333#endif
334     return;
335}
336
337static void
338ic_poll(struct cam_sim *sim)
339{
340     debug_called(8);
341
342}
343
344int
345ic_getCamVals(isc_session_t *sp, iscsi_cam_t *cp)
346{
347     int	i;
348
349     debug_called(8);
350
351     if(sp && sp->isc->cam_sim) {
352	  cp->path_id = cam_sim_path(sp->isc->cam_sim);
353	  cp->target_id = sp->sid;
354	  cp->target_nluns = sp->target_nluns; // XXX: -1?
355	  for(i = 0; i < cp->target_nluns; i++)
356	       cp->target_lun[i] = sp->target_lun[i];
357	  return 0;
358     }
359     return ENXIO;
360}
361
362void
363ic_destroy(struct isc_softc *isp)
364{
365     debug_called(8);
366
367     CAM_LOCK(isp); // can't harm :-)
368
369     xpt_async(AC_LOST_DEVICE, isp->cam_path, NULL);
370     xpt_free_path(isp->cam_path);
371
372     xpt_bus_deregister(cam_sim_path(isp->cam_sim));
373     cam_sim_free(isp->cam_sim, TRUE /*free_devq*/);
374
375     CAM_UNLOCK(isp);
376}
377
378int
379ic_init(struct isc_softc *isp)
380{
381     struct cam_sim	*sim;
382     struct cam_devq	*devq;
383     struct cam_path	*path;
384
385     if((devq = cam_simq_alloc(256)) == NULL)
386	  return ENOMEM;
387
388#if __FreeBSD_version >= 700000
389     mtx_init(&isp->cam_mtx, "isc-cam", NULL, MTX_DEF);
390#else
391     isp->cam_mtx = Giant;
392#endif
393     sim = cam_sim_alloc(ic_action, ic_poll,
394			 "iscsi", isp, 0/*unit*/,
395#if __FreeBSD_version >= 700000
396			 &isp->cam_mtx,
397#endif
398			 1/*max_dev_transactions*/,
399			 100/*max_tagged_dev_transactions*/,
400			 devq);
401     if(sim == NULL) {
402	  cam_simq_free(devq);
403#if __FreeBSD_version >= 700000
404	  mtx_destroy(&isp->cam_mtx);
405#endif
406	  return ENXIO;
407     }
408     CAM_LOCK(isp);
409     if(xpt_bus_register(sim,
410#if __FreeBSD_version >= 700000
411			 NULL,
412#endif
413			 0/*bus_number*/) != CAM_SUCCESS)
414	  goto bad;
415
416     if(xpt_create_path(&path, xpt_periph, cam_sim_path(sim),
417			CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
418	  xpt_bus_deregister(cam_sim_path(sim));
419	  goto bad;
420     }
421
422     CAM_UNLOCK(isp);
423
424     isp->cam_sim = sim;
425     isp->cam_path = path;
426
427     debug(2, "cam subsystem initialized"); // XXX: add dev ...
428     debug(4, "sim=%p path=%p", sim, path);
429     return 0;
430
431 bad:
432     cam_sim_free(sim, /*free_devq*/TRUE);
433     CAM_UNLOCK(isp);
434#if __FreeBSD_version >= 700000
435     mtx_destroy(&isp->cam_mtx);
436#endif
437     return ENXIO;
438}
439