node.go

// Copyright 2013-2016 Aerospike, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package aerospike

import (
	"strconv"
	"strings"
	"sync"
	"time"

	. "github.com/aerospike/aerospike-client-go/logger"
	. "github.com/aerospike/aerospike-client-go/types"
	. "github.com/aerospike/aerospike-client-go/types/atomic"
)

const (
	_PARTITIONS  = 4096
	_FULL_HEALTH = 100
)

// Node represents an Aerospike Database Server Node
type Node struct {
	cluster *Cluster
	name    string
	host    *Host
	aliases []*Host
	address string

	connections     *AtomicQueue //ArrayBlockingQueue<*Connection>
	connectionCount *AtomicInt
	health          *AtomicInt //AtomicInteger

	partitionGeneration *AtomicInt
	refreshCount        *AtomicInt
	referenceCount      *AtomicInt
	responded           *AtomicBool
	useNewInfo          bool
	active              *AtomicBool
	mutex               sync.RWMutex

	supportsFloat, supportsBatchIndex, supportsReplicasAll, supportsGeo *AtomicBool
}

// NewNode initializes a server node with connection parameters.
func newNode(cluster *Cluster, nv *nodeValidator) *Node {
	return &Node{
		cluster:    cluster,
		name:       nv.name,
		aliases:    nv.aliases,
		address:    nv.address,
		useNewInfo: nv.useNewInfo,

		// Assign host to first IP alias because the server identifies nodes
		// by IP address (not hostname).
		host:                nv.aliases[0],
		connections:         NewAtomicQueue(cluster.clientPolicy.ConnectionQueueSize),
		connectionCount:     NewAtomicInt(0),
		health:              NewAtomicInt(_FULL_HEALTH),
		partitionGeneration: NewAtomicInt(-1),
		referenceCount:      NewAtomicInt(0),
		refreshCount:        NewAtomicInt(0),
		responded:           NewAtomicBool(false),
		active:              NewAtomicBool(true),

		supportsFloat:       NewAtomicBool(nv.supportsFloat),
		supportsBatchIndex:  NewAtomicBool(nv.supportsBatchIndex),
		supportsReplicasAll: NewAtomicBool(nv.supportsReplicasAll),
		supportsGeo:         NewAtomicBool(nv.supportsGeo),
	}
}

// Refresh requests current status from server node, and updates node with the result.
func (nd *Node) Refresh() ([]*Host, error) {
	var friends []*Host

	nd.refreshCount.IncrementAndGet()

	conn, err := nd.GetConnection(1 * time.Second)
	if err != nil {
		return nil, err
	}

	infoMap, err := RequestInfo(conn, "node", "partition-generation", "services")
	if err != nil {
		nd.InvalidateConnection(conn)
		nd.DecreaseHealth()
		return nil, err
	}

	if err := nd.verifyNodeName(infoMap); err != nil {
		nd.PutConnection(conn)
		return nil, err
	}
	nd.RestoreHealth()
	nd.responded.Set(true)

	if friends, err = nd.addFriends(infoMap); err != nil {
		nd.PutConnection(conn)
		return nil, err
	}

	if err := nd.updatePartitions(conn, infoMap); err != nil {
		nd.InvalidateConnection(conn)
		return nil, err
	}

	// Suppose there is a request peak, and we create lots of connections to
	// handle those requests. We want to keep those connections around while the
	// peak is taking place. When the peak is over, we hopefully will want to
	// close and those connections, and remove pressure from our side (the
	// client) and servers. Because the connection pool is a FIFO queue, if we
	// refresh the connection here, we may end up preventing lots of unused
	// connections from going idle, and therefore preventing them from being
	// closed. We should keep the number of connections to servers as low as
	// possible when there is no need for them. For that reason, we just put the
	// connection back into the pool without refreshing it.
	nd.PutConnection(conn)
	return friends, nil
}

func (nd *Node) verifyNodeName(infoMap map[string]string) error {
	infoName, exists := infoMap["node"]

	if !exists || len(infoName) == 0 {
		nd.DecreaseHealth()
		return NewAerospikeError(INVALID_NODE_ERROR, "Node name is empty")
	}

	if !(nd.name == infoName) {
		// Set node to inactive immediately.
		nd.active.Set(false)
		return NewAerospikeError(INVALID_NODE_ERROR, "Node name has changed. Old="+nd.name+" New="+infoName)
	}
	return nil
}

func (nd *Node) addFriends(infoMap map[string]string) ([]*Host, error) {
	friendString, exists := infoMap["services"]
	var friends []*Host

	if !exists || len(friendString) == 0 {
		return friends, nil
	}

	friendNames := strings.Split(friendString, ";")

	for _, friend := range friendNames {
		friendInfo := strings.Split(friend, ":")

		if len(friendInfo) != 2 {
			Logger.Error("Node info from asinfo:services is malformed. Expected HOST:PORT, but got `%s`", friend)
			continue
		}

		host := friendInfo[0]
		port, _ := strconv.Atoi(friendInfo[1])
		alias := NewHost(host, port)

		if nd.cluster.clientPolicy.IpMap != nil {
			if alternativeHost, ok := nd.cluster.clientPolicy.IpMap[host]; ok {
				alias = NewHost(alternativeHost, port)
			}
		}

		node := nd.cluster.findAlias(alias)

		if node != nil {
			node.referenceCount.IncrementAndGet()
		} else {
			if !nd.findAlias(friends, alias) {
				if friends == nil {
					friends = make([]*Host, 0, 16)
				}

				friends = append(friends, alias)
			}
		}
	}

	return friends, nil
}

func (nd *Node) findAlias(friends []*Host, alias *Host) bool {
	for _, host := range friends {
		if *host == *alias {
			return true
		}
	}
	return false
}

func (nd *Node) updatePartitions(conn *Connection, infoMap map[string]string) error {
	genString, exists := infoMap["partition-generation"]

	if !exists || len(genString) == 0 {
		return NewAerospikeError(PARSE_ERROR, "partition-generation is empty")
	}

	generation, _ := strconv.Atoi(genString)

	if nd.partitionGeneration.Get() != generation {
		Logger.Info("Node %s partition generation %d changed", nd.GetName(), generation)
		if err := nd.cluster.updatePartitions(conn, nd); err != nil {
			return err
		}
		nd.partitionGeneration.Set(generation)
	}

	return nil
}

// GetConnection gets a connection to the node.
// If no pooled connection is available, a new connection will be created.
func (nd *Node) GetConnection(timeout time.Duration) (conn *Connection, err error) {
	tBegin := time.Now()
	pollTries := 0
L:
	for timeout == 0 || time.Now().Sub(tBegin) <= timeout {
		if t := nd.connections.Poll(); t != nil {
			conn = t.(*Connection)
			if conn.IsConnected() && !conn.isIdle() {
				if err := conn.SetTimeout(timeout); err == nil {
					return conn, nil
				}
			}
			nd.InvalidateConnection(conn)
		}

		// if connection count is limited and enough connections are already created, don't create a new one
		if nd.cluster.clientPolicy.LimitConnectionsToQueueSize && nd.connectionCount.Get() >= nd.cluster.clientPolicy.ConnectionQueueSize {
			// will avoid an infinite loop
			if timeout != 0 || pollTries < 10 {
				// 10 reteies, each waits for 100us for a total of 1 milliseconds
				time.Sleep(time.Microsecond * 100)
				pollTries++
				continue
			}
			break L
		}

		if conn, err = NewConnection(nd.address, nd.cluster.clientPolicy.Timeout); err != nil {
			return nil, err
		}

		// need to authenticate
		if err = conn.Authenticate(nd.cluster.user, nd.cluster.Password()); err != nil {
			// Socket not authenticated. Do not put back into pool.
			conn.Close()

			return nil, err
		}

		if err = conn.SetTimeout(timeout); err != nil {
			// Socket not authenticated. Do not put back into pool.
			conn.Close()
			return nil, err
		}

		conn.setIdleTimeout(nd.cluster.clientPolicy.IdleTimeout)
		conn.refresh()

		nd.connectionCount.IncrementAndGet()
		return conn, nil
	}
	return nil, NewAerospikeError(NO_AVAILABLE_CONNECTIONS_TO_NODE)
}

// PutConnection puts back a connection to the pool.
// If connection pool is full, the connection will be
// closed and discarded.
func (nd *Node) PutConnection(conn *Connection) {
	conn.refresh()
	if !nd.active.Get() || !nd.connections.Offer(conn) {
		nd.InvalidateConnection(conn)
	}
}

// InvalidateConnection closes and discards a connection from the pool.
func (nd *Node) InvalidateConnection(conn *Connection) {
	nd.connectionCount.DecrementAndGet()
	conn.Close()
}

// RestoreHealth marks the node as healthy.
func (nd *Node) RestoreHealth() {
	// There can be cases where health is full, but active is false.
	// Once a node has been marked inactive, it stays inactive.
	nd.health.Set(_FULL_HEALTH)
}

// DecreaseHealth decreases node Health as a result of bad connection or communication.
func (nd *Node) DecreaseHealth() {
	nd.health.DecrementAndGet()
}

// IsUnhealthy checks if the node is unhealthy.
func (nd *Node) IsUnhealthy() bool {
	return nd.health.Get() <= 0
}

// GetHost retrieves host for the node.
func (nd *Node) GetHost() *Host {
	return nd.host
}

// IsActive Checks if the node is active.
func (nd *Node) IsActive() bool {
	return nd.active.Get()
}

// GetName returns node name.
func (nd *Node) GetName() string {
	return nd.name
}

// GetAliases returnss node aliases.
func (nd *Node) GetAliases() []*Host {
	nd.mutex.RLock()
	aliases := nd.aliases
	nd.mutex.RUnlock()

	return aliases
}

// Sets node aliases
func (nd *Node) setAliases(aliases []*Host) {
	nd.mutex.Lock()
	nd.aliases = aliases
	nd.mutex.Unlock()
}

// AddAlias adds an alias for the node
func (nd *Node) AddAlias(aliasToAdd *Host) {
	// Aliases are only referenced in the cluster tend goroutine,
	// so synchronization is not necessary.
	aliases := nd.GetAliases()
	if aliases == nil {
		aliases = []*Host{}
	}

	aliases = append(aliases, aliasToAdd)
	nd.setAliases(aliases)
}

// Close marks node as inactice and closes all of its pooled connections.
func (nd *Node) Close() {
	nd.active.Set(false)
	nd.closeConnections()
}

// String implements stringer interface
func (nd *Node) String() string {
	return nd.name + " " + nd.host.String()
}

func (nd *Node) closeConnections() {
	for conn := nd.connections.Poll(); conn != nil; conn = nd.connections.Poll() {
		conn.(*Connection).Close()
	}
}

// Equals compares equality of two nodes based on their names.
func (nd *Node) Equals(other *Node) bool {
	return nd.name == other.name
}

// MigrationInProgress determines if the node is participating in a data migration
func (nd *Node) MigrationInProgress() (bool, error) {
	values, err := RequestNodeStats(nd)
	if err != nil {
		return false, err
	}

	// if the migration_progress_send exists and is not `0`, then migration is in progress
	if migration, exists := values["migrate_progress_send"]; exists && migration != "0" {
		return true, nil
	}

	// migration not in progress
	return false, nil
}

// WaitUntillMigrationIsFinished will block until migration operations are finished.
func (nd *Node) WaitUntillMigrationIsFinished(timeout time.Duration) (err error) {
	if timeout <= 0 {
		timeout = _NO_TIMEOUT
	}
	done := make(chan error)

	go func() {
		// this function is guaranteed to return after timeout
		// no go routines will be leaked
		for {
			if res, err := nd.MigrationInProgress(); err != nil || !res {
				done <- err
				return
			}
		}
	}()

	dealine := time.After(timeout)
	select {
	case <-dealine:
		return NewAerospikeError(TIMEOUT)
	case err = <-done:
		return err
	}
}