1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
|
package reverse_tunnel
import (
"context"
"errors"
"fmt"
"sync"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/api"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/reverse_tunnel/rpc"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/reverse_tunnel/tracker"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/errz"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/grpctool"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/logz"
"go.uber.org/zap"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)
// IOFunc is a function that performs I/O.
// It should be called when not holding a mutex to avoid blocking other goroutines trying to acquire the mutex
// for the duration of the I/O.
type IOFunc func()
type TunnelHandler interface {
// HandleTunnel is called with server-side interface of the reverse tunnel.
// It registers the tunnel and blocks, waiting for a request to proxy through the tunnel.
// The method returns the error value to return to gRPC framework.
// ctx can be used to unblock the method if the tunnel is not being used already.
// ctx should be a child of the server's context.
HandleTunnel(ctx context.Context, agentInfo *api.AgentInfo, server rpc.ReverseTunnel_ConnectServer) error
}
type FindHandle interface {
// Get finds a tunnel to an agentk.
// It waits for a matching tunnel to proxy a connection through. When a matching tunnel is found, it is returned.
// It returns gRPC status errors only, ready to return from RPC handler.
Get(ctx context.Context) (Tunnel, error)
// Done must be called to free resources of this FindHandle instance.
Done()
}
type TunnelFinder interface {
// FindTunnel starts searching for a tunnel to a matching agentk.
// Found tunnel is:
// - to an agent with provided id.
// - supports handling provided gRPC service and method.
// Tunnel found boolean indicates whether a suitable tunnel is immediately available from the
// returned FindHandle object.
FindTunnel(agentId int64, service, method string) (bool /* tunnel found */, FindHandle)
}
type findTunnelRequest struct {
agentId int64
service, method string
retTun chan<- *tunnel
}
type findHandle struct {
retTun <-chan *tunnel
done func()
gotTunnel bool
}
func (h *findHandle) Get(ctx context.Context) (Tunnel, error) {
select {
case <-ctx.Done():
return nil, grpctool.StatusErrorFromContext(ctx, "FindTunnel request aborted")
case tun := <-h.retTun:
h.gotTunnel = true
if tun == nil {
return nil, status.Error(codes.Unavailable, "kas is shutting down")
}
return tun, nil
}
}
func (h *findHandle) Done() {
if h.gotTunnel {
// No cleanup needed if Get returned a tunnel.
return
}
h.done()
}
type TunnelRegistry struct {
log *zap.Logger
errRep errz.ErrReporter
tunnelRegisterer tracker.Registerer
ownPrivateApiUrl string
tunnelStreamVisitor *grpctool.StreamVisitor
mu sync.Mutex
tuns map[*tunnel]struct{}
tunsByAgentId map[int64]map[*tunnel]struct{}
findRequestsByAgentId map[int64]map[*findTunnelRequest]struct{}
}
func NewTunnelRegistry(log *zap.Logger, errRep errz.ErrReporter, tunnelRegisterer tracker.Registerer, ownPrivateApiUrl string) (*TunnelRegistry, error) {
tunnelStreamVisitor, err := grpctool.NewStreamVisitor(&rpc.ConnectRequest{})
if err != nil {
return nil, err
}
return &TunnelRegistry{
log: log,
errRep: errRep,
tunnelRegisterer: tunnelRegisterer,
ownPrivateApiUrl: ownPrivateApiUrl,
tunnelStreamVisitor: tunnelStreamVisitor,
tuns: make(map[*tunnel]struct{}),
tunsByAgentId: make(map[int64]map[*tunnel]struct{}),
findRequestsByAgentId: make(map[int64]map[*findTunnelRequest]struct{}),
}, nil
}
func (r *TunnelRegistry) FindTunnel(agentId int64, service, method string) (bool /* tunnel found */, FindHandle) {
// Buffer 1 to not block on send when a tunnel is found before find request is registered.
retTun := make(chan *tunnel, 1) // can receive nil from it if Stop() is called
ftr := &findTunnelRequest{
agentId: agentId,
service: service,
method: method,
retTun: retTun,
}
found := false
doIORegister := func() IOFunc {
r.mu.Lock()
defer r.mu.Unlock()
// 1. Check if we have a suitable tunnel
for tun := range r.tunsByAgentId[agentId] {
if !tun.agentDescriptor.SupportsServiceAndMethod(service, method) {
continue
}
// Suitable tunnel found!
tun.state = stateFound
retTun <- tun // must not block because the reception is below
found = true
return r.unregisterTunnelLocked(tun)
}
// 2. No suitable tunnel found, add to the queue
findRequestsForAgentId := r.findRequestsByAgentId[agentId]
if findRequestsForAgentId == nil {
findRequestsForAgentId = make(map[*findTunnelRequest]struct{}, 1)
r.findRequestsByAgentId[agentId] = findRequestsForAgentId
}
findRequestsForAgentId[ftr] = struct{}{}
return noIO
}()
doIORegister()
return found, &findHandle{
retTun: retTun,
done: func() {
doIODone := func() IOFunc {
r.mu.Lock()
defer r.mu.Unlock()
close(retTun)
tun := <-retTun // will get nil if there was nothing in the channel or if registry is shutting down.
if tun != nil {
// Got the tunnel, but it's too late so return it to the registry.
return r.onTunnelDoneLocked(tun)
} else {
r.deleteFindRequest(ftr)
return noIO
}
}()
doIODone()
},
}
}
func (r *TunnelRegistry) HandleTunnel(ctx context.Context, agentInfo *api.AgentInfo, server rpc.ReverseTunnel_ConnectServer) error {
recv, err := server.Recv()
if err != nil {
return err
}
descriptor, ok := recv.Msg.(*rpc.ConnectRequest_Descriptor_)
if !ok {
return status.Errorf(codes.InvalidArgument, "Invalid oneof value type: %T", recv.Msg)
}
retErr := make(chan error, 1)
tun := &tunnel{
tunnel: server,
tunnelStreamVisitor: r.tunnelStreamVisitor,
tunnelRetErr: retErr,
agentId: agentInfo.Id,
agentDescriptor: descriptor.Descriptor_.AgentDescriptor,
state: stateReady,
onForward: r.onTunnelForward,
onDone: r.onTunnelDone,
}
// Register
doIO := func() IOFunc {
r.mu.Lock()
defer r.mu.Unlock()
return r.registerTunnelLocked(tun)
}()
doIO()
// Wait for return error or for cancellation
select {
case <-ctx.Done():
// Context canceled
r.mu.Lock()
switch tun.state {
case stateReady:
tun.state = stateContextDone
doIO = r.unregisterTunnelLocked(tun) // nolint: contextcheck
r.mu.Unlock()
doIO()
return nil
case stateFound:
// Tunnel was found but hasn't been used yet, Done() hasn't been called.
// Set state to stateContextDone so that ForwardStream() errors out without doing any I/O.
tun.state = stateContextDone
r.mu.Unlock()
return nil
case stateForwarding:
// I/O on the stream will error out, just wait for the return value.
r.mu.Unlock()
return <-retErr
case stateDone:
// Forwarding has finished and then ctx signaled done. Return the result value from forwarding.
r.mu.Unlock()
return <-retErr
case stateContextDone:
// Cannot happen twice.
r.mu.Unlock()
panic(errors.New("unreachable"))
default:
// Should never happen
r.mu.Unlock()
panic(fmt.Errorf("invalid state: %d", tun.state))
}
case err = <-retErr:
return err
}
}
func (r *TunnelRegistry) registerTunnelLocked(toReg *tunnel) IOFunc {
agentId := toReg.agentId
// 1. Before registering the tunnel see if there is a find tunnel request waiting for it
findRequestsForAgentId := r.findRequestsByAgentId[agentId]
for ftr := range findRequestsForAgentId {
if !toReg.agentDescriptor.SupportsServiceAndMethod(ftr.service, ftr.method) {
continue
}
// Waiting request found!
toReg.state = stateFound
ftr.retTun <- toReg // Satisfy the waiting request ASAP
r.deleteFindRequest(ftr) // Remove it from the queue
return noIO
}
// 2. Register the tunnel
toReg.state = stateReady
r.tuns[toReg] = struct{}{}
tunsByAgentId := r.tunsByAgentId[agentId]
if tunsByAgentId == nil {
tunsByAgentId = make(map[*tunnel]struct{}, 1)
r.tunsByAgentId[agentId] = tunsByAgentId
}
tunsByAgentId[toReg] = struct{}{}
return r.registerTunnelIO(agentId)
}
func (r *TunnelRegistry) unregisterTunnelLocked(toUnreg *tunnel) IOFunc {
agentId := toUnreg.agentId
delete(r.tuns, toUnreg)
tunsByAgentId := r.tunsByAgentId[agentId]
delete(tunsByAgentId, toUnreg)
if len(tunsByAgentId) == 0 {
delete(r.tunsByAgentId, agentId)
}
return r.unregisterTunnelIO(agentId)
}
func (r *TunnelRegistry) onTunnelForward(tun *tunnel) error {
r.mu.Lock()
defer r.mu.Unlock()
switch tun.state {
case stateReady:
return status.Error(codes.Internal, "unreachable: ready -> forwarding should never happen")
case stateFound:
tun.state = stateForwarding
return nil
case stateForwarding:
return status.Error(codes.Internal, "ForwardStream() called more than once")
case stateDone:
return status.Error(codes.Internal, "ForwardStream() called after Done()")
case stateContextDone:
return status.Error(codes.Canceled, "ForwardStream() called on done stream")
default:
return status.Errorf(codes.Internal, "unreachable: invalid state: %d", tun.state)
}
}
func (r *TunnelRegistry) onTunnelDone(tun *tunnel) {
var doIO IOFunc
func() {
r.mu.Lock()
defer r.mu.Unlock()
doIO = r.onTunnelDoneLocked(tun)
}()
doIO()
}
func (r *TunnelRegistry) onTunnelDoneLocked(tun *tunnel) IOFunc {
switch tun.state {
case stateReady:
panic(errors.New("unreachable: ready -> done should never happen"))
case stateFound:
// Tunnel was found but was not used, Done() was called. Just put it back.
return r.registerTunnelLocked(tun)
case stateForwarding:
tun.state = stateDone
case stateDone:
panic(errors.New("Done() called more than once"))
case stateContextDone:
// Done() called after cancelled context in HandleTunnel(). Nothing to do.
default:
// Should never happen
panic(fmt.Errorf("invalid state: %d", tun.state))
}
return noIO
}
func (r *TunnelRegistry) deleteFindRequest(ftr *findTunnelRequest) {
findRequestsForAgentId := r.findRequestsByAgentId[ftr.agentId]
delete(findRequestsForAgentId, ftr)
if len(findRequestsForAgentId) == 0 {
delete(r.findRequestsByAgentId, ftr.agentId)
}
}
// Stop aborts any open tunnels.
// It should not be necessary to abort tunnels when registry is used correctly i.e. this method is called after
// all tunnels have terminated gracefully.
func (r *TunnelRegistry) Stop() {
r.stopInternal()
}
// stopInternal is used for testing.
func (r *TunnelRegistry) stopInternal() (int, int) {
// Abort all tunnels
r.mu.Lock()
defer r.mu.Unlock()
tl := len(r.tuns)
fl := len(r.findRequestsByAgentId)
if tl == 0 && fl == 0 {
return 0, 0 // Avoid logging a warning
}
r.log.Warn("Stopping tunnels and find requests", logz.NumberOfTunnels(tl), logz.NumberOfTunnelFindRequests(fl))
for tun := range r.tuns {
tun.state = stateDone
tun.tunnelRetErr <- nil // nil so that HandleTunnel() returns cleanly and agent immediately retries
doIO := r.unregisterTunnelLocked(tun)
doIO()
}
r.log.Warn("Done stopping tunnels")
// Abort all waiting new stream requests
for _, findRequestsForAgentId := range r.findRequestsByAgentId {
for ftr := range findRequestsForAgentId {
ftr.retTun <- nil // respond ASAP, then do all the bookkeeping
r.deleteFindRequest(ftr)
}
}
return tl, fl
}
func (r *TunnelRegistry) registerTunnelIO(agentId int64) IOFunc {
return func() {
err := r.tunnelRegisterer.RegisterTunnel(context.Background(), agentId) // don't pass context to always register
if err != nil {
r.errRep.HandleProcessingError(context.Background(), r.log.With(logz.AgentId(agentId)), "Failed to register tunnel", err)
}
}
}
func (r *TunnelRegistry) unregisterTunnelIO(agentId int64) IOFunc {
return func() {
err := r.tunnelRegisterer.UnregisterTunnel(context.Background(), agentId) // don't pass context to always unregister
if err != nil {
r.errRep.HandleProcessingError(context.Background(), r.log.With(logz.AgentId(agentId)), "Failed to unregister tunnel", err)
}
}
}
func noIO() {
}
|