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         const struct target_core_fabric_ops *tmp_tf_ops;
1449         unsigned char *buf;
1450         unsigned char *ptr, *i_str = NULL, proto_ident, tmp_proto_ident;
1451         char *iport_ptr = NULL, i_buf[PR_REG_ISID_ID_LEN];
1452         sense_reason_t ret;
1453         u32 tpdl, tid_len = 0;
1454         int dest_local_nexus;
1455         u32 dest_rtpi = 0;
1456
1457         local_se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
1458         /*
1459          * Allocate a struct pr_transport_id_holder and setup the
1460          * local_node_acl and local_se_deve pointers and add to
1461          * struct list_head tid_dest_list for add registration
1462          * processing in the loop of tid_dest_list below.
1463          */
1464         tidh_new = kzalloc(sizeof(struct pr_transport_id_holder), GFP_KERNEL);
1465         if (!tidh_new) {
1466                 pr_err("Unable to allocate tidh_new\n");
1467                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1468         }
1469         INIT_LIST_HEAD(&tidh_new->dest_list);
1470         tidh_new->dest_tpg = tpg;
1471         tidh_new->dest_node_acl = se_sess->se_node_acl;
1472         tidh_new->dest_se_deve = local_se_deve;
1473
1474         local_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1475                                 se_sess->se_node_acl, local_se_deve, l_isid,
1476                                 sa_res_key, all_tg_pt, aptpl);
1477         if (!local_pr_reg) {
1478                 kfree(tidh_new);
1479                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1480         }
1481         tidh_new->dest_pr_reg = local_pr_reg;
1482         /*
1483          * The local I_T nexus does not hold any configfs dependances,
1484          * so we set tid_h->dest_local_nexus=1 to prevent the
1485          * configfs_undepend_item() calls in the tid_dest_list loops below.
1486          */
1487         tidh_new->dest_local_nexus = 1;
1488         list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1489
1490         if (cmd->data_length < 28) {
1491                 pr_warn("SPC-PR: Received PR OUT parameter list"
1492                         " length too small: %u\n", cmd->data_length);
1493                 ret = TCM_INVALID_PARAMETER_LIST;
1494                 goto out;
1495         }
1496
1497         buf = transport_kmap_data_sg(cmd);
1498         if (!buf) {
1499                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1500                 goto out;
1501         }
1502
1503         /*
1504          * For a PERSISTENT RESERVE OUT specify initiator ports payload,
1505          * first extract TransportID Parameter Data Length, and make sure
1506          * the value matches up to the SCSI expected data transfer length.
1507          */
1508         tpdl = (buf[24] & 0xff) << 24;
1509         tpdl |= (buf[25] & 0xff) << 16;
1510         tpdl |= (buf[26] & 0xff) << 8;
1511         tpdl |= buf[27] & 0xff;
1512
1513         if ((tpdl + 28) != cmd->data_length) {
1514                 pr_err("SPC-3 PR: Illegal tpdl: %u + 28 byte header"
1515                         " does not equal CDB data_length: %u\n", tpdl,
1516                         cmd->data_length);
1517                 ret = TCM_INVALID_PARAMETER_LIST;
1518                 goto out_unmap;
1519         }
1520         /*
1521          * Start processing the received transport IDs using the
1522          * receiving I_T Nexus portal's fabric dependent methods to
1523          * obtain the SCSI Initiator Port/Device Identifiers.
1524          */
1525         ptr = &buf[28];
1526
1527         while (tpdl > 0) {
1528                 proto_ident = (ptr[0] & 0x0f);
1529                 dest_tpg = NULL;
1530
1531                 spin_lock(&dev->se_port_lock);
1532                 list_for_each_entry(tmp_port, &dev->dev_sep_list, sep_list) {
1533                         tmp_tpg = tmp_port->sep_tpg;
1534                         if (!tmp_tpg)
1535                                 continue;
1536                         tmp_tf_ops = tmp_tpg->se_tpg_tfo;
1537                         if (!tmp_tf_ops)
1538                                 continue;
1539                         if (!tmp_tf_ops->get_fabric_proto_ident ||
1540                             !tmp_tf_ops->tpg_parse_pr_out_transport_id)
1541                                 continue;
1542                         /*
1543                          * Look for the matching proto_ident provided by
1544                          * the received TransportID
1545                          */
1546                         tmp_proto_ident = tmp_tf_ops->get_fabric_proto_ident(tmp_tpg);
1547                         if (tmp_proto_ident != proto_ident)
1548                                 continue;
1549                         dest_rtpi = tmp_port->sep_rtpi;
1550
1551                         i_str = tmp_tf_ops->tpg_parse_pr_out_transport_id(
1552                                         tmp_tpg, (const char *)ptr, &tid_len,
1553                                         &iport_ptr);
1554                         if (!i_str)
1555                                 continue;
1556
1557                         atomic_inc_mb(&tmp_tpg->tpg_pr_ref_count);
1558                         spin_unlock(&dev->se_port_lock);
1559
1560                         if (core_scsi3_tpg_depend_item(tmp_tpg)) {
1561                                 pr_err(" core_scsi3_tpg_depend_item()"
1562                                         " for tmp_tpg\n");
1563                                 atomic_dec_mb(&tmp_tpg->tpg_pr_ref_count);
1564                                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1565                                 goto out_unmap;
1566                         }
1567                         /*
1568                          * Locate the destination initiator ACL to be registered
1569                          * from the decoded fabric module specific TransportID
1570                          * at *i_str.
1571                          */
1572                         spin_lock_irq(&tmp_tpg->acl_node_lock);
1573                         dest_node_acl = __core_tpg_get_initiator_node_acl(
1574                                                 tmp_tpg, i_str);
1575                         if (dest_node_acl)
1576                                 atomic_inc_mb(&dest_node_acl->acl_pr_ref_count);
1577                         spin_unlock_irq(&tmp_tpg->acl_node_lock);
1578
1579                         if (!dest_node_acl) {
1580                                 core_scsi3_tpg_undepend_item(tmp_tpg);
1581                                 spin_lock(&dev->se_port_lock);
1582                                 continue;
1583                         }
1584
1585                         if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
1586                                 pr_err("configfs_depend_item() failed"
1587                                         " for dest_node_acl->acl_group\n");
1588                                 atomic_dec_mb(&dest_node_acl->acl_pr_ref_count);
1589                                 core_scsi3_tpg_undepend_item(tmp_tpg);
1590                                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1591                                 goto out_unmap;
1592                         }
1593
1594                         dest_tpg = tmp_tpg;
1595                         pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node:"
1596                                 " %s Port RTPI: %hu\n",
1597                                 dest_tpg->se_tpg_tfo->get_fabric_name(),
1598                                 dest_node_acl->initiatorname, dest_rtpi);
1599
1600                         spin_lock(&dev->se_port_lock);
1601                         break;
1602                 }
1603                 spin_unlock(&dev->se_port_lock);
1604
1605                 if (!dest_tpg) {
1606                         pr_err("SPC-3 PR SPEC_I_PT: Unable to locate"
1607                                         " dest_tpg\n");
1608                         ret = TCM_INVALID_PARAMETER_LIST;
1609                         goto out_unmap;
1610                 }
1611
1612                 pr_debug("SPC-3 PR SPEC_I_PT: Got %s data_length: %u tpdl: %u"
1613                         " tid_len: %d for %s + %s\n",
1614                         dest_tpg->se_tpg_tfo->get_fabric_name(), cmd->data_length,
1615                         tpdl, tid_len, i_str, iport_ptr);
1616
1617                 if (tid_len > tpdl) {
1618                         pr_err("SPC-3 PR SPEC_I_PT: Illegal tid_len:"
1619                                 " %u for Transport ID: %s\n", tid_len, ptr);
1620                         core_scsi3_nodeacl_undepend_item(dest_node_acl);
1621                         core_scsi3_tpg_undepend_item(dest_tpg);
1622                         ret = TCM_INVALID_PARAMETER_LIST;
1623                         goto out_unmap;
1624                 }
1625                 /*
1626                  * Locate the desintation struct se_dev_entry pointer for matching
1627                  * RELATIVE TARGET PORT IDENTIFIER on the receiving I_T Nexus
1628                  * Target Port.
1629                  */
1630                 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl,
1631                                         dest_rtpi);
1632                 if (!dest_se_deve) {
1633                         pr_err("Unable to locate %s dest_se_deve"
1634                                 " from destination RTPI: %hu\n",
1635                                 dest_tpg->se_tpg_tfo->get_fabric_name(),
1636                                 dest_rtpi);
1637
1638                         core_scsi3_nodeacl_undepend_item(dest_node_acl);
1639                         core_scsi3_tpg_undepend_item(dest_tpg);
1640                         ret = TCM_INVALID_PARAMETER_LIST;
1641                         goto out_unmap;
1642                 }
1643
1644                 if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
1645                         pr_err("core_scsi3_lunacl_depend_item()"
1646                                         " failed\n");
1647                         atomic_dec_mb(&dest_se_deve->pr_ref_count);
1648                         core_scsi3_nodeacl_undepend_item(dest_node_acl);
1649                         core_scsi3_tpg_undepend_item(dest_tpg);
1650                         ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1651                         goto out_unmap;
1652                 }
1653
1654                 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node: %s"
1655                         " dest_se_deve mapped_lun: %u\n",
1656                         dest_tpg->se_tpg_tfo->get_fabric_name(),
1657                         dest_node_acl->initiatorname, dest_se_deve->mapped_lun);
1658
1659                 /*
1660                  * Skip any TransportIDs that already have a registration for
1661                  * this target port.
1662                  */
1663                 pr_reg_e = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
1664                                         iport_ptr);
1665                 if (pr_reg_e) {
1666                         core_scsi3_put_pr_reg(pr_reg_e);
1667                         core_scsi3_lunacl_undepend_item(dest_se_deve);
1668                         core_scsi3_nodeacl_undepend_item(dest_node_acl);
1669                         core_scsi3_tpg_undepend_item(dest_tpg);
1670                         ptr += tid_len;
1671                         tpdl -= tid_len;
1672                         tid_len = 0;
1673                         continue;
1674                 }
1675                 /*
1676                  * Allocate a struct pr_transport_id_holder and setup
1677                  * the dest_node_acl and dest_se_deve pointers for the
1678                  * loop below.
1679                  */
1680                 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder),
1681                                 GFP_KERNEL);
1682                 if (!tidh_new) {
1683                         pr_err("Unable to allocate tidh_new\n");
1684                         core_scsi3_lunacl_undepend_item(dest_se_deve);
1685                         core_scsi3_nodeacl_undepend_item(dest_node_acl);
1686                         core_scsi3_tpg_undepend_item(dest_tpg);
1687                         ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1688                         goto out_unmap;
1689                 }
1690                 INIT_LIST_HEAD(&tidh_new->dest_list);
1691                 tidh_new->dest_tpg = dest_tpg;
1692                 tidh_new->dest_node_acl = dest_node_acl;
1693                 tidh_new->dest_se_deve = dest_se_deve;
1694
1695                 /*
1696                  * Allocate, but do NOT add the registration for the
1697                  * TransportID referenced SCSI Initiator port.  This
1698                  * done because of the following from spc4r17 in section
1699                  * 6.14.3 wrt SPEC_I_PT:
1700                  *
1701                  * "If a registration fails for any initiator port (e.g., if th
1702                  * logical unit does not have enough resources available to
1703                  * hold the registration information), no registrations shall be
1704                  * made, and the command shall be terminated with
1705                  * CHECK CONDITION status."
1706                  *
1707                  * That means we call __core_scsi3_alloc_registration() here,
1708                  * and then call __core_scsi3_add_registration() in the
1709                  * 2nd loop which will never fail.
1710                  */
1711                 dest_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1712                                 dest_node_acl, dest_se_deve, iport_ptr,
1713                                 sa_res_key, all_tg_pt, aptpl);
1714                 if (!dest_pr_reg) {
1715                         core_scsi3_lunacl_undepend_item(dest_se_deve);
1716                         core_scsi3_nodeacl_undepend_item(dest_node_acl);
1717                         core_scsi3_tpg_undepend_item(dest_tpg);
1718                         kfree(tidh_new);
1719                         ret = TCM_INVALID_PARAMETER_LIST;
1720                         goto out_unmap;
1721                 }
1722                 tidh_new->dest_pr_reg = dest_pr_reg;
1723                 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1724
1725                 ptr += tid_len;
1726                 tpdl -= tid_len;
1727                 tid_len = 0;
1728
1729         }
1730
1731         transport_kunmap_data_sg(cmd);
1732
1733         /*
1734          * Go ahead and create a registrations from tid_dest_list for the
1735          * SPEC_I_PT provided TransportID for the *tidh referenced dest_node_acl
1736          * and dest_se_deve.
1737          *
1738          * The SA Reservation Key from the PROUT is set for the
1739          * registration, and ALL_TG_PT is also passed.  ALL_TG_PT=1
1740          * means that the TransportID Initiator port will be
1741          * registered on all of the target ports in the SCSI target device
1742          * ALL_TG_PT=0 means the registration will only be for the
1743          * SCSI target port the PROUT REGISTER with SPEC_I_PT=1
1744          * was received.
1745          */
1746         list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1747                 dest_tpg = tidh->dest_tpg;
1748                 dest_node_acl = tidh->dest_node_acl;
1749                 dest_se_deve = tidh->dest_se_deve;
1750                 dest_pr_reg = tidh->dest_pr_reg;
1751                 dest_local_nexus = tidh->dest_local_nexus;
1752
1753                 list_del(&tidh->dest_list);
1754                 kfree(tidh);
1755
1756                 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1757                 core_pr_dump_initiator_port(dest_pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1758
1759                 __core_scsi3_add_registration(cmd->se_dev, dest_node_acl,
1760                                         dest_pr_reg, 0, 0);
1761
1762                 pr_debug("SPC-3 PR [%s] SPEC_I_PT: Successfully"
1763                         " registered Transport ID for Node: %s%s Mapped LUN:"
1764                         " %u\n", dest_tpg->se_tpg_tfo->get_fabric_name(),
1765                         dest_node_acl->initiatorname, i_buf, dest_se_deve->mapped_lun);
1766
1767                 if (dest_local_nexus)
1768                         continue;
1769
1770                 core_scsi3_lunacl_undepend_item(dest_se_deve);
1771                 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1772                 core_scsi3_tpg_undepend_item(dest_tpg);
1773         }
1774
1775         return 0;
1776 out_unmap:
1777         transport_kunmap_data_sg(cmd);
1778 out:
1779         /*
1780          * For the failure case, release everything from tid_dest_list
1781          * including *dest_pr_reg and the configfs dependances..
1782          */
1783         list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1784                 dest_tpg = tidh->dest_tpg;
1785                 dest_node_acl = tidh->dest_node_acl;
1786                 dest_se_deve = tidh->dest_se_deve;
1787                 dest_pr_reg = tidh->dest_pr_reg;
1788                 dest_local_nexus = tidh->dest_local_nexus;
1789
1790                 list_del(&tidh->dest_list);
1791                 kfree(tidh);
1792                 /*
1793                  * Release any extra ALL_TG_PT=1 registrations for
1794                  * the SPEC_I_PT=1 case.
1795                  */
1796                 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1797                                 &dest_pr_reg->pr_reg_atp_list,
1798                                 pr_reg_atp_mem_list) {
1799                         list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1800                         core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1801                         kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
1802                 }
1803
1804                 kmem_cache_free(t10_pr_reg_cache, dest_pr_reg);
1805
1806                 if (dest_local_nexus)
1807                         continue;
1808
1809                 core_scsi3_lunacl_undepend_item(dest_se_deve);
1810                 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1811                 core_scsi3_tpg_undepend_item(dest_tpg);
1812         }
1813         return ret;
1814 }
1815
1816 static int core_scsi3_update_aptpl_buf(
1817         struct se_device *dev,
1818         unsigned char *buf,
1819         u32 pr_aptpl_buf_len)
1820 {
1821         struct se_lun *lun;
1822         struct se_portal_group *tpg;
1823         struct t10_pr_registration *pr_reg;
1824         unsigned char tmp[512], isid_buf[32];
1825         ssize_t len = 0;
1826         int reg_count = 0;
1827         int ret = 0;
1828
1829         spin_lock(&dev->dev_reservation_lock);
1830         spin_lock(&dev->t10_pr.registration_lock);
1831         /*
1832          * Walk the registration list..
1833          */
1834         list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
1835                         pr_reg_list) {
1836
1837                 tmp[0] = '\0';
1838                 isid_buf[0] = '\0';
1839                 tpg = pr_reg->pr_reg_nacl->se_tpg;
1840                 lun = pr_reg->pr_reg_tg_pt_lun;
1841                 /*
1842                  * Write out any ISID value to APTPL metadata that was included
1843                  * in the original registration.
1844                  */
1845                 if (pr_reg->isid_present_at_reg)
1846                         snprintf(isid_buf, 32, "initiator_sid=%s\n",
1847                                         pr_reg->pr_reg_isid);
1848                 /*
1849                  * Include special metadata if the pr_reg matches the
1850                  * reservation holder.
1851                  */
1852                 if (dev->dev_pr_res_holder == pr_reg) {
1853                         snprintf(tmp, 512, "PR_REG_START: %d"
1854                                 "\ninitiator_fabric=%s\n"
1855                                 "initiator_node=%s\n%s"
1856                                 "sa_res_key=%llu\n"
1857                                 "res_holder=1\nres_type=%02x\n"
1858                                 "res_scope=%02x\nres_all_tg_pt=%d\n"
1859                                 "mapped_lun=%u\n", reg_count,
1860                                 tpg->se_tpg_tfo->get_fabric_name(),
1861                                 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1862                                 pr_reg->pr_res_key, pr_reg->pr_res_type,
1863                                 pr_reg->pr_res_scope, pr_reg->pr_reg_all_tg_pt,
1864                                 pr_reg->pr_res_mapped_lun);
1865                 } else {
1866                         snprintf(tmp, 512, "PR_REG_START: %d\n"
1867                                 "initiator_fabric=%s\ninitiator_node=%s\n%s"
1868                                 "sa_res_key=%llu\nres_holder=0\n"
1869                                 "res_all_tg_pt=%d\nmapped_lun=%u\n",
1870                                 reg_count, tpg->se_tpg_tfo->get_fabric_name(),
1871                                 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1872                                 pr_reg->pr_res_key, pr_reg->pr_reg_all_tg_pt,
1873                                 pr_reg->pr_res_mapped_lun);
1874                 }
1875
1876                 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1877                         pr_err("Unable to update renaming APTPL metadata,"
1878                                " reallocating larger buffer\n");
1879                         ret = -EMSGSIZE;
1880                         goto out;
1881                 }
1882                 len += sprintf(buf+len, "%s", tmp);
1883
1884                 /*
1885                  * Include information about the associated SCSI target port.
1886                  */
1887                 snprintf(tmp, 512, "target_fabric=%s\ntarget_node=%s\n"
1888                         "tpgt=%hu\nport_rtpi=%hu\ntarget_lun=%u\nPR_REG_END:"
1889                         " %d\n", tpg->se_tpg_tfo->get_fabric_name(),
1890                         tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1891                         tpg->se_tpg_tfo->tpg_get_tag(tpg),
1892                         lun->lun_sep->sep_rtpi, lun->unpacked_lun, reg_count);
1893
1894                 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1895                         pr_err("Unable to update renaming APTPL metadata,"
1896                                " reallocating larger buffer\n");
1897                         ret = -EMSGSIZE;
1898                         goto out;
1899                 }
1900                 len += sprintf(buf+len, "%s", tmp);
1901                 reg_count++;
1902         }
1903
1904         if (!reg_count)
1905                 len += sprintf(buf+len, "No Registrations or Reservations");
1906
1907 out:
1908         spin_unlock(&dev->t10_pr.registration_lock);
1909         spin_unlock(&dev->dev_reservation_lock);
1910
1911         return ret;
1912 }
1913
1914 static int __core_scsi3_write_aptpl_to_file(
1915         struct se_device *dev,
1916         unsigned char *buf)
1917 {
1918         struct t10_wwn *wwn = &dev->t10_wwn;
1919         struct file *file;
1920         int flags = O_RDWR | O_CREAT | O_TRUNC;
1921         char path[512];
1922         u32 pr_aptpl_buf_len;
1923         int ret;
1924
1925         memset(path, 0, 512);
1926
1927         if (strlen(&wwn->unit_serial[0]) >= 512) {
1928                 pr_err("WWN value for struct se_device does not fit"
1929                         " into path buffer\n");
1930                 return -EMSGSIZE;
1931         }
1932
1933         snprintf(path, 512, "/var/target/pr/aptpl_%s", &wwn->unit_serial[0]);
1934         file = filp_open(path, flags, 0600);
1935         if (IS_ERR(file)) {
1936                 pr_err("filp_open(%s) for APTPL metadata"
1937                         " failed\n", path);
1938                 return PTR_ERR(file);
1939         }
1940
1941         pr_aptpl_buf_len = (strlen(buf) + 1); /* Add extra for NULL */
1942
1943         ret = kernel_write(file, buf, pr_aptpl_buf_len, 0);
1944
1945         if (ret < 0)
1946                 pr_debug("Error writing APTPL metadata file: %s\n", path);
1947         fput(file);
1948
1949         return (ret < 0) ? -EIO : 0;
1950 }
1951
1952 /*
1953  * Clear the APTPL metadata if APTPL has been disabled, otherwise
1954  * write out the updated metadata to struct file for this SCSI device.
1955  */
1956 static sense_reason_t core_scsi3_update_and_write_aptpl(struct se_device *dev, bool aptpl)
1957 {
1958         unsigned char *buf;
1959         int rc, len = PR_APTPL_BUF_LEN;
1960
1961         if (!aptpl) {
1962                 char *null_buf = "No Registrations or Reservations\n";
1963
1964                 rc = __core_scsi3_write_aptpl_to_file(dev, null_buf);
1965                 dev->t10_pr.pr_aptpl_active = 0;
1966                 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated\n");
1967
1968                 if (rc)
1969                         return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1970
1971                 return 0;
1972         }
1973 retry:
1974         buf = vzalloc(len);
1975         if (!buf)
1976                 return TCM_OUT_OF_RESOURCES;
1977
1978         rc = core_scsi3_update_aptpl_buf(dev, buf, len);
1979         if (rc < 0) {
1980                 vfree(buf);
1981                 len *= 2;
1982                 goto retry;
1983         }
1984
1985         rc = __core_scsi3_write_aptpl_to_file(dev, buf);
1986         if (rc != 0) {
1987                 pr_err("SPC-3 PR: Could not update APTPL\n");
1988                 vfree(buf);
1989                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1990         }
1991         dev->t10_pr.pr_aptpl_active = 1;
1992         vfree(buf);
1993         pr_debug("SPC-3 PR: Set APTPL Bit Activated\n");
1994         return 0;
1995 }
1996
1997 static sense_reason_t
1998 core_scsi3_emulate_pro_register(struct se_cmd *cmd, u64 res_key, u64 sa_res_key,
1999                 bool aptpl, bool all_tg_pt, bool spec_i_pt, enum register_type register_type)
2000 {
2001         struct se_session *se_sess = cmd->se_sess;
2002         struct se_device *dev = cmd->se_dev;
2003         struct se_dev_entry *se_deve;
2004         struct se_lun *se_lun = cmd->se_lun;
2005         struct se_portal_group *se_tpg;
2006         struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_reg_tmp;
2007         struct t10_reservation *pr_tmpl = &dev->t10_pr;
2008         unsigned char isid_buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
2009         sense_reason_t ret = TCM_NO_SENSE;
2010         int pr_holder = 0, type;
2011
2012         if (!se_sess || !se_lun) {
2013                 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2014                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2015         }
2016         se_tpg = se_sess->se_tpg;
2017         se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
2018
2019         if (se_tpg->se_tpg_tfo->sess_get_initiator_sid) {
2020                 memset(&isid_buf[0], 0, PR_REG_ISID_LEN);
2021                 se_tpg->se_tpg_tfo->sess_get_initiator_sid(se_sess, &isid_buf[0],
2022                                 PR_REG_ISID_LEN);
2023                 isid_ptr = &isid_buf[0];
2024         }
2025         /*
2026          * Follow logic from spc4r17 Section 5.7.7, Register Behaviors Table 47
2027          */
2028         pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2029         if (!pr_reg) {
2030                 if (res_key) {
2031                         pr_warn("SPC-3 PR: Reservation Key non-zero"
2032                                 " for SA REGISTER, returning CONFLICT\n");
2033                         return TCM_RESERVATION_CONFLICT;
2034                 }
2035                 /*
2036                  * Do nothing but return GOOD status.
2037                  */
2038                 if (!sa_res_key)
2039                         return 0;
2040
2041                 if (!spec_i_pt) {
2042                         /*
2043                          * Perform the Service Action REGISTER on the Initiator
2044                          * Port Endpoint that the PRO was received from on the
2045                          * Logical Unit of the SCSI device server.
2046                          */
2047                         if (core_scsi3_alloc_registration(cmd->se_dev,
2048                                         se_sess->se_node_acl, se_deve, isid_ptr,
2049                                         sa_res_key, all_tg_pt, aptpl,
2050                                         register_type, 0)) {
2051                                 pr_err("Unable to allocate"
2052                                         " struct t10_pr_registration\n");
2053                                 return TCM_INVALID_PARAMETER_LIST;
2054                         }
2055                 } else {
2056                         /*
2057                          * Register both the Initiator port that received
2058                          * PROUT SA REGISTER + SPEC_I_PT=1 and extract SCSI
2059                          * TransportID from Parameter list and loop through
2060                          * fabric dependent parameter list while calling
2061                          * logic from of core_scsi3_alloc_registration() for
2062                          * each TransportID provided SCSI Initiator Port/Device
2063                          */
2064                         ret = core_scsi3_decode_spec_i_port(cmd, se_tpg,
2065                                         isid_ptr, sa_res_key, all_tg_pt, aptpl);
2066                         if (ret != 0)
2067                                 return ret;
2068                 }
2069
2070                 return core_scsi3_update_and_write_aptpl(dev, aptpl);
2071         }
2072
2073         /* ok, existing registration */
2074
2075         if ((register_type == REGISTER) && (res_key != pr_reg->pr_res_key)) {
2076                 pr_err("SPC-3 PR REGISTER: Received"
2077                        " res_key: 0x%016Lx does not match"
2078                        " existing SA REGISTER res_key:"
2079                        " 0x%016Lx\n", res_key,
2080                        pr_reg->pr_res_key);
2081                 ret = TCM_RESERVATION_CONFLICT;
2082                 goto out;
2083         }
2084
2085         if (spec_i_pt) {
2086                 pr_err("SPC-3 PR REGISTER: SPEC_I_PT"
2087                         " set on a registered nexus\n");
2088                 ret = TCM_INVALID_PARAMETER_LIST;
2089                 goto out;
2090         }
2091
2092         /*
2093          * An existing ALL_TG_PT=1 registration being released
2094          * must also set ALL_TG_PT=1 in the incoming PROUT.
2095          */
2096         if (pr_reg->pr_reg_all_tg_pt && !all_tg_pt) {
2097                 pr_err("SPC-3 PR REGISTER: ALL_TG_PT=1"
2098                         " registration exists, but ALL_TG_PT=1 bit not"
2099                         " present in received PROUT\n");
2100                 ret = TCM_INVALID_CDB_FIELD;
2101                 goto out;
2102         }
2103
2104         /*
2105          * sa_res_key=1 Change Reservation Key for registered I_T Nexus.
2106          */
2107         if (sa_res_key) {
2108                 /*
2109                  * Increment PRgeneration counter for struct se_device"
2110                  * upon a successful REGISTER, see spc4r17 section 6.3.2
2111                  * READ_KEYS service action.
2112                  */
2113                 pr_reg->pr_res_generation = core_scsi3_pr_generation(cmd->se_dev);
2114                 pr_reg->pr_res_key = sa_res_key;
2115                 pr_debug("SPC-3 PR [%s] REGISTER%s: Changed Reservation"
2116                          " Key for %s to: 0x%016Lx PRgeneration:"
2117                          " 0x%08x\n", cmd->se_tfo->get_fabric_name(),
2118                          (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ? "_AND_IGNORE_EXISTING_KEY" : "",
2119                          pr_reg->pr_reg_nacl->initiatorname,
2120                          pr_reg->pr_res_key, pr_reg->pr_res_generation);
2121
2122         } else {
2123                 /*
2124                  * sa_res_key=0 Unregister Reservation Key for registered I_T Nexus.
2125                  */
2126                 type = pr_reg->pr_res_type;
2127                 pr_holder = core_scsi3_check_implicit_release(cmd->se_dev,
2128                                                               pr_reg);
2129                 if (pr_holder < 0) {
2130                         ret = TCM_RESERVATION_CONFLICT;
2131                         goto out;
2132                 }
2133
2134                 spin_lock(&pr_tmpl->registration_lock);
2135                 /*
2136                  * Release all ALL_TG_PT=1 for the matching SCSI Initiator Port
2137                  * and matching pr_res_key.
2138                  */
2139                 if (pr_reg->pr_reg_all_tg_pt) {
2140                         list_for_each_entry_safe(pr_reg_p, pr_reg_tmp,
2141                                         &pr_tmpl->registration_list,
2142                                         pr_reg_list) {
2143
2144                                 if (!pr_reg_p->pr_reg_all_tg_pt)
2145                                         continue;
2146                                 if (pr_reg_p->pr_res_key != res_key)
2147                                         continue;
2148                                 if (pr_reg == pr_reg_p)
2149                                         continue;
2150                                 if (strcmp(pr_reg->pr_reg_nacl->initiatorname,
2151                                            pr_reg_p->pr_reg_nacl->initiatorname))
2152                                         continue;
2153
2154                                 __core_scsi3_free_registration(dev,
2155                                                 pr_reg_p, NULL, 0);
2156                         }
2157                 }
2158
2159                 /*
2160                  * Release the calling I_T Nexus registration now..
2161                  */
2162                 __core_scsi3_free_registration(cmd->se_dev, pr_reg, NULL, 1);
2163                 pr_reg = NULL;
2164
2165                 /*
2166                  * From spc4r17, section 5.7.11.3 Unregistering
2167                  *
2168                  * If the persistent reservation is a registrants only
2169                  * type, the device server shall establish a unit
2170                  * attention condition for the initiator port associated
2171                  * with every registered I_T nexus except for the I_T
2172                  * nexus on which the PERSISTENT RESERVE OUT command was
2173                  * received, with the additional sense code set to
2174                  * RESERVATIONS RELEASED.
2175                  */
2176                 if (pr_holder &&
2177                     (type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY ||
2178                      type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY)) {
2179                         list_for_each_entry(pr_reg_p,
2180                                         &pr_tmpl->registration_list,
2181                                         pr_reg_list) {
2182
2183                                 core_scsi3_ua_allocate(
2184                                         pr_reg_p->pr_reg_nacl,
2185                                         pr_reg_p->pr_res_mapped_lun,
2186                                         0x2A,
2187                                         ASCQ_2AH_RESERVATIONS_RELEASED);
2188                         }
2189                 }
2190
2191                 spin_unlock(&pr_tmpl->registration_lock);
2192         }
2193
2194         ret = core_scsi3_update_and_write_aptpl(dev, aptpl);
2195
2196 out:
2197         if (pr_reg)
2198                 core_scsi3_put_pr_reg(pr_reg);
2199         return ret;
2200 }
2201
2202 unsigned char *core_scsi3_pr_dump_type(int type)
2203 {
2204         switch (type) {
2205         case PR_TYPE_WRITE_EXCLUSIVE:
2206                 return "Write Exclusive Access";
2207         case PR_TYPE_EXCLUSIVE_ACCESS:
2208                 return "Exclusive Access";
2209         case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2210                 return "Write Exclusive Access, Registrants Only";
2211         case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2212                 return "Exclusive Access, Registrants Only";
2213         case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2214                 return "Write Exclusive Access, All Registrants";
2215         case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2216                 return "Exclusive Access, All Registrants";
2217         default:
2218                 break;
2219         }
2220
2221         return "Unknown SPC-3 PR Type";
2222 }
2223
2224 static sense_reason_t
2225 core_scsi3_pro_reserve(struct se_cmd *cmd, int type, int scope, u64 res_key)
2226 {
2227         struct se_device *dev = cmd->se_dev;
2228         struct se_session *se_sess = cmd->se_sess;
2229         struct se_lun *se_lun = cmd->se_lun;
2230         struct t10_pr_registration *pr_reg, *pr_res_holder;
2231         struct t10_reservation *pr_tmpl = &dev->t10_pr;
2232         char i_buf[PR_REG_ISID_ID_LEN];
2233         sense_reason_t ret;
2234
2235         memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2236
2237         if (!se_sess || !se_lun) {
2238                 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2239                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2240         }
2241         /*
2242          * Locate the existing *pr_reg via struct se_node_acl pointers
2243          */
2244         pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2245                                 se_sess);
2246         if (!pr_reg) {
2247                 pr_err("SPC-3 PR: Unable to locate"
2248                         " PR_REGISTERED *pr_reg for RESERVE\n");
2249                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2250         }
2251         /*
2252          * From spc4r17 Section 5.7.9: Reserving:
2253          *
2254          * An application client creates a persistent reservation by issuing
2255          * a PERSISTENT RESERVE OUT command with RESERVE service action through
2256          * a registered I_T nexus with the following parameters:
2257          *    a) RESERVATION KEY set to the value of the reservation key that is
2258          *       registered with the logical unit for the I_T nexus; and
2259          */
2260         if (res_key != pr_reg->pr_res_key) {
2261                 pr_err("SPC-3 PR RESERVE: Received res_key: 0x%016Lx"
2262                         " does not match existing SA REGISTER res_key:"
2263                         " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2264                 ret = TCM_RESERVATION_CONFLICT;
2265                 goto out_put_pr_reg;
2266         }
2267         /*
2268          * From spc4r17 Section 5.7.9: Reserving:
2269          *
2270          * From above:
2271          *  b) TYPE field and SCOPE field set to the persistent reservation
2272          *     being created.
2273          *
2274          * Only one persistent reservation is allowed at a time per logical unit
2275          * and that persistent reservation has a scope of LU_SCOPE.
2276          */
2277         if (scope != PR_SCOPE_LU_SCOPE) {
2278                 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2279                 ret = TCM_INVALID_PARAMETER_LIST;
2280                 goto out_put_pr_reg;
2281         }
2282         /*
2283          * See if we have an existing PR reservation holder pointer at
2284          * struct se_device->dev_pr_res_holder in the form struct t10_pr_registration
2285          * *pr_res_holder.
2286          */
2287         spin_lock(&dev->dev_reservation_lock);
2288         pr_res_holder = dev->dev_pr_res_holder;
2289         if (pr_res_holder) {
2290                 /*
2291                  * From spc4r17 Section 5.7.9: Reserving:
2292                  *
2293                  * If the device server receives a PERSISTENT RESERVE OUT
2294                  * command from an I_T nexus other than a persistent reservation
2295                  * holder (see 5.7.10) that attempts to create a persistent
2296                  * reservation when a persistent reservation already exists for
2297                  * the logical unit, then the command shall be completed with
2298                  * RESERVATION CONFLICT status.
2299                  */
2300                 if (!is_reservation_holder(pr_res_holder, pr_reg)) {
2301                         struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2302                         pr_err("SPC-3 PR: Attempted RESERVE from"
2303                                 " [%s]: %s while reservation already held by"
2304                                 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2305                                 cmd->se_tfo->get_fabric_name(),
2306                                 se_sess->se_node_acl->initiatorname,
2307                                 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2308                                 pr_res_holder->pr_reg_nacl->initiatorname);
2309
2310                         spin_unlock(&dev->dev_reservation_lock);
2311                         ret = TCM_RESERVATION_CONFLICT;
2312                         goto out_put_pr_reg;
2313                 }
2314                 /*
2315                  * From spc4r17 Section 5.7.9: Reserving:
2316                  *
2317                  * If a persistent reservation holder attempts to modify the
2318                  * type or scope of an existing persistent reservation, the
2319                  * command shall be completed with RESERVATION CONFLICT status.
2320                  */
2321                 if ((pr_res_holder->pr_res_type != type) ||
2322                     (pr_res_holder->pr_res_scope != scope)) {
2323                         struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2324                         pr_err("SPC-3 PR: Attempted RESERVE from"
2325                                 " [%s]: %s trying to change TYPE and/or SCOPE,"
2326                                 " while reservation already held by [%s]: %s,"
2327                                 " returning RESERVATION_CONFLICT\n",
2328                                 cmd->se_tfo->get_fabric_name(),
2329                                 se_sess->se_node_acl->initiatorname,
2330                                 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2331                                 pr_res_holder->pr_reg_nacl->initiatorname);
2332
2333                         spin_unlock(&dev->dev_reservation_lock);
2334                         ret = TCM_RESERVATION_CONFLICT;
2335                         goto out_put_pr_reg;
2336                 }
2337                 /*
2338                  * From spc4r17 Section 5.7.9: Reserving:
2339                  *
2340                  * If the device server receives a PERSISTENT RESERVE OUT
2341                  * command with RESERVE service action where the TYPE field and
2342                  * the SCOPE field contain the same values as the existing type
2343                  * and scope from a persistent reservation holder, it shall not
2344                  * make any change to the existing persistent reservation and
2345                  * shall completethe command with GOOD status.
2346                  */
2347                 spin_unlock(&dev->dev_reservation_lock);
2348                 ret = 0;
2349                 goto out_put_pr_reg;
2350         }
2351         /*
2352          * Otherwise, our *pr_reg becomes the PR reservation holder for said
2353          * TYPE/SCOPE.  Also set the received scope and type in *pr_reg.
2354          */
2355         pr_reg->pr_res_scope = scope;
2356         pr_reg->pr_res_type = type;
2357         pr_reg->pr_res_holder = 1;
2358         dev->dev_pr_res_holder = pr_reg;
2359         core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2360
2361         pr_debug("SPC-3 PR [%s] Service Action: RESERVE created new"
2362                 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2363                 cmd->se_tfo->get_fabric_name(), core_scsi3_pr_dump_type(type),
2364                 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2365         pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
2366                         cmd->se_tfo->get_fabric_name(),
2367                         se_sess->se_node_acl->initiatorname,
2368                         i_buf);
2369         spin_unlock(&dev->dev_reservation_lock);
2370
2371         if (pr_tmpl->pr_aptpl_active)
2372                 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2373
2374         ret = 0;
2375 out_put_pr_reg:
2376         core_scsi3_put_pr_reg(pr_reg);
2377         return ret;
2378 }
2379
2380 static sense_reason_t
2381 core_scsi3_emulate_pro_reserve(struct se_cmd *cmd, int type, int scope,
2382                 u64 res_key)
2383 {
2384         switch (type) {
2385         case PR_TYPE_WRITE_EXCLUSIVE:
2386         case PR_TYPE_EXCLUSIVE_ACCESS:
2387         case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2388         case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2389         case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2390         case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2391                 return core_scsi3_pro_reserve(cmd, type, scope, res_key);
2392         default:
2393                 pr_err("SPC-3 PR: Unknown Service Action RESERVE Type:"
2394                         " 0x%02x\n", type);
2395                 return TCM_INVALID_CDB_FIELD;
2396         }
2397 }
2398
2399 /*
2400  * Called with struct se_device->dev_reservation_lock held.
2401  */
2402 static void __core_scsi3_complete_pro_release(
2403         struct se_device *dev,
2404         struct se_node_acl *se_nacl,
2405         struct t10_pr_registration *pr_reg,
2406         int explicit,
2407         int unreg)
2408 {
2409         const struct target_core_fabric_ops *tfo = se_nacl->se_tpg->se_tpg_tfo;
2410         char i_buf[PR_REG_ISID_ID_LEN];
2411         int pr_res_type = 0, pr_res_scope = 0;
2412
2413         memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2414         core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2415         /*
2416          * Go ahead and release the current PR reservation holder.
2417          * If an All Registrants reservation is currently active and
2418          * a unregister operation is requested, replace the current
2419          * dev_pr_res_holder with another active registration.
2420          */
2421         if (dev->dev_pr_res_holder) {
2422                 pr_res_type = dev->dev_pr_res_holder->pr_res_type;
2423                 pr_res_scope = dev->dev_pr_res_holder->pr_res_scope;
2424                 dev->dev_pr_res_holder->pr_res_type = 0;
2425                 dev->dev_pr_res_holder->pr_res_scope = 0;
2426                 dev->dev_pr_res_holder->pr_res_holder = 0;
2427                 dev->dev_pr_res_holder = NULL;
2428         }
2429         if (!unreg)
2430                 goto out;
2431
2432         spin_lock(&dev->t10_pr.registration_lock);
2433         list_del_init(&pr_reg->pr_reg_list);
2434         /*
2435          * If the I_T nexus is a reservation holder, the persistent reservation
2436          * is of an all registrants type, and the I_T nexus is the last remaining
2437          * registered I_T nexus, then the device server shall also release the
2438          * persistent reservation.
2439          */
2440         if (!list_empty(&dev->t10_pr.registration_list) &&
2441             ((pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2442              (pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))) {
2443                 dev->dev_pr_res_holder =
2444                         list_entry(dev->t10_pr.registration_list.next,
2445                                    struct t10_pr_registration, pr_reg_list);
2446                 dev->dev_pr_res_holder->pr_res_type = pr_res_type;
2447                 dev->dev_pr_res_holder->pr_res_scope = pr_res_scope;
2448                 dev->dev_pr_res_holder->pr_res_holder = 1;
2449         }
2450         spin_unlock(&dev->t10_pr.registration_lock);
2451 out:
2452         if (!dev->dev_pr_res_holder) {
2453                 pr_debug("SPC-3 PR [%s] Service Action: %s RELEASE cleared"
2454                         " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2455                         tfo->get_fabric_name(), (explicit) ? "explicit" :
2456                         "implicit", core_scsi3_pr_dump_type(pr_res_type),
2457                         (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2458         }
2459         pr_debug("SPC-3 PR [%s] RELEASE Node: %s%s\n",
2460                 tfo->get_fabric_name(), se_nacl->initiatorname,
2461                 i_buf);
2462         /*
2463          * Clear TYPE and SCOPE for the next PROUT Service Action: RESERVE
2464          */
2465         pr_reg->pr_res_holder = pr_reg->pr_res_type = pr_reg->pr_res_scope = 0;
2466 }
2467
2468 static sense_reason_t
2469 core_scsi3_emulate_pro_release(struct se_cmd *cmd, int type, int scope,
2470                 u64 res_key)
2471 {
2472         struct se_device *dev = cmd->se_dev;
2473         struct se_session *se_sess = cmd->se_sess;
2474         struct se_lun *se_lun = cmd->se_lun;
2475         struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_res_holder;
2476         struct t10_reservation *pr_tmpl = &dev->t10_pr;
2477         sense_reason_t ret = 0;
2478
2479         if (!se_sess || !se_lun) {
2480                 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2481                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2482         }
2483         /*
2484          * Locate the existing *pr_reg via struct se_node_acl pointers
2485          */
2486         pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2487         if (!pr_reg) {
2488                 pr_err("SPC-3 PR: Unable to locate"
2489                         " PR_REGISTERED *pr_reg for RELEASE\n");
2490                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2491         }
2492         /*
2493          * From spc4r17 Section 5.7.11.2 Releasing:
2494          *
2495          * If there is no persistent reservation or in response to a persistent
2496          * reservation release request from a registered I_T nexus that is not a
2497          * persistent reservation holder (see 5.7.10), the device server shall
2498          * do the following:
2499          *
2500          *     a) Not release the persistent reservation, if any;
2501          *     b) Not remove any registrations; and
2502          *     c) Complete the command with GOOD status.
2503          */
2504         spin_lock(&dev->dev_reservation_lock);
2505         pr_res_holder = dev->dev_pr_res_holder;
2506         if (!pr_res_holder) {
2507                 /*
2508                  * No persistent reservation, return GOOD status.
2509                  */
2510                 spin_unlock(&dev->dev_reservation_lock);
2511                 goto out_put_pr_reg;
2512         }
2513
2514         if (!is_reservation_holder(pr_res_holder, pr_reg)) {
2515                 /*
2516                  * Release request from a registered I_T nexus that is not a
2517                  * persistent reservation holder. return GOOD status.
2518                  */
2519                 spin_unlock(&dev->dev_reservation_lock);
2520                 goto out_put_pr_reg;
2521         }
2522
2523         /*
2524          * From spc4r17 Section 5.7.11.2 Releasing:
2525          *
2526          * Only the persistent reservation holder (see 5.7.10) is allowed to
2527          * release a persistent reservation.
2528          *
2529          * An application client releases the persistent reservation by issuing
2530          * a PERSISTENT RESERVE OUT command with RELEASE service action through
2531          * an I_T nexus that is a persistent reservation holder with the
2532          * following parameters:
2533          *
2534          *     a) RESERVATION KEY field set to the value of the reservation key
2535          *        that is registered with the logical unit for the I_T nexus;
2536          */
2537         if (res_key != pr_reg->pr_res_key) {
2538                 pr_err("SPC-3 PR RELEASE: Received res_key: 0x%016Lx"
2539                         " does not match existing SA REGISTER res_key:"
2540                         " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2541                 spin_unlock(&dev->dev_reservation_lock);
2542                 ret = TCM_RESERVATION_CONFLICT;
2543                 goto out_put_pr_reg;
2544         }
2545         /*
2546          * From spc4r17 Section 5.7.11.2 Releasing and above:
2547          *
2548          * b) TYPE field and SCOPE field set to match the persistent
2549          *    reservation being released.
2550          */
2551         if ((pr_res_holder->pr_res_type != type) ||
2552             (pr_res_holder->pr_res_scope != scope)) {
2553                 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2554                 pr_err("SPC-3 PR RELEASE: Attempted to release"
2555                         " reservation from [%s]: %s with different TYPE "
2556                         "and/or SCOPE  while reservation already held by"
2557                         " [%s]: %s, returning RESERVATION_CONFLICT\n",
2558                         cmd->se_tfo->get_fabric_name(),
2559                         se_sess->se_node_acl->initiatorname,
2560                         pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2561                         pr_res_holder->pr_reg_nacl->initiatorname);
2562
2563                 spin_unlock(&dev->dev_reservation_lock);
2564                 ret = TCM_RESERVATION_CONFLICT;
2565                 goto out_put_pr_reg;
2566         }
2567         /*
2568          * In response to a persistent reservation release request from the
2569          * persistent reservation holder the device server shall perform a
2570          * release by doing the following as an uninterrupted series of actions:
2571          * a) Release the persistent reservation;
2572          * b) Not remove any registration(s);
2573          * c) If the released persistent reservation is a registrants only type
2574          * or all registrants type persistent reservation,
2575          *    the device server shall establish a unit attention condition for
2576          *    the initiator port associated with every regis-
2577          *    tered I_T nexus other than I_T nexus on which the PERSISTENT
2578          *    RESERVE OUT command with RELEASE service action was received,
2579          *    with the additional sense code set to RESERVATIONS RELEASED; and
2580          * d) If the persistent reservation is of any other type, the device
2581          *    server shall not establish a unit attention condition.
2582          */
2583         __core_scsi3_complete_pro_release(dev, se_sess->se_node_acl,
2584                                           pr_reg, 1, 0);
2585
2586         spin_unlock(&dev->dev_reservation_lock);
2587
2588         if ((type != PR_TYPE_WRITE_EXCLUSIVE_REGONLY) &&
2589             (type != PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) &&
2590             (type != PR_TYPE_WRITE_EXCLUSIVE_ALLREG) &&
2591             (type != PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
2592                 /*
2593                  * If no UNIT ATTENTION conditions will be established for
2594                  * PR_TYPE_WRITE_EXCLUSIVE or PR_TYPE_EXCLUSIVE_ACCESS
2595                  * go ahead and check for APTPL=1 update+write below
2596                  */
2597                 goto write_aptpl;
2598         }
2599
2600         spin_lock(&pr_tmpl->registration_lock);
2601         list_for_each_entry(pr_reg_p, &pr_tmpl->registration_list,
2602                         pr_reg_list) {
2603                 /*
2604                  * Do not establish a UNIT ATTENTION condition
2605                  * for the calling I_T Nexus
2606                  */
2607                 if (pr_reg_p == pr_reg)
2608                         continue;
2609
2610                 core_scsi3_ua_allocate(pr_reg_p->pr_reg_nacl,
2611                                 pr_reg_p->pr_res_mapped_lun,
2612                                 0x2A, ASCQ_2AH_RESERVATIONS_RELEASED);
2613         }
2614         spin_unlock(&pr_tmpl->registration_lock);
2615
2616 write_aptpl:
2617         if (pr_tmpl->pr_aptpl_active)
2618                 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2619
2620 out_put_pr_reg:
2621         core_scsi3_put_pr_reg(pr_reg);
2622         return ret;
2623 }
2624
2625 static sense_reason_t
2626 core_scsi3_emulate_pro_clear(struct se_cmd *cmd, u64 res_key)
2627 {
2628         struct se_device *dev = cmd->se_dev;
2629         struct se_node_acl *pr_reg_nacl;
2630         struct se_session *se_sess = cmd->se_sess;
2631         struct t10_reservation *pr_tmpl = &dev->t10_pr;
2632         struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2633         u32 pr_res_mapped_lun = 0;
2634         int calling_it_nexus = 0;
2635         /*
2636          * Locate the existing *pr_reg via struct se_node_acl pointers
2637          */
2638         pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev,
2639                         se_sess->se_node_acl, se_sess);
2640         if (!pr_reg_n) {
2641                 pr_err("SPC-3 PR: Unable to locate"
2642                         " PR_REGISTERED *pr_reg for CLEAR\n");
2643                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2644         }
2645         /*
2646          * From spc4r17 section 5.7.11.6, Clearing:
2647          *
2648          * Any application client may release the persistent reservation and
2649          * remove all registrations from a device server by issuing a
2650          * PERSISTENT RESERVE OUT command with CLEAR service action through a
2651          * registered I_T nexus with the following parameter:
2652          *
2653          *      a) RESERVATION KEY field set to the value of the reservation key
2654          *         that is registered with the logical unit for the I_T nexus.
2655          */
2656         if (res_key != pr_reg_n->pr_res_key) {
2657                 pr_err("SPC-3 PR REGISTER: Received"
2658                         " res_key: 0x%016Lx does not match"
2659                         " existing SA REGISTER res_key:"
2660                         " 0x%016Lx\n", res_key, pr_reg_n->pr_res_key);
2661                 core_scsi3_put_pr_reg(pr_reg_n);
2662                 return TCM_RESERVATION_CONFLICT;
2663         }
2664         /*
2665          * a) Release the persistent reservation, if any;
2666          */
2667         spin_lock(&dev->dev_reservation_lock);
2668         pr_res_holder = dev->dev_pr_res_holder;
2669         if (pr_res_holder) {
2670                 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2671                 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
2672                                                   pr_res_holder, 0, 0);
2673         }
2674         spin_unlock(&dev->dev_reservation_lock);
2675         /*
2676          * b) Remove all registration(s) (see spc4r17 5.7.7);
2677          */
2678         spin_lock(&pr_tmpl->registration_lock);
2679         list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2680                         &pr_tmpl->registration_list, pr_reg_list) {
2681
2682                 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2683                 pr_reg_nacl = pr_reg->pr_reg_nacl;
2684                 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2685                 __core_scsi3_free_registration(dev, pr_reg, NULL,
2686                                         calling_it_nexus);
2687                 /*
2688                  * e) Establish a unit attention condition for the initiator
2689                  *    port associated with every registered I_T nexus other
2690                  *    than the I_T nexus on which the PERSISTENT RESERVE OUT
2691                  *    command with CLEAR service action was received, with the
2692                  *    additional sense code set to RESERVATIONS PREEMPTED.
2693                  */
2694                 if (!calling_it_nexus)
2695                         core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun,
2696                                 0x2A, ASCQ_2AH_RESERVATIONS_PREEMPTED);
2697         }
2698         spin_unlock(&pr_tmpl->registration_lock);
2699
2700         pr_debug("SPC-3 PR [%s] Service Action: CLEAR complete\n",
2701                 cmd->se_tfo->get_fabric_name());
2702
2703         core_scsi3_update_and_write_aptpl(cmd->se_dev, false);
2704
2705         core_scsi3_pr_generation(dev);
2706         return 0;
2707 }
2708
2709 /*
2710  * Called with struct se_device->dev_reservation_lock held.
2711  */
2712 static void __core_scsi3_complete_pro_preempt(
2713         struct se_device *dev,
2714         struct t10_pr_registration *pr_reg,
2715         struct list_head *preempt_and_abort_list,
2716         int type,
2717         int scope,
2718         enum preempt_type preempt_type)
2719 {
2720         struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
2721         const struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
2722         char i_buf[PR_REG_ISID_ID_LEN];
2723
2724         memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2725         core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2726         /*
2727          * Do an implicit RELEASE of the existing reservation.
2728          */
2729         if (dev->dev_pr_res_holder)
2730                 __core_scsi3_complete_pro_release(dev, nacl,
2731                                                   dev->dev_pr_res_holder, 0, 0);
2732
2733         dev->dev_pr_res_holder = pr_reg;
2734         pr_reg->pr_res_holder = 1;
2735         pr_reg->pr_res_type = type;
2736         pr_reg->pr_res_scope = scope;
2737
2738         pr_debug("SPC-3 PR [%s] Service Action: PREEMPT%s created new"
2739                 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2740                 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2741                 core_scsi3_pr_dump_type(type),
2742                 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2743         pr_debug("SPC-3 PR [%s] PREEMPT%s from Node: %s%s\n",
2744                 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2745                 nacl->initiatorname, i_buf);
2746         /*
2747          * For PREEMPT_AND_ABORT, add the preempting reservation's
2748          * struct t10_pr_registration to the list that will be compared
2749          * against received CDBs..
2750          */
2751         if (preempt_and_abort_list)
2752                 list_add_tail(&pr_reg->pr_reg_abort_list,
2753                                 preempt_and_abort_list);
2754 }
2755
2756 static void core_scsi3_release_preempt_and_abort(
2757         struct list_head *preempt_and_abort_list,
2758         struct t10_pr_registration *pr_reg_holder)
2759 {
2760         struct t10_pr_registration *pr_reg, *pr_reg_tmp;
2761
2762         list_for_each_entry_safe(pr_reg, pr_reg_tmp, preempt_and_abort_list,
2763                                 pr_reg_abort_list) {
2764
2765                 list_del(&pr_reg->pr_reg_abort_list);
2766                 if (pr_reg_holder == pr_reg)
2767                         continue;
2768                 if (pr_reg->pr_res_holder) {
2769                         pr_warn("pr_reg->pr_res_holder still set\n");
2770                         continue;
2771                 }
2772
2773                 pr_reg->pr_reg_deve = NULL;
2774                 pr_reg->pr_reg_nacl = NULL;
2775                 kmem_cache_free(t10_pr_reg_cache, pr_reg);
2776         }
2777 }
2778
2779 static sense_reason_t
2780 core_scsi3_pro_preempt(struct se_cmd *cmd, int type, int scope, u64 res_key,
2781                 u64 sa_res_key, enum preempt_type preempt_type)
2782 {
2783         struct se_device *dev = cmd->se_dev;
2784         struct se_node_acl *pr_reg_nacl;
2785         struct se_session *se_sess = cmd->se_sess;
2786         LIST_HEAD(preempt_and_abort_list);
2787         struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2788         struct t10_reservation *pr_tmpl = &dev->t10_pr;
2789         u32 pr_res_mapped_lun = 0;
2790         int all_reg = 0, calling_it_nexus = 0;
2791         bool sa_res_key_unmatched = sa_res_key != 0;
2792         int prh_type = 0, prh_scope = 0;
2793
2794         if (!se_sess)
2795                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2796
2797         pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2798                                 se_sess);
2799         if (!pr_reg_n) {
2800                 pr_err("SPC-3 PR: Unable to locate"
2801                         " PR_REGISTERED *pr_reg for PREEMPT%s\n",
2802                         (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "");
2803                 return TCM_RESERVATION_CONFLICT;
2804         }
2805         if (pr_reg_n->pr_res_key != res_key) {
2806                 core_scsi3_put_pr_reg(pr_reg_n);
2807                 return TCM_RESERVATION_CONFLICT;
2808         }
2809         if (scope != PR_SCOPE_LU_SCOPE) {
2810                 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2811                 core_scsi3_put_pr_reg(pr_reg_n);
2812                 return TCM_INVALID_PARAMETER_LIST;
2813         }
2814
2815         spin_lock(&dev->dev_reservation_lock);
2816         pr_res_holder = dev->dev_pr_res_holder;
2817         if (pr_res_holder &&
2818            ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2819             (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)))
2820                 all_reg = 1;
2821
2822         if (!all_reg && !sa_res_key) {
2823                 spin_unlock(&dev->dev_reservation_lock);
2824                 core_scsi3_put_pr_reg(pr_reg_n);
2825                 return TCM_INVALID_PARAMETER_LIST;
2826         }
2827         /*
2828          * From spc4r17, section 5.7.11.4.4 Removing Registrations:
2829          *
2830          * If the SERVICE ACTION RESERVATION KEY field does not identify a
2831          * persistent reservation holder or there is no persistent reservation
2832          * holder (i.e., there is no persistent reservation), then the device
2833          * server shall perform a preempt by doing the following in an
2834          * uninterrupted series of actions. (See below..)
2835          */
2836         if (!pr_res_holder || (pr_res_holder->pr_res_key != sa_res_key)) {
2837                 /*
2838                  * No existing or SA Reservation Key matching reservations..
2839                  *
2840                  * PROUT SA PREEMPT with All Registrant type reservations are
2841                  * allowed to be processed without a matching SA Reservation Key
2842                  */
2843                 spin_lock(&pr_tmpl->registration_lock);
2844                 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2845                                 &pr_tmpl->registration_list, pr_reg_list) {
2846                         /*
2847                          * Removing of registrations in non all registrants
2848                          * type reservations without a matching SA reservation
2849                          * key.
2850                          *
2851                          * a) Remove the registrations for all I_T nexuses
2852                          *    specified by the SERVICE ACTION RESERVATION KEY
2853                          *    field;
2854                          * b) Ignore the contents of the SCOPE and TYPE fields;
2855                          * c) Process tasks as defined in 5.7.1; and
2856                          * d) Establish a unit attention condition for the
2857                          *    initiator port associated with every I_T nexus
2858                          *    that lost its registration other than the I_T
2859                          *    nexus on which the PERSISTENT RESERVE OUT command
2860                          *    was received, with the additional sense code set
2861                          *    to REGISTRATIONS PREEMPTED.
2862                          */
2863                         if (!all_reg) {
2864                                 if (pr_reg->pr_res_key != sa_res_key)
2865                                         continue;
2866                                 sa_res_key_unmatched = false;
2867
2868                                 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2869                                 pr_reg_nacl = pr_reg->pr_reg_nacl;
2870                                 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2871                                 __core_scsi3_free_registration(dev, pr_reg,
2872                                         (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2873                                                 NULL, calling_it_nexus);
2874                         } else {
2875                                 /*
2876                                  * Case for any existing all registrants type
2877                                  * reservation, follow logic in spc4r17 section
2878                                  * 5.7.11.4 Preempting, Table 52 and Figure 7.
2879                                  *
2880                                  * For a ZERO SA Reservation key, release
2881                                  * all other registrations and do an implicit
2882                                  * release of active persistent reservation.
2883                                  *
2884                                  * For a non-ZERO SA Reservation key, only
2885                                  * release the matching reservation key from
2886                                  * registrations.
2887                                  */
2888                                 if ((sa_res_key) &&
2889                                      (pr_reg->pr_res_key != sa_res_key))
2890                                         continue;
2891                                 sa_res_key_unmatched = false;
2892
2893                                 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2894                                 if (calling_it_nexus)
2895                                         continue;
2896
2897                                 pr_reg_nacl = pr_reg->pr_reg_nacl;
2898                                 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2899                                 __core_scsi3_free_registration(dev, pr_reg,
2900                                         (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2901                                                 NULL, 0);
2902                         }
2903                         if (!calling_it_nexus)
2904                                 core_scsi3_ua_allocate(pr_reg_nacl,
2905                                         pr_res_mapped_lun, 0x2A,
2906                                         ASCQ_2AH_REGISTRATIONS_PREEMPTED);
2907                 }
2908                 spin_unlock(&pr_tmpl->registration_lock);
2909                 /*
2910                  * If a PERSISTENT RESERVE OUT with a PREEMPT service action or
2911                  * a PREEMPT AND ABORT service action sets the SERVICE ACTION
2912                  * RESERVATION KEY field to a value that does not match any
2913                  * registered reservation key, then the device server shall
2914                  * complete the command with RESERVATION CONFLICT status.
2915                  */
2916                 if (sa_res_key_unmatched) {
2917                         spin_unlock(&dev->dev_reservation_lock);
2918                         core_scsi3_put_pr_reg(pr_reg_n);
2919                         return TCM_RESERVATION_CONFLICT;
2920                 }
2921                 /*
2922                  * For an existing all registrants type reservation
2923                  * with a zero SA rservation key, preempt the existing
2924                  * reservation with the new PR type and scope.
2925                  */
2926                 if (pr_res_holder && all_reg && !(sa_res_key)) {
2927                         __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
2928                                 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
2929                                 type, scope, preempt_type);
2930
2931                         if (preempt_type == PREEMPT_AND_ABORT)
2932                                 core_scsi3_release_preempt_and_abort(
2933                                         &preempt_and_abort_list, pr_reg_n);
2934                 }
2935                 spin_unlock(&dev->dev_reservation_lock);
2936
2937                 if (pr_tmpl->pr_aptpl_active)
2938                         core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2939
2940                 core_scsi3_put_pr_reg(pr_reg_n);
2941                 core_scsi3_pr_generation(cmd->se_dev);
2942                 return 0;
2943         }
2944         /*
2945          * The PREEMPTing SA reservation key matches that of the
2946          * existing persistent reservation, first, we check if
2947          * we are preempting our own reservation.
2948          * From spc4r17, section 5.7.11.4.3 Preempting
2949          * persistent reservations and registration handling
2950          *
2951          * If an all registrants persistent reservation is not
2952          * present, it is not an error for the persistent
2953          * reservation holder to preempt itself (i.e., a
2954          * PERSISTENT RESERVE OUT with a PREEMPT service action
2955          * or a PREEMPT AND ABORT service action with the
2956          * SERVICE ACTION RESERVATION KEY value equal to the
2957          * persistent reservation holder's reservation key that
2958          * is received from the persistent reservation holder).
2959          * In that case, the device server shall establish the
2960          * new persistent reservation and maintain the
2961          * registration.
2962          */
2963         prh_type = pr_res_holder->pr_res_type;
2964         prh_scope = pr_res_holder->pr_res_scope;
2965         /*
2966          * If the SERVICE ACTION RESERVATION KEY field identifies a
2967          * persistent reservation holder (see 5.7.10), the device
2968          * server shall perform a preempt by doing the following as
2969          * an uninterrupted series of actions:
2970          *
2971          * a) Release the persistent reservation for the holder
2972          *    identified by the SERVICE ACTION RESERVATION KEY field;
2973          */
2974         if (pr_reg_n != pr_res_holder)
2975                 __core_scsi3_complete_pro_release(dev,
2976                                                   pr_res_holder->pr_reg_nacl,
2977                                                   dev->dev_pr_res_holder, 0, 0);
2978         /*
2979          * b) Remove the registrations for all I_T nexuses identified
2980          *    by the SERVICE ACTION RESERVATION KEY field, except the
2981          *    I_T nexus that is being used for the PERSISTENT RESERVE
2982          *    OUT command. If an all registrants persistent reservation
2983          *    is present and the SERVICE ACTION RESERVATION KEY field
2984          *    is set to zero, then all registrations shall be removed
2985          *    except for that of the I_T nexus that is being used for
2986          *    the PERSISTENT RESERVE OUT command;
2987          */
2988         spin_lock(&pr_tmpl->registration_lock);
2989         list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2990                         &pr_tmpl->registration_list, pr_reg_list) {
2991
2992                 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2993                 if (calling_it_nexus)
2994                         continue;
2995
2996                 if (pr_reg->pr_res_key != sa_res_key)
2997                         continue;
2998
2999                 pr_reg_nacl = pr_reg->pr_reg_nacl;
3000                 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
3001                 __core_scsi3_free_registration(dev, pr_reg,
3002                                 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
3003                                 calling_it_nexus);
3004                 /*
3005                  * e) Establish a unit attention condition for the initiator
3006                  *    port associated with every I_T nexus that lost its
3007                  *    persistent reservation and/or registration, with the
3008                  *    additional sense code set to REGISTRATIONS PREEMPTED;
3009                  */
3010                 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun, 0x2A,
3011                                 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
3012         }
3013         spin_unlock(&pr_tmpl->registration_lock);
3014         /*
3015          * c) Establish a persistent reservation for the preempting
3016          *    I_T nexus using the contents of the SCOPE and TYPE fields;
3017          */
3018         __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
3019                         (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
3020                         type, scope, preempt_type);
3021         /*
3022          * d) Process tasks as defined in 5.7.1;
3023          * e) See above..
3024          * f) If the type or scope has changed, then for every I_T nexus
3025          *    whose reservation key was not removed, except for the I_T
3026          *    nexus on which the PERSISTENT RESERVE OUT command was
3027          *    received, the device server shall establish a unit
3028          *    attention condition for the initiator port associated with
3029          *    that I_T nexus, with the additional sense code set to
3030          *    RESERVATIONS RELEASED. If the type or scope have not
3031          *    changed, then no unit attention condition(s) shall be
3032          *    established for this reason.
3033          */
3034         if ((prh_type != type) || (prh_scope != scope)) {
3035                 spin_lock(&pr_tmpl->registration_lock);
3036                 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3037                                 &pr_tmpl->registration_list, pr_reg_list) {
3038
3039                         calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3040                         if (calling_it_nexus)
3041                                 continue;
3042
3043                         core_scsi3_ua_allocate(pr_reg->pr_reg_nacl,
3044                                         pr_reg->pr_res_mapped_lun, 0x2A,
3045                                         ASCQ_2AH_RESERVATIONS_RELEASED);
3046                 }
3047                 spin_unlock(&pr_tmpl->registration_lock);
3048         }
3049         spin_unlock(&dev->dev_reservation_lock);
3050         /*
3051          * Call LUN_RESET logic upon list of struct t10_pr_registration,
3052          * All received CDBs for the matching existing reservation and
3053          * registrations undergo ABORT_TASK logic.
3054          *
3055          * From there, core_scsi3_release_preempt_and_abort() will
3056          * release every registration in the list (which have already
3057          * been removed from the primary pr_reg list), except the
3058          * new persistent reservation holder, the calling Initiator Port.
3059          */
3060         if (preempt_type == PREEMPT_AND_ABORT) {
3061                 core_tmr_lun_reset(dev, NULL, &preempt_and_abort_list, cmd);
3062                 core_scsi3_release_preempt_and_abort(&preempt_and_abort_list,
3063                                                 pr_reg_n);
3064         }
3065
3066         if (pr_tmpl->pr_aptpl_active)
3067                 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
3068
3069         core_scsi3_put_pr_reg(pr_reg_n);
3070         core_scsi3_pr_generation(cmd->se_dev);
3071         return 0;
3072 }
3073
3074 static sense_reason_t
3075 core_scsi3_emulate_pro_preempt(struct se_cmd *cmd, int type, int scope,
3076                 u64 res_key, u64 sa_res_key, enum preempt_type preempt_type)
3077 {
3078         switch (type) {
3079         case PR_TYPE_WRITE_EXCLUSIVE:
3080         case PR_TYPE_EXCLUSIVE_ACCESS:
3081         case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
3082         case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
3083         case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
3084         case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
3085                 return core_scsi3_pro_preempt(cmd, type, scope, res_key,
3086                                               sa_res_key, preempt_type);
3087         default:
3088                 pr_err("SPC-3 PR: Unknown Service Action PREEMPT%s"
3089                         " Type: 0x%02x\n", (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "", type);
3090                 return TCM_INVALID_CDB_FIELD;
3091         }
3092 }
3093
3094
3095 static sense_reason_t
3096 core_scsi3_emulate_pro_register_and_move(struct se_cmd *cmd, u64 res_key,
3097                 u64 sa_res_key, int aptpl, int unreg)
3098 {
3099         struct se_session *se_sess = cmd->se_sess;
3100         struct se_device *dev = cmd->se_dev;
3101         struct se_dev_entry *dest_se_deve = NULL;
3102         struct se_lun *se_lun = cmd->se_lun;
3103         struct se_node_acl *pr_res_nacl, *pr_reg_nacl, *dest_node_acl = NULL;
3104         struct se_port *se_port;
3105         struct se_portal_group *se_tpg, *dest_se_tpg = NULL;
3106         const struct target_core_fabric_ops *dest_tf_ops = NULL, *tf_ops;
3107         struct t10_pr_registration *pr_reg, *pr_res_holder, *dest_pr_reg;
3108         struct t10_reservation *pr_tmpl = &dev->t10_pr;
3109         unsigned char *buf;
3110         unsigned char *initiator_str;
3111         char *iport_ptr = NULL, i_buf[PR_REG_ISID_ID_LEN];
3112         u32 tid_len, tmp_tid_len;
3113         int new_reg = 0, type, scope, matching_iname;
3114         sense_reason_t ret;
3115         unsigned short rtpi;
3116         unsigned char proto_ident;
3117
3118         if (!se_sess || !se_lun) {
3119                 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
3120                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3121         }
3122
3123         memset(i_buf, 0, PR_REG_ISID_ID_LEN);
3124         se_tpg = se_sess->se_tpg;
3125         tf_ops = se_tpg->se_tpg_tfo;
3126         /*
3127          * Follow logic from spc4r17 Section 5.7.8, Table 50 --
3128          *      Register behaviors for a REGISTER AND MOVE service action
3129          *
3130          * Locate the existing *pr_reg via struct se_node_acl pointers
3131          */
3132         pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
3133                                 se_sess);
3134         if (!pr_reg) {
3135                 pr_err("SPC-3 PR: Unable to locate PR_REGISTERED"
3136                         " *pr_reg for REGISTER_AND_MOVE\n");
3137                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3138         }
3139         /*
3140          * The provided reservation key much match the existing reservation key
3141          * provided during this initiator's I_T nexus registration.
3142          */
3143         if (res_key != pr_reg->pr_res_key) {
3144                 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received"
3145                         " res_key: 0x%016Lx does not match existing SA REGISTER"
3146                         " res_key: 0x%016Lx\n", res_key, pr_reg->pr_res_key);
3147                 ret = TCM_RESERVATION_CONFLICT;
3148                 goto out_put_pr_reg;
3149         }
3150         /*
3151          * The service active reservation key needs to be non zero
3152          */
3153         if (!sa_res_key) {
3154                 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received zero"
3155                         " sa_res_key\n");
3156                 ret = TCM_INVALID_PARAMETER_LIST;
3157                 goto out_put_pr_reg;
3158         }
3159
3160         /*
3161          * Determine the Relative Target Port Identifier where the reservation
3162          * will be moved to for the TransportID containing SCSI initiator WWN
3163          * information.
3164          */
3165         buf = transport_kmap_data_sg(cmd);
3166         if (!buf) {
3167                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3168                 goto out_put_pr_reg;
3169         }
3170
3171         rtpi = (buf[18] & 0xff) << 8;
3172         rtpi |= buf[19] & 0xff;
3173         tid_len = (buf[20] & 0xff) << 24;
3174         tid_len |= (buf[21] & 0xff) << 16;
3175         tid_len |= (buf[22] & 0xff) << 8;
3176         tid_len |= buf[23] & 0xff;
3177         transport_kunmap_data_sg(cmd);
3178         buf = NULL;
3179
3180         if ((tid_len + 24) != cmd->data_length) {
3181                 pr_err("SPC-3 PR: Illegal tid_len: %u + 24 byte header"
3182                         " does not equal CDB data_length: %u\n", tid_len,
3183                         cmd->data_length);
3184                 ret = TCM_INVALID_PARAMETER_LIST;
3185                 goto out_put_pr_reg;
3186         }
3187
3188         spin_lock(&dev->se_port_lock);
3189         list_for_each_entry(se_port, &dev->dev_sep_list, sep_list) {
3190                 if (se_port->sep_rtpi != rtpi)
3191                         continue;
3192                 dest_se_tpg = se_port->sep_tpg;
3193                 if (!dest_se_tpg)
3194                         continue;
3195                 dest_tf_ops = dest_se_tpg->se_tpg_tfo;
3196                 if (!dest_tf_ops)
3197                         continue;
3198
3199                 atomic_inc_mb(&dest_se_tpg->tpg_pr_ref_count);
3200                 spin_unlock(&dev->se_port_lock);
3201
3202                 if (core_scsi3_tpg_depend_item(dest_se_tpg)) {
3203                         pr_err("core_scsi3_tpg_depend_item() failed"
3204                                 " for dest_se_tpg\n");
3205                         atomic_dec_mb(&dest_se_tpg->tpg_pr_ref_count);
3206                         ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3207                         goto out_put_pr_reg;
3208                 }
3209
3210                 spin_lock(&dev->se_port_lock);
3211                 break;
3212         }
3213         spin_unlock(&dev->se_port_lock);
3214
3215         if (!dest_se_tpg || !dest_tf_ops) {
3216                 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3217                         " fabric ops from Relative Target Port Identifier:"
3218                         " %hu\n", rtpi);
3219                 ret = TCM_INVALID_PARAMETER_LIST;
3220                 goto out_put_pr_reg;
3221         }
3222
3223         buf = transport_kmap_data_sg(cmd);
3224         if (!buf) {
3225                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3226                 goto out_put_pr_reg;
3227         }
3228         proto_ident = (buf[24] & 0x0f);
3229
3230         pr_debug("SPC-3 PR REGISTER_AND_MOVE: Extracted Protocol Identifier:"
3231                         " 0x%02x\n", proto_ident);
3232
3233         if (proto_ident != dest_tf_ops->get_fabric_proto_ident(dest_se_tpg)) {
3234                 pr_err("SPC-3 PR REGISTER_AND_MOVE: Received"
3235                         " proto_ident: 0x%02x does not match ident: 0x%02x"
3236                         " from fabric: %s\n", proto_ident,
3237                         dest_tf_ops->get_fabric_proto_ident(dest_se_tpg),
3238                         dest_tf_ops->get_fabric_name());
3239                 ret = TCM_INVALID_PARAMETER_LIST;
3240                 goto out;
3241         }
3242         if (dest_tf_ops->tpg_parse_pr_out_transport_id == NULL) {
3243                 pr_err("SPC-3 PR REGISTER_AND_MOVE: Fabric does not"
3244                         " containg a valid tpg_parse_pr_out_transport_id"
3245                         " function pointer\n");
3246                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3247                 goto out;
3248         }
3249         initiator_str = dest_tf_ops->tpg_parse_pr_out_transport_id(dest_se_tpg,
3250                         (const char *)&buf[24], &tmp_tid_len, &iport_ptr);
3251         if (!initiator_str) {
3252                 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3253                         " initiator_str from Transport ID\n");
3254                 ret = TCM_INVALID_PARAMETER_LIST;
3255                 goto out;
3256         }
3257
3258         transport_kunmap_data_sg(cmd);
3259         buf = NULL;
3260
3261         pr_debug("SPC-3 PR [%s] Extracted initiator %s identifier: %s"
3262                 " %s\n", dest_tf_ops->get_fabric_name(), (iport_ptr != NULL) ?
3263                 "port" : "device", initiator_str, (iport_ptr != NULL) ?
3264                 iport_ptr : "");
3265         /*
3266          * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3267          * action specifies a TransportID that is the same as the initiator port
3268          * of the I_T nexus for the command received, then the command shall
3269          * be terminated with CHECK CONDITION status, with the sense key set to
3270          * ILLEGAL REQUEST, and the additional sense code set to INVALID FIELD
3271          * IN PARAMETER LIST.
3272          */
3273         pr_reg_nacl = pr_reg->pr_reg_nacl;
3274         matching_iname = (!strcmp(initiator_str,
3275                                   pr_reg_nacl->initiatorname)) ? 1 : 0;
3276         if (!matching_iname)
3277                 goto after_iport_check;
3278
3279         if (!iport_ptr || !pr_reg->isid_present_at_reg) {
3280                 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s"
3281                         " matches: %s on received I_T Nexus\n", initiator_str,
3282                         pr_reg_nacl->initiatorname);
3283                 ret = TCM_INVALID_PARAMETER_LIST;
3284                 goto out;
3285         }
3286         if (!strcmp(iport_ptr, pr_reg->pr_reg_isid)) {
3287                 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s %s"
3288                         " matches: %s %s on received I_T Nexus\n",
3289                         initiator_str, iport_ptr, pr_reg_nacl->initiatorname,
3290                         pr_reg->pr_reg_isid);
3291                 ret = TCM_INVALID_PARAMETER_LIST;
3292                 goto out;
3293         }
3294 after_iport_check:
3295         /*
3296          * Locate the destination struct se_node_acl from the received Transport ID
3297          */
3298         spin_lock_irq(&dest_se_tpg->acl_node_lock);
3299         dest_node_acl = __core_tpg_get_initiator_node_acl(dest_se_tpg,
3300                                 initiator_str);
3301         if (dest_node_acl)
3302                 atomic_inc_mb(&dest_node_acl->acl_pr_ref_count);
3303         spin_unlock_irq(&dest_se_tpg->acl_node_lock);
3304
3305         if (!dest_node_acl) {
3306                 pr_err("Unable to locate %s dest_node_acl for"
3307                         " TransportID%s\n", dest_tf_ops->get_fabric_name(),
3308                         initiator_str);
3309                 ret = TCM_INVALID_PARAMETER_LIST;
3310                 goto out;
3311         }
3312
3313         if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
3314                 pr_err("core_scsi3_nodeacl_depend_item() for"
3315                         " dest_node_acl\n");
3316                 atomic_dec_mb(&dest_node_acl->acl_pr_ref_count);
3317                 dest_node_acl = NULL;
3318                 ret = TCM_INVALID_PARAMETER_LIST;
3319                 goto out;
3320         }
3321
3322         pr_debug("SPC-3 PR REGISTER_AND_MOVE: Found %s dest_node_acl:"
3323                 " %s from TransportID\n", dest_tf_ops->get_fabric_name(),
3324                 dest_node_acl->initiatorname);
3325
3326         /*
3327          * Locate the struct se_dev_entry pointer for the matching RELATIVE TARGET
3328          * PORT IDENTIFIER.
3329          */
3330         dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl, rtpi);
3331         if (!dest_se_deve) {
3332                 pr_err("Unable to locate %s dest_se_deve from RTPI:"
3333                         " %hu\n",  dest_tf_ops->get_fabric_name(), rtpi);
3334                 ret = TCM_INVALID_PARAMETER_LIST;
3335                 goto out;
3336         }
3337
3338         if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
3339                 pr_err("core_scsi3_lunacl_depend_item() failed\n");
3340                 atomic_dec_mb(&dest_se_deve->pr_ref_count);
3341                 dest_se_deve = NULL;
3342                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3343                 goto out;
3344         }
3345
3346         pr_debug("SPC-3 PR REGISTER_AND_MOVE: Located %s node %s LUN"
3347                 " ACL for dest_se_deve->mapped_lun: %u\n",
3348                 dest_tf_ops->get_fabric_name(), dest_node_acl->initiatorname,
3349                 dest_se_deve->mapped_lun);
3350
3351         /*
3352          * A persistent reservation needs to already existing in order to
3353          * successfully complete the REGISTER_AND_MOVE service action..
3354          */
3355         spin_lock(&dev->dev_reservation_lock);
3356         pr_res_holder = dev->dev_pr_res_holder;
3357         if (!pr_res_holder) {
3358                 pr_warn("SPC-3 PR REGISTER_AND_MOVE: No reservation"
3359                         " currently held\n");
3360                 spin_unlock(&dev->dev_reservation_lock);
3361                 ret = TCM_INVALID_CDB_FIELD;
3362                 goto out;
3363         }
3364         /*
3365          * The received on I_T Nexus must be the reservation holder.
3366          *
3367          * From spc4r17 section 5.7.8  Table 50 --
3368          *      Register behaviors for a REGISTER AND MOVE service action
3369          */
3370         if (!is_reservation_holder(pr_res_holder, pr_reg)) {
3371                 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Calling I_T"
3372                         " Nexus is not reservation holder\n");
3373                 spin_unlock(&dev->dev_reservation_lock);
3374                 ret = TCM_RESERVATION_CONFLICT;
3375                 goto out;
3376         }
3377         /*
3378          * From spc4r17 section 5.7.8: registering and moving reservation
3379          *
3380          * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3381          * action is received and the established persistent reservation is a
3382          * Write Exclusive - All Registrants type or Exclusive Access -
3383          * All Registrants type reservation, then the command shall be completed
3384          * with RESERVATION CONFLICT status.
3385          */
3386         if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3387             (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
3388                 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Unable to move"
3389                         " reservation for type: %s\n",
3390                         core_scsi3_pr_dump_type(pr_res_holder->pr_res_type));
3391                 spin_unlock(&dev->dev_reservation_lock);
3392                 ret = TCM_RESERVATION_CONFLICT;
3393                 goto out;
3394         }
3395         pr_res_nacl = pr_res_holder->pr_reg_nacl;
3396         /*
3397          * b) Ignore the contents of the (received) SCOPE and TYPE fields;
3398          */
3399         type = pr_res_holder->pr_res_type;
3400         scope = pr_res_holder->pr_res_type;
3401         /*
3402          * c) Associate the reservation key specified in the SERVICE ACTION
3403          *    RESERVATION KEY field with the I_T nexus specified as the
3404          *    destination of the register and move, where:
3405          *    A) The I_T nexus is specified by the TransportID and the
3406          *       RELATIVE TARGET PORT IDENTIFIER field (see 6.14.4); and
3407          *    B) Regardless of the TransportID format used, the association for
3408          *       the initiator port is based on either the initiator port name
3409          *       (see 3.1.71) on SCSI transport protocols where port names are
3410          *       required or the initiator port identifier (see 3.1.70) on SCSI
3411          *       transport protocols where port names are not required;
3412          * d) Register the reservation key specified in the SERVICE ACTION
3413          *    RESERVATION KEY field;
3414          * e) Retain the reservation key specified in the SERVICE ACTION
3415          *    RESERVATION KEY field and associated information;
3416          *
3417          * Also, It is not an error for a REGISTER AND MOVE service action to
3418          * register an I_T nexus that is already registered with the same
3419          * reservation key or a different reservation key.
3420          */
3421         dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3422                                         iport_ptr);
3423         if (!dest_pr_reg) {
3424                 if (core_scsi3_alloc_registration(cmd->se_dev,
3425                                 dest_node_acl, dest_se_deve, iport_ptr,
3426                                 sa_res_key, 0, aptpl, 2, 1)) {
3427                         spin_unlock(&dev->dev_reservation_lock);
3428                         ret = TCM_INVALID_PARAMETER_LIST;
3429                         goto out;
3430                 }
3431                 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3432                                                 iport_ptr);
3433                 new_reg = 1;
3434         }
3435         /*
3436          * f) Release the persistent reservation for the persistent reservation
3437          *    holder (i.e., the I_T nexus on which the
3438          */
3439         __core_scsi3_complete_pro_release(dev, pr_res_nacl,
3440                                           dev->dev_pr_res_holder, 0, 0);
3441         /*
3442          * g) Move the persistent reservation to the specified I_T nexus using
3443          *    the same scope and type as the persistent reservation released in
3444          *    item f); and
3445          */
3446         dev->dev_pr_res_holder = dest_pr_reg;
3447         dest_pr_reg->pr_res_holder = 1;
3448         dest_pr_reg->pr_res_type = type;
3449         pr_reg->pr_res_scope = scope;
3450         core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
3451         /*
3452          * Increment PRGeneration for existing registrations..
3453          */
3454         if (!new_reg)
3455                 dest_pr_reg->pr_res_generation = pr_tmpl->pr_generation++;
3456         spin_unlock(&dev->dev_reservation_lock);
3457
3458         pr_debug("SPC-3 PR [%s] Service Action: REGISTER_AND_MOVE"
3459                 " created new reservation holder TYPE: %s on object RTPI:"
3460                 " %hu  PRGeneration: 0x%08x\n", dest_tf_ops->get_fabric_name(),
3461                 core_scsi3_pr_dump_type(type), rtpi,
3462                 dest_pr_reg->pr_res_generation);
3463         pr_debug("SPC-3 PR Successfully moved reservation from"
3464                 " %s Fabric Node: %s%s -> %s Fabric Node: %s %s\n",
3465                 tf_ops->get_fabric_name(), pr_reg_nacl->initiatorname,
3466                 i_buf, dest_tf_ops->get_fabric_name(),
3467                 dest_node_acl->initiatorname, (iport_ptr != NULL) ?
3468                 iport_ptr : "");
3469         /*
3470          * It is now safe to release configfs group dependencies for destination
3471          * of Transport ID Initiator Device/Port Identifier
3472          */
3473         core_scsi3_lunacl_undepend_item(dest_se_deve);
3474         core_scsi3_nodeacl_undepend_item(dest_node_acl);
3475         core_scsi3_tpg_undepend_item(dest_se_tpg);
3476         /*
3477          * h) If the UNREG bit is set to one, unregister (see 5.7.11.3) the I_T
3478          * nexus on which PERSISTENT RESERVE OUT command was received.
3479          */
3480         if (unreg) {
3481                 spin_lock(&pr_tmpl->registration_lock);
3482                 __core_scsi3_free_registration(dev, pr_reg, NULL, 1);
3483                 spin_unlock(&pr_tmpl->registration_lock);
3484         } else
3485                 core_scsi3_put_pr_reg(pr_reg);
3486
3487         core_scsi3_update_and_write_aptpl(cmd->se_dev, aptpl);
3488
3489         transport_kunmap_data_sg(cmd);
3490
3491         core_scsi3_put_pr_reg(dest_pr_reg);
3492         return 0;
3493 out:
3494         if (buf)
3495                 transport_kunmap_data_sg(cmd);
3496         if (dest_se_deve)
3497                 core_scsi3_lunacl_undepend_item(dest_se_deve);
3498         if (dest_node_acl)
3499                 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3500         core_scsi3_tpg_undepend_item(dest_se_tpg);
3501
3502 out_put_pr_reg:
3503         core_scsi3_put_pr_reg(pr_reg);
3504         return ret;
3505 }
3506
3507 static unsigned long long core_scsi3_extract_reservation_key(unsigned char *cdb)
3508 {
3509         unsigned int __v1, __v2;
3510
3511         __v1 = (cdb[0] << 24) | (cdb[1] << 16) | (cdb[2] << 8) | cdb[3];
3512         __v2 = (cdb[4] << 24) | (cdb[5] << 16) | (cdb[6] << 8) | cdb[7];
3513
3514         return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
3515 }
3516
3517 /*
3518  * See spc4r17 section 6.14 Table 170
3519  */
3520 sense_reason_t
3521 target_scsi3_emulate_pr_out(struct se_cmd *cmd)
3522 {
3523         struct se_device *dev = cmd->se_dev;
3524         unsigned char *cdb = &cmd->t_task_cdb[0];
3525         unsigned char *buf;
3526         u64 res_key, sa_res_key;
3527         int sa, scope, type, aptpl;
3528         int spec_i_pt = 0, all_tg_pt = 0, unreg = 0;
3529         sense_reason_t ret;
3530
3531         /*
3532          * Following spc2r20 5.5.1 Reservations overview:
3533          *
3534          * If a logical unit has been reserved by any RESERVE command and is
3535          * still reserved by any initiator, all PERSISTENT RESERVE IN and all
3536          * PERSISTENT RESERVE OUT commands shall conflict regardless of
3537          * initiator or service action and shall terminate with a RESERVATION
3538          * CONFLICT status.
3539          */
3540         if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
3541                 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
3542                         " SPC-2 reservation is held, returning"
3543                         " RESERVATION_CONFLICT\n");
3544                 return TCM_RESERVATION_CONFLICT;
3545         }
3546
3547         /*
3548          * FIXME: A NULL struct se_session pointer means an this is not coming from
3549          * a $FABRIC_MOD's nexus, but from internal passthrough ops.
3550          */
3551         if (!cmd->se_sess)
3552                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3553
3554         if (cmd->data_length < 24) {
3555                 pr_warn("SPC-PR: Received PR OUT parameter list"
3556                         " length too small: %u\n", cmd->data_length);
3557                 return TCM_INVALID_PARAMETER_LIST;
3558         }
3559
3560         /*
3561          * From the PERSISTENT_RESERVE_OUT command descriptor block (CDB)
3562          */
3563         sa = (cdb[1] & 0x1f);
3564         scope = (cdb[2] & 0xf0);
3565         type = (cdb[2] & 0x0f);
3566
3567         buf = transport_kmap_data_sg(cmd);
3568         if (!buf)
3569                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3570
3571         /*
3572          * From PERSISTENT_RESERVE_OUT parameter list (payload)
3573          */
3574         res_key = core_scsi3_extract_reservation_key(&buf[0]);
3575         sa_res_key = core_scsi3_extract_reservation_key(&buf[8]);
3576         /*
3577          * REGISTER_AND_MOVE uses a different SA parameter list containing
3578          * SCSI TransportIDs.
3579          */
3580         if (sa != PRO_REGISTER_AND_MOVE) {
3581                 spec_i_pt = (buf[20] & 0x08);
3582                 all_tg_pt = (buf[20] & 0x04);
3583                 aptpl = (buf[20] & 0x01);
3584         } else {
3585                 aptpl = (buf[17] & 0x01);
3586                 unreg = (buf[17] & 0x02);
3587         }
3588         /*
3589          * If the backend device has been configured to force APTPL metadata
3590          * write-out, go ahead and propigate aptpl=1 down now.
3591          */
3592         if (dev->dev_attrib.force_pr_aptpl)
3593                 aptpl = 1;
3594
3595         transport_kunmap_data_sg(cmd);
3596         buf = NULL;
3597
3598         /*
3599          * SPEC_I_PT=1 is only valid for Service action: REGISTER
3600          */
3601         if (spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER))
3602                 return TCM_INVALID_PARAMETER_LIST;
3603
3604         /*
3605          * From spc4r17 section 6.14:
3606          *
3607          * If the SPEC_I_PT bit is set to zero, the service action is not
3608          * REGISTER AND MOVE, and the parameter list length is not 24, then
3609          * the command shall be terminated with CHECK CONDITION status, with
3610          * the sense key set to ILLEGAL REQUEST, and the additional sense
3611          * code set to PARAMETER LIST LENGTH ERROR.
3612          */
3613         if (!spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER_AND_MOVE) &&
3614             (cmd->data_length != 24)) {
3615                 pr_warn("SPC-PR: Received PR OUT illegal parameter"
3616                         " list length: %u\n", cmd->data_length);
3617                 return TCM_INVALID_PARAMETER_LIST;
3618         }
3619
3620         /*
3621          * (core_scsi3_emulate_pro_* function parameters
3622          * are defined by spc4r17 Table 174:
3623          * PERSISTENT_RESERVE_OUT service actions and valid parameters.
3624          */
3625         switch (sa) {
3626         case PRO_REGISTER:
3627                 ret = core_scsi3_emulate_pro_register(cmd,
3628                         res_key, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER);
3629                 break;
3630         case PRO_RESERVE:
3631                 ret = core_scsi3_emulate_pro_reserve(cmd, type, scope, res_key);
3632                 break;
3633         case PRO_RELEASE:
3634                 ret = core_scsi3_emulate_pro_release(cmd, type, scope, res_key);
3635                 break;
3636         case PRO_CLEAR:
3637                 ret = core_scsi3_emulate_pro_clear(cmd, res_key);
3638                 break;
3639         case PRO_PREEMPT:
3640                 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3641                                         res_key, sa_res_key, PREEMPT);
3642                 break;
3643         case PRO_PREEMPT_AND_ABORT:
3644                 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3645                                         res_key, sa_res_key, PREEMPT_AND_ABORT);
3646                 break;
3647         case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
3648                 ret = core_scsi3_emulate_pro_register(cmd,
3649                         0, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER_AND_IGNORE_EXISTING_KEY);
3650                 break;
3651         case PRO_REGISTER_AND_MOVE:
3652                 ret = core_scsi3_emulate_pro_register_and_move(cmd, res_key,
3653                                 sa_res_key, aptpl, unreg);
3654                 break;
3655         default:
3656                 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
3657                         " action: 0x%02x\n", cdb[1] & 0x1f);
3658                 return TCM_INVALID_CDB_FIELD;
3659         }
3660
3661         if (!ret)
3662                 target_complete_cmd(cmd, GOOD);
3663         return ret;
3664 }
3665
3666 /*
3667  * PERSISTENT_RESERVE_IN Service Action READ_KEYS
3668  *
3669  * See spc4r17 section 5.7.6.2 and section 6.13.2, Table 160
3670  */
3671 static sense_reason_t
3672 core_scsi3_pri_read_keys(struct se_cmd *cmd)
3673 {
3674         struct se_device *dev = cmd->se_dev;
3675         struct t10_pr_registration *pr_reg;
3676         unsigned char *buf;
3677         u32 add_len = 0, off = 8;
3678
3679         if (cmd->data_length < 8) {
3680                 pr_err("PRIN SA READ_KEYS SCSI Data Length: %u"
3681                         " too small\n", cmd->data_length);
3682                 return TCM_INVALID_CDB_FIELD;
3683         }
3684
3685         buf = transport_kmap_data_sg(cmd);
3686         if (!buf)
3687                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3688
3689         buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3690         buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3691         buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3692         buf[3] = (dev->t10_pr.pr_generation & 0xff);
3693
3694         spin_lock(&dev->t10_pr.registration_lock);
3695         list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
3696                         pr_reg_list) {
3697                 /*
3698                  * Check for overflow of 8byte PRI READ_KEYS payload and
3699                  * next reservation key list descriptor.
3700                  */
3701                 if ((add_len + 8) > (cmd->data_length - 8))
3702                         break;
3703
3704                 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
3705                 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
3706                 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
3707                 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
3708                 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
3709                 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
3710                 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
3711                 buf[off++] = (pr_reg->pr_res_key & 0xff);
3712
3713                 add_len += 8;
3714         }
3715         spin_unlock(&dev->t10_pr.registration_lock);
3716
3717         buf[4] = ((add_len >> 24) & 0xff);
3718         buf[5] = ((add_len >> 16) & 0xff);
3719         buf[6] = ((add_len >> 8) & 0xff);
3720         buf[7] = (add_len & 0xff);
3721
3722         transport_kunmap_data_sg(cmd);
3723
3724         return 0;
3725 }
3726
3727 /*
3728  * PERSISTENT_RESERVE_IN Service Action READ_RESERVATION
3729  *
3730  * See spc4r17 section 5.7.6.3 and section 6.13.3.2 Table 161 and 162
3731  */
3732 static sense_reason_t
3733 core_scsi3_pri_read_reservation(struct se_cmd *cmd)
3734 {
3735         struct se_device *dev = cmd->se_dev;
3736         struct t10_pr_registration *pr_reg;
3737         unsigned char *buf;
3738         u64 pr_res_key;
3739         u32 add_len = 16; /* Hardcoded to 16 when a reservation is held. */
3740
3741         if (cmd->data_length < 8) {
3742                 pr_err("PRIN SA READ_RESERVATIONS SCSI Data Length: %u"
3743                         " too small\n", cmd->data_length);
3744                 return TCM_INVALID_CDB_FIELD;
3745         }
3746
3747         buf = transport_kmap_data_sg(cmd);
3748         if (!buf)
3749                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3750
3751         buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3752         buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3753         buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3754         buf[3] = (dev->t10_pr.pr_generation & 0xff);
3755
3756         spin_lock(&dev->dev_reservation_lock);
3757         pr_reg = dev->dev_pr_res_holder;
3758         if (pr_reg) {
3759                 /*
3760                  * Set the hardcoded Additional Length
3761                  */
3762                 buf[4] = ((add_len >> 24) & 0xff);
3763                 buf[5] = ((add_len >> 16) & 0xff);
3764                 buf[6] = ((add_len >> 8) & 0xff);
3765                 buf[7] = (add_len & 0xff);
3766
3767                 if (cmd->data_length < 22)
3768                         goto err;
3769
3770                 /*
3771                  * Set the Reservation key.
3772                  *
3773                  * From spc4r17, section 5.7.10:
3774                  * A persistent reservation holder has its reservation key
3775                  * returned in the parameter data from a PERSISTENT
3776                  * RESERVE IN command with READ RESERVATION service action as
3777                  * follows:
3778                  * a) For a persistent reservation of the type Write Exclusive
3779                  *    - All Registrants or Exclusive Access  All Regitrants,
3780                  *      the reservation key shall be set to zero; or
3781                  * b) For all other persistent reservation types, the
3782                  *    reservation key shall be set to the registered
3783                  *    reservation key for the I_T nexus that holds the
3784                  *    persistent reservation.
3785                  */
3786                 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3787                     (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
3788                         pr_res_key = 0;
3789                 else
3790                         pr_res_key = pr_reg->pr_res_key;
3791
3792                 buf[8] = ((pr_res_key >> 56) & 0xff);
3793                 buf[9] = ((pr_res_key >> 48) & 0xff);
3794                 buf[10] = ((pr_res_key >> 40) & 0xff);
3795                 buf[11] = ((pr_res_key >> 32) & 0xff);
3796                 buf[12] = ((pr_res_key >> 24) & 0xff);
3797                 buf[13] = ((pr_res_key >> 16) & 0xff);
3798                 buf[14] = ((pr_res_key >> 8) & 0xff);
3799                 buf[15] = (pr_res_key & 0xff);
3800                 /*
3801                  * Set the SCOPE and TYPE
3802                  */
3803                 buf[21] = (pr_reg->pr_res_scope & 0xf0) |
3804                           (pr_reg->pr_res_type & 0x0f);
3805         }
3806
3807 err:
3808         spin_unlock(&dev->dev_reservation_lock);
3809         transport_kunmap_data_sg(cmd);
3810
3811         return 0;
3812 }
3813
3814 /*
3815  * PERSISTENT_RESERVE_IN Service Action REPORT_CAPABILITIES
3816  *
3817  * See spc4r17 section 6.13.4 Table 165
3818  */
3819 static sense_reason_t
3820 core_scsi3_pri_report_capabilities(struct se_cmd *cmd)
3821 {
3822         struct se_device *dev = cmd->se_dev;
3823         struct t10_reservation *pr_tmpl = &dev->t10_pr;
3824         unsigned char *buf;
3825         u16 add_len = 8; /* Hardcoded to 8. */
3826
3827         if (cmd->data_length < 6) {
3828                 pr_err("PRIN SA REPORT_CAPABILITIES SCSI Data Length:"
3829                         " %u too small\n", cmd->data_length);
3830                 return TCM_INVALID_CDB_FIELD;
3831         }
3832
3833         buf = transport_kmap_data_sg(cmd);
3834         if (!buf)
3835                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3836
3837         buf[0] = ((add_len >> 8) & 0xff);
3838         buf[1] = (add_len & 0xff);
3839         buf[2] |= 0x10; /* CRH: Compatible Reservation Hanlding bit. */
3840         buf[2] |= 0x08; /* SIP_C: Specify Initiator Ports Capable bit */
3841         buf[2] |= 0x04; /* ATP_C: All Target Ports Capable bit */
3842         buf[2] |= 0x01; /* PTPL_C: Persistence across Target Power Loss bit */
3843         /*
3844          * We are filling in the PERSISTENT RESERVATION TYPE MASK below, so
3845          * set the TMV: Task Mask Valid bit.
3846          */
3847         buf[3] |= 0x80;
3848         /*
3849          * Change ALLOW COMMANDs to 0x20 or 0x40 later from Table 166
3850          */
3851         buf[3] |= 0x10; /* ALLOW COMMANDs field 001b */
3852         /*
3853          * PTPL_A: Persistence across Target Power Loss Active bit
3854          */
3855         if (pr_tmpl->pr_aptpl_active)
3856                 buf[3] |= 0x01;
3857         /*
3858          * Setup the PERSISTENT RESERVATION TYPE MASK from Table 167
3859          */
3860         buf[4] |= 0x80; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3861         buf[4] |= 0x40; /* PR_TYPE_EXCLUSIVE_ACCESS_REGONLY */
3862         buf[4] |= 0x20; /* PR_TYPE_WRITE_EXCLUSIVE_REGONLY */
3863         buf[4] |= 0x08; /* PR_TYPE_EXCLUSIVE_ACCESS */
3864         buf[4] |= 0x02; /* PR_TYPE_WRITE_EXCLUSIVE */
3865         buf[5] |= 0x01; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3866
3867         transport_kunmap_data_sg(cmd);
3868
3869         return 0;
3870 }
3871
3872 /*
3873  * PERSISTENT_RESERVE_IN Service Action READ_FULL_STATUS
3874  *
3875  * See spc4r17 section 6.13.5 Table 168 and 169
3876  */
3877 static sense_reason_t
3878 core_scsi3_pri_read_full_status(struct se_cmd *cmd)
3879 {
3880         struct se_device *dev = cmd->se_dev;
3881         struct se_node_acl *se_nacl;
3882         struct se_portal_group *se_tpg;
3883         struct t10_pr_registration *pr_reg, *pr_reg_tmp;
3884         struct t10_reservation *pr_tmpl = &dev->t10_pr;
3885         unsigned char *buf;
3886         u32 add_desc_len = 0, add_len = 0, desc_len, exp_desc_len;
3887         u32 off = 8; /* off into first Full Status descriptor */
3888         int format_code = 0, pr_res_type = 0, pr_res_scope = 0;
3889         bool all_reg = false;
3890
3891         if (cmd->data_length < 8) {
3892                 pr_err("PRIN SA READ_FULL_STATUS SCSI Data Length: %u"
3893                         " too small\n", cmd->data_length);
3894                 return TCM_INVALID_CDB_FIELD;
3895         }
3896
3897         buf = transport_kmap_data_sg(cmd);
3898         if (!buf)
3899                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3900
3901         buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3902         buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3903         buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3904         buf[3] = (dev->t10_pr.pr_generation & 0xff);
3905
3906         spin_lock(&dev->dev_reservation_lock);
3907         if (dev->dev_pr_res_holder) {
3908                 struct t10_pr_registration *pr_holder = dev->dev_pr_res_holder;
3909
3910                 if (pr_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG ||
3911                     pr_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG) {
3912                         all_reg = true;
3913                         pr_res_type = pr_holder->pr_res_type;
3914                         pr_res_scope = pr_holder->pr_res_scope;
3915                 }
3916         }
3917         spin_unlock(&dev->dev_reservation_lock);
3918
3919         spin_lock(&pr_tmpl->registration_lock);
3920         list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3921                         &pr_tmpl->registration_list, pr_reg_list) {
3922
3923                 se_nacl = pr_reg->pr_reg_nacl;
3924                 se_tpg = pr_reg->pr_reg_nacl->se_tpg;
3925                 add_desc_len = 0;
3926
3927                 atomic_inc_mb(&pr_reg->pr_res_holders);
3928                 spin_unlock(&pr_tmpl->registration_lock);
3929                 /*
3930                  * Determine expected length of $FABRIC_MOD specific
3931                  * TransportID full status descriptor..
3932                  */
3933                 exp_desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id_len(
3934                                 se_tpg, se_nacl, pr_reg, &format_code);
3935
3936                 if ((exp_desc_len + add_len) > cmd->data_length) {
3937                         pr_warn("SPC-3 PRIN READ_FULL_STATUS ran"
3938                                 " out of buffer: %d\n", cmd->data_length);
3939                         spin_lock(&pr_tmpl->registration_lock);
3940                         atomic_dec_mb(&pr_reg->pr_res_holders);
3941                         break;
3942                 }
3943                 /*
3944                  * Set RESERVATION KEY
3945                  */
3946                 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
3947                 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
3948                 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
3949                 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
3950                 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
3951                 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
3952                 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
3953                 buf[off++] = (pr_reg->pr_res_key & 0xff);
3954                 off += 4; /* Skip Over Reserved area */
3955
3956                 /*
3957                  * Set ALL_TG_PT bit if PROUT SA REGISTER had this set.
3958                  */
3959                 if (pr_reg->pr_reg_all_tg_pt)
3960                         buf[off] = 0x02;
3961                 /*
3962                  * The struct se_lun pointer will be present for the
3963                  * reservation holder for PR_HOLDER bit.
3964                  *
3965                  * Also, if this registration is the reservation
3966                  * holder or there is an All Registrants reservation
3967                  * active, fill in SCOPE and TYPE in the next byte.
3968                  */
3969                 if (pr_reg->pr_res_holder) {
3970                         buf[off++] |= 0x01;
3971                         buf[off++] = (pr_reg->pr_res_scope & 0xf0) |
3972                                      (pr_reg->pr_res_type & 0x0f);
3973                 } else if (all_reg) {
3974                         buf[off++] |= 0x01;
3975                         buf[off++] = (pr_res_scope & 0xf0) |
3976                                      (pr_res_type & 0x0f);
3977                 } else {
3978                         off += 2;
3979                 }
3980
3981                 off += 4; /* Skip over reserved area */
3982                 /*
3983                  * From spc4r17 6.3.15:
3984                  *
3985                  * If the ALL_TG_PT bit set to zero, the RELATIVE TARGET PORT
3986                  * IDENTIFIER field contains the relative port identifier (see
3987                  * 3.1.120) of the target port that is part of the I_T nexus
3988                  * described by this full status descriptor. If the ALL_TG_PT
3989                  * bit is set to one, the contents of the RELATIVE TARGET PORT
3990                  * IDENTIFIER field are not defined by this standard.
3991                  */
3992                 if (!pr_reg->pr_reg_all_tg_pt) {
3993                         struct se_port *port = pr_reg->pr_reg_tg_pt_lun->lun_sep;
3994
3995                         buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
3996                         buf[off++] = (port->sep_rtpi & 0xff);
3997                 } else
3998                         off += 2; /* Skip over RELATIVE TARGET PORT IDENTIFIER */
3999
4000                 /*
4001                  * Now, have the $FABRIC_MOD fill in the protocol identifier
4002                  */
4003                 desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id(se_tpg,
4004                                 se_nacl, pr_reg, &format_code, &buf[off+4]);
4005
4006                 spin_lock(&pr_tmpl->registration_lock);
4007                 atomic_dec_mb(&pr_reg->pr_res_holders);
4008                 /*
4009                  * Set the ADDITIONAL DESCRIPTOR LENGTH
4010                  */
4011                 buf[off++] = ((desc_len >> 24) & 0xff);
4012                 buf[off++] = ((desc_len >> 16) & 0xff);
4013                 buf[off++] = ((desc_len >> 8) & 0xff);
4014                 buf[off++] = (desc_len & 0xff);
4015                 /*
4016                  * Size of full desctipor header minus TransportID
4017                  * containing $FABRIC_MOD specific) initiator device/port
4018                  * WWN information.
4019                  *
4020                  *  See spc4r17 Section 6.13.5 Table 169
4021                  */
4022                 add_desc_len = (24 + desc_len);
4023
4024                 off += desc_len;
4025                 add_len += add_desc_len;
4026         }
4027         spin_unlock(&pr_tmpl->registration_lock);
4028         /*
4029          * Set ADDITIONAL_LENGTH
4030          */
4031         buf[4] = ((add_len >> 24) & 0xff);
4032         buf[5] = ((add_len >> 16) & 0xff);
4033         buf[6] = ((add_len >> 8) & 0xff);
4034         buf[7] = (add_len & 0xff);
4035
4036         transport_kunmap_data_sg(cmd);
4037
4038         return 0;
4039 }
4040
4041 sense_reason_t
4042 target_scsi3_emulate_pr_in(struct se_cmd *cmd)
4043 {
4044         sense_reason_t ret;
4045
4046         /*
4047          * Following spc2r20 5.5.1 Reservations overview:
4048          *
4049          * If a logical unit has been reserved by any RESERVE command and is
4050          * still reserved by any initiator, all PERSISTENT RESERVE IN and all
4051          * PERSISTENT RESERVE OUT commands shall conflict regardless of
4052          * initiator or service action and shall terminate with a RESERVATION
4053          * CONFLICT status.
4054          */
4055         if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
4056                 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
4057                         " SPC-2 reservation is held, returning"
4058                         " RESERVATION_CONFLICT\n");
4059                 return TCM_RESERVATION_CONFLICT;
4060         }
4061
4062         switch (cmd->t_task_cdb[1] & 0x1f) {
4063         case PRI_READ_KEYS:
4064                 ret = core_scsi3_pri_read_keys(cmd);
4065                 break;
4066         case PRI_READ_RESERVATION:
4067                 ret = core_scsi3_pri_read_reservation(cmd);
4068                 break;
4069         case PRI_REPORT_CAPABILITIES:
4070                 ret = core_scsi3_pri_report_capabilities(cmd);
4071                 break;
4072         case PRI_READ_FULL_STATUS:
4073                 ret = core_scsi3_pri_read_full_status(cmd);
4074                 break;
4075         default:
4076                 pr_err("Unknown PERSISTENT_RESERVE_IN service"
4077                         " action: 0x%02x\n", cmd->t_task_cdb[1] & 0x1f);
4078                 return TCM_INVALID_CDB_FIELD;
4079         }
4080
4081         if (!ret)
4082                 target_complete_cmd(cmd, GOOD);
4083         return ret;
4084 }
4085
4086 sense_reason_t
4087 target_check_reservation(struct se_cmd *cmd)
4088 {
4089         struct se_device *dev = cmd->se_dev;
4090         sense_reason_t ret;
4091
4092         if (!cmd->se_sess)
4093                 return 0;
4094         if (dev->se_hba->hba_flags & HBA_FLAGS_INTERNAL_USE)
4095                 return 0;
4096         if (dev->transport->transport_flags & TRANSPORT_FLAG_PASSTHROUGH)
4097                 return 0;
4098
4099         spin_lock(&dev->dev_reservation_lock);
4100         if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
4101                 ret = target_scsi2_reservation_check(cmd);
4102         else
4103                 ret = target_scsi3_pr_reservation_check(cmd);
4104         spin_unlock(&dev->dev_reservation_lock);
4105
4106         return ret;
4107 }