2 * Copyright(c) 2007 - 2008 Intel Corporation. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
17 * Maintained at www.Open-FCoE.org
23 * This block discovers all FC-4 remote ports, including FCP initiators. It
24 * also handles RSCN events and re-discovery if necessary.
30 * The disc mutex is can be locked when acquiring rport locks, but may not
31 * be held when acquiring the lport lock. Refer to fc_lport.c for more
35 #include <linux/timer.h>
36 #include <linux/slab.h>
37 #include <linux/err.h>
38 #include <linux/export.h>
39 #include <asm/unaligned.h>
41 #include <scsi/fc/fc_gs.h>
43 #include <scsi/libfc.h>
47 #define FC_DISC_RETRY_LIMIT 3 /* max retries */
48 #define FC_DISC_RETRY_DELAY 500UL /* (msecs) delay */
50 static void fc_disc_gpn_ft_req(struct fc_disc
*);
51 static void fc_disc_gpn_ft_resp(struct fc_seq
*, struct fc_frame
*, void *);
52 static void fc_disc_done(struct fc_disc
*, enum fc_disc_event
);
53 static void fc_disc_timeout(struct work_struct
*);
54 static int fc_disc_single(struct fc_lport
*, struct fc_disc_port
*);
55 static void fc_disc_restart(struct fc_disc
*);
58 * fc_disc_stop_rports() - Delete all the remote ports associated with the lport
59 * @disc: The discovery job to stop remote ports on
61 * Locking Note: This function expects that the lport mutex is locked before
64 void fc_disc_stop_rports(struct fc_disc
*disc
)
66 struct fc_lport
*lport
;
67 struct fc_rport_priv
*rdata
;
69 lport
= fc_disc_lport(disc
);
71 mutex_lock(&disc
->disc_mutex
);
72 list_for_each_entry_rcu(rdata
, &disc
->rports
, peers
)
73 lport
->tt
.rport_logoff(rdata
);
74 mutex_unlock(&disc
->disc_mutex
);
78 * fc_disc_recv_rscn_req() - Handle Registered State Change Notification (RSCN)
79 * @disc: The discovery object to which the RSCN applies
82 * Locking Note: This function expects that the disc_mutex is locked
83 * before it is called.
85 static void fc_disc_recv_rscn_req(struct fc_disc
*disc
, struct fc_frame
*fp
)
87 struct fc_lport
*lport
;
88 struct fc_els_rscn
*rp
;
89 struct fc_els_rscn_page
*pp
;
90 struct fc_seq_els_data rjt_data
;
93 enum fc_els_rscn_ev_qual ev_qual
;
94 enum fc_els_rscn_addr_fmt fmt
;
95 LIST_HEAD(disc_ports
);
96 struct fc_disc_port
*dp
, *next
;
98 lport
= fc_disc_lport(disc
);
100 FC_DISC_DBG(disc
, "Received an RSCN event\n");
102 /* make sure the frame contains an RSCN message */
103 rp
= fc_frame_payload_get(fp
, sizeof(*rp
));
106 /* make sure the page length is as expected (4 bytes) */
107 if (rp
->rscn_page_len
!= sizeof(*pp
))
109 /* get the RSCN payload length */
110 len
= ntohs(rp
->rscn_plen
);
111 if (len
< sizeof(*rp
))
113 /* make sure the frame contains the expected payload */
114 rp
= fc_frame_payload_get(fp
, len
);
117 /* payload must be a multiple of the RSCN page size */
119 if (len
% sizeof(*pp
))
122 for (pp
= (void *)(rp
+ 1); len
> 0; len
-= sizeof(*pp
), pp
++) {
123 ev_qual
= pp
->rscn_page_flags
>> ELS_RSCN_EV_QUAL_BIT
;
124 ev_qual
&= ELS_RSCN_EV_QUAL_MASK
;
125 fmt
= pp
->rscn_page_flags
>> ELS_RSCN_ADDR_FMT_BIT
;
126 fmt
&= ELS_RSCN_ADDR_FMT_MASK
;
128 * if we get an address format other than port
129 * (area, domain, fabric), then do a full discovery
132 case ELS_ADDR_FMT_PORT
:
133 FC_DISC_DBG(disc
, "Port address format for port "
134 "(%6.6x)\n", ntoh24(pp
->rscn_fid
));
135 dp
= kzalloc(sizeof(*dp
), GFP_KERNEL
);
141 dp
->port_id
= ntoh24(pp
->rscn_fid
);
142 list_add_tail(&dp
->peers
, &disc_ports
);
144 case ELS_ADDR_FMT_AREA
:
145 case ELS_ADDR_FMT_DOM
:
146 case ELS_ADDR_FMT_FAB
:
148 FC_DISC_DBG(disc
, "Address format is (%d)\n", fmt
);
153 lport
->tt
.seq_els_rsp_send(fp
, ELS_LS_ACC
, NULL
);
156 * If not doing a complete rediscovery, do GPN_ID on
157 * the individual ports mentioned in the list.
158 * If any of these get an error, do a full rediscovery.
159 * In any case, go through the list and free the entries.
161 list_for_each_entry_safe(dp
, next
, &disc_ports
, peers
) {
162 list_del(&dp
->peers
);
164 redisc
= fc_disc_single(lport
, dp
);
168 FC_DISC_DBG(disc
, "RSCN received: rediscovering\n");
169 fc_disc_restart(disc
);
171 FC_DISC_DBG(disc
, "RSCN received: not rediscovering. "
172 "redisc %d state %d in_prog %d\n",
173 redisc
, lport
->state
, disc
->pending
);
178 FC_DISC_DBG(disc
, "Received a bad RSCN frame\n");
179 rjt_data
.reason
= ELS_RJT_LOGIC
;
180 rjt_data
.explan
= ELS_EXPL_NONE
;
181 lport
->tt
.seq_els_rsp_send(fp
, ELS_LS_RJT
, &rjt_data
);
186 * fc_disc_recv_req() - Handle incoming requests
187 * @lport: The local port receiving the request
188 * @fp: The request frame
190 * Locking Note: This function is called from the EM and will lock
191 * the disc_mutex before calling the handler for the
194 static void fc_disc_recv_req(struct fc_lport
*lport
, struct fc_frame
*fp
)
197 struct fc_disc
*disc
= &lport
->disc
;
199 op
= fc_frame_payload_op(fp
);
202 mutex_lock(&disc
->disc_mutex
);
203 fc_disc_recv_rscn_req(disc
, fp
);
204 mutex_unlock(&disc
->disc_mutex
);
207 FC_DISC_DBG(disc
, "Received an unsupported request, "
208 "the opcode is (%x)\n", op
);
215 * fc_disc_restart() - Restart discovery
216 * @disc: The discovery object to be restarted
218 * Locking Note: This function expects that the disc mutex
221 static void fc_disc_restart(struct fc_disc
*disc
)
223 if (!disc
->disc_callback
)
226 FC_DISC_DBG(disc
, "Restarting discovery\n");
233 * Advance disc_id. This is an arbitrary non-zero number that will
234 * match the value in the fc_rport_priv after discovery for all
235 * freshly-discovered remote ports. Avoid wrapping to zero.
237 disc
->disc_id
= (disc
->disc_id
+ 2) | 1;
238 disc
->retry_count
= 0;
239 fc_disc_gpn_ft_req(disc
);
243 * fc_disc_start() - Start discovery on a local port
244 * @lport: The local port to have discovery started on
245 * @disc_callback: Callback function to be called when discovery is complete
247 static void fc_disc_start(void (*disc_callback
)(struct fc_lport
*,
249 struct fc_lport
*lport
)
251 struct fc_disc
*disc
= &lport
->disc
;
254 * At this point we may have a new disc job or an existing
255 * one. Either way, let's lock when we make changes to it
256 * and send the GPN_FT request.
258 mutex_lock(&disc
->disc_mutex
);
259 disc
->disc_callback
= disc_callback
;
260 fc_disc_restart(disc
);
261 mutex_unlock(&disc
->disc_mutex
);
265 * fc_disc_done() - Discovery has been completed
266 * @disc: The discovery context
267 * @event: The discovery completion status
269 * Locking Note: This function expects that the disc mutex is locked before
270 * it is called. The discovery callback is then made with the lock released,
271 * and the lock is re-taken before returning from this function
273 static void fc_disc_done(struct fc_disc
*disc
, enum fc_disc_event event
)
275 struct fc_lport
*lport
= fc_disc_lport(disc
);
276 struct fc_rport_priv
*rdata
;
278 FC_DISC_DBG(disc
, "Discovery complete\n");
281 if (disc
->requested
) {
282 fc_disc_restart(disc
);
287 * Go through all remote ports. If they were found in the latest
288 * discovery, reverify or log them in. Otherwise, log them out.
289 * Skip ports which were never discovered. These are the dNS port
290 * and ports which were created by PLOGI.
292 list_for_each_entry_rcu(rdata
, &disc
->rports
, peers
) {
295 if (rdata
->disc_id
== disc
->disc_id
)
296 lport
->tt
.rport_login(rdata
);
298 lport
->tt
.rport_logoff(rdata
);
301 mutex_unlock(&disc
->disc_mutex
);
302 disc
->disc_callback(lport
, event
);
303 mutex_lock(&disc
->disc_mutex
);
307 * fc_disc_error() - Handle error on dNS request
308 * @disc: The discovery context
309 * @fp: The error code encoded as a frame pointer
311 static void fc_disc_error(struct fc_disc
*disc
, struct fc_frame
*fp
)
313 struct fc_lport
*lport
= fc_disc_lport(disc
);
314 unsigned long delay
= 0;
316 FC_DISC_DBG(disc
, "Error %ld, retries %d/%d\n",
317 PTR_ERR(fp
), disc
->retry_count
,
318 FC_DISC_RETRY_LIMIT
);
320 if (!fp
|| PTR_ERR(fp
) == -FC_EX_TIMEOUT
) {
322 * Memory allocation failure, or the exchange timed out,
325 if (disc
->retry_count
< FC_DISC_RETRY_LIMIT
) {
326 /* go ahead and retry */
328 delay
= msecs_to_jiffies(FC_DISC_RETRY_DELAY
);
330 delay
= msecs_to_jiffies(lport
->e_d_tov
);
332 /* timeout faster first time */
333 if (!disc
->retry_count
)
337 schedule_delayed_work(&disc
->disc_work
, delay
);
339 fc_disc_done(disc
, DISC_EV_FAILED
);
344 * fc_disc_gpn_ft_req() - Send Get Port Names by FC-4 type (GPN_FT) request
345 * @lport: The discovery context
347 * Locking Note: This function expects that the disc_mutex is locked
348 * before it is called.
350 static void fc_disc_gpn_ft_req(struct fc_disc
*disc
)
353 struct fc_lport
*lport
= fc_disc_lport(disc
);
355 WARN_ON(!fc_lport_test_ready(lport
));
362 fp
= fc_frame_alloc(lport
,
363 sizeof(struct fc_ct_hdr
) +
364 sizeof(struct fc_ns_gid_ft
));
368 if (lport
->tt
.elsct_send(lport
, 0, fp
,
371 disc
, 3 * lport
->r_a_tov
))
374 fc_disc_error(disc
, NULL
);
378 * fc_disc_gpn_ft_parse() - Parse the body of the dNS GPN_FT response.
379 * @lport: The local port the GPN_FT was received on
380 * @buf: The GPN_FT response buffer
381 * @len: The size of response buffer
383 * Goes through the list of IDs and names resulting from a request.
385 static int fc_disc_gpn_ft_parse(struct fc_disc
*disc
, void *buf
, size_t len
)
387 struct fc_lport
*lport
;
388 struct fc_gpn_ft_resp
*np
;
393 struct fc_rport_identifiers ids
;
394 struct fc_rport_priv
*rdata
;
396 lport
= fc_disc_lport(disc
);
400 * Handle partial name record left over from previous call.
404 np
= (struct fc_gpn_ft_resp
*)bp
;
405 tlen
= disc
->buf_len
;
408 WARN_ON(tlen
>= sizeof(*np
));
409 plen
= sizeof(*np
) - tlen
;
411 WARN_ON(plen
>= sizeof(*np
));
414 np
= &disc
->partial_buf
;
415 memcpy((char *)np
+ tlen
, bp
, plen
);
418 * Set bp so that the loop below will advance it to the
419 * first valid full name element.
424 disc
->buf_len
= (unsigned char) plen
;
425 if (plen
== sizeof(*np
))
430 * Handle full name records, including the one filled from above.
431 * Normally, np == bp and plen == len, but from the partial case above,
432 * bp, len describe the overall buffer, and np, plen describe the
433 * partial buffer, which if would usually be full now.
434 * After the first time through the loop, things return to "normal".
436 while (plen
>= sizeof(*np
)) {
437 ids
.port_id
= ntoh24(np
->fp_fid
);
438 ids
.port_name
= ntohll(np
->fp_wwpn
);
440 if (ids
.port_id
!= lport
->port_id
&&
441 ids
.port_name
!= lport
->wwpn
) {
442 rdata
= lport
->tt
.rport_create(lport
, ids
.port_id
);
444 rdata
->ids
.port_name
= ids
.port_name
;
445 rdata
->disc_id
= disc
->disc_id
;
447 printk(KERN_WARNING
"libfc: Failed to allocate "
448 "memory for the newly discovered port "
449 "(%6.6x)\n", ids
.port_id
);
454 if (np
->fp_flags
& FC_NS_FID_LAST
) {
455 fc_disc_done(disc
, DISC_EV_SUCCESS
);
461 np
= (struct fc_gpn_ft_resp
*)bp
;
466 * Save any partial record at the end of the buffer for next time.
468 if (error
== 0 && len
> 0 && len
< sizeof(*np
)) {
469 if (np
!= &disc
->partial_buf
) {
470 FC_DISC_DBG(disc
, "Partial buffer remains "
472 memcpy(&disc
->partial_buf
, np
, len
);
474 disc
->buf_len
= (unsigned char) len
;
480 * fc_disc_timeout() - Handler for discovery timeouts
481 * @work: Structure holding discovery context that needs to retry discovery
483 static void fc_disc_timeout(struct work_struct
*work
)
485 struct fc_disc
*disc
= container_of(work
,
488 mutex_lock(&disc
->disc_mutex
);
489 fc_disc_gpn_ft_req(disc
);
490 mutex_unlock(&disc
->disc_mutex
);
494 * fc_disc_gpn_ft_resp() - Handle a response frame from Get Port Names (GPN_FT)
495 * @sp: The sequence that the GPN_FT response was received on
496 * @fp: The GPN_FT response frame
497 * @lp_arg: The discovery context
499 * Locking Note: This function is called without disc mutex held, and
500 * should do all its processing with the mutex held
502 static void fc_disc_gpn_ft_resp(struct fc_seq
*sp
, struct fc_frame
*fp
,
505 struct fc_disc
*disc
= disc_arg
;
506 struct fc_ct_hdr
*cp
;
507 struct fc_frame_header
*fh
;
508 enum fc_disc_event event
= DISC_EV_NONE
;
509 unsigned int seq_cnt
;
513 mutex_lock(&disc
->disc_mutex
);
514 FC_DISC_DBG(disc
, "Received a GPN_FT response\n");
517 fc_disc_error(disc
, fp
);
518 mutex_unlock(&disc
->disc_mutex
);
522 WARN_ON(!fc_frame_is_linear(fp
)); /* buffer must be contiguous */
523 fh
= fc_frame_header_get(fp
);
524 len
= fr_len(fp
) - sizeof(*fh
);
525 seq_cnt
= ntohs(fh
->fh_seq_cnt
);
526 if (fr_sof(fp
) == FC_SOF_I3
&& seq_cnt
== 0 && disc
->seq_count
== 0) {
527 cp
= fc_frame_payload_get(fp
, sizeof(*cp
));
529 FC_DISC_DBG(disc
, "GPN_FT response too short, len %d\n",
531 event
= DISC_EV_FAILED
;
532 } else if (ntohs(cp
->ct_cmd
) == FC_FS_ACC
) {
534 /* Accepted, parse the response. */
536 error
= fc_disc_gpn_ft_parse(disc
, cp
+ 1, len
);
537 } else if (ntohs(cp
->ct_cmd
) == FC_FS_RJT
) {
538 FC_DISC_DBG(disc
, "GPN_FT rejected reason %x exp %x "
539 "(check zoning)\n", cp
->ct_reason
,
541 event
= DISC_EV_FAILED
;
542 if (cp
->ct_reason
== FC_FS_RJT_UNABL
&&
543 cp
->ct_explan
== FC_FS_EXP_FTNR
)
544 event
= DISC_EV_SUCCESS
;
546 FC_DISC_DBG(disc
, "GPN_FT unexpected response code "
547 "%x\n", ntohs(cp
->ct_cmd
));
548 event
= DISC_EV_FAILED
;
550 } else if (fr_sof(fp
) == FC_SOF_N3
&& seq_cnt
== disc
->seq_count
) {
551 error
= fc_disc_gpn_ft_parse(disc
, fh
+ 1, len
);
553 FC_DISC_DBG(disc
, "GPN_FT unexpected frame - out of sequence? "
554 "seq_cnt %x expected %x sof %x eof %x\n",
555 seq_cnt
, disc
->seq_count
, fr_sof(fp
), fr_eof(fp
));
556 event
= DISC_EV_FAILED
;
559 fc_disc_error(disc
, fp
);
560 else if (event
!= DISC_EV_NONE
)
561 fc_disc_done(disc
, event
);
563 mutex_unlock(&disc
->disc_mutex
);
567 * fc_disc_gpn_id_resp() - Handle a response frame from Get Port Names (GPN_ID)
568 * @sp: The sequence the GPN_ID is on
569 * @fp: The response frame
570 * @rdata_arg: The remote port that sent the GPN_ID response
572 * Locking Note: This function is called without disc mutex held.
574 static void fc_disc_gpn_id_resp(struct fc_seq
*sp
, struct fc_frame
*fp
,
577 struct fc_rport_priv
*rdata
= rdata_arg
;
578 struct fc_rport_priv
*new_rdata
;
579 struct fc_lport
*lport
;
580 struct fc_disc
*disc
;
581 struct fc_ct_hdr
*cp
;
582 struct fc_ns_gid_pn
*pn
;
585 lport
= rdata
->local_port
;
588 mutex_lock(&disc
->disc_mutex
);
589 if (PTR_ERR(fp
) == -FC_EX_CLOSED
)
594 cp
= fc_frame_payload_get(fp
, sizeof(*cp
));
597 if (ntohs(cp
->ct_cmd
) == FC_FS_ACC
) {
598 if (fr_len(fp
) < sizeof(struct fc_frame_header
) +
599 sizeof(*cp
) + sizeof(*pn
))
601 pn
= (struct fc_ns_gid_pn
*)(cp
+ 1);
602 port_name
= get_unaligned_be64(&pn
->fn_wwpn
);
603 if (rdata
->ids
.port_name
== -1)
604 rdata
->ids
.port_name
= port_name
;
605 else if (rdata
->ids
.port_name
!= port_name
) {
606 FC_DISC_DBG(disc
, "GPN_ID accepted. WWPN changed. "
607 "Port-id %6.6x wwpn %16.16llx\n",
608 rdata
->ids
.port_id
, port_name
);
609 lport
->tt
.rport_logoff(rdata
);
611 new_rdata
= lport
->tt
.rport_create(lport
,
614 new_rdata
->disc_id
= disc
->disc_id
;
615 lport
->tt
.rport_login(new_rdata
);
619 rdata
->disc_id
= disc
->disc_id
;
620 lport
->tt
.rport_login(rdata
);
621 } else if (ntohs(cp
->ct_cmd
) == FC_FS_RJT
) {
622 FC_DISC_DBG(disc
, "GPN_ID rejected reason %x exp %x\n",
623 cp
->ct_reason
, cp
->ct_explan
);
624 lport
->tt
.rport_logoff(rdata
);
626 FC_DISC_DBG(disc
, "GPN_ID unexpected response code %x\n",
629 fc_disc_restart(disc
);
632 mutex_unlock(&disc
->disc_mutex
);
633 kref_put(&rdata
->kref
, lport
->tt
.rport_destroy
);
637 * fc_disc_gpn_id_req() - Send Get Port Names by ID (GPN_ID) request
638 * @lport: The local port to initiate discovery on
639 * @rdata: remote port private data
641 * Locking Note: This function expects that the disc_mutex is locked
642 * before it is called.
643 * On failure, an error code is returned.
645 static int fc_disc_gpn_id_req(struct fc_lport
*lport
,
646 struct fc_rport_priv
*rdata
)
650 fp
= fc_frame_alloc(lport
, sizeof(struct fc_ct_hdr
) +
651 sizeof(struct fc_ns_fid
));
654 if (!lport
->tt
.elsct_send(lport
, rdata
->ids
.port_id
, fp
, FC_NS_GPN_ID
,
655 fc_disc_gpn_id_resp
, rdata
,
658 kref_get(&rdata
->kref
);
663 * fc_disc_single() - Discover the directory information for a single target
664 * @lport: The local port the remote port is associated with
665 * @dp: The port to rediscover
667 * Locking Note: This function expects that the disc_mutex is locked
668 * before it is called.
670 static int fc_disc_single(struct fc_lport
*lport
, struct fc_disc_port
*dp
)
672 struct fc_rport_priv
*rdata
;
674 rdata
= lport
->tt
.rport_create(lport
, dp
->port_id
);
678 return fc_disc_gpn_id_req(lport
, rdata
);
682 * fc_disc_stop() - Stop discovery for a given lport
683 * @lport: The local port that discovery should stop on
685 void fc_disc_stop(struct fc_lport
*lport
)
687 struct fc_disc
*disc
= &lport
->disc
;
690 cancel_delayed_work_sync(&disc
->disc_work
);
691 fc_disc_stop_rports(disc
);
695 * fc_disc_stop_final() - Stop discovery for a given lport
696 * @lport: The lport that discovery should stop on
698 * This function will block until discovery has been
699 * completely stopped and all rports have been deleted.
701 void fc_disc_stop_final(struct fc_lport
*lport
)
704 lport
->tt
.rport_flush_queue();
708 * fc_disc_init() - Initialize the discovery layer for a local port
709 * @lport: The local port that needs the discovery layer to be initialized
711 int fc_disc_init(struct fc_lport
*lport
)
713 struct fc_disc
*disc
;
715 if (!lport
->tt
.disc_start
)
716 lport
->tt
.disc_start
= fc_disc_start
;
718 if (!lport
->tt
.disc_stop
)
719 lport
->tt
.disc_stop
= fc_disc_stop
;
721 if (!lport
->tt
.disc_stop_final
)
722 lport
->tt
.disc_stop_final
= fc_disc_stop_final
;
724 if (!lport
->tt
.disc_recv_req
)
725 lport
->tt
.disc_recv_req
= fc_disc_recv_req
;
728 INIT_DELAYED_WORK(&disc
->disc_work
, fc_disc_timeout
);
729 mutex_init(&disc
->disc_mutex
);
730 INIT_LIST_HEAD(&disc
->rports
);
736 EXPORT_SYMBOL(fc_disc_init
);