netdev-vport: Warn on IPsec tunnels when ovs-monitor-ipsec not running.
[sliver-openvswitch.git] / lib / cfm.h
1 /*
2  * Copyright (c) 2010 Nicira Networks.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef CFM_H
18 #define CFM_H 1
19
20 #include <stdint.h>
21
22 #include "hmap.h"
23 #include "packets.h"
24
25 struct flow;
26
27 /* A 'cfm' represent a local Maintenance Point (MP) and its Connectivity Fault
28  * Management (CFM) state machine.  Its configuration variables should be set
29  * by clients of the CFM library. */
30 struct cfm {
31     /* Configuration Variables. */
32     uint16_t mpid;              /* The MPID of this CFM. */
33     uint8_t maid[CCM_MAID_LEN]; /* The MAID of this CFM. */
34     int interval;               /* The requested transmission interval. */
35     uint8_t eth_src[ETH_ADDR_LEN];
36
37     /* Statistics. */
38     struct hmap remote_mps;     /* Expected remote MPs. */
39     struct hmap x_remote_mps;   /* Unexpected remote MPs. */
40     struct hmap x_remote_maids; /* Unexpected remote MAIDs. */
41     bool fault;                 /* Indicates connectivity vaults. */
42 };
43
44 /* Remote MPs represent foreign network entities that are configured to have
45  * the same MAID as this CFM instance. */
46 struct remote_mp {
47     uint16_t mpid;         /* The Maintenance Point ID of this 'remote_mp'. */
48     struct hmap_node node; /* In 'cfm' 'remote_mps' or 'x_remote_mps'. */
49
50     long long recv_time; /* Time the most recent CCM was received. */
51     bool fault;          /* Indicates a connectivity fault. */
52 };
53
54 /* Remote MAIDs keep track of incoming CCM messages which have a different MAID
55  * than this CFM instance. */
56 struct remote_maid {
57     uint8_t maid[CCM_MAID_LEN]; /* The remote MAID. */
58     struct hmap_node node;      /* In 'cfm' 'x_remote_maids'. */
59
60     long long recv_time; /* Most recent receive time for this 'remote_maid'. */
61 };
62
63 struct cfm *cfm_create(void);
64
65 void cfm_destroy(struct cfm *);
66
67 struct ofpbuf *cfm_run(struct cfm *);
68
69 void cfm_wait(struct cfm *);
70
71 bool cfm_configure(struct cfm *);
72
73 void cfm_update_remote_mps(struct cfm *, const uint16_t *mpid, size_t n_mpids);
74
75 const struct remote_mp *cfm_get_remote_mp(const struct cfm *, uint16_t mpid);
76
77 bool cfm_generate_maid(const char *md_name, const char *ma_name,
78                        uint8_t maid[CCM_MAID_LEN]);
79
80 bool cfm_should_process_flow(const struct flow *);
81
82 void cfm_process_heartbeat(struct cfm *, const struct ofpbuf *packet);
83
84 #endif /* cfm.h */