pproffd.go 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. // Package pproffd is for detecting resource leaks due to unclosed handles.
  2. package pproffd
  3. import (
  4. "io"
  5. "net"
  6. "os"
  7. "runtime/pprof"
  8. )
  9. var enabled = func() bool {
  10. _, ok := os.LookupEnv("PPROFFD")
  11. return ok
  12. }()
  13. var p *pprof.Profile
  14. func init() {
  15. if enabled {
  16. p = pprof.NewProfile("fds")
  17. }
  18. }
  19. type fd int
  20. func (me *fd) Closed() {
  21. if enabled {
  22. p.Remove(me)
  23. }
  24. }
  25. func add(skip int) (ret *fd) {
  26. if enabled {
  27. ret = new(fd)
  28. p.Add(ret, skip+2)
  29. }
  30. return
  31. }
  32. type Wrapped interface {
  33. Wrapped() io.Closer
  34. }
  35. type CloseWrapper struct {
  36. fd *fd
  37. c io.Closer
  38. }
  39. func (me CloseWrapper) Wrapped() io.Closer {
  40. return me.c
  41. }
  42. func (me CloseWrapper) Close() error {
  43. me.fd.Closed()
  44. return me.c.Close()
  45. }
  46. func NewCloseWrapper(c io.Closer) CloseWrapper {
  47. // TODO: Check enabled?
  48. return CloseWrapper{
  49. fd: add(2),
  50. c: c,
  51. }
  52. }
  53. type wrappedNetConn struct {
  54. net.Conn
  55. CloseWrapper
  56. }
  57. func (me wrappedNetConn) Close() error {
  58. return me.CloseWrapper.Close()
  59. }
  60. // Tracks a net.Conn until Close() is explicitly called.
  61. func WrapNetConn(nc net.Conn) net.Conn {
  62. if !enabled {
  63. return nc
  64. }
  65. if nc == nil {
  66. return nil
  67. }
  68. return wrappedNetConn{
  69. nc,
  70. NewCloseWrapper(nc),
  71. }
  72. }
  73. type OSFile interface {
  74. io.Reader
  75. io.Seeker
  76. io.Closer
  77. io.Writer
  78. Stat() (os.FileInfo, error)
  79. io.ReaderAt
  80. io.WriterAt
  81. Wrapped
  82. }
  83. type wrappedOSFile struct {
  84. *os.File
  85. CloseWrapper
  86. }
  87. func (me wrappedOSFile) Close() error {
  88. return me.CloseWrapper.Close()
  89. }
  90. type unwrappedOsFile struct {
  91. *os.File
  92. }
  93. func (me unwrappedOsFile) Wrapped() io.Closer {
  94. return me.File
  95. }
  96. func WrapOSFile(f *os.File) OSFile {
  97. if !enabled {
  98. return unwrappedOsFile{f}
  99. }
  100. return &wrappedOSFile{f, NewCloseWrapper(f)}
  101. }