xref: /aosp_15_r20/external/ot-br-posix/src/backbone_router/dua_routing_manager.hpp (revision 4a64e381480ef79f0532b2421e44e6ee336b8e0d)
1 /*
2  *    Copyright (c) 2020, The OpenThread Authors.
3  *    All rights reserved.
4  *
5  *    Redistribution and use in source and binary forms, with or without
6  *    modification, are permitted provided that the following conditions are met:
7  *    1. Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *    2. Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *    3. Neither the name of the copyright holder nor the
13  *       names of its contributors may be used to endorse or promote products
14  *       derived from this software without specific prior written permission.
15  *
16  *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *    POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  *   This file includes definition for DUA routing functionalities.
32  */
33 
34 #ifndef BACKBONE_ROUTER_DUA_ROUTING_MANAGER
35 #define BACKBONE_ROUTER_DUA_ROUTING_MANAGER
36 
37 #include "openthread-br/config.h"
38 
39 #if OTBR_ENABLE_DUA_ROUTING
40 
41 #include <set>
42 #include <utility>
43 #include <openthread/backbone_router_ftd.h>
44 
45 #include "common/code_utils.hpp"
46 #include "ncp/rcp_host.hpp"
47 #include "utils/system_utils.hpp"
48 
49 namespace otbr {
50 namespace BackboneRouter {
51 
52 /**
53  * @addtogroup border-router-backbone
54  *
55  * @brief
56  *   This module includes definition for DUA routing functionalities.
57  *
58  * @{
59  */
60 
61 /**
62  * This class implements the DUA routing manager.
63  */
64 class DuaRoutingManager : private NonCopyable
65 {
66 public:
67     /**
68      * This constructor initializes a DUA routing manager instance.
69      */
DuaRoutingManager(std::string aInterfaceName,std::string aBackboneInterfaceName)70     explicit DuaRoutingManager(std::string aInterfaceName, std::string aBackboneInterfaceName)
71         : mEnabled(false)
72         , mInterfaceName(std::move(aInterfaceName))
73         , mBackboneInterfaceName(std::move(aBackboneInterfaceName))
74     {
75     }
76 
77     /**
78      * This method enables the DUA routing manager.
79      */
80     void Enable(const Ip6Prefix &aDomainPrefix);
81 
82     /**
83      * This method disables the DUA routing manager.
84      */
85     void Disable(void);
86 
87 private:
88     void AddDefaultRouteToThread(void);
89     void DelDefaultRouteToThread(void);
90     void AddPolicyRouteToBackbone(void);
91     void DelPolicyRouteToBackbone(void);
92 
93     Ip6Prefix   mDomainPrefix;
94     bool        mEnabled : 1;
95     std::string mInterfaceName;
96     std::string mBackboneInterfaceName;
97 };
98 
99 /**
100  * @}
101  */
102 
103 } // namespace BackboneRouter
104 } // namespace otbr
105 
106 #endif // OTBR_ENABLE_DUA_ROUTING
107 
108 #endif // BACKBONE_ROUTER_DUA_ROUTING_MANAGER
109