gotgt/pkg/port/iscsit/conn.go

/*
Copyright 2016 The GoStor Authors All rights reserved.

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 iscsit

import (
	"io"
	"net"
	"sort"
	"sync"

	"github.com/gostor/gotgt/pkg/api"
	"github.com/gostor/gotgt/pkg/util"
)

const (
	CONN_STATE_FREE           = 0
	CONN_STATE_SECURITY       = 1
	CONN_STATE_SECURITY_AUTH  = 2
	CONN_STATE_SECURITY_DONE  = 3
	CONN_STATE_SECURITY_LOGIN = 4
	CONN_STATE_SECURITY_FULL  = 5
	CONN_STATE_LOGIN          = 6
	CONN_STATE_LOGIN_FULL     = 7
	CONN_STATE_FULL           = 8
	CONN_STATE_KERNEL         = 9
	CONN_STATE_CLOSE          = 10
	CONN_STATE_EXIT           = 11
	CONN_STATE_SCSI           = 12
	CONN_STATE_INIT           = 13
	CONN_STATE_START          = 14
	CONN_STATE_READY          = 15
)

var (
	DATAIN  byte = 0x01
	DATAOUT byte = 0x10
)

type iscsiConnection struct {
	state     int
	authState int
	session   *ISCSISession
	tid       int
	cid       uint16
	rxIOState int
	txIOState int
	refcount  int
	conn      net.Conn

	rxBuffer []byte
	txBuffer []byte
	req      *ISCSICommand
	resp     *ISCSICommand

	loginParam *iscsiLoginParam

	// StatSN - the status sequence number on this connection
	statSN uint32
	// ExpStatSN - the expected status sequence number on this connection
	expStatSN uint32
	// CmdSN - the command sequence number at the target
	cmdSN uint32
	// ExpCmdSN - the next expected command sequence number at the target
	expCmdSN uint32
	// MaxCmdSN - the maximum CmdSN acceptable at the target from this initiator
	maxCmdSN                 uint32
	maxRecvDataSegmentLength uint32
	maxBurstLength           uint32
	maxSeqCount              uint32

	rxTask *iscsiTask
	txTask *iscsiTask

	readLock *sync.RWMutex
}

type taskState int

const (
	taskPending taskState = 0
	taskSCSI    taskState = 1
)

type iscsiTask struct {
	tag   uint32
	conn  *iscsiConnection
	cmd   *ISCSICommand
	scmd  *api.SCSICommand
	state taskState

	offset     int
	r2tCount   int
	unsolCount int
	expR2TSN   int

	r2tSN uint32
}

func (c *iscsiConnection) init() {
	c.state = CONN_STATE_FREE
	c.refcount = 1
	c.readLock = new(sync.RWMutex)
	c.loginParam.sessionParam = []ISCSISessionParam{}
	c.loginParam.tgtCSG = LoginOperationalNegotiation
	c.loginParam.tgtNSG = LoginOperationalNegotiation
	for _, param := range sessionKeys {
		c.loginParam.sessionParam = append(c.loginParam.sessionParam,
			ISCSISessionParam{idx: param.idx, Value: param.def})
	}
	sort.Sort(c.loginParam.sessionParam)
}

func (c *iscsiConnection) readData(size int) ([]byte, int, error) {
	var buf = make([]byte, size)
	length, err := io.ReadFull(c.conn, buf)
	if err != nil {
		return nil, -1, err
	}
	return buf, length, nil
}

func (c *iscsiConnection) write(resp []byte) (int, error) {
	return c.conn.Write(resp)
}

func (c *iscsiConnection) close() {
	c.conn.Close()
}

func (conn *iscsiConnection) ReInstatement(newConn *iscsiConnection) {
	conn.close()
	conn.conn = newConn.conn
}

func (conn *iscsiConnection) buildRespPackage(oc OpCode) error {
	conn.txTask = &iscsiTask{conn: conn, cmd: conn.req, tag: conn.req.TaskTag, scmd: &api.SCSICommand{}}
	conn.txIOState = IOSTATE_TX_BHS
	conn.statSN += 1
	task := conn.rxTask
	resp := &ISCSICommand{
		StatSN:   conn.req.ExpStatSN,
		TaskTag:  conn.req.TaskTag,
		ExpCmdSN: conn.session.ExpCmdSN,
		MaxCmdSN: conn.session.ExpCmdSN + conn.session.MaxQueueCommand,
	}
	switch oc {
	case OpReady:
		resp.OpCode = OpReady
		resp.R2TSN = task.r2tSN
		resp.BufferOffset = uint32(task.offset)
		resp.DesiredLength = uint32(task.r2tCount)
		if val := conn.loginParam.sessionParam[ISCSI_PARAM_MAX_BURST].Value; task.r2tCount > int(val) {
			resp.DesiredLength = uint32(val)
		}
	case OpSCSIIn, OpSCSIResp:
		resp.OpCode = oc
		resp.Immediate = true
		resp.Final = true
		resp.SCSIResponse = 0x00
		resp.HasStatus = true
		scmd := task.scmd
		resp.Status = scmd.Result
		if scmd.Direction == api.SCSIDataRead || scmd.Direction == api.SCSIDataWrite {
			if scmd.InSDBBuffer.Buffer != nil {
				buf := scmd.InSDBBuffer.Buffer.Bytes()
				resp.RawData = buf
			} else {
				resp.RawData = []byte{}
			}
		}
		if scmd.Result != 0 && scmd.SenseBuffer != nil {
			resp.RawData = scmd.SenseBuffer.Bytes()
		}
	case OpNoopIn, OpSCSITaskResp, OpReject:
		resp.OpCode = oc
		resp.Final = true
		resp.NSG = FullFeaturePhase
		resp.ExpCmdSN = conn.req.CmdSN + 1
	case OpLoginResp:
		resp.OpCode = OpLoginResp
		resp.Transit = conn.loginParam.tgtTrans
		resp.CSG = conn.req.CSG
		resp.NSG = conn.loginParam.tgtNSG
		resp.ExpCmdSN = conn.req.CmdSN
		resp.MaxCmdSN = conn.req.CmdSN
		negoKeys, err := conn.processLoginData()
		if err != nil {
			return err
		}
		if !conn.loginParam.keyDeclared {
			negoKeys = loginKVDeclare(conn, negoKeys)
			conn.loginParam.keyDeclared = true
		}
		resp.RawData = util.MarshalKVText(negoKeys)
		conn.txTask = nil
	}

	conn.resp = resp
	return nil
}