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/anacrolix/torrent/metainfo"
  12         "github.com/anacrolix/torrent/mmap_span"
  13         "github.com/edsrzf/mmap-go"
  14 )
  15
  16 type mmapClientImpl struct {
  17         baseDir string
  18         pc      PieceCompletion
  19 }
  20
  21 func NewMMap(baseDir string) ClientImpl {
  22         return NewMMapWithCompletion(baseDir, pieceCompletionForDir(baseDir))
  23 }
  24
  25 func NewMMapWithCompletion(baseDir string, completion PieceCompletion) ClientImpl {
  26         return &mmapClientImpl{
  27                 baseDir: baseDir,
  28                 pc:      completion,
  29         }
  30 }
  31
  32 func (s *mmapClientImpl) OpenTorrent(info *metainfo.Info, infoHash metainfo.Hash) (t TorrentImpl, err error) {
  33         span, err := mMapTorrent(info, s.baseDir)
  34         t = &mmapTorrentStorage{
  35                 infoHash: infoHash,
  36                 span:     span,
  37                 pc:       s.pc,
  38         }
  39         return
  40 }
  41
  42 func (s *mmapClientImpl) Close() error {
  43         return s.pc.Close()
  44 }
  45
  46 type mmapTorrentStorage struct {
  47         infoHash metainfo.Hash
  48         span     *mmap_span.MMapSpan
  49         pc       PieceCompletion
  50 }
  51
  52 func (ts *mmapTorrentStorage) Piece(p metainfo.Piece) PieceImpl {
  53         return mmapStoragePiece{
  54                 pc:       ts.pc,
  55                 p:        p,
  56                 ih:       ts.infoHash,
  57                 ReaderAt: io.NewSectionReader(ts.span, p.Offset(), p.Length()),
  58                 WriterAt: missinggo.NewSectionWriter(ts.span, p.Offset(), p.Length()),
  59         }
  60 }
  61
  62 func (ts *mmapTorrentStorage) Close() error {
  63         ts.pc.Close()
  64         return ts.span.Close()
  65 }
  66
  67 type mmapStoragePiece struct {
  68         pc PieceCompletion
  69         p  metainfo.Piece
  70         ih metainfo.Hash
  71         io.ReaderAt
  72         io.WriterAt
  73 }
  74
  75 func (me mmapStoragePiece) pieceKey() metainfo.PieceKey {
  76         return metainfo.PieceKey{me.ih, me.p.Index()}
  77 }
  78
  79 func (sp mmapStoragePiece) Completion() Completion {
  80         c, _ := sp.pc.Get(sp.pieceKey())
  81         return c
  82 }
  83
  84 func (sp mmapStoragePiece) MarkComplete() error {
  85         sp.pc.Set(sp.pieceKey(), true)
  86         return nil
  87 }
  88
  89 func (sp mmapStoragePiece) MarkNotComplete() error {
  90         sp.pc.Set(sp.pieceKey(), false)
  91         return nil
  92 }
  93
  94 func mMapTorrent(md *metainfo.Info, location string) (mms *mmap_span.MMapSpan, err error) {
  95         mms = &mmap_span.MMapSpan{}
  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 }