// 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 proc

import (
	"fmt"
	"math"
	"path"
	"strconv"
	"testing"

	"gvisor.dev/gvisor/pkg/abi/linux"
	"gvisor.dev/gvisor/pkg/fspath"
	"gvisor.dev/gvisor/pkg/sentry/context"
	"gvisor.dev/gvisor/pkg/sentry/kernel"
	"gvisor.dev/gvisor/pkg/sentry/kernel/auth"
	"gvisor.dev/gvisor/pkg/sentry/usermem"
	"gvisor.dev/gvisor/pkg/sentry/vfs"
	"gvisor.dev/gvisor/pkg/syserror"
)

var (
	// Next offset 256 by convention. Adds 1 for the next offset.
	selfLink       = vfs.Dirent{Type: linux.DT_LNK, NextOff: 256 + 0 + 1}
	threadSelfLink = vfs.Dirent{Type: linux.DT_LNK, NextOff: 256 + 1 + 1}

	// /proc/[pid] next offset starts at 256+2 (files above), then adds the
	// PID, and adds 1 for the next offset.
	proc1 = vfs.Dirent{Type: linux.DT_DIR, NextOff: 258 + 1 + 1}
	proc2 = vfs.Dirent{Type: linux.DT_DIR, NextOff: 258 + 2 + 1}
	proc3 = vfs.Dirent{Type: linux.DT_DIR, NextOff: 258 + 3 + 1}
)

type testIterDirentsCallback struct {
	dirents []vfs.Dirent
}

func (t *testIterDirentsCallback) Handle(d vfs.Dirent) bool {
	t.dirents = append(t.dirents, d)
	return true
}

func checkDots(dirs []vfs.Dirent) ([]vfs.Dirent, error) {
	if got := len(dirs); got < 2 {
		return dirs, fmt.Errorf("wrong number of dirents, want at least: 2, got: %d: %v", got, dirs)
	}
	for i, want := range []string{".", ".."} {
		if got := dirs[i].Name; got != want {
			return dirs, fmt.Errorf("wrong name, want: %s, got: %s", want, got)
		}
		if got := dirs[i].Type; got != linux.DT_DIR {
			return dirs, fmt.Errorf("wrong type, want: %d, got: %d", linux.DT_DIR, got)
		}
	}
	return dirs[2:], nil
}

func checkTasksStaticFiles(gots []vfs.Dirent) ([]vfs.Dirent, error) {
	wants := map[string]vfs.Dirent{
		"cpuinfo":     {Type: linux.DT_REG},
		"loadavg":     {Type: linux.DT_REG},
		"meminfo":     {Type: linux.DT_REG},
		"mounts":      {Type: linux.DT_LNK},
		"self":        selfLink,
		"stat":        {Type: linux.DT_REG},
		"sys":         {Type: linux.DT_DIR},
		"thread-self": threadSelfLink,
		"uptime":      {Type: linux.DT_REG},
		"version":     {Type: linux.DT_REG},
	}
	return checkFiles(gots, wants)
}

func checkTaskStaticFiles(gots []vfs.Dirent) ([]vfs.Dirent, error) {
	wants := map[string]vfs.Dirent{
		"auxv":    {Type: linux.DT_REG},
		"cmdline": {Type: linux.DT_REG},
		"comm":    {Type: linux.DT_REG},
		"environ": {Type: linux.DT_REG},
		"gid_map": {Type: linux.DT_REG},
		"io":      {Type: linux.DT_REG},
		"maps":    {Type: linux.DT_REG},
		"ns":      {Type: linux.DT_DIR},
		"smaps":   {Type: linux.DT_REG},
		"stat":    {Type: linux.DT_REG},
		"statm":   {Type: linux.DT_REG},
		"status":  {Type: linux.DT_REG},
		"task":    {Type: linux.DT_DIR},
		"uid_map": {Type: linux.DT_REG},
	}
	return checkFiles(gots, wants)
}

func checkFiles(gots []vfs.Dirent, wants map[string]vfs.Dirent) ([]vfs.Dirent, error) {
	// Go over all files, when there is a match, the file is removed from both
	// 'gots' and 'wants'. wants is expected to reach 0, as all files must
	// be present. Remaining files in 'gots', is returned to caller to decide
	// whether this is valid or not.
	for i := 0; i < len(gots); i++ {
		got := gots[i]
		want, ok := wants[got.Name]
		if !ok {
			continue
		}
		if want.Type != got.Type {
			return gots, fmt.Errorf("wrong file type, want: %v, got: %v: %+v", want.Type, got.Type, got)
		}
		if want.NextOff != 0 && want.NextOff != got.NextOff {
			return gots, fmt.Errorf("wrong dirent offset, want: %v, got: %v: %+v", want.NextOff, got.NextOff, got)
		}

		delete(wants, got.Name)
		gots = append(gots[0:i], gots[i+1:]...)
		i--
	}
	if len(wants) != 0 {
		return gots, fmt.Errorf("not all files were found, missing: %+v", wants)
	}
	return gots, nil
}

func setup() (context.Context, *vfs.VirtualFilesystem, vfs.VirtualDentry, error) {
	k, err := boot()
	if err != nil {
		return nil, nil, vfs.VirtualDentry{}, fmt.Errorf("creating kernel: %v", err)
	}

	ctx := k.SupervisorContext()
	creds := auth.CredentialsFromContext(ctx)

	vfsObj := vfs.New()
	vfsObj.MustRegisterFilesystemType("procfs", &procFSType{}, &vfs.RegisterFilesystemTypeOptions{
		AllowUserMount: true,
	})
	mntns, err := vfsObj.NewMountNamespace(ctx, creds, "", "procfs", &vfs.GetFilesystemOptions{})
	if err != nil {
		return nil, nil, vfs.VirtualDentry{}, fmt.Errorf("NewMountNamespace(): %v", err)
	}
	return ctx, vfsObj, mntns.Root(), nil
}

func TestTasksEmpty(t *testing.T) {
	ctx, vfsObj, root, err := setup()
	if err != nil {
		t.Fatalf("Setup failed: %v", err)
	}
	defer root.DecRef()

	fd, err := vfsObj.OpenAt(
		ctx,
		auth.CredentialsFromContext(ctx),
		&vfs.PathOperation{Root: root, Start: root, Path: fspath.Parse("/")},
		&vfs.OpenOptions{},
	)
	if err != nil {
		t.Fatalf("vfsfs.OpenAt failed: %v", err)
	}

	cb := testIterDirentsCallback{}
	if err := fd.Impl().IterDirents(ctx, &cb); err != nil {
		t.Fatalf("IterDirents(): %v", err)
	}
	cb.dirents, err = checkDots(cb.dirents)
	if err != nil {
		t.Error(err.Error())
	}
	cb.dirents, err = checkTasksStaticFiles(cb.dirents)
	if err != nil {
		t.Error(err.Error())
	}
	if len(cb.dirents) != 0 {
		t.Errorf("found more files than expected: %+v", cb.dirents)
	}
}

func TestTasks(t *testing.T) {
	ctx, vfsObj, root, err := setup()
	if err != nil {
		t.Fatalf("Setup failed: %v", err)
	}
	defer root.DecRef()

	k := kernel.KernelFromContext(ctx)
	var tasks []*kernel.Task
	for i := 0; i < 5; i++ {
		tc := k.NewThreadGroup(nil, k.RootPIDNamespace(), kernel.NewSignalHandlers(), linux.SIGCHLD, k.GlobalInit().Limits())
		task, err := createTask(ctx, fmt.Sprintf("name-%d", i), tc)
		if err != nil {
			t.Fatalf("CreateTask(): %v", err)
		}
		tasks = append(tasks, task)
	}

	fd, err := vfsObj.OpenAt(
		ctx,
		auth.CredentialsFromContext(ctx),
		&vfs.PathOperation{Root: root, Start: root, Path: fspath.Parse("/")},
		&vfs.OpenOptions{},
	)
	if err != nil {
		t.Fatalf("vfsfs.OpenAt(/) failed: %v", err)
	}

	cb := testIterDirentsCallback{}
	if err := fd.Impl().IterDirents(ctx, &cb); err != nil {
		t.Fatalf("IterDirents(): %v", err)
	}
	cb.dirents, err = checkDots(cb.dirents)
	if err != nil {
		t.Error(err.Error())
	}
	cb.dirents, err = checkTasksStaticFiles(cb.dirents)
	if err != nil {
		t.Error(err.Error())
	}
	lastPid := 0
	for _, d := range cb.dirents {
		pid, err := strconv.Atoi(d.Name)
		if err != nil {
			t.Fatalf("Invalid process directory %q", d.Name)
		}
		if lastPid > pid {
			t.Errorf("pids not in order: %v", cb.dirents)
		}
		found := false
		for _, t := range tasks {
			if k.TaskSet().Root.IDOfTask(t) == kernel.ThreadID(pid) {
				found = true
			}
		}
		if !found {
			t.Errorf("Additional task ID %d listed: %v", pid, tasks)
		}
		// Next offset starts at 256+2 ('self' and 'thread-self'), then adds the
		// PID, and adds 1 for the next offset.
		if want := int64(256 + 2 + pid + 1); d.NextOff != want {
			t.Errorf("Wrong dirent offset want: %d got: %d: %+v", want, d.NextOff, d)
		}
	}

	// Test lookup.
	for _, path := range []string{"/1", "/2"} {
		fd, err := vfsObj.OpenAt(
			ctx,
			auth.CredentialsFromContext(ctx),
			&vfs.PathOperation{Root: root, Start: root, Path: fspath.Parse(path)},
			&vfs.OpenOptions{},
		)
		if err != nil {
			t.Fatalf("vfsfs.OpenAt(%q) failed: %v", path, err)
		}
		buf := make([]byte, 1)
		bufIOSeq := usermem.BytesIOSequence(buf)
		if _, err := fd.Read(ctx, bufIOSeq, vfs.ReadOptions{}); err != syserror.EISDIR {
			t.Errorf("wrong error reading directory: %v", err)
		}
	}

	if _, err := vfsObj.OpenAt(
		ctx,
		auth.CredentialsFromContext(ctx),
		&vfs.PathOperation{Root: root, Start: root, Path: fspath.Parse("/9999")},
		&vfs.OpenOptions{},
	); err != syserror.ENOENT {
		t.Fatalf("wrong error from vfsfs.OpenAt(/9999): %v", err)
	}
}

func TestTasksOffset(t *testing.T) {
	ctx, vfsObj, root, err := setup()
	if err != nil {
		t.Fatalf("Setup failed: %v", err)
	}
	defer root.DecRef()

	k := kernel.KernelFromContext(ctx)
	for i := 0; i < 3; i++ {
		tc := k.NewThreadGroup(nil, k.RootPIDNamespace(), kernel.NewSignalHandlers(), linux.SIGCHLD, k.GlobalInit().Limits())
		if _, err := createTask(ctx, fmt.Sprintf("name-%d", i), tc); err != nil {
			t.Fatalf("CreateTask(): %v", err)
		}
	}

	for _, tc := range []struct {
		name   string
		offset int64
		wants  map[string]vfs.Dirent
	}{
		{
			name:   "small offset",
			offset: 100,
			wants: map[string]vfs.Dirent{
				"self":        selfLink,
				"thread-self": threadSelfLink,
				"1":           proc1,
				"2":           proc2,
				"3":           proc3,
			},
		},
		{
			name:   "offset at start",
			offset: 256,
			wants: map[string]vfs.Dirent{
				"self":        selfLink,
				"thread-self": threadSelfLink,
				"1":           proc1,
				"2":           proc2,
				"3":           proc3,
			},
		},
		{
			name:   "skip /proc/self",
			offset: 257,
			wants: map[string]vfs.Dirent{
				"thread-self": threadSelfLink,
				"1":           proc1,
				"2":           proc2,
				"3":           proc3,
			},
		},
		{
			name:   "skip symlinks",
			offset: 258,
			wants: map[string]vfs.Dirent{
				"1": proc1,
				"2": proc2,
				"3": proc3,
			},
		},
		{
			name:   "skip first process",
			offset: 260,
			wants: map[string]vfs.Dirent{
				"2": proc2,
				"3": proc3,
			},
		},
		{
			name:   "last process",
			offset: 261,
			wants: map[string]vfs.Dirent{
				"3": proc3,
			},
		},
		{
			name:   "after last",
			offset: 262,
			wants:  nil,
		},
		{
			name:   "TaskLimit+1",
			offset: kernel.TasksLimit + 1,
			wants:  nil,
		},
		{
			name:   "max",
			offset: math.MaxInt64,
			wants:  nil,
		},
	} {
		t.Run(tc.name, func(t *testing.T) {
			fd, err := vfsObj.OpenAt(
				ctx,
				auth.CredentialsFromContext(ctx),
				&vfs.PathOperation{Root: root, Start: root, Path: fspath.Parse("/")},
				&vfs.OpenOptions{},
			)
			if err != nil {
				t.Fatalf("vfsfs.OpenAt(/) failed: %v", err)
			}
			if _, err := fd.Impl().Seek(ctx, tc.offset, linux.SEEK_SET); err != nil {
				t.Fatalf("Seek(%d, SEEK_SET): %v", tc.offset, err)
			}

			cb := testIterDirentsCallback{}
			if err := fd.Impl().IterDirents(ctx, &cb); err != nil {
				t.Fatalf("IterDirents(): %v", err)
			}
			if cb.dirents, err = checkFiles(cb.dirents, tc.wants); err != nil {
				t.Error(err.Error())
			}
			if len(cb.dirents) != 0 {
				t.Errorf("found more files than expected: %+v", cb.dirents)
			}
		})
	}
}

func TestTask(t *testing.T) {
	ctx, vfsObj, root, err := setup()
	if err != nil {
		t.Fatalf("Setup failed: %v", err)
	}
	defer root.DecRef()

	k := kernel.KernelFromContext(ctx)
	tc := k.NewThreadGroup(nil, k.RootPIDNamespace(), kernel.NewSignalHandlers(), linux.SIGCHLD, k.GlobalInit().Limits())
	_, err = createTask(ctx, "name", tc)
	if err != nil {
		t.Fatalf("CreateTask(): %v", err)
	}

	fd, err := vfsObj.OpenAt(
		ctx,
		auth.CredentialsFromContext(ctx),
		&vfs.PathOperation{Root: root, Start: root, Path: fspath.Parse("/1")},
		&vfs.OpenOptions{},
	)
	if err != nil {
		t.Fatalf("vfsfs.OpenAt(/1) failed: %v", err)
	}

	cb := testIterDirentsCallback{}
	if err := fd.Impl().IterDirents(ctx, &cb); err != nil {
		t.Fatalf("IterDirents(): %v", err)
	}
	cb.dirents, err = checkDots(cb.dirents)
	if err != nil {
		t.Error(err.Error())
	}
	cb.dirents, err = checkTaskStaticFiles(cb.dirents)
	if err != nil {
		t.Error(err.Error())
	}
	if len(cb.dirents) != 0 {
		t.Errorf("found more files than expected: %+v", cb.dirents)
	}
}

func TestProcSelf(t *testing.T) {
	ctx, vfsObj, root, err := setup()
	if err != nil {
		t.Fatalf("Setup failed: %v", err)
	}
	defer root.DecRef()

	k := kernel.KernelFromContext(ctx)
	tc := k.NewThreadGroup(nil, k.RootPIDNamespace(), kernel.NewSignalHandlers(), linux.SIGCHLD, k.GlobalInit().Limits())
	task, err := createTask(ctx, "name", tc)
	if err != nil {
		t.Fatalf("CreateTask(): %v", err)
	}

	fd, err := vfsObj.OpenAt(
		task,
		auth.CredentialsFromContext(ctx),
		&vfs.PathOperation{Root: root, Start: root, Path: fspath.Parse("/self/"), FollowFinalSymlink: true},
		&vfs.OpenOptions{},
	)
	if err != nil {
		t.Fatalf("vfsfs.OpenAt(/self/) failed: %v", err)
	}

	cb := testIterDirentsCallback{}
	if err := fd.Impl().IterDirents(ctx, &cb); err != nil {
		t.Fatalf("IterDirents(): %v", err)
	}
	cb.dirents, err = checkDots(cb.dirents)
	if err != nil {
		t.Error(err.Error())
	}
	cb.dirents, err = checkTaskStaticFiles(cb.dirents)
	if err != nil {
		t.Error(err.Error())
	}
	if len(cb.dirents) != 0 {
		t.Errorf("found more files than expected: %+v", cb.dirents)
	}
}

func iterateDir(ctx context.Context, t *testing.T, vfsObj *vfs.VirtualFilesystem, root vfs.VirtualDentry, fd *vfs.FileDescription) {
	t.Logf("Iterating: /proc%s", fd.MappedName(ctx))

	cb := testIterDirentsCallback{}
	if err := fd.Impl().IterDirents(ctx, &cb); err != nil {
		t.Fatalf("IterDirents(): %v", err)
	}
	var err error
	cb.dirents, err = checkDots(cb.dirents)
	if err != nil {
		t.Error(err.Error())
	}
	for _, d := range cb.dirents {
		childPath := path.Join(fd.MappedName(ctx), d.Name)
		if d.Type == linux.DT_LNK {
			link, err := vfsObj.ReadlinkAt(
				ctx,
				auth.CredentialsFromContext(ctx),
				&vfs.PathOperation{Root: root, Start: root, Path: fspath.Parse(childPath)},
			)
			if err != nil {
				t.Errorf("vfsfs.ReadlinkAt(%v) failed: %v", childPath, err)
			} else {
				t.Logf("Skipping symlink: /proc%s => %s", childPath, link)
			}
			continue
		}

		t.Logf("Opening: /proc%s", childPath)
		child, err := vfsObj.OpenAt(
			ctx,
			auth.CredentialsFromContext(ctx),
			&vfs.PathOperation{Root: root, Start: root, Path: fspath.Parse(childPath)},
			&vfs.OpenOptions{},
		)
		if err != nil {
			t.Errorf("vfsfs.OpenAt(%v) failed: %v", childPath, err)
			continue
		}
		stat, err := child.Stat(ctx, vfs.StatOptions{})
		if err != nil {
			t.Errorf("Stat(%v) failed: %v", childPath, err)
		}
		if got := linux.FileMode(stat.Mode).DirentType(); got != d.Type {
			t.Errorf("wrong file mode, stat: %v, dirent: %v", got, d.Type)
		}
		if d.Type == linux.DT_DIR {
			// Found another dir, let's do it again!
			iterateDir(ctx, t, vfsObj, root, child)
		}
	}
}

// TestTree iterates all directories and stats every file.
func TestTree(t *testing.T) {
	uberCtx, vfsObj, root, err := setup()
	if err != nil {
		t.Fatalf("Setup failed: %v", err)
	}
	defer root.DecRef()

	k := kernel.KernelFromContext(uberCtx)
	var tasks []*kernel.Task
	for i := 0; i < 5; i++ {
		tc := k.NewThreadGroup(nil, k.RootPIDNamespace(), kernel.NewSignalHandlers(), linux.SIGCHLD, k.GlobalInit().Limits())
		task, err := createTask(uberCtx, fmt.Sprintf("name-%d", i), tc)
		if err != nil {
			t.Fatalf("CreateTask(): %v", err)
		}
		tasks = append(tasks, task)
	}

	ctx := tasks[0]
	fd, err := vfsObj.OpenAt(
		ctx,
		auth.CredentialsFromContext(uberCtx),
		&vfs.PathOperation{Root: root, Start: root, Path: fspath.Parse("/")},
		&vfs.OpenOptions{},
	)
	if err != nil {
		t.Fatalf("vfsfs.OpenAt(/) failed: %v", err)
	}
	iterateDir(ctx, t, vfsObj, root, fd)
}