go-ethereum/core/vm/analysis.go

// Copyright 2014 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package vm

const (
	set2BitsMask = uint16(0b11)
	set3BitsMask = uint16(0b111)
	set4BitsMask = uint16(0b1111)
	set5BitsMask = uint16(0b1_1111)
	set6BitsMask = uint16(0b11_1111)
	set7BitsMask = uint16(0b111_1111)
)

// bitvec is a bit vector which maps bytes in a program.
// An unset bit means the byte is an opcode, a set bit means
// it's data (i.e. argument of PUSHxx).
type bitvec []byte

func (bits bitvec) set1(pos uint64) {
	bits[pos/8] |= 1 << (pos % 8)
}

func (bits bitvec) setN(flag uint16, pos uint64) {
	a := flag << (pos % 8)
	bits[pos/8] |= byte(a)
	if b := byte(a >> 8); b != 0 {
		bits[pos/8+1] = b
	}
}

func (bits bitvec) set8(pos uint64) {
	a := byte(0xFF << (pos % 8))
	bits[pos/8] |= a
	bits[pos/8+1] = ^a
}

func (bits bitvec) set16(pos uint64) {
	a := byte(0xFF << (pos % 8))
	bits[pos/8] |= a
	bits[pos/8+1] = 0xFF
	bits[pos/8+2] = ^a
}

// codeSegment checks if the position is in a code segment.
func (bits *bitvec) codeSegment(pos uint64) bool {
	return (((*bits)[pos/8] >> (pos % 8)) & 1) == 0
}

// codeBitmap collects data locations in code.
func codeBitmap(code []byte) bitvec {
	// The bitmap is 4 bytes longer than necessary, in case the code
	// ends with a PUSH32, the algorithm will set bits on the
	// bitvector outside the bounds of the actual code.
	bits := make(bitvec, len(code)/8+1+4)
	return codeBitmapInternal(code, bits)
}

// codeBitmapInternal is the internal implementation of codeBitmap.
// It exists for the purpose of being able to run benchmark tests
// without dynamic allocations affecting the results.
func codeBitmapInternal(code, bits bitvec) bitvec {
	for pc := uint64(0); pc < uint64(len(code)); {
		op := OpCode(code[pc])
		pc++
		if int8(op) < int8(PUSH1) { // If not PUSH (the int8(op) > int(PUSH32) is always false).
			continue
		}
		numbits := op - PUSH1 + 1
		if numbits >= 8 {
			for ; numbits >= 16; numbits -= 16 {
				bits.set16(pc)
				pc += 16
			}
			for ; numbits >= 8; numbits -= 8 {
				bits.set8(pc)
				pc += 8
			}
		}
		switch numbits {
		case 1:
			bits.set1(pc)
			pc += 1
		case 2:
			bits.setN(set2BitsMask, pc)
			pc += 2
		case 3:
			bits.setN(set3BitsMask, pc)
			pc += 3
		case 4:
			bits.setN(set4BitsMask, pc)
			pc += 4
		case 5:
			bits.setN(set5BitsMask, pc)
			pc += 5
		case 6:
			bits.setN(set6BitsMask, pc)
			pc += 6
		case 7:
			bits.setN(set7BitsMask, pc)
			pc += 7
		}
	}
	return bits
}

type bitVec []uint32

func (b bitVec) isCode(pc uint64) bool {
	return (b[pc/32] & (1 << (pc % 32))) == 0
}

func newCodeBitVec(code []byte) (bv bitVec) {
	bv = make(bitVec, len(code)/32+2)
	bv.codeBitVec(code)
	return bv
}

func (bv bitVec) codeBitVec(code []byte) bitVec {
	var pc uint64
	for pc < uint64(len(code)) {
		op := code[pc]
		if int8(op) < 0x60 {
			pc++
			continue // continue if the OpCode is not PUSH1..32
		}
		numBytes := op - 0x5f // number of data bytes pushed

		// set bits
		mask := masks[numBytes] // optimization for: (1 << numBytes) - 1
		shift := uint8(pc+1) % 32

		i := (pc + 1) / 32
		bv[i+1] = mask >> (32 - shift)
		bv[i] |= mask << shift

		pc += uint64(numBytes + 1)
	}
	return bv
}

var masks = [256]uint32{
	1:  0b00000000_00000000_00000000_00000001,
	2:  0b00000000_00000000_00000000_00000011,
	3:  0b00000000_00000000_00000000_00000111,
	4:  0b00000000_00000000_00000000_00001111,
	5:  0b00000000_00000000_00000000_00011111,
	6:  0b00000000_00000000_00000000_00111111,
	7:  0b00000000_00000000_00000000_01111111,
	8:  0b00000000_00000000_00000000_11111111,
	9:  0b00000000_00000000_00000001_11111111,
	10: 0b00000000_00000000_00000011_11111111,
	11: 0b00000000_00000000_00000111_11111111,
	12: 0b00000000_00000000_00001111_11111111,
	13: 0b00000000_00000000_00011111_11111111,
	14: 0b00000000_00000000_00111111_11111111,
	15: 0b00000000_00000000_01111111_11111111,
	16: 0b00000000_00000000_11111111_11111111,
	17: 0b00000000_00000001_11111111_11111111,
	18: 0b00000000_00000011_11111111_11111111,
	19: 0b00000000_00000111_11111111_11111111,
	20: 0b00000000_00001111_11111111_11111111,
	21: 0b00000000_00011111_11111111_11111111,
	22: 0b00000000_00111111_11111111_11111111,
	23: 0b00000000_01111111_11111111_11111111,
	24: 0b00000000_11111111_11111111_11111111,
	25: 0b00000001_11111111_11111111_11111111,
	26: 0b00000011_11111111_11111111_11111111,
	27: 0b00000111_11111111_11111111_11111111,
	28: 0b00001111_11111111_11111111_11111111,
	29: 0b00011111_11111111_11111111_11111111,
	30: 0b00111111_11111111_11111111_11111111,
	31: 0b01111111_11111111_11111111_11111111,
	32: 0b11111111_11111111_11111111_11111111,
}