drivers/target/target_core_pr.c

   1 /*******************************************************************************
   2  * Filename:  target_core_pr.c
   3  *
   4  * This file contains SPC-3 compliant persistent reservations and
   5  * legacy SPC-2 reservations with compatible reservation handling (CRH=1)
   6  *
   7  * (c) Copyright 2009-2012 RisingTide Systems LLC.
   8  *
   9  * Nicholas A. Bellinger <nab@kernel.org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24  *
  25  ******************************************************************************/
  26
  27 #include <linux/slab.h>
  28 #include <linux/spinlock.h>
  29 #include <linux/list.h>
  30 #include <linux/file.h>
  31 #include <scsi/scsi.h>
  32 #include <scsi/scsi_cmnd.h>
  33 #include <asm/unaligned.h>
  34
  35 #include <target/target_core_base.h>
  36 #include <target/target_core_backend.h>
  37 #include <target/target_core_fabric.h>
  38 #include <target/target_core_configfs.h>
  39
  40 #include "target_core_internal.h"
  41 #include "target_core_pr.h"
  42 #include "target_core_ua.h"
  43
  44 /*
  45  * Used for Specify Initiator Ports Capable Bit (SPEC_I_PT)
  46  */
  47 struct pr_transport_id_holder {
  48         int dest_local_nexus;
  49         struct t10_pr_registration *dest_pr_reg;
  50         struct se_portal_group *dest_tpg;
  51         struct se_node_acl *dest_node_acl;
  52         struct se_dev_entry *dest_se_deve;
  53         struct list_head dest_list;
  54 };
  55
  56 void core_pr_dump_initiator_port(
  57         struct t10_pr_registration *pr_reg,
  58         char *buf,
  59         u32 size)
  60 {
  61         if (!pr_reg->isid_present_at_reg)
  62                 buf[0] = '\0';
  63
  64         snprintf(buf, size, ",i,0x%s", pr_reg->pr_reg_isid);
  65 }
  66
  67 enum register_type {
  68         REGISTER,
  69         REGISTER_AND_IGNORE_EXISTING_KEY,
  70         REGISTER_AND_MOVE,
  71 };
  72
  73 enum preempt_type {
  74         PREEMPT,
  75         PREEMPT_AND_ABORT,
  76 };
  77
  78 static void __core_scsi3_complete_pro_release(struct se_device *, struct se_node_acl *,
  79                         struct t10_pr_registration *, int);
  80
  81 static sense_reason_t
  82 target_scsi2_reservation_check(struct se_cmd *cmd)
  83 {
  84         struct se_device *dev = cmd->se_dev;
  85         struct se_session *sess = cmd->se_sess;
  86
  87         switch (cmd->t_task_cdb[0]) {
  88         case INQUIRY:
  89         case RELEASE:
  90         case RELEASE_10:
  91                 return 0;
  92         default:
  93                 break;
  94         }
  95
  96         if (!dev->dev_reserved_node_acl || !sess)
  97                 return 0;
  98
  99         if (dev->dev_reserved_node_acl != sess->se_node_acl)
 100                 return TCM_RESERVATION_CONFLICT;
 101
 102         if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS_WITH_ISID) {
 103                 if (dev->dev_res_bin_isid != sess->sess_bin_isid)
 104                         return TCM_RESERVATION_CONFLICT;
 105         }
 106
 107         return 0;
 108 }
 109
 110 static struct t10_pr_registration *core_scsi3_locate_pr_reg(struct se_device *,
 111                                         struct se_node_acl *, struct se_session *);
 112 static void core_scsi3_put_pr_reg(struct t10_pr_registration *);
 113
 114 static int target_check_scsi2_reservation_conflict(struct se_cmd *cmd)
 115 {
 116         struct se_session *se_sess = cmd->se_sess;
 117         struct se_device *dev = cmd->se_dev;
 118         struct t10_pr_registration *pr_reg;
 119         struct t10_reservation *pr_tmpl = &dev->t10_pr;
 120         int conflict = 0;
 121
 122         pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
 123                         se_sess);
 124         if (pr_reg) {
 125                 /*
 126                  * From spc4r17 5.7.3 Exceptions to SPC-2 RESERVE and RELEASE
 127                  * behavior
 128                  *
 129                  * A RESERVE(6) or RESERVE(10) command shall complete with GOOD
 130                  * status, but no reservation shall be established and the
 131                  * persistent reservation shall not be changed, if the command
 132                  * is received from a) and b) below.
 133                  *
 134                  * A RELEASE(6) or RELEASE(10) command shall complete with GOOD
 135                  * status, but the persistent reservation shall not be released,
 136                  * if the command is received from a) and b)
 137                  *
 138                  * a) An I_T nexus that is a persistent reservation holder; or
 139                  * b) An I_T nexus that is registered if a registrants only or
 140                  *    all registrants type persistent reservation is present.
 141                  *
 142                  * In all other cases, a RESERVE(6) command, RESERVE(10) command,
 143                  * RELEASE(6) command, or RELEASE(10) command shall be processed
 144                  * as defined in SPC-2.
 145                  */
 146                 if (pr_reg->pr_res_holder) {
 147                         core_scsi3_put_pr_reg(pr_reg);
 148                         return 1;
 149                 }
 150                 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY) ||
 151                     (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) ||
 152                     (pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
 153                     (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
 154                         core_scsi3_put_pr_reg(pr_reg);
 155                         return 1;
 156                 }
 157                 core_scsi3_put_pr_reg(pr_reg);
 158                 conflict = 1;
 159         } else {
 160                 /*
 161                  * Following spc2r20 5.5.1 Reservations overview:
 162                  *
 163                  * If a logical unit has executed a PERSISTENT RESERVE OUT
 164                  * command with the REGISTER or the REGISTER AND IGNORE
 165                  * EXISTING KEY service action and is still registered by any
 166                  * initiator, all RESERVE commands and all RELEASE commands
 167                  * regardless of initiator shall conflict and shall terminate
 168                  * with a RESERVATION CONFLICT status.
 169                  */
 170                 spin_lock(&pr_tmpl->registration_lock);
 171                 conflict = (list_empty(&pr_tmpl->registration_list)) ? 0 : 1;
 172                 spin_unlock(&pr_tmpl->registration_lock);
 173         }
 174
 175         if (conflict) {
 176                 pr_err("Received legacy SPC-2 RESERVE/RELEASE"
 177                         " while active SPC-3 registrations exist,"
 178                         " returning RESERVATION_CONFLICT\n");
 179                 return -EBUSY;
 180         }
 181
 182         return 0;
 183 }
 184
 185 sense_reason_t
 186 target_scsi2_reservation_release(struct se_cmd *cmd)
 187 {
 188         struct se_device *dev = cmd->se_dev;
 189         struct se_session *sess = cmd->se_sess;
 190         struct se_portal_group *tpg;
 191         int rc;
 192
 193         if (!sess || !sess->se_tpg)
 194                 goto out;
 195         rc = target_check_scsi2_reservation_conflict(cmd);
 196         if (rc == 1)
 197                 goto out;
 198         if (rc < 0)
 199                 return TCM_RESERVATION_CONFLICT;
 200
 201         spin_lock(&dev->dev_reservation_lock);
 202         if (!dev->dev_reserved_node_acl || !sess)
 203                 goto out_unlock;
 204
 205         if (dev->dev_reserved_node_acl != sess->se_node_acl)
 206                 goto out_unlock;
 207
 208         if (dev->dev_res_bin_isid != sess->sess_bin_isid)
 209                 goto out_unlock;
 210
 211         dev->dev_reserved_node_acl = NULL;
 212         dev->dev_reservation_flags &= ~DRF_SPC2_RESERVATIONS;
 213         if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS_WITH_ISID) {
 214                 dev->dev_res_bin_isid = 0;
 215                 dev->dev_reservation_flags &= ~DRF_SPC2_RESERVATIONS_WITH_ISID;
 216         }
 217         tpg = sess->se_tpg;
 218         pr_debug("SCSI-2 Released reservation for %s LUN: %u ->"
 219                 " MAPPED LUN: %u for %s\n", tpg->se_tpg_tfo->get_fabric_name(),
 220                 cmd->se_lun->unpacked_lun, cmd->se_deve->mapped_lun,
 221                 sess->se_node_acl->initiatorname);
 222
 223 out_unlock:
 224         spin_unlock(&dev->dev_reservation_lock);
 225 out:
 226         target_complete_cmd(cmd, GOOD);
 227         return 0;
 228 }
 229
 230 sense_reason_t
 231 target_scsi2_reservation_reserve(struct se_cmd *cmd)
 232 {
 233         struct se_device *dev = cmd->se_dev;
 234         struct se_session *sess = cmd->se_sess;
 235         struct se_portal_group *tpg;
 236         sense_reason_t ret = 0;
 237         int rc;
 238
 239         if ((cmd->t_task_cdb[1] & 0x01) &&
 240             (cmd->t_task_cdb[1] & 0x02)) {
 241                 pr_err("LongIO and Obselete Bits set, returning"
 242                                 " ILLEGAL_REQUEST\n");
 243                 return TCM_UNSUPPORTED_SCSI_OPCODE;
 244         }
 245         /*
 246          * This is currently the case for target_core_mod passthrough struct se_cmd
 247          * ops
 248          */
 249         if (!sess || !sess->se_tpg)
 250                 goto out;
 251         rc = target_check_scsi2_reservation_conflict(cmd);
 252         if (rc == 1)
 253                 goto out;
 254
 255         if (rc < 0)
 256                 return TCM_RESERVATION_CONFLICT;
 257
 258         tpg = sess->se_tpg;
 259         spin_lock(&dev->dev_reservation_lock);
 260         if (dev->dev_reserved_node_acl &&
 261            (dev->dev_reserved_node_acl != sess->se_node_acl)) {
 262                 pr_err("SCSI-2 RESERVATION CONFLIFT for %s fabric\n",
 263                         tpg->se_tpg_tfo->get_fabric_name());
 264                 pr_err("Original reserver LUN: %u %s\n",
 265                         cmd->se_lun->unpacked_lun,
 266                         dev->dev_reserved_node_acl->initiatorname);
 267                 pr_err("Current attempt - LUN: %u -> MAPPED LUN: %u"
 268                         " from %s \n", cmd->se_lun->unpacked_lun,
 269                         cmd->se_deve->mapped_lun,
 270                         sess->se_node_acl->initiatorname);
 271                 ret = TCM_RESERVATION_CONFLICT;
 272                 goto out_unlock;
 273         }
 274
 275         dev->dev_reserved_node_acl = sess->se_node_acl;
 276         dev->dev_reservation_flags |= DRF_SPC2_RESERVATIONS;
 277         if (sess->sess_bin_isid != 0) {
 278                 dev->dev_res_bin_isid = sess->sess_bin_isid;
 279                 dev->dev_reservation_flags |= DRF_SPC2_RESERVATIONS_WITH_ISID;
 280         }
 281         pr_debug("SCSI-2 Reserved %s LUN: %u -> MAPPED LUN: %u"
 282                 " for %s\n", tpg->se_tpg_tfo->get_fabric_name(),
 283                 cmd->se_lun->unpacked_lun, cmd->se_deve->mapped_lun,
 284                 sess->se_node_acl->initiatorname);
 285
 286 out_unlock:
 287         spin_unlock(&dev->dev_reservation_lock);
 288 out:
 289         if (!ret)
 290                 target_complete_cmd(cmd, GOOD);
 291         return ret;
 292 }
 293
 294
 295 /*
 296  * Begin SPC-3/SPC-4 Persistent Reservations emulation support
 297  *
 298  * This function is called by those initiator ports who are *NOT*
 299  * the active PR reservation holder when a reservation is present.
 300  */
 301 static int core_scsi3_pr_seq_non_holder(
 302         struct se_cmd *cmd,
 303         u32 pr_reg_type)
 304 {
 305         unsigned char *cdb = cmd->t_task_cdb;
 306         struct se_dev_entry *se_deve;
 307         struct se_session *se_sess = cmd->se_sess;
 308         int other_cdb = 0, ignore_reg;
 309         int registered_nexus = 0, ret = 1; /* Conflict by default */
 310         int all_reg = 0, reg_only = 0; /* ALL_REG, REG_ONLY */
 311         int we = 0; /* Write Exclusive */
 312         int legacy = 0; /* Act like a legacy device and return
 313                          * RESERVATION CONFLICT on some CDBs */
 314
 315         se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
 316         /*
 317          * Determine if the registration should be ignored due to
 318          * non-matching ISIDs in target_scsi3_pr_reservation_check().
 319          */
 320         ignore_reg = (pr_reg_type & 0x80000000);
 321         if (ignore_reg)
 322                 pr_reg_type &= ~0x80000000;
 323
 324         switch (pr_reg_type) {
 325         case PR_TYPE_WRITE_EXCLUSIVE:
 326                 we = 1;
 327         case PR_TYPE_EXCLUSIVE_ACCESS:
 328                 /*
 329                  * Some commands are only allowed for the persistent reservation
 330                  * holder.
 331                  */
 332                 if ((se_deve->def_pr_registered) && !(ignore_reg))
 333                         registered_nexus = 1;
 334                 break;
 335         case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
 336                 we = 1;
 337         case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
 338                 /*
 339                  * Some commands are only allowed for registered I_T Nexuses.
 340                  */
 341                 reg_only = 1;
 342                 if ((se_deve->def_pr_registered) && !(ignore_reg))
 343                         registered_nexus = 1;
 344                 break;
 345         case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
 346                 we = 1;
 347         case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
 348                 /*
 349                  * Each registered I_T Nexus is a reservation holder.
 350                  */
 351                 all_reg = 1;
 352                 if ((se_deve->def_pr_registered) && !(ignore_reg))
 353                         registered_nexus = 1;
 354                 break;
 355         default:
 356                 return -EINVAL;
 357         }
 358         /*
 359          * Referenced from spc4r17 table 45 for *NON* PR holder access
 360          */
 361         switch (cdb[0]) {
 362         case SECURITY_PROTOCOL_IN:
 363                 if (registered_nexus)
 364                         return 0;
 365                 ret = (we) ? 0 : 1;
 366                 break;
 367         case MODE_SENSE:
 368         case MODE_SENSE_10:
 369         case READ_ATTRIBUTE:
 370         case READ_BUFFER:
 371         case RECEIVE_DIAGNOSTIC:
 372                 if (legacy) {
 373                         ret = 1;
 374                         break;
 375                 }
 376                 if (registered_nexus) {
 377                         ret = 0;
 378                         break;
 379                 }
 380                 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
 381                 break;
 382         case PERSISTENT_RESERVE_OUT:
 383                 /*
 384                  * This follows PERSISTENT_RESERVE_OUT service actions that
 385                  * are allowed in the presence of various reservations.
 386                  * See spc4r17, table 46
 387                  */
 388                 switch (cdb[1] & 0x1f) {
 389                 case PRO_CLEAR:
 390                 case PRO_PREEMPT:
 391                 case PRO_PREEMPT_AND_ABORT:
 392                         ret = (registered_nexus) ? 0 : 1;
 393                         break;
 394                 case PRO_REGISTER:
 395                 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
 396                         ret = 0;
 397                         break;
 398                 case PRO_REGISTER_AND_MOVE:
 399                 case PRO_RESERVE:
 400                         ret = 1;
 401                         break;
 402                 case PRO_RELEASE:
 403                         ret = (registered_nexus) ? 0 : 1;
 404                         break;
 405                 default:
 406                         pr_err("Unknown PERSISTENT_RESERVE_OUT service"
 407                                 " action: 0x%02x\n", cdb[1] & 0x1f);
 408                         return -EINVAL;
 409                 }
 410                 break;
 411         case RELEASE:
 412         case RELEASE_10:
 413                 /* Handled by CRH=1 in target_scsi2_reservation_release() */
 414                 ret = 0;
 415                 break;
 416         case RESERVE:
 417         case RESERVE_10:
 418                 /* Handled by CRH=1 in target_scsi2_reservation_reserve() */
 419                 ret = 0;
 420                 break;
 421         case TEST_UNIT_READY:
 422                 ret = (legacy) ? 1 : 0; /* Conflict for legacy */
 423                 break;
 424         case MAINTENANCE_IN:
 425                 switch (cdb[1] & 0x1f) {
 426                 case MI_MANAGEMENT_PROTOCOL_IN:
 427                         if (registered_nexus) {
 428                                 ret = 0;
 429                                 break;
 430                         }
 431                         ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
 432                         break;
 433                 case MI_REPORT_SUPPORTED_OPERATION_CODES:
 434                 case MI_REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS:
 435                         if (legacy) {
 436                                 ret = 1;
 437                                 break;
 438                         }
 439                         if (registered_nexus) {
 440                                 ret = 0;
 441                                 break;
 442                         }
 443                         ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
 444                         break;
 445                 case MI_REPORT_ALIASES:
 446                 case MI_REPORT_IDENTIFYING_INFORMATION:
 447                 case MI_REPORT_PRIORITY:
 448                 case MI_REPORT_TARGET_PGS:
 449                 case MI_REPORT_TIMESTAMP:
 450                         ret = 0; /* Allowed */
 451                         break;
 452                 default:
 453                         pr_err("Unknown MI Service Action: 0x%02x\n",
 454                                 (cdb[1] & 0x1f));
 455                         return -EINVAL;
 456                 }
 457                 break;
 458         case ACCESS_CONTROL_IN:
 459         case ACCESS_CONTROL_OUT:
 460         case INQUIRY:
 461         case LOG_SENSE:
 462         case READ_MEDIA_SERIAL_NUMBER:
 463         case REPORT_LUNS:
 464         case REQUEST_SENSE:
 465         case PERSISTENT_RESERVE_IN:
 466                 ret = 0; /*/ Allowed CDBs */
 467                 break;
 468         default:
 469                 other_cdb = 1;
 470                 break;
 471         }
 472         /*
 473          * Case where the CDB is explicitly allowed in the above switch
 474          * statement.
 475          */
 476         if (!ret && !other_cdb) {
 477                 pr_debug("Allowing explict CDB: 0x%02x for %s"
 478                         " reservation holder\n", cdb[0],
 479                         core_scsi3_pr_dump_type(pr_reg_type));
 480
 481                 return ret;
 482         }
 483         /*
 484          * Check if write exclusive initiator ports *NOT* holding the
 485          * WRITE_EXCLUSIVE_* reservation.
 486          */
 487         if (we && !registered_nexus) {
 488                 if (cmd->data_direction == DMA_TO_DEVICE) {
 489                         /*
 490                          * Conflict for write exclusive
 491                          */
 492                         pr_debug("%s Conflict for unregistered nexus"
 493                                 " %s CDB: 0x%02x to %s reservation\n",
 494                                 transport_dump_cmd_direction(cmd),
 495                                 se_sess->se_node_acl->initiatorname, cdb[0],
 496                                 core_scsi3_pr_dump_type(pr_reg_type));
 497                         return 1;
 498                 } else {
 499                         /*
 500                          * Allow non WRITE CDBs for all Write Exclusive
 501                          * PR TYPEs to pass for registered and
 502                          * non-registered_nexuxes NOT holding the reservation.
 503                          *
 504                          * We only make noise for the unregisterd nexuses,
 505                          * as we expect registered non-reservation holding
 506                          * nexuses to issue CDBs.
 507                          */
 508
 509                         if (!registered_nexus) {
 510                                 pr_debug("Allowing implict CDB: 0x%02x"
 511                                         " for %s reservation on unregistered"
 512                                         " nexus\n", cdb[0],
 513                                         core_scsi3_pr_dump_type(pr_reg_type));
 514                         }
 515
 516                         return 0;
 517                 }
 518         } else if ((reg_only) || (all_reg)) {
 519                 if (registered_nexus) {
 520                         /*
 521                          * For PR_*_REG_ONLY and PR_*_ALL_REG reservations,
 522                          * allow commands from registered nexuses.
 523                          */
 524
 525                         pr_debug("Allowing implict CDB: 0x%02x for %s"
 526                                 " reservation\n", cdb[0],
 527                                 core_scsi3_pr_dump_type(pr_reg_type));
 528
 529                         return 0;
 530                 }
 531         }
 532         pr_debug("%s Conflict for %sregistered nexus %s CDB: 0x%2x"
 533                 " for %s reservation\n", transport_dump_cmd_direction(cmd),
 534                 (registered_nexus) ? "" : "un",
 535                 se_sess->se_node_acl->initiatorname, cdb[0],
 536                 core_scsi3_pr_dump_type(pr_reg_type));
 537
 538         return 1; /* Conflict by default */
 539 }
 540
 541 static sense_reason_t
 542 target_scsi3_pr_reservation_check(struct se_cmd *cmd)
 543 {
 544         struct se_device *dev = cmd->se_dev;
 545         struct se_session *sess = cmd->se_sess;
 546         u32 pr_reg_type;
 547
 548         if (!dev->dev_pr_res_holder)
 549                 return 0;
 550
 551         pr_reg_type = dev->dev_pr_res_holder->pr_res_type;
 552         cmd->pr_res_key = dev->dev_pr_res_holder->pr_res_key;
 553         if (dev->dev_pr_res_holder->pr_reg_nacl != sess->se_node_acl)
 554                 goto check_nonholder;
 555
 556         if (dev->dev_pr_res_holder->isid_present_at_reg) {
 557                 if (dev->dev_pr_res_holder->pr_reg_bin_isid !=
 558                     sess->sess_bin_isid) {
 559                         pr_reg_type |= 0x80000000;
 560                         goto check_nonholder;
 561                 }
 562         }
 563
 564         return 0;
 565
 566 check_nonholder:
 567         if (core_scsi3_pr_seq_non_holder(cmd, pr_reg_type))
 568                 return TCM_RESERVATION_CONFLICT;
 569         return 0;
 570 }
 571
 572 static u32 core_scsi3_pr_generation(struct se_device *dev)
 573 {
 574         u32 prg;
 575
 576         /*
 577          * PRGeneration field shall contain the value of a 32-bit wrapping
 578          * counter mainted by the device server.
 579          *
 580          * Note that this is done regardless of Active Persist across
 581          * Target PowerLoss (APTPL)
 582          *
 583          * See spc4r17 section 6.3.12 READ_KEYS service action
 584          */
 585         spin_lock(&dev->dev_reservation_lock);
 586         prg = dev->t10_pr.pr_generation++;
 587         spin_unlock(&dev->dev_reservation_lock);
 588
 589         return prg;
 590 }
 591
 592 static struct t10_pr_registration *__core_scsi3_do_alloc_registration(
 593         struct se_device *dev,
 594         struct se_node_acl *nacl,
 595         struct se_dev_entry *deve,
 596         unsigned char *isid,
 597         u64 sa_res_key,
 598         int all_tg_pt,
 599         int aptpl)
 600 {
 601         struct t10_pr_registration *pr_reg;
 602
 603         pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_ATOMIC);
 604         if (!pr_reg) {
 605                 pr_err("Unable to allocate struct t10_pr_registration\n");
 606                 return NULL;
 607         }
 608
 609         pr_reg->pr_aptpl_buf = kzalloc(dev->t10_pr.pr_aptpl_buf_len,
 610                                         GFP_ATOMIC);
 611         if (!pr_reg->pr_aptpl_buf) {
 612                 pr_err("Unable to allocate pr_reg->pr_aptpl_buf\n");
 613                 kmem_cache_free(t10_pr_reg_cache, pr_reg);
 614                 return NULL;
 615         }
 616
 617         INIT_LIST_HEAD(&pr_reg->pr_reg_list);
 618         INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
 619         INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
 620         INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
 621         INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
 622         atomic_set(&pr_reg->pr_res_holders, 0);
 623         pr_reg->pr_reg_nacl = nacl;
 624         pr_reg->pr_reg_deve = deve;
 625         pr_reg->pr_res_mapped_lun = deve->mapped_lun;
 626         pr_reg->pr_aptpl_target_lun = deve->se_lun->unpacked_lun;
 627         pr_reg->pr_res_key = sa_res_key;
 628         pr_reg->pr_reg_all_tg_pt = all_tg_pt;
 629         pr_reg->pr_reg_aptpl = aptpl;
 630         pr_reg->pr_reg_tg_pt_lun = deve->se_lun;
 631         /*
 632          * If an ISID value for this SCSI Initiator Port exists,
 633          * save it to the registration now.
 634          */
 635         if (isid != NULL) {
 636                 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
 637                 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
 638                 pr_reg->isid_present_at_reg = 1;
 639         }
 640
 641         return pr_reg;
 642 }
 643
 644 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *);
 645 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *);
 646
 647 /*
 648  * Function used for handling PR registrations for ALL_TG_PT=1 and ALL_TG_PT=0
 649  * modes.
 650  */
 651 static struct t10_pr_registration *__core_scsi3_alloc_registration(
 652         struct se_device *dev,
 653         struct se_node_acl *nacl,
 654         struct se_dev_entry *deve,
 655         unsigned char *isid,
 656         u64 sa_res_key,
 657         int all_tg_pt,
 658         int aptpl)
 659 {
 660         struct se_dev_entry *deve_tmp;
 661         struct se_node_acl *nacl_tmp;
 662         struct se_port *port, *port_tmp;
 663         struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
 664         struct t10_pr_registration *pr_reg, *pr_reg_atp, *pr_reg_tmp, *pr_reg_tmp_safe;
 665         int ret;
 666         /*
 667          * Create a registration for the I_T Nexus upon which the
 668          * PROUT REGISTER was received.
 669          */
 670         pr_reg = __core_scsi3_do_alloc_registration(dev, nacl, deve, isid,
 671                         sa_res_key, all_tg_pt, aptpl);
 672         if (!pr_reg)
 673                 return NULL;
 674         /*
 675          * Return pointer to pr_reg for ALL_TG_PT=0
 676          */
 677         if (!all_tg_pt)
 678                 return pr_reg;
 679         /*
 680          * Create list of matching SCSI Initiator Port registrations
 681          * for ALL_TG_PT=1
 682          */
 683         spin_lock(&dev->se_port_lock);
 684         list_for_each_entry_safe(port, port_tmp, &dev->dev_sep_list, sep_list) {
 685                 atomic_inc(&port->sep_tg_pt_ref_cnt);
 686                 smp_mb__after_atomic_inc();
 687                 spin_unlock(&dev->se_port_lock);
 688
 689                 spin_lock_bh(&port->sep_alua_lock);
 690                 list_for_each_entry(deve_tmp, &port->sep_alua_list,
 691                                         alua_port_list) {
 692                         /*
 693                          * This pointer will be NULL for demo mode MappedLUNs
 694                          * that have not been make explict via a ConfigFS
 695                          * MappedLUN group for the SCSI Initiator Node ACL.
 696                          */
 697                         if (!deve_tmp->se_lun_acl)
 698                                 continue;
 699
 700                         nacl_tmp = deve_tmp->se_lun_acl->se_lun_nacl;
 701                         /*
 702                          * Skip the matching struct se_node_acl that is allocated
 703                          * above..
 704                          */
 705                         if (nacl == nacl_tmp)
 706                                 continue;
 707                         /*
 708                          * Only perform PR registrations for target ports on
 709                          * the same fabric module as the REGISTER w/ ALL_TG_PT=1
 710                          * arrived.
 711                          */
 712                         if (tfo != nacl_tmp->se_tpg->se_tpg_tfo)
 713                                 continue;
 714                         /*
 715                          * Look for a matching Initiator Node ACL in ASCII format
 716                          */
 717                         if (strcmp(nacl->initiatorname, nacl_tmp->initiatorname))
 718                                 continue;
 719
 720                         atomic_inc(&deve_tmp->pr_ref_count);
 721                         smp_mb__after_atomic_inc();
 722                         spin_unlock_bh(&port->sep_alua_lock);
 723                         /*
 724                          * Grab a configfs group dependency that is released
 725                          * for the exception path at label out: below, or upon
 726                          * completion of adding ALL_TG_PT=1 registrations in
 727                          * __core_scsi3_add_registration()
 728                          */
 729                         ret = core_scsi3_lunacl_depend_item(deve_tmp);
 730                         if (ret < 0) {
 731                                 pr_err("core_scsi3_lunacl_depend"
 732                                                 "_item() failed\n");
 733                                 atomic_dec(&port->sep_tg_pt_ref_cnt);
 734                                 smp_mb__after_atomic_dec();
 735                                 atomic_dec(&deve_tmp->pr_ref_count);
 736                                 smp_mb__after_atomic_dec();
 737                                 goto out;
 738                         }
 739                         /*
 740                          * Located a matching SCSI Initiator Port on a different
 741                          * port, allocate the pr_reg_atp and attach it to the
 742                          * pr_reg->pr_reg_atp_list that will be processed once
 743                          * the original *pr_reg is processed in
 744                          * __core_scsi3_add_registration()
 745                          */
 746                         pr_reg_atp = __core_scsi3_do_alloc_registration(dev,
 747                                                 nacl_tmp, deve_tmp, NULL,
 748                                                 sa_res_key, all_tg_pt, aptpl);
 749                         if (!pr_reg_atp) {
 750                                 atomic_dec(&port->sep_tg_pt_ref_cnt);
 751                                 smp_mb__after_atomic_dec();
 752                                 atomic_dec(&deve_tmp->pr_ref_count);
 753                                 smp_mb__after_atomic_dec();
 754                                 core_scsi3_lunacl_undepend_item(deve_tmp);
 755                                 goto out;
 756                         }
 757
 758                         list_add_tail(&pr_reg_atp->pr_reg_atp_mem_list,
 759                                       &pr_reg->pr_reg_atp_list);
 760                         spin_lock_bh(&port->sep_alua_lock);
 761                 }
 762                 spin_unlock_bh(&port->sep_alua_lock);
 763
 764                 spin_lock(&dev->se_port_lock);
 765                 atomic_dec(&port->sep_tg_pt_ref_cnt);
 766                 smp_mb__after_atomic_dec();
 767         }
 768         spin_unlock(&dev->se_port_lock);
 769
 770         return pr_reg;
 771 out:
 772         list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
 773                         &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
 774                 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
 775                 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
 776                 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
 777         }
 778         kmem_cache_free(t10_pr_reg_cache, pr_reg);
 779         return NULL;
 780 }
 781
 782 int core_scsi3_alloc_aptpl_registration(
 783         struct t10_reservation *pr_tmpl,
 784         u64 sa_res_key,
 785         unsigned char *i_port,
 786         unsigned char *isid,
 787         u32 mapped_lun,
 788         unsigned char *t_port,
 789         u16 tpgt,
 790         u32 target_lun,
 791         int res_holder,
 792         int all_tg_pt,
 793         u8 type)
 794 {
 795         struct t10_pr_registration *pr_reg;
 796
 797         if (!i_port || !t_port || !sa_res_key) {
 798                 pr_err("Illegal parameters for APTPL registration\n");
 799                 return -EINVAL;
 800         }
 801
 802         pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_KERNEL);
 803         if (!pr_reg) {
 804                 pr_err("Unable to allocate struct t10_pr_registration\n");
 805                 return -ENOMEM;
 806         }
 807         pr_reg->pr_aptpl_buf = kzalloc(pr_tmpl->pr_aptpl_buf_len, GFP_KERNEL);
 808
 809         INIT_LIST_HEAD(&pr_reg->pr_reg_list);
 810         INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
 811         INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
 812         INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
 813         INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
 814         atomic_set(&pr_reg->pr_res_holders, 0);
 815         pr_reg->pr_reg_nacl = NULL;
 816         pr_reg->pr_reg_deve = NULL;
 817         pr_reg->pr_res_mapped_lun = mapped_lun;
 818         pr_reg->pr_aptpl_target_lun = target_lun;
 819         pr_reg->pr_res_key = sa_res_key;
 820         pr_reg->pr_reg_all_tg_pt = all_tg_pt;
 821         pr_reg->pr_reg_aptpl = 1;
 822         pr_reg->pr_reg_tg_pt_lun = NULL;
 823         pr_reg->pr_res_scope = 0; /* Always LUN_SCOPE */
 824         pr_reg->pr_res_type = type;
 825         /*
 826          * If an ISID value had been saved in APTPL metadata for this
 827          * SCSI Initiator Port, restore it now.
 828          */
 829         if (isid != NULL) {
 830                 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
 831                 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
 832                 pr_reg->isid_present_at_reg = 1;
 833         }
 834         /*
 835          * Copy the i_port and t_port information from caller.
 836          */
 837         snprintf(pr_reg->pr_iport, PR_APTPL_MAX_IPORT_LEN, "%s", i_port);
 838         snprintf(pr_reg->pr_tport, PR_APTPL_MAX_TPORT_LEN, "%s", t_port);
 839         pr_reg->pr_reg_tpgt = tpgt;
 840         /*
 841          * Set pr_res_holder from caller, the pr_reg who is the reservation
 842          * holder will get it's pointer set in core_scsi3_aptpl_reserve() once
 843          * the Initiator Node LUN ACL from the fabric module is created for
 844          * this registration.
 845          */
 846         pr_reg->pr_res_holder = res_holder;
 847
 848         list_add_tail(&pr_reg->pr_reg_aptpl_list, &pr_tmpl->aptpl_reg_list);
 849         pr_debug("SPC-3 PR APTPL Successfully added registration%s from"
 850                         " metadata\n", (res_holder) ? "+reservation" : "");
 851         return 0;
 852 }
 853
 854 static void core_scsi3_aptpl_reserve(
 855         struct se_device *dev,
 856         struct se_portal_group *tpg,
 857         struct se_node_acl *node_acl,
 858         struct t10_pr_registration *pr_reg)
 859 {
 860         char i_buf[PR_REG_ISID_ID_LEN];
 861
 862         memset(i_buf, 0, PR_REG_ISID_ID_LEN);
 863         core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
 864
 865         spin_lock(&dev->dev_reservation_lock);
 866         dev->dev_pr_res_holder = pr_reg;
 867         spin_unlock(&dev->dev_reservation_lock);
 868
 869         pr_debug("SPC-3 PR [%s] Service Action: APTPL RESERVE created"
 870                 " new reservation holder TYPE: %s ALL_TG_PT: %d\n",
 871                 tpg->se_tpg_tfo->get_fabric_name(),
 872                 core_scsi3_pr_dump_type(pr_reg->pr_res_type),
 873                 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
 874         pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
 875                 tpg->se_tpg_tfo->get_fabric_name(), node_acl->initiatorname,
 876                 i_buf);
 877 }
 878
 879 static void __core_scsi3_add_registration(struct se_device *, struct se_node_acl *,
 880                                 struct t10_pr_registration *, enum register_type, int);
 881
 882 static int __core_scsi3_check_aptpl_registration(
 883         struct se_device *dev,
 884         struct se_portal_group *tpg,
 885         struct se_lun *lun,
 886         u32 target_lun,
 887         struct se_node_acl *nacl,
 888         struct se_dev_entry *deve)
 889 {
 890         struct t10_pr_registration *pr_reg, *pr_reg_tmp;
 891         struct t10_reservation *pr_tmpl = &dev->t10_pr;
 892         unsigned char i_port[PR_APTPL_MAX_IPORT_LEN];
 893         unsigned char t_port[PR_APTPL_MAX_TPORT_LEN];
 894         u16 tpgt;
 895
 896         memset(i_port, 0, PR_APTPL_MAX_IPORT_LEN);
 897         memset(t_port, 0, PR_APTPL_MAX_TPORT_LEN);
 898         /*
 899          * Copy Initiator Port information from struct se_node_acl
 900          */
 901         snprintf(i_port, PR_APTPL_MAX_IPORT_LEN, "%s", nacl->initiatorname);
 902         snprintf(t_port, PR_APTPL_MAX_TPORT_LEN, "%s",
 903                         tpg->se_tpg_tfo->tpg_get_wwn(tpg));
 904         tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
 905         /*
 906          * Look for the matching registrations+reservation from those
 907          * created from APTPL metadata.  Note that multiple registrations
 908          * may exist for fabrics that use ISIDs in their SCSI Initiator Port
 909          * TransportIDs.
 910          */
 911         spin_lock(&pr_tmpl->aptpl_reg_lock);
 912         list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
 913                                 pr_reg_aptpl_list) {
 914                 if (!strcmp(pr_reg->pr_iport, i_port) &&
 915                      (pr_reg->pr_res_mapped_lun == deve->mapped_lun) &&
 916                     !(strcmp(pr_reg->pr_tport, t_port)) &&
 917                      (pr_reg->pr_reg_tpgt == tpgt) &&
 918                      (pr_reg->pr_aptpl_target_lun == target_lun)) {
 919
 920                         pr_reg->pr_reg_nacl = nacl;
 921                         pr_reg->pr_reg_deve = deve;
 922                         pr_reg->pr_reg_tg_pt_lun = lun;
 923
 924                         list_del(&pr_reg->pr_reg_aptpl_list);
 925                         spin_unlock(&pr_tmpl->aptpl_reg_lock);
 926                         /*
 927                          * At this point all of the pointers in *pr_reg will
 928                          * be setup, so go ahead and add the registration.
 929                          */
 930
 931                         __core_scsi3_add_registration(dev, nacl, pr_reg, 0, 0);
 932                         /*
 933                          * If this registration is the reservation holder,
 934                          * make that happen now..
 935                          */
 936                         if (pr_reg->pr_res_holder)
 937                                 core_scsi3_aptpl_reserve(dev, tpg,
 938                                                 nacl, pr_reg);
 939                         /*
 940                          * Reenable pr_aptpl_active to accept new metadata
 941                          * updates once the SCSI device is active again..
 942                          */
 943                         spin_lock(&pr_tmpl->aptpl_reg_lock);
 944                         pr_tmpl->pr_aptpl_active = 1;
 945                 }
 946         }
 947         spin_unlock(&pr_tmpl->aptpl_reg_lock);
 948
 949         return 0;
 950 }
 951
 952 int core_scsi3_check_aptpl_registration(
 953         struct se_device *dev,
 954         struct se_portal_group *tpg,
 955         struct se_lun *lun,
 956         struct se_lun_acl *lun_acl)
 957 {
 958         struct se_node_acl *nacl = lun_acl->se_lun_nacl;
 959         struct se_dev_entry *deve = nacl->device_list[lun_acl->mapped_lun];
 960
 961         if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
 962                 return 0;
 963
 964         return __core_scsi3_check_aptpl_registration(dev, tpg, lun,
 965                                 lun->unpacked_lun, nacl, deve);
 966 }
 967
 968 static void __core_scsi3_dump_registration(
 969         struct target_core_fabric_ops *tfo,
 970         struct se_device *dev,
 971         struct se_node_acl *nacl,
 972         struct t10_pr_registration *pr_reg,
 973         enum register_type register_type)
 974 {
 975         struct se_portal_group *se_tpg = nacl->se_tpg;
 976         char i_buf[PR_REG_ISID_ID_LEN];
 977
 978         memset(&i_buf[0], 0, PR_REG_ISID_ID_LEN);
 979         core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
 980
 981         pr_debug("SPC-3 PR [%s] Service Action: REGISTER%s Initiator"
 982                 " Node: %s%s\n", tfo->get_fabric_name(), (register_type == REGISTER_AND_MOVE) ?
 983                 "_AND_MOVE" : (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ?
 984                 "_AND_IGNORE_EXISTING_KEY" : "", nacl->initiatorname,
 985                 i_buf);
 986         pr_debug("SPC-3 PR [%s] registration on Target Port: %s,0x%04x\n",
 987                  tfo->get_fabric_name(), tfo->tpg_get_wwn(se_tpg),
 988                 tfo->tpg_get_tag(se_tpg));
 989         pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
 990                 " Port(s)\n",  tfo->get_fabric_name(),
 991                 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
 992                 dev->transport->name);
 993         pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
 994                 " 0x%08x  APTPL: %d\n", tfo->get_fabric_name(),
 995                 pr_reg->pr_res_key, pr_reg->pr_res_generation,
 996                 pr_reg->pr_reg_aptpl);
 997 }
 998
 999 /*
1000  * this function can be called with struct se_device->dev_reservation_lock
1001  * when register_move = 1
1002  */
1003 static void __core_scsi3_add_registration(
1004         struct se_device *dev,
1005         struct se_node_acl *nacl,
1006         struct t10_pr_registration *pr_reg,
1007         enum register_type register_type,
1008         int register_move)
1009 {
1010         struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
1011         struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1012         struct t10_reservation *pr_tmpl = &dev->t10_pr;
1013
1014         /*
1015          * Increment PRgeneration counter for struct se_device upon a successful
1016          * REGISTER, see spc4r17 section 6.3.2 READ_KEYS service action
1017          *
1018          * Also, when register_move = 1 for PROUT REGISTER_AND_MOVE service
1019          * action, the struct se_device->dev_reservation_lock will already be held,
1020          * so we do not call core_scsi3_pr_generation() which grabs the lock
1021          * for the REGISTER.
1022          */
1023         pr_reg->pr_res_generation = (register_move) ?
1024                         dev->t10_pr.pr_generation++ :
1025                         core_scsi3_pr_generation(dev);
1026
1027         spin_lock(&pr_tmpl->registration_lock);
1028         list_add_tail(&pr_reg->pr_reg_list, &pr_tmpl->registration_list);
1029         pr_reg->pr_reg_deve->def_pr_registered = 1;
1030
1031         __core_scsi3_dump_registration(tfo, dev, nacl, pr_reg, register_type);
1032         spin_unlock(&pr_tmpl->registration_lock);
1033         /*
1034          * Skip extra processing for ALL_TG_PT=0 or REGISTER_AND_MOVE.
1035          */
1036         if (!pr_reg->pr_reg_all_tg_pt || register_move)
1037                 return;
1038         /*
1039          * Walk pr_reg->pr_reg_atp_list and add registrations for ALL_TG_PT=1
1040          * allocated in __core_scsi3_alloc_registration()
1041          */
1042         list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1043                         &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
1044                 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1045
1046                 pr_reg_tmp->pr_res_generation = core_scsi3_pr_generation(dev);
1047
1048                 spin_lock(&pr_tmpl->registration_lock);
1049                 list_add_tail(&pr_reg_tmp->pr_reg_list,
1050                               &pr_tmpl->registration_list);
1051                 pr_reg_tmp->pr_reg_deve->def_pr_registered = 1;
1052
1053                 __core_scsi3_dump_registration(tfo, dev,
1054                                 pr_reg_tmp->pr_reg_nacl, pr_reg_tmp,
1055                                 register_type);
1056                 spin_unlock(&pr_tmpl->registration_lock);
1057                 /*
1058                  * Drop configfs group dependency reference from
1059                  * __core_scsi3_alloc_registration()
1060                  */
1061                 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1062         }
1063 }
1064
1065 static int core_scsi3_alloc_registration(
1066         struct se_device *dev,
1067         struct se_node_acl *nacl,
1068         struct se_dev_entry *deve,
1069         unsigned char *isid,
1070         u64 sa_res_key,
1071         int all_tg_pt,
1072         int aptpl,
1073         enum register_type register_type,
1074         int register_move)
1075 {
1076         struct t10_pr_registration *pr_reg;
1077
1078         pr_reg = __core_scsi3_alloc_registration(dev, nacl, deve, isid,
1079                         sa_res_key, all_tg_pt, aptpl);
1080         if (!pr_reg)
1081                 return -EPERM;
1082
1083         __core_scsi3_add_registration(dev, nacl, pr_reg,
1084                         register_type, register_move);
1085         return 0;
1086 }
1087
1088 static struct t10_pr_registration *__core_scsi3_locate_pr_reg(
1089         struct se_device *dev,
1090         struct se_node_acl *nacl,
1091         unsigned char *isid)
1092 {
1093         struct t10_reservation *pr_tmpl = &dev->t10_pr;
1094         struct t10_pr_registration *pr_reg, *pr_reg_tmp;
1095         struct se_portal_group *tpg;
1096
1097         spin_lock(&pr_tmpl->registration_lock);
1098         list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1099                         &pr_tmpl->registration_list, pr_reg_list) {
1100                 /*
1101                  * First look for a matching struct se_node_acl
1102                  */
1103                 if (pr_reg->pr_reg_nacl != nacl)
1104                         continue;
1105
1106                 tpg = pr_reg->pr_reg_nacl->se_tpg;
1107                 /*
1108                  * If this registration does NOT contain a fabric provided
1109                  * ISID, then we have found a match.
1110                  */
1111                 if (!pr_reg->isid_present_at_reg) {
1112                         /*
1113                          * Determine if this SCSI device server requires that
1114                          * SCSI Intiatior TransportID w/ ISIDs is enforced
1115                          * for fabric modules (iSCSI) requiring them.
1116                          */
1117                         if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1118                                 if (dev->dev_attrib.enforce_pr_isids)
1119                                         continue;
1120                         }
1121                         atomic_inc(&pr_reg->pr_res_holders);
1122                         smp_mb__after_atomic_inc();
1123                         spin_unlock(&pr_tmpl->registration_lock);
1124                         return pr_reg;
1125                 }
1126                 /*
1127                  * If the *pr_reg contains a fabric defined ISID for multi-value
1128                  * SCSI Initiator Port TransportIDs, then we expect a valid
1129                  * matching ISID to be provided by the local SCSI Initiator Port.
1130                  */
1131                 if (!isid)
1132                         continue;
1133                 if (strcmp(isid, pr_reg->pr_reg_isid))
1134                         continue;
1135
1136                 atomic_inc(&pr_reg->pr_res_holders);
1137                 smp_mb__after_atomic_inc();
1138                 spin_unlock(&pr_tmpl->registration_lock);
1139                 return pr_reg;
1140         }
1141         spin_unlock(&pr_tmpl->registration_lock);
1142
1143         return NULL;
1144 }
1145
1146 static struct t10_pr_registration *core_scsi3_locate_pr_reg(
1147         struct se_device *dev,
1148         struct se_node_acl *nacl,
1149         struct se_session *sess)
1150 {
1151         struct se_portal_group *tpg = nacl->se_tpg;
1152         unsigned char buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
1153
1154         if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1155                 memset(&buf[0], 0, PR_REG_ISID_LEN);
1156                 tpg->se_tpg_tfo->sess_get_initiator_sid(sess, &buf[0],
1157                                         PR_REG_ISID_LEN);
1158                 isid_ptr = &buf[0];
1159         }
1160
1161         return __core_scsi3_locate_pr_reg(dev, nacl, isid_ptr);
1162 }
1163
1164 static void core_scsi3_put_pr_reg(struct t10_pr_registration *pr_reg)
1165 {
1166         atomic_dec(&pr_reg->pr_res_holders);
1167         smp_mb__after_atomic_dec();
1168 }
1169
1170 static int core_scsi3_check_implict_release(
1171         struct se_device *dev,
1172         struct t10_pr_registration *pr_reg)
1173 {
1174         struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
1175         struct t10_pr_registration *pr_res_holder;
1176         int ret = 0;
1177
1178         spin_lock(&dev->dev_reservation_lock);
1179         pr_res_holder = dev->dev_pr_res_holder;
1180         if (!pr_res_holder) {
1181                 spin_unlock(&dev->dev_reservation_lock);
1182                 return ret;
1183         }
1184         if (pr_res_holder == pr_reg) {
1185                 /*
1186                  * Perform an implict RELEASE if the registration that
1187                  * is being released is holding the reservation.
1188                  *
1189                  * From spc4r17, section 5.7.11.1:
1190                  *
1191                  * e) If the I_T nexus is the persistent reservation holder
1192                  *    and the persistent reservation is not an all registrants
1193                  *    type, then a PERSISTENT RESERVE OUT command with REGISTER
1194                  *    service action or REGISTER AND  IGNORE EXISTING KEY
1195                  *    service action with the SERVICE ACTION RESERVATION KEY
1196                  *    field set to zero (see 5.7.11.3).
1197                  */
1198                 __core_scsi3_complete_pro_release(dev, nacl, pr_reg, 0);
1199                 ret = 1;
1200                 /*
1201                  * For 'All Registrants' reservation types, all existing
1202                  * registrations are still processed as reservation holders
1203                  * in core_scsi3_pr_seq_non_holder() after the initial
1204                  * reservation holder is implictly released here.
1205                  */
1206         } else if (pr_reg->pr_reg_all_tg_pt &&
1207                   (!strcmp(pr_res_holder->pr_reg_nacl->initiatorname,
1208                           pr_reg->pr_reg_nacl->initiatorname)) &&
1209                   (pr_res_holder->pr_res_key == pr_reg->pr_res_key)) {
1210                 pr_err("SPC-3 PR: Unable to perform ALL_TG_PT=1"
1211                         " UNREGISTER while existing reservation with matching"
1212                         " key 0x%016Lx is present from another SCSI Initiator"
1213                         " Port\n", pr_reg->pr_res_key);
1214                 ret = -EPERM;
1215         }
1216         spin_unlock(&dev->dev_reservation_lock);
1217
1218         return ret;
1219 }
1220
1221 /*
1222  * Called with struct t10_reservation->registration_lock held.
1223  */
1224 static void __core_scsi3_free_registration(
1225         struct se_device *dev,
1226         struct t10_pr_registration *pr_reg,
1227         struct list_head *preempt_and_abort_list,
1228         int dec_holders)
1229 {
1230         struct target_core_fabric_ops *tfo =
1231                         pr_reg->pr_reg_nacl->se_tpg->se_tpg_tfo;
1232         struct t10_reservation *pr_tmpl = &dev->t10_pr;
1233         char i_buf[PR_REG_ISID_ID_LEN];
1234
1235         memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1236         core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1237
1238         pr_reg->pr_reg_deve->def_pr_registered = 0;
1239         pr_reg->pr_reg_deve->pr_res_key = 0;
1240         list_del(&pr_reg->pr_reg_list);
1241         /*
1242          * Caller accessing *pr_reg using core_scsi3_locate_pr_reg(),
1243          * so call core_scsi3_put_pr_reg() to decrement our reference.
1244          */
1245         if (dec_holders)
1246                 core_scsi3_put_pr_reg(pr_reg);
1247         /*
1248          * Wait until all reference from any other I_T nexuses for this
1249          * *pr_reg have been released.  Because list_del() is called above,
1250          * the last core_scsi3_put_pr_reg(pr_reg) will release this reference
1251          * count back to zero, and we release *pr_reg.
1252          */
1253         while (atomic_read(&pr_reg->pr_res_holders) != 0) {
1254                 spin_unlock(&pr_tmpl->registration_lock);
1255                 pr_debug("SPC-3 PR [%s] waiting for pr_res_holders\n",
1256                                 tfo->get_fabric_name());
1257                 cpu_relax();
1258                 spin_lock(&pr_tmpl->registration_lock);
1259         }
1260
1261         pr_debug("SPC-3 PR [%s] Service Action: UNREGISTER Initiator"
1262                 " Node: %s%s\n", tfo->get_fabric_name(),
1263                 pr_reg->pr_reg_nacl->initiatorname,
1264                 i_buf);
1265         pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1266                 " Port(s)\n", tfo->get_fabric_name(),
1267                 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
1268                 dev->transport->name);
1269         pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1270                 " 0x%08x\n", tfo->get_fabric_name(), pr_reg->pr_res_key,
1271                 pr_reg->pr_res_generation);
1272
1273         if (!preempt_and_abort_list) {
1274                 pr_reg->pr_reg_deve = NULL;
1275                 pr_reg->pr_reg_nacl = NULL;
1276                 kfree(pr_reg->pr_aptpl_buf);
1277                 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1278                 return;
1279         }
1280         /*
1281          * For PREEMPT_AND_ABORT, the list of *pr_reg in preempt_and_abort_list
1282          * are released once the ABORT_TASK_SET has completed..
1283          */
1284         list_add_tail(&pr_reg->pr_reg_abort_list, preempt_and_abort_list);
1285 }
1286
1287 void core_scsi3_free_pr_reg_from_nacl(
1288         struct se_device *dev,
1289         struct se_node_acl *nacl)
1290 {
1291         struct t10_reservation *pr_tmpl = &dev->t10_pr;
1292         struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1293         /*
1294          * If the passed se_node_acl matches the reservation holder,
1295          * release the reservation.
1296          */
1297         spin_lock(&dev->dev_reservation_lock);
1298         pr_res_holder = dev->dev_pr_res_holder;
1299         if ((pr_res_holder != NULL) &&
1300             (pr_res_holder->pr_reg_nacl == nacl))
1301                 __core_scsi3_complete_pro_release(dev, nacl, pr_res_holder, 0);
1302         spin_unlock(&dev->dev_reservation_lock);
1303         /*
1304          * Release any registration associated with the struct se_node_acl.
1305          */
1306         spin_lock(&pr_tmpl->registration_lock);
1307         list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1308                         &pr_tmpl->registration_list, pr_reg_list) {
1309
1310                 if (pr_reg->pr_reg_nacl != nacl)
1311                         continue;
1312
1313                 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1314         }
1315         spin_unlock(&pr_tmpl->registration_lock);
1316 }
1317
1318 void core_scsi3_free_all_registrations(
1319         struct se_device *dev)
1320 {
1321         struct t10_reservation *pr_tmpl = &dev->t10_pr;
1322         struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1323
1324         spin_lock(&dev->dev_reservation_lock);
1325         pr_res_holder = dev->dev_pr_res_holder;
1326         if (pr_res_holder != NULL) {
1327                 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
1328                 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
1329                                 pr_res_holder, 0);
1330         }
1331         spin_unlock(&dev->dev_reservation_lock);
1332
1333         spin_lock(&pr_tmpl->registration_lock);
1334         list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1335                         &pr_tmpl->registration_list, pr_reg_list) {
1336
1337                 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1338         }
1339         spin_unlock(&pr_tmpl->registration_lock);
1340
1341         spin_lock(&pr_tmpl->aptpl_reg_lock);
1342         list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
1343                                 pr_reg_aptpl_list) {
1344                 list_del(&pr_reg->pr_reg_aptpl_list);
1345                 kfree(pr_reg->pr_aptpl_buf);
1346                 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1347         }
1348         spin_unlock(&pr_tmpl->aptpl_reg_lock);
1349 }
1350
1351 static int core_scsi3_tpg_depend_item(struct se_portal_group *tpg)
1352 {
1353         return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1354                         &tpg->tpg_group.cg_item);
1355 }
1356
1357 static void core_scsi3_tpg_undepend_item(struct se_portal_group *tpg)
1358 {
1359         configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1360                         &tpg->tpg_group.cg_item);
1361
1362         atomic_dec(&tpg->tpg_pr_ref_count);
1363         smp_mb__after_atomic_dec();
1364 }
1365
1366 static int core_scsi3_nodeacl_depend_item(struct se_node_acl *nacl)
1367 {
1368         struct se_portal_group *tpg = nacl->se_tpg;
1369
1370         if (nacl->dynamic_node_acl)
1371                 return 0;
1372
1373         return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1374                         &nacl->acl_group.cg_item);
1375 }
1376
1377 static void core_scsi3_nodeacl_undepend_item(struct se_node_acl *nacl)
1378 {
1379         struct se_portal_group *tpg = nacl->se_tpg;
1380
1381         if (nacl->dynamic_node_acl) {
1382                 atomic_dec(&nacl->acl_pr_ref_count);
1383                 smp_mb__after_atomic_dec();
1384                 return;
1385         }
1386
1387         configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1388                         &nacl->acl_group.cg_item);
1389
1390         atomic_dec(&nacl->acl_pr_ref_count);
1391         smp_mb__after_atomic_dec();
1392 }
1393
1394 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *se_deve)
1395 {
1396         struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1397         struct se_node_acl *nacl;
1398         struct se_portal_group *tpg;
1399         /*
1400          * For nacl->dynamic_node_acl=1
1401          */
1402         if (!lun_acl)
1403                 return 0;
1404
1405         nacl = lun_acl->se_lun_nacl;
1406         tpg = nacl->se_tpg;
1407
1408         return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1409                         &lun_acl->se_lun_group.cg_item);
1410 }
1411
1412 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *se_deve)
1413 {
1414         struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1415         struct se_node_acl *nacl;
1416         struct se_portal_group *tpg;
1417         /*
1418          * For nacl->dynamic_node_acl=1
1419          */
1420         if (!lun_acl) {
1421                 atomic_dec(&se_deve->pr_ref_count);
1422                 smp_mb__after_atomic_dec();
1423                 return;
1424         }
1425         nacl = lun_acl->se_lun_nacl;
1426         tpg = nacl->se_tpg;
1427
1428         configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1429                         &lun_acl->se_lun_group.cg_item);
1430
1431         atomic_dec(&se_deve->pr_ref_count);
1432         smp_mb__after_atomic_dec();
1433 }
1434
1435 static sense_reason_t
1436 core_scsi3_decode_spec_i_port(
1437         struct se_cmd *cmd,
1438         struct se_portal_group *tpg,
1439         unsigned char *l_isid,
1440         u64 sa_res_key,
1441         int all_tg_pt,
1442         int aptpl)
1443 {
1444         struct se_device *dev = cmd->se_dev;
1445         struct se_port *tmp_port;
1446         struct se_portal_group *dest_tpg = NULL, *tmp_tpg;
1447         struct se_session *se_sess = cmd->se_sess;
1448         struct se_node_acl *dest_node_acl = NULL;
1449         struct se_dev_entry *dest_se_deve = NULL, *local_se_deve;
1450         struct t10_pr_registration *dest_pr_reg, *local_pr_reg, *pr_reg_e;
1451         struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1452         LIST_HEAD(tid_dest_list);
1453         struct pr_transport_id_holder *tidh_new, *tidh, *tidh_tmp;
1454         struct target_core_fabric_ops *tmp_tf_ops;
1455         unsigned char *buf;
1456         unsigned char *ptr, *i_str = NULL, proto_ident, tmp_proto_ident;
1457         char *iport_ptr = NULL, dest_iport[64], i_buf[PR_REG_ISID_ID_LEN];
1458         sense_reason_t ret;
1459         u32 tpdl, tid_len = 0;
1460         int dest_local_nexus;
1461         u32 dest_rtpi = 0;
1462
1463         memset(dest_iport, 0, 64);
1464
1465         local_se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
1466         /*
1467          * Allocate a struct pr_transport_id_holder and setup the
1468          * local_node_acl and local_se_deve pointers and add to
1469          * struct list_head tid_dest_list for add registration
1470          * processing in the loop of tid_dest_list below.
1471          */
1472         tidh_new = kzalloc(sizeof(struct pr_transport_id_holder), GFP_KERNEL);
1473         if (!tidh_new) {
1474                 pr_err("Unable to allocate tidh_new\n");
1475                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1476         }
1477         INIT_LIST_HEAD(&tidh_new->dest_list);
1478         tidh_new->dest_tpg = tpg;
1479         tidh_new->dest_node_acl = se_sess->se_node_acl;
1480         tidh_new->dest_se_deve = local_se_deve;
1481
1482         local_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1483                                 se_sess->se_node_acl, local_se_deve, l_isid,
1484                                 sa_res_key, all_tg_pt, aptpl);
1485         if (!local_pr_reg) {
1486                 kfree(tidh_new);
1487                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1488         }
1489         tidh_new->dest_pr_reg = local_pr_reg;
1490         /*
1491          * The local I_T nexus does not hold any configfs dependances,
1492          * so we set tid_h->dest_local_nexus=1 to prevent the
1493          * configfs_undepend_item() calls in the tid_dest_list loops below.
1494          */
1495         tidh_new->dest_local_nexus = 1;
1496         list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1497
1498         if (cmd->data_length < 28) {
1499                 pr_warn("SPC-PR: Received PR OUT parameter list"
1500                         " length too small: %u\n", cmd->data_length);
1501                 ret = TCM_INVALID_PARAMETER_LIST;
1502                 goto out;
1503         }
1504
1505         buf = transport_kmap_data_sg(cmd);
1506         if (!buf) {
1507                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1508                 goto out;
1509         }
1510
1511         /*
1512          * For a PERSISTENT RESERVE OUT specify initiator ports payload,
1513          * first extract TransportID Parameter Data Length, and make sure
1514          * the value matches up to the SCSI expected data transfer length.
1515          */
1516         tpdl = (buf[24] & 0xff) << 24;
1517         tpdl |= (buf[25] & 0xff) << 16;
1518         tpdl |= (buf[26] & 0xff) << 8;
1519         tpdl |= buf[27] & 0xff;
1520
1521         if ((tpdl + 28) != cmd->data_length) {
1522                 pr_err("SPC-3 PR: Illegal tpdl: %u + 28 byte header"
1523                         " does not equal CDB data_length: %u\n", tpdl,
1524                         cmd->data_length);
1525                 ret = TCM_INVALID_PARAMETER_LIST;
1526                 goto out_unmap;
1527         }
1528         /*
1529          * Start processing the received transport IDs using the
1530          * receiving I_T Nexus portal's fabric dependent methods to
1531          * obtain the SCSI Initiator Port/Device Identifiers.
1532          */
1533         ptr = &buf[28];
1534
1535         while (tpdl > 0) {
1536                 proto_ident = (ptr[0] & 0x0f);
1537                 dest_tpg = NULL;
1538
1539                 spin_lock(&dev->se_port_lock);
1540                 list_for_each_entry(tmp_port, &dev->dev_sep_list, sep_list) {
1541                         tmp_tpg = tmp_port->sep_tpg;
1542                         if (!tmp_tpg)
1543                                 continue;
1544                         tmp_tf_ops = tmp_tpg->se_tpg_tfo;
1545                         if (!tmp_tf_ops)
1546                                 continue;
1547                         if (!tmp_tf_ops->get_fabric_proto_ident ||
1548                             !tmp_tf_ops->tpg_parse_pr_out_transport_id)
1549                                 continue;
1550                         /*
1551                          * Look for the matching proto_ident provided by
1552                          * the received TransportID
1553                          */
1554                         tmp_proto_ident = tmp_tf_ops->get_fabric_proto_ident(tmp_tpg);
1555                         if (tmp_proto_ident != proto_ident)
1556                                 continue;
1557                         dest_rtpi = tmp_port->sep_rtpi;
1558
1559                         i_str = tmp_tf_ops->tpg_parse_pr_out_transport_id(
1560                                         tmp_tpg, (const char *)ptr, &tid_len,
1561                                         &iport_ptr);
1562                         if (!i_str)
1563                                 continue;
1564
1565                         atomic_inc(&tmp_tpg->tpg_pr_ref_count);
1566                         smp_mb__after_atomic_inc();
1567                         spin_unlock(&dev->se_port_lock);
1568
1569                         if (core_scsi3_tpg_depend_item(tmp_tpg)) {
1570                                 pr_err(" core_scsi3_tpg_depend_item()"
1571                                         " for tmp_tpg\n");
1572                                 atomic_dec(&tmp_tpg->tpg_pr_ref_count);
1573                                 smp_mb__after_atomic_dec();
1574                                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1575                                 goto out_unmap;
1576                         }
1577                         /*
1578                          * Locate the destination initiator ACL to be registered
1579                          * from the decoded fabric module specific TransportID
1580                          * at *i_str.
1581                          */
1582                         spin_lock_irq(&tmp_tpg->acl_node_lock);
1583                         dest_node_acl = __core_tpg_get_initiator_node_acl(
1584                                                 tmp_tpg, i_str);
1585                         if (dest_node_acl) {
1586                                 atomic_inc(&dest_node_acl->acl_pr_ref_count);
1587                                 smp_mb__after_atomic_inc();
1588                         }
1589                         spin_unlock_irq(&tmp_tpg->acl_node_lock);
1590
1591                         if (!dest_node_acl) {
1592                                 core_scsi3_tpg_undepend_item(tmp_tpg);
1593                                 spin_lock(&dev->se_port_lock);
1594                                 continue;
1595                         }
1596
1597                         if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
1598                                 pr_err("configfs_depend_item() failed"
1599                                         " for dest_node_acl->acl_group\n");
1600                                 atomic_dec(&dest_node_acl->acl_pr_ref_count);
1601                                 smp_mb__after_atomic_dec();
1602                                 core_scsi3_tpg_undepend_item(tmp_tpg);
1603                                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1604                                 goto out_unmap;
1605                         }
1606
1607                         dest_tpg = tmp_tpg;
1608                         pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node:"
1609                                 " %s Port RTPI: %hu\n",
1610                                 dest_tpg->se_tpg_tfo->get_fabric_name(),
1611                                 dest_node_acl->initiatorname, dest_rtpi);
1612
1613                         spin_lock(&dev->se_port_lock);
1614                         break;
1615                 }
1616                 spin_unlock(&dev->se_port_lock);
1617
1618                 if (!dest_tpg) {
1619                         pr_err("SPC-3 PR SPEC_I_PT: Unable to locate"
1620                                         " dest_tpg\n");
1621                         ret = TCM_INVALID_PARAMETER_LIST;
1622                         goto out_unmap;
1623                 }
1624
1625                 pr_debug("SPC-3 PR SPEC_I_PT: Got %s data_length: %u tpdl: %u"
1626                         " tid_len: %d for %s + %s\n",
1627                         dest_tpg->se_tpg_tfo->get_fabric_name(), cmd->data_length,
1628                         tpdl, tid_len, i_str, iport_ptr);
1629
1630                 if (tid_len > tpdl) {
1631                         pr_err("SPC-3 PR SPEC_I_PT: Illegal tid_len:"
1632                                 " %u for Transport ID: %s\n", tid_len, ptr);
1633                         core_scsi3_nodeacl_undepend_item(dest_node_acl);
1634                         core_scsi3_tpg_undepend_item(dest_tpg);
1635                         ret = TCM_INVALID_PARAMETER_LIST;
1636                         goto out_unmap;
1637                 }
1638                 /*
1639                  * Locate the desintation struct se_dev_entry pointer for matching
1640                  * RELATIVE TARGET PORT IDENTIFIER on the receiving I_T Nexus
1641                  * Target Port.
1642                  */
1643                 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl,
1644                                         dest_rtpi);
1645                 if (!dest_se_deve) {
1646                         pr_err("Unable to locate %s dest_se_deve"
1647                                 " from destination RTPI: %hu\n",
1648                                 dest_tpg->se_tpg_tfo->get_fabric_name(),
1649                                 dest_rtpi);
1650
1651                         core_scsi3_nodeacl_undepend_item(dest_node_acl);
1652                         core_scsi3_tpg_undepend_item(dest_tpg);
1653                         ret = TCM_INVALID_PARAMETER_LIST;
1654                         goto out_unmap;
1655                 }
1656
1657                 if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
1658                         pr_err("core_scsi3_lunacl_depend_item()"
1659                                         " failed\n");
1660                         atomic_dec(&dest_se_deve->pr_ref_count);
1661                         smp_mb__after_atomic_dec();
1662                         core_scsi3_nodeacl_undepend_item(dest_node_acl);
1663                         core_scsi3_tpg_undepend_item(dest_tpg);
1664                         ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1665                         goto out_unmap;
1666                 }
1667
1668                 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node: %s"
1669                         " dest_se_deve mapped_lun: %u\n",
1670                         dest_tpg->se_tpg_tfo->get_fabric_name(),
1671                         dest_node_acl->initiatorname, dest_se_deve->mapped_lun);
1672
1673                 /*
1674                  * Skip any TransportIDs that already have a registration for
1675                  * this target port.
1676                  */
1677                 pr_reg_e = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
1678                                         iport_ptr);
1679                 if (pr_reg_e) {
1680                         core_scsi3_put_pr_reg(pr_reg_e);
1681                         core_scsi3_lunacl_undepend_item(dest_se_deve);
1682                         core_scsi3_nodeacl_undepend_item(dest_node_acl);
1683                         core_scsi3_tpg_undepend_item(dest_tpg);
1684                         ptr += tid_len;
1685                         tpdl -= tid_len;
1686                         tid_len = 0;
1687                         continue;
1688                 }
1689                 /*
1690                  * Allocate a struct pr_transport_id_holder and setup
1691                  * the dest_node_acl and dest_se_deve pointers for the
1692                  * loop below.
1693                  */
1694                 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder),
1695                                 GFP_KERNEL);
1696                 if (!tidh_new) {
1697                         pr_err("Unable to allocate tidh_new\n");
1698                         core_scsi3_lunacl_undepend_item(dest_se_deve);
1699                         core_scsi3_nodeacl_undepend_item(dest_node_acl);
1700                         core_scsi3_tpg_undepend_item(dest_tpg);
1701                         ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1702                         goto out_unmap;
1703                 }
1704                 INIT_LIST_HEAD(&tidh_new->dest_list);
1705                 tidh_new->dest_tpg = dest_tpg;
1706                 tidh_new->dest_node_acl = dest_node_acl;
1707                 tidh_new->dest_se_deve = dest_se_deve;
1708
1709                 /*
1710                  * Allocate, but do NOT add the registration for the
1711                  * TransportID referenced SCSI Initiator port.  This
1712                  * done because of the following from spc4r17 in section
1713                  * 6.14.3 wrt SPEC_I_PT:
1714                  *
1715                  * "If a registration fails for any initiator port (e.g., if th
1716                  * logical unit does not have enough resources available to
1717                  * hold the registration information), no registrations shall be
1718                  * made, and the command shall be terminated with
1719                  * CHECK CONDITION status."
1720                  *
1721                  * That means we call __core_scsi3_alloc_registration() here,
1722                  * and then call __core_scsi3_add_registration() in the
1723                  * 2nd loop which will never fail.
1724                  */
1725                 dest_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1726                                 dest_node_acl, dest_se_deve, iport_ptr,
1727                                 sa_res_key, all_tg_pt, aptpl);
1728                 if (!dest_pr_reg) {
1729                         core_scsi3_lunacl_undepend_item(dest_se_deve);
1730                         core_scsi3_nodeacl_undepend_item(dest_node_acl);
1731                         core_scsi3_tpg_undepend_item(dest_tpg);
1732                         kfree(tidh_new);
1733                         ret = TCM_INVALID_PARAMETER_LIST;
1734                         goto out_unmap;
1735                 }
1736                 tidh_new->dest_pr_reg = dest_pr_reg;
1737                 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1738
1739                 ptr += tid_len;
1740                 tpdl -= tid_len;
1741                 tid_len = 0;
1742
1743         }
1744
1745         transport_kunmap_data_sg(cmd);
1746
1747         /*
1748          * Go ahead and create a registrations from tid_dest_list for the
1749          * SPEC_I_PT provided TransportID for the *tidh referenced dest_node_acl
1750          * and dest_se_deve.
1751          *
1752          * The SA Reservation Key from the PROUT is set for the
1753          * registration, and ALL_TG_PT is also passed.  ALL_TG_PT=1
1754          * means that the TransportID Initiator port will be
1755          * registered on all of the target ports in the SCSI target device
1756          * ALL_TG_PT=0 means the registration will only be for the
1757          * SCSI target port the PROUT REGISTER with SPEC_I_PT=1
1758          * was received.
1759          */
1760         list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1761                 dest_tpg = tidh->dest_tpg;
1762                 dest_node_acl = tidh->dest_node_acl;
1763                 dest_se_deve = tidh->dest_se_deve;
1764                 dest_pr_reg = tidh->dest_pr_reg;
1765                 dest_local_nexus = tidh->dest_local_nexus;
1766
1767                 list_del(&tidh->dest_list);
1768                 kfree(tidh);
1769
1770                 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1771                 core_pr_dump_initiator_port(dest_pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1772
1773                 __core_scsi3_add_registration(cmd->se_dev, dest_node_acl,
1774                                         dest_pr_reg, 0, 0);
1775
1776                 pr_debug("SPC-3 PR [%s] SPEC_I_PT: Successfully"
1777                         " registered Transport ID for Node: %s%s Mapped LUN:"
1778                         " %u\n", dest_tpg->se_tpg_tfo->get_fabric_name(),
1779                         dest_node_acl->initiatorname, i_buf, dest_se_deve->mapped_lun);
1780
1781                 if (dest_local_nexus)
1782                         continue;
1783
1784                 core_scsi3_lunacl_undepend_item(dest_se_deve);
1785                 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1786                 core_scsi3_tpg_undepend_item(dest_tpg);
1787         }
1788
1789         return 0;
1790 out_unmap:
1791         transport_kunmap_data_sg(cmd);
1792 out:
1793         /*
1794          * For the failure case, release everything from tid_dest_list
1795          * including *dest_pr_reg and the configfs dependances..
1796          */
1797         list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1798                 dest_tpg = tidh->dest_tpg;
1799                 dest_node_acl = tidh->dest_node_acl;
1800                 dest_se_deve = tidh->dest_se_deve;
1801                 dest_pr_reg = tidh->dest_pr_reg;
1802                 dest_local_nexus = tidh->dest_local_nexus;
1803
1804                 list_del(&tidh->dest_list);
1805                 kfree(tidh);
1806                 /*
1807                  * Release any extra ALL_TG_PT=1 registrations for
1808                  * the SPEC_I_PT=1 case.
1809                  */
1810                 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1811                                 &dest_pr_reg->pr_reg_atp_list,
1812                                 pr_reg_atp_mem_list) {
1813                         list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1814                         core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1815                         kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
1816                 }
1817
1818                 kfree(dest_pr_reg->pr_aptpl_buf);
1819                 kmem_cache_free(t10_pr_reg_cache, dest_pr_reg);
1820
1821                 if (dest_local_nexus)
1822                         continue;
1823
1824                 core_scsi3_lunacl_undepend_item(dest_se_deve);
1825                 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1826                 core_scsi3_tpg_undepend_item(dest_tpg);
1827         }
1828         return ret;
1829 }
1830
1831 static int core_scsi3_update_aptpl_buf(
1832         struct se_device *dev,
1833         unsigned char *buf,
1834         u32 pr_aptpl_buf_len)
1835 {
1836         struct se_lun *lun;
1837         struct se_portal_group *tpg;
1838         struct t10_pr_registration *pr_reg;
1839         unsigned char tmp[512], isid_buf[32];
1840         ssize_t len = 0;
1841         int reg_count = 0;
1842         int ret = 0;
1843
1844         memset(buf, 0, pr_aptpl_buf_len);
1845
1846         spin_lock(&dev->dev_reservation_lock);
1847         spin_lock(&dev->t10_pr.registration_lock);
1848         /*
1849          * Walk the registration list..
1850          */
1851         list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
1852                         pr_reg_list) {
1853
1854                 tmp[0] = '\0';
1855                 isid_buf[0] = '\0';
1856                 tpg = pr_reg->pr_reg_nacl->se_tpg;
1857                 lun = pr_reg->pr_reg_tg_pt_lun;
1858                 /*
1859                  * Write out any ISID value to APTPL metadata that was included
1860                  * in the original registration.
1861                  */
1862                 if (pr_reg->isid_present_at_reg)
1863                         snprintf(isid_buf, 32, "initiator_sid=%s\n",
1864                                         pr_reg->pr_reg_isid);
1865                 /*
1866                  * Include special metadata if the pr_reg matches the
1867                  * reservation holder.
1868                  */
1869                 if (dev->dev_pr_res_holder == pr_reg) {
1870                         snprintf(tmp, 512, "PR_REG_START: %d"
1871                                 "\ninitiator_fabric=%s\n"
1872                                 "initiator_node=%s\n%s"
1873                                 "sa_res_key=%llu\n"
1874                                 "res_holder=1\nres_type=%02x\n"
1875                                 "res_scope=%02x\nres_all_tg_pt=%d\n"
1876                                 "mapped_lun=%u\n", reg_count,
1877                                 tpg->se_tpg_tfo->get_fabric_name(),
1878                                 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1879                                 pr_reg->pr_res_key, pr_reg->pr_res_type,
1880                                 pr_reg->pr_res_scope, pr_reg->pr_reg_all_tg_pt,
1881                                 pr_reg->pr_res_mapped_lun);
1882                 } else {
1883                         snprintf(tmp, 512, "PR_REG_START: %d\n"
1884                                 "initiator_fabric=%s\ninitiator_node=%s\n%s"
1885                                 "sa_res_key=%llu\nres_holder=0\n"
1886                                 "res_all_tg_pt=%d\nmapped_lun=%u\n",
1887                                 reg_count, tpg->se_tpg_tfo->get_fabric_name(),
1888                                 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1889                                 pr_reg->pr_res_key, pr_reg->pr_reg_all_tg_pt,
1890                                 pr_reg->pr_res_mapped_lun);
1891                 }
1892
1893                 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1894                         pr_err("Unable to update renaming"
1895                                 " APTPL metadata\n");
1896                         ret = -EMSGSIZE;
1897                         goto out;
1898                 }
1899                 len += sprintf(buf+len, "%s", tmp);
1900
1901                 /*
1902                  * Include information about the associated SCSI target port.
1903                  */
1904                 snprintf(tmp, 512, "target_fabric=%s\ntarget_node=%s\n"
1905                         "tpgt=%hu\nport_rtpi=%hu\ntarget_lun=%u\nPR_REG_END:"
1906                         " %d\n", tpg->se_tpg_tfo->get_fabric_name(),
1907                         tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1908                         tpg->se_tpg_tfo->tpg_get_tag(tpg),
1909                         lun->lun_sep->sep_rtpi, lun->unpacked_lun, reg_count);
1910
1911                 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1912                         pr_err("Unable to update renaming"
1913                                 " APTPL metadata\n");
1914                         ret = -EMSGSIZE;
1915                         goto out;
1916                 }
1917                 len += sprintf(buf+len, "%s", tmp);
1918                 reg_count++;
1919         }
1920
1921         if (!reg_count)
1922                 len += sprintf(buf+len, "No Registrations or Reservations");
1923
1924 out:
1925         spin_unlock(&dev->t10_pr.registration_lock);
1926         spin_unlock(&dev->dev_reservation_lock);
1927
1928         return ret;
1929 }
1930
1931 /*
1932  * Called with struct se_device->aptpl_file_mutex held
1933  */
1934 static int __core_scsi3_write_aptpl_to_file(
1935         struct se_device *dev,
1936         unsigned char *buf,
1937         u32 pr_aptpl_buf_len)
1938 {
1939         struct t10_wwn *wwn = &dev->t10_wwn;
1940         struct file *file;
1941         int flags = O_RDWR | O_CREAT | O_TRUNC;
1942         char path[512];
1943         int ret;
1944
1945         memset(path, 0, 512);
1946
1947         if (strlen(&wwn->unit_serial[0]) >= 512) {
1948                 pr_err("WWN value for struct se_device does not fit"
1949                         " into path buffer\n");
1950                 return -EMSGSIZE;
1951         }
1952
1953         snprintf(path, 512, "/var/target/pr/aptpl_%s", &wwn->unit_serial[0]);
1954         file = filp_open(path, flags, 0600);
1955         if (IS_ERR(file)) {
1956                 pr_err("filp_open(%s) for APTPL metadata"
1957                         " failed\n", path);
1958                 return PTR_ERR(file);
1959         }
1960
1961         if (!pr_aptpl_buf_len)
1962                 pr_aptpl_buf_len = (strlen(&buf[0]) + 1); /* Add extra for NULL */
1963
1964         ret = kernel_write(file, buf, pr_aptpl_buf_len, 0);
1965
1966         if (ret < 0)
1967                 pr_debug("Error writing APTPL metadata file: %s\n", path);
1968         fput(file);
1969
1970         return ret ? -EIO : 0;
1971 }
1972
1973 static int
1974 core_scsi3_update_and_write_aptpl(struct se_device *dev, unsigned char *in_buf,
1975                 u32 in_pr_aptpl_buf_len)
1976 {
1977         unsigned char null_buf[64], *buf;
1978         int ret;
1979
1980         /*
1981          * Can be called with a NULL pointer from PROUT service action CLEAR
1982          */
1983         if (!in_buf) {
1984                 snprintf(null_buf, 64, "No Registrations or Reservations\n");
1985                 buf = null_buf;
1986         } else {
1987                 ret = core_scsi3_update_aptpl_buf(dev, in_buf, in_pr_aptpl_buf_len);
1988                 if (ret != 0)
1989                         return ret;
1990                 buf = in_buf;
1991         }
1992
1993         /*
1994          * __core_scsi3_write_aptpl_to_file() will call strlen()
1995          * on the passed buf to determine pr_aptpl_buf_len.
1996          */
1997         return __core_scsi3_write_aptpl_to_file(dev, buf, 0);
1998 }
1999
2000 static sense_reason_t
2001 core_scsi3_emulate_pro_register(struct se_cmd *cmd, u64 res_key, u64 sa_res_key,
2002                 int aptpl, int all_tg_pt, int spec_i_pt, enum register_type register_type)
2003 {
2004         struct se_session *se_sess = cmd->se_sess;
2005         struct se_device *dev = cmd->se_dev;
2006         struct se_dev_entry *se_deve;
2007         struct se_lun *se_lun = cmd->se_lun;
2008         struct se_portal_group *se_tpg;
2009         struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_reg_tmp, *pr_reg_e;
2010         struct t10_reservation *pr_tmpl = &dev->t10_pr;
2011         /* Used for APTPL metadata w/ UNREGISTER */
2012         unsigned char *pr_aptpl_buf = NULL;
2013         unsigned char isid_buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
2014         sense_reason_t ret = TCM_NO_SENSE;
2015         int pr_holder = 0, type;
2016
2017         if (!se_sess || !se_lun) {
2018                 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2019                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2020         }
2021         se_tpg = se_sess->se_tpg;
2022         se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
2023
2024         if (se_tpg->se_tpg_tfo->sess_get_initiator_sid) {
2025                 memset(&isid_buf[0], 0, PR_REG_ISID_LEN);
2026                 se_tpg->se_tpg_tfo->sess_get_initiator_sid(se_sess, &isid_buf[0],
2027                                 PR_REG_ISID_LEN);
2028                 isid_ptr = &isid_buf[0];
2029         }
2030         /*
2031          * Follow logic from spc4r17 Section 5.7.7, Register Behaviors Table 47
2032          */
2033         pr_reg_e = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2034         if (!pr_reg_e) {
2035                 if (res_key) {
2036                         pr_warn("SPC-3 PR: Reservation Key non-zero"
2037                                 " for SA REGISTER, returning CONFLICT\n");
2038                         return TCM_RESERVATION_CONFLICT;
2039                 }
2040                 /*
2041                  * Do nothing but return GOOD status.
2042                  */
2043                 if (!sa_res_key)
2044                         return 0;
2045
2046                 if (!spec_i_pt) {
2047                         /*
2048                          * Perform the Service Action REGISTER on the Initiator
2049                          * Port Endpoint that the PRO was received from on the
2050                          * Logical Unit of the SCSI device server.
2051                          */
2052                         if (core_scsi3_alloc_registration(cmd->se_dev,
2053                                         se_sess->se_node_acl, se_deve, isid_ptr,
2054                                         sa_res_key, all_tg_pt, aptpl,
2055                                         register_type, 0)) {
2056                                 pr_err("Unable to allocate"
2057                                         " struct t10_pr_registration\n");
2058                                 return TCM_INVALID_PARAMETER_LIST;
2059                         }
2060                 } else {
2061                         /*
2062                          * Register both the Initiator port that received
2063                          * PROUT SA REGISTER + SPEC_I_PT=1 and extract SCSI
2064                          * TransportID from Parameter list and loop through
2065                          * fabric dependent parameter list while calling
2066                          * logic from of core_scsi3_alloc_registration() for
2067                          * each TransportID provided SCSI Initiator Port/Device
2068                          */
2069                         ret = core_scsi3_decode_spec_i_port(cmd, se_tpg,
2070                                         isid_ptr, sa_res_key, all_tg_pt, aptpl);
2071                         if (ret != 0)
2072                                 return ret;
2073                 }
2074                 /*
2075                  * Nothing left to do for the APTPL=0 case.
2076                  */
2077                 if (!aptpl) {
2078                         pr_tmpl->pr_aptpl_active = 0;
2079                         core_scsi3_update_and_write_aptpl(cmd->se_dev, NULL, 0);
2080                         pr_debug("SPC-3 PR: Set APTPL Bit Deactivated for"
2081                                         " REGISTER\n");
2082                         return 0;
2083                 }
2084                 /*
2085                  * Locate the newly allocated local I_T Nexus *pr_reg, and
2086                  * update the APTPL metadata information using its
2087                  * preallocated *pr_reg->pr_aptpl_buf.
2088                  */
2089                 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev,
2090                                 se_sess->se_node_acl, se_sess);
2091
2092                 if (core_scsi3_update_and_write_aptpl(cmd->se_dev,
2093                                 &pr_reg->pr_aptpl_buf[0],
2094                                 pr_tmpl->pr_aptpl_buf_len)) {
2095                         pr_tmpl->pr_aptpl_active = 1;
2096                         pr_debug("SPC-3 PR: Set APTPL Bit Activated for REGISTER\n");
2097                 }
2098
2099                 goto out_put_pr_reg;
2100         }
2101
2102         /*
2103          * Locate the existing *pr_reg via struct se_node_acl pointers
2104          */
2105         pr_reg = pr_reg_e;
2106         type = pr_reg->pr_res_type;
2107
2108         if (register_type == REGISTER) {
2109                 if (res_key != pr_reg->pr_res_key) {
2110                         pr_err("SPC-3 PR REGISTER: Received"
2111                                 " res_key: 0x%016Lx does not match"
2112                                 " existing SA REGISTER res_key:"
2113                                 " 0x%016Lx\n", res_key,
2114                                 pr_reg->pr_res_key);
2115                         ret = TCM_RESERVATION_CONFLICT;
2116                         goto out_put_pr_reg;
2117                 }
2118         }
2119
2120         if (spec_i_pt) {
2121                 pr_err("SPC-3 PR REGISTER: SPEC_I_PT"
2122                         " set on a registered nexus\n");
2123                 ret = TCM_INVALID_PARAMETER_LIST;
2124                 goto out_put_pr_reg;
2125         }
2126
2127         /*
2128          * An existing ALL_TG_PT=1 registration being released
2129          * must also set ALL_TG_PT=1 in the incoming PROUT.
2130          */
2131         if (pr_reg->pr_reg_all_tg_pt && !all_tg_pt) {
2132                 pr_err("SPC-3 PR REGISTER: ALL_TG_PT=1"
2133                         " registration exists, but ALL_TG_PT=1 bit not"
2134                         " present in received PROUT\n");
2135                 ret = TCM_INVALID_CDB_FIELD;
2136                 goto out_put_pr_reg;
2137         }
2138
2139         /*
2140          * Allocate APTPL metadata buffer used for UNREGISTER ops
2141          */
2142         if (aptpl) {
2143                 pr_aptpl_buf = kzalloc(pr_tmpl->pr_aptpl_buf_len,
2144                                         GFP_KERNEL);
2145                 if (!pr_aptpl_buf) {
2146                         pr_err("Unable to allocate"
2147                                 " pr_aptpl_buf\n");
2148                         ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2149                         goto out_put_pr_reg;
2150                 }
2151         }
2152
2153         /*
2154          * sa_res_key=0 Unregister Reservation Key for registered I_T
2155          * Nexus sa_res_key=1 Change Reservation Key for registered I_T
2156          * Nexus.
2157          */
2158         if (!sa_res_key) {
2159                 pr_holder = core_scsi3_check_implict_release(
2160                                 cmd->se_dev, pr_reg);
2161                 if (pr_holder < 0) {
2162                         kfree(pr_aptpl_buf);
2163                         ret = TCM_RESERVATION_CONFLICT;
2164                         goto out_put_pr_reg;
2165                 }
2166
2167                 spin_lock(&pr_tmpl->registration_lock);
2168                 /*
2169                  * Release all ALL_TG_PT=1 for the matching SCSI Initiator Port
2170                  * and matching pr_res_key.
2171                  */
2172                 if (pr_reg->pr_reg_all_tg_pt) {
2173                         list_for_each_entry_safe(pr_reg_p, pr_reg_tmp,
2174                                         &pr_tmpl->registration_list,
2175                                         pr_reg_list) {
2176
2177                                 if (!pr_reg_p->pr_reg_all_tg_pt)
2178                                         continue;
2179                                 if (pr_reg_p->pr_res_key != res_key)
2180                                         continue;
2181                                 if (pr_reg == pr_reg_p)
2182                                         continue;
2183                                 if (strcmp(pr_reg->pr_reg_nacl->initiatorname,
2184                                            pr_reg_p->pr_reg_nacl->initiatorname))
2185                                         continue;
2186
2187                                 __core_scsi3_free_registration(dev,
2188                                                 pr_reg_p, NULL, 0);
2189                         }
2190                 }
2191
2192                 /*
2193                  * Release the calling I_T Nexus registration now..
2194                  */
2195                 __core_scsi3_free_registration(cmd->se_dev, pr_reg, NULL, 1);
2196
2197                 /*
2198                  * From spc4r17, section 5.7.11.3 Unregistering
2199                  *
2200                  * If the persistent reservation is a registrants only
2201                  * type, the device server shall establish a unit
2202                  * attention condition for the initiator port associated
2203                  * with every registered I_T nexus except for the I_T
2204                  * nexus on which the PERSISTENT RESERVE OUT command was
2205                  * received, with the additional sense code set to
2206                  * RESERVATIONS RELEASED.
2207                  */
2208                 if (pr_holder &&
2209                    (type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY ||
2210                     type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY)) {
2211                         list_for_each_entry(pr_reg_p,
2212                                         &pr_tmpl->registration_list,
2213                                         pr_reg_list) {
2214
2215                                 core_scsi3_ua_allocate(
2216                                         pr_reg_p->pr_reg_nacl,
2217                                         pr_reg_p->pr_res_mapped_lun,
2218                                         0x2A,
2219                                         ASCQ_2AH_RESERVATIONS_RELEASED);
2220                         }
2221                 }
2222                 spin_unlock(&pr_tmpl->registration_lock);
2223
2224                 if (!aptpl) {
2225                         pr_tmpl->pr_aptpl_active = 0;
2226                         core_scsi3_update_and_write_aptpl(dev, NULL, 0);
2227                         pr_debug("SPC-3 PR: Set APTPL Bit Deactivated"
2228                                         " for UNREGISTER\n");
2229                         return 0;
2230                 }
2231
2232                 if (!core_scsi3_update_and_write_aptpl(dev, &pr_aptpl_buf[0],
2233                                 pr_tmpl->pr_aptpl_buf_len)) {
2234                         pr_tmpl->pr_aptpl_active = 1;
2235                         pr_debug("SPC-3 PR: Set APTPL Bit Activated"
2236                                         " for UNREGISTER\n");
2237                 }
2238
2239                 goto out_free_aptpl_buf;
2240         }
2241
2242         /*
2243          * Increment PRgeneration counter for struct se_device"
2244          * upon a successful REGISTER, see spc4r17 section 6.3.2
2245          * READ_KEYS service action.
2246          */
2247         pr_reg->pr_res_generation = core_scsi3_pr_generation(cmd->se_dev);
2248         pr_reg->pr_res_key = sa_res_key;
2249         pr_debug("SPC-3 PR [%s] REGISTER%s: Changed Reservation"
2250                 " Key for %s to: 0x%016Lx PRgeneration:"
2251                 " 0x%08x\n", cmd->se_tfo->get_fabric_name(),
2252                 (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ? "_AND_IGNORE_EXISTING_KEY" : "",
2253                 pr_reg->pr_reg_nacl->initiatorname,
2254                 pr_reg->pr_res_key, pr_reg->pr_res_generation);
2255
2256         if (!aptpl) {
2257                 pr_tmpl->pr_aptpl_active = 0;
2258                 core_scsi3_update_and_write_aptpl(dev, NULL, 0);
2259                 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated"
2260                                 " for REGISTER\n");
2261                 ret = 0;
2262                 goto out_put_pr_reg;
2263         }
2264
2265         if (!core_scsi3_update_and_write_aptpl(dev, &pr_aptpl_buf[0],
2266                                                 pr_tmpl->pr_aptpl_buf_len)) {
2267                 pr_tmpl->pr_aptpl_active = 1;
2268                 pr_debug("SPC-3 PR: Set APTPL Bit Activated"
2269                         " for REGISTER\n");
2270         }
2271
2272 out_free_aptpl_buf:
2273         kfree(pr_aptpl_buf);
2274         ret = 0;
2275 out_put_pr_reg:
2276         core_scsi3_put_pr_reg(pr_reg);
2277         return ret;
2278 }
2279
2280 unsigned char *core_scsi3_pr_dump_type(int type)
2281 {
2282         switch (type) {
2283         case PR_TYPE_WRITE_EXCLUSIVE:
2284                 return "Write Exclusive Access";
2285         case PR_TYPE_EXCLUSIVE_ACCESS:
2286                 return "Exclusive Access";
2287         case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2288                 return "Write Exclusive Access, Registrants Only";
2289         case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2290                 return "Exclusive Access, Registrants Only";
2291         case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2292                 return "Write Exclusive Access, All Registrants";
2293         case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2294                 return "Exclusive Access, All Registrants";
2295         default:
2296                 break;
2297         }
2298
2299         return "Unknown SPC-3 PR Type";
2300 }
2301
2302 static sense_reason_t
2303 core_scsi3_pro_reserve(struct se_cmd *cmd, int type, int scope, u64 res_key)
2304 {
2305         struct se_device *dev = cmd->se_dev;
2306         struct se_session *se_sess = cmd->se_sess;
2307         struct se_lun *se_lun = cmd->se_lun;
2308         struct t10_pr_registration *pr_reg, *pr_res_holder;
2309         struct t10_reservation *pr_tmpl = &dev->t10_pr;
2310         char i_buf[PR_REG_ISID_ID_LEN];
2311         sense_reason_t ret;
2312
2313         memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2314
2315         if (!se_sess || !se_lun) {
2316                 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2317                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2318         }
2319         /*
2320          * Locate the existing *pr_reg via struct se_node_acl pointers
2321          */
2322         pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2323                                 se_sess);
2324         if (!pr_reg) {
2325                 pr_err("SPC-3 PR: Unable to locate"
2326                         " PR_REGISTERED *pr_reg for RESERVE\n");
2327                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2328         }
2329         /*
2330          * From spc4r17 Section 5.7.9: Reserving:
2331          *
2332          * An application client creates a persistent reservation by issuing
2333          * a PERSISTENT RESERVE OUT command with RESERVE service action through
2334          * a registered I_T nexus with the following parameters:
2335          *    a) RESERVATION KEY set to the value of the reservation key that is
2336          *       registered with the logical unit for the I_T nexus; and
2337          */
2338         if (res_key != pr_reg->pr_res_key) {
2339                 pr_err("SPC-3 PR RESERVE: Received res_key: 0x%016Lx"
2340                         " does not match existing SA REGISTER res_key:"
2341                         " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2342                 ret = TCM_RESERVATION_CONFLICT;
2343                 goto out_put_pr_reg;
2344         }
2345         /*
2346          * From spc4r17 Section 5.7.9: Reserving:
2347          *
2348          * From above:
2349          *  b) TYPE field and SCOPE field set to the persistent reservation
2350          *     being created.
2351          *
2352          * Only one persistent reservation is allowed at a time per logical unit
2353          * and that persistent reservation has a scope of LU_SCOPE.
2354          */
2355         if (scope != PR_SCOPE_LU_SCOPE) {
2356                 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2357                 ret = TCM_INVALID_PARAMETER_LIST;
2358                 goto out_put_pr_reg;
2359         }
2360         /*
2361          * See if we have an existing PR reservation holder pointer at
2362          * struct se_device->dev_pr_res_holder in the form struct t10_pr_registration
2363          * *pr_res_holder.
2364          */
2365         spin_lock(&dev->dev_reservation_lock);
2366         pr_res_holder = dev->dev_pr_res_holder;
2367         if (pr_res_holder) {
2368                 /*
2369                  * From spc4r17 Section 5.7.9: Reserving:
2370                  *
2371                  * If the device server receives a PERSISTENT RESERVE OUT
2372                  * command from an I_T nexus other than a persistent reservation
2373                  * holder (see 5.7.10) that attempts to create a persistent
2374                  * reservation when a persistent reservation already exists for
2375                  * the logical unit, then the command shall be completed with
2376                  * RESERVATION CONFLICT status.
2377                  */
2378                 if (pr_res_holder != pr_reg) {
2379                         struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2380                         pr_err("SPC-3 PR: Attempted RESERVE from"
2381                                 " [%s]: %s while reservation already held by"
2382                                 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2383                                 cmd->se_tfo->get_fabric_name(),
2384                                 se_sess->se_node_acl->initiatorname,
2385                                 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2386                                 pr_res_holder->pr_reg_nacl->initiatorname);
2387
2388                         spin_unlock(&dev->dev_reservation_lock);
2389                         ret = TCM_RESERVATION_CONFLICT;
2390                         goto out_put_pr_reg;
2391                 }
2392                 /*
2393                  * From spc4r17 Section 5.7.9: Reserving:
2394                  *
2395                  * If a persistent reservation holder attempts to modify the
2396                  * type or scope of an existing persistent reservation, the
2397                  * command shall be completed with RESERVATION CONFLICT status.
2398                  */
2399                 if ((pr_res_holder->pr_res_type != type) ||
2400                     (pr_res_holder->pr_res_scope != scope)) {
2401                         struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2402                         pr_err("SPC-3 PR: Attempted RESERVE from"
2403                                 " [%s]: %s trying to change TYPE and/or SCOPE,"
2404                                 " while reservation already held by [%s]: %s,"
2405                                 " returning RESERVATION_CONFLICT\n",
2406                                 cmd->se_tfo->get_fabric_name(),
2407                                 se_sess->se_node_acl->initiatorname,
2408                                 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2409                                 pr_res_holder->pr_reg_nacl->initiatorname);
2410
2411                         spin_unlock(&dev->dev_reservation_lock);
2412                         ret = TCM_RESERVATION_CONFLICT;
2413                         goto out_put_pr_reg;
2414                 }
2415                 /*
2416                  * From spc4r17 Section 5.7.9: Reserving:
2417                  *
2418                  * If the device server receives a PERSISTENT RESERVE OUT
2419                  * command with RESERVE service action where the TYPE field and
2420                  * the SCOPE field contain the same values as the existing type
2421                  * and scope from a persistent reservation holder, it shall not
2422                  * make any change to the existing persistent reservation and
2423                  * shall completethe command with GOOD status.
2424                  */
2425                 spin_unlock(&dev->dev_reservation_lock);
2426                 ret = 0;
2427                 goto out_put_pr_reg;
2428         }
2429         /*
2430          * Otherwise, our *pr_reg becomes the PR reservation holder for said
2431          * TYPE/SCOPE.  Also set the received scope and type in *pr_reg.
2432          */
2433         pr_reg->pr_res_scope = scope;
2434         pr_reg->pr_res_type = type;
2435         pr_reg->pr_res_holder = 1;
2436         dev->dev_pr_res_holder = pr_reg;
2437         core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2438
2439         pr_debug("SPC-3 PR [%s] Service Action: RESERVE created new"
2440                 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2441                 cmd->se_tfo->get_fabric_name(), core_scsi3_pr_dump_type(type),
2442                 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2443         pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
2444                         cmd->se_tfo->get_fabric_name(),
2445                         se_sess->se_node_acl->initiatorname,
2446                         i_buf);
2447         spin_unlock(&dev->dev_reservation_lock);
2448
2449         if (pr_tmpl->pr_aptpl_active) {
2450                 if (!core_scsi3_update_and_write_aptpl(cmd->se_dev,
2451                                 &pr_reg->pr_aptpl_buf[0],
2452                                 pr_tmpl->pr_aptpl_buf_len)) {
2453                         pr_debug("SPC-3 PR: Updated APTPL metadata"
2454                                         " for RESERVE\n");
2455                 }
2456         }
2457
2458         ret = 0;
2459 out_put_pr_reg:
2460         core_scsi3_put_pr_reg(pr_reg);
2461         return ret;
2462 }
2463
2464 static sense_reason_t
2465 core_scsi3_emulate_pro_reserve(struct se_cmd *cmd, int type, int scope,
2466                 u64 res_key)
2467 {
2468         switch (type) {
2469         case PR_TYPE_WRITE_EXCLUSIVE:
2470         case PR_TYPE_EXCLUSIVE_ACCESS:
2471         case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2472         case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2473         case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2474         case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2475                 return core_scsi3_pro_reserve(cmd, type, scope, res_key);
2476         default:
2477                 pr_err("SPC-3 PR: Unknown Service Action RESERVE Type:"
2478                         " 0x%02x\n", type);
2479                 return TCM_INVALID_CDB_FIELD;
2480         }
2481 }
2482
2483 /*
2484  * Called with struct se_device->dev_reservation_lock held.
2485  */
2486 static void __core_scsi3_complete_pro_release(
2487         struct se_device *dev,
2488         struct se_node_acl *se_nacl,
2489         struct t10_pr_registration *pr_reg,
2490         int explict)
2491 {
2492         struct target_core_fabric_ops *tfo = se_nacl->se_tpg->se_tpg_tfo;
2493         char i_buf[PR_REG_ISID_ID_LEN];
2494
2495         memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2496         core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2497         /*
2498          * Go ahead and release the current PR reservation holder.
2499          */
2500         dev->dev_pr_res_holder = NULL;
2501
2502         pr_debug("SPC-3 PR [%s] Service Action: %s RELEASE cleared"
2503                 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2504                 tfo->get_fabric_name(), (explict) ? "explict" : "implict",
2505                 core_scsi3_pr_dump_type(pr_reg->pr_res_type),
2506                 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2507         pr_debug("SPC-3 PR [%s] RELEASE Node: %s%s\n",
2508                 tfo->get_fabric_name(), se_nacl->initiatorname,
2509                 i_buf);
2510         /*
2511          * Clear TYPE and SCOPE for the next PROUT Service Action: RESERVE
2512          */
2513         pr_reg->pr_res_holder = pr_reg->pr_res_type = pr_reg->pr_res_scope = 0;
2514 }
2515
2516 static sense_reason_t
2517 core_scsi3_emulate_pro_release(struct se_cmd *cmd, int type, int scope,
2518                 u64 res_key)
2519 {
2520         struct se_device *dev = cmd->se_dev;
2521         struct se_session *se_sess = cmd->se_sess;
2522         struct se_lun *se_lun = cmd->se_lun;
2523         struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_res_holder;
2524         struct t10_reservation *pr_tmpl = &dev->t10_pr;
2525         int all_reg = 0;
2526         sense_reason_t ret = 0;
2527
2528         if (!se_sess || !se_lun) {
2529                 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2530                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2531         }
2532         /*
2533          * Locate the existing *pr_reg via struct se_node_acl pointers
2534          */
2535         pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2536         if (!pr_reg) {
2537                 pr_err("SPC-3 PR: Unable to locate"
2538                         " PR_REGISTERED *pr_reg for RELEASE\n");
2539                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2540         }
2541         /*
2542          * From spc4r17 Section 5.7.11.2 Releasing:
2543          *
2544          * If there is no persistent reservation or in response to a persistent
2545          * reservation release request from a registered I_T nexus that is not a
2546          * persistent reservation holder (see 5.7.10), the device server shall
2547          * do the following:
2548          *
2549          *     a) Not release the persistent reservation, if any;
2550          *     b) Not remove any registrations; and
2551          *     c) Complete the command with GOOD status.
2552          */
2553         spin_lock(&dev->dev_reservation_lock);
2554         pr_res_holder = dev->dev_pr_res_holder;
2555         if (!pr_res_holder) {
2556                 /*
2557                  * No persistent reservation, return GOOD status.
2558                  */
2559                 spin_unlock(&dev->dev_reservation_lock);
2560                 goto out_put_pr_reg;
2561         }
2562         if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2563             (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
2564                 all_reg = 1;
2565
2566         if ((all_reg == 0) && (pr_res_holder != pr_reg)) {
2567                 /*
2568                  * Non 'All Registrants' PR Type cases..
2569                  * Release request from a registered I_T nexus that is not a
2570                  * persistent reservation holder. return GOOD status.
2571                  */
2572                 spin_unlock(&dev->dev_reservation_lock);
2573                 goto out_put_pr_reg;
2574         }
2575
2576         /*
2577          * From spc4r17 Section 5.7.11.2 Releasing:
2578          *
2579          * Only the persistent reservation holder (see 5.7.10) is allowed to
2580          * release a persistent reservation.
2581          *
2582          * An application client releases the persistent reservation by issuing
2583          * a PERSISTENT RESERVE OUT command with RELEASE service action through
2584          * an I_T nexus that is a persistent reservation holder with the
2585          * following parameters:
2586          *
2587          *     a) RESERVATION KEY field set to the value of the reservation key
2588          *        that is registered with the logical unit for the I_T nexus;
2589          */
2590         if (res_key != pr_reg->pr_res_key) {
2591                 pr_err("SPC-3 PR RELEASE: Received res_key: 0x%016Lx"
2592                         " does not match existing SA REGISTER res_key:"
2593                         " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2594                 spin_unlock(&dev->dev_reservation_lock);
2595                 ret = TCM_RESERVATION_CONFLICT;
2596                 goto out_put_pr_reg;
2597         }
2598         /*
2599          * From spc4r17 Section 5.7.11.2 Releasing and above:
2600          *
2601          * b) TYPE field and SCOPE field set to match the persistent
2602          *    reservation being released.
2603          */
2604         if ((pr_res_holder->pr_res_type != type) ||
2605             (pr_res_holder->pr_res_scope != scope)) {
2606                 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2607                 pr_err("SPC-3 PR RELEASE: Attempted to release"
2608                         " reservation from [%s]: %s with different TYPE "
2609                         "and/or SCOPE  while reservation already held by"
2610                         " [%s]: %s, returning RESERVATION_CONFLICT\n",
2611                         cmd->se_tfo->get_fabric_name(),
2612                         se_sess->se_node_acl->initiatorname,
2613                         pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2614                         pr_res_holder->pr_reg_nacl->initiatorname);
2615
2616                 spin_unlock(&dev->dev_reservation_lock);
2617                 ret = TCM_RESERVATION_CONFLICT;
2618                 goto out_put_pr_reg;
2619         }
2620         /*
2621          * In response to a persistent reservation release request from the
2622          * persistent reservation holder the device server shall perform a
2623          * release by doing the following as an uninterrupted series of actions:
2624          * a) Release the persistent reservation;
2625          * b) Not remove any registration(s);
2626          * c) If the released persistent reservation is a registrants only type
2627          * or all registrants type persistent reservation,
2628          *    the device server shall establish a unit attention condition for
2629          *    the initiator port associated with every regis-
2630          *    tered I_T nexus other than I_T nexus on which the PERSISTENT
2631          *    RESERVE OUT command with RELEASE service action was received,
2632          *    with the additional sense code set to RESERVATIONS RELEASED; and
2633          * d) If the persistent reservation is of any other type, the device
2634          *    server shall not establish a unit attention condition.
2635          */
2636         __core_scsi3_complete_pro_release(dev, se_sess->se_node_acl,
2637                         pr_reg, 1);
2638
2639         spin_unlock(&dev->dev_reservation_lock);
2640
2641         if ((type != PR_TYPE_WRITE_EXCLUSIVE_REGONLY) &&
2642             (type != PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) &&
2643             (type != PR_TYPE_WRITE_EXCLUSIVE_ALLREG) &&
2644             (type != PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
2645                 /*
2646                  * If no UNIT ATTENTION conditions will be established for
2647                  * PR_TYPE_WRITE_EXCLUSIVE or PR_TYPE_EXCLUSIVE_ACCESS
2648                  * go ahead and check for APTPL=1 update+write below
2649                  */
2650                 goto write_aptpl;
2651         }
2652
2653         spin_lock(&pr_tmpl->registration_lock);
2654         list_for_each_entry(pr_reg_p, &pr_tmpl->registration_list,
2655                         pr_reg_list) {
2656                 /*
2657                  * Do not establish a UNIT ATTENTION condition
2658                  * for the calling I_T Nexus
2659                  */
2660                 if (pr_reg_p == pr_reg)
2661                         continue;
2662
2663                 core_scsi3_ua_allocate(pr_reg_p->pr_reg_nacl,
2664                                 pr_reg_p->pr_res_mapped_lun,
2665                                 0x2A, ASCQ_2AH_RESERVATIONS_RELEASED);
2666         }
2667         spin_unlock(&pr_tmpl->registration_lock);
2668
2669 write_aptpl:
2670         if (pr_tmpl->pr_aptpl_active) {
2671                 if (!core_scsi3_update_and_write_aptpl(cmd->se_dev,
2672                         &pr_reg->pr_aptpl_buf[0], pr_tmpl->pr_aptpl_buf_len)) {
2673                         pr_debug("SPC-3 PR: Updated APTPL metadata for RELEASE\n");
2674                 }
2675         }
2676 out_put_pr_reg:
2677         core_scsi3_put_pr_reg(pr_reg);
2678         return ret;
2679 }
2680
2681 static sense_reason_t
2682 core_scsi3_emulate_pro_clear(struct se_cmd *cmd, u64 res_key)
2683 {
2684         struct se_device *dev = cmd->se_dev;
2685         struct se_node_acl *pr_reg_nacl;
2686         struct se_session *se_sess = cmd->se_sess;
2687         struct t10_reservation *pr_tmpl = &dev->t10_pr;
2688         struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2689         u32 pr_res_mapped_lun = 0;
2690         int calling_it_nexus = 0;
2691         /*
2692          * Locate the existing *pr_reg via struct se_node_acl pointers
2693          */
2694         pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev,
2695                         se_sess->se_node_acl, se_sess);
2696         if (!pr_reg_n) {
2697                 pr_err("SPC-3 PR: Unable to locate"
2698                         " PR_REGISTERED *pr_reg for CLEAR\n");
2699                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2700         }
2701         /*
2702          * From spc4r17 section 5.7.11.6, Clearing:
2703          *
2704          * Any application client may release the persistent reservation and
2705          * remove all registrations from a device server by issuing a
2706          * PERSISTENT RESERVE OUT command with CLEAR service action through a
2707          * registered I_T nexus with the following parameter:
2708          *
2709          *      a) RESERVATION KEY field set to the value of the reservation key
2710          *         that is registered with the logical unit for the I_T nexus.
2711          */
2712         if (res_key != pr_reg_n->pr_res_key) {
2713                 pr_err("SPC-3 PR REGISTER: Received"
2714                         " res_key: 0x%016Lx does not match"
2715                         " existing SA REGISTER res_key:"
2716                         " 0x%016Lx\n", res_key, pr_reg_n->pr_res_key);
2717                 core_scsi3_put_pr_reg(pr_reg_n);
2718                 return TCM_RESERVATION_CONFLICT;
2719         }
2720         /*
2721          * a) Release the persistent reservation, if any;
2722          */
2723         spin_lock(&dev->dev_reservation_lock);
2724         pr_res_holder = dev->dev_pr_res_holder;
2725         if (pr_res_holder) {
2726                 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2727                 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
2728                         pr_res_holder, 0);
2729         }
2730         spin_unlock(&dev->dev_reservation_lock);
2731         /*
2732          * b) Remove all registration(s) (see spc4r17 5.7.7);
2733          */
2734         spin_lock(&pr_tmpl->registration_lock);
2735         list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2736                         &pr_tmpl->registration_list, pr_reg_list) {
2737
2738                 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2739                 pr_reg_nacl = pr_reg->pr_reg_nacl;
2740                 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2741                 __core_scsi3_free_registration(dev, pr_reg, NULL,
2742                                         calling_it_nexus);
2743                 /*
2744                  * e) Establish a unit attention condition for the initiator
2745                  *    port associated with every registered I_T nexus other
2746                  *    than the I_T nexus on which the PERSISTENT RESERVE OUT
2747                  *    command with CLEAR service action was received, with the
2748                  *    additional sense code set to RESERVATIONS PREEMPTED.
2749                  */
2750                 if (!calling_it_nexus)
2751                         core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun,
2752                                 0x2A, ASCQ_2AH_RESERVATIONS_PREEMPTED);
2753         }
2754         spin_unlock(&pr_tmpl->registration_lock);
2755
2756         pr_debug("SPC-3 PR [%s] Service Action: CLEAR complete\n",
2757                 cmd->se_tfo->get_fabric_name());
2758
2759         if (pr_tmpl->pr_aptpl_active) {
2760                 core_scsi3_update_and_write_aptpl(cmd->se_dev, NULL, 0);
2761                 pr_debug("SPC-3 PR: Updated APTPL metadata"
2762                                 " for CLEAR\n");
2763         }
2764
2765         core_scsi3_pr_generation(dev);
2766         return 0;
2767 }
2768
2769 /*
2770  * Called with struct se_device->dev_reservation_lock held.
2771  */
2772 static void __core_scsi3_complete_pro_preempt(
2773         struct se_device *dev,
2774         struct t10_pr_registration *pr_reg,
2775         struct list_head *preempt_and_abort_list,
2776         int type,
2777         int scope,
2778         enum preempt_type preempt_type)
2779 {
2780         struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
2781         struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
2782         char i_buf[PR_REG_ISID_ID_LEN];
2783
2784         memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2785         core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2786         /*
2787          * Do an implict RELEASE of the existing reservation.
2788          */
2789         if (dev->dev_pr_res_holder)
2790                 __core_scsi3_complete_pro_release(dev, nacl,
2791                                 dev->dev_pr_res_holder, 0);
2792
2793         dev->dev_pr_res_holder = pr_reg;
2794         pr_reg->pr_res_holder = 1;
2795         pr_reg->pr_res_type = type;
2796         pr_reg->pr_res_scope = scope;
2797
2798         pr_debug("SPC-3 PR [%s] Service Action: PREEMPT%s created new"
2799                 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2800                 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2801                 core_scsi3_pr_dump_type(type),
2802                 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2803         pr_debug("SPC-3 PR [%s] PREEMPT%s from Node: %s%s\n",
2804                 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2805                 nacl->initiatorname, i_buf);
2806         /*
2807          * For PREEMPT_AND_ABORT, add the preempting reservation's
2808          * struct t10_pr_registration to the list that will be compared
2809          * against received CDBs..
2810          */
2811         if (preempt_and_abort_list)
2812                 list_add_tail(&pr_reg->pr_reg_abort_list,
2813                                 preempt_and_abort_list);
2814 }
2815
2816 static void core_scsi3_release_preempt_and_abort(
2817         struct list_head *preempt_and_abort_list,
2818         struct t10_pr_registration *pr_reg_holder)
2819 {
2820         struct t10_pr_registration *pr_reg, *pr_reg_tmp;
2821
2822         list_for_each_entry_safe(pr_reg, pr_reg_tmp, preempt_and_abort_list,
2823                                 pr_reg_abort_list) {
2824
2825                 list_del(&pr_reg->pr_reg_abort_list);
2826                 if (pr_reg_holder == pr_reg)
2827                         continue;
2828                 if (pr_reg->pr_res_holder) {
2829                         pr_warn("pr_reg->pr_res_holder still set\n");
2830                         continue;
2831                 }
2832
2833                 pr_reg->pr_reg_deve = NULL;
2834                 pr_reg->pr_reg_nacl = NULL;
2835                 kfree(pr_reg->pr_aptpl_buf);
2836                 kmem_cache_free(t10_pr_reg_cache, pr_reg);
2837         }
2838 }
2839
2840 static sense_reason_t
2841 core_scsi3_pro_preempt(struct se_cmd *cmd, int type, int scope, u64 res_key,
2842                 u64 sa_res_key, enum preempt_type preempt_type)
2843 {
2844         struct se_device *dev = cmd->se_dev;
2845         struct se_node_acl *pr_reg_nacl;
2846         struct se_session *se_sess = cmd->se_sess;
2847         LIST_HEAD(preempt_and_abort_list);
2848         struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2849         struct t10_reservation *pr_tmpl = &dev->t10_pr;
2850         u32 pr_res_mapped_lun = 0;
2851         int all_reg = 0, calling_it_nexus = 0, released_regs = 0;
2852         int prh_type = 0, prh_scope = 0;
2853
2854         if (!se_sess)
2855                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2856
2857         pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2858                                 se_sess);
2859         if (!pr_reg_n) {
2860                 pr_err("SPC-3 PR: Unable to locate"
2861                         " PR_REGISTERED *pr_reg for PREEMPT%s\n",
2862                         (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "");
2863                 return TCM_RESERVATION_CONFLICT;
2864         }
2865         if (pr_reg_n->pr_res_key != res_key) {
2866                 core_scsi3_put_pr_reg(pr_reg_n);
2867                 return TCM_RESERVATION_CONFLICT;
2868         }
2869         if (scope != PR_SCOPE_LU_SCOPE) {
2870                 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2871                 core_scsi3_put_pr_reg(pr_reg_n);
2872                 return TCM_INVALID_PARAMETER_LIST;
2873         }
2874
2875         spin_lock(&dev->dev_reservation_lock);
2876         pr_res_holder = dev->dev_pr_res_holder;
2877         if (pr_res_holder &&
2878            ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2879             (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)))
2880                 all_reg = 1;
2881
2882         if (!all_reg && !sa_res_key) {
2883                 spin_unlock(&dev->dev_reservation_lock);
2884                 core_scsi3_put_pr_reg(pr_reg_n);
2885                 return TCM_INVALID_PARAMETER_LIST;
2886         }
2887         /*
2888          * From spc4r17, section 5.7.11.4.4 Removing Registrations:
2889          *
2890          * If the SERVICE ACTION RESERVATION KEY field does not identify a
2891          * persistent reservation holder or there is no persistent reservation
2892          * holder (i.e., there is no persistent reservation), then the device
2893          * server shall perform a preempt by doing the following in an
2894          * uninterrupted series of actions. (See below..)
2895          */
2896         if (!pr_res_holder || (pr_res_holder->pr_res_key != sa_res_key)) {
2897                 /*
2898                  * No existing or SA Reservation Key matching reservations..
2899                  *
2900                  * PROUT SA PREEMPT with All Registrant type reservations are
2901                  * allowed to be processed without a matching SA Reservation Key
2902                  */
2903                 spin_lock(&pr_tmpl->registration_lock);
2904                 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2905                                 &pr_tmpl->registration_list, pr_reg_list) {
2906                         /*
2907                          * Removing of registrations in non all registrants
2908                          * type reservations without a matching SA reservation
2909                          * key.
2910                          *
2911                          * a) Remove the registrations for all I_T nexuses
2912                          *    specified by the SERVICE ACTION RESERVATION KEY
2913                          *    field;
2914                          * b) Ignore the contents of the SCOPE and TYPE fields;
2915                          * c) Process tasks as defined in 5.7.1; and
2916                          * d) Establish a unit attention condition for the
2917                          *    initiator port associated with every I_T nexus
2918                          *    that lost its registration other than the I_T
2919                          *    nexus on which the PERSISTENT RESERVE OUT command
2920                          *    was received, with the additional sense code set
2921                          *    to REGISTRATIONS PREEMPTED.
2922                          */
2923                         if (!all_reg) {
2924                                 if (pr_reg->pr_res_key != sa_res_key)
2925                                         continue;
2926
2927                                 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2928                                 pr_reg_nacl = pr_reg->pr_reg_nacl;
2929                                 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2930                                 __core_scsi3_free_registration(dev, pr_reg,
2931                                         (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2932                                                 NULL, calling_it_nexus);
2933                                 released_regs++;
2934                         } else {
2935                                 /*
2936                                  * Case for any existing all registrants type
2937                                  * reservation, follow logic in spc4r17 section
2938                                  * 5.7.11.4 Preempting, Table 52 and Figure 7.
2939                                  *
2940                                  * For a ZERO SA Reservation key, release
2941                                  * all other registrations and do an implict
2942                                  * release of active persistent reservation.
2943                                  *
2944                                  * For a non-ZERO SA Reservation key, only
2945                                  * release the matching reservation key from
2946                                  * registrations.
2947                                  */
2948                                 if ((sa_res_key) &&
2949                                      (pr_reg->pr_res_key != sa_res_key))
2950                                         continue;
2951
2952                                 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2953                                 if (calling_it_nexus)
2954                                         continue;
2955
2956                                 pr_reg_nacl = pr_reg->pr_reg_nacl;
2957                                 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2958                                 __core_scsi3_free_registration(dev, pr_reg,
2959                                         (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2960                                                 NULL, 0);
2961                                 released_regs++;
2962                         }
2963                         if (!calling_it_nexus)
2964                                 core_scsi3_ua_allocate(pr_reg_nacl,
2965                                         pr_res_mapped_lun, 0x2A,
2966                                         ASCQ_2AH_REGISTRATIONS_PREEMPTED);
2967                 }
2968                 spin_unlock(&pr_tmpl->registration_lock);
2969                 /*
2970                  * If a PERSISTENT RESERVE OUT with a PREEMPT service action or
2971                  * a PREEMPT AND ABORT service action sets the SERVICE ACTION
2972                  * RESERVATION KEY field to a value that does not match any
2973                  * registered reservation key, then the device server shall
2974                  * complete the command with RESERVATION CONFLICT status.
2975                  */
2976                 if (!released_regs) {
2977                         spin_unlock(&dev->dev_reservation_lock);
2978                         core_scsi3_put_pr_reg(pr_reg_n);
2979                         return TCM_RESERVATION_CONFLICT;
2980                 }
2981                 /*
2982                  * For an existing all registrants type reservation
2983                  * with a zero SA rservation key, preempt the existing
2984                  * reservation with the new PR type and scope.
2985                  */
2986                 if (pr_res_holder && all_reg && !(sa_res_key)) {
2987                         __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
2988                                 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
2989                                 type, scope, preempt_type);
2990
2991                         if (preempt_type == PREEMPT_AND_ABORT)
2992                                 core_scsi3_release_preempt_and_abort(
2993                                         &preempt_and_abort_list, pr_reg_n);
2994                 }
2995                 spin_unlock(&dev->dev_reservation_lock);
2996
2997                 if (pr_tmpl->pr_aptpl_active) {
2998                         if (!core_scsi3_update_and_write_aptpl(cmd->se_dev,
2999                                         &pr_reg_n->pr_aptpl_buf[0],
3000                                         pr_tmpl->pr_aptpl_buf_len)) {
3001                                 pr_debug("SPC-3 PR: Updated APTPL"
3002                                         " metadata for  PREEMPT%s\n", (preempt_type == PREEMPT_AND_ABORT) ?
3003                                         "_AND_ABORT" : "");
3004                         }
3005                 }
3006
3007                 core_scsi3_put_pr_reg(pr_reg_n);
3008                 core_scsi3_pr_generation(cmd->se_dev);
3009                 return 0;
3010         }
3011         /*
3012          * The PREEMPTing SA reservation key matches that of the
3013          * existing persistent reservation, first, we check if
3014          * we are preempting our own reservation.
3015          * From spc4r17, section 5.7.11.4.3 Preempting
3016          * persistent reservations and registration handling
3017          *
3018          * If an all registrants persistent reservation is not
3019          * present, it is not an error for the persistent
3020          * reservation holder to preempt itself (i.e., a
3021          * PERSISTENT RESERVE OUT with a PREEMPT service action
3022          * or a PREEMPT AND ABORT service action with the
3023          * SERVICE ACTION RESERVATION KEY value equal to the
3024          * persistent reservation holder's reservation key that
3025          * is received from the persistent reservation holder).
3026          * In that case, the device server shall establish the
3027          * new persistent reservation and maintain the
3028          * registration.
3029          */
3030         prh_type = pr_res_holder->pr_res_type;
3031         prh_scope = pr_res_holder->pr_res_scope;
3032         /*
3033          * If the SERVICE ACTION RESERVATION KEY field identifies a
3034          * persistent reservation holder (see 5.7.10), the device
3035          * server shall perform a preempt by doing the following as
3036          * an uninterrupted series of actions:
3037          *
3038          * a) Release the persistent reservation for the holder
3039          *    identified by the SERVICE ACTION RESERVATION KEY field;
3040          */
3041         if (pr_reg_n != pr_res_holder)
3042                 __core_scsi3_complete_pro_release(dev,
3043                                 pr_res_holder->pr_reg_nacl,
3044                                 dev->dev_pr_res_holder, 0);
3045         /*
3046          * b) Remove the registrations for all I_T nexuses identified
3047          *    by the SERVICE ACTION RESERVATION KEY field, except the
3048          *    I_T nexus that is being used for the PERSISTENT RESERVE
3049          *    OUT command. If an all registrants persistent reservation
3050          *    is present and the SERVICE ACTION RESERVATION KEY field
3051          *    is set to zero, then all registrations shall be removed
3052          *    except for that of the I_T nexus that is being used for
3053          *    the PERSISTENT RESERVE OUT command;
3054          */
3055         spin_lock(&pr_tmpl->registration_lock);
3056         list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3057                         &pr_tmpl->registration_list, pr_reg_list) {
3058
3059                 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3060                 if (calling_it_nexus)
3061                         continue;
3062
3063                 if (pr_reg->pr_res_key != sa_res_key)
3064                         continue;
3065
3066                 pr_reg_nacl = pr_reg->pr_reg_nacl;
3067                 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
3068                 __core_scsi3_free_registration(dev, pr_reg,
3069                                 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
3070                                 calling_it_nexus);
3071                 /*
3072                  * e) Establish a unit attention condition for the initiator
3073                  *    port associated with every I_T nexus that lost its
3074                  *    persistent reservation and/or registration, with the
3075                  *    additional sense code set to REGISTRATIONS PREEMPTED;
3076                  */
3077                 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun, 0x2A,
3078                                 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
3079         }
3080         spin_unlock(&pr_tmpl->registration_lock);
3081         /*
3082          * c) Establish a persistent reservation for the preempting
3083          *    I_T nexus using the contents of the SCOPE and TYPE fields;
3084          */
3085         __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
3086                         (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
3087                         type, scope, preempt_type);
3088         /*
3089          * d) Process tasks as defined in 5.7.1;
3090          * e) See above..
3091          * f) If the type or scope has changed, then for every I_T nexus
3092          *    whose reservation key was not removed, except for the I_T
3093          *    nexus on which the PERSISTENT RESERVE OUT command was
3094          *    received, the device server shall establish a unit
3095          *    attention condition for the initiator port associated with
3096          *    that I_T nexus, with the additional sense code set to
3097          *    RESERVATIONS RELEASED. If the type or scope have not
3098          *    changed, then no unit attention condition(s) shall be
3099          *    established for this reason.
3100          */
3101         if ((prh_type != type) || (prh_scope != scope)) {
3102                 spin_lock(&pr_tmpl->registration_lock);
3103                 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3104                                 &pr_tmpl->registration_list, pr_reg_list) {
3105
3106                         calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3107                         if (calling_it_nexus)
3108                                 continue;
3109
3110                         core_scsi3_ua_allocate(pr_reg->pr_reg_nacl,
3111                                         pr_reg->pr_res_mapped_lun, 0x2A,
3112                                         ASCQ_2AH_RESERVATIONS_RELEASED);
3113                 }
3114                 spin_unlock(&pr_tmpl->registration_lock);
3115         }
3116         spin_unlock(&dev->dev_reservation_lock);
3117         /*
3118          * Call LUN_RESET logic upon list of struct t10_pr_registration,
3119          * All received CDBs for the matching existing reservation and
3120          * registrations undergo ABORT_TASK logic.
3121          *
3122          * From there, core_scsi3_release_preempt_and_abort() will
3123          * release every registration in the list (which have already
3124          * been removed from the primary pr_reg list), except the
3125          * new persistent reservation holder, the calling Initiator Port.
3126          */
3127         if (preempt_type == PREEMPT_AND_ABORT) {
3128                 core_tmr_lun_reset(dev, NULL, &preempt_and_abort_list, cmd);
3129                 core_scsi3_release_preempt_and_abort(&preempt_and_abort_list,
3130                                                 pr_reg_n);
3131         }
3132
3133         if (pr_tmpl->pr_aptpl_active) {
3134                 if (!core_scsi3_update_and_write_aptpl(cmd->se_dev,
3135                                 &pr_reg_n->pr_aptpl_buf[0],
3136                                 pr_tmpl->pr_aptpl_buf_len)) {
3137                         pr_debug("SPC-3 PR: Updated APTPL metadata for PREEMPT"
3138                                 "%s\n", (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "");
3139                 }
3140         }
3141
3142         core_scsi3_put_pr_reg(pr_reg_n);
3143         core_scsi3_pr_generation(cmd->se_dev);
3144         return 0;
3145 }
3146
3147 static sense_reason_t
3148 core_scsi3_emulate_pro_preempt(struct se_cmd *cmd, int type, int scope,
3149                 u64 res_key, u64 sa_res_key, enum preempt_type preempt_type)
3150 {
3151         switch (type) {
3152         case PR_TYPE_WRITE_EXCLUSIVE:
3153         case PR_TYPE_EXCLUSIVE_ACCESS:
3154         case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
3155         case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
3156         case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
3157         case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
3158                 return core_scsi3_pro_preempt(cmd, type, scope, res_key,
3159                                               sa_res_key, preempt_type);
3160         default:
3161                 pr_err("SPC-3 PR: Unknown Service Action PREEMPT%s"
3162                         " Type: 0x%02x\n", (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "", type);
3163                 return TCM_INVALID_CDB_FIELD;
3164         }
3165 }
3166
3167
3168 static sense_reason_t
3169 core_scsi3_emulate_pro_register_and_move(struct se_cmd *cmd, u64 res_key,
3170                 u64 sa_res_key, int aptpl, int unreg)
3171 {
3172         struct se_session *se_sess = cmd->se_sess;
3173         struct se_device *dev = cmd->se_dev;
3174         struct se_dev_entry *dest_se_deve = NULL;
3175         struct se_lun *se_lun = cmd->se_lun;
3176         struct se_node_acl *pr_res_nacl, *pr_reg_nacl, *dest_node_acl = NULL;
3177         struct se_port *se_port;
3178         struct se_portal_group *se_tpg, *dest_se_tpg = NULL;
3179         struct target_core_fabric_ops *dest_tf_ops = NULL, *tf_ops;
3180         struct t10_pr_registration *pr_reg, *pr_res_holder, *dest_pr_reg;
3181         struct t10_reservation *pr_tmpl = &dev->t10_pr;
3182         unsigned char *buf;
3183         unsigned char *initiator_str;
3184         char *iport_ptr = NULL, dest_iport[64], i_buf[PR_REG_ISID_ID_LEN];
3185         u32 tid_len, tmp_tid_len;
3186         int new_reg = 0, type, scope, matching_iname;
3187         sense_reason_t ret;
3188         unsigned short rtpi;
3189         unsigned char proto_ident;
3190
3191         if (!se_sess || !se_lun) {
3192                 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
3193                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3194         }
3195
3196         memset(dest_iport, 0, 64);
3197         memset(i_buf, 0, PR_REG_ISID_ID_LEN);
3198         se_tpg = se_sess->se_tpg;
3199         tf_ops = se_tpg->se_tpg_tfo;
3200         /*
3201          * Follow logic from spc4r17 Section 5.7.8, Table 50 --
3202          *      Register behaviors for a REGISTER AND MOVE service action
3203          *
3204          * Locate the existing *pr_reg via struct se_node_acl pointers
3205          */
3206         pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
3207                                 se_sess);
3208         if (!pr_reg) {
3209                 pr_err("SPC-3 PR: Unable to locate PR_REGISTERED"
3210                         " *pr_reg for REGISTER_AND_MOVE\n");
3211                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3212         }
3213         /*
3214          * The provided reservation key much match the existing reservation key
3215          * provided during this initiator's I_T nexus registration.
3216          */
3217         if (res_key != pr_reg->pr_res_key) {
3218                 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received"
3219                         " res_key: 0x%016Lx does not match existing SA REGISTER"
3220                         " res_key: 0x%016Lx\n", res_key, pr_reg->pr_res_key);
3221                 ret = TCM_RESERVATION_CONFLICT;
3222                 goto out_put_pr_reg;
3223         }
3224         /*
3225          * The service active reservation key needs to be non zero
3226          */
3227         if (!sa_res_key) {
3228                 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received zero"
3229                         " sa_res_key\n");
3230                 ret = TCM_INVALID_PARAMETER_LIST;
3231                 goto out_put_pr_reg;
3232         }
3233
3234         /*
3235          * Determine the Relative Target Port Identifier where the reservation
3236          * will be moved to for the TransportID containing SCSI initiator WWN
3237          * information.
3238          */
3239         buf = transport_kmap_data_sg(cmd);
3240         if (!buf) {
3241                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3242                 goto out_put_pr_reg;
3243         }
3244
3245         rtpi = (buf[18] & 0xff) << 8;
3246         rtpi |= buf[19] & 0xff;
3247         tid_len = (buf[20] & 0xff) << 24;
3248         tid_len |= (buf[21] & 0xff) << 16;
3249         tid_len |= (buf[22] & 0xff) << 8;
3250         tid_len |= buf[23] & 0xff;
3251         transport_kunmap_data_sg(cmd);
3252         buf = NULL;
3253
3254         if ((tid_len + 24) != cmd->data_length) {
3255                 pr_err("SPC-3 PR: Illegal tid_len: %u + 24 byte header"
3256                         " does not equal CDB data_length: %u\n", tid_len,
3257                         cmd->data_length);
3258                 ret = TCM_INVALID_PARAMETER_LIST;
3259                 goto out_put_pr_reg;
3260         }
3261
3262         spin_lock(&dev->se_port_lock);
3263         list_for_each_entry(se_port, &dev->dev_sep_list, sep_list) {
3264                 if (se_port->sep_rtpi != rtpi)
3265                         continue;
3266                 dest_se_tpg = se_port->sep_tpg;
3267                 if (!dest_se_tpg)
3268                         continue;
3269                 dest_tf_ops = dest_se_tpg->se_tpg_tfo;
3270                 if (!dest_tf_ops)
3271                         continue;
3272
3273                 atomic_inc(&dest_se_tpg->tpg_pr_ref_count);
3274                 smp_mb__after_atomic_inc();
3275                 spin_unlock(&dev->se_port_lock);
3276
3277                 if (core_scsi3_tpg_depend_item(dest_se_tpg)) {
3278                         pr_err("core_scsi3_tpg_depend_item() failed"
3279                                 " for dest_se_tpg\n");
3280                         atomic_dec(&dest_se_tpg->tpg_pr_ref_count);
3281                         smp_mb__after_atomic_dec();
3282                         ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3283                         goto out_put_pr_reg;
3284                 }
3285
3286                 spin_lock(&dev->se_port_lock);
3287                 break;
3288         }
3289         spin_unlock(&dev->se_port_lock);
3290
3291         if (!dest_se_tpg || !dest_tf_ops) {
3292                 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3293                         " fabric ops from Relative Target Port Identifier:"
3294                         " %hu\n", rtpi);
3295                 ret = TCM_INVALID_PARAMETER_LIST;
3296                 goto out_put_pr_reg;
3297         }
3298
3299         buf = transport_kmap_data_sg(cmd);
3300         if (!buf) {
3301                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3302                 goto out_put_pr_reg;
3303         }
3304         proto_ident = (buf[24] & 0x0f);
3305
3306         pr_debug("SPC-3 PR REGISTER_AND_MOVE: Extracted Protocol Identifier:"
3307                         " 0x%02x\n", proto_ident);
3308
3309         if (proto_ident != dest_tf_ops->get_fabric_proto_ident(dest_se_tpg)) {
3310                 pr_err("SPC-3 PR REGISTER_AND_MOVE: Received"
3311                         " proto_ident: 0x%02x does not match ident: 0x%02x"
3312                         " from fabric: %s\n", proto_ident,
3313                         dest_tf_ops->get_fabric_proto_ident(dest_se_tpg),
3314                         dest_tf_ops->get_fabric_name());
3315                 ret = TCM_INVALID_PARAMETER_LIST;
3316                 goto out;
3317         }
3318         if (dest_tf_ops->tpg_parse_pr_out_transport_id == NULL) {
3319                 pr_err("SPC-3 PR REGISTER_AND_MOVE: Fabric does not"
3320                         " containg a valid tpg_parse_pr_out_transport_id"
3321                         " function pointer\n");
3322                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3323                 goto out;
3324         }
3325         initiator_str = dest_tf_ops->tpg_parse_pr_out_transport_id(dest_se_tpg,
3326                         (const char *)&buf[24], &tmp_tid_len, &iport_ptr);
3327         if (!initiator_str) {
3328                 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3329                         " initiator_str from Transport ID\n");
3330                 ret = TCM_INVALID_PARAMETER_LIST;
3331                 goto out;
3332         }
3333
3334         transport_kunmap_data_sg(cmd);
3335         buf = NULL;
3336
3337         pr_debug("SPC-3 PR [%s] Extracted initiator %s identifier: %s"
3338                 " %s\n", dest_tf_ops->get_fabric_name(), (iport_ptr != NULL) ?
3339                 "port" : "device", initiator_str, (iport_ptr != NULL) ?
3340                 iport_ptr : "");
3341         /*
3342          * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3343          * action specifies a TransportID that is the same as the initiator port
3344          * of the I_T nexus for the command received, then the command shall
3345          * be terminated with CHECK CONDITION status, with the sense key set to
3346          * ILLEGAL REQUEST, and the additional sense code set to INVALID FIELD
3347          * IN PARAMETER LIST.
3348          */
3349         pr_reg_nacl = pr_reg->pr_reg_nacl;
3350         matching_iname = (!strcmp(initiator_str,
3351                                   pr_reg_nacl->initiatorname)) ? 1 : 0;
3352         if (!matching_iname)
3353                 goto after_iport_check;
3354
3355         if (!iport_ptr || !pr_reg->isid_present_at_reg) {
3356                 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s"
3357                         " matches: %s on received I_T Nexus\n", initiator_str,
3358                         pr_reg_nacl->initiatorname);
3359                 ret = TCM_INVALID_PARAMETER_LIST;
3360                 goto out;
3361         }
3362         if (!strcmp(iport_ptr, pr_reg->pr_reg_isid)) {
3363                 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s %s"
3364                         " matches: %s %s on received I_T Nexus\n",
3365                         initiator_str, iport_ptr, pr_reg_nacl->initiatorname,
3366                         pr_reg->pr_reg_isid);
3367                 ret = TCM_INVALID_PARAMETER_LIST;
3368                 goto out;
3369         }
3370 after_iport_check:
3371         /*
3372          * Locate the destination struct se_node_acl from the received Transport ID
3373          */
3374         spin_lock_irq(&dest_se_tpg->acl_node_lock);
3375         dest_node_acl = __core_tpg_get_initiator_node_acl(dest_se_tpg,
3376                                 initiator_str);
3377         if (dest_node_acl) {
3378                 atomic_inc(&dest_node_acl->acl_pr_ref_count);
3379                 smp_mb__after_atomic_inc();
3380         }
3381         spin_unlock_irq(&dest_se_tpg->acl_node_lock);
3382
3383         if (!dest_node_acl) {
3384                 pr_err("Unable to locate %s dest_node_acl for"
3385                         " TransportID%s\n", dest_tf_ops->get_fabric_name(),
3386                         initiator_str);
3387                 ret = TCM_INVALID_PARAMETER_LIST;
3388                 goto out;
3389         }
3390
3391         if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
3392                 pr_err("core_scsi3_nodeacl_depend_item() for"
3393                         " dest_node_acl\n");
3394                 atomic_dec(&dest_node_acl->acl_pr_ref_count);
3395                 smp_mb__after_atomic_dec();
3396                 dest_node_acl = NULL;
3397                 ret = TCM_INVALID_PARAMETER_LIST;
3398                 goto out;
3399         }
3400
3401         pr_debug("SPC-3 PR REGISTER_AND_MOVE: Found %s dest_node_acl:"
3402                 " %s from TransportID\n", dest_tf_ops->get_fabric_name(),
3403                 dest_node_acl->initiatorname);
3404
3405         /*
3406          * Locate the struct se_dev_entry pointer for the matching RELATIVE TARGET
3407          * PORT IDENTIFIER.
3408          */
3409         dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl, rtpi);
3410         if (!dest_se_deve) {
3411                 pr_err("Unable to locate %s dest_se_deve from RTPI:"
3412                         " %hu\n",  dest_tf_ops->get_fabric_name(), rtpi);
3413                 ret = TCM_INVALID_PARAMETER_LIST;
3414                 goto out;
3415         }
3416
3417         if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
3418                 pr_err("core_scsi3_lunacl_depend_item() failed\n");
3419                 atomic_dec(&dest_se_deve->pr_ref_count);
3420                 smp_mb__after_atomic_dec();
3421                 dest_se_deve = NULL;
3422                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3423                 goto out;
3424         }
3425
3426         pr_debug("SPC-3 PR REGISTER_AND_MOVE: Located %s node %s LUN"
3427                 " ACL for dest_se_deve->mapped_lun: %u\n",
3428                 dest_tf_ops->get_fabric_name(), dest_node_acl->initiatorname,
3429                 dest_se_deve->mapped_lun);
3430
3431         /*
3432          * A persistent reservation needs to already existing in order to
3433          * successfully complete the REGISTER_AND_MOVE service action..
3434          */
3435         spin_lock(&dev->dev_reservation_lock);
3436         pr_res_holder = dev->dev_pr_res_holder;
3437         if (!pr_res_holder) {
3438                 pr_warn("SPC-3 PR REGISTER_AND_MOVE: No reservation"
3439                         " currently held\n");
3440                 spin_unlock(&dev->dev_reservation_lock);
3441                 ret = TCM_INVALID_CDB_FIELD;
3442                 goto out;
3443         }
3444         /*
3445          * The received on I_T Nexus must be the reservation holder.
3446          *
3447          * From spc4r17 section 5.7.8  Table 50 --
3448          *      Register behaviors for a REGISTER AND MOVE service action
3449          */
3450         if (pr_res_holder != pr_reg) {
3451                 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Calling I_T"
3452                         " Nexus is not reservation holder\n");
3453                 spin_unlock(&dev->dev_reservation_lock);
3454                 ret = TCM_RESERVATION_CONFLICT;
3455                 goto out;
3456         }
3457         /*
3458          * From spc4r17 section 5.7.8: registering and moving reservation
3459          *
3460          * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3461          * action is received and the established persistent reservation is a
3462          * Write Exclusive - All Registrants type or Exclusive Access -
3463          * All Registrants type reservation, then the command shall be completed
3464          * with RESERVATION CONFLICT status.
3465          */
3466         if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3467             (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
3468                 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Unable to move"
3469                         " reservation for type: %s\n",
3470                         core_scsi3_pr_dump_type(pr_res_holder->pr_res_type));
3471                 spin_unlock(&dev->dev_reservation_lock);
3472                 ret = TCM_RESERVATION_CONFLICT;
3473                 goto out;
3474         }
3475         pr_res_nacl = pr_res_holder->pr_reg_nacl;
3476         /*
3477          * b) Ignore the contents of the (received) SCOPE and TYPE fields;
3478          */
3479         type = pr_res_holder->pr_res_type;
3480         scope = pr_res_holder->pr_res_type;
3481         /*
3482          * c) Associate the reservation key specified in the SERVICE ACTION
3483          *    RESERVATION KEY field with the I_T nexus specified as the
3484          *    destination of the register and move, where:
3485          *    A) The I_T nexus is specified by the TransportID and the
3486          *       RELATIVE TARGET PORT IDENTIFIER field (see 6.14.4); and
3487          *    B) Regardless of the TransportID format used, the association for
3488          *       the initiator port is based on either the initiator port name
3489          *       (see 3.1.71) on SCSI transport protocols where port names are
3490          *       required or the initiator port identifier (see 3.1.70) on SCSI
3491          *       transport protocols where port names are not required;
3492          * d) Register the reservation key specified in the SERVICE ACTION
3493          *    RESERVATION KEY field;
3494          * e) Retain the reservation key specified in the SERVICE ACTION
3495          *    RESERVATION KEY field and associated information;
3496          *
3497          * Also, It is not an error for a REGISTER AND MOVE service action to
3498          * register an I_T nexus that is already registered with the same
3499          * reservation key or a different reservation key.
3500          */
3501         dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3502                                         iport_ptr);
3503         if (!dest_pr_reg) {
3504                 if (core_scsi3_alloc_registration(cmd->se_dev,
3505                                 dest_node_acl, dest_se_deve, iport_ptr,
3506                                 sa_res_key, 0, aptpl, 2, 1)) {
3507                         spin_unlock(&dev->dev_reservation_lock);
3508                         ret = TCM_INVALID_PARAMETER_LIST;
3509                         goto out;
3510                 }
3511                 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3512                                                 iport_ptr);
3513                 new_reg = 1;
3514         }
3515         /*
3516          * f) Release the persistent reservation for the persistent reservation
3517          *    holder (i.e., the I_T nexus on which the
3518          */
3519         __core_scsi3_complete_pro_release(dev, pr_res_nacl,
3520                         dev->dev_pr_res_holder, 0);
3521         /*
3522          * g) Move the persistent reservation to the specified I_T nexus using
3523          *    the same scope and type as the persistent reservation released in
3524          *    item f); and
3525          */
3526         dev->dev_pr_res_holder = dest_pr_reg;
3527         dest_pr_reg->pr_res_holder = 1;
3528         dest_pr_reg->pr_res_type = type;
3529         pr_reg->pr_res_scope = scope;
3530         core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
3531         /*
3532          * Increment PRGeneration for existing registrations..
3533          */
3534         if (!new_reg)
3535                 dest_pr_reg->pr_res_generation = pr_tmpl->pr_generation++;
3536         spin_unlock(&dev->dev_reservation_lock);
3537
3538         pr_debug("SPC-3 PR [%s] Service Action: REGISTER_AND_MOVE"
3539                 " created new reservation holder TYPE: %s on object RTPI:"
3540                 " %hu  PRGeneration: 0x%08x\n", dest_tf_ops->get_fabric_name(),
3541                 core_scsi3_pr_dump_type(type), rtpi,
3542                 dest_pr_reg->pr_res_generation);
3543         pr_debug("SPC-3 PR Successfully moved reservation from"
3544                 " %s Fabric Node: %s%s -> %s Fabric Node: %s %s\n",
3545                 tf_ops->get_fabric_name(), pr_reg_nacl->initiatorname,
3546                 i_buf, dest_tf_ops->get_fabric_name(),
3547                 dest_node_acl->initiatorname, (iport_ptr != NULL) ?
3548                 iport_ptr : "");
3549         /*
3550          * It is now safe to release configfs group dependencies for destination
3551          * of Transport ID Initiator Device/Port Identifier
3552          */
3553         core_scsi3_lunacl_undepend_item(dest_se_deve);
3554         core_scsi3_nodeacl_undepend_item(dest_node_acl);
3555         core_scsi3_tpg_undepend_item(dest_se_tpg);
3556         /*
3557          * h) If the UNREG bit is set to one, unregister (see 5.7.11.3) the I_T
3558          * nexus on which PERSISTENT RESERVE OUT command was received.
3559          */
3560         if (unreg) {
3561                 spin_lock(&pr_tmpl->registration_lock);
3562                 __core_scsi3_free_registration(dev, pr_reg, NULL, 1);
3563                 spin_unlock(&pr_tmpl->registration_lock);
3564         } else
3565                 core_scsi3_put_pr_reg(pr_reg);
3566
3567         /*
3568          * Clear the APTPL metadata if APTPL has been disabled, otherwise
3569          * write out the updated metadata to struct file for this SCSI device.
3570          */
3571         if (!aptpl) {
3572                 pr_tmpl->pr_aptpl_active = 0;
3573                 core_scsi3_update_and_write_aptpl(cmd->se_dev, NULL, 0);
3574                 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated for"
3575                                 " REGISTER_AND_MOVE\n");
3576         } else {
3577                 pr_tmpl->pr_aptpl_active = 1;
3578                 if (!core_scsi3_update_and_write_aptpl(cmd->se_dev,
3579                                 &dest_pr_reg->pr_aptpl_buf[0],
3580                                 pr_tmpl->pr_aptpl_buf_len)) {
3581                         pr_debug("SPC-3 PR: Set APTPL Bit Activated for"
3582                                         " REGISTER_AND_MOVE\n");
3583                 }
3584         }
3585
3586         transport_kunmap_data_sg(cmd);
3587
3588         core_scsi3_put_pr_reg(dest_pr_reg);
3589         return 0;
3590 out:
3591         if (buf)
3592                 transport_kunmap_data_sg(cmd);
3593         if (dest_se_deve)
3594                 core_scsi3_lunacl_undepend_item(dest_se_deve);
3595         if (dest_node_acl)
3596                 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3597         core_scsi3_tpg_undepend_item(dest_se_tpg);
3598
3599 out_put_pr_reg:
3600         core_scsi3_put_pr_reg(pr_reg);
3601         return ret;
3602 }
3603
3604 static unsigned long long core_scsi3_extract_reservation_key(unsigned char *cdb)
3605 {
3606         unsigned int __v1, __v2;
3607
3608         __v1 = (cdb[0] << 24) | (cdb[1] << 16) | (cdb[2] << 8) | cdb[3];
3609         __v2 = (cdb[4] << 24) | (cdb[5] << 16) | (cdb[6] << 8) | cdb[7];
3610
3611         return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
3612 }
3613
3614 /*
3615  * See spc4r17 section 6.14 Table 170
3616  */
3617 sense_reason_t
3618 target_scsi3_emulate_pr_out(struct se_cmd *cmd)
3619 {
3620         unsigned char *cdb = &cmd->t_task_cdb[0];
3621         unsigned char *buf;
3622         u64 res_key, sa_res_key;
3623         int sa, scope, type, aptpl;
3624         int spec_i_pt = 0, all_tg_pt = 0, unreg = 0;
3625         sense_reason_t ret;
3626
3627         /*
3628          * Following spc2r20 5.5.1 Reservations overview:
3629          *
3630          * If a logical unit has been reserved by any RESERVE command and is
3631          * still reserved by any initiator, all PERSISTENT RESERVE IN and all
3632          * PERSISTENT RESERVE OUT commands shall conflict regardless of
3633          * initiator or service action and shall terminate with a RESERVATION
3634          * CONFLICT status.
3635          */
3636         if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
3637                 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
3638                         " SPC-2 reservation is held, returning"
3639                         " RESERVATION_CONFLICT\n");
3640                 return TCM_RESERVATION_CONFLICT;
3641         }
3642
3643         /*
3644          * FIXME: A NULL struct se_session pointer means an this is not coming from
3645          * a $FABRIC_MOD's nexus, but from internal passthrough ops.
3646          */
3647         if (!cmd->se_sess)
3648                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3649
3650         if (cmd->data_length < 24) {
3651                 pr_warn("SPC-PR: Received PR OUT parameter list"
3652                         " length too small: %u\n", cmd->data_length);
3653                 return TCM_INVALID_PARAMETER_LIST;
3654         }
3655
3656         /*
3657          * From the PERSISTENT_RESERVE_OUT command descriptor block (CDB)
3658          */
3659         sa = (cdb[1] & 0x1f);
3660         scope = (cdb[2] & 0xf0);
3661         type = (cdb[2] & 0x0f);
3662
3663         buf = transport_kmap_data_sg(cmd);
3664         if (!buf)
3665                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3666
3667         /*
3668          * From PERSISTENT_RESERVE_OUT parameter list (payload)
3669          */
3670         res_key = core_scsi3_extract_reservation_key(&buf[0]);
3671         sa_res_key = core_scsi3_extract_reservation_key(&buf[8]);
3672         /*
3673          * REGISTER_AND_MOVE uses a different SA parameter list containing
3674          * SCSI TransportIDs.
3675          */
3676         if (sa != PRO_REGISTER_AND_MOVE) {
3677                 spec_i_pt = (buf[20] & 0x08);
3678                 all_tg_pt = (buf[20] & 0x04);
3679                 aptpl = (buf[20] & 0x01);
3680         } else {
3681                 aptpl = (buf[17] & 0x01);
3682                 unreg = (buf[17] & 0x02);
3683         }
3684         transport_kunmap_data_sg(cmd);
3685         buf = NULL;
3686
3687         /*
3688          * SPEC_I_PT=1 is only valid for Service action: REGISTER
3689          */
3690         if (spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER))
3691                 return TCM_INVALID_PARAMETER_LIST;
3692
3693         /*
3694          * From spc4r17 section 6.14:
3695          *
3696          * If the SPEC_I_PT bit is set to zero, the service action is not
3697          * REGISTER AND MOVE, and the parameter list length is not 24, then
3698          * the command shall be terminated with CHECK CONDITION status, with
3699          * the sense key set to ILLEGAL REQUEST, and the additional sense
3700          * code set to PARAMETER LIST LENGTH ERROR.
3701          */
3702         if (!spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER_AND_MOVE) &&
3703             (cmd->data_length != 24)) {
3704                 pr_warn("SPC-PR: Received PR OUT illegal parameter"
3705                         " list length: %u\n", cmd->data_length);
3706                 return TCM_INVALID_PARAMETER_LIST;
3707         }
3708
3709         /*
3710          * (core_scsi3_emulate_pro_* function parameters
3711          * are defined by spc4r17 Table 174:
3712          * PERSISTENT_RESERVE_OUT service actions and valid parameters.
3713          */
3714         switch (sa) {
3715         case PRO_REGISTER:
3716                 ret = core_scsi3_emulate_pro_register(cmd,
3717                         res_key, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER);
3718                 break;
3719         case PRO_RESERVE:
3720                 ret = core_scsi3_emulate_pro_reserve(cmd, type, scope, res_key);
3721                 break;
3722         case PRO_RELEASE:
3723                 ret = core_scsi3_emulate_pro_release(cmd, type, scope, res_key);
3724                 break;
3725         case PRO_CLEAR:
3726                 ret = core_scsi3_emulate_pro_clear(cmd, res_key);
3727                 break;
3728         case PRO_PREEMPT:
3729                 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3730                                         res_key, sa_res_key, PREEMPT);
3731                 break;
3732         case PRO_PREEMPT_AND_ABORT:
3733                 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3734                                         res_key, sa_res_key, PREEMPT_AND_ABORT);
3735                 break;
3736         case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
3737                 ret = core_scsi3_emulate_pro_register(cmd,
3738                         0, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER_AND_IGNORE_EXISTING_KEY);
3739                 break;
3740         case PRO_REGISTER_AND_MOVE:
3741                 ret = core_scsi3_emulate_pro_register_and_move(cmd, res_key,
3742                                 sa_res_key, aptpl, unreg);
3743                 break;
3744         default:
3745                 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
3746                         " action: 0x%02x\n", cdb[1] & 0x1f);
3747                 return TCM_INVALID_CDB_FIELD;
3748         }
3749
3750         if (!ret)
3751                 target_complete_cmd(cmd, GOOD);
3752         return ret;
3753 }
3754
3755 /*
3756  * PERSISTENT_RESERVE_IN Service Action READ_KEYS
3757  *
3758  * See spc4r17 section 5.7.6.2 and section 6.13.2, Table 160
3759  */
3760 static sense_reason_t
3761 core_scsi3_pri_read_keys(struct se_cmd *cmd)
3762 {
3763         struct se_device *dev = cmd->se_dev;
3764         struct t10_pr_registration *pr_reg;
3765         unsigned char *buf;
3766         u32 add_len = 0, off = 8;
3767
3768         if (cmd->data_length < 8) {
3769                 pr_err("PRIN SA READ_KEYS SCSI Data Length: %u"
3770                         " too small\n", cmd->data_length);
3771                 return TCM_INVALID_CDB_FIELD;
3772         }
3773
3774         buf = transport_kmap_data_sg(cmd);
3775         if (!buf)
3776                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3777
3778         buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3779         buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3780         buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3781         buf[3] = (dev->t10_pr.pr_generation & 0xff);
3782
3783         spin_lock(&dev->t10_pr.registration_lock);
3784         list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
3785                         pr_reg_list) {
3786                 /*
3787                  * Check for overflow of 8byte PRI READ_KEYS payload and
3788                  * next reservation key list descriptor.
3789                  */
3790                 if ((add_len + 8) > (cmd->data_length - 8))
3791                         break;
3792
3793                 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
3794                 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
3795                 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
3796                 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
3797                 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
3798                 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
3799                 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
3800                 buf[off++] = (pr_reg->pr_res_key & 0xff);
3801
3802                 add_len += 8;
3803         }
3804         spin_unlock(&dev->t10_pr.registration_lock);
3805
3806         buf[4] = ((add_len >> 24) & 0xff);
3807         buf[5] = ((add_len >> 16) & 0xff);
3808         buf[6] = ((add_len >> 8) & 0xff);
3809         buf[7] = (add_len & 0xff);
3810
3811         transport_kunmap_data_sg(cmd);
3812
3813         return 0;
3814 }
3815
3816 /*
3817  * PERSISTENT_RESERVE_IN Service Action READ_RESERVATION
3818  *
3819  * See spc4r17 section 5.7.6.3 and section 6.13.3.2 Table 161 and 162
3820  */
3821 static sense_reason_t
3822 core_scsi3_pri_read_reservation(struct se_cmd *cmd)
3823 {
3824         struct se_device *dev = cmd->se_dev;
3825         struct t10_pr_registration *pr_reg;
3826         unsigned char *buf;
3827         u64 pr_res_key;
3828         u32 add_len = 16; /* Hardcoded to 16 when a reservation is held. */
3829
3830         if (cmd->data_length < 8) {
3831                 pr_err("PRIN SA READ_RESERVATIONS SCSI Data Length: %u"
3832                         " too small\n", cmd->data_length);
3833                 return TCM_INVALID_CDB_FIELD;
3834         }
3835
3836         buf = transport_kmap_data_sg(cmd);
3837         if (!buf)
3838                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3839
3840         buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3841         buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3842         buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3843         buf[3] = (dev->t10_pr.pr_generation & 0xff);
3844
3845         spin_lock(&dev->dev_reservation_lock);
3846         pr_reg = dev->dev_pr_res_holder;
3847         if (pr_reg) {
3848                 /*
3849                  * Set the hardcoded Additional Length
3850                  */
3851                 buf[4] = ((add_len >> 24) & 0xff);
3852                 buf[5] = ((add_len >> 16) & 0xff);
3853                 buf[6] = ((add_len >> 8) & 0xff);
3854                 buf[7] = (add_len & 0xff);
3855
3856                 if (cmd->data_length < 22)
3857                         goto err;
3858
3859                 /*
3860                  * Set the Reservation key.
3861                  *
3862                  * From spc4r17, section 5.7.10:
3863                  * A persistent reservation holder has its reservation key
3864                  * returned in the parameter data from a PERSISTENT
3865                  * RESERVE IN command with READ RESERVATION service action as
3866                  * follows:
3867                  * a) For a persistent reservation of the type Write Exclusive
3868                  *    - All Registrants or Exclusive Access  All Regitrants,
3869                  *      the reservation key shall be set to zero; or
3870                  * b) For all other persistent reservation types, the
3871                  *    reservation key shall be set to the registered
3872                  *    reservation key for the I_T nexus that holds the
3873                  *    persistent reservation.
3874                  */
3875                 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3876                     (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
3877                         pr_res_key = 0;
3878                 else
3879                         pr_res_key = pr_reg->pr_res_key;
3880
3881                 buf[8] = ((pr_res_key >> 56) & 0xff);
3882                 buf[9] = ((pr_res_key >> 48) & 0xff);
3883                 buf[10] = ((pr_res_key >> 40) & 0xff);
3884                 buf[11] = ((pr_res_key >> 32) & 0xff);
3885                 buf[12] = ((pr_res_key >> 24) & 0xff);
3886                 buf[13] = ((pr_res_key >> 16) & 0xff);
3887                 buf[14] = ((pr_res_key >> 8) & 0xff);
3888                 buf[15] = (pr_res_key & 0xff);
3889                 /*
3890                  * Set the SCOPE and TYPE
3891                  */
3892                 buf[21] = (pr_reg->pr_res_scope & 0xf0) |
3893                           (pr_reg->pr_res_type & 0x0f);
3894         }
3895
3896 err:
3897         spin_unlock(&dev->dev_reservation_lock);
3898         transport_kunmap_data_sg(cmd);
3899
3900         return 0;
3901 }
3902
3903 /*
3904  * PERSISTENT_RESERVE_IN Service Action REPORT_CAPABILITIES
3905  *
3906  * See spc4r17 section 6.13.4 Table 165
3907  */
3908 static sense_reason_t
3909 core_scsi3_pri_report_capabilities(struct se_cmd *cmd)
3910 {
3911         struct se_device *dev = cmd->se_dev;
3912         struct t10_reservation *pr_tmpl = &dev->t10_pr;
3913         unsigned char *buf;
3914         u16 add_len = 8; /* Hardcoded to 8. */
3915
3916         if (cmd->data_length < 6) {
3917                 pr_err("PRIN SA REPORT_CAPABILITIES SCSI Data Length:"
3918                         " %u too small\n", cmd->data_length);
3919                 return TCM_INVALID_CDB_FIELD;
3920         }
3921
3922         buf = transport_kmap_data_sg(cmd);
3923         if (!buf)
3924                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3925
3926         buf[0] = ((add_len << 8) & 0xff);
3927         buf[1] = (add_len & 0xff);
3928         buf[2] |= 0x10; /* CRH: Compatible Reservation Hanlding bit. */
3929         buf[2] |= 0x08; /* SIP_C: Specify Initiator Ports Capable bit */
3930         buf[2] |= 0x04; /* ATP_C: All Target Ports Capable bit */
3931         buf[2] |= 0x01; /* PTPL_C: Persistence across Target Power Loss bit */
3932         /*
3933          * We are filling in the PERSISTENT RESERVATION TYPE MASK below, so
3934          * set the TMV: Task Mask Valid bit.
3935          */
3936         buf[3] |= 0x80;
3937         /*
3938          * Change ALLOW COMMANDs to 0x20 or 0x40 later from Table 166
3939          */
3940         buf[3] |= 0x10; /* ALLOW COMMANDs field 001b */
3941         /*
3942          * PTPL_A: Persistence across Target Power Loss Active bit
3943          */
3944         if (pr_tmpl->pr_aptpl_active)
3945                 buf[3] |= 0x01;
3946         /*
3947          * Setup the PERSISTENT RESERVATION TYPE MASK from Table 167
3948          */
3949         buf[4] |= 0x80; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3950         buf[4] |= 0x40; /* PR_TYPE_EXCLUSIVE_ACCESS_REGONLY */
3951         buf[4] |= 0x20; /* PR_TYPE_WRITE_EXCLUSIVE_REGONLY */
3952         buf[4] |= 0x08; /* PR_TYPE_EXCLUSIVE_ACCESS */
3953         buf[4] |= 0x02; /* PR_TYPE_WRITE_EXCLUSIVE */
3954         buf[5] |= 0x01; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3955
3956         transport_kunmap_data_sg(cmd);
3957
3958         return 0;
3959 }
3960
3961 /*
3962  * PERSISTENT_RESERVE_IN Service Action READ_FULL_STATUS
3963  *
3964  * See spc4r17 section 6.13.5 Table 168 and 169
3965  */
3966 static sense_reason_t
3967 core_scsi3_pri_read_full_status(struct se_cmd *cmd)
3968 {
3969         struct se_device *dev = cmd->se_dev;
3970         struct se_node_acl *se_nacl;
3971         struct se_portal_group *se_tpg;
3972         struct t10_pr_registration *pr_reg, *pr_reg_tmp;
3973         struct t10_reservation *pr_tmpl = &dev->t10_pr;
3974         unsigned char *buf;
3975         u32 add_desc_len = 0, add_len = 0, desc_len, exp_desc_len;
3976         u32 off = 8; /* off into first Full Status descriptor */
3977         int format_code = 0;
3978
3979         if (cmd->data_length < 8) {
3980                 pr_err("PRIN SA READ_FULL_STATUS SCSI Data Length: %u"
3981                         " too small\n", cmd->data_length);
3982                 return TCM_INVALID_CDB_FIELD;
3983         }
3984
3985         buf = transport_kmap_data_sg(cmd);
3986         if (!buf)
3987                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3988
3989         buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3990         buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3991         buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3992         buf[3] = (dev->t10_pr.pr_generation & 0xff);
3993
3994         spin_lock(&pr_tmpl->registration_lock);
3995         list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3996                         &pr_tmpl->registration_list, pr_reg_list) {
3997
3998                 se_nacl = pr_reg->pr_reg_nacl;
3999                 se_tpg = pr_reg->pr_reg_nacl->se_tpg;
4000                 add_desc_len = 0;
4001
4002                 atomic_inc(&pr_reg->pr_res_holders);
4003                 smp_mb__after_atomic_inc();
4004                 spin_unlock(&pr_tmpl->registration_lock);
4005                 /*
4006                  * Determine expected length of $FABRIC_MOD specific
4007                  * TransportID full status descriptor..
4008                  */
4009                 exp_desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id_len(
4010                                 se_tpg, se_nacl, pr_reg, &format_code);
4011
4012                 if ((exp_desc_len + add_len) > cmd->data_length) {
4013                         pr_warn("SPC-3 PRIN READ_FULL_STATUS ran"
4014                                 " out of buffer: %d\n", cmd->data_length);
4015                         spin_lock(&pr_tmpl->registration_lock);
4016                         atomic_dec(&pr_reg->pr_res_holders);
4017                         smp_mb__after_atomic_dec();
4018                         break;
4019                 }
4020                 /*
4021                  * Set RESERVATION KEY
4022                  */
4023                 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
4024                 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
4025                 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
4026                 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
4027                 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
4028                 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
4029                 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
4030                 buf[off++] = (pr_reg->pr_res_key & 0xff);
4031                 off += 4; /* Skip Over Reserved area */
4032
4033                 /*
4034                  * Set ALL_TG_PT bit if PROUT SA REGISTER had this set.
4035                  */
4036                 if (pr_reg->pr_reg_all_tg_pt)
4037                         buf[off] = 0x02;
4038                 /*
4039                  * The struct se_lun pointer will be present for the
4040                  * reservation holder for PR_HOLDER bit.
4041                  *
4042                  * Also, if this registration is the reservation
4043                  * holder, fill in SCOPE and TYPE in the next byte.
4044                  */
4045                 if (pr_reg->pr_res_holder) {
4046                         buf[off++] |= 0x01;
4047                         buf[off++] = (pr_reg->pr_res_scope & 0xf0) |
4048                                      (pr_reg->pr_res_type & 0x0f);
4049                 } else
4050                         off += 2;
4051
4052                 off += 4; /* Skip over reserved area */
4053                 /*
4054                  * From spc4r17 6.3.15:
4055                  *
4056                  * If the ALL_TG_PT bit set to zero, the RELATIVE TARGET PORT
4057                  * IDENTIFIER field contains the relative port identifier (see
4058                  * 3.1.120) of the target port that is part of the I_T nexus
4059                  * described by this full status descriptor. If the ALL_TG_PT
4060                  * bit is set to one, the contents of the RELATIVE TARGET PORT
4061                  * IDENTIFIER field are not defined by this standard.
4062                  */
4063                 if (!pr_reg->pr_reg_all_tg_pt) {
4064                         struct se_port *port = pr_reg->pr_reg_tg_pt_lun->lun_sep;
4065
4066                         buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
4067                         buf[off++] = (port->sep_rtpi & 0xff);
4068                 } else
4069                         off += 2; /* Skip over RELATIVE TARGET PORT IDENTIFIER */
4070
4071                 /*
4072                  * Now, have the $FABRIC_MOD fill in the protocol identifier
4073                  */
4074                 desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id(se_tpg,
4075                                 se_nacl, pr_reg, &format_code, &buf[off+4]);
4076
4077                 spin_lock(&pr_tmpl->registration_lock);
4078                 atomic_dec(&pr_reg->pr_res_holders);
4079                 smp_mb__after_atomic_dec();
4080                 /*
4081                  * Set the ADDITIONAL DESCRIPTOR LENGTH
4082                  */
4083                 buf[off++] = ((desc_len >> 24) & 0xff);
4084                 buf[off++] = ((desc_len >> 16) & 0xff);
4085                 buf[off++] = ((desc_len >> 8) & 0xff);
4086                 buf[off++] = (desc_len & 0xff);
4087                 /*
4088                  * Size of full desctipor header minus TransportID
4089                  * containing $FABRIC_MOD specific) initiator device/port
4090                  * WWN information.
4091                  *
4092                  *  See spc4r17 Section 6.13.5 Table 169
4093                  */
4094                 add_desc_len = (24 + desc_len);
4095
4096                 off += desc_len;
4097                 add_len += add_desc_len;
4098         }
4099         spin_unlock(&pr_tmpl->registration_lock);
4100         /*
4101          * Set ADDITIONAL_LENGTH
4102          */
4103         buf[4] = ((add_len >> 24) & 0xff);
4104         buf[5] = ((add_len >> 16) & 0xff);
4105         buf[6] = ((add_len >> 8) & 0xff);
4106         buf[7] = (add_len & 0xff);
4107
4108         transport_kunmap_data_sg(cmd);
4109
4110         return 0;
4111 }
4112
4113 sense_reason_t
4114 target_scsi3_emulate_pr_in(struct se_cmd *cmd)
4115 {
4116         sense_reason_t ret;
4117
4118         /*
4119          * Following spc2r20 5.5.1 Reservations overview:
4120          *
4121          * If a logical unit has been reserved by any RESERVE command and is
4122          * still reserved by any initiator, all PERSISTENT RESERVE IN and all
4123          * PERSISTENT RESERVE OUT commands shall conflict regardless of
4124          * initiator or service action and shall terminate with a RESERVATION
4125          * CONFLICT status.
4126          */
4127         if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
4128                 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
4129                         " SPC-2 reservation is held, returning"
4130                         " RESERVATION_CONFLICT\n");
4131                 return TCM_RESERVATION_CONFLICT;
4132         }
4133
4134         switch (cmd->t_task_cdb[1] & 0x1f) {
4135         case PRI_READ_KEYS:
4136                 ret = core_scsi3_pri_read_keys(cmd);
4137                 break;
4138         case PRI_READ_RESERVATION:
4139                 ret = core_scsi3_pri_read_reservation(cmd);
4140                 break;
4141         case PRI_REPORT_CAPABILITIES:
4142                 ret = core_scsi3_pri_report_capabilities(cmd);
4143                 break;
4144         case PRI_READ_FULL_STATUS:
4145                 ret = core_scsi3_pri_read_full_status(cmd);
4146                 break;
4147         default:
4148                 pr_err("Unknown PERSISTENT_RESERVE_IN service"
4149                         " action: 0x%02x\n", cmd->t_task_cdb[1] & 0x1f);
4150                 return TCM_INVALID_CDB_FIELD;
4151         }
4152
4153         if (!ret)
4154                 target_complete_cmd(cmd, GOOD);
4155         return ret;
4156 }
4157
4158 sense_reason_t
4159 target_check_reservation(struct se_cmd *cmd)
4160 {
4161         struct se_device *dev = cmd->se_dev;
4162         sense_reason_t ret;
4163
4164         if (!cmd->se_sess)
4165                 return 0;
4166         if (dev->se_hba->hba_flags & HBA_FLAGS_INTERNAL_USE)
4167                 return 0;
4168         if (dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV)
4169                 return 0;
4170
4171         spin_lock(&dev->dev_reservation_lock);
4172         if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
4173                 ret = target_scsi2_reservation_check(cmd);
4174         else
4175                 ret = target_scsi3_pr_reservation_check(cmd);
4176         spin_unlock(&dev->dev_reservation_lock);
4177
4178         return ret;
4179 }