David K. Bainbridge | d77028f | 2017-08-01 12:47:55 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 4d08470 | 2017-08-03 22:45:58 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
David K. Bainbridge | d77028f | 2017-08-01 12:47:55 -0700 | [diff] [blame] | 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 | */ |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 16 | package org.opencord.igmpproxy; |
| 17 | |
| 18 | import org.onlab.packet.Ethernet; |
| 19 | import org.onlab.packet.Ip4Address; |
| 20 | import org.onosproject.net.DeviceId; |
Esin Karaman | 305908c | 2020-02-24 14:42:52 +0000 | [diff] [blame] | 21 | import org.onosproject.net.PortNumber; |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 22 | |
| 23 | import java.util.Random; |
Esin Karaman | a05342e | 2019-09-17 13:01:25 +0000 | [diff] [blame] | 24 | import java.util.concurrent.atomic.AtomicInteger; |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 25 | |
| 26 | /** |
David K. Bainbridge | d77028f | 2017-08-01 12:47:55 -0700 | [diff] [blame] | 27 | * State machine for single IGMP group member. The state machine is implemented on |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 28 | * RFC 2236 "6. Host State Diagram". |
| 29 | */ |
| 30 | public class SingleStateMachine { |
Vignesh Ethiraj | d1957c9 | 2019-11-18 11:52:49 +0000 | [diff] [blame] | 31 | // Only for tests purposes |
| 32 | static boolean sendQuery = true; |
| 33 | |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 34 | static final int STATE_NON = 0; |
| 35 | static final int STATE_DELAY = 1; |
| 36 | static final int STATE_IDLE = 2; |
| 37 | static final int TRANSITION_JOIN = 0; |
| 38 | static final int TRANSITION_LEAVE = 1; |
| 39 | static final int TRANSITION_QUERY = 2; |
| 40 | static final int TRANSITION_TIMEOUT = 3; |
| 41 | static final int DEFAULT_MAX_RESP = 0xfffffff; |
| 42 | static final int DEFAULT_COUNT = 1; |
| 43 | private DeviceId devId; |
| 44 | private Ip4Address groupIp; |
| 45 | private Ip4Address srcIp; |
Esin Karaman | 305908c | 2020-02-24 14:42:52 +0000 | [diff] [blame] | 46 | private PortNumber upLinkPort; |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 47 | |
Esin Karaman | a05342e | 2019-09-17 13:01:25 +0000 | [diff] [blame] | 48 | private AtomicInteger count = new AtomicInteger(DEFAULT_COUNT); |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 49 | private int timerId = IgmpTimer.INVALID_TIMER_ID; |
| 50 | private int timeOut = DEFAULT_MAX_RESP; |
| 51 | private State[] states = |
| 52 | { |
| 53 | new NonMember(), new DelayMember(), new IdleMember() |
| 54 | }; |
| 55 | private int[] nonTransition = |
| 56 | {STATE_DELAY, STATE_NON, STATE_NON, STATE_NON}; |
| 57 | private int[] delayTransition = |
| 58 | {STATE_DELAY, STATE_NON, STATE_DELAY, STATE_IDLE}; |
| 59 | private int[] idleTransition = |
| 60 | {STATE_IDLE, STATE_NON, STATE_DELAY, STATE_IDLE}; |
| 61 | //THE TRANSITION TABLE |
| 62 | private int[][] transition = |
| 63 | {nonTransition, delayTransition, idleTransition}; |
| 64 | private int currentState = STATE_NON; |
| 65 | |
Esin Karaman | 305908c | 2020-02-24 14:42:52 +0000 | [diff] [blame] | 66 | public SingleStateMachine(DeviceId devId, Ip4Address groupIp, Ip4Address src, PortNumber upLinkPort) { |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 67 | this.devId = devId; |
| 68 | this.groupIp = groupIp; |
| 69 | this.srcIp = src; |
Esin Karaman | 305908c | 2020-02-24 14:42:52 +0000 | [diff] [blame] | 70 | this.upLinkPort = upLinkPort; |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 71 | } |
| 72 | |
Esin Karaman | a05342e | 2019-09-17 13:01:25 +0000 | [diff] [blame] | 73 | public Ip4Address getGroupIp() { |
| 74 | return groupIp; |
| 75 | } |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 76 | |
| 77 | public DeviceId getDeviceId() { |
| 78 | return devId; |
| 79 | } |
| 80 | public boolean increaseCounter() { |
Esin Karaman | a05342e | 2019-09-17 13:01:25 +0000 | [diff] [blame] | 81 | count.incrementAndGet(); |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 82 | return true; |
| 83 | } |
| 84 | |
| 85 | public boolean decreaseCounter() { |
Esin Karaman | a05342e | 2019-09-17 13:01:25 +0000 | [diff] [blame] | 86 | if (count.get() > 0) { |
| 87 | count.decrementAndGet(); |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 88 | return true; |
| 89 | } else { |
| 90 | return false; |
| 91 | } |
| 92 | } |
| 93 | |
| 94 | public int getCounter() { |
Esin Karaman | a05342e | 2019-09-17 13:01:25 +0000 | [diff] [blame] | 95 | return count.get(); |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 96 | } |
| 97 | public int currentState() { |
| 98 | return currentState; |
| 99 | } |
| 100 | |
| 101 | private void next(int msg) { |
| 102 | currentState = transition[currentState][msg]; |
| 103 | } |
| 104 | |
Esin Karaman | a05342e | 2019-09-17 13:01:25 +0000 | [diff] [blame] | 105 | public void join(boolean messageOutAllowed) { |
| 106 | states[currentState].join(messageOutAllowed); |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 107 | next(TRANSITION_JOIN); |
| 108 | } |
| 109 | |
Esin Karaman | a05342e | 2019-09-17 13:01:25 +0000 | [diff] [blame] | 110 | public void leave(boolean messageOutAllowed) { |
| 111 | states[currentState].leave(messageOutAllowed); |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 112 | next(TRANSITION_LEAVE); |
| 113 | } |
| 114 | |
| 115 | public void query(int maxResp) { |
| 116 | states[currentState].query(maxResp); |
| 117 | next(TRANSITION_QUERY); |
| 118 | } |
| 119 | |
| 120 | public void timeOut() { |
| 121 | states[currentState].timeOut(); |
| 122 | next(TRANSITION_TIMEOUT); |
| 123 | } |
| 124 | |
| 125 | int getTimeOut(int maxTimeOut) { |
| 126 | Random random = new Random(); |
| 127 | return Math.abs(random.nextInt()) % maxTimeOut; |
| 128 | } |
| 129 | |
| 130 | protected void cancelTimer() { |
| 131 | if (IgmpTimer.INVALID_TIMER_ID != timerId) { |
| 132 | IgmpTimer.cancel(timerId); |
| 133 | } |
| 134 | } |
| 135 | |
| 136 | class State { |
Esin Karaman | a05342e | 2019-09-17 13:01:25 +0000 | [diff] [blame] | 137 | public void join(boolean messageOutAllowed) { |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 138 | } |
| 139 | |
Esin Karaman | a05342e | 2019-09-17 13:01:25 +0000 | [diff] [blame] | 140 | public void leave(boolean messageOutAllowed) { |
| 141 | if (messageOutAllowed) { |
| 142 | Ethernet eth = IgmpSender.getInstance().buildIgmpV3Leave(groupIp, srcIp); |
Esin Karaman | 305908c | 2020-02-24 14:42:52 +0000 | [diff] [blame] | 143 | IgmpSender.getInstance().sendIgmpPacketUplink(eth, devId, upLinkPort); |
Esin Karaman | a05342e | 2019-09-17 13:01:25 +0000 | [diff] [blame] | 144 | } |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 145 | } |
| 146 | |
| 147 | public void query(int maxResp) { |
| 148 | } |
| 149 | |
| 150 | public void timeOut() { |
| 151 | } |
| 152 | |
| 153 | } |
| 154 | |
| 155 | class NonMember extends State { |
Esin Karaman | a05342e | 2019-09-17 13:01:25 +0000 | [diff] [blame] | 156 | public void join(boolean messageOutAllowed) { |
| 157 | if (messageOutAllowed) { |
| 158 | Ethernet eth = IgmpSender.getInstance().buildIgmpV3Join(groupIp, srcIp); |
Esin Karaman | 305908c | 2020-02-24 14:42:52 +0000 | [diff] [blame] | 159 | IgmpSender.getInstance().sendIgmpPacketUplink(eth, devId, upLinkPort); |
Esin Karaman | a05342e | 2019-09-17 13:01:25 +0000 | [diff] [blame] | 160 | timeOut = getTimeOut(IgmpManager.getUnsolicitedTimeout()); |
| 161 | timerId = IgmpTimer.start(SingleStateMachine.this, timeOut); |
| 162 | } |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 163 | } |
| 164 | } |
| 165 | |
| 166 | class DelayMember extends State { |
| 167 | public void query(int maxResp) { |
| 168 | if (maxResp < timeOut) { |
| 169 | timeOut = getTimeOut(maxResp); |
| 170 | timerId = IgmpTimer.reset(timerId, SingleStateMachine.this, timeOut); |
| 171 | } |
| 172 | } |
| 173 | |
| 174 | public void timeOut() { |
Vignesh Ethiraj | d1957c9 | 2019-11-18 11:52:49 +0000 | [diff] [blame] | 175 | if (sendQuery) { |
| 176 | Ethernet eth = IgmpSender.getInstance().buildIgmpV3ResponseQuery(groupIp, srcIp); |
Esin Karaman | 305908c | 2020-02-24 14:42:52 +0000 | [diff] [blame] | 177 | IgmpSender.getInstance().sendIgmpPacketUplink(eth, devId, upLinkPort); |
Vignesh Ethiraj | d1957c9 | 2019-11-18 11:52:49 +0000 | [diff] [blame] | 178 | timeOut = DEFAULT_MAX_RESP; |
| 179 | } |
ke han | 81a38b9 | 2017-03-10 18:41:44 +0800 | [diff] [blame] | 180 | } |
| 181 | |
| 182 | } |
| 183 | |
| 184 | class IdleMember extends State { |
| 185 | public void query(int maxResp) { |
| 186 | timeOut = getTimeOut(maxResp); |
| 187 | timerId = IgmpTimer.start(SingleStateMachine.this, timeOut); |
| 188 | } |
| 189 | } |
| 190 | } |