1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (C) 2008-2012 Daisuke Aoyama <aoyama@peach.ne.jp>. 5 * Copyright (c) Intel Corporation. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * * Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * * Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in 16 * the documentation and/or other materials provided with the 17 * distribution. 18 * * Neither the name of Intel Corporation nor the names of its 19 * contributors may be used to endorse or promote products derived 20 * from this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 #include "spdk/stdinc.h" 36 #include "spdk/env.h" 37 #include "spdk/string.h" 38 #include "spdk/sock.h" 39 #include "spdk/likely.h" 40 41 #include "iscsi/iscsi.h" 42 #include "iscsi/init_grp.h" 43 #include "iscsi/portal_grp.h" 44 #include "iscsi/conn.h" 45 #include "iscsi/task.h" 46 47 #include "spdk_internal/event.h" 48 #include "spdk_internal/log.h" 49 50 struct spdk_iscsi_opts *g_spdk_iscsi_opts = NULL; 51 52 static spdk_iscsi_init_cb g_init_cb_fn = NULL; 53 static void *g_init_cb_arg = NULL; 54 55 static spdk_iscsi_fini_cb g_fini_cb_fn; 56 static void *g_fini_cb_arg; 57 58 #define ISCSI_CONFIG_TMPL \ 59 "[iSCSI]\n" \ 60 " # node name (not include optional part)\n" \ 61 " # Users can optionally change this to fit their environment.\n" \ 62 " NodeBase \"%s\"\n" \ 63 "\n" \ 64 " # files\n" \ 65 " %s %s\n" \ 66 "\n" \ 67 " # socket I/O timeout sec. (polling is infinity)\n" \ 68 " Timeout %d\n" \ 69 "\n" \ 70 " # authentication information for discovery session\n" \ 71 " DiscoveryAuthMethod %s\n" \ 72 " DiscoveryAuthGroup %s\n" \ 73 "\n" \ 74 " MaxSessions %d\n" \ 75 " MaxConnectionsPerSession %d\n" \ 76 " MaxConnections %d\n" \ 77 " MaxQueueDepth %d\n" \ 78 "\n" \ 79 " # iSCSI initial parameters negotiate with initiators\n" \ 80 " # NOTE: incorrect values might crash\n" \ 81 " DefaultTime2Wait %d\n" \ 82 " DefaultTime2Retain %d\n" \ 83 "\n" \ 84 " FirstBurstLength %d\n" \ 85 " ImmediateData %s\n" \ 86 " ErrorRecoveryLevel %d\n" \ 87 "\n" 88 89 static void 90 iscsi_globals_config_text(FILE *fp) 91 { 92 const char *authmethod = "None"; 93 char authgroup[32] = "None"; 94 95 if (NULL == fp) { 96 return; 97 } 98 99 if (g_spdk_iscsi.require_chap) { 100 authmethod = "CHAP"; 101 } else if (g_spdk_iscsi.mutual_chap) { 102 authmethod = "CHAP Mutual"; 103 } else if (!g_spdk_iscsi.disable_chap) { 104 authmethod = "Auto"; 105 } 106 107 if (g_spdk_iscsi.chap_group) { 108 snprintf(authgroup, sizeof(authgroup), "AuthGroup%d", g_spdk_iscsi.chap_group); 109 } 110 111 fprintf(fp, ISCSI_CONFIG_TMPL, 112 g_spdk_iscsi.nodebase, 113 g_spdk_iscsi.authfile ? "AuthFile" : "", 114 g_spdk_iscsi.authfile ? g_spdk_iscsi.authfile : "", 115 g_spdk_iscsi.timeout, authmethod, authgroup, 116 g_spdk_iscsi.MaxSessions, g_spdk_iscsi.MaxConnectionsPerSession, 117 g_spdk_iscsi.MaxConnections, 118 g_spdk_iscsi.MaxQueueDepth, 119 g_spdk_iscsi.DefaultTime2Wait, g_spdk_iscsi.DefaultTime2Retain, 120 g_spdk_iscsi.FirstBurstLength, 121 (g_spdk_iscsi.ImmediateData) ? "Yes" : "No", 122 g_spdk_iscsi.ErrorRecoveryLevel); 123 } 124 125 #define ISCSI_DATA_BUFFER_ALIGNMENT (0x1000) 126 #define ISCSI_DATA_BUFFER_MASK (ISCSI_DATA_BUFFER_ALIGNMENT - 1) 127 128 static void 129 mobj_ctor(struct spdk_mempool *mp, __attribute__((unused)) void *arg, 130 void *_m, __attribute__((unused)) unsigned i) 131 { 132 struct spdk_mobj *m = _m; 133 134 m->mp = mp; 135 m->buf = (uint8_t *)m + sizeof(struct spdk_mobj); 136 m->buf = (void *)((unsigned long)((uint8_t *)m->buf + ISCSI_DATA_BUFFER_ALIGNMENT) & 137 ~ISCSI_DATA_BUFFER_MASK); 138 } 139 140 #define NUM_PDU_PER_CONNECTION(iscsi) (2 * (iscsi->MaxQueueDepth + MAX_LARGE_DATAIN_PER_CONNECTION + 8)) 141 #define PDU_POOL_SIZE(iscsi) (iscsi->MaxConnections * NUM_PDU_PER_CONNECTION(iscsi)) 142 #define IMMEDIATE_DATA_POOL_SIZE(iscsi) (iscsi->MaxConnections * 128) 143 #define DATA_OUT_POOL_SIZE(iscsi) (iscsi->MaxConnections * MAX_DATA_OUT_PER_CONNECTION) 144 145 static int 146 iscsi_initialize_pdu_pool(void) 147 { 148 struct spdk_iscsi_globals *iscsi = &g_spdk_iscsi; 149 int imm_mobj_size = SPDK_BDEV_BUF_SIZE_WITH_MD(spdk_get_max_immediate_data_size()) + 150 sizeof(struct spdk_mobj) + ISCSI_DATA_BUFFER_ALIGNMENT; 151 int dout_mobj_size = SPDK_BDEV_BUF_SIZE_WITH_MD(SPDK_ISCSI_MAX_RECV_DATA_SEGMENT_LENGTH) + 152 sizeof(struct spdk_mobj) + ISCSI_DATA_BUFFER_ALIGNMENT; 153 154 /* create PDU pool */ 155 iscsi->pdu_pool = spdk_mempool_create("PDU_Pool", 156 PDU_POOL_SIZE(iscsi), 157 sizeof(struct spdk_iscsi_pdu), 158 256, SPDK_ENV_SOCKET_ID_ANY); 159 if (!iscsi->pdu_pool) { 160 SPDK_ERRLOG("create PDU pool failed\n"); 161 return -1; 162 } 163 164 iscsi->pdu_immediate_data_pool = spdk_mempool_create_ctor("PDU_immediate_data_Pool", 165 IMMEDIATE_DATA_POOL_SIZE(iscsi), 166 imm_mobj_size, 256, 167 SPDK_ENV_SOCKET_ID_ANY, 168 mobj_ctor, NULL); 169 if (!iscsi->pdu_immediate_data_pool) { 170 SPDK_ERRLOG("create PDU immediate data pool failed\n"); 171 return -1; 172 } 173 174 iscsi->pdu_data_out_pool = spdk_mempool_create_ctor("PDU_data_out_Pool", 175 DATA_OUT_POOL_SIZE(iscsi), 176 dout_mobj_size, 256, 177 SPDK_ENV_SOCKET_ID_ANY, 178 mobj_ctor, NULL); 179 if (!iscsi->pdu_data_out_pool) { 180 SPDK_ERRLOG("create PDU data out pool failed\n"); 181 return -1; 182 } 183 184 return 0; 185 } 186 187 static void 188 iscsi_sess_ctor(struct spdk_mempool *pool, void *arg, void *session_buf, 189 unsigned index) 190 { 191 struct spdk_iscsi_globals *iscsi = arg; 192 struct spdk_iscsi_sess *sess = session_buf; 193 194 iscsi->session[index] = sess; 195 196 /* tsih 0 is reserved, so start tsih values at 1. */ 197 sess->tsih = index + 1; 198 } 199 200 #define DEFAULT_TASK_POOL_SIZE 32768 201 202 static int 203 iscsi_initialize_task_pool(void) 204 { 205 struct spdk_iscsi_globals *iscsi = &g_spdk_iscsi; 206 207 /* create scsi_task pool */ 208 iscsi->task_pool = spdk_mempool_create("SCSI_TASK_Pool", 209 DEFAULT_TASK_POOL_SIZE, 210 sizeof(struct spdk_iscsi_task), 211 128, SPDK_ENV_SOCKET_ID_ANY); 212 if (!iscsi->task_pool) { 213 SPDK_ERRLOG("create task pool failed\n"); 214 return -1; 215 } 216 217 return 0; 218 } 219 220 #define SESSION_POOL_SIZE(iscsi) (iscsi->MaxSessions) 221 static int 222 iscsi_initialize_session_pool(void) 223 { 224 struct spdk_iscsi_globals *iscsi = &g_spdk_iscsi; 225 226 iscsi->session_pool = spdk_mempool_create_ctor("Session_Pool", 227 SESSION_POOL_SIZE(iscsi), 228 sizeof(struct spdk_iscsi_sess), 0, 229 SPDK_ENV_SOCKET_ID_ANY, 230 iscsi_sess_ctor, iscsi); 231 if (!iscsi->session_pool) { 232 SPDK_ERRLOG("create session pool failed\n"); 233 return -1; 234 } 235 236 return 0; 237 } 238 239 static int 240 iscsi_initialize_all_pools(void) 241 { 242 if (iscsi_initialize_pdu_pool() != 0) { 243 return -1; 244 } 245 246 if (iscsi_initialize_session_pool() != 0) { 247 return -1; 248 } 249 250 if (iscsi_initialize_task_pool() != 0) { 251 return -1; 252 } 253 254 return 0; 255 } 256 257 static void 258 iscsi_check_pool(struct spdk_mempool *pool, size_t count) 259 { 260 if (pool && spdk_mempool_count(pool) != count) { 261 SPDK_ERRLOG("spdk_mempool_count(%s) == %zu, should be %zu\n", 262 spdk_mempool_get_name(pool), spdk_mempool_count(pool), count); 263 } 264 } 265 266 static void 267 iscsi_check_pools(void) 268 { 269 struct spdk_iscsi_globals *iscsi = &g_spdk_iscsi; 270 271 iscsi_check_pool(iscsi->pdu_pool, PDU_POOL_SIZE(iscsi)); 272 iscsi_check_pool(iscsi->session_pool, SESSION_POOL_SIZE(iscsi)); 273 iscsi_check_pool(iscsi->pdu_immediate_data_pool, IMMEDIATE_DATA_POOL_SIZE(iscsi)); 274 iscsi_check_pool(iscsi->pdu_data_out_pool, DATA_OUT_POOL_SIZE(iscsi)); 275 iscsi_check_pool(iscsi->task_pool, DEFAULT_TASK_POOL_SIZE); 276 } 277 278 static void 279 iscsi_free_pools(void) 280 { 281 struct spdk_iscsi_globals *iscsi = &g_spdk_iscsi; 282 283 spdk_mempool_free(iscsi->pdu_pool); 284 spdk_mempool_free(iscsi->session_pool); 285 spdk_mempool_free(iscsi->pdu_immediate_data_pool); 286 spdk_mempool_free(iscsi->pdu_data_out_pool); 287 spdk_mempool_free(iscsi->task_pool); 288 } 289 290 void spdk_put_pdu(struct spdk_iscsi_pdu *pdu) 291 { 292 if (!pdu) { 293 return; 294 } 295 296 pdu->ref--; 297 298 if (pdu->ref < 0) { 299 SPDK_ERRLOG("Negative PDU refcount: %p\n", pdu); 300 pdu->ref = 0; 301 } 302 303 if (pdu->ref == 0) { 304 if (pdu->mobj) { 305 spdk_mempool_put(pdu->mobj->mp, (void *)pdu->mobj); 306 } 307 308 if (pdu->data && !pdu->data_from_mempool) { 309 free(pdu->data); 310 } 311 312 spdk_mempool_put(g_spdk_iscsi.pdu_pool, (void *)pdu); 313 } 314 } 315 316 struct spdk_iscsi_pdu *spdk_get_pdu(void) 317 { 318 struct spdk_iscsi_pdu *pdu; 319 320 pdu = spdk_mempool_get(g_spdk_iscsi.pdu_pool); 321 if (!pdu) { 322 SPDK_ERRLOG("Unable to get PDU\n"); 323 abort(); 324 } 325 326 /* we do not want to zero out the last part of the structure reserved for AHS and sense data */ 327 memset(pdu, 0, offsetof(struct spdk_iscsi_pdu, ahs)); 328 pdu->ref = 1; 329 330 return pdu; 331 } 332 333 static void 334 iscsi_log_globals(void) 335 { 336 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "AuthFile %s\n", 337 g_spdk_iscsi.authfile ? g_spdk_iscsi.authfile : "(none)"); 338 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "NodeBase %s\n", g_spdk_iscsi.nodebase); 339 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "MaxSessions %d\n", g_spdk_iscsi.MaxSessions); 340 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "MaxConnectionsPerSession %d\n", 341 g_spdk_iscsi.MaxConnectionsPerSession); 342 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "MaxQueueDepth %d\n", g_spdk_iscsi.MaxQueueDepth); 343 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "DefaultTime2Wait %d\n", 344 g_spdk_iscsi.DefaultTime2Wait); 345 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "DefaultTime2Retain %d\n", 346 g_spdk_iscsi.DefaultTime2Retain); 347 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "FirstBurstLength %d\n", 348 g_spdk_iscsi.FirstBurstLength); 349 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "ImmediateData %s\n", 350 g_spdk_iscsi.ImmediateData ? "Yes" : "No"); 351 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "AllowDuplicateIsid %s\n", 352 g_spdk_iscsi.AllowDuplicateIsid ? "Yes" : "No"); 353 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "ErrorRecoveryLevel %d\n", 354 g_spdk_iscsi.ErrorRecoveryLevel); 355 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "Timeout %d\n", g_spdk_iscsi.timeout); 356 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "NopInInterval %d\n", 357 g_spdk_iscsi.nopininterval); 358 if (g_spdk_iscsi.disable_chap) { 359 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, 360 "DiscoveryAuthMethod None\n"); 361 } else if (!g_spdk_iscsi.require_chap) { 362 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, 363 "DiscoveryAuthMethod Auto\n"); 364 } else { 365 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, 366 "DiscoveryAuthMethod %s %s\n", 367 g_spdk_iscsi.require_chap ? "CHAP" : "", 368 g_spdk_iscsi.mutual_chap ? "Mutual" : ""); 369 } 370 371 if (g_spdk_iscsi.chap_group == 0) { 372 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, 373 "DiscoveryAuthGroup None\n"); 374 } else { 375 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, 376 "DiscoveryAuthGroup AuthGroup%d\n", 377 g_spdk_iscsi.chap_group); 378 } 379 380 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "MinConnectionsPerCore%d\n", 381 spdk_iscsi_conn_get_min_per_core()); 382 } 383 384 static void 385 iscsi_opts_init(struct spdk_iscsi_opts *opts) 386 { 387 opts->MaxSessions = DEFAULT_MAX_SESSIONS; 388 opts->MaxConnectionsPerSession = DEFAULT_MAX_CONNECTIONS_PER_SESSION; 389 opts->MaxQueueDepth = DEFAULT_MAX_QUEUE_DEPTH; 390 opts->DefaultTime2Wait = DEFAULT_DEFAULTTIME2WAIT; 391 opts->DefaultTime2Retain = DEFAULT_DEFAULTTIME2RETAIN; 392 opts->FirstBurstLength = SPDK_ISCSI_FIRST_BURST_LENGTH; 393 opts->ImmediateData = DEFAULT_IMMEDIATEDATA; 394 opts->AllowDuplicateIsid = false; 395 opts->ErrorRecoveryLevel = DEFAULT_ERRORRECOVERYLEVEL; 396 opts->timeout = DEFAULT_TIMEOUT; 397 opts->nopininterval = DEFAULT_NOPININTERVAL; 398 opts->disable_chap = false; 399 opts->require_chap = false; 400 opts->mutual_chap = false; 401 opts->chap_group = 0; 402 opts->authfile = NULL; 403 opts->nodebase = NULL; 404 opts->min_connections_per_core = DEFAULT_CONNECTIONS_PER_LCORE; 405 } 406 407 struct spdk_iscsi_opts * 408 spdk_iscsi_opts_alloc(void) 409 { 410 struct spdk_iscsi_opts *opts; 411 412 opts = calloc(1, sizeof(*opts)); 413 if (!opts) { 414 SPDK_ERRLOG("calloc() failed for iscsi options\n"); 415 return NULL; 416 } 417 418 iscsi_opts_init(opts); 419 420 return opts; 421 } 422 423 void 424 spdk_iscsi_opts_free(struct spdk_iscsi_opts *opts) 425 { 426 free(opts->authfile); 427 free(opts->nodebase); 428 free(opts); 429 } 430 431 /* Deep copy of spdk_iscsi_opts */ 432 struct spdk_iscsi_opts * 433 spdk_iscsi_opts_copy(struct spdk_iscsi_opts *src) 434 { 435 struct spdk_iscsi_opts *dst; 436 437 dst = calloc(1, sizeof(*dst)); 438 if (!dst) { 439 SPDK_ERRLOG("calloc() failed for iscsi options\n"); 440 return NULL; 441 } 442 443 if (src->authfile) { 444 dst->authfile = strdup(src->authfile); 445 if (!dst->authfile) { 446 free(dst); 447 SPDK_ERRLOG("failed to strdup for auth file %s\n", src->authfile); 448 return NULL; 449 } 450 } 451 452 if (src->nodebase) { 453 dst->nodebase = strdup(src->nodebase); 454 if (!dst->nodebase) { 455 free(dst->authfile); 456 free(dst); 457 SPDK_ERRLOG("failed to strdup for nodebase %s\n", src->nodebase); 458 return NULL; 459 } 460 } 461 462 dst->MaxSessions = src->MaxSessions; 463 dst->MaxConnectionsPerSession = src->MaxConnectionsPerSession; 464 dst->MaxQueueDepth = src->MaxQueueDepth; 465 dst->DefaultTime2Wait = src->DefaultTime2Wait; 466 dst->DefaultTime2Retain = src->DefaultTime2Retain; 467 dst->FirstBurstLength = src->FirstBurstLength; 468 dst->ImmediateData = src->ImmediateData; 469 dst->AllowDuplicateIsid = src->AllowDuplicateIsid; 470 dst->ErrorRecoveryLevel = src->ErrorRecoveryLevel; 471 dst->timeout = src->timeout; 472 dst->nopininterval = src->nopininterval; 473 dst->disable_chap = src->disable_chap; 474 dst->require_chap = src->require_chap; 475 dst->mutual_chap = src->mutual_chap; 476 dst->chap_group = src->chap_group; 477 dst->min_connections_per_core = src->min_connections_per_core; 478 479 return dst; 480 } 481 482 static int 483 iscsi_read_config_file_params(struct spdk_conf_section *sp, 484 struct spdk_iscsi_opts *opts) 485 { 486 const char *val; 487 int MaxSessions; 488 int MaxConnectionsPerSession; 489 int MaxQueueDepth; 490 int DefaultTime2Wait; 491 int DefaultTime2Retain; 492 int FirstBurstLength; 493 int ErrorRecoveryLevel; 494 int timeout; 495 int nopininterval; 496 int min_conn_per_core = 0; 497 const char *ag_tag; 498 int ag_tag_i; 499 int i; 500 501 val = spdk_conf_section_get_val(sp, "Comment"); 502 if (val != NULL) { 503 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "Comment %s\n", val); 504 } 505 506 val = spdk_conf_section_get_val(sp, "AuthFile"); 507 if (val != NULL) { 508 opts->authfile = strdup(val); 509 if (!opts->authfile) { 510 SPDK_ERRLOG("strdup() failed for AuthFile\n"); 511 return -ENOMEM; 512 } 513 } 514 515 val = spdk_conf_section_get_val(sp, "NodeBase"); 516 if (val != NULL) { 517 opts->nodebase = strdup(val); 518 if (!opts->nodebase) { 519 free(opts->authfile); 520 SPDK_ERRLOG("strdup() failed for NodeBase\n"); 521 return -ENOMEM; 522 } 523 } 524 525 MaxSessions = spdk_conf_section_get_intval(sp, "MaxSessions"); 526 if (MaxSessions >= 0) { 527 opts->MaxSessions = MaxSessions; 528 } 529 530 MaxConnectionsPerSession = spdk_conf_section_get_intval(sp, "MaxConnectionsPerSession"); 531 if (MaxConnectionsPerSession >= 0) { 532 opts->MaxConnectionsPerSession = MaxConnectionsPerSession; 533 } 534 535 MaxQueueDepth = spdk_conf_section_get_intval(sp, "MaxQueueDepth"); 536 if (MaxQueueDepth >= 0) { 537 opts->MaxQueueDepth = MaxQueueDepth; 538 } 539 540 DefaultTime2Wait = spdk_conf_section_get_intval(sp, "DefaultTime2Wait"); 541 if (DefaultTime2Wait >= 0) { 542 opts->DefaultTime2Wait = DefaultTime2Wait; 543 } 544 545 DefaultTime2Retain = spdk_conf_section_get_intval(sp, "DefaultTime2Retain"); 546 if (DefaultTime2Retain >= 0) { 547 opts->DefaultTime2Retain = DefaultTime2Retain; 548 } 549 550 FirstBurstLength = spdk_conf_section_get_intval(sp, "FirstBurstLength"); 551 if (FirstBurstLength >= 0) { 552 opts->FirstBurstLength = FirstBurstLength; 553 } 554 555 opts->ImmediateData = spdk_conf_section_get_boolval(sp, "ImmediateData", 556 opts->ImmediateData); 557 558 /* This option is only for test. 559 * If AllowDuplicateIsid is enabled, it allows different connections carrying 560 * TSIH=0 login the target within the same session. 561 */ 562 opts->AllowDuplicateIsid = spdk_conf_section_get_boolval(sp, "AllowDuplicateIsid", 563 opts->AllowDuplicateIsid); 564 565 ErrorRecoveryLevel = spdk_conf_section_get_intval(sp, "ErrorRecoveryLevel"); 566 if (ErrorRecoveryLevel >= 0) { 567 opts->ErrorRecoveryLevel = ErrorRecoveryLevel; 568 } 569 timeout = spdk_conf_section_get_intval(sp, "Timeout"); 570 if (timeout >= 0) { 571 opts->timeout = timeout; 572 } 573 nopininterval = spdk_conf_section_get_intval(sp, "NopInInterval"); 574 if (nopininterval >= 0) { 575 opts->nopininterval = nopininterval; 576 } 577 val = spdk_conf_section_get_val(sp, "DiscoveryAuthMethod"); 578 if (val != NULL) { 579 for (i = 0; ; i++) { 580 val = spdk_conf_section_get_nmval(sp, "DiscoveryAuthMethod", 0, i); 581 if (val == NULL) { 582 break; 583 } 584 if (strcasecmp(val, "CHAP") == 0) { 585 opts->require_chap = true; 586 } else if (strcasecmp(val, "Mutual") == 0) { 587 opts->require_chap = true; 588 opts->mutual_chap = true; 589 } else if (strcasecmp(val, "Auto") == 0) { 590 opts->disable_chap = false; 591 opts->require_chap = false; 592 opts->mutual_chap = false; 593 } else if (strcasecmp(val, "None") == 0) { 594 opts->disable_chap = true; 595 opts->require_chap = false; 596 opts->mutual_chap = false; 597 } else { 598 SPDK_ERRLOG("unknown CHAP mode %s\n", val); 599 } 600 } 601 if (opts->mutual_chap && !opts->require_chap) { 602 free(opts->authfile); 603 free(opts->nodebase); 604 SPDK_ERRLOG("CHAP must set to be required when using mutual CHAP.\n"); 605 return -EINVAL; 606 } 607 } 608 val = spdk_conf_section_get_val(sp, "DiscoveryAuthGroup"); 609 if (val != NULL) { 610 ag_tag = val; 611 if (strcasecmp(ag_tag, "None") == 0) { 612 opts->chap_group = 0; 613 } else { 614 if (strncasecmp(ag_tag, "AuthGroup", 615 strlen("AuthGroup")) != 0 616 || sscanf(ag_tag, "%*[^0-9]%d", &ag_tag_i) != 1 617 || ag_tag_i == 0) { 618 SPDK_ERRLOG("invalid auth group %s, ignoring\n", ag_tag); 619 } else { 620 opts->chap_group = ag_tag_i; 621 } 622 } 623 } 624 min_conn_per_core = spdk_conf_section_get_intval(sp, "MinConnectionsPerCore"); 625 if (min_conn_per_core >= 0) { 626 opts->min_connections_per_core = min_conn_per_core; 627 } 628 629 return 0; 630 } 631 632 static int 633 iscsi_opts_verify(struct spdk_iscsi_opts *opts) 634 { 635 if (!opts->nodebase) { 636 opts->nodebase = strdup(SPDK_ISCSI_DEFAULT_NODEBASE); 637 if (opts->nodebase == NULL) { 638 SPDK_ERRLOG("strdup() failed for default nodebase\n"); 639 return -ENOMEM; 640 } 641 } 642 643 if (opts->MaxSessions == 0 || opts->MaxSessions > 65535) { 644 SPDK_ERRLOG("%d is invalid. MaxSessions must be more than 0 and no more than 65535\n", 645 opts->MaxSessions); 646 return -EINVAL; 647 } 648 649 if (opts->MaxConnectionsPerSession == 0 || opts->MaxConnectionsPerSession > 65535) { 650 SPDK_ERRLOG("%d is invalid. MaxConnectionsPerSession must be more than 0 and no more than 65535\n", 651 opts->MaxConnectionsPerSession); 652 return -EINVAL; 653 } 654 655 if (opts->MaxQueueDepth == 0 || opts->MaxQueueDepth > 256) { 656 SPDK_ERRLOG("%d is invalid. MaxQueueDepth must be more than 0 and no more than 256\n", 657 opts->MaxQueueDepth); 658 return -EINVAL; 659 } 660 661 if (opts->DefaultTime2Wait > 3600) { 662 SPDK_ERRLOG("%d is invalid. DefaultTime2Wait must be no more than 3600\n", 663 opts->DefaultTime2Wait); 664 return -EINVAL; 665 } 666 667 if (opts->DefaultTime2Retain > 3600) { 668 SPDK_ERRLOG("%d is invalid. DefaultTime2Retain must be no more than 3600\n", 669 opts->DefaultTime2Retain); 670 return -EINVAL; 671 } 672 673 if (opts->FirstBurstLength >= SPDK_ISCSI_MIN_FIRST_BURST_LENGTH) { 674 if (opts->FirstBurstLength > SPDK_ISCSI_MAX_BURST_LENGTH) { 675 SPDK_ERRLOG("FirstBurstLength %d shall not exceed MaxBurstLength %d\n", 676 opts->FirstBurstLength, SPDK_ISCSI_MAX_BURST_LENGTH); 677 return -EINVAL; 678 } 679 } else { 680 SPDK_ERRLOG("FirstBurstLength %d shall be no less than %d\n", 681 opts->FirstBurstLength, SPDK_ISCSI_MIN_FIRST_BURST_LENGTH); 682 return -EINVAL; 683 } 684 685 if (opts->ErrorRecoveryLevel > 2) { 686 SPDK_ERRLOG("ErrorRecoveryLevel %d is not supported.\n", opts->ErrorRecoveryLevel); 687 return -EINVAL; 688 } 689 690 if (opts->timeout < 0) { 691 SPDK_ERRLOG("%d is invalid. timeout must not be less than 0\n", opts->timeout); 692 return -EINVAL; 693 } 694 695 if (opts->nopininterval < 0 || opts->nopininterval > MAX_NOPININTERVAL) { 696 SPDK_ERRLOG("%d is invalid. nopinterval must be between 0 and %d\n", 697 opts->nopininterval, MAX_NOPININTERVAL); 698 return -EINVAL; 699 } 700 701 if (!spdk_iscsi_check_chap_params(opts->disable_chap, opts->require_chap, 702 opts->mutual_chap, opts->chap_group)) { 703 SPDK_ERRLOG("CHAP params in opts are illegal combination\n"); 704 return -EINVAL; 705 } 706 707 return 0; 708 } 709 710 static int 711 iscsi_parse_options(struct spdk_iscsi_opts **popts) 712 { 713 struct spdk_iscsi_opts *opts; 714 struct spdk_conf_section *sp; 715 int rc; 716 717 opts = spdk_iscsi_opts_alloc(); 718 if (!opts) { 719 SPDK_ERRLOG("spdk_iscsi_opts_alloc_failed() failed\n"); 720 return -ENOMEM; 721 } 722 723 /* Process parameters */ 724 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "iscsi_read_config_file_parmas\n"); 725 sp = spdk_conf_find_section(NULL, "iSCSI"); 726 if (sp != NULL) { 727 rc = iscsi_read_config_file_params(sp, opts); 728 if (rc != 0) { 729 free(opts); 730 SPDK_ERRLOG("iscsi_read_config_file_params() failed\n"); 731 return rc; 732 } 733 } 734 735 *popts = opts; 736 737 return 0; 738 } 739 740 static int 741 iscsi_set_global_params(struct spdk_iscsi_opts *opts) 742 { 743 int rc; 744 745 rc = iscsi_opts_verify(opts); 746 if (rc != 0) { 747 SPDK_ERRLOG("spdk_iscsi_opts_verify() failed\n"); 748 return rc; 749 } 750 751 if (opts->authfile != NULL) { 752 g_spdk_iscsi.authfile = strdup(opts->authfile); 753 if (!g_spdk_iscsi.authfile) { 754 SPDK_ERRLOG("failed to strdup for auth file %s\n", opts->authfile); 755 return -ENOMEM; 756 } 757 } 758 759 g_spdk_iscsi.nodebase = strdup(opts->nodebase); 760 if (!g_spdk_iscsi.nodebase) { 761 SPDK_ERRLOG("failed to strdup for nodebase %s\n", opts->nodebase); 762 return -ENOMEM; 763 } 764 765 g_spdk_iscsi.MaxSessions = opts->MaxSessions; 766 g_spdk_iscsi.MaxConnectionsPerSession = opts->MaxConnectionsPerSession; 767 g_spdk_iscsi.MaxQueueDepth = opts->MaxQueueDepth; 768 g_spdk_iscsi.DefaultTime2Wait = opts->DefaultTime2Wait; 769 g_spdk_iscsi.DefaultTime2Retain = opts->DefaultTime2Retain; 770 g_spdk_iscsi.FirstBurstLength = opts->FirstBurstLength; 771 g_spdk_iscsi.ImmediateData = opts->ImmediateData; 772 g_spdk_iscsi.AllowDuplicateIsid = opts->AllowDuplicateIsid; 773 g_spdk_iscsi.ErrorRecoveryLevel = opts->ErrorRecoveryLevel; 774 g_spdk_iscsi.timeout = opts->timeout; 775 g_spdk_iscsi.nopininterval = opts->nopininterval; 776 g_spdk_iscsi.disable_chap = opts->disable_chap; 777 g_spdk_iscsi.require_chap = opts->require_chap; 778 g_spdk_iscsi.mutual_chap = opts->mutual_chap; 779 g_spdk_iscsi.chap_group = opts->chap_group; 780 781 spdk_iscsi_conn_set_min_per_core(opts->min_connections_per_core); 782 783 iscsi_log_globals(); 784 785 return 0; 786 } 787 788 int 789 spdk_iscsi_set_discovery_auth(bool disable_chap, bool require_chap, bool mutual_chap, 790 int32_t chap_group) 791 { 792 if (!spdk_iscsi_check_chap_params(disable_chap, require_chap, mutual_chap, 793 chap_group)) { 794 SPDK_ERRLOG("CHAP params are illegal combination\n"); 795 return -EINVAL; 796 } 797 798 pthread_mutex_lock(&g_spdk_iscsi.mutex); 799 g_spdk_iscsi.disable_chap = disable_chap; 800 g_spdk_iscsi.require_chap = require_chap; 801 g_spdk_iscsi.mutual_chap = mutual_chap; 802 g_spdk_iscsi.chap_group = chap_group; 803 pthread_mutex_unlock(&g_spdk_iscsi.mutex); 804 805 return 0; 806 } 807 808 int 809 spdk_iscsi_auth_group_add_secret(struct spdk_iscsi_auth_group *group, 810 const char *user, const char *secret, 811 const char *muser, const char *msecret) 812 { 813 struct spdk_iscsi_auth_secret *_secret; 814 size_t len; 815 816 if (user == NULL || secret == NULL) { 817 SPDK_ERRLOG("user and secret must be specified\n"); 818 return -EINVAL; 819 } 820 821 if (muser != NULL && msecret == NULL) { 822 SPDK_ERRLOG("msecret must be specified with muser\n"); 823 return -EINVAL; 824 } 825 826 TAILQ_FOREACH(_secret, &group->secret_head, tailq) { 827 if (strcmp(_secret->user, user) == 0) { 828 SPDK_ERRLOG("user for secret is duplicated\n"); 829 return -EEXIST; 830 } 831 } 832 833 _secret = calloc(1, sizeof(*_secret)); 834 if (_secret == NULL) { 835 SPDK_ERRLOG("calloc() failed for CHAP secret\n"); 836 return -ENOMEM; 837 } 838 839 len = strnlen(user, sizeof(_secret->user)); 840 if (len > sizeof(_secret->user) - 1) { 841 SPDK_ERRLOG("CHAP user longer than %zu characters: %s\n", 842 sizeof(_secret->user) - 1, user); 843 free(_secret); 844 return -EINVAL; 845 } 846 memcpy(_secret->user, user, len); 847 848 len = strnlen(secret, sizeof(_secret->secret)); 849 if (len > sizeof(_secret->secret) - 1) { 850 SPDK_ERRLOG("CHAP secret longer than %zu characters: %s\n", 851 sizeof(_secret->secret) - 1, secret); 852 free(_secret); 853 return -EINVAL; 854 } 855 memcpy(_secret->secret, secret, len); 856 857 if (muser != NULL) { 858 len = strnlen(muser, sizeof(_secret->muser)); 859 if (len > sizeof(_secret->muser) - 1) { 860 SPDK_ERRLOG("Mutual CHAP user longer than %zu characters: %s\n", 861 sizeof(_secret->muser) - 1, muser); 862 free(_secret); 863 return -EINVAL; 864 } 865 memcpy(_secret->muser, muser, len); 866 867 len = strnlen(msecret, sizeof(_secret->msecret)); 868 if (len > sizeof(_secret->msecret) - 1) { 869 SPDK_ERRLOG("Mutual CHAP secret longer than %zu characters: %s\n", 870 sizeof(_secret->msecret) - 1, msecret); 871 free(_secret); 872 return -EINVAL; 873 } 874 memcpy(_secret->msecret, msecret, len); 875 } 876 877 TAILQ_INSERT_TAIL(&group->secret_head, _secret, tailq); 878 return 0; 879 } 880 881 int 882 spdk_iscsi_auth_group_delete_secret(struct spdk_iscsi_auth_group *group, 883 const char *user) 884 { 885 struct spdk_iscsi_auth_secret *_secret; 886 887 if (user == NULL) { 888 SPDK_ERRLOG("user must be specified\n"); 889 return -EINVAL; 890 } 891 892 TAILQ_FOREACH(_secret, &group->secret_head, tailq) { 893 if (strcmp(_secret->user, user) == 0) { 894 break; 895 } 896 } 897 898 if (_secret == NULL) { 899 SPDK_ERRLOG("secret is not found\n"); 900 return -ENODEV; 901 } 902 903 TAILQ_REMOVE(&group->secret_head, _secret, tailq); 904 free(_secret); 905 906 return 0; 907 } 908 909 int 910 spdk_iscsi_add_auth_group(int32_t tag, struct spdk_iscsi_auth_group **_group) 911 { 912 struct spdk_iscsi_auth_group *group; 913 914 TAILQ_FOREACH(group, &g_spdk_iscsi.auth_group_head, tailq) { 915 if (group->tag == tag) { 916 SPDK_ERRLOG("Auth group (%d) already exists\n", tag); 917 return -EEXIST; 918 } 919 } 920 921 group = calloc(1, sizeof(*group)); 922 if (group == NULL) { 923 SPDK_ERRLOG("calloc() failed for auth group\n"); 924 return -ENOMEM; 925 } 926 927 TAILQ_INIT(&group->secret_head); 928 group->tag = tag; 929 930 TAILQ_INSERT_TAIL(&g_spdk_iscsi.auth_group_head, group, tailq); 931 932 *_group = group; 933 return 0; 934 } 935 936 void 937 spdk_iscsi_delete_auth_group(struct spdk_iscsi_auth_group *group) 938 { 939 struct spdk_iscsi_auth_secret *_secret, *tmp; 940 941 TAILQ_REMOVE(&g_spdk_iscsi.auth_group_head, group, tailq); 942 943 TAILQ_FOREACH_SAFE(_secret, &group->secret_head, tailq, tmp) { 944 TAILQ_REMOVE(&group->secret_head, _secret, tailq); 945 free(_secret); 946 } 947 free(group); 948 } 949 950 struct spdk_iscsi_auth_group * 951 spdk_iscsi_find_auth_group_by_tag(int32_t tag) 952 { 953 struct spdk_iscsi_auth_group *group; 954 955 TAILQ_FOREACH(group, &g_spdk_iscsi.auth_group_head, tailq) { 956 if (group->tag == tag) { 957 return group; 958 } 959 } 960 961 return NULL; 962 } 963 964 static void 965 iscsi_auth_groups_destroy(void) 966 { 967 struct spdk_iscsi_auth_group *group, *tmp; 968 969 TAILQ_FOREACH_SAFE(group, &g_spdk_iscsi.auth_group_head, tailq, tmp) { 970 spdk_iscsi_delete_auth_group(group); 971 } 972 } 973 974 static int 975 iscsi_parse_auth_group(struct spdk_conf_section *sp) 976 { 977 int rc; 978 int i; 979 int tag; 980 const char *val, *user, *secret, *muser, *msecret; 981 struct spdk_iscsi_auth_group *group = NULL; 982 983 val = spdk_conf_section_get_val(sp, "Comment"); 984 if (val != NULL) { 985 SPDK_DEBUGLOG(SPDK_LOG_ISCSI, "Comment %s\n", val); 986 } 987 988 tag = spdk_conf_section_get_num(sp); 989 990 rc = spdk_iscsi_add_auth_group(tag, &group); 991 if (rc != 0) { 992 SPDK_ERRLOG("Failed to add auth group\n"); 993 return rc; 994 } 995 996 for (i = 0; ; i++) { 997 val = spdk_conf_section_get_nval(sp, "Auth", i); 998 if (val == NULL) { 999 break; 1000 } 1001 1002 user = spdk_conf_section_get_nmval(sp, "Auth", i, 0); 1003 secret = spdk_conf_section_get_nmval(sp, "Auth", i, 1); 1004 muser = spdk_conf_section_get_nmval(sp, "Auth", i, 2); 1005 msecret = spdk_conf_section_get_nmval(sp, "Auth", i, 3); 1006 1007 rc = spdk_iscsi_auth_group_add_secret(group, user, secret, muser, msecret); 1008 if (rc != 0) { 1009 SPDK_ERRLOG("Failed to add secret to auth group\n"); 1010 spdk_iscsi_delete_auth_group(group); 1011 return rc; 1012 } 1013 } 1014 1015 return 0; 1016 } 1017 1018 static int 1019 iscsi_parse_auth_info(void) 1020 { 1021 struct spdk_conf *config; 1022 struct spdk_conf_section *sp; 1023 int rc; 1024 1025 config = spdk_conf_allocate(); 1026 if (!config) { 1027 SPDK_ERRLOG("Failed to allocate config file\n"); 1028 return -ENOMEM; 1029 } 1030 1031 rc = spdk_conf_read(config, g_spdk_iscsi.authfile); 1032 if (rc != 0) { 1033 SPDK_INFOLOG(SPDK_LOG_ISCSI, "Failed to load auth file\n"); 1034 spdk_conf_free(config); 1035 return rc; 1036 } 1037 1038 sp = spdk_conf_first_section(config); 1039 while (sp != NULL) { 1040 if (spdk_conf_section_match_prefix(sp, "AuthGroup")) { 1041 if (spdk_conf_section_get_num(sp) == 0) { 1042 SPDK_ERRLOG("Group 0 is invalid\n"); 1043 iscsi_auth_groups_destroy(); 1044 spdk_conf_free(config); 1045 return -EINVAL; 1046 } 1047 1048 rc = iscsi_parse_auth_group(sp); 1049 if (rc != 0) { 1050 SPDK_ERRLOG("parse_auth_group() failed\n"); 1051 iscsi_auth_groups_destroy(); 1052 spdk_conf_free(config); 1053 return rc; 1054 } 1055 } 1056 sp = spdk_conf_next_section(sp); 1057 } 1058 1059 spdk_conf_free(config); 1060 return 0; 1061 } 1062 1063 static struct spdk_iscsi_auth_secret * 1064 iscsi_find_auth_secret(const char *authuser, int ag_tag) 1065 { 1066 struct spdk_iscsi_auth_group *group; 1067 struct spdk_iscsi_auth_secret *_secret; 1068 1069 TAILQ_FOREACH(group, &g_spdk_iscsi.auth_group_head, tailq) { 1070 if (group->tag == ag_tag) { 1071 TAILQ_FOREACH(_secret, &group->secret_head, tailq) { 1072 if (strcmp(_secret->user, authuser) == 0) { 1073 return _secret; 1074 } 1075 } 1076 } 1077 } 1078 1079 return NULL; 1080 } 1081 1082 int 1083 spdk_iscsi_chap_get_authinfo(struct iscsi_chap_auth *auth, const char *authuser, 1084 int ag_tag) 1085 { 1086 struct spdk_iscsi_auth_secret *_secret; 1087 1088 if (authuser == NULL) { 1089 return -EINVAL; 1090 } 1091 1092 if (auth->user[0] != '\0') { 1093 memset(auth->user, 0, sizeof(auth->user)); 1094 memset(auth->secret, 0, sizeof(auth->secret)); 1095 memset(auth->muser, 0, sizeof(auth->muser)); 1096 memset(auth->msecret, 0, sizeof(auth->msecret)); 1097 } 1098 1099 pthread_mutex_lock(&g_spdk_iscsi.mutex); 1100 1101 _secret = iscsi_find_auth_secret(authuser, ag_tag); 1102 if (_secret == NULL) { 1103 pthread_mutex_unlock(&g_spdk_iscsi.mutex); 1104 1105 SPDK_ERRLOG("CHAP secret is not found: user:%s, tag:%d\n", 1106 authuser, ag_tag); 1107 return -ENOENT; 1108 } 1109 1110 memcpy(auth->user, _secret->user, sizeof(auth->user)); 1111 memcpy(auth->secret, _secret->secret, sizeof(auth->secret)); 1112 1113 if (_secret->muser[0] != '\0') { 1114 memcpy(auth->muser, _secret->muser, sizeof(auth->muser)); 1115 memcpy(auth->msecret, _secret->msecret, sizeof(auth->msecret)); 1116 } 1117 1118 pthread_mutex_unlock(&g_spdk_iscsi.mutex); 1119 return 0; 1120 } 1121 1122 static int 1123 iscsi_initialize_global_params(void) 1124 { 1125 int rc; 1126 1127 if (!g_spdk_iscsi_opts) { 1128 rc = iscsi_parse_options(&g_spdk_iscsi_opts); 1129 if (rc != 0) { 1130 SPDK_ERRLOG("spdk_iscsi_parse_options() failed\n"); 1131 return rc; 1132 } 1133 } 1134 1135 rc = iscsi_set_global_params(g_spdk_iscsi_opts); 1136 if (rc != 0) { 1137 SPDK_ERRLOG("spdk_iscsi_set_global_params() failed\n"); 1138 } 1139 1140 spdk_iscsi_opts_free(g_spdk_iscsi_opts); 1141 g_spdk_iscsi_opts = NULL; 1142 1143 return rc; 1144 } 1145 1146 static void 1147 iscsi_init_complete(int rc) 1148 { 1149 spdk_iscsi_init_cb cb_fn = g_init_cb_fn; 1150 void *cb_arg = g_init_cb_arg; 1151 1152 g_init_cb_fn = NULL; 1153 g_init_cb_arg = NULL; 1154 1155 cb_fn(cb_arg, rc); 1156 } 1157 1158 static int 1159 iscsi_poll_group_poll(void *ctx) 1160 { 1161 struct spdk_iscsi_poll_group *group = ctx; 1162 struct spdk_iscsi_conn *conn, *tmp; 1163 int rc; 1164 1165 if (spdk_unlikely(STAILQ_EMPTY(&group->connections))) { 1166 return 0; 1167 } 1168 1169 rc = spdk_sock_group_poll(group->sock_group); 1170 if (rc < 0) { 1171 SPDK_ERRLOG("Failed to poll sock_group=%p\n", group->sock_group); 1172 } 1173 1174 STAILQ_FOREACH_SAFE(conn, &group->connections, link, tmp) { 1175 if (conn->state == ISCSI_CONN_STATE_EXITING) { 1176 spdk_iscsi_conn_destruct(conn); 1177 } 1178 } 1179 1180 return -1; 1181 } 1182 1183 static int 1184 iscsi_poll_group_handle_nop(void *ctx) 1185 { 1186 struct spdk_iscsi_poll_group *group = ctx; 1187 struct spdk_iscsi_conn *conn, *tmp; 1188 1189 STAILQ_FOREACH_SAFE(conn, &group->connections, link, tmp) { 1190 spdk_iscsi_conn_handle_nop(conn); 1191 } 1192 1193 return -1; 1194 } 1195 1196 static void 1197 iscsi_create_poll_group(void *ctx) 1198 { 1199 struct spdk_iscsi_poll_group *pg; 1200 1201 assert(g_spdk_iscsi.poll_group != NULL); 1202 pg = &g_spdk_iscsi.poll_group[spdk_env_get_current_core()]; 1203 pg->core = spdk_env_get_current_core(); 1204 1205 STAILQ_INIT(&pg->connections); 1206 pg->sock_group = spdk_sock_group_create(); 1207 assert(pg->sock_group != NULL); 1208 1209 pg->poller = spdk_poller_register(iscsi_poll_group_poll, pg, 0); 1210 /* set the period to 1 sec */ 1211 pg->nop_poller = spdk_poller_register(iscsi_poll_group_handle_nop, pg, 1000000); 1212 } 1213 1214 static void 1215 iscsi_unregister_poll_group(void *ctx) 1216 { 1217 struct spdk_iscsi_poll_group *pg; 1218 1219 assert(g_spdk_iscsi.poll_group != NULL); 1220 pg = &g_spdk_iscsi.poll_group[spdk_env_get_current_core()]; 1221 assert(pg->poller != NULL); 1222 assert(pg->sock_group != NULL); 1223 1224 spdk_sock_group_close(&pg->sock_group); 1225 spdk_poller_unregister(&pg->poller); 1226 spdk_poller_unregister(&pg->nop_poller); 1227 } 1228 1229 static void 1230 initialize_iscsi_poll_group(spdk_msg_fn cpl) 1231 { 1232 size_t g_num_poll_groups = spdk_env_get_last_core() + 1; 1233 1234 g_spdk_iscsi.poll_group = calloc(g_num_poll_groups, sizeof(struct spdk_iscsi_poll_group)); 1235 if (!g_spdk_iscsi.poll_group) { 1236 SPDK_ERRLOG("Failed to allocated iscsi poll group\n"); 1237 iscsi_init_complete(-1); 1238 return; 1239 } 1240 1241 /* Send a message to each thread and create a poll group */ 1242 spdk_for_each_thread(iscsi_create_poll_group, NULL, cpl); 1243 } 1244 1245 static void 1246 iscsi_parse_configuration(void *ctx) 1247 { 1248 int rc; 1249 1250 rc = spdk_iscsi_parse_portal_grps(); 1251 if (rc < 0) { 1252 SPDK_ERRLOG("spdk_iscsi_parse_portal_grps() failed\n"); 1253 goto end; 1254 } 1255 1256 rc = spdk_iscsi_parse_init_grps(); 1257 if (rc < 0) { 1258 SPDK_ERRLOG("spdk_iscsi_parse_init_grps() failed\n"); 1259 goto end; 1260 } 1261 1262 rc = spdk_iscsi_parse_tgt_nodes(); 1263 if (rc < 0) { 1264 SPDK_ERRLOG("spdk_iscsi_parse_tgt_nodes() failed\n"); 1265 } 1266 1267 if (g_spdk_iscsi.authfile != NULL) { 1268 if (access(g_spdk_iscsi.authfile, R_OK) == 0) { 1269 rc = iscsi_parse_auth_info(); 1270 if (rc < 0) { 1271 SPDK_ERRLOG("spdk_iscsi_parse_auth_info() failed\n"); 1272 } 1273 } else { 1274 SPDK_INFOLOG(SPDK_LOG_ISCSI, "CHAP secret file is not found in the path %s\n", 1275 g_spdk_iscsi.authfile); 1276 } 1277 } 1278 1279 end: 1280 iscsi_init_complete(rc); 1281 } 1282 1283 static int 1284 iscsi_parse_globals(void) 1285 { 1286 int rc; 1287 1288 rc = iscsi_initialize_global_params(); 1289 if (rc != 0) { 1290 SPDK_ERRLOG("spdk_iscsi_initialize_iscsi_global_params() failed\n"); 1291 return rc; 1292 } 1293 1294 g_spdk_iscsi.session = calloc(1, sizeof(void *) * g_spdk_iscsi.MaxSessions); 1295 if (!g_spdk_iscsi.session) { 1296 SPDK_ERRLOG("calloc() failed for session array\n"); 1297 return -1; 1298 } 1299 1300 /* 1301 * For now, just support same number of total connections, rather 1302 * than MaxSessions * MaxConnectionsPerSession. After we add better 1303 * handling for low resource conditions from our various buffer 1304 * pools, we can bump this up to support more connections. 1305 */ 1306 g_spdk_iscsi.MaxConnections = g_spdk_iscsi.MaxSessions; 1307 1308 rc = iscsi_initialize_all_pools(); 1309 if (rc != 0) { 1310 SPDK_ERRLOG("spdk_initialize_all_pools() failed\n"); 1311 free(g_spdk_iscsi.session); 1312 return -1; 1313 } 1314 1315 rc = spdk_initialize_iscsi_conns(); 1316 if (rc < 0) { 1317 SPDK_ERRLOG("spdk_initialize_iscsi_conns() failed\n"); 1318 free(g_spdk_iscsi.session); 1319 return rc; 1320 } 1321 1322 initialize_iscsi_poll_group(iscsi_parse_configuration); 1323 return 0; 1324 } 1325 1326 void 1327 spdk_iscsi_init(spdk_iscsi_init_cb cb_fn, void *cb_arg) 1328 { 1329 int rc; 1330 1331 assert(cb_fn != NULL); 1332 g_init_cb_fn = cb_fn; 1333 g_init_cb_arg = cb_arg; 1334 1335 rc = iscsi_parse_globals(); 1336 if (rc < 0) { 1337 SPDK_ERRLOG("spdk_iscsi_parse_globals() failed\n"); 1338 iscsi_init_complete(-1); 1339 } 1340 1341 /* 1342 * spdk_iscsi_parse_configuration() will be called as the callback to 1343 * spdk_initialize_iscsi_poll_group() and will complete iSCSI 1344 * subsystem initialization. 1345 */ 1346 } 1347 1348 void 1349 spdk_iscsi_fini(spdk_iscsi_fini_cb cb_fn, void *cb_arg) 1350 { 1351 g_fini_cb_fn = cb_fn; 1352 g_fini_cb_arg = cb_arg; 1353 1354 spdk_iscsi_portal_grp_close_all(); 1355 spdk_shutdown_iscsi_conns(); 1356 free(g_spdk_iscsi.session); 1357 } 1358 1359 static void 1360 iscsi_fini_done(void *arg) 1361 { 1362 iscsi_check_pools(); 1363 iscsi_free_pools(); 1364 1365 spdk_iscsi_shutdown_tgt_nodes(); 1366 spdk_iscsi_init_grps_destroy(); 1367 spdk_iscsi_portal_grps_destroy(); 1368 iscsi_auth_groups_destroy(); 1369 free(g_spdk_iscsi.authfile); 1370 free(g_spdk_iscsi.nodebase); 1371 free(g_spdk_iscsi.poll_group); 1372 1373 pthread_mutex_destroy(&g_spdk_iscsi.mutex); 1374 g_fini_cb_fn(g_fini_cb_arg); 1375 } 1376 1377 void 1378 spdk_shutdown_iscsi_conns_done(void) 1379 { 1380 if (g_spdk_iscsi.poll_group) { 1381 spdk_for_each_thread(iscsi_unregister_poll_group, NULL, iscsi_fini_done); 1382 } else { 1383 iscsi_fini_done(NULL); 1384 } 1385 } 1386 1387 void 1388 spdk_iscsi_config_text(FILE *fp) 1389 { 1390 iscsi_globals_config_text(fp); 1391 spdk_iscsi_portal_grps_config_text(fp); 1392 spdk_iscsi_init_grps_config_text(fp); 1393 spdk_iscsi_tgt_nodes_config_text(fp); 1394 } 1395 1396 void 1397 spdk_iscsi_opts_info_json(struct spdk_json_write_ctx *w) 1398 { 1399 spdk_json_write_object_begin(w); 1400 1401 if (g_spdk_iscsi.authfile != NULL) { 1402 spdk_json_write_named_string(w, "auth_file", g_spdk_iscsi.authfile); 1403 } 1404 spdk_json_write_named_string(w, "node_base", g_spdk_iscsi.nodebase); 1405 1406 spdk_json_write_named_uint32(w, "max_sessions", g_spdk_iscsi.MaxSessions); 1407 spdk_json_write_named_uint32(w, "max_connections_per_session", 1408 g_spdk_iscsi.MaxConnectionsPerSession); 1409 1410 spdk_json_write_named_uint32(w, "max_queue_depth", g_spdk_iscsi.MaxQueueDepth); 1411 1412 spdk_json_write_named_uint32(w, "default_time2wait", g_spdk_iscsi.DefaultTime2Wait); 1413 spdk_json_write_named_uint32(w, "default_time2retain", g_spdk_iscsi.DefaultTime2Retain); 1414 1415 spdk_json_write_named_uint32(w, "first_burst_length", g_spdk_iscsi.FirstBurstLength); 1416 1417 spdk_json_write_named_bool(w, "immediate_data", g_spdk_iscsi.ImmediateData); 1418 1419 spdk_json_write_named_bool(w, "allow_duplicated_isid", g_spdk_iscsi.AllowDuplicateIsid); 1420 1421 spdk_json_write_named_uint32(w, "error_recovery_level", g_spdk_iscsi.ErrorRecoveryLevel); 1422 1423 spdk_json_write_named_int32(w, "nop_timeout", g_spdk_iscsi.timeout); 1424 spdk_json_write_named_int32(w, "nop_in_interval", g_spdk_iscsi.nopininterval); 1425 1426 spdk_json_write_named_bool(w, "disable_chap", g_spdk_iscsi.disable_chap); 1427 spdk_json_write_named_bool(w, "require_chap", g_spdk_iscsi.require_chap); 1428 spdk_json_write_named_bool(w, "mutual_chap", g_spdk_iscsi.mutual_chap); 1429 spdk_json_write_named_int32(w, "chap_group", g_spdk_iscsi.chap_group); 1430 1431 spdk_json_write_named_uint32(w, "min_connections_per_core", 1432 spdk_iscsi_conn_get_min_per_core()); 1433 1434 spdk_json_write_object_end(w); 1435 } 1436 1437 static void 1438 iscsi_auth_group_info_json(struct spdk_iscsi_auth_group *group, 1439 struct spdk_json_write_ctx *w) 1440 { 1441 struct spdk_iscsi_auth_secret *_secret; 1442 1443 spdk_json_write_object_begin(w); 1444 1445 spdk_json_write_named_int32(w, "tag", group->tag); 1446 1447 spdk_json_write_named_array_begin(w, "secrets"); 1448 TAILQ_FOREACH(_secret, &group->secret_head, tailq) { 1449 spdk_json_write_object_begin(w); 1450 1451 spdk_json_write_named_string(w, "user", _secret->user); 1452 spdk_json_write_named_string(w, "secret", _secret->secret); 1453 1454 if (_secret->muser[0] != '\0') { 1455 spdk_json_write_named_string(w, "muser", _secret->muser); 1456 spdk_json_write_named_string(w, "msecret", _secret->msecret); 1457 } 1458 1459 spdk_json_write_object_end(w); 1460 } 1461 spdk_json_write_array_end(w); 1462 1463 spdk_json_write_object_end(w); 1464 } 1465 1466 static void 1467 iscsi_auth_group_config_json(struct spdk_iscsi_auth_group *group, 1468 struct spdk_json_write_ctx *w) 1469 { 1470 spdk_json_write_object_begin(w); 1471 1472 spdk_json_write_named_string(w, "method", "add_iscsi_auth_group"); 1473 1474 spdk_json_write_name(w, "params"); 1475 iscsi_auth_group_info_json(group, w); 1476 1477 spdk_json_write_object_end(w); 1478 } 1479 1480 void 1481 spdk_iscsi_auth_groups_info_json(struct spdk_json_write_ctx *w) 1482 { 1483 struct spdk_iscsi_auth_group *group; 1484 1485 TAILQ_FOREACH(group, &g_spdk_iscsi.auth_group_head, tailq) { 1486 iscsi_auth_group_info_json(group, w); 1487 } 1488 } 1489 1490 static void 1491 iscsi_auth_groups_config_json(struct spdk_json_write_ctx *w) 1492 { 1493 struct spdk_iscsi_auth_group *group; 1494 1495 TAILQ_FOREACH(group, &g_spdk_iscsi.auth_group_head, tailq) { 1496 iscsi_auth_group_config_json(group, w); 1497 } 1498 } 1499 1500 static void 1501 iscsi_opts_config_json(struct spdk_json_write_ctx *w) 1502 { 1503 spdk_json_write_object_begin(w); 1504 1505 spdk_json_write_named_string(w, "method", "set_iscsi_options"); 1506 1507 spdk_json_write_name(w, "params"); 1508 spdk_iscsi_opts_info_json(w); 1509 1510 spdk_json_write_object_end(w); 1511 } 1512 1513 void 1514 spdk_iscsi_config_json(struct spdk_json_write_ctx *w) 1515 { 1516 spdk_json_write_array_begin(w); 1517 iscsi_opts_config_json(w); 1518 spdk_iscsi_portal_grps_config_json(w); 1519 spdk_iscsi_init_grps_config_json(w); 1520 spdk_iscsi_tgt_nodes_config_json(w); 1521 iscsi_auth_groups_config_json(w); 1522 spdk_json_write_array_end(w); 1523 } 1524 1525 SPDK_LOG_REGISTER_COMPONENT("iscsi", SPDK_LOG_ISCSI) 1526