sys/dev/iscsi/initiator/iscsivar.h

   1 /*-
   2  * Copyright (c) 2005-2010 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$
  27  */
  28
  29 /*
  30  | $Id: iscsivar.h 743 2009-08-08 10:54:53Z danny $
  31  */
  32 #define ISCSI_MAX_LUNS          128     // don't touch this
  33 #if ISCSI_MAX_LUNS > 8
  34 /*
  35  | for this to work
  36  | sysctl kern.cam.cam_srch_hi=1
  37  */
  38 #endif
  39
  40 #ifndef ISCSI_INITIATOR_DEBUG
  41 #define ISCSI_INITIATOR_DEBUG 1
  42 #endif
  43
  44 #ifdef ISCSI_INITIATOR_DEBUG
  45 extern int iscsi_debug;
  46 #define debug(level, fmt, args...)      do {if(level <= iscsi_debug)\
  47         printf("%s: " fmt "\n", __func__ , ##args);} while(0)
  48 #define sdebug(level, fmt, args...)     do {if(level <= iscsi_debug)\
  49         printf("%d] %s: " fmt "\n", sp->sid, __func__ , ##args);} while(0)
  50 #define debug_called(level)             do {if(level <= iscsi_debug)\
  51         printf("%s: called\n",  __func__);} while(0)
  52 #else
  53 #define debug(level, fmt, args...)
  54 #define debug_called(level)
  55 #define sdebug(level, fmt, args...)
  56 #endif /* ISCSI_INITIATOR_DEBUG */
  57
  58 #define xdebug(fmt, args...)    printf(">>> %s: " fmt "\n", __func__ , ##args)
  59
  60 #define MAX_SESSIONS    ISCSI_MAX_TARGETS
  61 #define MAX_PDUS        (MAX_SESSIONS*256) // XXX: at the moment this is arbitrary
  62
  63 typedef uint32_t digest_t(const void *, int len, uint32_t ocrc);
  64
  65 MALLOC_DECLARE(M_ISCSI);
  66 MALLOC_DECLARE(M_ISCSIBUF);
  67 MALLOC_DECLARE(M_PDU);
  68
  69 #define ISOK2DIG(dig, pp)       ((dig != NULL) && ((pp->ipdu.bhs.opcode & 0x1f) != ISCSI_LOGIN_CMD))
  70
  71 #ifndef BIT
  72 #define BIT(n)  (1 <<(n))
  73 #endif
  74
  75 #define ISC_SM_RUN      BIT(0)
  76 #define ISC_SM_RUNNING  BIT(1)
  77
  78 #define ISC_LINK_UP     BIT(2)
  79 #define ISC_CON_RUN     BIT(3)
  80 #define ISC_CON_RUNNING BIT(4)
  81 #define ISC_KILL        BIT(5)
  82 #define ISC_OQNOTEMPTY  BIT(6)
  83 #define ISC_OWAITING    BIT(7)
  84 #define ISC_FFPHASE     BIT(8)
  85
  86 #define ISC_CAMDEVS     BIT(9)
  87 #define ISC_SCANWAIT    BIT(10)
  88
  89 #define ISC_MEMWAIT     BIT(11)
  90 #define ISC_SIGNALED    BIT(12)
  91
  92 #define ISC_HOLD        BIT(15)
  93 #define ISC_HOLDED      BIT(16)
  94
  95 #define ISC_SHUTDOWN    BIT(31)
  96
  97 /*
  98  | some stats
  99  */
 100 struct i_stats {
 101      int        npdu;   // number of pdus malloc'ed.
 102      int        nrecv;  // unprocessed received pdus
 103      int        nsent;  // sent pdus
 104
 105      int        nrsp, max_rsp;
 106      int        nrsv, max_rsv;
 107      int        ncsnd, max_csnd;
 108      int        nisnd, max_isnd;
 109      int        nwsnd, max_wsnd;
 110      int        nhld, max_hld;
 111
 112      struct bintime t_sent;
 113      struct bintime t_recv;
 114 };
 115
 116 /*
 117  | one per 'session'
 118  */
 119
 120 typedef TAILQ_HEAD(, pduq) queue_t;
 121
 122 typedef struct isc_session {
 123      TAILQ_ENTRY(isc_session)   sp_link;
 124      int                flags;
 125      struct cdev        *dev;
 126      struct socket      *soc;
 127      struct file        *fp;
 128      struct thread      *td;
 129
 130      struct proc        *proc; // the userland process
 131      int                signal;
 132      struct proc        *soc_proc;
 133      struct proc        *stp;   // the sm thread
 134
 135      struct isc_softc   *isc;
 136
 137      digest_t           *hdrDigest;     // the digest alg. if any
 138      digest_t           *dataDigest;    // the digest alg. if any
 139
 140      int                sid;            // Session ID
 141      sn_t               sn;             // sequence number stuff;
 142      int                cws;            // current window size
 143
 144      int                target_nluns; // this and target_lun are
 145                                       // hopefully temporal till I
 146                                       // figure out a better way.
 147      int                target_lun[ISCSI_MAX_LUNS/(sizeof(int)*8) + 1];
 148
 149      struct mtx         rsp_mtx;
 150      struct mtx         rsv_mtx;
 151      struct mtx         snd_mtx;
 152      struct mtx         hld_mtx;
 153      struct mtx         io_mtx;
 154      queue_t            rsp;
 155      queue_t            rsv;
 156      queue_t            csnd;
 157      queue_t            isnd;
 158      queue_t            wsnd;
 159      queue_t            hld;
 160
 161      isc_opt_t          opt;    // negotiable values
 162
 163      struct i_stats     stats;
 164      bhs_t              bhs;
 165      struct uio         uio;
 166      struct iovec       iov;
 167      /*
 168       | cam stuff
 169       */
 170      struct cam_sim     *cam_sim;
 171      struct cam_path    *cam_path;
 172      struct mtx         cam_mtx;
 173      /*
 174       | sysctl stuff
 175       */
 176      struct sysctl_ctx_list     clist;
 177      struct sysctl_oid  *oid;
 178      int        douio;  //XXX: turn on/off uio on read
 179 } isc_session_t;
 180
 181 typedef struct pduq {
 182      TAILQ_ENTRY(pduq)  pq_link;
 183
 184      caddr_t            buf;
 185      u_int              len;    // the total length of the pdu
 186      pdu_t              pdu;
 187      union ccb          *ccb;
 188
 189      struct uio         uio;
 190      struct iovec       iov[5]; // XXX: careful ...
 191      struct mbuf        *mp;
 192      struct bintime     ts;
 193      queue_t            *pduq;
 194 } pduq_t;
 195 /*
 196  */
 197 struct isc_softc {
 198      struct mtx         isc_mtx;
 199      TAILQ_HEAD(,isc_session)   isc_sess;
 200      int                nsess;
 201      struct cdev        *dev;
 202      char               isid[6];        // Initiator Session ID (48 bits)
 203      struct unrhdr      *unit;
 204      struct sx          unit_sx;
 205
 206      uma_zone_t         pdu_zone;       // pool of free pdu's
 207 #ifdef  ISCSI_INITIATOR_DEBUG
 208      int                 npdu_alloc, npdu_max; // for instrumentation
 209 #endif
 210 #ifdef DO_EVENTHANDLER
 211      eventhandler_tag   eh;
 212 #endif
 213      /*
 214       | sysctl stuff
 215       */
 216      struct sysctl_ctx_list     clist;
 217      struct sysctl_oid          *oid;
 218 };
 219
 220 #ifdef  ISCSI_INITIATOR_DEBUG
 221 extern struct mtx iscsi_dbg_mtx;
 222 #endif
 223
 224 void    isc_start_receiver(isc_session_t *sp);
 225 void    isc_stop_receiver(isc_session_t *sp);
 226
 227 int     isc_sendPDU(isc_session_t *sp, pduq_t *pq);
 228 int     isc_qout(isc_session_t *sp, pduq_t *pq);
 229 int     i_prepPDU(isc_session_t *sp, pduq_t *pq);
 230
 231 int     ism_fullfeature(struct cdev *dev, int flag);
 232
 233 int     i_pdu_flush(isc_session_t *sc);
 234 int     i_setopt(isc_session_t *sp, isc_opt_t *opt);
 235 void    i_freeopt(isc_opt_t *opt);
 236
 237 int     ic_init(isc_session_t *sp);
 238 void    ic_destroy(isc_session_t *sp);
 239 void    ic_lost_target(isc_session_t *sp, int target);
 240 int     ic_getCamVals(isc_session_t *sp, iscsi_cam_t *cp);
 241
 242 void    ism_recv(isc_session_t *sp, pduq_t *pq);
 243 int     ism_start(isc_session_t *sp);
 244 void    ism_restart(isc_session_t *sp);
 245 void    ism_stop(isc_session_t *sp);
 246
 247 int     scsi_encap(struct cam_sim *sim, union ccb *ccb);
 248 int     scsi_decap(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
 249 void    iscsi_r2t(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
 250 void    iscsi_done(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
 251 void    iscsi_reject(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
 252 void    iscsi_async(isc_session_t *sp,  pduq_t *pq);
 253 void    iscsi_cleanup(isc_session_t *sp);
 254 int     iscsi_requeue(isc_session_t *sp);
 255
 256 // Serial Number Arithmetic
 257 #define _MAXINCR        0x7FFFFFFF      // 2 ^ 31 - 1
 258 #define SNA_GT(i1, i2)  ((i1 != i2) && (\
 259         (i1 < i2 && i2 - i1 > _MAXINCR) ||\
 260         (i1 > i2 && i1 - i2 < _MAXINCR))?1: 0)
 261
 262 /*
 263  | inlines
 264  */
 265 #ifdef _CAM_CAM_XPT_SIM_H
 266
 267 #if __FreeBSD_version <  600000
 268 #define CAM_LOCK(arg)
 269 #define CAM_ULOCK(arg)
 270
 271 static __inline void
 272 XPT_DONE(isc_session_t *sp, union ccb *ccb)
 273 {
 274      mtx_lock(&Giant);
 275      xpt_done(ccb);
 276      mtx_unlock(&Giant);
 277 }
 278 #elif __FreeBSD_version >= 700000
 279 #define CAM_LOCK(arg)   mtx_lock(&arg->cam_mtx)
 280 #define CAM_UNLOCK(arg) mtx_unlock(&arg->cam_mtx)
 281
 282 static __inline void
 283 XPT_DONE(isc_session_t *sp, union ccb *ccb)
 284 {
 285      CAM_LOCK(sp);
 286      xpt_done(ccb);
 287      CAM_UNLOCK(sp);
 288 }
 289 #else
 290 //__FreeBSD_version >= 600000
 291 #define CAM_LOCK(arg)
 292 #define CAM_UNLOCK(arg)
 293 #define XPT_DONE(ignore, arg)   xpt_done(arg)
 294 #endif
 295
 296 #endif /* _CAM_CAM_XPT_SIM_H */
 297
 298 static __inline pduq_t *
 299 pdu_alloc(struct isc_softc *isc, int wait)
 300 {
 301      pduq_t     *pq;
 302
 303      pq = (pduq_t *)uma_zalloc(isc->pdu_zone, wait /* M_WAITOK or M_NOWAIT*/);
 304      if(pq == NULL) {
 305           debug(7, "out of mem");
 306           return NULL;
 307      }
 308 #ifdef ISCSI_INITIATOR_DEBUG
 309      isc->npdu_alloc++;
 310      if(isc->npdu_alloc > isc->npdu_max)
 311           isc->npdu_max = isc->npdu_alloc;
 312 #endif
 313      memset(pq, 0, sizeof(pduq_t));
 314
 315      return pq;
 316 }
 317
 318 static __inline void
 319 pdu_free(struct isc_softc *isc, pduq_t *pq)
 320 {
 321      if(pq->mp)
 322           m_freem(pq->mp);
 323 #ifdef NO_USE_MBUF
 324      if(pq->buf != NULL)
 325           free(pq->buf, M_ISCSIBUF);
 326 #endif
 327 #ifdef ISCSI_INITIATOR_DEBUG
 328      isc->npdu_alloc--;
 329 #endif
 330      uma_zfree(isc->pdu_zone, pq);
 331 }
 332
 333 static __inline void
 334 i_nqueue_rsp(isc_session_t *sp, pduq_t *pq)
 335 {
 336      mtx_lock(&sp->rsp_mtx);
 337      if(++sp->stats.nrsp > sp->stats.max_rsp)
 338           sp->stats.max_rsp = sp->stats.nrsp;
 339      TAILQ_INSERT_TAIL(&sp->rsp, pq, pq_link);
 340      mtx_unlock(&sp->rsp_mtx);
 341 }
 342
 343 static __inline pduq_t *
 344 i_dqueue_rsp(isc_session_t *sp)
 345 {
 346      pduq_t *pq;
 347
 348      mtx_lock(&sp->rsp_mtx);
 349      if((pq = TAILQ_FIRST(&sp->rsp)) != NULL) {
 350           sp->stats.nrsp--;
 351           TAILQ_REMOVE(&sp->rsp, pq, pq_link);
 352      }
 353      mtx_unlock(&sp->rsp_mtx);
 354
 355      return pq;
 356 }
 357
 358 static __inline void
 359 i_nqueue_rsv(isc_session_t *sp, pduq_t *pq)
 360 {
 361      mtx_lock(&sp->rsv_mtx);
 362      if(++sp->stats.nrsv > sp->stats.max_rsv)
 363           sp->stats.max_rsv = sp->stats.nrsv;
 364      TAILQ_INSERT_TAIL(&sp->rsv, pq, pq_link);
 365      mtx_unlock(&sp->rsv_mtx);
 366 }
 367
 368 static __inline pduq_t *
 369 i_dqueue_rsv(isc_session_t *sp)
 370 {
 371      pduq_t *pq;
 372
 373      mtx_lock(&sp->rsv_mtx);
 374      if((pq = TAILQ_FIRST(&sp->rsv)) != NULL) {
 375           sp->stats.nrsv--;
 376           TAILQ_REMOVE(&sp->rsv, pq, pq_link);
 377      }
 378      mtx_unlock(&sp->rsv_mtx);
 379
 380      return pq;
 381 }
 382
 383 static __inline void
 384 i_nqueue_csnd(isc_session_t *sp, pduq_t *pq)
 385 {
 386      mtx_lock(&sp->snd_mtx);
 387      if(++sp->stats.ncsnd > sp->stats.max_csnd)
 388           sp->stats.max_csnd = sp->stats.ncsnd;
 389      TAILQ_INSERT_TAIL(&sp->csnd, pq, pq_link);
 390      mtx_unlock(&sp->snd_mtx);
 391 }
 392
 393 static __inline pduq_t *
 394 i_dqueue_csnd(isc_session_t *sp)
 395 {
 396      pduq_t *pq;
 397
 398      mtx_lock(&sp->snd_mtx);
 399      if((pq = TAILQ_FIRST(&sp->csnd)) != NULL) {
 400           sp->stats.ncsnd--;
 401           TAILQ_REMOVE(&sp->csnd, pq, pq_link);
 402      }
 403      mtx_unlock(&sp->snd_mtx);
 404
 405      return pq;
 406 }
 407
 408 static __inline void
 409 i_nqueue_isnd(isc_session_t *sp, pduq_t *pq)
 410 {
 411      mtx_lock(&sp->snd_mtx);
 412      if(++sp->stats.nisnd > sp->stats.max_isnd)
 413           sp->stats.max_isnd = sp->stats.nisnd;
 414      TAILQ_INSERT_TAIL(&sp->isnd, pq, pq_link);
 415      mtx_unlock(&sp->snd_mtx);
 416 }
 417
 418 static __inline pduq_t *
 419 i_dqueue_isnd(isc_session_t *sp)
 420 {
 421      pduq_t *pq;
 422
 423      mtx_lock(&sp->snd_mtx);
 424      if((pq = TAILQ_FIRST(&sp->isnd)) != NULL) {
 425           sp->stats.nisnd--;
 426           TAILQ_REMOVE(&sp->isnd, pq, pq_link);
 427      }
 428      mtx_unlock(&sp->snd_mtx);
 429
 430      return pq;
 431 }
 432
 433 static __inline void
 434 i_nqueue_wsnd(isc_session_t *sp, pduq_t *pq)
 435 {
 436      mtx_lock(&sp->snd_mtx);
 437      if(++sp->stats.nwsnd > sp->stats.max_wsnd)
 438           sp->stats.max_wsnd = sp->stats.nwsnd;
 439      TAILQ_INSERT_TAIL(&sp->wsnd, pq, pq_link);
 440      mtx_unlock(&sp->snd_mtx);
 441 }
 442
 443 static __inline pduq_t *
 444 i_dqueue_wsnd(isc_session_t *sp)
 445 {
 446      pduq_t *pq;
 447
 448      mtx_lock(&sp->snd_mtx);
 449      if((pq = TAILQ_FIRST(&sp->wsnd)) != NULL) {
 450           sp->stats.nwsnd--;
 451           TAILQ_REMOVE(&sp->wsnd, pq, pq_link);
 452      }
 453      mtx_unlock(&sp->snd_mtx);
 454
 455      return pq;
 456 }
 457
 458 static __inline pduq_t *
 459 i_dqueue_snd(isc_session_t *sp, int which)
 460 {
 461      pduq_t *pq;
 462
 463      pq = NULL;
 464      mtx_lock(&sp->snd_mtx);
 465      if((which & BIT(0)) && (pq = TAILQ_FIRST(&sp->isnd)) != NULL) {
 466           sp->stats.nisnd--;
 467           TAILQ_REMOVE(&sp->isnd, pq, pq_link);
 468           pq->pduq = &sp->isnd; // remember where you came from
 469      } else
 470      if((which & BIT(1)) && (pq = TAILQ_FIRST(&sp->wsnd)) != NULL) {
 471           sp->stats.nwsnd--;
 472           TAILQ_REMOVE(&sp->wsnd, pq, pq_link);
 473           pq->pduq = &sp->wsnd; // remember where you came from
 474      } else
 475      if((which & BIT(2)) && (pq = TAILQ_FIRST(&sp->csnd)) != NULL) {
 476           sp->stats.ncsnd--;
 477           TAILQ_REMOVE(&sp->csnd, pq, pq_link);
 478           pq->pduq = &sp->csnd; // remember where you came from
 479      }
 480      mtx_unlock(&sp->snd_mtx);
 481
 482      return pq;
 483 }
 484
 485 static __inline void
 486 i_rqueue_pdu(isc_session_t *sp, pduq_t *pq)
 487 {
 488      mtx_lock(&sp->snd_mtx);
 489      KASSERT(pq->pduq != NULL, ("pq->pduq is NULL"));
 490      TAILQ_INSERT_TAIL(pq->pduq, pq, pq_link);
 491      mtx_unlock(&sp->snd_mtx);
 492 }
 493
 494 /*
 495  | Waiting for ACK (or something :-)
 496  */
 497 static __inline void
 498 i_nqueue_hld(isc_session_t *sp, pduq_t *pq)
 499 {
 500      getbintime(&pq->ts);
 501      mtx_lock(&sp->hld_mtx);
 502      if(++sp->stats.nhld > sp->stats.max_hld)
 503           sp->stats.max_hld = sp->stats.nhld;
 504      TAILQ_INSERT_TAIL(&sp->hld, pq, pq_link);
 505      mtx_unlock(&sp->hld_mtx);
 506      return;
 507 }
 508
 509 static __inline void
 510 i_remove_hld(isc_session_t *sp, pduq_t *pq)
 511 {
 512      mtx_lock(&sp->hld_mtx);
 513      sp->stats.nhld--;
 514      TAILQ_REMOVE(&sp->hld, pq, pq_link);
 515      mtx_unlock(&sp->hld_mtx);
 516 }
 517
 518 static __inline pduq_t *
 519 i_dqueue_hld(isc_session_t *sp)
 520 {
 521      pduq_t *pq;
 522
 523      mtx_lock(&sp->hld_mtx);
 524      if((pq = TAILQ_FIRST(&sp->hld)) != NULL) {
 525           sp->stats.nhld--;
 526           TAILQ_REMOVE(&sp->hld, pq, pq_link);
 527      }
 528      mtx_unlock(&sp->hld_mtx);
 529
 530      return pq;
 531 }
 532
 533 static __inline pduq_t *
 534 i_search_hld(isc_session_t *sp, int itt, int keep)
 535 {
 536      pduq_t     *pq, *tmp;
 537
 538      pq = NULL;
 539
 540      mtx_lock(&sp->hld_mtx);
 541      TAILQ_FOREACH_SAFE(pq, &sp->hld, pq_link, tmp) {
 542           if(pq->pdu.ipdu.bhs.itt == itt) {
 543                if(!keep) {
 544                     sp->stats.nhld--;
 545                     TAILQ_REMOVE(&sp->hld, pq, pq_link);
 546                }
 547                break;
 548           }
 549      }
 550      mtx_unlock(&sp->hld_mtx);
 551
 552      return pq;
 553 }
 554
 555 static __inline void
 556 i_acked_hld(isc_session_t *sp, pdu_t *op)
 557 {
 558      pduq_t     *pq, *tmp;
 559      u_int exp = sp->sn.expCmd;
 560
 561      pq = NULL;
 562      mtx_lock(&sp->hld_mtx);
 563      TAILQ_FOREACH_SAFE(pq, &sp->hld, pq_link, tmp) {
 564           if((op && op->ipdu.bhs.itt == pq->pdu.ipdu.bhs.itt)
 565              || (pq->ccb == NULL
 566                  && (pq->pdu.ipdu.bhs.opcode != ISCSI_WRITE_DATA)
 567                  && SNA_GT(exp, ntohl(pq->pdu.ipdu.bhs.ExpStSN)))) {
 568                sp->stats.nhld--;
 569                TAILQ_REMOVE(&sp->hld, pq, pq_link);
 570                pdu_free(sp->isc, pq);
 571           }
 572      }
 573      mtx_unlock(&sp->hld_mtx);
 574 }
 575
 576 static __inline void
 577 i_mbufcopy(struct mbuf *mp, caddr_t dp, int len)
 578 {
 579      struct mbuf *m;
 580      caddr_t bp;
 581
 582      for(m = mp; m != NULL; m = m->m_next) {
 583           bp = mtod(m, caddr_t);
 584           /*
 585            | the pdu is word (4 octed) aligned
 586            | so len <= packet
 587            */
 588           memcpy(dp, bp, MIN(len, m->m_len));
 589           dp += m->m_len;
 590           len -= m->m_len;
 591           if(len <= 0)
 592                break;
 593      }
 594 }