Setting tag sliver-openvswitch-2.2.90-1
[sliver-openvswitch.git] / lib / cfm.h
index 651b1c4..13fdc60 100644 (file)
--- a/lib/cfm.h
+++ b/lib/cfm.h
@@ -1,5 +1,4 @@
-/*
- * Copyright (c) 2010 Nicira Networks.
+/* Copyright (c) 2010, 2011 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 
 struct flow;
 struct ofpbuf;
-
-/* Ethernet destination address of CCM packets. */
-static const uint8_t eth_addr_ccm[6] OVS_UNUSED
-    = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x30 };
-
-#define ETH_TYPE_CFM 0x8902
-
-/* A 'ccm' represents a Continuity Check Message from the 802.1ag
- * specification.  Continuity Check Messages are broadcast periodically so that
- * hosts can determine who they have connectivity to. */
-#define CCM_LEN 74
-#define CCM_MAID_LEN 48
-struct ccm {
-    uint8_t  mdlevel_version; /* MD Level and Version */
-    uint8_t  opcode;
-    uint8_t  flags;
-    uint8_t  tlv_offset;
-    ovs_be32 seq;
-    ovs_be16 mpid;
-    uint8_t  maid[CCM_MAID_LEN];
-    uint8_t  zero[16]; /* Defined by ITU-T Y.1731 should be zero */
-} __attribute__((packed));
-BUILD_ASSERT_DECL(CCM_LEN == sizeof(struct ccm));
-
-/* A 'cfm' represent a local Maintenance Point (MP) and its Connectivity Fault
- * Management (CFM) state machine.  Its configuration variables should be set
- * by clients of the CFM library. */
-struct cfm {
-    /* Configuration Variables. */
-    uint16_t mpid;              /* The MPID of this CFM. */
-    uint8_t maid[CCM_MAID_LEN]; /* The MAID of this CFM. */
-    int interval;               /* The requested transmission interval. */
-
-    /* Statistics. */
-    struct hmap remote_mps;     /* Expected remote MPs. */
-    struct hmap x_remote_mps;   /* Unexpected remote MPs. */
-    struct hmap x_remote_maids; /* Unexpected remote MAIDs. */
-    bool fault;                 /* Indicates connectivity vaults. */
+struct netdev;
+struct flow_wildcards;
+
+#define CFM_RANDOM_VLAN UINT16_MAX
+
+#define CFM_FAULT_REASONS                  \
+    CFM_FAULT_REASON(RECV, recv)           \
+    CFM_FAULT_REASON(RDI, rdi)             \
+    CFM_FAULT_REASON(MAID, maid)           \
+    CFM_FAULT_REASON(LOOPBACK, loopback)   \
+    CFM_FAULT_REASON(OVERFLOW, overflow)   \
+    CFM_FAULT_REASON(OVERRIDE, override)
+
+enum cfm_fault_bit_index {
+#define CFM_FAULT_REASON(NAME, STR) CFM_FAULT_INDEX_##NAME,
+    CFM_FAULT_REASONS
+#undef CFM_FAULT_REASON
+    CFM_FAULT_N_REASONS
 };
 
-/* Remote MPs represent foreign network entities that are configured to have
- * the same MAID as this CFM instance. */
-struct remote_mp {
-    uint16_t mpid;         /* The Maintenance Point ID of this 'remote_mp'. */
-    struct hmap_node node; /* In 'cfm' 'remote_mps' or 'x_remote_mps'. */
-
-    long long recv_time; /* Time the most recent CCM was received. */
-    bool fault;          /* Indicates a connectivity fault. */
+enum cfm_fault_reason {
+#define CFM_FAULT_REASON(NAME, STR) \
+    CFM_FAULT_##NAME = 1 << CFM_FAULT_INDEX_##NAME,
+    CFM_FAULT_REASONS
+#undef CFM_FAULT_REASON
 };
 
-/* Remote MAIDs keep track of incoming CCM messages which have a different MAID
- * than this CFM instance. */
-struct remote_maid {
-    uint8_t maid[CCM_MAID_LEN]; /* The remote MAID. */
-    struct hmap_node node;      /* In 'cfm' 'x_remote_maids'. */
-
-    long long recv_time; /* Most recent receive time for this 'remote_maid'. */
+struct cfm_settings {
+    uint64_t mpid;              /* The MPID of this CFM. */
+    int interval;               /* The requested transmission interval. */
+    bool extended;              /* Run in extended mode. */
+    bool demand;                /* Run in demand mode. */
+    bool opup;                  /* Operational State. */
+    uint16_t ccm_vlan;          /* CCM Vlan tag. Zero if none.
+                                   CFM_RANDOM_VLAN if random. */
+    uint8_t ccm_pcp;            /* CCM Priority. Zero if none. */
+
+    bool check_tnl_key;         /* Verify inbound packet key? */
 };
 
-struct cfm *cfm_create(void);
-
-void cfm_destroy(struct cfm *);
-
+void cfm_init(void);
+struct cfm *cfm_create(const struct netdev *);
+struct cfm *cfm_ref(const struct cfm *);
+void cfm_unref(struct cfm *);
 void cfm_run(struct cfm *);
-
 bool cfm_should_send_ccm(struct cfm *);
-
-void cfm_compose_ccm(struct cfm *, struct ccm *);
-
+void cfm_compose_ccm(struct cfm *, struct ofpbuf *packet, uint8_t eth_src[6]);
 void cfm_wait(struct cfm *);
-
-bool cfm_configure(struct cfm *);
-
-void cfm_update_remote_mps(struct cfm *, const uint16_t *mpid, size_t n_mpids);
-
-const struct remote_mp *cfm_get_remote_mp(const struct cfm *, uint16_t mpid);
-
-bool cfm_generate_maid(const char *md_name, const char *ma_name,
-                       uint8_t maid[CCM_MAID_LEN]);
-
-bool cfm_should_process_flow(const struct flow *);
-
+bool cfm_configure(struct cfm *, const struct cfm_settings *);
+void cfm_set_netdev(struct cfm *, const struct netdev *);
+bool cfm_should_process_flow(const struct cfm *cfm, const struct flow *,
+                             struct flow_wildcards *);
 void cfm_process_heartbeat(struct cfm *, const struct ofpbuf *packet);
-
+bool cfm_check_status_change(struct cfm *);
+int cfm_get_fault(const struct cfm *);
+uint64_t cfm_get_flap_count(const struct cfm *);
+int cfm_get_health(const struct cfm *);
+int cfm_get_opup(const struct cfm *);
+void cfm_get_remote_mpids(const struct cfm *, uint64_t **rmps, size_t *n_rmps);
+const char *cfm_fault_reason_to_str(int fault);
+
+long long int cfm_wake_time(struct cfm*);
 #endif /* cfm.h */