arblant
firefox-vpn-client / core / internal / proxy / pool.go
pool.go449 lines · 10.0 KB
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 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
package proxy

import (
	"fmt"
	"hash/fnv"
	"net"
	"strings"
	"sync"
	"sync/atomic"
	"time"

	"github.com/armanlife/firefox-vpn-client/core/internal/logx"
)

const upstreamSessionRetryDelay = 10 * time.Second

type pooledProxySession struct {
	mu      sync.Mutex
	session proxySession
	healthy bool
	retired bool
	refs    int
}

type proxySessionPool struct {
	create         func() (proxySession, error)
	setCreateToken func(string)
	sessions       []*pooledProxySession
	clientSlots    map[string]int
	next           atomic.Uint64
	tokenMu        sync.RWMutex
	currentToken   string

	mu        sync.Mutex
	closed    bool
	done      chan struct{}
	closeOnce sync.Once
}

func newProxySessionPool(size int, create func() (proxySession, error), setCreateToken ...func(string)) (*proxySessionPool, error) {
	if size < 1 {
		return nil, fmt.Errorf("upstream session pool size must be at least 1")
	}

	pool := &proxySessionPool{
		create:      create,
		sessions:    make([]*pooledProxySession, size),
		clientSlots: make(map[string]int),
		done:        make(chan struct{}),
	}
	if len(setCreateToken) > 0 {
		pool.setCreateToken = setCreateToken[0]
	}
	successes := 0
	var firstErr error
	for i := 0; i < size; i++ {
		session, err := create()
		if err != nil {
			if firstErr == nil {
				firstErr = err
			}
			logx.Warn("creating upstream session failed slot=%d size=%d err=%s", i+1, size, logx.Err(err))
			continue
		}
		pool.sessions[i] = newPooledProxySession(session)
		successes++
	}
	if successes == 0 {
		_ = pool.Close()
		return nil, fmt.Errorf("creating upstream session pool: %w", firstErr)
	}
	if successes < size {
		logx.Warn("upstream proxy session pool partially established available=%d desired=%d affinity=client-ip failover=enabled", successes, size)
		for i := range pool.sessions {
			if pool.sessions[i] == nil {
				go pool.replenishSlot(i)
			}
		}
	} else {
		logx.Info("upstream proxy session pool established size=%d affinity=client-ip failover=enabled", successes)
	}
	return pool, nil
}

func newPooledProxySession(session proxySession) *pooledProxySession {
	return &pooledProxySession{
		session: session,
		healthy: true,
	}
}

func (p *proxySessionPool) OpenTunnel(authority string) (net.Conn, error) {
	return p.openTunnel(authority, "")
}

func (p *proxySessionPool) OpenTunnelForClient(authority, clientKey string) (net.Conn, error) {
	return p.openTunnel(authority, clientKey)
}

func (p *proxySessionPool) UpdateToken(token string) error {
	if strings.TrimSpace(token) == "" {
		return fmt.Errorf("empty proxy session token")
	}
	if p == nil {
		return ErrNoUsableSession
	}
	p.tokenMu.Lock()
	p.currentToken = token
	p.tokenMu.Unlock()
	if p.setCreateToken != nil {
		p.setCreateToken(token)
	}

	p.mu.Lock()
	sessions := append([]*pooledProxySession(nil), p.sessions...)
	p.mu.Unlock()
	updated := 0
	for _, pooled := range sessions {
		if pooled == nil {
			continue
		}
		session, ok := pooled.acquire()
		if !ok {
			continue
		}
		updater, ok := session.(proxySessionTokenUpdater)
		if !ok {
			pooled.release()
			return fmt.Errorf("upstream session does not support token update")
		}
		if err := updater.UpdateToken(token); err != nil {
			pooled.release()
			return err
		}
		pooled.release()
		updated++
	}
	if updated == 0 {
		return ErrNoUsableSession
	}
	return nil
}

func (p *proxySessionPool) applyCurrentToken(session proxySession) error {
	p.tokenMu.RLock()
	token := p.currentToken
	p.tokenMu.RUnlock()
	if token == "" {
		return nil
	}
	updater, ok := session.(proxySessionTokenUpdater)
	if !ok {
		return fmt.Errorf("upstream session does not support token update")
	}
	return updater.UpdateToken(token)
}

func (p *proxySessionPool) openTunnel(authority, clientKey string) (net.Conn, error) {
	if p == nil || len(p.sessions) == 0 {
		return nil, ErrNoUsableSession
	}

	start := p.nextSlot(clientKey)
	var lastErr error
	for i := 0; i < len(p.sessions); i++ {
		slot := (start + i) % len(p.sessions)
		pooled := p.slot(slot)
		if pooled == nil {
			continue
		}
		session, ok := pooled.acquire()
		if !ok {
			// A slot the keepalive marked unhealthy stays skipped until it is
			// retired, so retire it here to trigger background replenishment.
			if pooled.needsRetire() {
				p.setClientFallback(clientKey, start, slot, (slot+1)%len(p.sessions))
				p.retireSlot(slot, pooled)
			}
			continue
		}
		conn, err := session.OpenTunnel(authority)
		if err == nil {
			p.rememberClientSlot(clientKey, start, slot)
			return &pooledTunnelConn{
				Conn:    conn,
				release: pooled.release,
			}, nil
		}
		pooled.release()
		lastErr = err
		if !shouldRebuildProxySession(err) {
			return nil, err
		}
		p.setClientFallback(clientKey, start, slot, (slot+1)%len(p.sessions))
		p.retireSlot(slot, pooled)
	}
	if lastErr != nil {
		return nil, lastErr
	}
	return nil, ErrNoUsableSession
}

func (p *proxySessionPool) nextSlot(clientKey string) int {
	if clientKey == "" {
		return int((p.next.Add(1) - 1) % uint64(len(p.sessions)))
	}

	p.mu.Lock()
	if slot, ok := p.clientSlots[clientKey]; ok {
		p.mu.Unlock()
		return slot
	}
	h := fnv.New32a()
	_, _ = h.Write([]byte(clientKey))
	slot := int(h.Sum32() % uint32(len(p.sessions)))
	p.clientSlots[clientKey] = slot
	p.mu.Unlock()
	return slot
}

func (p *proxySessionPool) rememberClientSlot(clientKey string, initialSlot, actualSlot int) {
	if clientKey == "" || initialSlot == actualSlot {
		return
	}
	p.mu.Lock()
	currentSlot, ok := p.clientSlots[clientKey]
	if !p.closed && ok && (currentSlot == initialSlot || p.sessions[currentSlot] == nil) {
		p.clientSlots[clientKey] = actualSlot
	}
	p.mu.Unlock()
}

func (p *proxySessionPool) setClientFallback(clientKey string, initialSlot, failedSlot, fallbackSlot int) {
	if clientKey == "" {
		return
	}
	p.mu.Lock()
	currentSlot, ok := p.clientSlots[clientKey]
	if !p.closed && ok && (currentSlot == initialSlot || currentSlot == failedSlot || p.sessions[currentSlot] == nil) {
		p.clientSlots[clientKey] = fallbackSlot
	}
	p.mu.Unlock()
}

func (p *proxySessionPool) Close() error {
	if p == nil {
		return nil
	}
	var sessions []*pooledProxySession
	p.closeOnce.Do(func() {
		close(p.done)
		p.mu.Lock()
		p.closed = true
		sessions = append(sessions, p.sessions...)
		for i := range p.sessions {
			p.sessions[i] = nil
		}
		p.mu.Unlock()
	})
	var err error
	for _, pooled := range sessions {
		if pooled == nil {
			continue
		}
		if closeErr := pooled.closeNow(); err == nil {
			err = closeErr
		}
	}
	return err
}

func (p *proxySessionPool) slot(i int) *pooledProxySession {
	p.mu.Lock()
	defer p.mu.Unlock()
	if p.closed || i < 0 || i >= len(p.sessions) {
		return nil
	}
	return p.sessions[i]
}

func (p *proxySessionPool) retireSlot(i int, expected *pooledProxySession) {
	expected.retire()

	p.mu.Lock()
	if p.closed || i < 0 || i >= len(p.sessions) || p.sessions[i] != expected {
		p.mu.Unlock()
		return
	}
	p.sessions[i] = nil
	p.mu.Unlock()

	go p.replenishSlot(i)
}

func (p *proxySessionPool) replenishSlot(i int) {
	for {
		p.mu.Lock()
		if p.closed || i < 0 || i >= len(p.sessions) || p.sessions[i] != nil {
			p.mu.Unlock()
			return
		}
		p.mu.Unlock()

		session, err := p.create()
		if err != nil {
			logx.Warn("replenishing upstream session failed slot=%d err=%s", i+1, logx.Err(err))
			if !p.waitOrClosed(upstreamSessionRetryDelay) {
				return
			}
			continue
		}
		if err := p.applyCurrentToken(session); err != nil {
			_ = session.Close()
			logx.Warn("applying renewed token to replenished upstream session failed slot=%d err=%s", i+1, logx.Err(err))
			if !p.waitOrClosed(upstreamSessionRetryDelay) {
				return
			}
			continue
		}

		pooled := newPooledProxySession(session)
		p.mu.Lock()
		if p.closed || p.sessions[i] != nil {
			p.mu.Unlock()
			_ = pooled.closeNow()
			return
		}
		p.sessions[i] = pooled
		p.mu.Unlock()
		logx.Info("upstream proxy session replenished slot=%d", i+1)
		return
	}
}

func (p *proxySessionPool) waitOrClosed(d time.Duration) bool {
	timer := time.NewTimer(d)
	defer timer.Stop()
	select {
	case <-timer.C:
		return true
	case <-p.done:
		return false
	}
}

func (p *pooledProxySession) acquire() (proxySession, bool) {
	p.mu.Lock()
	defer p.mu.Unlock()
	if !p.healthy || p.retired || p.session == nil {
		return nil, false
	}
	if !isSessionAlive(p.session) {
		// The keepalive already saw this connection die. Mark it unhealthy so
		// openTunnel retires the slot and replenishes it in the background.
		p.healthy = false
		return nil, false
	}
	p.refs++
	return p.session, true
}

// needsRetire reports whether this slot holds a session that is unusable but
// has not been retired yet, so the caller can start a replacement.
func (p *pooledProxySession) needsRetire() bool {
	p.mu.Lock()
	defer p.mu.Unlock()
	return !p.retired && !p.healthy
}

func (p *pooledProxySession) release() {
	session := p.releaseLocked()
	if session != nil {
		_ = session.Close()
	}
}

func (p *pooledProxySession) releaseLocked() proxySession {
	p.mu.Lock()
	defer p.mu.Unlock()
	if p.refs > 0 {
		p.refs--
	}
	if p.refs == 0 && p.retired && p.session != nil {
		session := p.session
		p.session = nil
		return session
	}
	return nil
}

func (p *pooledProxySession) retire() {
	p.mu.Lock()
	p.healthy = false
	p.retired = true
	shouldClose := p.refs == 0 && p.session != nil
	var session proxySession
	if shouldClose {
		session = p.session
		p.session = nil
	}
	p.mu.Unlock()
	if session != nil {
		_ = session.Close()
	}
}

func (p *pooledProxySession) closeNow() error {
	p.mu.Lock()
	session := p.session
	p.session = nil
	p.healthy = false
	p.retired = true
	p.mu.Unlock()
	if session == nil {
		return nil
	}
	return session.Close()
}

type pooledTunnelConn struct {
	net.Conn
	release func()
	once    sync.Once
}

func (c *pooledTunnelConn) Close() error {
	var err error
	c.once.Do(func() {
		err = c.Conn.Close()
		if c.release != nil {
			c.release()
		}
	})
	return err
}

func (c *pooledTunnelConn) CloseRead() error {
	if closeReader, ok := c.Conn.(interface{ CloseRead() error }); ok {
		return closeReader.CloseRead()
	}
	return nil
}

func (c *pooledTunnelConn) CloseWrite() error {
	if closeWriter, ok := c.Conn.(interface{ CloseWrite() error }); ok {
		return closeWriter.CloseWrite()
	}
	return nil
}