lib/fs: Introduce walkfs debug facility (syncthing#4712)

imsodin · calmh · commit 8a3e584c19e6 · 2018-02-05T11:07:56.000+01:00
diff --git a/lib/fs/debug.go b/lib/fs/debug.go
@@ -18,5 +18,12 @@ var (
 )
 
 func init() {
-	l.SetDebug("fs", strings.Contains(os.Getenv("STTRACE"), "fs") || os.Getenv("STTRACE") == "all")
+	logger.DefaultLogger.NewFacility("walkfs", "Filesystem access while walking")
+	switch {
+	case strings.Contains(os.Getenv("STTRACE"), "walkfs") || os.Getenv("STTRACE") == "all":
+		l.SetDebug("walkfs", true)
+		fallthrough
+	case strings.Contains(os.Getenv("STTRACE"), "fs"):
+		l.SetDebug("fs", true)
+	}
 }
diff --git a/lib/fs/filesystem.go b/lib/fs/filesystem.go
@@ -160,7 +160,7 @@ func NewFilesystem(fsType FilesystemType, uri string) Filesystem {
 	var fs Filesystem
 	switch fsType {
 	case FilesystemTypeBasic:
-		fs = NewWalkFilesystem(newBasicFilesystem(uri))
+		fs = newBasicFilesystem(uri)
 	default:
 		l.Debugln("Unknown filesystem", fsType, uri)
 		fs = &errorFilesystem{
@@ -170,10 +170,15 @@ func NewFilesystem(fsType FilesystemType, uri string) Filesystem {
 		}
 	}
 
+	if l.ShouldDebug("walkfs") {
+		return NewWalkFilesystem(&logFilesystem{fs})
+	}
+
 	if l.ShouldDebug("fs") {
-		fs = &logFilesystem{fs}
+		return &logFilesystem{NewWalkFilesystem(fs)}
 	}
-	return fs
+
+	return NewWalkFilesystem(fs)
 }
 
 // IsInternal returns true if the file, as a path relative to the folder

Original file line number	Diff line number	Diff line change
`@@ -18,5 +18,12 @@ var (`
`18`	`18`	`)`
`19`	`19`
`20`	`20`	`func init() {`
`21`		`- l.SetDebug("fs", strings.Contains(os.Getenv("STTRACE"), "fs") \|\| os.Getenv("STTRACE") == "all")`
	`21`	`+ logger.DefaultLogger.NewFacility("walkfs", "Filesystem access while walking")`
	`22`	`+ switch {`
	`23`	`+ case strings.Contains(os.Getenv("STTRACE"), "walkfs") \|\| os.Getenv("STTRACE") == "all":`
	`24`	`+ l.SetDebug("walkfs", true)`
	`25`	`+ fallthrough`
	`26`	`+ case strings.Contains(os.Getenv("STTRACE"), "fs"):`
	`27`	`+ l.SetDebug("fs", true)`
	`28`	`+ }`
`22`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -160,7 +160,7 @@ func NewFilesystem(fsType FilesystemType, uri string) Filesystem {`
`160`	`160`	`var fs Filesystem`
`161`	`161`	`switch fsType {`
`162`	`162`	`case FilesystemTypeBasic:`
`163`		`- fs = NewWalkFilesystem(newBasicFilesystem(uri))`
	`163`	`+ fs = newBasicFilesystem(uri)`
`164`	`164`	`default:`
`165`	`165`	`l.Debugln("Unknown filesystem", fsType, uri)`
`166`	`166`	`fs = &errorFilesystem{`
`@@ -170,10 +170,15 @@ func NewFilesystem(fsType FilesystemType, uri string) Filesystem {`
`170`	`170`	`}`
`171`	`171`	`}`
`172`	`172`
	`173`	`+ if l.ShouldDebug("walkfs") {`
	`174`	`+ return NewWalkFilesystem(&logFilesystem{fs})`
	`175`	`+ }`
	`176`	`+`
`173`	`177`	`if l.ShouldDebug("fs") {`
`174`		`- fs = &logFilesystem{fs}`
	`178`	`+ return &logFilesystem{NewWalkFilesystem(fs)}`
`175`	`179`	`}`
`176`		`- return fs`
	`180`	`+`
	`181`	`+ return NewWalkFilesystem(fs)`
`177`	`182`	`}`
`178`	`183`
`179`	`184`	`// IsInternal returns true if the file, as a path relative to the folder`