TODO cleanup compilation

[mab68]

Faucet has a lot of TODOs lying around. I will be moving those TODOs, along with their age (as of writing this) into this issue and we can discuss whether they are still valid etc..

• faucet/fctl.py
  Hasn't changed

  • [3yr] This script and its usage is experimental and its output is expected to change significantly.
    

    faucet/faucet/fctl.py

    Line 5 in 19678f3

    # TODO: this script and is usage is experimental and its output

  • [3yr] Add control functionality.
    

    faucet/faucet/fctl.py

    Line 7 in 19678f3

    # TODO: add control functionality.

  • [3yr] Byte/packet counters could be per second (given multiple samples)
    

    faucet/faucet/fctl.py

    Line 37 in 19678f3

    # TODO: byte/packet counters could be per second (given multiple samples)

• faucet/faucet_event.py
  Hasn't changed

  • [2yr] Events are currently schema-less. This is to facilitate rapid prototyping, and will change.
    

    faucet/faucet/faucet_event.py

    Line 3 in f15cb17

    # TODO: events are currently schema-less. This is to facilitate rapid prototyping, and will change.

  • [2yr] Not all cases where a notified client fails or could block, have been tested. Only one client is supported (multiple clients should be implemented with a client that copies/pushes to a message bus)
    

    faucet/faucet/faucet_event.py

    Line 4 in f15cb17

    # TODO: not all cases where a notified client fails or could block, have been tested.

• travis/runtests.sh

  • [10mo] run a standalone DP and also a stacked DP test to test hardware linkages.
    

    faucet/travis/runtests.sh

    Line 95 in d75c3d0

    # TODO: run a standalone DP and also a stacked DP test to test hardware linkages.

  • [11mo] automatically run gdb?
    

    faucet/travis/runtests.sh

    Line 104 in d75c3d0

    # TODO: automatically run gdb?

• tests/unit/faucet/valve_test_lib.py

  • [2yr] Verify events
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 513 in a930f7c

    # TODO: verify events

  • [2yr] Verify learn caching
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 771 in a930f7c

    # TODO: verify learn caching.

  • [2yr] Verify host learning banned
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 778 in a930f7c

    # TODO: verify host learning banned

  • [2yr] Verify state expired
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 809 in a930f7c

    # TODO: verify state expired

  • [2yr] VLAN packet submitted to packet in always has VID, FakeOFTable implementation should do this by applying actions.
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 880 in a930f7c

    # TODO: VLAN packet submitted to packet in always has VID

  • [2yr] Verify TFM content
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1021 in a930f7c

    # TODO: verify TFM content.

  • [2yr] Check ARP reply is valid
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1081 in a930f7c

    # TODO: check ARP reply is valid

  • [2yr] Check ARP reply is valid
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1092 in a930f7c

    # TODO: check ARP reply is valid

  • [2yr] Check reply NA is valid
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1111 in a930f7c

    # TODO: check reply NA is valid

  • [2yr] Check NA response flows are valid
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1124 in a930f7c

    # TODO: check NA response flows are valid

  • [2yr] Check RA is valid
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1138 in a930f7c

    # TODO: check RA is valid

  • [2yr] Check ARP reply is valid
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1178 in a930f7c

    # TODO: check ARP reply is valid

  • [2yr] Check add flows
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1185 in a930f7c

    # TODO: check add flows.

  • [2yr] Check del flows
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1189 in a930f7c

    # TODO: check del flows.

  • [2yr] Verify learning rule contents
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1202 in a930f7c

    # TODO: verify learning rule contents

  • [2yr] Verify learning rule contents
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1222 in a930f7c

    # TODO: verify learning rule contents

  • [2yr] Check proactive neighbor resolution
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1237 in a930f7c

    # TODO: check proactive neighbor resolution

  • [2yr] Check proactive neighbor resolution
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1249 in a930f7c

    # TODO: check proactive neighbor resolution

  • [2yr] Verify LLDP packet content
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1661 in a930f7c

    # TODO: verify LLDP packet content.

  • [6 mo] Test actual config contents
    

    faucet/tests/unit/faucet/valve_test_lib.py

    Line 1746 in a930f7c

    # TODO: test actual config contents.

• faucet/valve_table.py

  • [2yr] Verify actions
    

    faucet/faucet/valve_table.py

    Line 94 in 863b5a9

    # TODO: verify actions

  • [11mo] ACL builder should not use ALL table
    

    faucet/faucet/valve_table.py

    Line 117 in 863b5a9

    # TODO: ACL builder should not use ALL table.

• docker/runtests.sh

  • [2yr] Need to force UTF-8 as POSIX causes python3/pytype errors
    

    faucet/docker/runtests.sh

    Line 127 in d75c3d0

    # TODO: need to force UTF-8 as POSIX causes python3/pytype errors.

  • [10mo] Randomize OF port range (offset from 1 for basic test)
    

    faucet/docker/runtests.sh

    Line 189 in d75c3d0

    # TODO: randomize OF port range (offset from 1 for basic test)

• faucet/faucet_bgp.py

  • [2yr] Delete RIB routes for down peer
    

    faucet/faucet/faucet_bgp.py

    Line 94 in 340b519

    # TODO: delete RIB routes for down peer.

  • [12mo] Port status changes should cause us to withdraw a route
    

    faucet/faucet/faucet_bgp.py

    Line 218 in 340b519

    # TODO: port status changes should cause us to withdraw a route.

  • [2yr] Shutdown and remove deconfigured BGP speakers
    

    faucet/faucet/faucet_bgp.py

    Line 223 in 340b519

    # TODO: shutdown and remove deconfigured BGP speakers.

• faucet/prom_client.py

  • [2yr] Investigate faster alternative (https://bugs.launchpad.net/pbr/+bug/1688405)
    

    faucet/faucet/prom_client.py

    Line 56 in c4f131d

    # TODO: investigate faster alternative (https://bugs.launchpad.net/pbr/+bug/1688405)

    
    Marked Fix Released on 2018-04-25

• faucet/gauge_pollers.py

  • [3yr] It may be worthwhile verifying this is the correct stats response before doing this
    

    faucet/faucet/gauge_pollers.py

    Line 99 in 52c1e22

    # TODO: it may be worth while verifying this is the correct stats

  • [3yr] This should use a deterministic method instead of random
    

    faucet/faucet/gauge_pollers.py

    Line 186 in 52c1e22

    # TODO: this should use a deterministic method instead of random

• faucet/valve_flood.py

  • [6mo] Optimization - drop all general flood dsts if all ports are restricted
    

    faucet/faucet/valve_flood.py

    Line 144 in dc8f363

    # TODO: optimization - drop all general flood dsts if all ports are restricted.

  • [6mo] Optimize, avoid generating delete for port if no existing flow
    

    faucet/faucet/valve_flood.py

    Line 219 in dc8f363

    # TODO: optimize, avoid generating delete for port if no existing flow.

  • [2mo] Consolidate stack port selection logic, this reuses logic from _build_mask_flood_rules()
    

    faucet/faucet/valve_flood.py

    Line 656 in dc8f363

    # TODO: Consolidate stack port selection logic,

  • [7mo] Currently requires controller to manage all switches in the stack to keep each DP's graph consistent
    

    faucet/faucet/valve_flood.py

    Line 849 in dc8f363

    # TODO: currently requires controller to manage all switches

  • [7mo] Simplest possible unicast learning. We find just one port that is the shortest unicast path to the destination. We could use other factors (eg we could load balance over multiple ports based on destination MAC)
    

    faucet/faucet/valve_flood.py

    Line 851 in dc8f363

    # TODO: simplest possible unicast learning.

  • [7mo] Edge DPs could use a different forwarding algorithm (for example, just default switch to a neighbor). Find port that forwards closer to destination DP that has already learned this host (if any).
    

    faucet/faucet/valve_flood.py

    Line 855 in dc8f363

    # TODO: edge DPs could use a different forwarding algorithm

• faucet/valve_acl.py

  • [3yr] Change this, maybe this can be rewritten easily, possibly replace with a class for ACLs
    

    faucet/faucet/valve_acl.py

    Line 92 in dc8f363

    # TODO: change this, maybe this can be rewritten easily

  • [9mo] Rename priorities
    

    faucet/faucet/valve_acl.py

    Line 219 in dc8f363

    # TODO Rename priorities

    
    Closed by Ordered ACL output actions #3476. Priorities renamed as Tunnel ACL also uses the dot1x priorities.
  • [14mo] This will be handled by the VLAN manager. VLANs with reserved_internal_vlan=True will handle creating this flow for us
    

    faucet/faucet/valve_acl.py

    Line 459 in dc8f363

    #TODO: This will be handled by the vlan manager

    
    Closed by Ordered ACL output actions #3476. Tunnel ACLs refactored to not use the VLAN table.

• faucet/valve.py

  • [2yr] The beacon service is specifically NOT to support conventional R/STP. It is intended to facilitate physical troubleshooting (e.g. a standard cable tester can display OF port information). It is used also by stacking to verify stacking links.
    

    faucet/faucet/valve.py

    Line 551 in a074fc1

    # TODO: the beacon service is specifically NOT to support conventional R/STP.

    
    Changed to a note
  • [2yr] In the stacking case, provide an authentication scheme for the probes so they cannot be forged.
    

    faucet/faucet/valve.py

    Line 555 in a074fc1

    # TODO: in the stacking case, provide an authentication scheme for the probes

  • [6mo] Add additional output port strategies (eg. MPLS)
    

    faucet/faucet/valve.py

    Line 815 in a074fc1

    # TODO: add additional output port strategies (eg. MPLS)

  • [6mo] Support tagged ports with additional VLAN VID ranges
    

    faucet/faucet/valve.py

    Line 816 in a074fc1

    # TODO: support tagged ports with additional VLAN VID ranges.

  • [2yr] Make MAC table updates less expensive
    

    faucet/faucet/valve.py

    Line 1544 in a074fc1

    # TODO: make MAC table updates less expensive.

  • [14mo] Verify LLDP message (e.g. org-specific authenticator TLV)
    

    faucet/faucet/valve.py

    Line 1567 in a074fc1

    # TODO: verify LLDP message (e.g. org-specific authenticator TLV)

  • [7mo] We will repeatedly spam the DP for each packet in. Should use learn_host() style rate limiting.
    

    faucet/faucet/valve.py

    Line 1629 in a074fc1

    # TODO: we will repeatedly spam the DP for each packet in.

  • [7mo] Generalize multi DP routing.
    

    faucet/faucet/valve.py

    Line 1638 in a074fc1

    # TODO: generalize multi DP routing

  • [7mo] Multi DP routing requires learning from directly attached switch first.
    

    faucet/faucet/valve.py

    Line 1640 in a074fc1

    # TODO: multi DP routing requires learning from directly attached switch first.

  • [7mo] Does not handle pruning
    

    faucet/faucet/valve.py

    Line 1652 in a074fc1

    # TODO: does not handle pruning.

  • [2yr] Expensive, even at non-debug level.
    

    faucet/faucet/valve.py

    Line 1680 in a074fc1

    # TODO: expensive, even at non-debug level.

    
    Don't need it.
  • [1mo] Optimize for all meters being erased
    

    faucet/faucet/valve.py

    Line 1795 in a074fc1

    # TODO: optimize for all meters being erased

  • [9mo] Handle change versus add separately so can avoid delete first.
    

    faucet/faucet/valve.py

    Line 1832 in a074fc1

    # TODO: handle change versus add separately so can avoid delete first.

  • [8mo] Use OXMIDs acceptable to OVS
    

    faucet/faucet/valve.py

    Line 2059 in a074fc1

    # TODO: use OXMIDs acceptable to OVS.

  • [8mo] Dynamically determine tables/flows
    

    faucet/faucet/valve.py

    Line 2060 in a074fc1

    # TODO: dynamically determine tables/flows

[mab68]

• faucet/faucet_pipeline.py

  • [2yr] Implement an eth_type table before VLAN. This would enable interception of control protocols and simplify matches in vlan/eth_src, enabling use of exact_match
    

    faucet/faucet/faucet_pipeline.py

    Line 180 in 70d8368

    # TODO: implement an eth_type table before VLAN. This would enable interception

• faucet/gauge_prom.py

  • [2yr] Labels based on matches will be dynamic
    

    faucet/faucet/gauge_prom.py

    Line 171 in 52c1e22

    # TODO: labels based on matches will be dynamic

• clib/clib_mininet_test_main.py

  • [6mo] Tested with OVS userspace only
    

    faucet/clib/clib_mininet_test_main.py

    Line 49 in 155446f

    DEFAULT_HARDWARE, # TODO: tested with OVS userspace only.

  • [2yr] Test other stacking combinations
    

    faucet/clib/clib_mininet_test_main.py

    Line 359 in 155446f

    # TODO: test other stacking combinations.

  • [2yr] Tests that are serialized generally depend on hardcoded ports. Make then use dynamic ports.
    

    faucet/clib/clib_mininet_test_main.py

    Line 486 in 155446f

    # TODO: Tests that are serialized generally depend on hardcoded ports.

• faucet/acl.py

  • [14mo] Would be possible to save the names instead of the DP and port objects
    

    faucet/faucet/acl.py

    Line 116 in 64ebec1

    #TODO: Would be possible to save the names instead of the DP and port objects

    
    Fixed by Ordered ACL output actions #3476. ACL tunnel information dictionary uses DP names and port numbers.
  • [14mo] Choose what combinations of matches & actions to disallow with a tunnel
    

    faucet/faucet/acl.py

    Line 308 in 64ebec1

    TODO: Choose what combinations of matches & actions to disallow with a tunnel

    
    Fixed by Ordered ACL output actions #3476. With the inclusion of ordered ACL actions, tunnel rules should work with all other action types.

• faucet/valves_manager.py

  • [2yr] Better to use an inotify method that doesn't conflict with eventlets.
    

    faucet/faucet/valves_manager.py

    Line 52 in a074fc1

    # TODO: Better to use an inotify method that doesn't conflict with eventlets.

  • [7mo] Timeout should be configurable
    

    faucet/faucet/valves_manager.py

    Line 113 in a074fc1

    # TODO: timeout should be configurable

• faucet/dp.py

  • [1mo] Not supported by OVS in 2.7.0
    

    faucet/faucet/dp.py

    Line 100 in b73ec09

    # Ask switch to rate limit packetin pps. TODO: Not supported by OVS in 2.7.0

  • [1mo] Not supported by OVS in 2.7.0
    

    faucet/faucet/dp.py

    Line 102 in b73ec09

    # Ask switch to rate limit slowpath pps. TODO: Not supported by OVS in 2.7.0

  • [2yr] Dynamically configure output attribute
    

    faucet/faucet/dp.py

    Line 475 in b73ec09

    # TODO: dynamically configure output attribue

  • [2yr] Confusingly, mirror at config time means what ports to mirror from. But internally, we use as a list of ports to mirror to.
    

    faucet/faucet/dp.py

    Line 1077 in b73ec09

    # TODO: confusingly, mirror at config time means what ports to mirror from.

  • [2yr] Optimize case were only VLAN ACL changed
    

    faucet/faucet/dp.py

    Line 1449 in b73ec09

    # TODO: optimize case where only VLAN ACL changed.

  • [2yr] Move this config validation to ACL object
    

    faucet/faucet/dp.py

    Line 1183 in b73ec09

    # TODO: move this config validation to ACL object.

  • [8dy] Limit scope to only routers that have affected VLANs
    

    faucet/faucet/dp.py

    Line 1528 in b73ec09

    # TODO: limit scope to only routers that have affected VLANs.

• tests/unit/faucet/test_check_config.py

  • [2yr] Check acls_in work now acl_in is deprecated, remove in future
    

    faucet/tests/unit/faucet/test_check_config.py

    Line 56 in bbe3246

    # TODO: Check acls_in work now acl_in is deprecated, remove in future

    
    Moved to Fully deprecate acl_in #3492

[mab68]

• clib/mininet_test_base.py

  • [7mo] Occasionally fails with socket error
    

    faucet/clib/mininet_test_base.py

    Line 424 in a074fc1

    # TODO: occasionally fails with socket error.

  • [2yr] Seemingly can't have more than one namespace
    

    faucet/clib/mininet_test_base.py

    Line 650 in a074fc1

    # TODO: seemingly can't have more than one namespace.

  • [1mo] Should this have meter_confs as well or can we just match meter_ids
    

    faucet/clib/mininet_test_base.py

    Line 989 in a074fc1

    # TODO: Should this have meter_confs as well or can we just match meter_ids

  • [2yr] Ryu ofctl serializes to old matches
    

    faucet/clib/mininet_test_base.py

    Line 1001 in a074fc1

    # TODO: Ryu ofctl serializes to old matches.

  • [2yr] Verify port/host association, not just that host moved.
    

    faucet/clib/mininet_test_base.py

    Line 1578 in a074fc1

    # TODO: verify port/host association, not just that host moved.

  • [2yr] Test environment is pretty hard on test host, with this many macvlans
    

    faucet/clib/mininet_test_base.py

    Line 1729 in a074fc1

    # TODO: test environment is pretty hard on test host, with this many macvlans

  • [3yr] Account for drops
    

    faucet/clib/mininet_test_base.py

    Line 2126 in a074fc1

    # TODO: account for drops.

  • [2yr] VIP might not be in neigbor teable if still tentative/ND used non VIP source address. Make test host source address consistent.
    

    faucet/clib/mininet_test_base.py

    Line 2331 in a074fc1

    # TODO: VIP might not be in neighbor table if still tentative/ND used non VIP source address.

• clib/mininet_test_topo.py

  • [11mo] This should be configurable (e.g. for randomization)
    

    faucet/clib/mininet_test_topo.py

    Line 26 in d75c3d0

    # TODO: this should be configurable (e.g for randomization)

    
    Fixed by Add option for integration test start port #3494.
  • [7mo] This can be simplified when we update mininet in the test image
    

    faucet/clib/mininet_test_topo.py

    Line 45 in d75c3d0

    # TODO: This can be simplified when we update Mininet in the test image

• tests/unit/faucet/fakeoftable.py

  • [2yr] Handle OFPMeterMod
    

    faucet/tests/unit/faucet/fakeoftable.py

    Line 212 in e125b87

    # TODO: handle OFPMeterMod

  • [2yr] Add cookie and out_group
    

    faucet/tests/unit/faucet/fakeoftable.py

    Line 462 in e125b87

    # TODO: add cookie and out_group

• clib/mininet_test_base_topo.py

  • [2mo] This redoes logic from get_config()
    

    faucet/clib/mininet_test_base_topo.py

    Line 206 in ae3f2ac

    # TODO: This redoes logic from get_config()

  • [4mo] Fix faucet so the test inversion is no longer required
    

    faucet/clib/mininet_test_base_topo.py

    Line 680 in ae3f2ac

    # TODO: Fix faucet so the test inversion is no longer required.

• faucet/faucet_dot1x.py

  • [11mo] Come back to. Should this be down?
    

    faucet/faucet/faucet_dot1x.py

    Line 179 in d4ff92d

    #TODO Come back to. Should this be down?

    
    Hasn't come back to.

• faucet/config_parser.py

  • [2yr] refactor watcher_conf as a container
    

    faucet/faucet/config_parser.py

    Line 303 in b665179

    # TODO: refactor watcher_conf as a container.

• tests/unit/faucet/test_valve.py

  • [2yr] Check mirror packets are present/correct
    

    faucet/tests/unit/faucet/test_valve.py

    Line 608 in 9e9ec34

    # TODO: check mirror packets are present/correct

• tests/tolerance/mininet_tests.py

  • [4mo] Add the following otpions: PROTECTED_NODES, PROTECTED_EDGES, ASSUME_TRANSITIVE_PING, IGNORE_SUBGRAPH
    

    faucet/tests/tolerance/mininet_tests.py

    Line 32 in db3e63f

    TODO: Add the following options

    
    Not necessary.

• faucet/valve_packet.py

  • [2yr] Python library parsers are fragile, perform sanity check on the header to limit exposure of the parser.
    

    faucet/faucet/valve_packet.py

    Line 99 in 863b5a9

    # TODO: python library parsers are fragile

• faucet/vlan.py

  • [2yr] Not well supported by any hardware, so not used
    

    faucet/faucet/vlan.py

    Line 43 in ae3f2ac

    # TODO: not well supported by any hardware, so not used.

    
    Changed to note. Not well supported by hardware & never used in Faucet so ignore.

[mab68]

• faucet/valve_route.py

  • [2yr] Avoid relearning L3 source if same L3 source tries multiple L3 destinations quickly.
    

    faucet/faucet/valve_route.py

    Line 647 in dc8f363

    # TODO: avoid relearning L3 source if same L3 source tries

• tests/integration/mininet_tests.py

  • [6mo] Userspace DP port status not reliable
    

    faucet/tests/integration/mininet_tests.py

    Line 1654 in f13396a

    # TODO: userspace DP port status not reliable.

  • [10mo] Currently set to accommodate least hardware
    

    faucet/tests/integration/mininet_tests.py

    Line 2829 in f13396a

    # TODO: currently set to accommodate least hardware

  • [10mo] Currently set to accommodate least hardware
    

    faucet/tests/integration/mininet_tests.py

    Line 2878 in f13396a

    # TODO: currently set to accommodate least hardware

  • [2yr] Tune for loop mitigation performance
    

    faucet/tests/integration/mininet_tests.py

    Line 3963 in f13396a

    # TODO: tune for loop mitigation performance.

  • [7mo] Ensure at least on error is always generated
    

    faucet/tests/integration/mininet_tests.py

    Line 8212 in f13396a

    # TODO: ensure at least one error is always generated.

• tests/unit/faucet/test_valve_stack.py

  • [2mo] This should be False to prevent unnecessary packet-ins
    

    faucet/tests/unit/faucet/test_valve_stack.py

    Line 537 in f13396a

    # TODO: This should be False to prevent unnecessary packet-ins.

• tests/unit/faucet/test_config.py

  • [2yr] Check alcs_in work now acl_in is deprecated
    

    faucet/tests/unit/faucet/test_config.py

    Line 46 in f13396a

    # TODO: Check acls_in work now acl_in is deprecated

    
    Moved to Fully deprecate acl_in #3492