netbird/gvisor
0
0
Fork 0
mirror of https://github.com/netbirdio/gvisor.git synced 2026-05-22 17:12:49 -07:00
Code Issues Packages Projects Releases Wiki Activity

Improve lisafs debug log messages.

Browse Source 
- Improves Statx prints. Used by Inode, which is in turn used by many messages.
  Now mode and timestamps are much more readable.
- Print all mask fields as hex for readability.
- Made WalkStatus readable.
- Improves printing of slices. Earlier, there was a ", " suffix which was
  confusing because it could look like an empty string entry. Now we print
  slices more meticulously.
- Consistently use Stringer implementations to print things, instead of %+v. So
  future improvements are easier to make.

PiperOrigin-RevId: 516895609
This commit is contained in:
Ayush Ranjan
2023-03-15 12:20:52 -07:00
committed by gVisor bot
parent c122d8d6c8
commit 4c5803c47f
3 changed files with 65 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/abi/linux/file.go
+2 -2
View File
@@ -274,8 +274,8 @@ type Statx struct {
// String implements fmt.Stringer.String.
func (s *Statx) String() string {
return fmt.Sprintf("Statx{Mask: %d, Blksize: %d, Attributes: %d, Nlink: %d, UID: %d, GID: %d, Mode: %d, Ino: %d, Size: %d, Blocks: %d, AttributesMask: %d, Atime: %d, Btime: %d, Ctime: %d, Mtime: %d, RdevMajor: %d, RdevMinor: %d, DevMajor: %d, DevMinor: %d}",
s.Mask, s.Blksize, s.Attributes, s.Nlink, s.UID, s.GID, s.Mode, s.Ino, s.Size, s.Blocks, s.AttributesMask, s.Atime, s.Btime, s.Ctime, s.Mtime, s.RdevMajor, s.RdevMinor, s.DevMajor, s.DevMinor)
return fmt.Sprintf("Statx{Mask: %#x, Mode: %s, UID: %d, GID: %d, Ino: %d, DevMajor: %d, DevMinor: %d, Size: %d, Blocks: %d, Blksize: %d, Nlink: %d, Atime: %s, Btime: %s, Ctime: %s, Mtime: %s, Attributes: %d, AttributesMask: %d, RdevMajor: %d, RdevMinor: %d}",
s.Mask, FileMode(s.Mode), s.UID, s.GID, s.Ino, s.DevMajor, s.DevMinor, s.Size, s.Blocks, s.Blksize, s.Nlink, s.Atime.ToTime(), s.Btime.ToTime(), s.Ctime.ToTime(), s.Mtime.ToTime(), s.Attributes, s.AttributesMask, s.RdevMajor, s.RdevMinor)
}
// SizeOfStatx is the size of a Statx struct.
pkg/abi/linux/time.go
+5
View File
@@ -274,6 +274,11 @@ func NsecToStatxTimestamp(nsec int64) (ts StatxTimestamp) {
}
}
// ToTime returns the Go time.Time representation.
func (sxts StatxTimestamp) ToTime() time.Time {
return time.Unix(sxts.Sec, int64(sxts.Nsec))
}
// Utime represents struct utimbuf used by utimes(2).
//
// +marshal
pkg/lisafs/message.go
+58 -19
View File
@@ -270,9 +270,7 @@ type StringArray []string
func (s *StringArray) String() string {
var b strings.Builder
b.WriteString("[")
for _, str := range *s {
b.WriteString(fmt.Sprintf("%s, ", str))
}
b.WriteString(strings.Join(*s, ", "))
b.WriteString("]")
return b.String()
}
@@ -331,6 +329,10 @@ type Inode struct {
Stat linux.Statx
}
func (i *Inode) String() string {
return fmt.Sprintf("Inode{ControlFD: %d, Stat: %s}", i.ControlFD, i.Stat.String())
}
// MountReq is an empty request to Mount on the connection.
type MountReq struct{ EmptyMessage }
@@ -351,7 +353,7 @@ type MountResp struct {
// String implements fmt.Stringer.String.
func (m *MountResp) String() string {
return fmt.Sprintf("MountResp{Root: %+v, MaxMessageSize: %d, SupportedMs: %+v}", m.Root, m.MaxMessageSize, m.SupportedMs)
return fmt.Sprintf("MountResp{Root: %s, MaxMessageSize: %d, SupportedMs: %+v}", m.Root.String(), m.MaxMessageSize, m.SupportedMs)
}
// SizeBytes implements marshal.Marshallable.SizeBytes.
@@ -453,8 +455,8 @@ type SetStatReq struct {
// String implements fmt.Stringer.String.
func (s *SetStatReq) String() string {
return fmt.Sprintf("SetStatReq{FD: %d, Mask: %d, Mode: %d, UID: %d, GID: %d, Size: %d, Atime: %+v, Mtime: %+v}",
s.FD, s.Mask, s.Mode, s.UID, s.GID, s.Size, s.Atime, s.Mtime)
return fmt.Sprintf("SetStatReq{FD: %d, Mask: %#x, Mode: %d, UID: %d, GID: %d, Size: %d, Atime: %s, Mtime: %s}",
s.FD, s.Mask, s.Mode, s.UID, s.GID, s.Size, s.Atime.ToTime(), s.Mtime.ToTime())
}
// SetStatResp is used to communicate SetStat results. It contains a mask
@@ -470,7 +472,7 @@ type SetStatResp struct {
// String implements fmt.Stringer.String.
func (s *SetStatResp) String() string {
return fmt.Sprintf("SetStatResp{FailureMask: %d, FailureErrNo: %d}", s.FailureMask, s.FailureErrNo)
return fmt.Sprintf("SetStatResp{FailureMask: %#x, FailureErrNo: %d}", s.FailureMask, s.FailureErrNo)
}
// WalkReq is used to request to walk multiple path components at once. This
@@ -530,6 +532,19 @@ const (
WalkComponentSymlink
)
func walkStatusToString(ws WalkStatus) string {
switch ws {
case WalkSuccess:
return "Success"
case WalkComponentDoesNotExist:
return "ComponentDoesNotExist"
case WalkComponentSymlink:
return "ComponentSymlink"
default:
panic(fmt.Sprintf("Unknown WalkStatus: %d", ws))
}
}
// WalkResp is used to communicate the inodes walked by the server. In memory,
// the inode array is preceded by a uint16 integer denoting array length.
type WalkResp struct {
@@ -544,10 +559,13 @@ func (w *WalkResp) String() string {
var arrB strings.Builder
arrB.WriteString("[")
for i := range w.Inodes {
arrB.WriteString(fmt.Sprintf("%+v, ", w.Inodes[i]))
if i > 0 {
arrB.WriteString(", ")
}
arrB.WriteString(w.Inodes[i].String())
}
arrB.WriteString("]")
return fmt.Sprintf("WalkResp{Status: %d, Inodes: %s}", w.Status, arrB.String())
return fmt.Sprintf("WalkResp{Status: %s, Inodes: %s}", walkStatusToString(w.Status), arrB.String())
}
// SizeBytes implements marshal.Marshallable.SizeBytes.
@@ -595,7 +613,16 @@ type WalkStatResp struct {
// String implements fmt.Stringer.String.
func (w *WalkStatResp) String() string {
return fmt.Sprintf("WalkStatResp{Stats: %+v}", w.Stats)
var arrB strings.Builder
arrB.WriteString("[")
for i := range w.Stats {
if i > 0 {
arrB.WriteString(", ")
}
arrB.WriteString(w.Stats[i].String())
}
arrB.WriteString("]")
return fmt.Sprintf("WalkStatResp{Stats: %s}", arrB.String())
}
// SizeBytes implements marshal.Marshallable.SizeBytes.
@@ -716,7 +743,7 @@ type OpenCreateAtResp struct {
// String implements fmt.Stringer.String.
func (o *OpenCreateAtResp) String() string {
return fmt.Sprintf("OpenCreateAtResp{Child: %+v, NewFD: %d}", o.Child, o.NewFD)
return fmt.Sprintf("OpenCreateAtResp{Child: %s, NewFD: %d}", o.Child.String(), o.NewFD)
}
// FdArray is a utility struct which implements a marshallable type for
@@ -730,8 +757,11 @@ type FdArray []FDID
func (f *FdArray) String() string {
var b strings.Builder
b.WriteString("[")
for _, fd := range *f {
b.WriteString(fmt.Sprintf("%d, ", fd))
for i, fd := range *f {
if i > 0 {
b.WriteString(", ")
}
b.WriteString(fmt.Sprintf("%d", fd))
}
b.WriteString("]")
return b.String()
@@ -985,7 +1015,7 @@ type MkdirAtResp struct {
// String implements fmt.Stringer.String.
func (m *MkdirAtResp) String() string {
return fmt.Sprintf("MkdirAtResp{ChildDir: %+v}", m.ChildDir)
return fmt.Sprintf("MkdirAtResp{ChildDir: %s}", m.ChildDir.String())
}
// MknodAtReq is used to make MknodAt requests.
@@ -1038,7 +1068,7 @@ type MknodAtResp struct {
// String implements fmt.Stringer.String.
func (m *MknodAtResp) String() string {
return fmt.Sprintf("MknodAtResp{Child: %+v}", m.Child)
return fmt.Sprintf("MknodAtResp{Child: %s}", m.Child.String())
}
// SymlinkAtReq is used to make SymlinkAt request.
@@ -1098,7 +1128,7 @@ type SymlinkAtResp struct {
// String implements fmt.Stringer.String.
func (s *SymlinkAtResp) String() string {
return fmt.Sprintf("SymlinkAtResp{Symlink: %+v}", s.Symlink)
return fmt.Sprintf("SymlinkAtResp{Symlink: %s}", s.Symlink.String())
}
// LinkAtReq is used to make LinkAt requests.
@@ -1148,7 +1178,7 @@ type LinkAtResp struct {
// String implements fmt.Stringer.String.
func (l *LinkAtResp) String() string {
return fmt.Sprintf("LinkAtResp{Link: %+v}", l.Link)
return fmt.Sprintf("LinkAtResp{Link: %s}", l.Link.String())
}
// FStatFSReq is used to request StatFS results for the specified FD.
@@ -1336,7 +1366,7 @@ type BindAtResp struct {
// String implements fmt.Stringer.String.
func (b *BindAtResp) String() string {
return fmt.Sprintf("BindAtResp{Child: %+v, BoundSocketFD: %v}", b.Child, b.BoundSocketFD)
return fmt.Sprintf("BindAtResp{Child: %s, BoundSocketFD: %d}", b.Child.String(), b.BoundSocketFD)
}
// ListenReq is used to make Listen requests.
@@ -1571,7 +1601,16 @@ type Getdents64Resp struct {
// String implements fmt.Stringer.String.
func (g *Getdents64Resp) String() string {
return fmt.Sprintf("Getdents64Resp{Dirents: %+v}", g.Dirents)
var b strings.Builder
b.WriteString("[")
for i, dirent := range g.Dirents {
if i > 0 {
b.WriteString(", ")
}
b.WriteString(dirent.String())
}
b.WriteString("]")
return fmt.Sprintf("Getdents64Resp{Dirents: %s}", b.String())
}
// SizeBytes implements marshal.Marshallable.SizeBytes.