Merge pull request #20 from nspcc-dev/use-x-sys-cpu-instead-of-self-implemented

Use golang.org/x/sys instead of self-implemented detector

.gitignore

@@ -10,3 +10,6 @@
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+
+vendor
+tzsum

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.11-alpine3.8 as builder
+FROM golang:1-alpine as builder
 
 RUN set -x \
     && apk add --no-cache \
@@ -28,7 +28,7 @@ RUN set -x \
     && go build -mod=vendor -o /go/bin/homo ./cmd/homo/main.go
 
 # Executable image
-FROM alpine:3.8
+FROM alpine:3.11
 
 WORKDIR /fixtures
 

Makefile

@@ -4,7 +4,8 @@ R=\033[0m
 
 NAME ?= homo
 
-.PHONY: help attach auto up down
+.PHONY: help attach auto up down deps
+
 # Show this help prompt
 help:
 	@echo '  Usage:'
@@ -15,22 +16,28 @@ help:
 	@echo ''
 	@awk '/^#/{ comment = substr($$0,3) } comment && /^[a-zA-Z][a-zA-Z0-9_-]+ ?:/{ print "   ", $$1, comment }' $(MAKEFILE_LIST) | column -t -s ':' | grep -v 'IGNORE' | sort | uniq
 
+# Install dependencies
+deps:
+	@go mod tidy -v
+	@go mod vendor
+
 # Auto Tillich-Zémor hasher demo
-auto: down
+auto: down deps
 	@echo "\n${B}${G}build container${R}\n"
 	@time docker build -t poc-demo .
 	@echo "\n${B}${G}Bootup container:${R}\n"
 	@time docker run -d --rm -it --name hash-demo poc-demo:latest sh
 	@bash ./auto.sh
+	@make down
 
 # Stop demo container
 down:
 	@echo "\n${B}${G}Stop container${R}\n"
-	@docker stop hash-demo || true
+	@docker kill hash-demo || true
-	@docker rm hash-demo || true
+	@docker rm -f hash-demo || true
 
 # Run Tillich-Zémor hasher demo
-up: down
+up: down deps
 	@echo "\n${B}${G}build container${R}\n"
 	@time docker build -t poc-demo .
 	@echo "\n${B}${G}enter inside container:${R}\n"

benchmark

@@ -1,13 +1,11 @@
 #!/bin/bash
-#tmpfile=$(mktemp /tmp/random-file.XXXXXX)
-#size=$1
-#dd if=/dev/urandom of=$tmpfile bs=$size count=1
 
-tmpfile=$1
+tmpfile=$(mktemp /tmp/random-file.XXXXXX)
+dd if=/dev/urandom of=$tmpfile bs=$1 count=1
 
 go build ./cmd/tzsum && \
 for impl in avx avx2 avx2inline purego; do
 	echo $impl implementation:
-	/usr/bin/env time -f "time: %e seconds" ./tzsum -name $tmpfile -impl $impl
+	/usr/bin/env time ./tzsum -name $tmpfile -impl $impl
 	echo
 done

go.mod

@@ -2,4 +2,7 @@ module github.com/nspcc-dev/tzhash
 
 go 1.12
 
-require github.com/stretchr/testify v1.3.0
+require (
+	github.com/stretchr/testify v1.3.0
+	golang.org/x/sys v0.0.0-20200113162924-86b910548bc1
+)

go.sum

@@ -6,3 +6,5 @@ github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+golang.org/x/sys v0.0.0-20200113162924-86b910548bc1 h1:gZpLHxUX5BdYLA08Lj4YCJNN/jk7KtquiArPoeX0WvA=
+golang.org/x/sys v0.0.0-20200113162924-86b910548bc1/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=

internal/cpuid/cpuid_x86.go

@@ -1,77 +0,0 @@
-// Copyright (c) 2009 The Go Authors. All rights reserved.
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-//    * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-//    * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-//    * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-// +build 386 amd64 amd64p32
-
-package cpuid
-
-const (
-	bitOSXSAVE = 1 << 27
-	bitAVX     = 1 << 28
-	bitAVX2    = 1 << 5
-)
-
-var (
-	hasAVX  bool
-	hasAVX2 bool
-)
-
-func init() {
-	maxID, _, _, _ := cpuid(0, 0)
-	if maxID < 1 {
-		return
-	}
-
-	_, _, ecx1, _ := cpuid(1, 0)
-	hasOSXSAVE := isSet(ecx1, bitOSXSAVE)
-
-	osSupportsAVX := false
-	if hasOSXSAVE {
-		eax, _ := xgetbv()
-		osSupportsAVX = isSet(eax, 1<<1) && isSet(eax, 1<<2)
-	}
-
-	hasAVX = isSet(ecx1, bitAVX) && osSupportsAVX
-
-	if maxID < 7 {
-		return
-	}
-
-	_, ebx7, _, _ := cpuid(7, 0)
-	hasAVX2 = isSet(ebx7, bitAVX2) && osSupportsAVX
-}
-
-func HasAVX() bool  { return hasAVX }
-func HasAVX2() bool { return hasAVX2 }
-
-func isSet(hwc uint32, value uint32) bool {
-	return hwc&value != 0
-}
-
-func cpuid(eaxArg, ecxArg uint32) (eax, ebx, ecx, edx uint32)
-func xgetbv() (eax, edx uint32)

internal/cpuid/cpuid_x86.s

@@ -1,48 +0,0 @@
-// Copyright (c) 2009 The Go Authors. All rights reserved.
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-//    * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-//    * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-//    * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-#include "textflag.h"
-
-// func cpuid(eaxArg, ecxArg uint32) (eax, ebx, ecx, edx uint32)
-TEXT ·cpuid(SB), NOSPLIT, $0-24
-    MOVL eaxArg+0(FP), AX
-    MOVL ecxArg+4(FP), CX
-    CPUID
-    MOVL AX, eax+8(FP)
-    MOVL BX, ebx+12(FP)
-    MOVL CX, ecx+16(FP)
-    MOVL DX, edx+20(FP)
-    RET
-
-// func xgetbv() (eax, edx uint32)
-TEXT ·xgetbv(SB),NOSPLIT,$0-8
-    MOVL $0, CX
-    XGETBV
-    MOVL AX, eax+0(FP)
-    MOVL DX, edx+4(FP)
-    RET

tz/hash.go

@@ -7,7 +7,7 @@ import (
 	"errors"
 	"hash"
 
-	"github.com/nspcc-dev/tzhash/internal/cpuid"
+	"golang.org/x/sys/cpu"
 )
 
 type Implementation int
@@ -25,10 +25,10 @@ const (
 )
 
 var (
-	hasAVX = cpuid.HasAVX()
+	hasAVX = cpu.X86.HasAVX
 	// Having AVX2 does not guarantee
 	// that AVX is also present.
-	hasAVX2 = cpuid.HasAVX2() && hasAVX
+	hasAVX2 = cpu.X86.HasAVX2 && hasAVX
 )
 
 func (impl Implementation) String() string {