minio/internal/deadlineconn/deadlineconn.go

// Copyright (c) 2015-2022 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

// Package deadlineconn implements net.Conn wrapper with configured deadlines.
package deadlineconn

import (
	"context"
	"net"
	"sync"
	"sync/atomic"
	"time"
)

// updateInterval is the minimum time between deadline updates.
const updateInterval = 250 * time.Millisecond

// DeadlineConn - is a generic stream-oriented network connection supporting buffered reader and read/write timeout.
type DeadlineConn struct {
	net.Conn
	readDeadline            time.Duration // sets the read deadline on a connection.
	readSetAt               time.Time
	writeDeadline           time.Duration // sets the write deadline on a connection.
	writeSetAt              time.Time
	abortReads, abortWrites atomic.Bool // A deadline was set to indicate caller wanted the conn to time out.
	mu                      sync.Mutex
}

// Sets read deadline
func (c *DeadlineConn) setReadDeadline() {
	// Do not set a Read deadline, if upstream wants to cancel all reads.
	if c.readDeadline <= 0 || c.abortReads.Load() {
		return
	}

	c.mu.Lock()
	defer c.mu.Unlock()
	if c.abortReads.Load() {
		return
	}

	now := time.Now()
	if now.Sub(c.readSetAt) > updateInterval {
		c.Conn.SetReadDeadline(now.Add(c.readDeadline + updateInterval))
		c.readSetAt = now
	}
}

func (c *DeadlineConn) setWriteDeadline() {
	// Do not set a Write deadline, if upstream wants to cancel all reads.
	if c.writeDeadline <= 0 || c.abortWrites.Load() {
		return
	}

	c.mu.Lock()
	defer c.mu.Unlock()
	if c.abortWrites.Load() {
		return
	}
	now := time.Now()
	if now.Sub(c.writeSetAt) > updateInterval {
		c.Conn.SetWriteDeadline(now.Add(c.writeDeadline + updateInterval))
		c.writeSetAt = now
	}
}

// Read - reads data from the connection using wrapped buffered reader.
func (c *DeadlineConn) Read(b []byte) (n int, err error) {
	if c.abortReads.Load() {
		return 0, context.DeadlineExceeded
	}
	c.setReadDeadline()
	n, err = c.Conn.Read(b)
	return n, err
}

// Write - writes data to the connection.
func (c *DeadlineConn) Write(b []byte) (n int, err error) {
	if c.abortWrites.Load() {
		return 0, context.DeadlineExceeded
	}
	c.setWriteDeadline()
	n, err = c.Conn.Write(b)
	return n, err
}

// SetDeadline will set the deadline for reads and writes.
// A zero value for t means I/O operations will not time out.
func (c *DeadlineConn) SetDeadline(t time.Time) error {
	c.mu.Lock()
	defer c.mu.Unlock()
	if t.IsZero() {
		var err error
		if c.readDeadline == 0 {
			err = c.Conn.SetReadDeadline(t)
		}
		if c.writeDeadline == 0 {
			if wErr := c.Conn.SetWriteDeadline(t); wErr != nil {
				return wErr
			}
		}
		c.abortReads.Store(false)
		c.abortWrites.Store(false)
		return err
	}
	// If upstream sets a deadline in the past, assume it wants to abort reads/writes.
	if time.Until(t) < 0 {
		c.abortReads.Store(true)
		c.abortWrites.Store(true)
		return c.Conn.SetDeadline(t)
	}

	c.abortReads.Store(false)
	c.abortWrites.Store(false)
	c.readSetAt = time.Now()
	c.writeSetAt = time.Now()
	return c.Conn.SetDeadline(t)
}

// SetReadDeadline sets the deadline for future Read calls
// and any currently-blocked Read call.
// A zero value for t means Read will not time out.
func (c *DeadlineConn) SetReadDeadline(t time.Time) error {
	if t.IsZero() && c.readDeadline != 0 {
		c.abortReads.Store(false)
		// Keep the deadline we want.
		return nil
	}

	c.mu.Lock()
	defer c.mu.Unlock()
	c.abortReads.Store(time.Until(t) < 0)
	c.readSetAt = time.Now()
	return c.Conn.SetReadDeadline(t)
}

// SetWriteDeadline sets the deadline for future Write calls
// and any currently-blocked Write call.
// Even if write times out, it may return n > 0, indicating that
// some of the data was successfully written.
// A zero value for t means Write will not time out.
func (c *DeadlineConn) SetWriteDeadline(t time.Time) error {
	if t.IsZero() && c.writeDeadline != 0 {
		c.abortWrites.Store(false)
		// Keep the deadline we want.
		return nil
	}
	c.mu.Lock()
	defer c.mu.Unlock()
	c.abortWrites.Store(time.Until(t) < 0)
	c.writeSetAt = time.Now()
	return c.Conn.SetWriteDeadline(t)
}

// Close wraps conn.Close and stops sending deadline updates.
func (c *DeadlineConn) Close() error {
	c.abortReads.Store(true)
	c.abortWrites.Store(true)
	return c.Conn.Close()
}

// WithReadDeadline sets a new read side net.Conn deadline.
func (c *DeadlineConn) WithReadDeadline(d time.Duration) *DeadlineConn {
	c.readDeadline = d
	return c
}

// WithWriteDeadline sets a new write side net.Conn deadline.
func (c *DeadlineConn) WithWriteDeadline(d time.Duration) *DeadlineConn {
	c.writeDeadline = d
	return c
}

// New - creates a new connection object wrapping net.Conn with deadlines.
func New(c net.Conn) *DeadlineConn {
	return &DeadlineConn{
		Conn: c,
	}
}