lowlevel.go 24 KB

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