forked from ecdufcdrvr/bcmufctdrvr
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ocs_domain.c
1624 lines (1370 loc) · 44.7 KB
/
ocs_domain.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* BSD LICENSE
*
* Copyright (c) 2011-2018, Broadcom. All Rights Reserved.
* The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file
* Handles the domain object callback from the HAL.
*/
/*!
@defgroup domain_sm Domain State Machine: States
*/
#include "ocs.h"
#include "ocs_fabric.h"
#include "ocs_device.h"
#include "spv.h"
#include "ocs_spdk_nvmet.h"
#define domain_sm_trace(domain) \
do { \
if (OCS_LOG_ENABLE_DOMAIN_SM_TRACE(domain->ocs)) \
ocs_log_info(domain->ocs, "[domain] %-20s %-20s\n", __func__, ocs_sm_event_name(evt)); \
} while (0)
#define domain_trace(domain, fmt, ...) \
do { \
if (OCS_LOG_ENABLE_DOMAIN_SM_TRACE(domain ? domain->ocs : NULL)) \
ocs_log_info(domain ? domain->ocs : NULL, fmt, ##__VA_ARGS__); \
} while (0)
#define domain_printf(domain, fmt, ...) \
do { \
ocs_log_info(domain ? domain->ocs : NULL, fmt, ##__VA_ARGS__); \
} while (0)
void ocs_mgmt_domain_list(ocs_textbuf_t *textbuf, void *domain);
void ocs_mgmt_domain_get_all(ocs_textbuf_t *textbuf, void *domain);
int ocs_mgmt_domain_get(ocs_textbuf_t *textbuf, char *parent, char *name, void *domain);
int ocs_mgmt_domain_set(char *parent, char *name, char *value, void *domain);
int ocs_mgmt_domain_exec(char *parent, char *action, void *arg_in, uint32_t arg_in_length,
void *arg_out, uint32_t arg_out_length, void *domain);
static ocs_mgmt_functions_t domain_mgmt_functions = {
.get_list_handler = ocs_mgmt_domain_list,
.get_handler = ocs_mgmt_domain_get,
.get_all_handler = ocs_mgmt_domain_get_all,
.set_handler = ocs_mgmt_domain_set,
.exec_handler = ocs_mgmt_domain_exec,
};
/**
* @brief Accept domain callback events from the HAL.
*
* <h3 class="desc">Description</h3>
* HAL calls this function with various domain-related events.
*
* @param arg Application-specified argument.
* @param event Domain event.
* @param data Event specific data.
*
* @return Returns 0 on success; or a negative error value on failure.
*/
int32_t
ocs_domain_cb(void *arg, ocs_hal_domain_event_e event, void *data)
{
ocs_t *ocs = arg;
ocs_domain_t *domain = NULL;
int32_t rc = 0;
ocs_assert(data, -1);
if (event != OCS_HAL_DOMAIN_FOUND) {
domain = data;
}
switch (event) {
case OCS_HAL_DOMAIN_FOUND: {
uint64_t fcf_wwn = 0;
ocs_domain_record_t *drec = data;
ocs_assert(drec, -1);
/* extract the fcf_wwn */
fcf_wwn = ocs_be64toh(*((uint64_t*)drec->wwn));
/* lookup domain, or allocate a new one if one doesn't exist already */
domain = ocs_domain_find(ocs, fcf_wwn);
if (domain == NULL) {
domain = ocs_domain_alloc(ocs, fcf_wwn);
if (domain == NULL) {
ocs_log_err(ocs, "%s: ocs_domain_alloc() failed\n", __func__);
rc = -1;
break;
}
ocs_sm_transition(&domain->drvsm, __ocs_domain_init, NULL);
}
ocs_domain_post_event(domain, OCS_EVT_DOMAIN_FOUND, drec);
break;
}
case OCS_HAL_DOMAIN_LOST:
domain_trace(domain, "OCS_HAL_DOMAIN_LOST:\n");
ocs_domain_hold_frames(domain);
ocs_domain_post_event(domain, OCS_EVT_DOMAIN_LOST, NULL);
break;
case OCS_HAL_DOMAIN_ALLOC_OK: {
domain_trace(domain, "OCS_HAL_DOMAIN_ALLOC_OK:\n");
domain->instance_index = 0;
ocs_domain_post_event(domain, OCS_EVT_DOMAIN_ALLOC_OK, NULL);
break;
}
case OCS_HAL_DOMAIN_ALLOC_FAIL:
domain_trace(domain, "OCS_HAL_DOMAIN_ALLOC_FAIL:\n");
ocs_domain_post_event(domain, OCS_EVT_DOMAIN_ALLOC_FAIL, NULL);
break;
case OCS_HAL_DOMAIN_ATTACH_OK:
domain_trace(domain, "OCS_HAL_DOMAIN_ATTACH_OK:\n");
ocs_domain_post_event(domain, OCS_EVT_DOMAIN_ATTACH_OK, NULL);
break;
case OCS_HAL_DOMAIN_ATTACH_FAIL:
domain_trace(domain, "OCS_HAL_DOMAIN_ATTACH_FAIL:\n");
ocs_domain_post_event(domain, OCS_EVT_DOMAIN_ATTACH_FAIL, NULL);
break;
case OCS_HAL_DOMAIN_FREE_OK:
domain_trace(domain, "OCS_HAL_DOMAIN_FREE_OK:\n");
ocs_domain_post_event(domain, OCS_EVT_DOMAIN_FREE_OK, NULL);
break;
case OCS_HAL_DOMAIN_FREE_FAIL:
domain_trace(domain, "OCS_HAL_DOMAIN_FREE_FAIL:\n");
ocs_domain_post_event(domain, OCS_EVT_DOMAIN_FREE_FAIL, NULL);
break;
default:
ocs_log_warn(ocs, "%s: unsupported event %#x\n", __func__, event);
}
return rc;
}
/**
* @brief Find the domain, given its FCF_WWN.
*
* <h3 class="desc">Description</h3>
* Search the domain_list to find a matching domain object.
*
* @param ocs Pointer to the OCS device.
* @param fcf_wwn FCF WWN to find.
*
* @return Returns the pointer to the domain if found; or NULL otherwise.
*/
ocs_domain_t *
ocs_domain_find(ocs_t *ocs, uint64_t fcf_wwn)
{
ocs_domain_t *domain = NULL;
/* Check to see if this domain is already allocated */
ocs_device_lock(ocs);
ocs_list_foreach(&ocs->domain_list, domain) {
if (fcf_wwn == domain->fcf_wwn) {
break;
}
}
ocs_device_unlock(ocs);
return domain;
}
/**
* @brief Allocate a domain object.
*
* <h3 class="desc">Description</h3>
* A domain object is allocated and initialized. It is associated with the
* \c ocs argument.
*
* @param ocs Pointer to the OCS device.
* @param fcf_wwn FCF WWN of the domain.
*
* @return Returns a pointer to the ocs_domain_t object; or NULL.
*/
ocs_domain_t *
ocs_domain_alloc(ocs_t *ocs, uint64_t fcf_wwn)
{
ocs_domain_t *domain;
ocs_assert(ocs, NULL);
domain = ocs_malloc(ocs, sizeof(*domain), OCS_M_NOWAIT | OCS_M_ZERO);
if (domain) {
domain->ocs = ocs;
domain->instance_index = ocs->domain_instance_count++;
domain->drvsm.app = domain;
ocs_rlock_init(ocs, &domain->drvsm_lock, "Domain SM lock");
ocs_domain_lock_init(domain);
ocs_lock_init(ocs, &domain->lookup_lock, "Domain lookup[%d]", domain->instance_index);
/* Allocate a sparse vector for sport FC_ID's */
domain->lookup = spv_new(ocs);
if (domain->lookup == NULL) {
ocs_log_err(ocs, "%s: spv_new() failed\n", __func__);
ocs_free(ocs, domain, sizeof(*domain));
return NULL;
}
ocs_list_init(&domain->sport_list, ocs_sport_t, link);
domain->fcf_wwn = fcf_wwn;
ocs_log_debug(ocs, "Domain allocated: wwn %016" PRIX64 "\n", domain->fcf_wwn);
domain->femul_enable = (ocs->ctrlmask & OCS_CTRLMASK_ENABLE_FABRIC_EMULATION) != 0;
#if defined(ENABLE_FABRIC_EMULATION)
domain->ocs_ns = ocs_ns_attach(domain, OCS_NS_MAX_RECORDS);
#endif
ocs_device_lock(ocs);
/* if this is the first domain, then assign it as the "root" domain */
if (ocs_list_empty(&ocs->domain_list)) {
ocs->domain = domain;
}
ocs_list_add_tail(&ocs->domain_list, domain);
ocs_device_unlock(ocs);
domain->mgmt_functions = &domain_mgmt_functions;
} else {
ocs_log_err(ocs, "%s: domain allocation failed\n", __func__);
}
return domain;
}
/**
* @brief Free a domain object.
*
* <h3 class="desc">Description</h3>
* The domain object is freed.
*
* @param domain Domain object to free.
*
* @return None.
*/
void
ocs_domain_free(ocs_domain_t *domain)
{
ocs_t *ocs;
ocs_assert(domain);
ocs_assert(domain->ocs);
/* Hold frames to clear the domain pointer from the xport lookup */
ocs_domain_hold_frames(domain);
ocs = domain->ocs;
ocs_log_debug(ocs, "Domain free: wwn %016" PRIX64 "\n", domain->fcf_wwn);
spv_del(domain->lookup);
domain->lookup = NULL;
ocs_device_lock(ocs);
ocs_list_remove(&ocs->domain_list, domain);
if (domain == ocs->domain) {
/* set global domain to the new head */
ocs->domain = ocs_list_get_head(&ocs->domain_list);
if (ocs->domain) {
ocs_log_debug(ocs, "%s: setting new domain, old=%p new=%p\n",
__func__, domain, ocs->domain);
}
}
if (ocs_list_empty(&ocs->domain_list) && ocs->domain_list_empty_cb ) {
(*ocs->domain_list_empty_cb)(ocs, ocs->domain_list_empty_cb_arg);
}
ocs_device_unlock(ocs);
ocs_rlock_free(&domain->drvsm_lock);
ocs_lock_free(&domain->lookup_lock);
#if defined(ENABLE_FABRIC_EMULATION)
/* Free name services database */
ocs_ns_detach(domain->ocs_ns);
/* Shutdown fabric emulation */
ocs_femul_shutdown(domain);
#endif
ocs_free(ocs, domain, sizeof(*domain));
}
/**
* @brief Free memory resources of a domain object.
*
* <h3 class="desc">Description</h3>
* After the domain object is freed, its child objects are also freed.
*
* @param domain Pointer to a domain object.
*
* @return None.
*/
void
ocs_domain_force_free(ocs_domain_t *domain)
{
ocs_sport_t *sport;
ocs_sport_t *next;
/* Shutdown domain sm */
ocs_sm_disable(&domain->drvsm);
ocs_scsi_notify_domain_force_free(domain);
ocs_domain_lock(domain);
ocs_list_foreach_safe(&domain->sport_list, sport, next) {
ocs_sport_force_free(sport);
}
ocs_domain_unlock(domain);
ocs_hal_domain_force_free(&domain->ocs->hal, domain);
ocs_domain_free(domain);
}
/**
* @brief Register a callback when the domain_list goes empty.
*
* <h3 class="desc">Description</h3>
* A function callback may be registered when the domain_list goes empty.
*
* @param ocs Pointer to a device object.
* @param callback Callback function.
* @param arg Callback argument.
*
* @return None.
*/
void
ocs_register_domain_list_empty_cb(ocs_t *ocs, void (*callback)(ocs_t *ocs, void *arg), void *arg)
{
ocs_device_lock(ocs);
ocs->domain_list_empty_cb = callback;
ocs->domain_list_empty_cb_arg = arg;
if (ocs_list_empty(&ocs->domain_list) && callback) {
(*callback)(ocs, arg);
}
ocs_device_unlock(ocs);
}
/**
* @brief Return a pointer to the domain, given the instance index.
*
* <h3 class="desc">Description</h3>
* A pointer to the domain context, given by the index, is returned.
*
* @param ocs Pointer to the driver instance context.
* @param index Instance index.
*
* @return Returns a pointer to the domain; or NULL.
*/
ocs_domain_t *
ocs_domain_get_instance(ocs_t *ocs, uint32_t index)
{
ocs_domain_t *domain = NULL;
if (index >= OCS_MAX_DOMAINS) {
ocs_log_err(ocs, "%s: invalid index: %d\n", __func__, index);
return NULL;
}
ocs_device_lock(ocs);
ocs_list_foreach(&ocs->domain_list, domain) {
if (domain->instance_index == index) {
break;
}
}
ocs_device_unlock(ocs);
return domain;
}
/**
* @ingroup domain_sm
* @brief Domain state machine: Common event handler.
*
* <h3 class="desc">Description</h3>
* Common/shared events are handled here for the domain state machine.
*
* @param funcname Function name text.
* @param ctx Domain state machine context.
* @param evt Event to process.
* @param arg Per event optional argument.
*
* @return Returns NULL.
*/
static void *
__ocs_domain_common(const char *funcname, ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg)
{
ocs_domain_t *domain = ctx->app;
switch(evt) {
case OCS_EVT_ENTER:
case OCS_EVT_REENTER:
case OCS_EVT_EXIT:
case OCS_EVT_ALL_CHILD_NODES_FREE:
/* this can arise if an FLOGI fails on the SPORT, and the SPORT is shutdown */
break;
default:
ocs_log_warn(domain->ocs, "%-20s %-20s not handled\n", funcname, ocs_sm_event_name(evt));
break;
}
return NULL;
}
/**
* @ingroup domain_sm
* @brief Domain state machine: Common shutdown.
*
* <h3 class="desc">Description</h3>
* Handles common shutdown events.
*
* @param funcname Function name text.
* @param ctx Remote node state machine context.
* @param evt Event to process.
* @param arg Per event optional argument.
*
* @return Returns NULL.
*/
static void *
__ocs_domain_common_shutdown(const char *funcname, ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg)
{
ocs_domain_t *domain = ctx->app;
switch(evt) {
case OCS_EVT_ENTER:
case OCS_EVT_REENTER:
case OCS_EVT_EXIT:
break;
case OCS_EVT_DOMAIN_FOUND:
ocs_assert(arg, NULL);
//sm: / save drec, mark domain_found_pending
ocs_memcpy(&domain->pending_drec, arg, sizeof(domain->pending_drec));
domain->domain_found_pending = TRUE;
break;
case OCS_EVT_DOMAIN_LOST: // clear drec available
//sm: / unmark domain_found_pending
domain->domain_found_pending = FALSE;
break;
default:
ocs_log_warn(domain->ocs, "%-20s %-20s not handled\n", funcname, ocs_sm_event_name(evt));
break;
}
return NULL;
}
#define std_domain_state_decl(...) \
ocs_domain_t *domain = NULL; \
ocs_t *ocs = NULL; \
\
ocs_assert(ctx, NULL); \
ocs_assert(ctx->app, NULL); \
domain = ctx->app; \
ocs_assert(domain->ocs, NULL); \
ocs = domain->ocs; \
ocs_assert(ocs->xport, NULL);
/**
* @ingroup domain_sm
* @brief Domain state machine: Initial state.
*
* <h3 class="desc">Description</h3>
* The initial state for a domain. Each domain is initialized to
* this state at start of day (SOD).
*
* @param ctx Domain state machine context.
* @param evt Event to process.
* @param arg Per event optional argument.
*
* @return Returns NULL.
*/
void *
__ocs_domain_init(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg)
{
std_domain_state_decl();
domain_sm_trace(domain);
switch(evt) {
case OCS_EVT_ENTER:
domain->attached = 0;
break;
case OCS_EVT_DOMAIN_FOUND: {
int32_t vlan = 0;
uint32_t i;
ocs_domain_record_t *drec = arg;
ocs_sport_t *sport;
uint64_t my_wwnn = ocs->xport->req_wwnn;
uint64_t my_wwpn = ocs->xport->req_wwpn;
uint64_t be_wwpn;
/* For now, user must specify both port name and node name, or we let firmware
* pick both (same as for vports).
* TODO: do we want to allow setting only port name or only node name?
*/
if ((my_wwpn == 0) || (my_wwnn == 0)) {
ocs_log_debug(ocs, "%s: using default hardware WWN configuration \n", __func__);
my_wwpn = ocs_get_wwn(&ocs->hal, OCS_HAL_WWN_PORT);
my_wwnn = ocs_get_wwn(&ocs->hal, OCS_HAL_WWN_NODE);
}
ocs_log_debug(ocs, "Creating base sport using WWPN %016" PRIx64 " WWNN %016" PRIx64 "\n",
my_wwpn, my_wwnn);
/* Allocate a sport and transition to __ocs_sport_allocated */
sport = ocs_sport_alloc(domain, my_wwpn, my_wwnn, UINT32_MAX, ocs->enable_ini, ocs->enable_tgt);
if (sport == NULL) {
ocs_log_err(ocs, "%s: ocs_sport_alloc() failed\n", __func__);
break;
}
ocs_sm_transition(&sport->sm, __ocs_sport_allocated, NULL);
/* If domain is ethernet, then fetch the vlan id value */
if (drec->is_ethernet) {
vlan = ocs_bitmap_search((void *)drec->map.vlan, TRUE, 512 * 8);
if (vlan < 0) {
ocs_log_err(ocs, "%s: no VLAN id available (FCF=%d)\n", __func__,
drec->index);
break;
}
}
be_wwpn = ocs_htobe64(sport->wwpn);
/* allocate ocs_sli_port_t object for local port
* Note: drec->fc_id is ALPA from read_topology only if loop
*/
if (ocs_hal_port_alloc(&ocs->hal, sport, NULL, (uint8_t *)&be_wwpn)) {
ocs_log_err(ocs, "Can't allocate port\n");
ocs_sport_free(sport);
break;
}
/* initialize domain object */
domain->is_loop = drec->is_loop;
domain->is_fc = drec->is_fc;
/*
* If the loop position map includes ALPA == 0, then we are in a public loop (NL_PORT)
* Note that the first element of the loopmap[] contains the count of elements, and if
* ALPA == 0 is present, it will occupy the first location after the count.
*/
domain->is_nlport = drec->map.loop[1] == 0x00;
if (domain->is_loop) {
ocs_log_debug(ocs, "%s: %s fc_id=%#x speed=%d\n", __func__,
drec->is_loop ? (domain->is_nlport ? "public-loop" : "loop") : "other",
drec->fc_id, drec->speed);
sport->fc_id = drec->fc_id;
sport->topology = OCS_SPORT_TOPOLOGY_LOOP;
ocs_snprintf(sport->display_name, sizeof(sport->display_name), "s%06x", drec->fc_id);
if (ocs->enable_ini) {
uint32_t count = drec->map.loop[0];
ocs_log_debug(ocs, "%s: %d position map entries\n", __func__, count);
for (i = 1; i <= count; i++) {
if (drec->map.loop[i] != drec->fc_id) {
ocs_node_t *node;
ocs_log_debug(ocs, "%s: %#x -> %#x\n", __func__,
drec->fc_id, drec->map.loop[i]);
node = ocs_node_alloc(sport, drec->map.loop[i], FALSE, TRUE);
if (node == NULL) {
ocs_log_err(ocs, "%s: ocs_node_alloc() failed\n", __func__);
break;
}
ocs_node_transition(node, __ocs_d_wait_loop, NULL);
}
}
}
}
/* Initiate HAL domain alloc */
if (ocs_hal_domain_alloc(&ocs->hal, domain, drec->index, vlan)) {
ocs_log_err(ocs, "Failed to initiate HAL domain allocation\n");
break;
}
ocs_sm_transition(ctx, __ocs_domain_wait_alloc, arg);
break;
}
default:
__ocs_domain_common(__func__, ctx, evt, arg);
return NULL;
}
return NULL;
}
/**
* @ingroup domain_sm
* @brief Domain state machine: Wait for the domain allocation to complete.
*
* <h3 class="desc">Description</h3>
* Waits for the domain state to be allocated. After the HAL domain
* allocation process has been initiated, this state waits for
* that process to complete (i.e. a domain-alloc-ok event).
*
* @param ctx Domain state machine context.
* @param evt Event to process.
* @param arg Per event optional argument.
*
* @return Returns NULL.
*/
void *
__ocs_domain_wait_alloc(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg)
{
ocs_sport_t *sport;
std_domain_state_decl();
domain_sm_trace(domain);
switch(evt) {
case OCS_EVT_DOMAIN_ALLOC_OK: {
char prop_buf[32];
uint64_t wwn_bump = 0;
fc_plogi_payload_t *sp;
if (ocs_get_property("wwn_bump", prop_buf, sizeof(prop_buf)) == 0) {
wwn_bump = ocs_strtoull(prop_buf, 0, 0);
}
sport = domain->sport;
ocs_assert(sport, NULL);
sp = (fc_plogi_payload_t*) sport->service_params;
/* Save the domain service parameters */
ocs_memcpy(domain->service_params + 4, domain->dma.virt, sizeof(fc_plogi_payload_t) - 4);
ocs_memcpy(sport->service_params + 4, domain->dma.virt, sizeof(fc_plogi_payload_t) - 4);
/* If we're in fabric emulation mode, the flogi service parameters have not been setup yet,
* so we need some reasonable BB credit value
*/
if (domain->femul_enable) {
ocs_memcpy(domain->flogi_service_params + 4, domain->service_params + 4, sizeof(fc_plogi_payload_t) - 4);
}
/* Update the sport's service parameters, user might have specified non-default names */
sp->port_name_hi = ocs_htobe32((uint32_t) (sport->wwpn >> 32ll));
sp->port_name_lo = ocs_htobe32((uint32_t) sport->wwpn);
sp->node_name_hi = ocs_htobe32((uint32_t) (sport->wwnn >> 32ll));
sp->node_name_lo = ocs_htobe32((uint32_t) sport->wwnn);
if (wwn_bump) {
sp->port_name_lo = ocs_htobe32(ocs_be32toh(sp->port_name_lo) ^ ((uint32_t)(wwn_bump)));
sp->port_name_hi = ocs_htobe32(ocs_be32toh(sp->port_name_hi) ^ ((uint32_t)(wwn_bump >> 32)));
sp->node_name_lo = ocs_htobe32(ocs_be32toh(sp->node_name_lo) ^ ((uint32_t)(wwn_bump)));
sp->node_name_hi = ocs_htobe32(ocs_be32toh(sp->node_name_hi) ^ ((uint32_t)(wwn_bump >> 32)));
ocs_log_info(ocs, "Overriding WWN\n");
}
/* Take the loop topology path, unless we are an NL_PORT (public loop) */
if (domain->is_loop && !domain->is_nlport) {
/*
* For loop, we already have our FC ID and don't need fabric login.
* Transition to the allocated state and post an event to attach to
* the domain. Note that this breaks the normal action/transition
* pattern here to avoid a race with the domain attach callback.
*/
//sm: is_loop / domain_attach
ocs_sm_transition(ctx, __ocs_domain_allocated, NULL);
__ocs_domain_attach_internal(domain, sport->fc_id);
break;
} else {
ocs_node_t *node;
#if defined(ENABLE_FABRIC_EMULATION)
/* If we are running in Fabric Emulation Mode, then initialize */
if (domain->femul_enable) {
ocs_log_info(ocs, "Starting Fabric Emulation operation\n");
ocs_femul_init(domain);
ocs_sm_transition(ctx, __ocs_domain_allocated, NULL);
/* Accept frames */
domain->req_accept_frames = 1;
break;
}
#endif
/* alloc fabric node, send FLOGI */
node = ocs_node_find(sport, FC_ADDR_FABRIC);
if (node) {
ocs_log_err(ocs, "Hmmmm ... Fabric Controller node already exists\n");
break;
}
node = ocs_node_alloc(sport, FC_ADDR_FABRIC, FALSE, FALSE);
if (!node) {
ocs_log_err(ocs, "Error: ocs_node_alloc() failed\n");
} else {
if (ocs->nodedb_mask & OCS_NODEDB_PAUSE_FABRIC_LOGIN) {
ocs_node_pause(node, __ocs_fabric_init);
} else {
ocs_node_transition(node, __ocs_fabric_init, NULL);
}
}
/* Accept frames */
domain->req_accept_frames = 1;
}
//sm: / start fabric logins
ocs_sm_transition(ctx, __ocs_domain_allocated, NULL);
break;
}
case OCS_EVT_DOMAIN_ALLOC_FAIL:
// TODO: hal/device reset
ocs_log_err(ocs, "%s recv'd waiting for DOMAIN_ALLOC_OK; shutting down domain\n",
ocs_sm_event_name(evt));
domain->req_domain_free = 1;
break;
case OCS_EVT_DOMAIN_FOUND:
/* Should not happen */
ocs_assert(evt, NULL);
break;
case OCS_EVT_DOMAIN_LOST:
ocs_log_debug(ocs, "%s received while waiting for ocs_hal_domain_alloc() to complete\n", ocs_sm_event_name(evt));
ocs_sm_transition(ctx, __ocs_domain_wait_domain_lost, NULL);
break;
default:
__ocs_domain_common(__func__, ctx, evt, arg);
return NULL;
}
return NULL;
}
/**
* @ingroup domain_sm
* @brief Domain state machine: Wait for the domain attach request.
*
* <h3 class="desc">Description</h3>
* In this state, the domain has been allocated and is waiting for a domain attach request.
* The attach request comes from a node instance completing the fabric login,
* or from a point-to-point negotiation and login.
*
* @param ctx Remote node state machine context.
* @param evt Event to process.
* @param arg Per event optional argument.
*
* @return Returns NULL.
*/
void *
__ocs_domain_allocated(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg)
{
int32_t rc = 0;
std_domain_state_decl();
domain_sm_trace(domain);
switch(evt) {
case OCS_EVT_DOMAIN_REQ_ATTACH: {
uint32_t fc_id;
ocs_assert(arg, NULL);
fc_id = *((uint32_t*)arg);
ocs_log_debug(ocs, "%s: Requesting hal domain attach fc_id x%x\n", __func__, fc_id);
/* Update sport lookup */
ocs_lock(&domain->lookup_lock);
spv_set(domain->lookup, fc_id, domain->sport);
ocs_unlock(&domain->lookup_lock);
/* Update display name for the sport */
ocs_node_fcid_display(fc_id, domain->sport->display_name, sizeof(domain->sport->display_name));
/* Issue domain attach call */
rc = ocs_hal_domain_attach(&ocs->hal, domain, fc_id);
if (rc) {
ocs_log_err(ocs, "%s: ocs_hal_domain_attach failed: %d\n", __func__, rc);
return NULL;
}
//sm: / domain_attach
ocs_sm_transition(ctx, __ocs_domain_wait_attach, NULL);
break;
}
case OCS_EVT_DOMAIN_FOUND:
/* Should not happen */
ocs_assert(evt, NULL);
break;
case OCS_EVT_DOMAIN_LOST: {
int32_t rc;
ocs_log_debug(ocs, "%s received while waiting for OCS_EVT_DOMAIN_REQ_ATTACH\n",
ocs_sm_event_name(evt));
ocs_domain_lock(domain);
if (!ocs_list_empty(&domain->sport_list)) {
/* if there are sports, transition to wait state and send
* shutdown to each sport */
ocs_sport_t *sport = NULL;
ocs_sport_t *sport_next = NULL;
ocs_sm_transition(ctx, __ocs_domain_wait_sports_free, NULL);
ocs_list_foreach_safe(&domain->sport_list, sport, sport_next) {
ocs_sm_post_event(&sport->sm, OCS_EVT_SHUTDOWN, NULL);
}
ocs_domain_unlock(domain);
} else {
ocs_domain_unlock(domain);
/* no sports exist, free domain */
ocs_sm_transition(ctx, __ocs_domain_wait_shutdown, NULL);
rc = ocs_hal_domain_free(&ocs->hal, domain);
if (rc) {
ocs_log_err(ocs, "%s: ocs_hal_domain_free() failed: %d\n", __func__, rc);
//TODO: hal/device reset needed
}
}
break;
}
default:
__ocs_domain_common(__func__, ctx, evt, arg);
return NULL;
}
return NULL;
}
/**
* @ingroup domain_sm
* @brief Domain state machine: Wait for the HAL domain attach to complete.
*
* <h3 class="desc">Description</h3>
* Waits for the HAL domain attach to complete. Forwards attach ok event to the
* fabric node state machine.
*
* @param ctx Remote node state machine context.
* @param evt Event to process.
* @param arg Per event optional argument.
*
* @return Returns NULL.
*/
void *
__ocs_domain_wait_attach(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg)
{
std_domain_state_decl();
domain_sm_trace(domain);
switch(evt) {
case OCS_EVT_DOMAIN_ATTACH_OK: {
ocs_node_t *node = NULL;
ocs_node_t *next_node = NULL;
ocs_sport_t *sport;
ocs_sport_t *next_sport;
/* Mark as attached */
domain->attached = 1;
/* Register with SCSI API */
if (ocs->enable_tgt)
ocs_scsi_tgt_new_domain(domain);
if (ocs->enable_ini)
ocs_scsi_ini_new_domain(domain);
/* Transition to ready */
//sm: / forward event to all sports and nodes
ocs_sm_transition(ctx, __ocs_domain_ready, NULL);
/* We have an FCFI, so we can accept frames */
domain->req_accept_frames = 1;
/* Notify all nodes that the domain attach request has completed
* Note: sport will have already received notification of sport attached
* as a result of the HAL's port attach.
*/
ocs_domain_lock(domain);
ocs_list_foreach_safe(&domain->sport_list, sport, next_sport) {
ocs_sport_lock(sport);
ocs_list_foreach_safe(&sport->node_list, node, next_node) {
ocs_node_post_event(node, OCS_EVT_DOMAIN_ATTACH_OK, NULL);
}
ocs_sport_unlock(sport);
}
ocs_domain_unlock(domain);
break;
}
case OCS_EVT_DOMAIN_ATTACH_FAIL:
ocs_log_debug(ocs, "%s received while waiting for hal attach to complete\n", ocs_sm_event_name(evt));
//TODO: hal/device reset
break;
case OCS_EVT_DOMAIN_FOUND:
/* Should not happen */
ocs_assert(evt, NULL);
break;
case OCS_EVT_DOMAIN_LOST:
/* Domain lost while waiting for an attach to complete, go to a state that waits for
* the domain attach to complete, then handle domain lost
*/
ocs_sm_transition(ctx, __ocs_domain_wait_domain_lost, NULL);
break;
case OCS_EVT_DOMAIN_REQ_ATTACH:
/* In P2P we can get an attach request from the other FLOGI path, so drop this one */
break;
default:
__ocs_domain_common(__func__, ctx, evt, arg);
return NULL;
}
return NULL;
}
/**
* @ingroup domain_sm
* @brief Domain state machine: Ready state.
*
* <h3 class="desc">Description</h3>
* This is a domain ready state. It waits for a domain-lost event, and initiates shutdown.
*
* @param ctx Remote node state machine context.
* @param evt Event to process.
* @param arg Per event optional argument.
*
* @return Returns NULL.
*/
void *
__ocs_domain_ready(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg)
{
std_domain_state_decl();
domain_sm_trace(domain);
switch(evt) {
case OCS_EVT_ENTER: {
/* start any pending vports */
if (ocs_vport_start(domain)) {
ocs_log_debug(domain->ocs, "%s: ocs_vport_start() did not start all vports\n", __func__);
}
break;
}
case OCS_EVT_DOMAIN_LOST: {
int32_t rc;
ocs_domain_lock(domain);