+//go:build !wasm
+// +build !wasm
+
package storage
import (
"os"
"path/filepath"
- "github.com/anacrolix/missinggo"
+ "github.com/anacrolix/missinggo/v2"
"github.com/edsrzf/mmap-go"
"github.com/anacrolix/torrent/metainfo"
pc PieceCompletion
}
-func NewMMap(baseDir string) ClientImpl {
+// TODO: Support all the same native filepath configuration that NewFileOpts provides.
+func NewMMap(baseDir string) ClientImplCloser {
return NewMMapWithCompletion(baseDir, pieceCompletionForDir(baseDir))
}
-func NewMMapWithCompletion(baseDir string, completion PieceCompletion) ClientImpl {
+func NewMMapWithCompletion(baseDir string, completion PieceCompletion) *mmapClientImpl {
return &mmapClientImpl{
baseDir: baseDir,
pc: completion,
}
}
-func (s *mmapClientImpl) OpenTorrent(info *metainfo.Info, infoHash metainfo.Hash) (t TorrentImpl, err error) {
+func (s *mmapClientImpl) OpenTorrent(info *metainfo.Info, infoHash metainfo.Hash) (_ TorrentImpl, err error) {
span, err := mMapTorrent(info, s.baseDir)
- t = &mmapTorrentStorage{
+ t := &mmapTorrentStorage{
infoHash: infoHash,
span: span,
pc: s.pc,
}
- return
+ return TorrentImpl{Piece: t.Piece, Close: t.Close, Flush: t.Flush}, err
}
func (s *mmapClientImpl) Close() error {
type mmapTorrentStorage struct {
infoHash metainfo.Hash
span *mmap_span.MMapSpan
- pc PieceCompletion
+ pc PieceCompletionGetSetter
}
func (ts *mmapTorrentStorage) Piece(p metainfo.Piece) PieceImpl {
}
func (ts *mmapTorrentStorage) Close() error {
- ts.pc.Close()
- return ts.span.Close()
+ errs := ts.span.Close()
+ if len(errs) > 0 {
+ return errs[0]
+ }
+ return nil
+}
+
+func (ts *mmapTorrentStorage) Flush() error {
+ errs := ts.span.Flush()
+ if len(errs) > 0 {
+ return errs[0]
+ }
+ return nil
}
type mmapStoragePiece struct {
- pc PieceCompletion
+ pc PieceCompletionGetSetter
p metainfo.Piece
ih metainfo.Hash
io.ReaderAt
}
func (sp mmapStoragePiece) Completion() Completion {
- c, _ := sp.pc.Get(sp.pieceKey())
+ c, err := sp.pc.Get(sp.pieceKey())
+ if err != nil {
+ panic(err)
+ }
return c
}
}
}()
for _, miFile := range md.UpvertedFiles() {
- fileName := filepath.Join(append([]string{location, md.Name}, miFile.Path...)...)
- var mm mmap.MMap
+ var safeName string
+ safeName, err = ToSafeFilePath(append([]string{md.Name}, miFile.Path...)...)
+ if err != nil {
+ return
+ }
+ fileName := filepath.Join(location, safeName)
+ var mm FileMapping
mm, err = mmapFile(fileName, miFile.Length)
if err != nil {
err = fmt.Errorf("file %q: %s", miFile.DisplayPath(md), err)
return
}
- if mm != nil {
- mms.Append(mm)
- }
+ mms.Append(mm)
}
+ mms.InitIndex()
return
}
-func mmapFile(name string, size int64) (ret mmap.MMap, err error) {
+func mmapFile(name string, size int64) (_ FileMapping, err error) {
dir := filepath.Dir(name)
- err = os.MkdirAll(dir, 0777)
+ err = os.MkdirAll(dir, 0o750)
if err != nil {
err = fmt.Errorf("making directory %q: %s", dir, err)
return
}
var file *os.File
- file, err = os.OpenFile(name, os.O_CREATE|os.O_RDWR, 0666)
+ file, err = os.OpenFile(name, os.O_CREATE|os.O_RDWR, 0o666)
if err != nil {
return
}
- defer file.Close()
+ defer func() {
+ if err != nil {
+ file.Close()
+ }
+ }()
var fi os.FileInfo
fi, err = file.Stat()
if err != nil {
return
}
}
- if size == 0 {
- // Can't mmap() regions with length 0.
- return
- }
- intLen := int(size)
- if int64(intLen) != size {
- err = errors.New("size too large for system")
+ return func() (ret mmapWithFile, err error) {
+ ret.f = file
+ if size == 0 {
+ // Can't mmap() regions with length 0.
+ return
+ }
+ intLen := int(size)
+ if int64(intLen) != size {
+ err = errors.New("size too large for system")
+ return
+ }
+ ret.mmap, err = mmap.MapRegion(file, intLen, mmap.RDWR, 0, 0)
+ if err != nil {
+ err = fmt.Errorf("error mapping region: %s", err)
+ return
+ }
+ if int64(len(ret.mmap)) != size {
+ panic(len(ret.mmap))
+ }
return
+ }()
+}
+
+// Combines a mmapped region and file into a storage Mmap abstraction, which handles closing the
+// mmap file handle.
+func WrapFileMapping(region mmap.MMap, file *os.File) FileMapping {
+ return mmapWithFile{
+ f: file,
+ mmap: region,
}
- ret, err = mmap.MapRegion(file, intLen, mmap.RDWR, 0, 0)
- if err != nil {
- err = fmt.Errorf("error mapping region: %s", err)
- return
+}
+
+type FileMapping = mmap_span.Mmap
+
+// Handles closing the mmap's file handle (needed for Windows). Could be implemented differently by
+// OS.
+type mmapWithFile struct {
+ f *os.File
+ mmap mmap.MMap
+}
+
+func (m mmapWithFile) Flush() error {
+ return m.mmap.Flush()
+}
+
+func (m mmapWithFile) Unmap() (err error) {
+ if m.mmap != nil {
+ err = m.mmap.Unmap()
}
- if int64(len(ret)) != size {
- panic(len(ret))
+ fileErr := m.f.Close()
+ if err == nil {
+ err = fileErr
}
return
}
+
+func (m mmapWithFile) Bytes() []byte {
+ if m.mmap == nil {
+ return nil
+ }
+ return m.mmap
+}