summaryrefslogtreecommitdiffhomepage
path: root/tools/checkunsafe/check_unsafe.go
blob: 4ccd7cc5a899f8a34e15793ca428ed8dbdf12a5a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
// Copyright 2019 The gVisor Authors.
//
// 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 checkunsafe allows unsafe imports only in files named appropriately.
package checkunsafe

import (
	"fmt"
	"path"
	"strconv"
	"strings"

	"golang.org/x/tools/go/analysis"
)

// Analyzer defines the entrypoint.
var Analyzer = &analysis.Analyzer{
	Name: "checkunsafe",
	Doc:  "allows unsafe use only in specified files",
	Run:  run,
}

func run(pass *analysis.Pass) (interface{}, error) {
	for _, f := range pass.Files {
		for _, imp := range f.Imports {
			// Is this an unsafe import?
			pkg, err := strconv.Unquote(imp.Path.Value)
			if err != nil || pkg != "unsafe" {
				continue
			}

			// Extract the filename.
			filename := pass.Fset.File(imp.Pos()).Name()

			// Allow files named _unsafe.go or _test.go to opt out.
			if strings.HasSuffix(filename, "_unsafe.go") || strings.HasSuffix(filename, "_test.go") {
				continue
			}

			// Throw the error.
			pass.Reportf(imp.Pos(), fmt.Sprintf("package unsafe imported by %s; must end with _unsafe.go", path.Base(filename)))
		}
	}
	return nil, nil
}