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