storage/mmap.go

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