storage/mmap.go

   1 //go:build !wasm
   2 // +build !wasm
   3
   4 package storage
   5
   6 import (
   7         "errors"
   8         "fmt"
   9         "io"
  10         "os"
  11         "path/filepath"
  12
  13         "github.com/anacrolix/missinggo/v2"
  14         "github.com/edsrzf/mmap-go"
  15
  16         "github.com/anacrolix/torrent/metainfo"
  17         "github.com/anacrolix/torrent/mmap_span"
  18 )
  19
  20 type mmapClientImpl struct {
  21         baseDir string
  22         pc      PieceCompletion
  23 }
  24
  25 // TODO: Support all the same native filepath configuration that NewFileOpts provides.
  26 func NewMMap(baseDir string) ClientImplCloser {
  27         return NewMMapWithCompletion(baseDir, pieceCompletionForDir(baseDir))
  28 }
  29
  30 func NewMMapWithCompletion(baseDir string, completion PieceCompletion) *mmapClientImpl {
  31         return &mmapClientImpl{
  32                 baseDir: baseDir,
  33                 pc:      completion,
  34         }
  35 }
  36
  37 func (s *mmapClientImpl) OpenTorrent(info *metainfo.Info, infoHash metainfo.Hash) (_ TorrentImpl, err error) {
  38         span, err := mMapTorrent(info, s.baseDir)
  39         t := &mmapTorrentStorage{
  40                 infoHash: infoHash,
  41                 span:     span,
  42                 pc:       s.pc,
  43         }
  44         return TorrentImpl{Piece: t.Piece, Close: t.Close, Flush: t.Flush}, err
  45 }
  46
  47 func (s *mmapClientImpl) Close() error {
  48         return s.pc.Close()
  49 }
  50
  51 type mmapTorrentStorage struct {
  52         infoHash metainfo.Hash
  53         span     *mmap_span.MMapSpan
  54         pc       PieceCompletionGetSetter
  55 }
  56
  57 func (ts *mmapTorrentStorage) Piece(p metainfo.Piece) PieceImpl {
  58         return mmapStoragePiece{
  59                 pc:       ts.pc,
  60                 p:        p,
  61                 ih:       ts.infoHash,
  62                 ReaderAt: io.NewSectionReader(ts.span, p.Offset(), p.Length()),
  63                 WriterAt: missinggo.NewSectionWriter(ts.span, p.Offset(), p.Length()),
  64         }
  65 }
  66
  67 func (ts *mmapTorrentStorage) Close() error {
  68         errs := ts.span.Close()
  69         if len(errs) > 0 {
  70                 return errs[0]
  71         }
  72         return nil
  73 }
  74 func (ts *mmapTorrentStorage) Flush() error {
  75         errs := ts.span.Flush()
  76         if len(errs) > 0 {
  77                 return errs[0]
  78         }
  79         return nil
  80 }
  81
  82 type mmapStoragePiece struct {
  83         pc PieceCompletionGetSetter
  84         p  metainfo.Piece
  85         ih metainfo.Hash
  86         io.ReaderAt
  87         io.WriterAt
  88 }
  89
  90 func (me mmapStoragePiece) pieceKey() metainfo.PieceKey {
  91         return metainfo.PieceKey{me.ih, me.p.Index()}
  92 }
  93
  94 func (sp mmapStoragePiece) Completion() Completion {
  95         c, err := sp.pc.Get(sp.pieceKey())
  96         if err != nil {
  97                 panic(err)
  98         }
  99         return c
 100 }
 101
 102 func (sp mmapStoragePiece) MarkComplete() error {
 103         sp.pc.Set(sp.pieceKey(), true)
 104         return nil
 105 }
 106
 107 func (sp mmapStoragePiece) MarkNotComplete() error {
 108         sp.pc.Set(sp.pieceKey(), false)
 109         return nil
 110 }
 111
 112 func mMapTorrent(md *metainfo.Info, location string) (mms *mmap_span.MMapSpan, err error) {
 113         mms = &mmap_span.MMapSpan{}
 114         defer func() {
 115                 if err != nil {
 116                         mms.Close()
 117                 }
 118         }()
 119         for _, miFile := range md.UpvertedFiles() {
 120                 var safeName string
 121                 safeName, err = ToSafeFilePath(append([]string{md.Name}, miFile.Path...)...)
 122                 if err != nil {
 123                         return
 124                 }
 125                 fileName := filepath.Join(location, safeName)
 126                 var mm mmap.MMap
 127                 mm, err = mmapFile(fileName, miFile.Length)
 128                 if err != nil {
 129                         err = fmt.Errorf("file %q: %s", miFile.DisplayPath(md), err)
 130                         return
 131                 }
 132                 if mm != nil {
 133                         mms.Append(mm)
 134                 }
 135         }
 136         mms.InitIndex()
 137         return
 138 }
 139
 140 func mmapFile(name string, size int64) (ret mmap.MMap, err error) {
 141         dir := filepath.Dir(name)
 142         err = os.MkdirAll(dir, 0o750)
 143         if err != nil {
 144                 err = fmt.Errorf("making directory %q: %s", dir, err)
 145                 return
 146         }
 147         var file *os.File
 148         file, err = os.OpenFile(name, os.O_CREATE|os.O_RDWR, 0o666)
 149         if err != nil {
 150                 return
 151         }
 152         defer file.Close()
 153         var fi os.FileInfo
 154         fi, err = file.Stat()
 155         if err != nil {
 156                 return
 157         }
 158         if fi.Size() < size {
 159                 // I think this is necessary on HFS+. Maybe Linux will SIGBUS too if
 160                 // you overmap a file but I'm not sure.
 161                 err = file.Truncate(size)
 162                 if err != nil {
 163                         return
 164                 }
 165         }
 166         if size == 0 {
 167                 // Can't mmap() regions with length 0.
 168                 return
 169         }
 170         intLen := int(size)
 171         if int64(intLen) != size {
 172                 err = errors.New("size too large for system")
 173                 return
 174         }
 175         ret, err = mmap.MapRegion(file, intLen, mmap.RDWR, 0, 0)
 176         if err != nil {
 177                 err = fmt.Errorf("error mapping region: %s", err)
 178                 return
 179         }
 180         if int64(len(ret)) != size {
 181                 panic(len(ret))
 182         }
 183         return
 184 }