lowlevel.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879
  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 https://mozilla.org/MPL/2.0/.
  6. package db
  7. import (
  8. "bytes"
  9. "encoding/binary"
  10. "time"
  11. "github.com/syncthing/syncthing/lib/db/backend"
  12. "github.com/syncthing/syncthing/lib/protocol"
  13. "github.com/syncthing/syncthing/lib/sync"
  14. "github.com/willf/bloom"
  15. )
  16. const (
  17. // We set the bloom filter capacity to handle 100k individual items with
  18. // a false positive probability of 1% for the first pass. Once we know
  19. // how many items we have we will use that number instead, if it's more
  20. // than 100k. For fewer than 100k items we will just get better false
  21. // positive rate instead.
  22. indirectGCBloomCapacity = 100000
  23. indirectGCBloomFalsePositiveRate = 0.01 // 1%
  24. indirectGCDefaultInterval = 13 * time.Hour
  25. indirectGCTimeKey = "lastIndirectGCTime"
  26. // Use indirection for the block list when it exceeds this many entries
  27. blocksIndirectionCutoff = 3
  28. recheckDefaultInterval = 30 * 24 * time.Hour
  29. )
  30. // Lowlevel is the lowest level database interface. It has a very simple
  31. // purpose: hold the actual backend database, and the in-memory state
  32. // that belong to that database. In the same way that a single on disk
  33. // database can only be opened once, there should be only one Lowlevel for
  34. // any given backend.
  35. type Lowlevel struct {
  36. backend.Backend
  37. folderIdx *smallIndex
  38. deviceIdx *smallIndex
  39. keyer keyer
  40. gcMut sync.RWMutex
  41. gcKeyCount int
  42. gcStop chan struct{}
  43. indirectGCInterval time.Duration
  44. recheckInterval time.Duration
  45. }
  46. func NewLowlevel(backend backend.Backend, opts ...Option) *Lowlevel {
  47. db := &Lowlevel{
  48. Backend: backend,
  49. folderIdx: newSmallIndex(backend, []byte{KeyTypeFolderIdx}),
  50. deviceIdx: newSmallIndex(backend, []byte{KeyTypeDeviceIdx}),
  51. gcMut: sync.NewRWMutex(),
  52. gcStop: make(chan struct{}),
  53. indirectGCInterval: indirectGCDefaultInterval,
  54. recheckInterval: recheckDefaultInterval,
  55. }
  56. for _, opt := range opts {
  57. opt(db)
  58. }
  59. db.keyer = newDefaultKeyer(db.folderIdx, db.deviceIdx)
  60. go db.gcRunner()
  61. return db
  62. }
  63. type Option func(*Lowlevel)
  64. // WithRecheckInterval sets the time interval in between metadata recalculations
  65. // and consistency checks.
  66. func WithRecheckInterval(dur time.Duration) Option {
  67. return func(db *Lowlevel) {
  68. if dur > 0 {
  69. db.recheckInterval = dur
  70. }
  71. }
  72. }
  73. // WithIndirectGCInterval sets the time interval in between GC runs.
  74. func WithIndirectGCInterval(dur time.Duration) Option {
  75. return func(db *Lowlevel) {
  76. if dur > 0 {
  77. db.indirectGCInterval = dur
  78. }
  79. }
  80. }
  81. func (db *Lowlevel) Close() error {
  82. close(db.gcStop)
  83. return db.Backend.Close()
  84. }
  85. // ListFolders returns the list of folders currently in the database
  86. func (db *Lowlevel) ListFolders() []string {
  87. return db.folderIdx.Values()
  88. }
  89. // updateRemoteFiles adds a list of fileinfos to the database and updates the
  90. // global versionlist and metadata.
  91. func (db *Lowlevel) updateRemoteFiles(folder, device []byte, fs []protocol.FileInfo, meta *metadataTracker) error {
  92. db.gcMut.RLock()
  93. defer db.gcMut.RUnlock()
  94. t, err := db.newReadWriteTransaction()
  95. if err != nil {
  96. return err
  97. }
  98. defer t.close()
  99. var dk, gk, keyBuf []byte
  100. devID := protocol.DeviceIDFromBytes(device)
  101. for _, f := range fs {
  102. name := []byte(f.Name)
  103. dk, err = db.keyer.GenerateDeviceFileKey(dk, folder, device, name)
  104. if err != nil {
  105. return err
  106. }
  107. ef, ok, err := t.getFileTrunc(dk, true)
  108. if err != nil {
  109. return err
  110. }
  111. if ok && unchanged(f, ef) {
  112. continue
  113. }
  114. if ok {
  115. meta.removeFile(devID, ef)
  116. }
  117. meta.addFile(devID, f)
  118. l.Debugf("insert; folder=%q device=%v %v", folder, devID, f)
  119. if err := t.putFile(dk, f, false); err != nil {
  120. return err
  121. }
  122. gk, err = db.keyer.GenerateGlobalVersionKey(gk, folder, name)
  123. if err != nil {
  124. return err
  125. }
  126. keyBuf, _, err = t.updateGlobal(gk, keyBuf, folder, device, f, meta)
  127. if err != nil {
  128. return err
  129. }
  130. if err := t.Checkpoint(func() error {
  131. return meta.toDB(t, folder)
  132. }); err != nil {
  133. return err
  134. }
  135. }
  136. if err := meta.toDB(t, folder); err != nil {
  137. return err
  138. }
  139. return t.Commit()
  140. }
  141. // updateLocalFiles adds fileinfos to the db, and updates the global versionlist,
  142. // metadata, sequence and blockmap buckets.
  143. func (db *Lowlevel) updateLocalFiles(folder []byte, fs []protocol.FileInfo, meta *metadataTracker) error {
  144. db.gcMut.RLock()
  145. defer db.gcMut.RUnlock()
  146. t, err := db.newReadWriteTransaction()
  147. if err != nil {
  148. return err
  149. }
  150. defer t.close()
  151. var dk, gk, keyBuf []byte
  152. blockBuf := make([]byte, 4)
  153. for _, f := range fs {
  154. name := []byte(f.Name)
  155. dk, err = db.keyer.GenerateDeviceFileKey(dk, folder, protocol.LocalDeviceID[:], name)
  156. if err != nil {
  157. return err
  158. }
  159. ef, ok, err := t.getFileByKey(dk)
  160. if err != nil {
  161. return err
  162. }
  163. if ok && unchanged(f, ef) {
  164. continue
  165. }
  166. if ok {
  167. if !ef.IsDirectory() && !ef.IsDeleted() && !ef.IsInvalid() {
  168. for _, block := range ef.Blocks {
  169. keyBuf, err = db.keyer.GenerateBlockMapKey(keyBuf, folder, block.Hash, name)
  170. if err != nil {
  171. return err
  172. }
  173. if err := t.Delete(keyBuf); err != nil {
  174. return err
  175. }
  176. }
  177. }
  178. keyBuf, err = db.keyer.GenerateSequenceKey(keyBuf, folder, ef.SequenceNo())
  179. if err != nil {
  180. return err
  181. }
  182. if err := t.Delete(keyBuf); err != nil {
  183. return err
  184. }
  185. l.Debugf("removing sequence; folder=%q sequence=%v %v", folder, ef.SequenceNo(), ef.FileName())
  186. }
  187. f.Sequence = meta.nextLocalSeq()
  188. if ok {
  189. meta.removeFile(protocol.LocalDeviceID, ef)
  190. }
  191. meta.addFile(protocol.LocalDeviceID, f)
  192. l.Debugf("insert (local); folder=%q %v", folder, f)
  193. if err := t.putFile(dk, f, false); err != nil {
  194. return err
  195. }
  196. gk, err = db.keyer.GenerateGlobalVersionKey(gk, folder, []byte(f.Name))
  197. if err != nil {
  198. return err
  199. }
  200. keyBuf, _, err = t.updateGlobal(gk, keyBuf, folder, protocol.LocalDeviceID[:], f, meta)
  201. if err != nil {
  202. return err
  203. }
  204. keyBuf, err = db.keyer.GenerateSequenceKey(keyBuf, folder, f.Sequence)
  205. if err != nil {
  206. return err
  207. }
  208. if err := t.Put(keyBuf, dk); err != nil {
  209. return err
  210. }
  211. l.Debugf("adding sequence; folder=%q sequence=%v %v", folder, f.Sequence, f.Name)
  212. if !f.IsDirectory() && !f.IsDeleted() && !f.IsInvalid() {
  213. for i, block := range f.Blocks {
  214. binary.BigEndian.PutUint32(blockBuf, uint32(i))
  215. keyBuf, err = db.keyer.GenerateBlockMapKey(keyBuf, folder, block.Hash, name)
  216. if err != nil {
  217. return err
  218. }
  219. if err := t.Put(keyBuf, blockBuf); err != nil {
  220. return err
  221. }
  222. }
  223. }
  224. if err := t.Checkpoint(func() error {
  225. return meta.toDB(t, folder)
  226. }); err != nil {
  227. return err
  228. }
  229. }
  230. if err := meta.toDB(t, folder); err != nil {
  231. return err
  232. }
  233. return t.Commit()
  234. }
  235. func (db *Lowlevel) dropFolder(folder []byte) error {
  236. db.gcMut.RLock()
  237. defer db.gcMut.RUnlock()
  238. t, err := db.newReadWriteTransaction()
  239. if err != nil {
  240. return err
  241. }
  242. defer t.close()
  243. // Remove all items related to the given folder from the device->file bucket
  244. k0, err := db.keyer.GenerateDeviceFileKey(nil, folder, nil, nil)
  245. if err != nil {
  246. return err
  247. }
  248. if err := t.deleteKeyPrefix(k0.WithoutNameAndDevice()); err != nil {
  249. return err
  250. }
  251. // Remove all sequences related to the folder
  252. k1, err := db.keyer.GenerateSequenceKey(nil, folder, 0)
  253. if err != nil {
  254. return err
  255. }
  256. if err := t.deleteKeyPrefix(k1.WithoutSequence()); err != nil {
  257. return err
  258. }
  259. // Remove all items related to the given folder from the global bucket
  260. k2, err := db.keyer.GenerateGlobalVersionKey(nil, folder, nil)
  261. if err != nil {
  262. return err
  263. }
  264. if err := t.deleteKeyPrefix(k2.WithoutName()); err != nil {
  265. return err
  266. }
  267. // Remove all needs related to the folder
  268. k3, err := db.keyer.GenerateNeedFileKey(nil, folder, nil)
  269. if err != nil {
  270. return err
  271. }
  272. if err := t.deleteKeyPrefix(k3.WithoutName()); err != nil {
  273. return err
  274. }
  275. // Remove the blockmap of the folder
  276. k4, err := db.keyer.GenerateBlockMapKey(nil, folder, nil, nil)
  277. if err != nil {
  278. return err
  279. }
  280. if err := t.deleteKeyPrefix(k4.WithoutHashAndName()); err != nil {
  281. return err
  282. }
  283. return t.Commit()
  284. }
  285. func (db *Lowlevel) dropDeviceFolder(device, folder []byte, meta *metadataTracker) error {
  286. db.gcMut.RLock()
  287. defer db.gcMut.RUnlock()
  288. t, err := db.newReadWriteTransaction()
  289. if err != nil {
  290. return err
  291. }
  292. defer t.close()
  293. key, err := db.keyer.GenerateDeviceFileKey(nil, folder, device, nil)
  294. if err != nil {
  295. return err
  296. }
  297. dbi, err := t.NewPrefixIterator(key)
  298. if err != nil {
  299. return err
  300. }
  301. var gk, keyBuf []byte
  302. for dbi.Next() {
  303. name := db.keyer.NameFromDeviceFileKey(dbi.Key())
  304. gk, err = db.keyer.GenerateGlobalVersionKey(gk, folder, name)
  305. if err != nil {
  306. return err
  307. }
  308. keyBuf, err = t.removeFromGlobal(gk, keyBuf, folder, device, name, meta)
  309. if err != nil {
  310. return err
  311. }
  312. if err := t.Delete(dbi.Key()); err != nil {
  313. return err
  314. }
  315. if err := t.Checkpoint(); err != nil {
  316. return err
  317. }
  318. }
  319. if err := dbi.Error(); err != nil {
  320. return err
  321. }
  322. dbi.Release()
  323. if bytes.Equal(device, protocol.LocalDeviceID[:]) {
  324. key, err := db.keyer.GenerateBlockMapKey(nil, folder, nil, nil)
  325. if err != nil {
  326. return err
  327. }
  328. if err := t.deleteKeyPrefix(key.WithoutHashAndName()); err != nil {
  329. return err
  330. }
  331. }
  332. return t.Commit()
  333. }
  334. func (db *Lowlevel) checkGlobals(folder []byte, meta *metadataTracker) error {
  335. t, err := db.newReadWriteTransaction()
  336. if err != nil {
  337. return err
  338. }
  339. defer t.close()
  340. key, err := db.keyer.GenerateGlobalVersionKey(nil, folder, nil)
  341. if err != nil {
  342. return err
  343. }
  344. dbi, err := t.NewPrefixIterator(key.WithoutName())
  345. if err != nil {
  346. return err
  347. }
  348. defer dbi.Release()
  349. var dk []byte
  350. for dbi.Next() {
  351. var vl VersionList
  352. if err := vl.Unmarshal(dbi.Value()); err != nil || len(vl.Versions) == 0 {
  353. if err := t.Delete(dbi.Key()); err != nil {
  354. return err
  355. }
  356. }
  357. // Check the global version list for consistency. An issue in previous
  358. // versions of goleveldb could result in reordered writes so that
  359. // there are global entries pointing to no longer existing files. Here
  360. // we find those and clear them out.
  361. name := db.keyer.NameFromGlobalVersionKey(dbi.Key())
  362. var newVL VersionList
  363. for i, version := range vl.Versions {
  364. dk, err = db.keyer.GenerateDeviceFileKey(dk, folder, version.Device, name)
  365. if err != nil {
  366. return err
  367. }
  368. _, err := t.Get(dk)
  369. if backend.IsNotFound(err) {
  370. continue
  371. }
  372. if err != nil {
  373. return err
  374. }
  375. newVL.Versions = append(newVL.Versions, version)
  376. if i == 0 {
  377. if fi, ok, err := t.getFileByKey(dk); err != nil {
  378. return err
  379. } else if ok {
  380. meta.addFile(protocol.GlobalDeviceID, fi)
  381. }
  382. }
  383. }
  384. if newLen := len(newVL.Versions); newLen == 0 {
  385. if err := t.Delete(dbi.Key()); err != nil {
  386. return err
  387. }
  388. } else if newLen != len(vl.Versions) {
  389. if err := t.Put(dbi.Key(), mustMarshal(&newVL)); err != nil {
  390. return err
  391. }
  392. }
  393. }
  394. if err := dbi.Error(); err != nil {
  395. return err
  396. }
  397. l.Debugf("db check completed for %q", folder)
  398. return t.Commit()
  399. }
  400. func (db *Lowlevel) getIndexID(device, folder []byte) (protocol.IndexID, error) {
  401. key, err := db.keyer.GenerateIndexIDKey(nil, device, folder)
  402. if err != nil {
  403. return 0, err
  404. }
  405. cur, err := db.Get(key)
  406. if backend.IsNotFound(err) {
  407. return 0, nil
  408. } else if err != nil {
  409. return 0, err
  410. }
  411. var id protocol.IndexID
  412. if err := id.Unmarshal(cur); err != nil {
  413. return 0, nil
  414. }
  415. return id, nil
  416. }
  417. func (db *Lowlevel) setIndexID(device, folder []byte, id protocol.IndexID) error {
  418. bs, _ := id.Marshal() // marshalling can't fail
  419. key, err := db.keyer.GenerateIndexIDKey(nil, device, folder)
  420. if err != nil {
  421. return err
  422. }
  423. return db.Put(key, bs)
  424. }
  425. func (db *Lowlevel) dropMtimes(folder []byte) error {
  426. key, err := db.keyer.GenerateMtimesKey(nil, folder)
  427. if err != nil {
  428. return err
  429. }
  430. return db.dropPrefix(key)
  431. }
  432. func (db *Lowlevel) dropFolderMeta(folder []byte) error {
  433. key, err := db.keyer.GenerateFolderMetaKey(nil, folder)
  434. if err != nil {
  435. return err
  436. }
  437. return db.dropPrefix(key)
  438. }
  439. func (db *Lowlevel) dropPrefix(prefix []byte) error {
  440. t, err := db.newReadWriteTransaction()
  441. if err != nil {
  442. return err
  443. }
  444. defer t.close()
  445. if err := t.deleteKeyPrefix(prefix); err != nil {
  446. return err
  447. }
  448. return t.Commit()
  449. }
  450. func (db *Lowlevel) gcRunner() {
  451. // Calculate the time for the next GC run. Even if we should run GC
  452. // directly, give the system a while to get up and running and do other
  453. // stuff first. (We might have migrations and stuff which would be
  454. // better off running before GC.)
  455. next := db.timeUntil(indirectGCTimeKey, db.indirectGCInterval)
  456. if next < time.Minute {
  457. next = time.Minute
  458. }
  459. t := time.NewTimer(next)
  460. defer t.Stop()
  461. for {
  462. select {
  463. case <-db.gcStop:
  464. return
  465. case <-t.C:
  466. if err := db.gcIndirect(); err != nil {
  467. l.Warnln("Database indirection GC failed:", err)
  468. }
  469. db.recordTime(indirectGCTimeKey)
  470. t.Reset(db.timeUntil(indirectGCTimeKey, db.indirectGCInterval))
  471. }
  472. }
  473. }
  474. // recordTime records the current time under the given key, affecting the
  475. // next call to timeUntil with the same key.
  476. func (db *Lowlevel) recordTime(key string) {
  477. miscDB := NewMiscDataNamespace(db)
  478. _ = miscDB.PutInt64(key, time.Now().Unix()) // error wilfully ignored
  479. }
  480. // timeUntil returns how long we should wait until the next interval, or
  481. // zero if it should happen directly.
  482. func (db *Lowlevel) timeUntil(key string, every time.Duration) time.Duration {
  483. miscDB := NewMiscDataNamespace(db)
  484. lastTime, _, _ := miscDB.Int64(key) // error wilfully ignored
  485. nextTime := time.Unix(lastTime, 0).Add(every)
  486. sleepTime := time.Until(nextTime)
  487. if sleepTime < 0 {
  488. sleepTime = 0
  489. }
  490. return sleepTime
  491. }
  492. func (db *Lowlevel) gcIndirect() error {
  493. // The indirection GC uses bloom filters to track used block lists and
  494. // versions. This means iterating over all items, adding their hashes to
  495. // the filter, then iterating over the indirected items and removing
  496. // those that don't match the filter. The filter will give false
  497. // positives so we will keep around one percent of things that we don't
  498. // really need (at most).
  499. //
  500. // Indirection GC needs to run when there are no modifications to the
  501. // FileInfos or indirected items.
  502. db.gcMut.Lock()
  503. defer db.gcMut.Unlock()
  504. t, err := db.newReadWriteTransaction()
  505. if err != nil {
  506. return err
  507. }
  508. defer t.Release()
  509. // Set up the bloom filters with the initial capacity and false positive
  510. // rate, or higher capacity if we've done this before and seen lots of
  511. // items. For simplicity's sake we track just one count, which is the
  512. // highest of the various indirected items.
  513. capacity := indirectGCBloomCapacity
  514. if db.gcKeyCount > capacity {
  515. capacity = db.gcKeyCount
  516. }
  517. blockFilter := bloom.NewWithEstimates(uint(capacity), indirectGCBloomFalsePositiveRate)
  518. // Iterate the FileInfos, unmarshal the block and version hashes and
  519. // add them to the filter.
  520. it, err := t.NewPrefixIterator([]byte{KeyTypeDevice})
  521. if err != nil {
  522. return err
  523. }
  524. defer it.Release()
  525. for it.Next() {
  526. var bl BlocksHashOnly
  527. if err := bl.Unmarshal(it.Value()); err != nil {
  528. return err
  529. }
  530. if len(bl.BlocksHash) > 0 {
  531. blockFilter.Add(bl.BlocksHash)
  532. }
  533. }
  534. it.Release()
  535. if err := it.Error(); err != nil {
  536. return err
  537. }
  538. // Iterate over block lists, removing keys with hashes that don't match
  539. // the filter.
  540. it, err = t.NewPrefixIterator([]byte{KeyTypeBlockList})
  541. if err != nil {
  542. return err
  543. }
  544. defer it.Release()
  545. matchedBlocks := 0
  546. for it.Next() {
  547. key := blockListKey(it.Key())
  548. if blockFilter.Test(key.BlocksHash()) {
  549. matchedBlocks++
  550. continue
  551. }
  552. if err := t.Delete(key); err != nil {
  553. return err
  554. }
  555. }
  556. it.Release()
  557. if err := it.Error(); err != nil {
  558. return err
  559. }
  560. // Remember the number of unique keys we kept until the next pass.
  561. db.gcKeyCount = matchedBlocks
  562. if err := t.Commit(); err != nil {
  563. return err
  564. }
  565. return db.Compact()
  566. }
  567. // CheckRepair checks folder metadata and sequences for miscellaneous errors.
  568. func (db *Lowlevel) CheckRepair() {
  569. for _, folder := range db.ListFolders() {
  570. _ = db.getMetaAndCheck(folder)
  571. }
  572. }
  573. func (db *Lowlevel) getMetaAndCheck(folder string) *metadataTracker {
  574. db.gcMut.RLock()
  575. defer db.gcMut.RUnlock()
  576. meta, err := db.recalcMeta(folder)
  577. if err == nil {
  578. var fixed int
  579. fixed, err = db.repairSequenceGCLocked(folder, meta)
  580. if fixed != 0 {
  581. l.Infof("Repaired %d sequence entries in database", fixed)
  582. }
  583. }
  584. if backend.IsClosed(err) {
  585. return nil
  586. } else if err != nil {
  587. panic(err)
  588. }
  589. return meta
  590. }
  591. func (db *Lowlevel) loadMetadataTracker(folder string) *metadataTracker {
  592. meta := newMetadataTracker()
  593. if err := meta.fromDB(db, []byte(folder)); err != nil {
  594. l.Infof("No stored folder metadata for %q; recalculating", folder)
  595. return db.getMetaAndCheck(folder)
  596. }
  597. curSeq := meta.Sequence(protocol.LocalDeviceID)
  598. if metaOK := db.verifyLocalSequence(curSeq, folder); !metaOK {
  599. l.Infof("Stored folder metadata for %q is out of date after crash; recalculating", folder)
  600. return db.getMetaAndCheck(folder)
  601. }
  602. if age := time.Since(meta.Created()); age > db.recheckInterval {
  603. l.Infof("Stored folder metadata for %q is %v old; recalculating", folder, age)
  604. return db.getMetaAndCheck(folder)
  605. }
  606. return meta
  607. }
  608. func (db *Lowlevel) recalcMeta(folder string) (*metadataTracker, error) {
  609. meta := newMetadataTracker()
  610. if err := db.checkGlobals([]byte(folder), meta); err != nil {
  611. return nil, err
  612. }
  613. t, err := db.newReadWriteTransaction()
  614. if err != nil {
  615. return nil, err
  616. }
  617. defer t.close()
  618. var deviceID protocol.DeviceID
  619. err = t.withAllFolderTruncated([]byte(folder), func(device []byte, f FileInfoTruncated) bool {
  620. copy(deviceID[:], device)
  621. meta.addFile(deviceID, f)
  622. return true
  623. })
  624. if err != nil {
  625. return nil, err
  626. }
  627. meta.SetCreated()
  628. if err := meta.toDB(t, []byte(folder)); err != nil {
  629. return nil, err
  630. }
  631. if err := t.Commit(); err != nil {
  632. return nil, err
  633. }
  634. return meta, nil
  635. }
  636. // Verify the local sequence number from actual sequence entries. Returns
  637. // true if it was all good, or false if a fixup was necessary.
  638. func (db *Lowlevel) verifyLocalSequence(curSeq int64, folder string) bool {
  639. // Walk the sequence index from the current (supposedly) highest
  640. // sequence number and raise the alarm if we get anything. This recovers
  641. // from the occasion where we have written sequence entries to disk but
  642. // not yet written new metadata to disk.
  643. //
  644. // Note that we can have the same thing happen for remote devices but
  645. // there it's not a problem -- we'll simply advertise a lower sequence
  646. // number than we've actually seen and receive some duplicate updates
  647. // and then be in sync again.
  648. t, err := db.newReadOnlyTransaction()
  649. if err != nil {
  650. panic(err)
  651. }
  652. ok := true
  653. if err := t.withHaveSequence([]byte(folder), curSeq+1, func(fi FileIntf) bool {
  654. ok = false // we got something, which we should not have
  655. return false
  656. }); err != nil && !backend.IsClosed(err) {
  657. panic(err)
  658. }
  659. t.close()
  660. return ok
  661. }
  662. // repairSequenceGCLocked makes sure the sequence numbers in the sequence keys
  663. // match those in the corresponding file entries. It returns the amount of fixed
  664. // entries.
  665. func (db *Lowlevel) repairSequenceGCLocked(folderStr string, meta *metadataTracker) (int, error) {
  666. t, err := db.newReadWriteTransaction()
  667. if err != nil {
  668. return 0, err
  669. }
  670. defer t.close()
  671. fixed := 0
  672. folder := []byte(folderStr)
  673. // First check that every file entry has a matching sequence entry
  674. // (this was previously db schema upgrade to 9).
  675. dk, err := t.keyer.GenerateDeviceFileKey(nil, folder, protocol.LocalDeviceID[:], nil)
  676. if err != nil {
  677. return 0, err
  678. }
  679. it, err := t.NewPrefixIterator(dk.WithoutName())
  680. if err != nil {
  681. return 0, err
  682. }
  683. defer it.Release()
  684. var sk sequenceKey
  685. for it.Next() {
  686. intf, err := t.unmarshalTrunc(it.Value(), true)
  687. if err != nil {
  688. return 0, err
  689. }
  690. fi := intf.(FileInfoTruncated)
  691. if sk, err = t.keyer.GenerateSequenceKey(sk, folder, fi.Sequence); err != nil {
  692. return 0, err
  693. }
  694. switch dk, err = t.Get(sk); {
  695. case err != nil:
  696. if !backend.IsNotFound(err) {
  697. return 0, err
  698. }
  699. fallthrough
  700. case !bytes.Equal(it.Key(), dk):
  701. fixed++
  702. fi.Sequence = meta.nextLocalSeq()
  703. if sk, err = t.keyer.GenerateSequenceKey(sk, folder, fi.Sequence); err != nil {
  704. return 0, err
  705. }
  706. if err := t.Put(sk, it.Key()); err != nil {
  707. return 0, err
  708. }
  709. if err := t.putFile(it.Key(), fi.copyToFileInfo(), true); err != nil {
  710. return 0, err
  711. }
  712. }
  713. if err := t.Checkpoint(func() error {
  714. return meta.toDB(t, folder)
  715. }); err != nil {
  716. return 0, err
  717. }
  718. }
  719. if err := it.Error(); err != nil {
  720. return 0, err
  721. }
  722. it.Release()
  723. // Secondly check there's no sequence entries pointing at incorrect things.
  724. sk, err = t.keyer.GenerateSequenceKey(sk, folder, 0)
  725. if err != nil {
  726. return 0, err
  727. }
  728. it, err = t.NewPrefixIterator(sk.WithoutSequence())
  729. if err != nil {
  730. return 0, err
  731. }
  732. defer it.Release()
  733. for it.Next() {
  734. // Check that the sequence from the key matches the
  735. // sequence in the file.
  736. fi, ok, err := t.getFileTrunc(it.Value(), true)
  737. if err != nil {
  738. return 0, err
  739. }
  740. if ok {
  741. if seq := t.keyer.SequenceFromSequenceKey(it.Key()); seq == fi.SequenceNo() {
  742. continue
  743. }
  744. }
  745. // Either the file is missing or has a different sequence number
  746. fixed++
  747. if err := t.Delete(it.Key()); err != nil {
  748. return 0, err
  749. }
  750. }
  751. if err := it.Error(); err != nil {
  752. return 0, err
  753. }
  754. it.Release()
  755. if err := meta.toDB(t, folder); err != nil {
  756. return 0, err
  757. }
  758. return fixed, t.Commit()
  759. }
  760. // unchanged checks if two files are the same and thus don't need to be updated.
  761. // Local flags or the invalid bit might change without the version
  762. // being bumped.
  763. func unchanged(nf, ef FileIntf) bool {
  764. return ef.FileVersion().Equal(nf.FileVersion()) && ef.IsInvalid() == nf.IsInvalid() && ef.FileLocalFlags() == nf.FileLocalFlags()
  765. }