summaryrefslogtreecommitdiffhomepage
path: root/pkg/sentry/fsimpl/sys/sys.go
blob: 34e8e0cbe1105fc431b54b79a26ab9c8ba9d6ab1 (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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
// 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 sys implements sysfs.
package sys

import (
	"bytes"
	"fmt"

	"gvisor.dev/gvisor/pkg/abi/linux"
	"gvisor.dev/gvisor/pkg/context"
	"gvisor.dev/gvisor/pkg/sentry/fsimpl/kernfs"
	"gvisor.dev/gvisor/pkg/sentry/kernel"
	"gvisor.dev/gvisor/pkg/sentry/kernel/auth"
	"gvisor.dev/gvisor/pkg/sentry/vfs"
	"gvisor.dev/gvisor/pkg/syserror"
)

// Name is the default filesystem name.
const Name = "sysfs"

// FilesystemType implements vfs.FilesystemType.
type FilesystemType struct{}

// filesystem implements vfs.FilesystemImpl.
type filesystem struct {
	kernfs.Filesystem
}

// Name implements vfs.FilesystemType.Name.
func (FilesystemType) Name() string {
	return Name
}

// GetFilesystem implements vfs.FilesystemType.GetFilesystem.
func (fsType FilesystemType) GetFilesystem(ctx context.Context, vfsObj *vfs.VirtualFilesystem, creds *auth.Credentials, source string, opts vfs.GetFilesystemOptions) (*vfs.Filesystem, *vfs.Dentry, error) {
	fs := &filesystem{}
	fs.Filesystem.Init(vfsObj, &fsType)
	k := kernel.KernelFromContext(ctx)
	maxCPUCores := k.ApplicationCores()
	defaultSysDirMode := linux.FileMode(0755)

	root := fs.newDir(creds, defaultSysDirMode, map[string]*kernfs.Dentry{
		"block": fs.newDir(creds, defaultSysDirMode, nil),
		"bus":   fs.newDir(creds, defaultSysDirMode, nil),
		"class": fs.newDir(creds, defaultSysDirMode, map[string]*kernfs.Dentry{
			"power_supply": fs.newDir(creds, defaultSysDirMode, nil),
		}),
		"dev": fs.newDir(creds, defaultSysDirMode, nil),
		"devices": fs.newDir(creds, defaultSysDirMode, map[string]*kernfs.Dentry{
			"system": fs.newDir(creds, defaultSysDirMode, map[string]*kernfs.Dentry{
				"cpu": fs.newDir(creds, defaultSysDirMode, map[string]*kernfs.Dentry{
					"online":   fs.newCPUFile(creds, maxCPUCores, linux.FileMode(0444)),
					"possible": fs.newCPUFile(creds, maxCPUCores, linux.FileMode(0444)),
					"present":  fs.newCPUFile(creds, maxCPUCores, linux.FileMode(0444)),
				}),
			}),
		}),
		"firmware": fs.newDir(creds, defaultSysDirMode, nil),
		"fs":       fs.newDir(creds, defaultSysDirMode, nil),
		"kernel":   fs.newDir(creds, defaultSysDirMode, nil),
		"module":   fs.newDir(creds, defaultSysDirMode, nil),
		"power":    fs.newDir(creds, defaultSysDirMode, nil),
	})
	return fs.VFSFilesystem(), root.VFSDentry(), nil
}

// dir implements kernfs.Inode.
type dir struct {
	kernfs.InodeAttrs
	kernfs.InodeNoDynamicLookup
	kernfs.InodeNotSymlink
	kernfs.InodeDirectoryNoNewChildren

	kernfs.OrderedChildren
	dentry kernfs.Dentry
}

func (fs *filesystem) newDir(creds *auth.Credentials, mode linux.FileMode, contents map[string]*kernfs.Dentry) *kernfs.Dentry {
	d := &dir{}
	d.InodeAttrs.Init(creds, fs.NextIno(), linux.ModeDirectory|0755)
	d.OrderedChildren.Init(kernfs.OrderedChildrenOptions{})
	d.dentry.Init(d)

	d.IncLinks(d.OrderedChildren.Populate(&d.dentry, contents))

	return &d.dentry
}

// SetStat implements Inode.SetStat not allowing inode attributes to be changed.
func (*dir) SetStat(context.Context, *vfs.Filesystem, *auth.Credentials, vfs.SetStatOptions) error {
	return syserror.EPERM
}

// Open implements kernfs.Inode.Open.
func (d *dir) Open(rp *vfs.ResolvingPath, vfsd *vfs.Dentry, opts vfs.OpenOptions) (*vfs.FileDescription, error) {
	fd, err := kernfs.NewGenericDirectoryFD(rp.Mount(), vfsd, &d.OrderedChildren, &opts)
	if err != nil {
		return nil, err
	}
	return fd.VFSFileDescription(), nil
}

// cpuFile implements kernfs.Inode.
type cpuFile struct {
	kernfs.DynamicBytesFile
	maxCores uint
}

// Generate implements vfs.DynamicBytesSource.Generate.
func (c *cpuFile) Generate(ctx context.Context, buf *bytes.Buffer) error {
	fmt.Fprintf(buf, "0-%d", c.maxCores-1)
	return nil
}

func (fs *filesystem) newCPUFile(creds *auth.Credentials, maxCores uint, mode linux.FileMode) *kernfs.Dentry {
	c := &cpuFile{maxCores: maxCores}
	c.DynamicBytesFile.Init(creds, fs.NextIno(), c, mode)
	d := &kernfs.Dentry{}
	d.Init(c)
	return d
}