memmap.go 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
  1. // Copyright © 2014 Steve Francia <spf@spf13.com>.
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. // http://www.apache.org/licenses/LICENSE-2.0
  7. //
  8. // Unless required by applicable law or agreed to in writing, software
  9. // distributed under the License is distributed on an "AS IS" BASIS,
  10. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11. // See the License for the specific language governing permissions and
  12. // limitations under the License.
  13. package afero
  14. import (
  15. "fmt"
  16. "log"
  17. "os"
  18. "path/filepath"
  19. "strings"
  20. "sync"
  21. "time"
  22. "github.com/spf13/afero/mem"
  23. )
  24. type MemMapFs struct {
  25. mu sync.RWMutex
  26. data map[string]*mem.FileData
  27. init sync.Once
  28. }
  29. func NewMemMapFs() Fs {
  30. return &MemMapFs{}
  31. }
  32. var memfsInit sync.Once
  33. func (m *MemMapFs) getData() map[string]*mem.FileData {
  34. m.init.Do(func() {
  35. m.data = make(map[string]*mem.FileData)
  36. // Root should always exist, right?
  37. // TODO: what about windows?
  38. m.data[FilePathSeparator] = mem.CreateDir(FilePathSeparator)
  39. })
  40. return m.data
  41. }
  42. func (MemMapFs) Name() string { return "MemMapFS" }
  43. func (m *MemMapFs) Create(name string) (File, error) {
  44. name = normalizePath(name)
  45. m.mu.Lock()
  46. file := mem.CreateFile(name)
  47. m.getData()[name] = file
  48. m.registerWithParent(file)
  49. m.mu.Unlock()
  50. return mem.NewFileHandle(file), nil
  51. }
  52. func (m *MemMapFs) unRegisterWithParent(fileName string) error {
  53. f, err := m.lockfreeOpen(fileName)
  54. if err != nil {
  55. return err
  56. }
  57. parent := m.findParent(f)
  58. if parent == nil {
  59. log.Panic("parent of ", f.Name(), " is nil")
  60. }
  61. mem.RemoveFromMemDir(parent, f)
  62. return nil
  63. }
  64. func (m *MemMapFs) findParent(f *mem.FileData) *mem.FileData {
  65. pdir, _ := filepath.Split(f.Name())
  66. pdir = filepath.Clean(pdir)
  67. pfile, err := m.lockfreeOpen(pdir)
  68. if err != nil {
  69. return nil
  70. }
  71. return pfile
  72. }
  73. func (m *MemMapFs) registerWithParent(f *mem.FileData) {
  74. if f == nil {
  75. return
  76. }
  77. parent := m.findParent(f)
  78. if parent == nil {
  79. pdir := filepath.Dir(filepath.Clean(f.Name()))
  80. err := m.lockfreeMkdir(pdir, 0777)
  81. if err != nil {
  82. //log.Println("Mkdir error:", err)
  83. return
  84. }
  85. parent, err = m.lockfreeOpen(pdir)
  86. if err != nil {
  87. //log.Println("Open after Mkdir error:", err)
  88. return
  89. }
  90. }
  91. mem.InitializeDir(parent)
  92. mem.AddToMemDir(parent, f)
  93. }
  94. func (m *MemMapFs) lockfreeMkdir(name string, perm os.FileMode) error {
  95. name = normalizePath(name)
  96. x, ok := m.getData()[name]
  97. if ok {
  98. // Only return ErrFileExists if it's a file, not a directory.
  99. i := mem.FileInfo{x}
  100. if !i.IsDir() {
  101. return ErrFileExists
  102. }
  103. } else {
  104. item := mem.CreateDir(name)
  105. m.getData()[name] = item
  106. m.registerWithParent(item)
  107. }
  108. return nil
  109. }
  110. func (m *MemMapFs) Mkdir(name string, perm os.FileMode) error {
  111. name = normalizePath(name)
  112. m.mu.RLock()
  113. _, ok := m.getData()[name]
  114. m.mu.RUnlock()
  115. if ok {
  116. return &os.PathError{"mkdir", name, ErrFileExists}
  117. } else {
  118. m.mu.Lock()
  119. item := mem.CreateDir(name)
  120. m.getData()[name] = item
  121. m.registerWithParent(item)
  122. m.mu.Unlock()
  123. }
  124. return nil
  125. }
  126. func (m *MemMapFs) MkdirAll(path string, perm os.FileMode) error {
  127. err := m.Mkdir(path, perm)
  128. if err != nil {
  129. if err.(*os.PathError).Err == ErrFileExists {
  130. return nil
  131. } else {
  132. return err
  133. }
  134. }
  135. return nil
  136. }
  137. // Handle some relative paths
  138. func normalizePath(path string) string {
  139. path = filepath.Clean(path)
  140. switch path {
  141. case ".":
  142. return FilePathSeparator
  143. case "..":
  144. return FilePathSeparator
  145. default:
  146. return path
  147. }
  148. }
  149. func (m *MemMapFs) Open(name string) (File, error) {
  150. f, err := m.open(name)
  151. if f != nil {
  152. return mem.NewReadOnlyFileHandle(f), err
  153. }
  154. return nil, err
  155. }
  156. func (m *MemMapFs) openWrite(name string) (File, error) {
  157. f, err := m.open(name)
  158. if f != nil {
  159. return mem.NewFileHandle(f), err
  160. }
  161. return nil, err
  162. }
  163. func (m *MemMapFs) open(name string) (*mem.FileData, error) {
  164. name = normalizePath(name)
  165. m.mu.RLock()
  166. f, ok := m.getData()[name]
  167. m.mu.RUnlock()
  168. if !ok {
  169. return nil, &os.PathError{"open", name, ErrFileNotFound}
  170. }
  171. return f, nil
  172. }
  173. func (m *MemMapFs) lockfreeOpen(name string) (*mem.FileData, error) {
  174. name = normalizePath(name)
  175. f, ok := m.getData()[name]
  176. if ok {
  177. return f, nil
  178. } else {
  179. return nil, ErrFileNotFound
  180. }
  181. }
  182. func (m *MemMapFs) OpenFile(name string, flag int, perm os.FileMode) (File, error) {
  183. file, err := m.openWrite(name)
  184. if os.IsNotExist(err) && (flag&os.O_CREATE > 0) {
  185. file, err = m.Create(name)
  186. }
  187. if err != nil {
  188. return nil, err
  189. }
  190. if flag == os.O_RDONLY {
  191. file = mem.NewReadOnlyFileHandle(file.(*mem.File).Data())
  192. }
  193. if flag&os.O_APPEND > 0 {
  194. _, err = file.Seek(0, os.SEEK_END)
  195. if err != nil {
  196. file.Close()
  197. return nil, err
  198. }
  199. }
  200. if flag&os.O_TRUNC > 0 && flag&(os.O_RDWR|os.O_WRONLY) > 0 {
  201. err = file.Truncate(0)
  202. if err != nil {
  203. file.Close()
  204. return nil, err
  205. }
  206. }
  207. return file, nil
  208. }
  209. func (m *MemMapFs) Remove(name string) error {
  210. name = normalizePath(name)
  211. m.mu.Lock()
  212. defer m.mu.Unlock()
  213. if _, ok := m.getData()[name]; ok {
  214. err := m.unRegisterWithParent(name)
  215. if err != nil {
  216. return &os.PathError{"remove", name, err}
  217. }
  218. delete(m.getData(), name)
  219. } else {
  220. return &os.PathError{"remove", name, os.ErrNotExist}
  221. }
  222. return nil
  223. }
  224. func (m *MemMapFs) RemoveAll(path string) error {
  225. path = normalizePath(path)
  226. m.mu.Lock()
  227. m.unRegisterWithParent(path)
  228. m.mu.Unlock()
  229. m.mu.RLock()
  230. defer m.mu.RUnlock()
  231. for p, _ := range m.getData() {
  232. if strings.HasPrefix(p, path) {
  233. m.mu.RUnlock()
  234. m.mu.Lock()
  235. delete(m.getData(), p)
  236. m.mu.Unlock()
  237. m.mu.RLock()
  238. }
  239. }
  240. return nil
  241. }
  242. func (m *MemMapFs) Rename(oldname, newname string) error {
  243. oldname = normalizePath(oldname)
  244. newname = normalizePath(newname)
  245. if oldname == newname {
  246. return nil
  247. }
  248. m.mu.RLock()
  249. defer m.mu.RUnlock()
  250. if _, ok := m.getData()[oldname]; ok {
  251. m.mu.RUnlock()
  252. m.mu.Lock()
  253. m.unRegisterWithParent(oldname)
  254. fileData := m.getData()[oldname]
  255. delete(m.getData(), oldname)
  256. mem.ChangeFileName(fileData, newname)
  257. m.getData()[newname] = fileData
  258. m.registerWithParent(fileData)
  259. m.mu.Unlock()
  260. m.mu.RLock()
  261. } else {
  262. return &os.PathError{"rename", oldname, ErrFileNotFound}
  263. }
  264. return nil
  265. }
  266. func (m *MemMapFs) Stat(name string) (os.FileInfo, error) {
  267. f, err := m.Open(name)
  268. if err != nil {
  269. return nil, err
  270. }
  271. fi := mem.GetFileInfo(f.(*mem.File).Data())
  272. return fi, nil
  273. }
  274. func (m *MemMapFs) Chmod(name string, mode os.FileMode) error {
  275. name = normalizePath(name)
  276. f, ok := m.getData()[name]
  277. if !ok {
  278. return &os.PathError{"chmod", name, ErrFileNotFound}
  279. }
  280. m.mu.Lock()
  281. mem.SetMode(f, mode)
  282. m.mu.Unlock()
  283. return nil
  284. }
  285. func (m *MemMapFs) Chtimes(name string, atime time.Time, mtime time.Time) error {
  286. name = normalizePath(name)
  287. f, ok := m.getData()[name]
  288. if !ok {
  289. return &os.PathError{"chtimes", name, ErrFileNotFound}
  290. }
  291. m.mu.Lock()
  292. mem.SetModTime(f, mtime)
  293. m.mu.Unlock()
  294. return nil
  295. }
  296. func (m *MemMapFs) List() {
  297. for _, x := range m.data {
  298. y := mem.FileInfo{x}
  299. fmt.Println(x.Name(), y.Size())
  300. }
  301. }
  302. func debugMemMapList(fs Fs) {
  303. if x, ok := fs.(*MemMapFs); ok {
  304. x.List()
  305. }
  306. }