decode.go

/*
 * Copyright (c) 2012-2014 Dave Collins <dave@davec.name>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package xdr

import (
	"fmt"
	"io"
	"math"
	"reflect"
	"strconv"
	"time"
)

const maxInt32 = math.MaxInt32

var errMaxSlice = "data exceeds max slice limit"
var errIODecode = "%s while decoding %d bytes"

// DecodeDefaultMaxDepth is the default maximum decoding depth
const DecodeDefaultMaxDepth = 200

// DecodeOptions configures how Decoding is done.
type DecodeOptions struct {
	// MaxDepth is the maximum decoding depth (i.e. maximum nesting of data structures).
	// It prevents infinite recursions in cyclic datastructures and determines the maximum callstack growth.
	// If set to 0, DecodeDefaultMaxDepth will be used.
	MaxDepth uint

	// MaxInputLen sets the maximum input size. It is used by the decoder to sanity-check
	// allocation sizes and avoid heap explosions from doctored inputs.
	//
	// If set to 0, the decoder will try to figure out the input size by checking whether
	// the provided io.Reader implements Len() (e.g. strings.Reader, bytes.Reader and bytes.Buffer do).
	// Otherwise, no sanity checks will be done.
	MaxInputLen int
}

// DefaultDecodeOptions are the default decoding options.
var DefaultDecodeOptions = DecodeOptions{
	MaxDepth:    DecodeDefaultMaxDepth,
	MaxInputLen: 0,
}

/*
Unmarshal parses XDR-encoded data into the value pointed to by v reading from
reader r and returning the total number of bytes read.  An addressable pointer
must be provided since Unmarshal needs to both store the result of the decode as
well as obtain target type information.  Unmarhsal traverses v recursively and
automatically indirects pointers through arbitrary depth, allocating them as
necessary, to decode the data into the underlying value pointed to.

Unmarshal uses reflection to determine the type of the concrete value contained
by v and performs a mapping of underlying XDR types to Go types as follows:

	Go Type <- XDR Type
	--------------------
	int8, int16, int32, int <- XDR Integer
	uint8, uint16, uint32, uint <- XDR Unsigned Integer
	int64 <- XDR Hyper Integer
	uint64 <- XDR Unsigned Hyper Integer
	bool <- XDR Boolean
	float32 <- XDR Floating-Point
	float64 <- XDR Double-Precision Floating-Point
	string <- XDR String
	byte <- XDR Integer
	[]byte <- XDR Variable-Length Opaque Data
	[#]byte <- XDR Fixed-Length Opaque Data
	[]<type> <- XDR Variable-Length Array
	[#]<type> <- XDR Fixed-Length Array
	struct <- XDR Structure
	map <- XDR Variable-Length Array of two-element XDR Structures
	time.Time <- XDR String encoded with RFC3339 nanosecond precision

Notes and Limitations:

  - Automatic unmarshalling of variable and fixed-length arrays of uint8s
    requires a special struct tag xdropaque:"false" since byte slices
    and byte arrays are assumed to be opaque data and byte is a Go alias
    for uint8 thus indistinguishable under reflection
  - Cyclic data structures are not supported and will result in ErrMaxDecodingDepth errors

If any issues are encountered during the unmarshalling process, an
UnmarshalError is returned with a human readable description as well as
an ErrorCode value for further inspection from sophisticated callers.  Some
potential issues are unsupported Go types, attempting to decode a value which is
too large to fit into a specified Go type, and exceeding max slice limitations.
*/
func Unmarshal(r io.Reader, v interface{}) (int, error) {
	d := NewDecoder(r)
	return d.Decode(v)
}

// UnmarshalWithOptions works like Unmarshal but accepts decoding options.
func UnmarshalWithOptions(r io.Reader, v interface{}, options DecodeOptions) (int, error) {
	d := NewDecoderWithOptions(r, options)
	return d.Decode(v)
}

type lenLeft interface {
	Len() int
}

// A Decoder wraps an io.Reader that is expected to provide an XDR-encoded byte
// stream and provides several exposed methods to manually decode various XDR
// primitives without relying on reflection.  The NewDecoder function can be
// used to get a new Decoder directly.
//
// Typically, Unmarshal should be used instead of manual decoding.  A Decoder
// is exposed, so it is possible to perform manual decoding should it be
// necessary in complex scenarios where automatic reflection-based decoding
// won't work.
type Decoder struct {
	// used to minimize heap allocations during decoding
	scratchBuf [8]byte
	r          io.Reader
	l          lenLeft
	maxDepth   uint
}

// readerLenWrapper wraps a reader an initial length and provides a Len() method indicating
// how much input is left
type readerLenWrapper struct {
	inner      io.Reader
	readCount  int
	initialLen int
}

func (l *readerLenWrapper) Len() int {
	return l.initialLen - l.readCount
}

func (l *readerLenWrapper) Read(p []byte) (int, error) {
	n, err := l.inner.Read(p)
	if n > 0 {
		l.readCount += n
	}
	return n, err
}

// NewDecoder returns a Decoder that can be used to manually decode XDR data
// from a provided reader. Typically, Unmarshal should be used instead of
// manually creating a Decoder.
func NewDecoder(r io.Reader) *Decoder {
	return NewDecoderWithOptions(r, DefaultDecodeOptions)
}

// NewDecoderWithOptions works like NewDecoder but allows supplying decoding options.
func NewDecoderWithOptions(r io.Reader, options DecodeOptions) *Decoder {
	maxDepth := options.MaxDepth
	if maxDepth < 1 {
		maxDepth = DecodeDefaultMaxDepth
	}
	if l, ok := r.(lenLeft); ok {
		return &Decoder{r: r, l: l, maxDepth: maxDepth}
	}
	if options.MaxInputLen > 0 {
		rlw := &readerLenWrapper{
			inner:      r,
			initialLen: options.MaxInputLen,
		}
		return &Decoder{r: rlw, l: rlw, maxDepth: maxDepth}
	}
	return &Decoder{r: r, l: nil, maxDepth: options.MaxDepth}
}

// DecodeInt treats the next 4 bytes as an XDR encoded integer and returns the
// result as an int32 along with the number of bytes actually read.
//
// An UnmarshalError is returned if there are insufficient bytes remaining.
//
// Reference:
//
//	RFC Section 4.1 - Integer
//	32-bit big-endian signed integer in range [-2147483648, 2147483647]
func (d *Decoder) DecodeInt() (int32, int, error) {
	n, err := io.ReadFull(d.r, d.scratchBuf[:4])
	if err != nil {
		msg := fmt.Sprintf(errIODecode, err.Error(), 4)
		err := unmarshalError("DecodeInt", ErrIO, msg, d.scratchBuf[:n], err)
		return 0, n, err
	}

	rv := int32(d.scratchBuf[3]) | int32(d.scratchBuf[2])<<8 |
		int32(d.scratchBuf[1])<<16 | int32(d.scratchBuf[0])<<24
	return rv, n, nil
}

// DecodeUint treats the next 4 bytes as an XDR encoded unsigned integer and
// returns the result as a uint32 along with the number of bytes actually read.
//
// An UnmarshalError is returned if there are insufficient bytes remaining.
//
// Reference:
//
//	RFC Section 4.2 - Unsigned Integer
//	32-bit big-endian unsigned integer in range [0, 4294967295]
func (d *Decoder) DecodeUint() (uint32, int, error) {
	n, err := io.ReadFull(d.r, d.scratchBuf[:4])
	if err != nil {
		msg := fmt.Sprintf(errIODecode, err.Error(), 4)
		err := unmarshalError("DecodeUint", ErrIO, msg, d.scratchBuf[:n], err)
		return 0, n, err
	}

	rv := uint32(d.scratchBuf[3]) | uint32(d.scratchBuf[2])<<8 |
		uint32(d.scratchBuf[1])<<16 | uint32(d.scratchBuf[0])<<24
	return rv, n, nil
}

// DecodeEnum treats the next 4 bytes as an XDR encoded enumeration value and
// returns the result as an int32 after verifying that the value is in the
// provided map of valid values.   It also returns the number of bytes actually
// read.
//
// An UnmarshalError is returned if there are insufficient bytes remaining or
// the parsed enumeration value is not one of the provided valid values.
//
// Reference:
//
//	RFC Section 4.3 - Enumeration
//	Represented as an XDR encoded signed integer
func (d *Decoder) DecodeEnum(validEnums map[int32]bool) (int32, int, error) {
	val, n, err := d.DecodeInt()
	if err != nil {
		return 0, n, err
	}

	if !validEnums[val] {
		err := unmarshalError("DecodeEnum", ErrBadEnumValue,
			"invalid enum", val, nil)
		return 0, n, err
	}
	return val, n, nil
}

// DecodeBool treats the next 4 bytes as an XDR encoded boolean value and
// returns the result as a bool along with the number of bytes actually read.
//
// An UnmarshalError is returned if there are insufficient bytes remaining or
// the parsed value is not a 0 or 1.
//
// Reference:
//
//	RFC Section 4.4 - Boolean
//	Represented as an XDR encoded enumeration where 0 is false and 1 is true
func (d *Decoder) DecodeBool() (bool, int, error) {
	val, n, err := d.DecodeInt()
	if err != nil {
		return false, n, err
	}
	switch val {
	case 0:
		return false, n, nil
	case 1:
		return true, n, nil
	}

	err = unmarshalError("DecodeBool", ErrBadEnumValue, "bool not 0 or 1",
		val, nil)
	return false, n, err
}

// DecodeHyper treats the next 8 bytes as an XDR encoded hyper value and
// returns the result as an int64  along with the number of bytes actually read.
//
// An UnmarshalError is returned if there are insufficient bytes remaining.
//
// Reference:
//
//	RFC Section 4.5 - Hyper Integer
//	64-bit big-endian signed integer in range [-9223372036854775808, 9223372036854775807]
func (d *Decoder) DecodeHyper() (int64, int, error) {
	n, err := io.ReadFull(d.r, d.scratchBuf[:8])
	if err != nil {
		msg := fmt.Sprintf(errIODecode, err.Error(), 8)
		err := unmarshalError("DecodeHyper", ErrIO, msg, d.scratchBuf[:n], err)
		return 0, n, err
	}

	rv := int64(d.scratchBuf[7]) | int64(d.scratchBuf[6])<<8 |
		int64(d.scratchBuf[5])<<16 | int64(d.scratchBuf[4])<<24 |
		int64(d.scratchBuf[3])<<32 | int64(d.scratchBuf[2])<<40 |
		int64(d.scratchBuf[1])<<48 | int64(d.scratchBuf[0])<<56
	return rv, n, err
}

// DecodeUhyper treats the next 8  bytes as an XDR encoded unsigned hyper value
// and returns the result as a uint64  along with the number of bytes actually
// read.
//
// An UnmarshalError is returned if there are insufficient bytes remaining.
//
// Reference:
//
//	RFC Section 4.5 - Unsigned Hyper Integer
//	64-bit big-endian unsigned integer in range [0, 18446744073709551615]
func (d *Decoder) DecodeUhyper() (uint64, int, error) {
	n, err := io.ReadFull(d.r, d.scratchBuf[:8])
	if err != nil {
		msg := fmt.Sprintf(errIODecode, err.Error(), 8)
		err := unmarshalError("DecodeUhyper", ErrIO, msg, d.scratchBuf[:n], err)
		return 0, n, err
	}

	rv := uint64(d.scratchBuf[7]) | uint64(d.scratchBuf[6])<<8 |
		uint64(d.scratchBuf[5])<<16 | uint64(d.scratchBuf[4])<<24 |
		uint64(d.scratchBuf[3])<<32 | uint64(d.scratchBuf[2])<<40 |
		uint64(d.scratchBuf[1])<<48 | uint64(d.scratchBuf[0])<<56
	return rv, n, nil
}

// DecodeFloat treats the next 4 bytes as an XDR encoded floating point and
// returns the result as a float32 along with the number of bytes actually read.
//
// An UnmarshalError is returned if there are insufficient bytes remaining.
//
// Reference:
//
//	RFC Section 4.6 - Floating Point
//	32-bit single-precision IEEE 754 floating point
func (d *Decoder) DecodeFloat() (float32, int, error) {
	n, err := io.ReadFull(d.r, d.scratchBuf[:4])
	if err != nil {
		msg := fmt.Sprintf(errIODecode, err.Error(), 4)
		err := unmarshalError("DecodeFloat", ErrIO, msg, d.scratchBuf[:n], err)
		return 0, n, err
	}

	val := uint32(d.scratchBuf[3]) | uint32(d.scratchBuf[2])<<8 |
		uint32(d.scratchBuf[1])<<16 | uint32(d.scratchBuf[0])<<24
	return math.Float32frombits(val), n, nil
}

// DecodeDouble treats the next 8 bytes as an XDR encoded double-precision
// floating point and returns the result as a float64 along with the number of
// bytes actually read.
//
// An UnmarshalError is returned if there are insufficient bytes remaining.
//
// Reference:
//
//	RFC Section 4.7 -  Double-Precision Floating Point
//	64-bit double-precision IEEE 754 floating point
func (d *Decoder) DecodeDouble() (float64, int, error) {
	n, err := io.ReadFull(d.r, d.scratchBuf[:8])
	if err != nil {
		msg := fmt.Sprintf(errIODecode, err.Error(), 8)
		err := unmarshalError("DecodeDouble", ErrIO, msg, d.scratchBuf[:n], err)
		return 0, n, err
	}

	val := uint64(d.scratchBuf[7]) | uint64(d.scratchBuf[6])<<8 |
		uint64(d.scratchBuf[5])<<16 | uint64(d.scratchBuf[4])<<24 |
		uint64(d.scratchBuf[3])<<32 | uint64(d.scratchBuf[2])<<40 |
		uint64(d.scratchBuf[1])<<48 | uint64(d.scratchBuf[0])<<56
	return math.Float64frombits(val), n, nil
}

// RFC Section 4.8 -  Quadruple-Precision Floating Point
// 128-bit quadruple-precision floating point
// Not Implemented

// DecodeFixedOpaque treats the next 'size' bytes as XDR encoded opaque data and
// returns the result as a byte slice along with the number of bytes actually
// read.
//
// An UnmarshalError is returned if there are insufficient bytes remaining to
// satisfy the passed size, including the necessary padding to make it a
// multiple of 4.
//
// Reference:
//
//	RFC Section 4.9 - Fixed-Length Opaque Data
//	Fixed-length uninterpreted data zero-padded to a multiple of four
func (d *Decoder) DecodeFixedOpaque(size int32) ([]byte, int, error) {
	out := make([]byte, size)
	n, err := d.DecodeFixedOpaqueInplace(out)
	if err != nil {
		return nil, n, err
	}
	return out, n, nil
}

// DecodeFixedOpaqueInplace is an in-place version of DecodeFixedOpaque.
// It improves performance when the destination is pre-allocated (which avoids
// internally allocating an extra slice and does not require further copying)
func (d *Decoder) DecodeFixedOpaqueInplace(out []byte) (int, error) {
	size := len(out)
	// Nothing to do if size is 0.
	if size == 0 {
		return 0, nil
	}

	pad := (4 - (size % 4)) % 4
	paddedSize := size + pad
	if uint(paddedSize) > uint(maxInt32) {
		err := unmarshalError("DecodeFixedOpaqueInplace", ErrOverflow,
			errMaxSlice, paddedSize, nil)
		return 0, err
	}

	n, err := io.ReadFull(d.r, out)
	if err != nil {
		msg := fmt.Sprintf(errIODecode, err.Error(), size)
		err := unmarshalError("DecodeFixedOpaqueInplace", ErrIO, msg, out[:n],
			err)
		return n, err
	}

	if pad > 0 {
		// the maximum value of pad is 3, so the scratch buffer should be enough
		_ = d.scratchBuf[2]
		padding := d.scratchBuf[:pad]
		n2, err := io.ReadFull(d.r, padding)
		if err != nil {
			msg := fmt.Sprintf(errIODecode, err.Error(), pad)
			err := unmarshalError("DecodeFixedOpaqueInplace", ErrIO, msg, out[:n],
				err)
			return n, err
		}
		n += n2
		// check all the padding bytes to be zero
		for _, p := range padding {
			if p != 0x00 {
				msg := "non-zero padding"
				err := unmarshalError("DecodeFixedOpaqueInplace", ErrIO, msg, padding[:n2], nil)
				return n, err
			}
		}
	}

	return n, nil
}

// DecodeOpaque treats the next bytes as variable length XDR encoded opaque
// data and returns the result as a byte slice along with the number of bytes
// actually read.
//
// An UnmarshalError is returned if there are insufficient bytes remaining or
// the opaque data is larger than the max length of a Go slice.
//
// Reference:
//
//	RFC Section 4.10 - Variable-Length Opaque Data
//	Unsigned integer length followed by fixed opaque data of that length
func (d *Decoder) DecodeOpaque(maxSize int) ([]byte, int, error) {
	dataLen, n, err := d.DecodeUint()
	if err != nil {
		return nil, n, err
	}

	maxSize = d.mergeInputLenAndMaxSize(maxSize)
	if maxSize == 0 {
		maxSize = maxInt32
	}

	if uint(dataLen) > uint(maxSize) {
		err := unmarshalError("DecodeOpaque", ErrOverflow, errMaxSlice,
			dataLen, nil)
		return nil, n, err
	}

	rv, n2, err := d.DecodeFixedOpaque(int32(dataLen))
	n += n2
	if err != nil {
		return nil, n, err
	}
	return rv, n, nil
}

// DecodeString treats the next bytes as a variable length XDR encoded string
// and returns the result as a string along with the number of bytes actually
// read.  Character encoding is assumed to be UTF-8 and therefore ASCII
// compatible.  If the underlying character encoding is not compatibile with
// this assumption, the data can instead be read as variable-length opaque data
// (DecodeOpaque) and manually converted as needed.
//
// An UnmarshalError is returned if there are insufficient bytes remaining or
// the string data is larger than the max length of a Go slice.
//
// Reference:
//
//	RFC Section 4.11 - String
//	Unsigned integer length followed by bytes zero-padded to a multiple of
//	four
func (d *Decoder) DecodeString(maxSize int) (string, int, error) {
	dataLen, n, err := d.DecodeUint()
	if err != nil {
		return "", n, err
	}

	maxSize = d.mergeInputLenAndMaxSize(maxSize)
	if maxSize == 0 {
		maxSize = maxInt32
	}

	if uint(dataLen) > uint(maxSize) {
		err = unmarshalError("DecodeString", ErrOverflow, errMaxSlice,
			dataLen, nil)
		return "", n, err
	}

	opaque, n2, err := d.DecodeFixedOpaque(int32(dataLen))
	n += n2
	if err != nil {
		return "", n, err
	}
	return string(opaque), n, nil
}

// decodeFixedArray treats the next bytes as a series of XDR encoded elements
// of the same type as the array represented by the reflection value and decodes
// each element into the passed array.  The ignoreOpaque flag controls whether
// or not uint8 (byte) elements should be decoded individually or as a fixed
// sequence of opaque data.  It returns the  the number of bytes actually read.
//
// An UnmarshalError is returned if any issues are encountered while decoding
// the array elements.
//
// Reference:
//
//	RFC Section 4.12 - Fixed-Length Array
//	Individually XDR encoded array elements
func (d *Decoder) decodeFixedArray(v reflect.Value, ignoreOpaque bool, maxDepth uint) (int, error) {
	// Treat [#]byte (byte is alias for uint8) as opaque data unless
	// ignored.
	if !ignoreOpaque && v.Type().Elem().Kind() == reflect.Uint8 {
		dest := v.Slice(0, v.Len()).Bytes()
		return d.DecodeFixedOpaqueInplace(dest)
	}

	// Decode each array element.
	var n int
	for i := 0; i < v.Len(); i++ {
		n2, err := d.decode(v.Index(i), 0, maxDepth)
		n += n2
		if err != nil {
			return n, err
		}
	}
	return n, nil
}

// decodeArray treats the next bytes as a variable length series of XDR encoded
// elements of the same type as the array represented by the reflection value.
// The number of elements is obtained by first decoding the unsigned integer
// element count.  Then each element is decoded into the passed array. The
// ignoreOpaque flag controls whether uint8 (byte) elements should be
// decoded individually or as a variable sequence of opaque data.  It returns
// the number of bytes actually read.
//
// An UnmarshalError is returned if any issues are encountered while decoding
// the array elements.
//
// Reference:
//
//	RFC Section 4.13 - Variable-Length Array
//	Unsigned integer length followed by individually XDR encoded array
//	elements
func (d *Decoder) decodeArray(v reflect.Value, ignoreOpaque bool, maxSize int, maxDepth uint) (int, error) {
	dataLen, n, err := d.DecodeUint()
	if err != nil {
		return n, err
	}

	maxSize = d.mergeInputLenAndMaxSize(maxSize)
	if maxSize == 0 {
		maxSize = maxInt32
	}

	if uint(dataLen) > uint(maxSize) {
		err := unmarshalError("decodeArray", ErrOverflow, errMaxSlice,
			dataLen, nil)
		return n, err
	}

	// Allocate storage for the slice elements (the underlying array) if
	// existing slice does not have enough capacity.
	sliceLen := int(dataLen)
	if v.Cap() < sliceLen {
		v.Set(reflect.MakeSlice(v.Type(), sliceLen, sliceLen))
	}
	v.SetLen(sliceLen)

	// Treat []byte (byte is alias for uint8) as opaque data unless ignored.
	if !ignoreOpaque && v.Type().Elem().Kind() == reflect.Uint8 {
		data, n2, err := d.DecodeFixedOpaque(int32(sliceLen))
		n += n2
		if err != nil {
			return n, err
		}
		v.SetBytes(data)
		return n, nil
	}

	// Decode each slice element.
	for i := 0; i < sliceLen; i++ {
		n2, err := d.decode(v.Index(i), 0, maxDepth)
		n += n2
		if err != nil {
			return n, err
		}
	}
	return n, nil
}

func setUnionArmsToNil(v reflect.Value) {
	for i := 0; i < v.NumField(); i++ {
		f := v.Field(i)
		if f.Kind() != reflect.Ptr {
			continue
		}
		v.Set(reflect.Zero(v.Type()))
	}
}

// decodeUnion
func (d *Decoder) decodeUnion(v reflect.Value, maxDepth uint) (int, error) {
	// we should have already checked that v is a union
	// prior to this call, so we panic if v is not a union
	u := v.Interface().(Union)

	setUnionArmsToNil(v)

	i, n, err := d.DecodeInt()
	if err != nil {
		return n, err
	}

	vs := v.FieldByName(u.SwitchFieldName())

	// ensure the switch field is a valid enum value for the union, if possible
	enum, ok := vs.Interface().(Enum)

	if ok && !enum.ValidEnum(i) {
		msg := fmt.Sprintf("switch '%d' is not valid enum value for union", i)
		err := unmarshalError("decode", ErrBadUnionSwitch, msg, nil, nil)
		return n, err
	}

	kind := vs.Kind()
	if kind == reflect.Uint || kind == reflect.Uint8 || kind == reflect.Uint16 ||
		kind == reflect.Uint32 || kind == reflect.Uint64 {
		vs.SetUint(uint64(i))
	} else {
		vs.SetInt(int64(i))
	}

	arm, ok := u.ArmForSwitch(i)

	if !ok {
		msg := fmt.Sprintf("switch '%d' is not valid for union", i)
		err := unmarshalError("decode", ErrBadUnionSwitch, msg, nil, nil)
		return n, err
	}

	if arm == "" {
		return n, nil
	}

	vv := v.FieldByName(arm)

	vvet := vv.Type().Elem()
	vv.Set(reflect.New(vvet))

	field, ok := v.Type().FieldByName(arm)
	if !ok {
		msg := fmt.Sprintf("switch '%s' is not valid for union", arm)
		err := unmarshalError("decode", ErrBadUnionSwitch, msg, nil, nil)
		return n, err
	}

	maxSize := 0
	sizeTag := field.Tag.Get("xdrmaxsize")
	if sizeTag != "" {
		sz, err := strconv.ParseInt(sizeTag, 10, 32)
		if err != nil {
			return n, err
		}
		maxSize = int(sz)
	}

	n2, err := d.decode(vv.Elem(), maxSize, maxDepth)
	n += n2

	if err != nil {
		return n, err
	}
	return n, nil
}

// decodeStruct treats the next bytes as a series of XDR encoded elements
// of the same type as the exported fields of the struct represented by the
// passed reflection value. Pointers are automatically indirected and
// allocated as necessary. It returns the number of bytes actually read.
//
// An UnmarshalError is returned if any issues are encountered while decoding
// the elements.
//
// Reference:
//
//	RFC Section 4.14 - Structure
//	XDR encoded elements in the order of their declaration in the struct
func (d *Decoder) decodeStruct(v reflect.Value, maxDepth uint) (int, error) {
	var n int
	vt := v.Type()
	for i := 0; i < v.NumField(); i++ {
		// Skip unexported fields.
		vtf := vt.Field(i)
		if vtf.PkgPath != "" {
			continue
		}

		// Indirect through pointers allocating them as needed and
		// ensure the field is settable.
		vf := v.Field(i)

		if !vf.CanSet() {
			msg := fmt.Sprintf("can't decode to unsettable '%v'",
				vf.Type().String())
			err := unmarshalError("decodeStruct", ErrNotSettable,
				msg, nil, nil)
			return n, err
		}

		// Handle non-opaque data to []uint8 and [#]uint8 based on
		// struct tag.
		tag := vtf.Tag.Get("xdropaque")
		if tag == "false" {
			switch vf.Kind() {
			case reflect.Slice:
				maxSize := 0
				if dest, ok := vf.Interface().(Sized); ok {
					maxSize = dest.XDRMaxSize()
				}

				n2, err := d.decodeArray(vf, true, maxSize, maxDepth)
				n += n2
				if err != nil {
					return n, err
				}
				continue

			case reflect.Array:
				n2, err := d.decodeFixedArray(vf, true, maxDepth)
				n += n2
				if err != nil {
					return n, err
				}
				continue
			}
		}

		maxSize := 0
		sizeTag := vtf.Tag.Get("xdrmaxsize")
		if sizeTag != "" {
			sz, err := strconv.ParseInt(sizeTag, 10, 32)
			if err != nil {
				return n, err
			}
			maxSize = int(sz)
		}

		// Decode each struct field.
		n2, err := d.decode(vf, maxSize, maxDepth)
		n += n2
		if err != nil {
			return n, err
		}
	}

	return n, nil
}

// RFC Section 4.15 - Discriminated Union
// RFC Section 4.16 - Void
// RFC Section 4.17 - Constant
// RFC Section 4.18 - Typedef
// RFC Section 4.19 - Optional data
// RFC Sections 4.15 though 4.19 only apply to the data specification language
// which is not implemented by this package.  In the case of discriminated
// unions, struct tags are used to perform a similar function.

// decodeMap treats the next bytes as an XDR encoded variable array of 2-element
// structures whose fields are of the same type as the map keys and elements
// represented by the passed reflection value.  Pointers are automatically
// indirected and allocated as necessary.  It returns the  the number of bytes
// actually read.
//
// An UnmarshalError is returned if any issues are encountered while decoding
// the elements.
func (d *Decoder) decodeMap(v reflect.Value, maxDepth uint) (int, error) {
	dataLen, n, err := d.DecodeUint()
	if err != nil {
		return n, err
	}
	if left, ok := d.InputLen(); ok {
		if uint(left) < uint(dataLen) {
			return n, unmarshalError("decodeMap", ErrOverflow, errMaxSlice, dataLen, nil)
		}
	}

	// Allocate storage for the underlying map if needed.
	vt := v.Type()
	if v.IsNil() {
		v.Set(reflect.MakeMap(vt))
	}

	// Decode each key and value according to their type.
	keyType := vt.Key()
	elemType := vt.Elem()
	for i := uint32(0); i < dataLen; i++ {
		key := reflect.New(keyType).Elem()
		n2, err := d.decode(key, 0, maxDepth)
		n += n2
		if err != nil {
			return n, err
		}

		val := reflect.New(elemType).Elem()
		n2, err = d.decode(val, 0, maxDepth)
		n += n2
		if err != nil {
			return n, err
		}
		v.SetMapIndex(key, val)
	}
	return n, nil
}

// decodeInterface examines the interface represented by the passed reflection
// value to detect whether it is an interface that can be decoded into and
// if it is, extracts the underlying value to pass back into the decode function
// for decoding according to its type. It returns the number of bytes
// actually read.
//
// An UnmarshalError is returned if any issues are encountered while decoding
// the interface.
func (d *Decoder) decodeInterface(v reflect.Value, maxDepth uint) (int, error) {
	if v.IsNil() || !v.CanInterface() {
		msg := fmt.Sprintf("can't decode to nil interface")
		err := unmarshalError("decodeInterface", ErrNilInterface, msg,
			nil, nil)
		return 0, err
	}

	// Extract underlying value from the interface and indirect through
	// any pointer, allocating as needed.
	ve := reflect.ValueOf(v.Interface())
	ve, err := d.indirectIfPtr(ve)
	if err != nil {
		return 0, err
	}
	if !ve.CanSet() {
		msg := fmt.Sprintf("can't decode to unsettable '%v'",
			ve.Type().String())
		err := unmarshalError("decodeInterface", ErrNotSettable, msg,
			nil, nil)
		return 0, err
	}
	return d.decode(ve, 0, maxDepth)
}

func (d *Decoder) mergeInputLenAndMaxSize(maxSize int) int {
	if left, ok := d.InputLen(); ok {
		if maxSize == 0 || left < maxSize {
			return left
		}
	}
	return maxSize
}

// decode is the main workhorse for unmarshalling via reflection.  It uses
// the passed reflection value to choose the XDR primitives to decode from
// the encapsulated reader.  It is a recursive function,
// so cyclic data structures are not supported and will result in an ErrMaxDecodingDepth
// error.  It returns the number of bytes actually read.
func (d *Decoder) decode(ve reflect.Value, maxSize int, maxDepth uint) (int, error) {
	if maxDepth == 0 {
		return 0, unmarshalError("decode", ErrMaxDecodingDepth, "maximum decoding depth reached", nil, nil)
	}
	maxDepth--

	if !ve.IsValid() {
		msg := fmt.Sprintf("type '%s' is not valid", ve.Kind().String())
		err := unmarshalError("decode", ErrUnsupportedType, msg, nil, nil)
		return 0, err
	}

	// Handle time.Time values by decoding them as an RFC3339 formatted
	// string with nanosecond precision.  Check the type string rather
	// than doing a full-blown conversion to interface and type assertion
	// since checking a string is much quicker.
	if ve.Type().String() == "time.Time" {
		// Read the value as a string and parse it.
		timeString, n, err := d.DecodeString(maxSize)
		if err != nil {
			return n, err
		}
		ttv, err := time.Parse(time.RFC3339, timeString)
		if err != nil {
			err := unmarshalError("decode", ErrParseTime,
				err.Error(), timeString, err)
			return n, err
		}
		ve.Set(reflect.ValueOf(ttv))
		return n, nil
	}

	// Handle native Go types.
	switch ve.Kind() {

	case reflect.Ptr:
		return d.decodePtr(ve, maxDepth)

	case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int:
		i, n, err := d.DecodeInt()
		if err != nil {
			return n, err
		}
		if ve.OverflowInt(int64(i)) {
			msg := fmt.Sprintf("signed integer too large to fit '%s'",
				ve.Kind().String())
			err = unmarshalError("decode", ErrOverflow, msg, i, nil)
			return n, err
		}
		ve.SetInt(int64(i))
		enum, ok := ve.Interface().(Enum)

		if ok {
			if !enum.ValidEnum(i) {
				err := unmarshalError("decode", ErrBadEnumValue, "invalid enum", i, nil)
				return n, err
			}
		}

		return n, nil

	case reflect.Int64:
		i, n, err := d.DecodeHyper()
		if err != nil {
			return n, err
		}
		ve.SetInt(i)
		return n, nil

	case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint:
		ui, n, err := d.DecodeUint()
		if err != nil {
			return n, err
		}
		if ve.OverflowUint(uint64(ui)) {
			msg := fmt.Sprintf("unsigned integer too large to fit '%s'",
				ve.Kind().String())
			err = unmarshalError("decode", ErrOverflow, msg, ui, nil)
			return n, err
		}
		ve.SetUint(uint64(ui))
		return n, nil

	case reflect.Uint64:
		ui, n, err := d.DecodeUhyper()
		if err != nil {
			return n, err
		}
		ve.SetUint(ui)
		return n, nil

	case reflect.Bool:
		b, n, err := d.DecodeBool()
		if err != nil {
			return n, err
		}
		ve.SetBool(b)
		return n, nil

	case reflect.Float32:
		f, n, err := d.DecodeFloat()
		if err != nil {
			return n, err
		}
		ve.SetFloat(float64(f))
		return n, nil

	case reflect.Float64:
		f, n, err := d.DecodeDouble()
		if err != nil {
			return n, err
		}
		ve.SetFloat(f)
		return n, nil

	case reflect.String:
		if dest, ok := ve.Interface().(Sized); ok {
			maxSize = dest.XDRMaxSize()
		}

		s, n, err := d.DecodeString(maxSize)
		if err != nil {
			return n, err
		}
		ve.SetString(s)
		return n, nil

	case reflect.Array:
		n, err := d.decodeFixedArray(ve, false, maxDepth)
		if err != nil {
			return n, err
		}
		return n, nil

	case reflect.Slice:
		if dest, ok := ve.Interface().(Sized); ok {
			maxSize = dest.XDRMaxSize()
		}

		n, err := d.decodeArray(ve, false, maxSize, maxDepth)
		if err != nil {
			return n, err
		}
		return n, nil

	case reflect.Struct:
		// If the struct's pointer implements union
		// we need to init the union's value interface

		if _, ok := ve.Interface().(Union); ok {
			return d.decodeUnion(ve, maxDepth)
		}

		n, err := d.decodeStruct(ve, maxDepth)
		if err != nil {
			return n, err
		}
		return n, nil

	case reflect.Map:
		n, err := d.decodeMap(ve, maxDepth)
		if err != nil {
			return n, err
		}
		return n, nil

	case reflect.Interface:
		n, err := d.decodeInterface(ve, maxDepth)
		if err != nil {
			return n, err
		}
		return n, nil
	}

	// The only unhandled types left are unsupported.  At the time of this
	// writing the only remaining unsupported types that exist are
	// reflect.Uintptr and reflect.UnsafePointer.
	msg := fmt.Sprintf("unsupported Go type '%s'", ve.Kind().String())
	err := unmarshalError("decode", ErrUnsupportedType, msg, nil, nil)
	return 0, err
}

func setPtrToNil(v *reflect.Value) error {
	if v.Kind() != reflect.Ptr {
		msg := fmt.Sprintf("value is not a pointer: '%v'",
			v.Type().String())
		err := unmarshalError("decodePtr", ErrBadArguments, msg,
			nil, nil)
		return err
	}
	if !v.CanSet() {
		msg := fmt.Sprintf("pointer value cannot be changed for '%v'",
			v.Type().String())
		err := unmarshalError("decodePtr", ErrNotSettable, msg,
			nil, nil)
		return err
	}

	v.Set(reflect.Zero(v.Type()))
	return nil
}

func (d *Decoder) allocPtrIfNil(v *reflect.Value) error {
	if v.Kind() != reflect.Ptr {
		msg := fmt.Sprintf("value is not a pointer: '%v'",
			v.Type().String())
		err := unmarshalError("decodePtr", ErrBadArguments, msg,
			nil, nil)
		return err
	}
	isNil := v.IsNil()
	if isNil && !v.CanSet() {
		msg := fmt.Sprintf("unable to allocate pointer for '%v'",
			v.Type().String())
		err := unmarshalError("decodePtr", ErrNotSettable, msg,
			nil, nil)
		return err
	}
	if isNil {
		vet := v.Type().Elem()
		v.Set(reflect.New(vet))
	}
	return nil
}

// decodePtr decodes a single tagged XDR pointer type: one 4-byte
// boolean followed by an encoded referent, which is allocated if needed.
func (d *Decoder) decodePtr(v reflect.Value, maxDepth uint) (int, error) {

	present, n, err := d.DecodeBool()

	if err != nil {
		return n, err
	}

	if !present {
		err = setPtrToNil(&v)
		return n, err
	}

	if err = d.allocPtrIfNil(&v); err != nil {
		return n, err
	}

	n2, err := d.decode(v.Elem(), 0, maxDepth)
	return n + n2, err
}

// IndirectIfPtr allocates a pointee and dereferences it, if passed a Ptr type,
// otherwise returns the passed value.
func (d *Decoder) indirectIfPtr(v reflect.Value) (reflect.Value, error) {
	if v.Kind() == reflect.Ptr {
		err := d.allocPtrIfNil(&v)
		return v.Elem(), err
	}
	return v, nil
}

// Decode operates identically to the Unmarshal function with the exception of
// using the reader associated with the Decoder as the source of XDR-encoded
// data instead of a user-supplied reader. See the Unmarhsal documentation for
// specifics. Decode(v) is equivalent to DecodeWithMaxDepth(v, DecodeDefaultMaxDepth)
func (d *Decoder) Decode(v interface{}) (int, error) {
	if v == nil {
		msg := "can't unmarshal to nil interface"
		return 0, unmarshalError("Unmarshal", ErrNilInterface, msg, nil,
			nil)
	}

	vv := reflect.ValueOf(v)
	if vv.Kind() != reflect.Ptr {
		msg := fmt.Sprintf("can't unmarshal to non-pointer '%v' - use "+
			"& operator", vv.Type().String())
		err := unmarshalError("Unmarshal", ErrBadArguments, msg, nil, nil)
		return 0, err
	}
	if vv.IsNil() && !vv.CanSet() {
		msg := fmt.Sprintf("can't unmarshal to unsettable '%v' - use "+
			"& operator", vv.Type().String())
		err := unmarshalError("Unmarshal", ErrNotSettable, msg, nil, nil)
		return 0, err
	}

	return d.decode(vv.Elem(), 0, d.maxDepth)
}

// InputLen returns the size left to read from the decoder's input if available
func (d *Decoder) InputLen() (int, bool) {
	if d.l == nil {
		return 0, false
	}
	return d.l.Len(), true
}