1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright(c) 2007 - 2008 Intel Corporation. All rights reserved.
5 * Maintained at www.Open-FCoE.org
11 * This block discovers all FC-4 remote ports, including FCP initiators. It
12 * also handles RSCN events and re-discovery if necessary.
18 * The disc mutex is can be locked when acquiring rport locks, but may not
19 * be held when acquiring the lport lock. Refer to fc_lport.c for more
23 #include <linux/timer.h>
24 #include <linux/slab.h>
25 #include <linux/err.h>
26 #include <linux/export.h>
27 #include <linux/rculist.h>
29 #include <asm/unaligned.h>
31 #include <scsi/fc/fc_gs.h>
33 #include <scsi/libfc.h>
37 #define FC_DISC_RETRY_LIMIT 3 /* max retries */
38 #define FC_DISC_RETRY_DELAY 500UL /* (msecs) delay */
40 static void fc_disc_gpn_ft_req(struct fc_disc
*);
41 static void fc_disc_gpn_ft_resp(struct fc_seq
*, struct fc_frame
*, void *);
42 static void fc_disc_done(struct fc_disc
*, enum fc_disc_event
);
43 static void fc_disc_timeout(struct work_struct
*);
44 static int fc_disc_single(struct fc_lport
*, struct fc_disc_port
*);
45 static void fc_disc_restart(struct fc_disc
*);
48 * fc_disc_stop_rports() - Delete all the remote ports associated with the lport
49 * @disc: The discovery job to stop remote ports on
51 static void fc_disc_stop_rports(struct fc_disc
*disc
)
53 struct fc_rport_priv
*rdata
;
55 lockdep_assert_held(&disc
->disc_mutex
);
57 list_for_each_entry(rdata
, &disc
->rports
, peers
) {
58 if (kref_get_unless_zero(&rdata
->kref
)) {
59 fc_rport_logoff(rdata
);
60 kref_put(&rdata
->kref
, fc_rport_destroy
);
66 * fc_disc_recv_rscn_req() - Handle Registered State Change Notification (RSCN)
67 * @disc: The discovery object to which the RSCN applies
70 static void fc_disc_recv_rscn_req(struct fc_disc
*disc
, struct fc_frame
*fp
)
72 struct fc_lport
*lport
;
73 struct fc_els_rscn
*rp
;
74 struct fc_els_rscn_page
*pp
;
75 struct fc_seq_els_data rjt_data
;
78 enum fc_els_rscn_ev_qual ev_qual
;
79 enum fc_els_rscn_addr_fmt fmt
;
80 LIST_HEAD(disc_ports
);
81 struct fc_disc_port
*dp
, *next
;
83 lockdep_assert_held(&disc
->disc_mutex
);
85 lport
= fc_disc_lport(disc
);
87 FC_DISC_DBG(disc
, "Received an RSCN event\n");
89 /* make sure the frame contains an RSCN message */
90 rp
= fc_frame_payload_get(fp
, sizeof(*rp
));
93 /* make sure the page length is as expected (4 bytes) */
94 if (rp
->rscn_page_len
!= sizeof(*pp
))
96 /* get the RSCN payload length */
97 len
= ntohs(rp
->rscn_plen
);
98 if (len
< sizeof(*rp
))
100 /* make sure the frame contains the expected payload */
101 rp
= fc_frame_payload_get(fp
, len
);
104 /* payload must be a multiple of the RSCN page size */
106 if (len
% sizeof(*pp
))
109 for (pp
= (void *)(rp
+ 1); len
> 0; len
-= sizeof(*pp
), pp
++) {
110 ev_qual
= pp
->rscn_page_flags
>> ELS_RSCN_EV_QUAL_BIT
;
111 ev_qual
&= ELS_RSCN_EV_QUAL_MASK
;
112 fmt
= pp
->rscn_page_flags
>> ELS_RSCN_ADDR_FMT_BIT
;
113 fmt
&= ELS_RSCN_ADDR_FMT_MASK
;
115 * if we get an address format other than port
116 * (area, domain, fabric), then do a full discovery
119 case ELS_ADDR_FMT_PORT
:
120 FC_DISC_DBG(disc
, "Port address format for port "
121 "(%6.6x)\n", ntoh24(pp
->rscn_fid
));
122 dp
= kzalloc(sizeof(*dp
), GFP_KERNEL
);
128 dp
->port_id
= ntoh24(pp
->rscn_fid
);
129 list_add_tail(&dp
->peers
, &disc_ports
);
131 case ELS_ADDR_FMT_AREA
:
132 case ELS_ADDR_FMT_DOM
:
133 case ELS_ADDR_FMT_FAB
:
135 FC_DISC_DBG(disc
, "Address format is (%d)\n", fmt
);
140 fc_seq_els_rsp_send(fp
, ELS_LS_ACC
, NULL
);
143 * If not doing a complete rediscovery, do GPN_ID on
144 * the individual ports mentioned in the list.
145 * If any of these get an error, do a full rediscovery.
146 * In any case, go through the list and free the entries.
148 list_for_each_entry_safe(dp
, next
, &disc_ports
, peers
) {
149 list_del(&dp
->peers
);
151 redisc
= fc_disc_single(lport
, dp
);
155 FC_DISC_DBG(disc
, "RSCN received: rediscovering\n");
156 fc_disc_restart(disc
);
158 FC_DISC_DBG(disc
, "RSCN received: not rediscovering. "
159 "redisc %d state %d in_prog %d\n",
160 redisc
, lport
->state
, disc
->pending
);
165 FC_DISC_DBG(disc
, "Received a bad RSCN frame\n");
166 rjt_data
.reason
= ELS_RJT_LOGIC
;
167 rjt_data
.explan
= ELS_EXPL_NONE
;
168 fc_seq_els_rsp_send(fp
, ELS_LS_RJT
, &rjt_data
);
173 * fc_disc_recv_req() - Handle incoming requests
174 * @lport: The local port receiving the request
175 * @fp: The request frame
177 * Locking Note: This function is called from the EM and will lock
178 * the disc_mutex before calling the handler for the
181 static void fc_disc_recv_req(struct fc_lport
*lport
, struct fc_frame
*fp
)
184 struct fc_disc
*disc
= &lport
->disc
;
186 op
= fc_frame_payload_op(fp
);
189 mutex_lock(&disc
->disc_mutex
);
190 fc_disc_recv_rscn_req(disc
, fp
);
191 mutex_unlock(&disc
->disc_mutex
);
194 FC_DISC_DBG(disc
, "Received an unsupported request, "
195 "the opcode is (%x)\n", op
);
202 * fc_disc_restart() - Restart discovery
203 * @disc: The discovery object to be restarted
205 static void fc_disc_restart(struct fc_disc
*disc
)
207 lockdep_assert_held(&disc
->disc_mutex
);
209 if (!disc
->disc_callback
)
212 FC_DISC_DBG(disc
, "Restarting discovery\n");
219 * Advance disc_id. This is an arbitrary non-zero number that will
220 * match the value in the fc_rport_priv after discovery for all
221 * freshly-discovered remote ports. Avoid wrapping to zero.
223 disc
->disc_id
= (disc
->disc_id
+ 2) | 1;
224 disc
->retry_count
= 0;
225 fc_disc_gpn_ft_req(disc
);
229 * fc_disc_start() - Start discovery on a local port
230 * @lport: The local port to have discovery started on
231 * @disc_callback: Callback function to be called when discovery is complete
233 static void fc_disc_start(void (*disc_callback
)(struct fc_lport
*,
235 struct fc_lport
*lport
)
237 struct fc_disc
*disc
= &lport
->disc
;
240 * At this point we may have a new disc job or an existing
241 * one. Either way, let's lock when we make changes to it
242 * and send the GPN_FT request.
244 mutex_lock(&disc
->disc_mutex
);
245 disc
->disc_callback
= disc_callback
;
246 fc_disc_restart(disc
);
247 mutex_unlock(&disc
->disc_mutex
);
251 * fc_disc_done() - Discovery has been completed
252 * @disc: The discovery context
253 * @event: The discovery completion status
255 static void fc_disc_done(struct fc_disc
*disc
, enum fc_disc_event event
)
257 struct fc_lport
*lport
= fc_disc_lport(disc
);
258 struct fc_rport_priv
*rdata
;
260 lockdep_assert_held(&disc
->disc_mutex
);
261 FC_DISC_DBG(disc
, "Discovery complete\n");
264 if (disc
->requested
) {
265 fc_disc_restart(disc
);
270 * Go through all remote ports. If they were found in the latest
271 * discovery, reverify or log them in. Otherwise, log them out.
272 * Skip ports which were never discovered. These are the dNS port
273 * and ports which were created by PLOGI.
275 * We don't need to use the _rcu variant here as the rport list
276 * is protected by the disc mutex which is already held on entry.
278 list_for_each_entry(rdata
, &disc
->rports
, peers
) {
279 if (!kref_get_unless_zero(&rdata
->kref
))
281 if (rdata
->disc_id
) {
282 if (rdata
->disc_id
== disc
->disc_id
)
283 fc_rport_login(rdata
);
285 fc_rport_logoff(rdata
);
287 kref_put(&rdata
->kref
, fc_rport_destroy
);
289 mutex_unlock(&disc
->disc_mutex
);
290 disc
->disc_callback(lport
, event
);
291 mutex_lock(&disc
->disc_mutex
);
295 * fc_disc_error() - Handle error on dNS request
296 * @disc: The discovery context
297 * @fp: The error code encoded as a frame pointer
299 static void fc_disc_error(struct fc_disc
*disc
, struct fc_frame
*fp
)
301 struct fc_lport
*lport
= fc_disc_lport(disc
);
302 unsigned long delay
= 0;
304 FC_DISC_DBG(disc
, "Error %ld, retries %d/%d\n",
305 PTR_ERR(fp
), disc
->retry_count
,
306 FC_DISC_RETRY_LIMIT
);
308 if (!fp
|| PTR_ERR(fp
) == -FC_EX_TIMEOUT
) {
310 * Memory allocation failure, or the exchange timed out,
313 if (disc
->retry_count
< FC_DISC_RETRY_LIMIT
) {
314 /* go ahead and retry */
316 delay
= msecs_to_jiffies(FC_DISC_RETRY_DELAY
);
318 delay
= msecs_to_jiffies(lport
->e_d_tov
);
320 /* timeout faster first time */
321 if (!disc
->retry_count
)
325 schedule_delayed_work(&disc
->disc_work
, delay
);
327 fc_disc_done(disc
, DISC_EV_FAILED
);
328 } else if (PTR_ERR(fp
) == -FC_EX_CLOSED
) {
330 * if discovery fails due to lport reset, clear
331 * pending flag so that subsequent discovery can
339 * fc_disc_gpn_ft_req() - Send Get Port Names by FC-4 type (GPN_FT) request
340 * @lport: The discovery context
342 static void fc_disc_gpn_ft_req(struct fc_disc
*disc
)
345 struct fc_lport
*lport
= fc_disc_lport(disc
);
347 lockdep_assert_held(&disc
->disc_mutex
);
349 WARN_ON(!fc_lport_test_ready(lport
));
356 fp
= fc_frame_alloc(lport
,
357 sizeof(struct fc_ct_hdr
) +
358 sizeof(struct fc_ns_gid_ft
));
362 if (lport
->tt
.elsct_send(lport
, 0, fp
,
365 disc
, 3 * lport
->r_a_tov
))
368 fc_disc_error(disc
, NULL
);
372 * fc_disc_gpn_ft_parse() - Parse the body of the dNS GPN_FT response.
373 * @lport: The local port the GPN_FT was received on
374 * @buf: The GPN_FT response buffer
375 * @len: The size of response buffer
377 * Goes through the list of IDs and names resulting from a request.
379 static int fc_disc_gpn_ft_parse(struct fc_disc
*disc
, void *buf
, size_t len
)
381 struct fc_lport
*lport
;
382 struct fc_gpn_ft_resp
*np
;
387 struct fc_rport_identifiers ids
;
388 struct fc_rport_priv
*rdata
;
390 lport
= fc_disc_lport(disc
);
394 * Handle partial name record left over from previous call.
398 np
= (struct fc_gpn_ft_resp
*)bp
;
399 tlen
= disc
->buf_len
;
402 WARN_ON(tlen
>= sizeof(*np
));
403 plen
= sizeof(*np
) - tlen
;
405 WARN_ON(plen
>= sizeof(*np
));
408 np
= &disc
->partial_buf
;
409 memcpy((char *)np
+ tlen
, bp
, plen
);
412 * Set bp so that the loop below will advance it to the
413 * first valid full name element.
418 disc
->buf_len
= (unsigned char) plen
;
419 if (plen
== sizeof(*np
))
424 * Handle full name records, including the one filled from above.
425 * Normally, np == bp and plen == len, but from the partial case above,
426 * bp, len describe the overall buffer, and np, plen describe the
427 * partial buffer, which if would usually be full now.
428 * After the first time through the loop, things return to "normal".
430 while (plen
>= sizeof(*np
)) {
431 ids
.port_id
= ntoh24(np
->fp_fid
);
432 ids
.port_name
= ntohll(np
->fp_wwpn
);
434 if (ids
.port_id
!= lport
->port_id
&&
435 ids
.port_name
!= lport
->wwpn
) {
436 rdata
= fc_rport_create(lport
, ids
.port_id
);
438 rdata
->ids
.port_name
= ids
.port_name
;
439 rdata
->disc_id
= disc
->disc_id
;
441 printk(KERN_WARNING
"libfc: Failed to allocate "
442 "memory for the newly discovered port "
443 "(%6.6x)\n", ids
.port_id
);
448 if (np
->fp_flags
& FC_NS_FID_LAST
) {
449 fc_disc_done(disc
, DISC_EV_SUCCESS
);
455 np
= (struct fc_gpn_ft_resp
*)bp
;
460 * Save any partial record at the end of the buffer for next time.
462 if (error
== 0 && len
> 0 && len
< sizeof(*np
)) {
463 if (np
!= &disc
->partial_buf
) {
464 FC_DISC_DBG(disc
, "Partial buffer remains "
466 memcpy(&disc
->partial_buf
, np
, len
);
468 disc
->buf_len
= (unsigned char) len
;
474 * fc_disc_timeout() - Handler for discovery timeouts
475 * @work: Structure holding discovery context that needs to retry discovery
477 static void fc_disc_timeout(struct work_struct
*work
)
479 struct fc_disc
*disc
= container_of(work
,
482 mutex_lock(&disc
->disc_mutex
);
483 fc_disc_gpn_ft_req(disc
);
484 mutex_unlock(&disc
->disc_mutex
);
488 * fc_disc_gpn_ft_resp() - Handle a response frame from Get Port Names (GPN_FT)
489 * @sp: The sequence that the GPN_FT response was received on
490 * @fp: The GPN_FT response frame
491 * @lp_arg: The discovery context
493 * Locking Note: This function is called without disc mutex held, and
494 * should do all its processing with the mutex held
496 static void fc_disc_gpn_ft_resp(struct fc_seq
*sp
, struct fc_frame
*fp
,
499 struct fc_disc
*disc
= disc_arg
;
500 struct fc_ct_hdr
*cp
;
501 struct fc_frame_header
*fh
;
502 enum fc_disc_event event
= DISC_EV_NONE
;
503 unsigned int seq_cnt
;
507 mutex_lock(&disc
->disc_mutex
);
508 FC_DISC_DBG(disc
, "Received a GPN_FT response\n");
511 fc_disc_error(disc
, fp
);
512 mutex_unlock(&disc
->disc_mutex
);
516 WARN_ON(!fc_frame_is_linear(fp
)); /* buffer must be contiguous */
517 fh
= fc_frame_header_get(fp
);
518 len
= fr_len(fp
) - sizeof(*fh
);
519 seq_cnt
= ntohs(fh
->fh_seq_cnt
);
520 if (fr_sof(fp
) == FC_SOF_I3
&& seq_cnt
== 0 && disc
->seq_count
== 0) {
521 cp
= fc_frame_payload_get(fp
, sizeof(*cp
));
523 FC_DISC_DBG(disc
, "GPN_FT response too short, len %d\n",
525 event
= DISC_EV_FAILED
;
526 } else if (ntohs(cp
->ct_cmd
) == FC_FS_ACC
) {
528 /* Accepted, parse the response. */
530 error
= fc_disc_gpn_ft_parse(disc
, cp
+ 1, len
);
531 } else if (ntohs(cp
->ct_cmd
) == FC_FS_RJT
) {
532 FC_DISC_DBG(disc
, "GPN_FT rejected reason %x exp %x "
533 "(check zoning)\n", cp
->ct_reason
,
535 event
= DISC_EV_FAILED
;
536 if (cp
->ct_reason
== FC_FS_RJT_UNABL
&&
537 cp
->ct_explan
== FC_FS_EXP_FTNR
)
538 event
= DISC_EV_SUCCESS
;
540 FC_DISC_DBG(disc
, "GPN_FT unexpected response code "
541 "%x\n", ntohs(cp
->ct_cmd
));
542 event
= DISC_EV_FAILED
;
544 } else if (fr_sof(fp
) == FC_SOF_N3
&& seq_cnt
== disc
->seq_count
) {
545 error
= fc_disc_gpn_ft_parse(disc
, fh
+ 1, len
);
547 FC_DISC_DBG(disc
, "GPN_FT unexpected frame - out of sequence? "
548 "seq_cnt %x expected %x sof %x eof %x\n",
549 seq_cnt
, disc
->seq_count
, fr_sof(fp
), fr_eof(fp
));
550 event
= DISC_EV_FAILED
;
553 fc_disc_error(disc
, ERR_PTR(error
));
554 else if (event
!= DISC_EV_NONE
)
555 fc_disc_done(disc
, event
);
557 mutex_unlock(&disc
->disc_mutex
);
561 * fc_disc_gpn_id_resp() - Handle a response frame from Get Port Names (GPN_ID)
562 * @sp: The sequence the GPN_ID is on
563 * @fp: The response frame
564 * @rdata_arg: The remote port that sent the GPN_ID response
566 * Locking Note: This function is called without disc mutex held.
568 static void fc_disc_gpn_id_resp(struct fc_seq
*sp
, struct fc_frame
*fp
,
571 struct fc_rport_priv
*rdata
= rdata_arg
;
572 struct fc_rport_priv
*new_rdata
;
573 struct fc_lport
*lport
;
574 struct fc_disc
*disc
;
575 struct fc_ct_hdr
*cp
;
576 struct fc_ns_gid_pn
*pn
;
579 lport
= rdata
->local_port
;
582 if (PTR_ERR(fp
) == -FC_EX_CLOSED
)
587 cp
= fc_frame_payload_get(fp
, sizeof(*cp
));
590 if (ntohs(cp
->ct_cmd
) == FC_FS_ACC
) {
591 if (fr_len(fp
) < sizeof(struct fc_frame_header
) +
592 sizeof(*cp
) + sizeof(*pn
))
594 pn
= (struct fc_ns_gid_pn
*)(cp
+ 1);
595 port_name
= get_unaligned_be64(&pn
->fn_wwpn
);
596 mutex_lock(&rdata
->rp_mutex
);
597 if (rdata
->ids
.port_name
== -1)
598 rdata
->ids
.port_name
= port_name
;
599 else if (rdata
->ids
.port_name
!= port_name
) {
600 FC_DISC_DBG(disc
, "GPN_ID accepted. WWPN changed. "
601 "Port-id %6.6x wwpn %16.16llx\n",
602 rdata
->ids
.port_id
, port_name
);
603 mutex_unlock(&rdata
->rp_mutex
);
604 fc_rport_logoff(rdata
);
605 mutex_lock(&lport
->disc
.disc_mutex
);
606 new_rdata
= fc_rport_create(lport
, rdata
->ids
.port_id
);
607 mutex_unlock(&lport
->disc
.disc_mutex
);
609 new_rdata
->disc_id
= disc
->disc_id
;
610 fc_rport_login(new_rdata
);
614 rdata
->disc_id
= disc
->disc_id
;
615 mutex_unlock(&rdata
->rp_mutex
);
616 fc_rport_login(rdata
);
617 } else if (ntohs(cp
->ct_cmd
) == FC_FS_RJT
) {
618 FC_DISC_DBG(disc
, "GPN_ID rejected reason %x exp %x\n",
619 cp
->ct_reason
, cp
->ct_explan
);
620 fc_rport_logoff(rdata
);
622 FC_DISC_DBG(disc
, "GPN_ID unexpected response code %x\n",
625 mutex_lock(&disc
->disc_mutex
);
626 fc_disc_restart(disc
);
627 mutex_unlock(&disc
->disc_mutex
);
630 kref_put(&rdata
->kref
, fc_rport_destroy
);
634 * fc_disc_gpn_id_req() - Send Get Port Names by ID (GPN_ID) request
635 * @lport: The local port to initiate discovery on
636 * @rdata: remote port private data
638 * On failure, an error code is returned.
640 static int fc_disc_gpn_id_req(struct fc_lport
*lport
,
641 struct fc_rport_priv
*rdata
)
645 lockdep_assert_held(&lport
->disc
.disc_mutex
);
646 fp
= fc_frame_alloc(lport
, sizeof(struct fc_ct_hdr
) +
647 sizeof(struct fc_ns_fid
));
650 if (!lport
->tt
.elsct_send(lport
, rdata
->ids
.port_id
, fp
, FC_NS_GPN_ID
,
651 fc_disc_gpn_id_resp
, rdata
,
654 kref_get(&rdata
->kref
);
659 * fc_disc_single() - Discover the directory information for a single target
660 * @lport: The local port the remote port is associated with
661 * @dp: The port to rediscover
663 static int fc_disc_single(struct fc_lport
*lport
, struct fc_disc_port
*dp
)
665 struct fc_rport_priv
*rdata
;
667 lockdep_assert_held(&lport
->disc
.disc_mutex
);
669 rdata
= fc_rport_create(lport
, dp
->port_id
);
673 return fc_disc_gpn_id_req(lport
, rdata
);
677 * fc_disc_stop() - Stop discovery for a given lport
678 * @lport: The local port that discovery should stop on
680 static void fc_disc_stop(struct fc_lport
*lport
)
682 struct fc_disc
*disc
= &lport
->disc
;
685 cancel_delayed_work_sync(&disc
->disc_work
);
686 mutex_lock(&disc
->disc_mutex
);
687 fc_disc_stop_rports(disc
);
688 mutex_unlock(&disc
->disc_mutex
);
692 * fc_disc_stop_final() - Stop discovery for a given lport
693 * @lport: The lport that discovery should stop on
695 * This function will block until discovery has been
696 * completely stopped and all rports have been deleted.
698 static void fc_disc_stop_final(struct fc_lport
*lport
)
701 fc_rport_flush_queue();
705 * fc_disc_config() - Configure the discovery layer for a local port
706 * @lport: The local port that needs the discovery layer to be configured
707 * @priv: Private data structre for users of the discovery layer
709 void fc_disc_config(struct fc_lport
*lport
, void *priv
)
711 struct fc_disc
*disc
;
713 if (!lport
->tt
.disc_start
)
714 lport
->tt
.disc_start
= fc_disc_start
;
716 if (!lport
->tt
.disc_stop
)
717 lport
->tt
.disc_stop
= fc_disc_stop
;
719 if (!lport
->tt
.disc_stop_final
)
720 lport
->tt
.disc_stop_final
= fc_disc_stop_final
;
722 if (!lport
->tt
.disc_recv_req
)
723 lport
->tt
.disc_recv_req
= fc_disc_recv_req
;
729 EXPORT_SYMBOL(fc_disc_config
);
732 * fc_disc_init() - Initialize the discovery layer for a local port
733 * @lport: The local port that needs the discovery layer to be initialized
735 void fc_disc_init(struct fc_lport
*lport
)
737 struct fc_disc
*disc
= &lport
->disc
;
739 INIT_DELAYED_WORK(&disc
->disc_work
, fc_disc_timeout
);
740 mutex_init(&disc
->disc_mutex
);
741 INIT_LIST_HEAD(&disc
->rports
);
743 EXPORT_SYMBOL(fc_disc_init
);