2 * Copyright (c) 2010 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
27 /* Ethernet destination address of CCM packets. */
28 static const uint8_t eth_addr_ccm[ETH_ADDR_LEN] OVS_UNUSED
29 = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x30 };
31 /* A 'cfm' represent a local Maintenance Point (MP) and its Connectivity Fault
32 * Management (CFM) state machine. Its configuration variables should be set
33 * by clients of the CFM library. */
35 /* Configuration Variables. */
36 uint16_t mpid; /* The MPID of this CFM. */
37 uint8_t maid[CCM_MAID_LEN]; /* The MAID of this CFM. */
38 int interval; /* The requested transmission interval. */
39 uint8_t eth_src[ETH_ADDR_LEN];
42 struct hmap remote_mps; /* Expected remote MPs. */
43 struct hmap x_remote_mps; /* Unexpected remote MPs. */
44 struct hmap x_remote_maids; /* Unexpected remote MAIDs. */
45 bool fault; /* Indicates connectivity vaults. */
48 /* Remote MPs represent foreign network entities that are configured to have
49 * the same MAID as this CFM instance. */
51 uint16_t mpid; /* The Maintenance Point ID of this 'remote_mp'. */
52 struct hmap_node node; /* In 'cfm' 'remote_mps' or 'x_remote_mps'. */
54 long long recv_time; /* Time the most recent CCM was received. */
55 bool fault; /* Indicates a connectivity fault. */
58 /* Remote MAIDs keep track of incoming CCM messages which have a different MAID
59 * than this CFM instance. */
61 uint8_t maid[CCM_MAID_LEN]; /* The remote MAID. */
62 struct hmap_node node; /* In 'cfm' 'x_remote_maids'. */
64 long long recv_time; /* Most recent receive time for this 'remote_maid'. */
67 struct cfm *cfm_create(void);
69 void cfm_destroy(struct cfm *);
71 struct ofpbuf *cfm_run(struct cfm *);
73 void cfm_wait(struct cfm *);
75 bool cfm_configure(struct cfm *);
77 void cfm_update_remote_mps(struct cfm *, const uint16_t *mpid, size_t n_mpids);
79 const struct remote_mp *cfm_get_remote_mp(const struct cfm *, uint16_t mpid);
81 bool cfm_generate_maid(const char *md_name, const char *ma_name,
82 uint8_t maid[CCM_MAID_LEN]);
84 bool cfm_should_process_flow(const struct flow *);
86 void cfm_process_heartbeat(struct cfm *, const struct ofpbuf *packet);