2006-01-02 11:04:38 -07:00
|
|
|
/*
|
|
|
|
|
* net/tipc/link.h: Include file for TIPC link code
|
2007-02-09 07:25:21 -07:00
|
|
|
*
|
2014-08-22 16:09:07 -06:00
|
|
|
* Copyright (c) 1995-2006, 2013-2014, Ericsson AB
|
2011-01-07 09:43:40 -07:00
|
|
|
* Copyright (c) 2004-2005, 2010-2011, Wind River Systems
|
2006-01-02 11:04:38 -07:00
|
|
|
* All rights reserved.
|
|
|
|
|
*
|
2006-01-11 05:30:43 -07:00
|
|
|
* Redistribution and use in source and binary forms, with or without
|
2006-01-02 11:04:38 -07:00
|
|
|
* modification, are permitted provided that the following conditions are met:
|
|
|
|
|
*
|
2006-01-11 05:30:43 -07:00
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
|
* 2. 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.
|
|
|
|
|
* 3. Neither the names of the copyright holders nor the names of its
|
|
|
|
|
* contributors may be used to endorse or promote products derived from
|
|
|
|
|
* this software without specific prior written permission.
|
2006-01-02 11:04:38 -07:00
|
|
|
*
|
2006-01-11 05:30:43 -07:00
|
|
|
* Alternatively, this software may be distributed under the terms of the
|
|
|
|
|
* GNU General Public License ("GPL") version 2 as published by the Free
|
|
|
|
|
* Software Foundation.
|
|
|
|
|
*
|
|
|
|
|
* 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
|
2006-01-02 11:04:38 -07:00
|
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef _TIPC_LINK_H
|
|
|
|
|
#define _TIPC_LINK_H
|
|
|
|
|
|
2014-11-20 02:29:07 -07:00
|
|
|
#include <net/genetlink.h>
|
2006-01-02 11:04:38 -07:00
|
|
|
#include "msg.h"
|
|
|
|
|
#include "node.h"
|
|
|
|
|
|
2015-01-09 00:27:01 -07:00
|
|
|
/* TIPC-specific error codes
|
|
|
|
|
*/
|
|
|
|
|
#define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */
|
|
|
|
|
|
2015-07-30 16:24:21 -06:00
|
|
|
/* Link FSM events:
|
2014-02-13 15:29:08 -07:00
|
|
|
*/
|
tipc: clean up definitions and usage of link flags
The status flag LINK_STOPPED is not needed any more, since the
mechanism for delayed deletion of links has been removed.
Likewise, LINK_STARTED and LINK_START_EVT are unnecessary,
because we can just as well start the link timer directly from
inside tipc_link_create().
We eliminate these flags in this commit.
Instead of the above flags, we now introduce three new link modes,
TIPC_LINK_OPEN, TIPC_LINK_BLOCKED and TIPC_LINK_TUNNEL. The values
indicate whether, and in the case of TIPC_LINK_TUNNEL, which, messages
the link is allowed to receive in this state. TIPC_LINK_BLOCKED also
blocks timer-driven protocol messages to be sent out, and any change
to the link FSM. Since the modes are mutually exclusive, we convert
them to state values, and rename the 'flags' field in struct tipc_link
to 'exec_mode'.
Finally, we move the #defines for link FSM states and events from link.h
into enums inside the file link.c, which is the real usage scope of
these definitions.
Reviewed-by: Ying Xue <ying.xue@windriver.com>
Signed-off-by: Jon Maloy <jon.maloy@ericsson.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2015-07-16 14:54:25 -06:00
|
|
|
enum {
|
2015-07-30 16:24:21 -06:00
|
|
|
LINK_ESTABLISH_EVT = 0xec1ab1e,
|
|
|
|
|
LINK_PEER_RESET_EVT = 0x9eed0e,
|
|
|
|
|
LINK_FAILURE_EVT = 0xfa110e,
|
|
|
|
|
LINK_RESET_EVT = 0x10ca1d0e,
|
|
|
|
|
LINK_FAILOVER_BEGIN_EVT = 0xfa110bee,
|
|
|
|
|
LINK_FAILOVER_END_EVT = 0xfa110ede,
|
|
|
|
|
LINK_SYNCH_BEGIN_EVT = 0xc1ccbee,
|
|
|
|
|
LINK_SYNCH_END_EVT = 0xc1ccede
|
tipc: clean up definitions and usage of link flags
The status flag LINK_STOPPED is not needed any more, since the
mechanism for delayed deletion of links has been removed.
Likewise, LINK_STARTED and LINK_START_EVT are unnecessary,
because we can just as well start the link timer directly from
inside tipc_link_create().
We eliminate these flags in this commit.
Instead of the above flags, we now introduce three new link modes,
TIPC_LINK_OPEN, TIPC_LINK_BLOCKED and TIPC_LINK_TUNNEL. The values
indicate whether, and in the case of TIPC_LINK_TUNNEL, which, messages
the link is allowed to receive in this state. TIPC_LINK_BLOCKED also
blocks timer-driven protocol messages to be sent out, and any change
to the link FSM. Since the modes are mutually exclusive, we convert
them to state values, and rename the 'flags' field in struct tipc_link
to 'exec_mode'.
Finally, we move the #defines for link FSM states and events from link.h
into enums inside the file link.c, which is the real usage scope of
these definitions.
Reviewed-by: Ying Xue <ying.xue@windriver.com>
Signed-off-by: Jon Maloy <jon.maloy@ericsson.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2015-07-16 14:54:25 -06:00
|
|
|
};
|
2014-02-13 15:29:08 -07:00
|
|
|
|
tipc: reduce locking scope during packet reception
We convert packet/message reception according to the same principle
we have been using for message sending and timeout handling:
We move the function tipc_rcv() to node.c, hence handling the initial
packet reception at the link aggregation level. The function grabs
the node lock, selects the receiving link, and accesses it via a new
call tipc_link_rcv(). This function appends buffers to the input
queue for delivery upwards, but it may also append outgoing packets
to the xmit queue, just as we do during regular message sending. The
latter will happen when buffers are forwarded from the link backlog,
or when retransmission is requested.
Upon return of this function, and after having released the node lock,
tipc_rcv() delivers/tranmsits the contents of those queues, but it may
also perform actions such as link activation or reset, as indicated by
the return flags from the link.
This reduces the number of cpu cycles spent inside the node spinlock,
and reduces contention on that lock.
Reviewed-by: Ying Xue <ying.xue@windriver.com>
Signed-off-by: Jon Maloy <jon.maloy@ericsson.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2015-07-16 14:54:31 -06:00
|
|
|
/* Events returned from link at packet reception or at timeout
|
tipc: improve link FSM implementation
The link FSM implementation is currently unnecessarily complex.
It sometimes checks for conditional state outside the FSM data
before deciding next state, and often performs actions directly
inside the FSM logics.
In this commit, we create a second, simpler FSM implementation,
that as far as possible acts only on states and events that it is
strictly defined for, and postpone any actions until it is finished
with its decisions. It also returns an event flag field and an a
buffer queue which may potentially contain a protocol message to
be sent by the caller.
Unfortunately, we cannot yet make the FSM "clean", in the sense
that its decisions are only based on FSM state and event, and that
state changes happen only here. That will have to wait until the
activate/reset logics has been cleaned up in a future commit.
We also rename the link states as follows:
WORKING_WORKING -> TIPC_LINK_WORKING
WORKING_UNKNOWN -> TIPC_LINK_PROBING
RESET_UNKNOWN -> TIPC_LINK_RESETTING
RESET_RESET -> TIPC_LINK_ESTABLISHING
The existing FSM function, link_state_event(), is still needed for
a while, so we redesign it to make use of the new function.
Reviewed-by: Ying Xue <ying.xue@windriver.com>
Signed-off-by: Jon Maloy <jon.maloy@ericsson.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2015-07-16 14:54:27 -06:00
|
|
|
*/
|
|
|
|
|
enum {
|
|
|
|
|
TIPC_LINK_UP_EVT = 1,
|
2015-10-22 06:51:41 -06:00
|
|
|
TIPC_LINK_DOWN_EVT = (1 << 1),
|
|
|
|
|
TIPC_LINK_SND_BC_ACK = (1 << 2)
|
tipc: improve link FSM implementation
The link FSM implementation is currently unnecessarily complex.
It sometimes checks for conditional state outside the FSM data
before deciding next state, and often performs actions directly
inside the FSM logics.
In this commit, we create a second, simpler FSM implementation,
that as far as possible acts only on states and events that it is
strictly defined for, and postpone any actions until it is finished
with its decisions. It also returns an event flag field and an a
buffer queue which may potentially contain a protocol message to
be sent by the caller.
Unfortunately, we cannot yet make the FSM "clean", in the sense
that its decisions are only based on FSM state and event, and that
state changes happen only here. That will have to wait until the
activate/reset logics has been cleaned up in a future commit.
We also rename the link states as follows:
WORKING_WORKING -> TIPC_LINK_WORKING
WORKING_UNKNOWN -> TIPC_LINK_PROBING
RESET_UNKNOWN -> TIPC_LINK_RESETTING
RESET_RESET -> TIPC_LINK_ESTABLISHING
The existing FSM function, link_state_event(), is still needed for
a while, so we redesign it to make use of the new function.
Reviewed-by: Ying Xue <ying.xue@windriver.com>
Signed-off-by: Jon Maloy <jon.maloy@ericsson.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2015-07-16 14:54:27 -06:00
|
|
|
};
|
|
|
|
|
|
2014-02-13 15:29:08 -07:00
|
|
|
/* Starting value for maximum packet size negotiation on unicast links
|
2006-01-02 11:04:38 -07:00
|
|
|
* (unless bearer MTU is less)
|
|
|
|
|
*/
|
|
|
|
|
#define MAX_PKT_DEFAULT 1500
|
|
|
|
|
|
2015-10-22 06:51:46 -06:00
|
|
|
bool tipc_link_create(struct net *net, char *if_name, int bearer_id,
|
2015-10-22 06:51:36 -06:00
|
|
|
int tolerance, char net_plane, u32 mtu, int priority,
|
|
|
|
|
int window, u32 session, u32 ownnode, u32 peer,
|
2015-10-22 06:51:41 -06:00
|
|
|
u16 peer_caps,
|
|
|
|
|
struct tipc_link *bc_sndlink,
|
|
|
|
|
struct tipc_link *bc_rcvlink,
|
|
|
|
|
struct sk_buff_head *inputq,
|
|
|
|
|
struct sk_buff_head *namedq,
|
2015-07-30 16:24:26 -06:00
|
|
|
struct tipc_link **link);
|
2015-10-22 06:51:46 -06:00
|
|
|
bool tipc_link_bc_create(struct net *net, u32 ownnode, u32 peer,
|
2015-10-22 06:51:41 -06:00
|
|
|
int mtu, int window, u16 peer_caps,
|
|
|
|
|
struct sk_buff_head *inputq,
|
2015-10-22 06:51:37 -06:00
|
|
|
struct sk_buff_head *namedq,
|
2015-10-22 06:51:41 -06:00
|
|
|
struct tipc_link *bc_sndlink,
|
2015-10-22 06:51:37 -06:00
|
|
|
struct tipc_link **link);
|
2015-11-19 12:30:46 -07:00
|
|
|
void tipc_link_reinit(struct tipc_link *l, u32 addr);
|
2015-07-30 16:24:19 -06:00
|
|
|
void tipc_link_tnl_prepare(struct tipc_link *l, struct tipc_link *tnl,
|
|
|
|
|
int mtyp, struct sk_buff_head *xmitq);
|
2015-10-15 12:52:45 -06:00
|
|
|
void tipc_link_build_reset_msg(struct tipc_link *l, struct sk_buff_head *xmitq);
|
2015-07-30 16:24:21 -06:00
|
|
|
int tipc_link_fsm_evt(struct tipc_link *l, int evt);
|
|
|
|
|
bool tipc_link_is_up(struct tipc_link *l);
|
2015-10-15 12:52:46 -06:00
|
|
|
bool tipc_link_peer_is_down(struct tipc_link *l);
|
2015-07-30 16:24:21 -06:00
|
|
|
bool tipc_link_is_reset(struct tipc_link *l);
|
tipc: delay ESTABLISH state event when link is established
Link establishing, just like link teardown, is a non-atomic action, in
the sense that discovering that conditions are right to establish a link,
and the actual adding of the link to one of the node's send slots is done
in two different lock contexts. The link FSM is designed to help bridging
the gap between the two contexts in a safe manner.
We have now discovered a weakness in the implementaton of this FSM.
Because we directly let the link go from state LINK_ESTABLISHING to
state LINK_ESTABLISHED already in the first lock context, we are unable
to distinguish between a fully established link, i.e., a link that has
been added to its slot, and a link that has not yet reached the second
lock context. It may hence happen that a manual intervention, e.g., when
disabling an interface, causes the function tipc_node_link_down() to try
removing the link from the node slots, decrementing its active link
counter etc, although the link was never added there in the first place.
We solve this by delaying the actual state change until we reach the
second lock context, inside the function tipc_node_link_up(). This
makes it possible for potentail callers of __tipc_node_link_down() to
know if they should proceed or not, and the problem is solved.
Unforunately, the situation described above also has a second problem.
Since there by necessity is a tipc_node_link_up() call pending once
the node lock has been released, we must defuse that call by setting
the link back from LINK_ESTABLISHING to LINK_RESET state. This forces
us to make a slight modification to the link FSM, which will now look
as follows.
+------------------------------------+
|RESET_EVT |
| |
| +--------------+
| +-----------------| SYNCHING |-----------------+
| |FAILURE_EVT +--------------+ PEER_RESET_EVT|
| | A | |
| | | | |
| | | | |
| | |SYNCH_ |SYNCH_ |
| | |BEGIN_EVT |END_EVT |
| | | | |
| V | V V
| +-------------+ +--------------+ +------------+
| | RESETTING |<---------| ESTABLISHED |--------->| PEER_RESET |
| +-------------+ FAILURE_ +--------------+ PEER_ +------------+
| | EVT | A RESET_EVT |
| | | | |
| | +----------------+ | |
| RESET_EVT| |RESET_EVT | |
| | | | |
| | | |ESTABLISH_EVT |
| | | +-------------+ | |
| | | | RESET_EVT | | |
| | | | | | |
| V V V | | |
| +-------------+ +--------------+ RESET_EVT|
+--->| RESET |--------->| ESTABLISHING |<----------------+
+-------------+ PEER_ +--------------+
| A RESET_EVT |
| | |
| | |
|FAILOVER_ |FAILOVER_ |FAILOVER_
|BEGIN_EVT |END_EVT |BEGIN_EVT
| | |
V | |
+-------------+ |
| FAILINGOVER |<----------------+
+-------------+
Signed-off-by: Jon Maloy <jon.maloy@ericsson.com>
Acked-by: Ying Xue <ying.xue@windriver.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2015-10-15 12:52:44 -06:00
|
|
|
bool tipc_link_is_establishing(struct tipc_link *l);
|
2015-07-30 16:24:21 -06:00
|
|
|
bool tipc_link_is_synching(struct tipc_link *l);
|
|
|
|
|
bool tipc_link_is_failingover(struct tipc_link *l);
|
|
|
|
|
bool tipc_link_is_blocked(struct tipc_link *l);
|
2015-10-22 06:51:46 -06:00
|
|
|
void tipc_link_set_active(struct tipc_link *l, bool active);
|
2015-11-19 12:30:47 -07:00
|
|
|
void tipc_link_reset(struct tipc_link *l);
|
2015-11-19 12:30:46 -07:00
|
|
|
void tipc_link_reset_stats(struct tipc_link *l);
|
|
|
|
|
int tipc_link_xmit(struct tipc_link *link, struct sk_buff_head *list,
|
2015-07-16 14:54:24 -06:00
|
|
|
struct sk_buff_head *xmitq);
|
2015-11-19 12:30:46 -07:00
|
|
|
struct sk_buff_head *tipc_link_inputq(struct tipc_link *l);
|
|
|
|
|
u16 tipc_link_rcv_nxt(struct tipc_link *l);
|
|
|
|
|
u16 tipc_link_acked(struct tipc_link *l);
|
|
|
|
|
u32 tipc_link_id(struct tipc_link *l);
|
|
|
|
|
char *tipc_link_name(struct tipc_link *l);
|
|
|
|
|
char tipc_link_plane(struct tipc_link *l);
|
|
|
|
|
int tipc_link_prio(struct tipc_link *l);
|
|
|
|
|
int tipc_link_window(struct tipc_link *l);
|
|
|
|
|
unsigned long tipc_link_tolerance(struct tipc_link *l);
|
|
|
|
|
void tipc_link_set_tolerance(struct tipc_link *l, u32 tol);
|
|
|
|
|
void tipc_link_set_prio(struct tipc_link *l, u32 prio);
|
|
|
|
|
void tipc_link_set_abort_limit(struct tipc_link *l, u32 limit);
|
2015-10-22 06:51:48 -06:00
|
|
|
void tipc_link_set_queue_limits(struct tipc_link *l, u32 window);
|
2015-11-19 12:30:45 -07:00
|
|
|
int __tipc_nl_add_link(struct net *net, struct tipc_nl_msg *msg,
|
|
|
|
|
struct tipc_link *link, int nlflags);
|
2014-11-20 02:29:07 -07:00
|
|
|
int tipc_nl_parse_link_prop(struct nlattr *prop, struct nlattr *props[]);
|
2015-07-16 14:54:28 -06:00
|
|
|
int tipc_link_timeout(struct tipc_link *l, struct sk_buff_head *xmitq);
|
tipc: reduce locking scope during packet reception
We convert packet/message reception according to the same principle
we have been using for message sending and timeout handling:
We move the function tipc_rcv() to node.c, hence handling the initial
packet reception at the link aggregation level. The function grabs
the node lock, selects the receiving link, and accesses it via a new
call tipc_link_rcv(). This function appends buffers to the input
queue for delivery upwards, but it may also append outgoing packets
to the xmit queue, just as we do during regular message sending. The
latter will happen when buffers are forwarded from the link backlog,
or when retransmission is requested.
Upon return of this function, and after having released the node lock,
tipc_rcv() delivers/tranmsits the contents of those queues, but it may
also perform actions such as link activation or reset, as indicated by
the return flags from the link.
This reduces the number of cpu cycles spent inside the node spinlock,
and reduces contention on that lock.
Reviewed-by: Ying Xue <ying.xue@windriver.com>
Signed-off-by: Jon Maloy <jon.maloy@ericsson.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2015-07-16 14:54:31 -06:00
|
|
|
int tipc_link_rcv(struct tipc_link *l, struct sk_buff *skb,
|
|
|
|
|
struct sk_buff_head *xmitq);
|
2015-10-22 06:51:41 -06:00
|
|
|
int tipc_link_build_ack_msg(struct tipc_link *l, struct sk_buff_head *xmitq);
|
|
|
|
|
void tipc_link_add_bc_peer(struct tipc_link *snd_l,
|
|
|
|
|
struct tipc_link *uc_l,
|
|
|
|
|
struct sk_buff_head *xmitq);
|
|
|
|
|
void tipc_link_remove_bc_peer(struct tipc_link *snd_l,
|
|
|
|
|
struct tipc_link *rcv_l,
|
|
|
|
|
struct sk_buff_head *xmitq);
|
2015-10-22 06:51:39 -06:00
|
|
|
int tipc_link_bc_peers(struct tipc_link *l);
|
2015-10-22 06:51:43 -06:00
|
|
|
void tipc_link_set_mtu(struct tipc_link *l, int mtu);
|
|
|
|
|
int tipc_link_mtu(struct tipc_link *l);
|
2015-10-22 06:51:41 -06:00
|
|
|
void tipc_link_bc_ack_rcv(struct tipc_link *l, u16 acked,
|
|
|
|
|
struct sk_buff_head *xmitq);
|
|
|
|
|
void tipc_link_build_bc_sync_msg(struct tipc_link *l,
|
|
|
|
|
struct sk_buff_head *xmitq);
|
|
|
|
|
void tipc_link_bc_init_rcv(struct tipc_link *l, struct tipc_msg *hdr);
|
|
|
|
|
void tipc_link_bc_sync_rcv(struct tipc_link *l, struct tipc_msg *hdr,
|
|
|
|
|
struct sk_buff_head *xmitq);
|
|
|
|
|
int tipc_link_bc_nack_rcv(struct tipc_link *l, struct sk_buff *skb,
|
|
|
|
|
struct sk_buff_head *xmitq);
|
2006-01-02 11:04:38 -07:00
|
|
|
#endif
|