leveldb_dbinstance.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826
  1. // Copyright (C) 2014 The Syncthing Authors.
  2. //
  3. // This Source Code Form is subject to the terms of the Mozilla Public
  4. // License, v. 2.0. If a copy of the MPL was not distributed with this file,
  5. // You can obtain one at http://mozilla.org/MPL/2.0/.
  6. package db
  7. import (
  8. "bytes"
  9. "encoding/binary"
  10. "os"
  11. "sort"
  12. "strings"
  13. "sync/atomic"
  14. "github.com/syncthing/syncthing/lib/protocol"
  15. "github.com/syncthing/syncthing/lib/sync"
  16. "github.com/syndtr/goleveldb/leveldb"
  17. "github.com/syndtr/goleveldb/leveldb/errors"
  18. "github.com/syndtr/goleveldb/leveldb/iterator"
  19. "github.com/syndtr/goleveldb/leveldb/opt"
  20. "github.com/syndtr/goleveldb/leveldb/storage"
  21. "github.com/syndtr/goleveldb/leveldb/util"
  22. )
  23. type deletionHandler func(t readWriteTransaction, folder, device, name []byte, dbi iterator.Iterator)
  24. type Instance struct {
  25. committed int64 // this must be the first attribute in the struct to ensure 64 bit alignment on 32 bit plaforms
  26. *leveldb.DB
  27. folderIdx *smallIndex
  28. deviceIdx *smallIndex
  29. }
  30. const (
  31. keyPrefixLen = 1
  32. keyFolderLen = 4 // indexed
  33. keyDeviceLen = 4 // indexed
  34. keyHashLen = 32
  35. )
  36. func Open(file string) (*Instance, error) {
  37. opts := &opt.Options{
  38. OpenFilesCacheCapacity: 100,
  39. WriteBuffer: 4 << 20,
  40. }
  41. db, err := leveldb.OpenFile(file, opts)
  42. if leveldbIsCorrupted(err) {
  43. db, err = leveldb.RecoverFile(file, opts)
  44. }
  45. if leveldbIsCorrupted(err) {
  46. // The database is corrupted, and we've tried to recover it but it
  47. // didn't work. At this point there isn't much to do beyond dropping
  48. // the database and reindexing...
  49. l.Infoln("Database corruption detected, unable to recover. Reinitializing...")
  50. if err := os.RemoveAll(file); err != nil {
  51. return nil, err
  52. }
  53. db, err = leveldb.OpenFile(file, opts)
  54. }
  55. if err != nil {
  56. return nil, err
  57. }
  58. return newDBInstance(db), nil
  59. }
  60. func OpenMemory() *Instance {
  61. db, _ := leveldb.Open(storage.NewMemStorage(), nil)
  62. return newDBInstance(db)
  63. }
  64. func newDBInstance(db *leveldb.DB) *Instance {
  65. i := &Instance{
  66. DB: db,
  67. }
  68. i.folderIdx = newSmallIndex(i, []byte{KeyTypeFolderIdx})
  69. i.deviceIdx = newSmallIndex(i, []byte{KeyTypeDeviceIdx})
  70. return i
  71. }
  72. // Committed returns the number of items committed to the database since startup
  73. func (db *Instance) Committed() int64 {
  74. return atomic.LoadInt64(&db.committed)
  75. }
  76. func (db *Instance) genericReplace(folder, device []byte, fs []protocol.FileInfo, localSize, globalSize *sizeTracker, deleteFn deletionHandler) {
  77. sort.Sort(fileList(fs)) // sort list on name, same as in the database
  78. t := db.newReadWriteTransaction()
  79. defer t.close()
  80. dbi := t.NewIterator(util.BytesPrefix(db.deviceKey(folder, device, nil)[:keyPrefixLen+keyFolderLen+keyDeviceLen]), nil)
  81. defer dbi.Release()
  82. moreDb := dbi.Next()
  83. fsi := 0
  84. isLocalDevice := bytes.Equal(device, protocol.LocalDeviceID[:])
  85. for {
  86. var newName, oldName []byte
  87. moreFs := fsi < len(fs)
  88. if !moreDb && !moreFs {
  89. break
  90. }
  91. if moreFs {
  92. newName = []byte(fs[fsi].Name)
  93. }
  94. if moreDb {
  95. oldName = db.deviceKeyName(dbi.Key())
  96. }
  97. cmp := bytes.Compare(newName, oldName)
  98. l.Debugf("generic replace; folder=%q device=%v moreFs=%v moreDb=%v cmp=%d newName=%q oldName=%q", folder, protocol.DeviceIDFromBytes(device), moreFs, moreDb, cmp, newName, oldName)
  99. switch {
  100. case moreFs && (!moreDb || cmp == -1):
  101. l.Debugln("generic replace; missing - insert")
  102. // Database is missing this file. Insert it.
  103. t.insertFile(folder, device, fs[fsi])
  104. if isLocalDevice {
  105. localSize.addFile(fs[fsi])
  106. }
  107. if fs[fsi].IsInvalid() {
  108. t.removeFromGlobal(folder, device, newName, globalSize)
  109. } else {
  110. t.updateGlobal(folder, device, fs[fsi], globalSize)
  111. }
  112. fsi++
  113. case moreFs && moreDb && cmp == 0:
  114. // File exists on both sides - compare versions. We might get an
  115. // update with the same version if a device has marked a file as
  116. // invalid, so handle that too.
  117. l.Debugln("generic replace; exists - compare")
  118. var ef FileInfoTruncated
  119. ef.Unmarshal(dbi.Value())
  120. if !fs[fsi].Version.Equal(ef.Version) || fs[fsi].Invalid != ef.Invalid {
  121. l.Debugln("generic replace; differs - insert")
  122. t.insertFile(folder, device, fs[fsi])
  123. if isLocalDevice {
  124. localSize.removeFile(ef)
  125. localSize.addFile(fs[fsi])
  126. }
  127. if fs[fsi].IsInvalid() {
  128. t.removeFromGlobal(folder, device, newName, globalSize)
  129. } else {
  130. t.updateGlobal(folder, device, fs[fsi], globalSize)
  131. }
  132. } else {
  133. l.Debugln("generic replace; equal - ignore")
  134. }
  135. fsi++
  136. moreDb = dbi.Next()
  137. case moreDb && (!moreFs || cmp == 1):
  138. l.Debugln("generic replace; exists - remove")
  139. deleteFn(t, folder, device, oldName, dbi)
  140. moreDb = dbi.Next()
  141. }
  142. // Write out and reuse the batch every few records, to avoid the batch
  143. // growing too large and thus allocating unnecessarily much memory.
  144. t.checkFlush()
  145. }
  146. }
  147. func (db *Instance) replace(folder, device []byte, fs []protocol.FileInfo, localSize, globalSize *sizeTracker) {
  148. db.genericReplace(folder, device, fs, localSize, globalSize, func(t readWriteTransaction, folder, device, name []byte, dbi iterator.Iterator) {
  149. // Database has a file that we are missing. Remove it.
  150. l.Debugf("delete; folder=%q device=%v name=%q", folder, protocol.DeviceIDFromBytes(device), name)
  151. t.removeFromGlobal(folder, device, name, globalSize)
  152. t.Delete(dbi.Key())
  153. })
  154. }
  155. func (db *Instance) updateFiles(folder, device []byte, fs []protocol.FileInfo, localSize, globalSize *sizeTracker) {
  156. t := db.newReadWriteTransaction()
  157. defer t.close()
  158. var fk []byte
  159. isLocalDevice := bytes.Equal(device, protocol.LocalDeviceID[:])
  160. for _, f := range fs {
  161. name := []byte(f.Name)
  162. fk = db.deviceKeyInto(fk[:cap(fk)], folder, device, name)
  163. bs, err := t.Get(fk, nil)
  164. if err == leveldb.ErrNotFound {
  165. if isLocalDevice {
  166. localSize.addFile(f)
  167. }
  168. t.insertFile(folder, device, f)
  169. if f.IsInvalid() {
  170. t.removeFromGlobal(folder, device, name, globalSize)
  171. } else {
  172. t.updateGlobal(folder, device, f, globalSize)
  173. }
  174. continue
  175. }
  176. var ef FileInfoTruncated
  177. err = ef.Unmarshal(bs)
  178. if err != nil {
  179. panic(err)
  180. }
  181. // The Invalid flag might change without the version being bumped.
  182. if !ef.Version.Equal(f.Version) || ef.Invalid != f.Invalid {
  183. if isLocalDevice {
  184. localSize.removeFile(ef)
  185. localSize.addFile(f)
  186. }
  187. t.insertFile(folder, device, f)
  188. if f.IsInvalid() {
  189. t.removeFromGlobal(folder, device, name, globalSize)
  190. } else {
  191. t.updateGlobal(folder, device, f, globalSize)
  192. }
  193. }
  194. // Write out and reuse the batch every few records, to avoid the batch
  195. // growing too large and thus allocating unnecessarily much memory.
  196. t.checkFlush()
  197. }
  198. }
  199. func (db *Instance) withHave(folder, device, prefix []byte, truncate bool, fn Iterator) {
  200. t := db.newReadOnlyTransaction()
  201. defer t.close()
  202. dbi := t.NewIterator(util.BytesPrefix(db.deviceKey(folder, device, prefix)[:keyPrefixLen+keyFolderLen+keyDeviceLen+len(prefix)]), nil)
  203. defer dbi.Release()
  204. slashedPrefix := prefix
  205. if !bytes.HasSuffix(prefix, []byte{'/'}) {
  206. slashedPrefix = append(slashedPrefix, '/')
  207. }
  208. for dbi.Next() {
  209. name := db.deviceKeyName(dbi.Key())
  210. if len(prefix) > 0 && !bytes.Equal(name, prefix) && !bytes.HasPrefix(name, slashedPrefix) {
  211. return
  212. }
  213. // The iterator function may keep a reference to the unmarshalled
  214. // struct, which in turn references the buffer it was unmarshalled
  215. // from. dbi.Value() just returns an internal slice that it reuses, so
  216. // we need to copy it.
  217. f, err := unmarshalTrunc(append([]byte{}, dbi.Value()...), truncate)
  218. if err != nil {
  219. panic(err)
  220. }
  221. if cont := fn(f); !cont {
  222. return
  223. }
  224. }
  225. }
  226. func (db *Instance) withAllFolderTruncated(folder []byte, fn func(device []byte, f FileInfoTruncated) bool) {
  227. t := db.newReadWriteTransaction()
  228. defer t.close()
  229. dbi := t.NewIterator(util.BytesPrefix(db.deviceKey(folder, nil, nil)[:keyPrefixLen+keyFolderLen]), nil)
  230. defer dbi.Release()
  231. for dbi.Next() {
  232. device := db.deviceKeyDevice(dbi.Key())
  233. var f FileInfoTruncated
  234. // The iterator function may keep a reference to the unmarshalled
  235. // struct, which in turn references the buffer it was unmarshalled
  236. // from. dbi.Value() just returns an internal slice that it reuses, so
  237. // we need to copy it.
  238. err := f.Unmarshal(append([]byte{}, dbi.Value()...))
  239. if err != nil {
  240. panic(err)
  241. }
  242. switch f.Name {
  243. case "", ".", "..", "/": // A few obviously invalid filenames
  244. l.Infof("Dropping invalid filename %q from database", f.Name)
  245. t.removeFromGlobal(folder, device, nil, nil)
  246. t.Delete(dbi.Key())
  247. t.checkFlush()
  248. continue
  249. }
  250. if cont := fn(device, f); !cont {
  251. return
  252. }
  253. }
  254. }
  255. func (db *Instance) getFile(folder, device, file []byte) (protocol.FileInfo, bool) {
  256. return getFile(db, db.deviceKey(folder, device, file))
  257. }
  258. func (db *Instance) getGlobal(folder, file []byte, truncate bool) (FileIntf, bool) {
  259. k := db.globalKey(folder, file)
  260. t := db.newReadOnlyTransaction()
  261. defer t.close()
  262. bs, err := t.Get(k, nil)
  263. if err == leveldb.ErrNotFound {
  264. return nil, false
  265. }
  266. if err != nil {
  267. panic(err)
  268. }
  269. var vl VersionList
  270. err = vl.Unmarshal(bs)
  271. if err != nil {
  272. panic(err)
  273. }
  274. if len(vl.Versions) == 0 {
  275. l.Debugln(k)
  276. panic("no versions?")
  277. }
  278. k = db.deviceKey(folder, vl.Versions[0].Device, file)
  279. bs, err = t.Get(k, nil)
  280. if err != nil {
  281. panic(err)
  282. }
  283. fi, err := unmarshalTrunc(bs, truncate)
  284. if err != nil {
  285. panic(err)
  286. }
  287. return fi, true
  288. }
  289. func (db *Instance) withGlobal(folder, prefix []byte, truncate bool, fn Iterator) {
  290. t := db.newReadOnlyTransaction()
  291. defer t.close()
  292. dbi := t.NewIterator(util.BytesPrefix(db.globalKey(folder, prefix)), nil)
  293. defer dbi.Release()
  294. slashedPrefix := prefix
  295. if !bytes.HasSuffix(prefix, []byte{'/'}) {
  296. slashedPrefix = append(slashedPrefix, '/')
  297. }
  298. var fk []byte
  299. for dbi.Next() {
  300. var vl VersionList
  301. err := vl.Unmarshal(dbi.Value())
  302. if err != nil {
  303. panic(err)
  304. }
  305. if len(vl.Versions) == 0 {
  306. l.Debugln(dbi.Key())
  307. panic("no versions?")
  308. }
  309. name := db.globalKeyName(dbi.Key())
  310. if len(prefix) > 0 && !bytes.Equal(name, prefix) && !bytes.HasPrefix(name, slashedPrefix) {
  311. return
  312. }
  313. fk = db.deviceKeyInto(fk[:cap(fk)], folder, vl.Versions[0].Device, name)
  314. bs, err := t.Get(fk, nil)
  315. if err != nil {
  316. l.Debugf("folder: %q (%x)", folder, folder)
  317. l.Debugf("key: %q (%x)", dbi.Key(), dbi.Key())
  318. l.Debugf("vl: %v", vl)
  319. l.Debugf("vl.Versions[0].Device: %x", vl.Versions[0].Device)
  320. l.Debugf("name: %q (%x)", name, name)
  321. l.Debugf("fk: %q", fk)
  322. l.Debugf("fk: %x %x %x",
  323. fk[keyPrefixLen:keyPrefixLen+keyFolderLen],
  324. fk[keyPrefixLen+keyFolderLen:keyPrefixLen+keyFolderLen+keyDeviceLen],
  325. fk[keyPrefixLen+keyFolderLen+keyDeviceLen:])
  326. panic(err)
  327. }
  328. f, err := unmarshalTrunc(bs, truncate)
  329. if err != nil {
  330. panic(err)
  331. }
  332. if cont := fn(f); !cont {
  333. return
  334. }
  335. }
  336. }
  337. func (db *Instance) availability(folder, file []byte) []protocol.DeviceID {
  338. k := db.globalKey(folder, file)
  339. bs, err := db.Get(k, nil)
  340. if err == leveldb.ErrNotFound {
  341. return nil
  342. }
  343. if err != nil {
  344. panic(err)
  345. }
  346. var vl VersionList
  347. err = vl.Unmarshal(bs)
  348. if err != nil {
  349. panic(err)
  350. }
  351. var devices []protocol.DeviceID
  352. for _, v := range vl.Versions {
  353. if !v.Version.Equal(vl.Versions[0].Version) {
  354. break
  355. }
  356. n := protocol.DeviceIDFromBytes(v.Device)
  357. devices = append(devices, n)
  358. }
  359. return devices
  360. }
  361. func (db *Instance) withNeed(folder, device []byte, truncate bool, fn Iterator) {
  362. t := db.newReadOnlyTransaction()
  363. defer t.close()
  364. dbi := t.NewIterator(util.BytesPrefix(db.globalKey(folder, nil)[:keyPrefixLen+keyFolderLen]), nil)
  365. defer dbi.Release()
  366. var fk []byte
  367. nextFile:
  368. for dbi.Next() {
  369. var vl VersionList
  370. err := vl.Unmarshal(dbi.Value())
  371. if err != nil {
  372. panic(err)
  373. }
  374. if len(vl.Versions) == 0 {
  375. l.Debugln(dbi.Key())
  376. panic("no versions?")
  377. }
  378. have := false // If we have the file, any version
  379. need := false // If we have a lower version of the file
  380. var haveVersion protocol.Vector
  381. for _, v := range vl.Versions {
  382. if bytes.Equal(v.Device, device) {
  383. have = true
  384. haveVersion = v.Version
  385. // XXX: This marks Concurrent (i.e. conflicting) changes as
  386. // needs. Maybe we should do that, but it needs special
  387. // handling in the puller.
  388. need = !v.Version.GreaterEqual(vl.Versions[0].Version)
  389. break
  390. }
  391. }
  392. if need || !have {
  393. name := db.globalKeyName(dbi.Key())
  394. needVersion := vl.Versions[0].Version
  395. nextVersion:
  396. for i := range vl.Versions {
  397. if !vl.Versions[i].Version.Equal(needVersion) {
  398. // We haven't found a valid copy of the file with the needed version.
  399. continue nextFile
  400. }
  401. fk = db.deviceKeyInto(fk[:cap(fk)], folder, vl.Versions[i].Device, name)
  402. bs, err := t.Get(fk, nil)
  403. if err != nil {
  404. var id protocol.DeviceID
  405. copy(id[:], device)
  406. l.Debugf("device: %v", id)
  407. l.Debugf("need: %v, have: %v", need, have)
  408. l.Debugf("key: %q (%x)", dbi.Key(), dbi.Key())
  409. l.Debugf("vl: %v", vl)
  410. l.Debugf("i: %v", i)
  411. l.Debugf("fk: %q (%x)", fk, fk)
  412. l.Debugf("name: %q (%x)", name, name)
  413. panic(err)
  414. }
  415. gf, err := unmarshalTrunc(bs, truncate)
  416. if err != nil {
  417. panic(err)
  418. }
  419. if gf.IsInvalid() {
  420. // The file is marked invalid for whatever reason, don't use it.
  421. continue nextVersion
  422. }
  423. if gf.IsDeleted() && !have {
  424. // We don't need deleted files that we don't have
  425. continue nextFile
  426. }
  427. l.Debugf("need folder=%q device=%v name=%q need=%v have=%v haveV=%d globalV=%d", folder, protocol.DeviceIDFromBytes(device), name, need, have, haveVersion, vl.Versions[0].Version)
  428. if cont := fn(gf); !cont {
  429. return
  430. }
  431. // This file is handled, no need to look further in the version list
  432. continue nextFile
  433. }
  434. }
  435. }
  436. }
  437. func (db *Instance) ListFolders() []string {
  438. t := db.newReadOnlyTransaction()
  439. defer t.close()
  440. dbi := t.NewIterator(util.BytesPrefix([]byte{KeyTypeGlobal}), nil)
  441. defer dbi.Release()
  442. folderExists := make(map[string]bool)
  443. for dbi.Next() {
  444. folder := string(db.globalKeyFolder(dbi.Key()))
  445. if !folderExists[folder] {
  446. folderExists[folder] = true
  447. }
  448. }
  449. folders := make([]string, 0, len(folderExists))
  450. for k := range folderExists {
  451. folders = append(folders, k)
  452. }
  453. sort.Strings(folders)
  454. return folders
  455. }
  456. func (db *Instance) dropFolder(folder []byte) {
  457. t := db.newReadOnlyTransaction()
  458. defer t.close()
  459. // Remove all items related to the given folder from the device->file bucket
  460. dbi := t.NewIterator(util.BytesPrefix([]byte{KeyTypeDevice}), nil)
  461. for dbi.Next() {
  462. itemFolder := db.deviceKeyFolder(dbi.Key())
  463. if bytes.Equal(folder, itemFolder) {
  464. db.Delete(dbi.Key(), nil)
  465. }
  466. }
  467. dbi.Release()
  468. // Remove all items related to the given folder from the global bucket
  469. dbi = t.NewIterator(util.BytesPrefix([]byte{KeyTypeGlobal}), nil)
  470. for dbi.Next() {
  471. itemFolder := db.globalKeyFolder(dbi.Key())
  472. if bytes.Equal(folder, itemFolder) {
  473. db.Delete(dbi.Key(), nil)
  474. }
  475. }
  476. dbi.Release()
  477. }
  478. func (db *Instance) checkGlobals(folder []byte, globalSize *sizeTracker) {
  479. t := db.newReadWriteTransaction()
  480. defer t.close()
  481. dbi := t.NewIterator(util.BytesPrefix(db.globalKey(folder, nil)[:keyPrefixLen+keyFolderLen]), nil)
  482. defer dbi.Release()
  483. var fk []byte
  484. for dbi.Next() {
  485. gk := dbi.Key()
  486. var vl VersionList
  487. err := vl.Unmarshal(dbi.Value())
  488. if err != nil {
  489. panic(err)
  490. }
  491. // Check the global version list for consistency. An issue in previous
  492. // versions of goleveldb could result in reordered writes so that
  493. // there are global entries pointing to no longer existing files. Here
  494. // we find those and clear them out.
  495. name := db.globalKeyName(gk)
  496. var newVL VersionList
  497. for i, version := range vl.Versions {
  498. fk = db.deviceKeyInto(fk[:cap(fk)], folder, version.Device, name)
  499. _, err := t.Get(fk, nil)
  500. if err == leveldb.ErrNotFound {
  501. continue
  502. }
  503. if err != nil {
  504. panic(err)
  505. }
  506. newVL.Versions = append(newVL.Versions, version)
  507. if i == 0 {
  508. fi, ok := t.getFile(folder, version.Device, name)
  509. if !ok {
  510. panic("nonexistent global master file")
  511. }
  512. globalSize.addFile(fi)
  513. }
  514. }
  515. if len(newVL.Versions) != len(vl.Versions) {
  516. t.Put(dbi.Key(), mustMarshal(&newVL))
  517. t.checkFlush()
  518. }
  519. }
  520. l.Debugf("db check completed for %q", folder)
  521. }
  522. // deviceKey returns a byte slice encoding the following information:
  523. // keyTypeDevice (1 byte)
  524. // folder (4 bytes)
  525. // device (4 bytes)
  526. // name (variable size)
  527. func (db *Instance) deviceKey(folder, device, file []byte) []byte {
  528. return db.deviceKeyInto(nil, folder, device, file)
  529. }
  530. func (db *Instance) deviceKeyInto(k []byte, folder, device, file []byte) []byte {
  531. reqLen := keyPrefixLen + keyFolderLen + keyDeviceLen + len(file)
  532. if len(k) < reqLen {
  533. k = make([]byte, reqLen)
  534. }
  535. k[0] = KeyTypeDevice
  536. binary.BigEndian.PutUint32(k[keyPrefixLen:], db.folderIdx.ID(folder))
  537. binary.BigEndian.PutUint32(k[keyPrefixLen+keyFolderLen:], db.deviceIdx.ID(device))
  538. copy(k[keyPrefixLen+keyFolderLen+keyDeviceLen:], []byte(file))
  539. return k[:reqLen]
  540. }
  541. // deviceKeyName returns the device ID from the key
  542. func (db *Instance) deviceKeyName(key []byte) []byte {
  543. return key[keyPrefixLen+keyFolderLen+keyDeviceLen:]
  544. }
  545. // deviceKeyFolder returns the folder name from the key
  546. func (db *Instance) deviceKeyFolder(key []byte) []byte {
  547. folder, ok := db.folderIdx.Val(binary.BigEndian.Uint32(key[keyPrefixLen:]))
  548. if !ok {
  549. panic("bug: lookup of nonexistent folder ID")
  550. }
  551. return folder
  552. }
  553. // deviceKeyDevice returns the device ID from the key
  554. func (db *Instance) deviceKeyDevice(key []byte) []byte {
  555. device, ok := db.deviceIdx.Val(binary.BigEndian.Uint32(key[keyPrefixLen+keyFolderLen:]))
  556. if !ok {
  557. panic("bug: lookup of nonexistent device ID")
  558. }
  559. return device
  560. }
  561. // globalKey returns a byte slice encoding the following information:
  562. // keyTypeGlobal (1 byte)
  563. // folder (4 bytes)
  564. // name (variable size)
  565. func (db *Instance) globalKey(folder, file []byte) []byte {
  566. k := make([]byte, keyPrefixLen+keyFolderLen+len(file))
  567. k[0] = KeyTypeGlobal
  568. binary.BigEndian.PutUint32(k[keyPrefixLen:], db.folderIdx.ID(folder))
  569. copy(k[keyPrefixLen+keyFolderLen:], []byte(file))
  570. return k
  571. }
  572. // globalKeyName returns the filename from the key
  573. func (db *Instance) globalKeyName(key []byte) []byte {
  574. return key[keyPrefixLen+keyFolderLen:]
  575. }
  576. // globalKeyFolder returns the folder name from the key
  577. func (db *Instance) globalKeyFolder(key []byte) []byte {
  578. folder, ok := db.folderIdx.Val(binary.BigEndian.Uint32(key[keyPrefixLen:]))
  579. if !ok {
  580. panic("bug: lookup of nonexistent folder ID")
  581. }
  582. return folder
  583. }
  584. func (db *Instance) getIndexID(device, folder []byte) protocol.IndexID {
  585. key := db.indexIDKey(device, folder)
  586. cur, err := db.Get(key, nil)
  587. if err != nil {
  588. return 0
  589. }
  590. var id protocol.IndexID
  591. if err := id.Unmarshal(cur); err != nil {
  592. return 0
  593. }
  594. return id
  595. }
  596. func (db *Instance) setIndexID(device, folder []byte, id protocol.IndexID) {
  597. key := db.indexIDKey(device, folder)
  598. bs, _ := id.Marshal() // marshalling can't fail
  599. if err := db.Put(key, bs, nil); err != nil {
  600. panic("storing index ID: " + err.Error())
  601. }
  602. }
  603. func (db *Instance) indexIDKey(device, folder []byte) []byte {
  604. k := make([]byte, keyPrefixLen+keyDeviceLen+keyFolderLen)
  605. k[0] = KeyTypeIndexID
  606. binary.BigEndian.PutUint32(k[keyPrefixLen:], db.deviceIdx.ID(device))
  607. binary.BigEndian.PutUint32(k[keyPrefixLen+keyDeviceLen:], db.folderIdx.ID(folder))
  608. return k
  609. }
  610. func unmarshalTrunc(bs []byte, truncate bool) (FileIntf, error) {
  611. if truncate {
  612. var tf FileInfoTruncated
  613. err := tf.Unmarshal(bs)
  614. return tf, err
  615. }
  616. var tf protocol.FileInfo
  617. err := tf.Unmarshal(bs)
  618. return tf, err
  619. }
  620. // A "better" version of leveldb's errors.IsCorrupted.
  621. func leveldbIsCorrupted(err error) bool {
  622. switch {
  623. case err == nil:
  624. return false
  625. case errors.IsCorrupted(err):
  626. return true
  627. case strings.Contains(err.Error(), "corrupted"):
  628. return true
  629. }
  630. return false
  631. }
  632. // A smallIndex is an in memory bidirectional []byte to uint32 map. It gives
  633. // fast lookups in both directions and persists to the database. Don't use for
  634. // storing more items than fit comfortably in RAM.
  635. type smallIndex struct {
  636. db *Instance
  637. prefix []byte
  638. id2val map[uint32]string
  639. val2id map[string]uint32
  640. nextID uint32
  641. mut sync.Mutex
  642. }
  643. func newSmallIndex(db *Instance, prefix []byte) *smallIndex {
  644. idx := &smallIndex{
  645. db: db,
  646. prefix: prefix,
  647. id2val: make(map[uint32]string),
  648. val2id: make(map[string]uint32),
  649. mut: sync.NewMutex(),
  650. }
  651. idx.load()
  652. return idx
  653. }
  654. // load iterates over the prefix space in the database and populates the in
  655. // memory maps.
  656. func (i *smallIndex) load() {
  657. tr := i.db.newReadOnlyTransaction()
  658. it := tr.NewIterator(util.BytesPrefix(i.prefix), nil)
  659. for it.Next() {
  660. val := string(it.Value())
  661. id := binary.BigEndian.Uint32(it.Key()[len(i.prefix):])
  662. i.id2val[id] = val
  663. i.val2id[val] = id
  664. if id >= i.nextID {
  665. i.nextID = id + 1
  666. }
  667. }
  668. it.Release()
  669. tr.close()
  670. }
  671. // ID returns the index number for the given byte slice, allocating a new one
  672. // and persisting this to the database if necessary.
  673. func (i *smallIndex) ID(val []byte) uint32 {
  674. i.mut.Lock()
  675. // intentionally avoiding defer here as we want this call to be as fast as
  676. // possible in the general case (folder ID already exists). The map lookup
  677. // with the conversion of []byte to string is compiler optimized to not
  678. // copy the []byte, which is why we don't assign it to a temp variable
  679. // here.
  680. if id, ok := i.val2id[string(val)]; ok {
  681. i.mut.Unlock()
  682. return id
  683. }
  684. id := i.nextID
  685. i.nextID++
  686. valStr := string(val)
  687. i.val2id[valStr] = id
  688. i.id2val[id] = valStr
  689. key := make([]byte, len(i.prefix)+8) // prefix plus uint32 id
  690. copy(key, i.prefix)
  691. binary.BigEndian.PutUint32(key[len(i.prefix):], id)
  692. i.db.Put(key, val, nil)
  693. i.mut.Unlock()
  694. return id
  695. }
  696. // Val returns the value for the given index number, or (nil, false) if there
  697. // is no such index number.
  698. func (i *smallIndex) Val(id uint32) ([]byte, bool) {
  699. i.mut.Lock()
  700. val, ok := i.id2val[id]
  701. i.mut.Unlock()
  702. if !ok {
  703. return nil, false
  704. }
  705. return []byte(val), true
  706. }