xref: /dragonfly/sys/dev/disk/iscsi/initiator/isc_cam.c (revision 2b7dbe20)
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  * $FreeBSD: src/sys/dev/iscsi/initiator/isc_cam.c,v 1.3 2008/11/25 07:17:11 scottl Exp $
27  */
28 
29 #include <sys/param.h>
30 #include <sys/kernel.h>
31 #include <sys/callout.h>
32 #include <sys/lock.h>
33 #include <sys/conf.h>
34 #include <sys/systm.h>
35 #include <sys/malloc.h>
36 #include <sys/mbuf.h>
37 #include <sys/uio.h>
38 #include <sys/sysctl.h>
39 #include <sys/eventhandler.h>
40 #include <sys/globaldata.h>
41 
42 #include <bus/cam/cam.h>
43 #include <bus/cam/cam_ccb.h>
44 #include <bus/cam/cam_sim.h>
45 #include <bus/cam/cam_xpt.h>
46 #include <bus/cam/cam_xpt_sim.h>
47 #include <bus/cam/cam_xpt_periph.h>
48 #include <bus/cam/cam_periph.h>
49 
50 #include <dev/disk/iscsi/initiator/iscsi.h>
51 #include <dev/disk/iscsi/initiator/iscsivar.h>
52 
53 // XXX: untested/incomplete
54 void
55 ic_freeze(isc_session_t *sp)
56 {
57      debug_called(8);
58 #if 0
59      sdebug(2, "freezing path=%p", sp->cam_path == NULL? 0: sp->cam_path);
60      if((sp->cam_path != NULL) && !(sp->flags & ISC_FROZEN)) {
61 	  xpt_freeze_devq(sp->cam_path, 1);
62      }
63 #endif
64      sp->flags |= ISC_FROZEN;
65 }
66 
67 // XXX: untested/incomplete
68 void
69 ic_release(isc_session_t *sp)
70 {
71      debug_called(8);
72 #if 0
73      sdebug(2, "release path=%p", sp->cam_path == NULL? 0: sp->cam_path);
74      if((sp->cam_path != NULL) && (sp->flags & ISC_FROZEN)) {
75 	  xpt_release_devq(sp->cam_path, 1, true);
76      }
77 #endif
78      sp->flags &= ~ISC_FROZEN;
79 }
80 
81 void
82 ic_lost_target(isc_session_t *sp, int target)
83 {
84      struct isc_softc   *isp = sp->isc;
85 
86      debug_called(8);
87      sdebug(2, "target=%d", target);
88      if(sp->cam_path != NULL) {
89 	  lockmgr(&isp->cam_lock, LK_EXCLUSIVE);
90 	  xpt_async(AC_LOST_DEVICE, sp->cam_path, NULL);
91 	  xpt_free_path(sp->cam_path);
92 	  lockmgr(&isp->cam_lock, LK_RELEASE);
93 	  sp->cam_path = 0; // XXX
94      }
95 }
96 
97 static void
98 _scan_callback(struct cam_periph *periph, union ccb *ccb)
99 {
100      isc_session_t *sp = (isc_session_t *)ccb->ccb_h.spriv_ptr0;
101 
102      debug_called(8);
103 
104      xpt_free_ccb(&ccb->ccb_h);
105      if (sp->flags & ISC_FFPWAIT) {
106 	  sp->flags &= ~ISC_FFPWAIT;
107 	  wakeup(sp);
108      }
109 }
110 
111 static void
112 _scan_target(isc_session_t *sp, int target)
113 {
114      union ccb *ccb;
115 
116      debug_called(8);
117      sdebug(2, "target=%d", target);
118 
119      ccb = xpt_alloc_ccb();
120 
121      CAM_LOCK(sp->isc);
122      xpt_setup_ccb(&ccb->ccb_h, sp->cam_path, 5/*priority (low)*/);
123      ccb->ccb_h.func_code	= XPT_SCAN_BUS;
124      ccb->ccb_h.cbfcnp		= _scan_callback;
125      ccb->crcn.flags		= CAM_FLAG_NONE;
126      ccb->ccb_h.spriv_ptr0	= sp;
127 
128      xpt_action(ccb);
129      CAM_UNLOCK(sp->isc);
130 }
131 
132 int
133 ic_fullfeature(struct cdev *dev)
134 {
135      struct isc_softc 	*isp = dev->si_drv1;
136      isc_session_t	*sp = (isc_session_t *)dev->si_drv2;
137 
138      debug_called(8);
139      sdebug(3, "dev=%d sc=%p", minor(dev), isp);
140 
141      sp->flags &= ~ISC_FFPHASE;
142      sp->flags |= ISC_FFPWAIT;
143 
144      CAM_LOCK(isp);
145      if(xpt_create_path(&sp->cam_path, xpt_periph, cam_sim_path(sp->isc->cam_sim),
146 			sp->sid, CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
147 	  xdebug("can't create cam path");
148 	  CAM_UNLOCK(isp);
149 	  return ENODEV; // XXX
150      }
151      CAM_UNLOCK(isp);
152 
153      _scan_target(sp, sp->sid);
154 
155      while(sp->flags & ISC_FFPWAIT)
156 	  tsleep(sp, 0, "ffp", 5*hz); // timeout should be configurable
157      if(sp->target_nluns > 0) {
158 	  sp->flags |= ISC_FFPHASE;
159 	  return 0;
160      }
161 
162      return ENODEV;
163 }
164 
165 static void
166 _inq(struct cam_sim *sim, union ccb *ccb, int maxluns)
167 {
168      struct ccb_pathinq *cpi = &ccb->cpi;
169 
170      debug_called(4);
171 
172      cpi->version_num = 1; /* XXX??? */
173      cpi->hba_inquiry = PI_SDTR_ABLE | PI_TAG_ABLE | PI_WIDE_32;
174      cpi->target_sprt = 0;
175      cpi->hba_misc = 0;
176      cpi->hba_eng_cnt = 0;
177      cpi->max_target = ISCSI_MAX_TARGETS - 1;
178      cpi->initiator_id = ISCSI_MAX_TARGETS;
179      cpi->max_lun = maxluns;
180      cpi->bus_id = cam_sim_bus(sim);
181      cpi->base_transfer_speed = 3300;
182      strncpy(cpi->sim_vid, "DragonFly", SIM_IDLEN);
183      strncpy(cpi->hba_vid, "iSCSI", HBA_IDLEN);
184      strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
185      cpi->unit_number = cam_sim_unit(sim);
186      cpi->ccb_h.status = CAM_REQ_CMP;
187 }
188 
189 static __inline int
190 _scsi_encap(struct cam_sim *sim, union ccb *ccb)
191 {
192      int		ret;
193      struct isc_softc	*isp = (struct isc_softc *)cam_sim_softc(sim);
194 
195      lockmgr(&isp->cam_lock, LK_EXCLUSIVE);
196      ret = scsi_encap(sim, ccb);
197      lockmgr(&isp->cam_lock, LK_RELEASE);
198      return ret;
199 }
200 
201 static void
202 ic_action(struct cam_sim *sim, union ccb *ccb)
203 {
204      struct ccb_hdr	*ccb_h = &ccb->ccb_h;
205      struct isc_softc	*isp = (struct isc_softc *)cam_sim_softc(sim);
206      isc_session_t	*sp;
207 
208      debug_called(8);
209 
210      if((ccb_h->target_id != CAM_TARGET_WILDCARD) && (ccb_h->target_id < MAX_SESSIONS))
211 	  sp = isp->sessions[ccb_h->target_id];
212      else
213 	  sp = NULL;
214 
215      ccb_h->spriv_ptr0 = sp;
216 
217      debug(4, "func_code=0x%x flags=0x%x status=0x%x target=%d lun=%d retry_count=%d timeout=%d",
218 	   ccb_h->func_code, ccb->ccb_h.flags, ccb->ccb_h.status,
219 	   ccb->ccb_h.target_id, ccb->ccb_h.target_lun,
220 	   ccb->ccb_h.retry_count, ccb_h->timeout);
221      /*
222       | first quick check
223       */
224      switch(ccb_h->func_code) {
225      default:
226 	  // XXX: maybe check something else?
227 	  break;
228 
229      case XPT_SCSI_IO:
230      case XPT_RESET_DEV:
231      case XPT_GET_TRAN_SETTINGS:
232      case XPT_SET_TRAN_SETTINGS:
233      case XPT_CALC_GEOMETRY:
234 	  if(sp == NULL) {
235 	       ccb->ccb_h.status = CAM_DEV_NOT_THERE;
236 	       xpt_done(ccb);
237 	       return;
238 	  }
239 	  break;
240 
241      case XPT_PATH_INQ:
242      case XPT_NOOP:
243 	  if(sp == NULL && ccb->ccb_h.target_id != CAM_TARGET_WILDCARD) {
244 	       ccb->ccb_h.status = CAM_DEV_NOT_THERE;
245 	       xpt_done(ccb);
246 	       debug(4, "status = CAM_DEV_NOT_THERE");
247 	       return;
248 	  }
249      }
250 
251      switch(ccb_h->func_code) {
252 
253      case XPT_PATH_INQ:
254 	  _inq(sim, ccb, (sp? sp->opt.maxluns: ISCSI_MAX_LUNS) - 1);
255 	  break;
256 
257      case XPT_RESET_BUS: // (can just be a stub that does nothing and completes)
258      {
259 	  struct ccb_pathinq *cpi = &ccb->cpi;
260 
261 	  debug(3, "XPT_RESET_BUS");
262 	  cpi->ccb_h.status = CAM_REQ_CMP;
263 	  break;
264      }
265 
266      case XPT_SCSI_IO:
267      {
268 	  struct ccb_scsiio* csio = &ccb->csio;
269 
270 	  debug(4, "XPT_SCSI_IO cmd=0x%x", csio->cdb_io.cdb_bytes[0]);
271 	  if(sp == NULL) {
272 	       ccb_h->status = CAM_REQ_INVALID; //CAM_NO_NEXUS;
273 	       debug(4, "xpt_done.status=%d", ccb_h->status);
274 	       break;
275 	  }
276 	  if(ccb_h->target_lun == CAM_LUN_WILDCARD) {
277 	       debug(3, "target=%d: bad lun (-1)", ccb_h->target_id);
278 	       ccb_h->status = CAM_LUN_INVALID;
279 	       break;
280 	  }
281 	  if(_scsi_encap(sim, ccb) != 0)
282 	       return;
283 	  break;
284      }
285 
286      case XPT_CALC_GEOMETRY:
287      {
288 	  struct	ccb_calc_geometry *ccg;
289 
290 	  ccg = &ccb->ccg;
291 	  debug(6, "XPT_CALC_GEOMETRY vsize=%jd bsize=%d", ccg->volume_size, ccg->block_size);
292 	  if(ccg->block_size == 0 ||
293 	     (ccg->volume_size < ccg->block_size)) {
294 	       // print error message  ...
295 	       /* XXX: what error is appropiate? */
296 	       break;
297 	  } else
298 	       cam_calc_geometry(ccg, /*extended*/1);
299 	  break;
300      }
301 
302      case XPT_GET_TRAN_SETTINGS:
303      default:
304 	  ccb_h->status = CAM_REQ_INVALID;
305 	  break;
306      }
307      xpt_done(ccb);
308      return;
309 }
310 
311 static void
312 ic_poll(struct cam_sim *sim)
313 {
314      debug_called(8);
315 
316 }
317 
318 int
319 ic_getCamVals(isc_session_t *sp, iscsi_cam_t *cp)
320 {
321      int	i;
322 
323      debug_called(8);
324 
325      if(sp && sp->isc->cam_sim) {
326 	  cp->path_id = cam_sim_path(sp->isc->cam_sim);
327 	  cp->target_id = sp->sid;
328 	  cp->target_nluns = sp->target_nluns; // XXX: -1?
329 	  for(i = 0; i < cp->target_nluns; i++)
330 	       cp->target_lun[i] = sp->target_lun[i];
331 	  return 0;
332      }
333      return ENXIO;
334 }
335 
336 void
337 ic_destroy(struct isc_softc *isp)
338 {
339      debug_called(8);
340 
341      CAM_LOCK(isp); // can't harm :-)
342 
343      xpt_async(AC_LOST_DEVICE, isp->cam_path, NULL);
344      xpt_free_path(isp->cam_path);
345      xpt_bus_deregister(cam_sim_path(isp->cam_sim));
346      cam_sim_free(isp->cam_sim);
347 
348      CAM_UNLOCK(isp);
349 }
350 
351 int
352 ic_init(struct isc_softc *isp)
353 {
354      struct cam_sim	*sim;
355      struct cam_devq	*devq;
356      struct cam_path	*path;
357 
358      if((devq = cam_simq_alloc(256)) == NULL)
359 	  return ENOMEM;
360 
361      lockinit(&isp->cam_lock, "isc-cam", 0, LK_CANRECURSE);
362      sim = cam_sim_alloc(ic_action, ic_poll,
363 			 "iscsi", isp, 0, /* unit */
364 			 &sim_mplock,
365 			 1,		/* max_dev_transactions */
366 			 100,		/* max_tagged_dev_transactions */
367 			 devq);
368      cam_simq_release(devq);
369      if(sim == NULL) {
370 	  lockuninit(&isp->cam_lock);
371 	  return ENXIO;
372      }
373      CAM_LOCK(isp);
374      if(xpt_bus_register(sim,
375 			 0/*bus_number*/) != CAM_SUCCESS)
376 	  goto bad;
377 
378      if(xpt_create_path(&path, xpt_periph, cam_sim_path(sim),
379 			CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
380 	  xpt_bus_deregister(cam_sim_path(sim));
381 	  goto bad;
382      }
383 
384      CAM_UNLOCK(isp);
385 
386      isp->cam_sim = sim;
387      isp->cam_path = path;
388 
389      debug(2, "cam subsystem initialized"); // XXX: add dev ...
390      debug(4, "sim=%p path=%p", sim, path);
391      return 0;
392 
393  bad:
394      cam_sim_free(sim);
395      CAM_UNLOCK(isp);
396      return ENXIO;
397 }
398