|
| 1 | +// Copyright (c) 2022-2023 Cisco and/or its affiliates. |
| 2 | +// |
| 3 | +// SPDX-License-Identifier: Apache-2.0 |
| 4 | +// |
| 5 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | +// you may not use this file except in compliance with the License. |
| 7 | +// You may obtain a copy of the License at: |
| 8 | +// |
| 9 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +// |
| 11 | +// Unless required by applicable law or agreed to in writing, software |
| 12 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | +// See the License for the specific language governing permissions and |
| 15 | +// limitations under the License. |
| 16 | + |
| 17 | +// Package heal contains an implementation of LivenessChecker. |
| 18 | +package heal |
| 19 | + |
| 20 | +import ( |
| 21 | + "context" |
| 22 | + "errors" |
| 23 | + "net" |
| 24 | + "strings" |
| 25 | + "time" |
| 26 | + |
| 27 | + "github.com/go-ping/ping" |
| 28 | + "github.com/networkservicemesh/api/pkg/api/networkservice" |
| 29 | + "github.com/networkservicemesh/api/pkg/api/networkservice/mechanisms/kernel" |
| 30 | + "github.com/networkservicemesh/sdk/pkg/tools/log" |
| 31 | +) |
| 32 | + |
| 33 | +const ( |
| 34 | + defaultTimeout = time.Second |
| 35 | + packetCount = 4 |
| 36 | + |
| 37 | + DatapathSourceIPsKey = "DATAPATH_SOURCE_IPS" |
| 38 | + DatapathDestinationIPsKey = "DATAPATH_DESTINATION_IPS" |
| 39 | + DatapathIPsSeparator = " " |
| 40 | +) |
| 41 | + |
| 42 | +type options struct { |
| 43 | + pingerFactory PingerFactory |
| 44 | +} |
| 45 | + |
| 46 | +// Option is an option pattern for LivelinessChecker |
| 47 | +type Option func(o *options) |
| 48 | + |
| 49 | +// WithPingerFactory - sets any custom pinger factory |
| 50 | +func WithPingerFactory(pf PingerFactory) Option { |
| 51 | + return func(o *options) { |
| 52 | + o.pingerFactory = pf |
| 53 | + } |
| 54 | +} |
| 55 | + |
| 56 | +// KernelLivenessCheck is an implementation of heal.LivenessCheck |
| 57 | +func KernelLivenessCheck(deadlineCtx context.Context, conn *networkservice.Connection) bool { |
| 58 | + return KernelLivenessCheckWithOptions(deadlineCtx, conn) |
| 59 | +} |
| 60 | + |
| 61 | +// KernelLivenessCheckWithOptions is an implementation with options of heal.LivenessCheck. It sends ICMP |
| 62 | +// ping and checks reply. Returns false if didn't get reply. |
| 63 | +func KernelLivenessCheckWithOptions(deadlineCtx context.Context, conn *networkservice.Connection, opts ...Option) bool { |
| 64 | + // Apply options |
| 65 | + o := &options{ |
| 66 | + pingerFactory: &defaultPingerFactory{}, |
| 67 | + } |
| 68 | + for _, opt := range opts { |
| 69 | + opt(o) |
| 70 | + } |
| 71 | + var pingerFactory = o.pingerFactory |
| 72 | + |
| 73 | + if mechanism := conn.GetMechanism().GetType(); mechanism != kernel.MECHANISM { |
| 74 | + log.FromContext(deadlineCtx).Warnf("ping is not supported for mechanism %v", mechanism) |
| 75 | + return true |
| 76 | + } |
| 77 | + |
| 78 | + sourceIPs, destinationIPs := getSourceDestinationIPs(conn.GetContext().GetExtraContext()) |
| 79 | + combinationCount := len(sourceIPs) * len(destinationIPs) |
| 80 | + if combinationCount == 0 { |
| 81 | + log.FromContext(deadlineCtx).Debug("No IP address") |
| 82 | + return true |
| 83 | + } |
| 84 | + |
| 85 | + deadline, ok := deadlineCtx.Deadline() |
| 86 | + if !ok { |
| 87 | + deadline = time.Now().Add(defaultTimeout) |
| 88 | + } |
| 89 | + timeout := time.Until(deadline) |
| 90 | + |
| 91 | + responseCh := make(chan error, combinationCount) |
| 92 | + defer close(responseCh) |
| 93 | + for _, sourceIP := range sourceIPs { |
| 94 | + for _, destinationIP := range destinationIPs { |
| 95 | + if (destinationIP.To4() != nil) != (sourceIP.To4() != nil) { |
| 96 | + responseCh <- nil |
| 97 | + continue |
| 98 | + } |
| 99 | + |
| 100 | + go func(srcIP, dstIP string) { |
| 101 | + logger := log.FromContext(deadlineCtx).WithField("srcIP", srcIP).WithField("dstIP", dstIP) |
| 102 | + pinger := pingerFactory.CreatePinger(srcIP, dstIP, timeout, packetCount) |
| 103 | + |
| 104 | + err := pinger.Run() |
| 105 | + if err != nil { |
| 106 | + logger.Errorf("Ping failed: %s", err.Error()) |
| 107 | + responseCh <- err |
| 108 | + return |
| 109 | + } |
| 110 | + |
| 111 | + if pinger.GetReceivedPackets() == 0 { |
| 112 | + err = errors.New("No packets received") |
| 113 | + logger.Errorf(err.Error()) |
| 114 | + responseCh <- err |
| 115 | + return |
| 116 | + } |
| 117 | + responseCh <- nil |
| 118 | + }(sourceIP.String(), destinationIP.String()) |
| 119 | + } |
| 120 | + } |
| 121 | + |
| 122 | + // Waiting for all ping results. If at least one fails - return false |
| 123 | + return waitForResponses(responseCh) |
| 124 | +} |
| 125 | + |
| 126 | +func getSourceDestinationIPs(extraContext map[string]string) ([]net.IP, []net.IP) { |
| 127 | + sourceIPs := []net.IP{} |
| 128 | + destinationIPs := []net.IP{} |
| 129 | + sourceIPsStr := extraContext[DatapathSourceIPsKey] |
| 130 | + destinationIPsStr := extraContext[DatapathDestinationIPsKey] |
| 131 | + |
| 132 | + for _, sourceIPStr := range strings.Split(sourceIPsStr, DatapathIPsSeparator) { |
| 133 | + sourceIP, _, err := net.ParseCIDR(sourceIPStr) |
| 134 | + if err != nil { |
| 135 | + continue |
| 136 | + } |
| 137 | + |
| 138 | + sourceIPs = append(sourceIPs, sourceIP) |
| 139 | + } |
| 140 | + |
| 141 | + for _, destinationIPStr := range strings.Split(destinationIPsStr, DatapathIPsSeparator) { |
| 142 | + destinationIP, _, err := net.ParseCIDR(destinationIPStr) |
| 143 | + if err != nil { |
| 144 | + continue |
| 145 | + } |
| 146 | + |
| 147 | + destinationIPs = append(destinationIPs, destinationIP) |
| 148 | + } |
| 149 | + |
| 150 | + return sourceIPs, destinationIPs |
| 151 | +} |
| 152 | + |
| 153 | +func waitForResponses(responseCh <-chan error) bool { |
| 154 | + respCount := cap(responseCh) |
| 155 | + success := true |
| 156 | + for { |
| 157 | + resp, ok := <-responseCh |
| 158 | + if !ok { |
| 159 | + return false |
| 160 | + } |
| 161 | + if resp != nil { |
| 162 | + success = false |
| 163 | + } |
| 164 | + respCount-- |
| 165 | + if respCount == 0 { |
| 166 | + return success |
| 167 | + } |
| 168 | + } |
| 169 | +} |
| 170 | + |
| 171 | +// PingerFactory - factory interface for creating pingers |
| 172 | +type PingerFactory interface { |
| 173 | + CreatePinger(srcIP, dstIP string, timeout time.Duration, count int) Pinger |
| 174 | +} |
| 175 | + |
| 176 | +// Pinger - pinger interface |
| 177 | +type Pinger interface { |
| 178 | + Run() error |
| 179 | + GetReceivedPackets() int |
| 180 | +} |
| 181 | + |
| 182 | +type defaultPingerFactory struct{} |
| 183 | + |
| 184 | +func (p *defaultPingerFactory) CreatePinger(srcIP, dstIP string, timeout time.Duration, count int) Pinger { |
| 185 | + pi := ping.New(dstIP) |
| 186 | + pi.Source = srcIP |
| 187 | + pi.Timeout = timeout |
| 188 | + pi.Count = count |
| 189 | + if count != 0 { |
| 190 | + pi.Interval = timeout / time.Duration(count) |
| 191 | + } |
| 192 | + |
| 193 | + return &defaultPinger{pinger: pi} |
| 194 | +} |
| 195 | + |
| 196 | +type defaultPinger struct { |
| 197 | + pinger *ping.Pinger |
| 198 | +} |
| 199 | + |
| 200 | +func (p *defaultPinger) Run() error { |
| 201 | + return p.pinger.Run() |
| 202 | +} |
| 203 | + |
| 204 | +func (p *defaultPinger) GetReceivedPackets() int { |
| 205 | + return p.pinger.Statistics().PacketsRecv |
| 206 | +} |
0 commit comments