transactions.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966
  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. "errors"
  10. "fmt"
  11. "github.com/syncthing/syncthing/lib/db/backend"
  12. "github.com/syncthing/syncthing/lib/osutil"
  13. "github.com/syncthing/syncthing/lib/protocol"
  14. )
  15. var (
  16. errEntryFromGlobalMissing = errors.New("device present in global list but missing as device/fileinfo entry")
  17. errEmptyGlobal = errors.New("no versions in global list")
  18. errEmptyFileVersion = errors.New("no devices in global file version")
  19. )
  20. // A readOnlyTransaction represents a database snapshot.
  21. type readOnlyTransaction struct {
  22. backend.ReadTransaction
  23. keyer keyer
  24. }
  25. func (db *Lowlevel) newReadOnlyTransaction() (readOnlyTransaction, error) {
  26. tran, err := db.NewReadTransaction()
  27. if err != nil {
  28. return readOnlyTransaction{}, err
  29. }
  30. return readOnlyTransaction{
  31. ReadTransaction: tran,
  32. keyer: db.keyer,
  33. }, nil
  34. }
  35. func (t readOnlyTransaction) close() {
  36. t.Release()
  37. }
  38. func (t readOnlyTransaction) getFile(folder, device, file []byte) (protocol.FileInfo, bool, error) {
  39. key, err := t.keyer.GenerateDeviceFileKey(nil, folder, device, file)
  40. if err != nil {
  41. return protocol.FileInfo{}, false, err
  42. }
  43. return t.getFileByKey(key)
  44. }
  45. func (t readOnlyTransaction) getFileByKey(key []byte) (protocol.FileInfo, bool, error) {
  46. f, ok, err := t.getFileTrunc(key, false)
  47. if err != nil || !ok {
  48. return protocol.FileInfo{}, false, err
  49. }
  50. return f.(protocol.FileInfo), true, nil
  51. }
  52. func (t readOnlyTransaction) getFileTrunc(key []byte, trunc bool) (protocol.FileIntf, bool, error) {
  53. bs, err := t.Get(key)
  54. if backend.IsNotFound(err) {
  55. return nil, false, nil
  56. }
  57. if err != nil {
  58. return nil, false, err
  59. }
  60. f, err := t.unmarshalTrunc(bs, trunc)
  61. if backend.IsNotFound(err) {
  62. return nil, false, nil
  63. }
  64. if err != nil {
  65. return nil, false, err
  66. }
  67. return f, true, nil
  68. }
  69. func (t readOnlyTransaction) unmarshalTrunc(bs []byte, trunc bool) (protocol.FileIntf, error) {
  70. if trunc {
  71. var tf FileInfoTruncated
  72. err := tf.Unmarshal(bs)
  73. if err != nil {
  74. return nil, err
  75. }
  76. if err := t.fillTruncated(&tf); err != nil {
  77. return nil, err
  78. }
  79. return tf, nil
  80. }
  81. var fi protocol.FileInfo
  82. if err := fi.Unmarshal(bs); err != nil {
  83. return nil, err
  84. }
  85. if err := t.fillFileInfo(&fi); err != nil {
  86. return nil, err
  87. }
  88. return fi, nil
  89. }
  90. // fillFileInfo follows the (possible) indirection of blocks and version
  91. // vector and fills it out.
  92. func (t readOnlyTransaction) fillFileInfo(fi *protocol.FileInfo) error {
  93. var key []byte
  94. if len(fi.Blocks) == 0 && len(fi.BlocksHash) != 0 {
  95. // The blocks list is indirected and we need to load it.
  96. key = t.keyer.GenerateBlockListKey(key, fi.BlocksHash)
  97. bs, err := t.Get(key)
  98. if err != nil {
  99. return fmt.Errorf("filling Blocks: %w", err)
  100. }
  101. var bl BlockList
  102. if err := bl.Unmarshal(bs); err != nil {
  103. return err
  104. }
  105. fi.Blocks = bl.Blocks
  106. }
  107. if len(fi.VersionHash) != 0 {
  108. key = t.keyer.GenerateVersionKey(key, fi.VersionHash)
  109. bs, err := t.Get(key)
  110. if err != nil {
  111. return fmt.Errorf("filling Version: %w", err)
  112. }
  113. var v protocol.Vector
  114. if err := v.Unmarshal(bs); err != nil {
  115. return err
  116. }
  117. fi.Version = v
  118. }
  119. return nil
  120. }
  121. // fillTruncated follows the (possible) indirection of version vector and
  122. // fills it.
  123. func (t readOnlyTransaction) fillTruncated(fi *FileInfoTruncated) error {
  124. var key []byte
  125. if len(fi.VersionHash) == 0 {
  126. return nil
  127. }
  128. key = t.keyer.GenerateVersionKey(key, fi.VersionHash)
  129. bs, err := t.Get(key)
  130. if err != nil {
  131. return err
  132. }
  133. var v protocol.Vector
  134. if err := v.Unmarshal(bs); err != nil {
  135. return err
  136. }
  137. fi.Version = v
  138. return nil
  139. }
  140. func (t readOnlyTransaction) getGlobalVersions(keyBuf, folder, file []byte) (VersionList, error) {
  141. var err error
  142. keyBuf, err = t.keyer.GenerateGlobalVersionKey(keyBuf, folder, file)
  143. if err != nil {
  144. return VersionList{}, err
  145. }
  146. return t.getGlobalVersionsByKey(keyBuf)
  147. }
  148. func (t readOnlyTransaction) getGlobalVersionsByKey(key []byte) (VersionList, error) {
  149. bs, err := t.Get(key)
  150. if err != nil {
  151. return VersionList{}, err
  152. }
  153. var vl VersionList
  154. if err := vl.Unmarshal(bs); err != nil {
  155. return VersionList{}, err
  156. }
  157. return vl, nil
  158. }
  159. func (t readOnlyTransaction) getGlobal(keyBuf, folder, file []byte, truncate bool) ([]byte, protocol.FileIntf, bool, error) {
  160. vl, err := t.getGlobalVersions(keyBuf, folder, file)
  161. if backend.IsNotFound(err) {
  162. return keyBuf, nil, false, nil
  163. } else if err != nil {
  164. return nil, nil, false, err
  165. }
  166. var fi protocol.FileIntf
  167. keyBuf, fi, _, err = t.getGlobalFromVersionList(keyBuf, folder, file, truncate, vl)
  168. return keyBuf, fi, true, err
  169. }
  170. func (t readOnlyTransaction) getGlobalFromVersionList(keyBuf, folder, file []byte, truncate bool, vl VersionList) ([]byte, protocol.FileIntf, FileVersion, error) {
  171. fv, ok := vl.GetGlobal()
  172. if !ok {
  173. return keyBuf, nil, FileVersion{}, errEmptyGlobal
  174. }
  175. keyBuf, fi, err := t.getGlobalFromFileVersion(keyBuf, folder, file, truncate, fv)
  176. return keyBuf, fi, fv, err
  177. }
  178. func (t readOnlyTransaction) getGlobalFromFileVersion(keyBuf, folder, file []byte, truncate bool, fv FileVersion) ([]byte, protocol.FileIntf, error) {
  179. dev, ok := fv.FirstDevice()
  180. if !ok {
  181. return keyBuf, nil, errEmptyFileVersion
  182. }
  183. keyBuf, err := t.keyer.GenerateDeviceFileKey(keyBuf, folder, dev, file)
  184. if err != nil {
  185. return keyBuf, nil, err
  186. }
  187. fi, ok, err := t.getFileTrunc(keyBuf, truncate)
  188. if err != nil {
  189. return keyBuf, nil, err
  190. }
  191. if !ok {
  192. return keyBuf, nil, errEntryFromGlobalMissing
  193. }
  194. return keyBuf, fi, nil
  195. }
  196. func (t *readOnlyTransaction) withHave(folder, device, prefix []byte, truncate bool, fn Iterator) error {
  197. if len(prefix) > 0 {
  198. unslashedPrefix := prefix
  199. if bytes.HasSuffix(prefix, []byte{'/'}) {
  200. unslashedPrefix = unslashedPrefix[:len(unslashedPrefix)-1]
  201. } else {
  202. prefix = append(prefix, '/')
  203. }
  204. key, err := t.keyer.GenerateDeviceFileKey(nil, folder, device, unslashedPrefix)
  205. if err != nil {
  206. return err
  207. }
  208. if f, ok, err := t.getFileTrunc(key, truncate); err != nil {
  209. return err
  210. } else if ok && !fn(f) {
  211. return nil
  212. }
  213. }
  214. key, err := t.keyer.GenerateDeviceFileKey(nil, folder, device, prefix)
  215. if err != nil {
  216. return err
  217. }
  218. dbi, err := t.NewPrefixIterator(key)
  219. if err != nil {
  220. return err
  221. }
  222. defer dbi.Release()
  223. for dbi.Next() {
  224. name := t.keyer.NameFromDeviceFileKey(dbi.Key())
  225. if len(prefix) > 0 && !bytes.HasPrefix(name, prefix) {
  226. return nil
  227. }
  228. f, err := t.unmarshalTrunc(dbi.Value(), truncate)
  229. if err != nil {
  230. l.Debugln("unmarshal error:", err)
  231. continue
  232. }
  233. if !fn(f) {
  234. return nil
  235. }
  236. }
  237. return dbi.Error()
  238. }
  239. func (t *readOnlyTransaction) withHaveSequence(folder []byte, startSeq int64, fn Iterator) error {
  240. first, err := t.keyer.GenerateSequenceKey(nil, folder, startSeq)
  241. if err != nil {
  242. return err
  243. }
  244. last, err := t.keyer.GenerateSequenceKey(nil, folder, maxInt64)
  245. if err != nil {
  246. return err
  247. }
  248. dbi, err := t.NewRangeIterator(first, last)
  249. if err != nil {
  250. return err
  251. }
  252. defer dbi.Release()
  253. for dbi.Next() {
  254. f, ok, err := t.getFileByKey(dbi.Value())
  255. if err != nil {
  256. return err
  257. }
  258. if !ok {
  259. l.Debugln("missing file for sequence number", t.keyer.SequenceFromSequenceKey(dbi.Key()))
  260. continue
  261. }
  262. if shouldDebug() {
  263. if seq := t.keyer.SequenceFromSequenceKey(dbi.Key()); f.Sequence != seq {
  264. l.Debugf("Sequence index corruption (folder %v, file %v): sequence %d != expected %d", string(folder), f.Name, f.Sequence, seq)
  265. }
  266. }
  267. if !fn(f) {
  268. return nil
  269. }
  270. }
  271. return dbi.Error()
  272. }
  273. func (t *readOnlyTransaction) withGlobal(folder, prefix []byte, truncate bool, fn Iterator) error {
  274. if len(prefix) > 0 {
  275. unslashedPrefix := prefix
  276. if bytes.HasSuffix(prefix, []byte{'/'}) {
  277. unslashedPrefix = unslashedPrefix[:len(unslashedPrefix)-1]
  278. } else {
  279. prefix = append(prefix, '/')
  280. }
  281. if _, f, ok, err := t.getGlobal(nil, folder, unslashedPrefix, truncate); err != nil {
  282. return err
  283. } else if ok && !fn(f) {
  284. return nil
  285. }
  286. }
  287. key, err := t.keyer.GenerateGlobalVersionKey(nil, folder, prefix)
  288. if err != nil {
  289. return err
  290. }
  291. dbi, err := t.NewPrefixIterator(key)
  292. if err != nil {
  293. return err
  294. }
  295. defer dbi.Release()
  296. var dk []byte
  297. for dbi.Next() {
  298. name := t.keyer.NameFromGlobalVersionKey(dbi.Key())
  299. if len(prefix) > 0 && !bytes.HasPrefix(name, prefix) {
  300. return nil
  301. }
  302. var vl VersionList
  303. if err := vl.Unmarshal(dbi.Value()); err != nil {
  304. return err
  305. }
  306. var f protocol.FileIntf
  307. dk, f, _, err = t.getGlobalFromVersionList(dk, folder, name, truncate, vl)
  308. if err != nil {
  309. return err
  310. }
  311. if !fn(f) {
  312. return nil
  313. }
  314. }
  315. if err != nil {
  316. return err
  317. }
  318. return dbi.Error()
  319. }
  320. func (t *readOnlyTransaction) withBlocksHash(folder, hash []byte, iterator Iterator) error {
  321. key, err := t.keyer.GenerateBlockListMapKey(nil, folder, hash, nil)
  322. if err != nil {
  323. return err
  324. }
  325. iter, err := t.NewPrefixIterator(key)
  326. if err != nil {
  327. return err
  328. }
  329. defer iter.Release()
  330. for iter.Next() {
  331. file := string(t.keyer.NameFromBlockListMapKey(iter.Key()))
  332. f, ok, err := t.getFile(folder, protocol.LocalDeviceID[:], []byte(osutil.NormalizedFilename(file)))
  333. if err != nil {
  334. return err
  335. }
  336. if !ok {
  337. continue
  338. }
  339. f.Name = osutil.NativeFilename(f.Name)
  340. if !bytes.Equal(f.BlocksHash, hash) {
  341. l.Warnf("Mismatching block map list hashes: got %x expected %x", f.BlocksHash, hash)
  342. continue
  343. }
  344. if f.IsDeleted() || f.IsInvalid() || f.IsDirectory() || f.IsSymlink() {
  345. l.Warnf("Found something of unexpected type in block list map: %s", f)
  346. continue
  347. }
  348. if !iterator(f) {
  349. break
  350. }
  351. }
  352. return iter.Error()
  353. }
  354. func (t *readOnlyTransaction) availability(folder, file []byte) ([]protocol.DeviceID, error) {
  355. vl, err := t.getGlobalVersions(nil, folder, file)
  356. if backend.IsNotFound(err) {
  357. return nil, nil
  358. }
  359. if err != nil {
  360. return nil, err
  361. }
  362. fv, ok := vl.GetGlobal()
  363. if !ok {
  364. return nil, nil
  365. }
  366. devices := make([]protocol.DeviceID, len(fv.Devices))
  367. for i, dev := range fv.Devices {
  368. n, err := protocol.DeviceIDFromBytes(dev)
  369. if err != nil {
  370. return nil, err
  371. }
  372. devices[i] = n
  373. }
  374. return devices, nil
  375. }
  376. func (t *readOnlyTransaction) withNeed(folder, device []byte, truncate bool, fn Iterator) error {
  377. if bytes.Equal(device, protocol.LocalDeviceID[:]) {
  378. return t.withNeedLocal(folder, truncate, fn)
  379. }
  380. return t.withNeedIteratingGlobal(folder, device, truncate, fn)
  381. }
  382. func (t *readOnlyTransaction) withNeedIteratingGlobal(folder, device []byte, truncate bool, fn Iterator) error {
  383. key, err := t.keyer.GenerateGlobalVersionKey(nil, folder, nil)
  384. if err != nil {
  385. return err
  386. }
  387. dbi, err := t.NewPrefixIterator(key.WithoutName())
  388. if err != nil {
  389. return err
  390. }
  391. defer dbi.Release()
  392. var dk []byte
  393. devID, err := protocol.DeviceIDFromBytes(device)
  394. if err != nil {
  395. return err
  396. }
  397. for dbi.Next() {
  398. var vl VersionList
  399. if err := vl.Unmarshal(dbi.Value()); err != nil {
  400. return err
  401. }
  402. globalFV, ok := vl.GetGlobal()
  403. if !ok {
  404. return errEmptyGlobal
  405. }
  406. haveFV, have := vl.Get(device)
  407. if !Need(globalFV, have, haveFV.Version) {
  408. continue
  409. }
  410. name := t.keyer.NameFromGlobalVersionKey(dbi.Key())
  411. var gf protocol.FileIntf
  412. dk, gf, err = t.getGlobalFromFileVersion(dk, folder, name, truncate, globalFV)
  413. if err != nil {
  414. return err
  415. }
  416. if shouldDebug() {
  417. if globalDev, ok := globalFV.FirstDevice(); ok {
  418. globalID, _ := protocol.DeviceIDFromBytes(globalDev)
  419. l.Debugf("need folder=%q device=%v name=%q have=%v invalid=%v haveV=%v globalV=%v globalDev=%v", folder, devID, name, have, haveFV.IsInvalid(), haveFV.Version, gf.FileVersion(), globalID)
  420. }
  421. }
  422. if !fn(gf) {
  423. return dbi.Error()
  424. }
  425. }
  426. return dbi.Error()
  427. }
  428. func (t *readOnlyTransaction) withNeedLocal(folder []byte, truncate bool, fn Iterator) error {
  429. key, err := t.keyer.GenerateNeedFileKey(nil, folder, nil)
  430. if err != nil {
  431. return err
  432. }
  433. dbi, err := t.NewPrefixIterator(key.WithoutName())
  434. if err != nil {
  435. return err
  436. }
  437. defer dbi.Release()
  438. var keyBuf []byte
  439. var f protocol.FileIntf
  440. var ok bool
  441. for dbi.Next() {
  442. keyBuf, f, ok, err = t.getGlobal(keyBuf, folder, t.keyer.NameFromGlobalVersionKey(dbi.Key()), truncate)
  443. if err != nil {
  444. return err
  445. }
  446. if !ok {
  447. continue
  448. }
  449. if !fn(f) {
  450. return nil
  451. }
  452. }
  453. return dbi.Error()
  454. }
  455. // A readWriteTransaction is a readOnlyTransaction plus a batch for writes.
  456. // The batch will be committed on close() or by checkFlush() if it exceeds the
  457. // batch size.
  458. type readWriteTransaction struct {
  459. backend.WriteTransaction
  460. readOnlyTransaction
  461. }
  462. func (db *Lowlevel) newReadWriteTransaction(hooks ...backend.CommitHook) (readWriteTransaction, error) {
  463. tran, err := db.NewWriteTransaction(hooks...)
  464. if err != nil {
  465. return readWriteTransaction{}, err
  466. }
  467. return readWriteTransaction{
  468. WriteTransaction: tran,
  469. readOnlyTransaction: readOnlyTransaction{
  470. ReadTransaction: tran,
  471. keyer: db.keyer,
  472. },
  473. }, nil
  474. }
  475. func (t readWriteTransaction) Commit() error {
  476. // The readOnlyTransaction must close after commit, because they may be
  477. // backed by the same actual lower level transaction.
  478. defer t.readOnlyTransaction.close()
  479. return t.WriteTransaction.Commit()
  480. }
  481. func (t readWriteTransaction) close() {
  482. t.readOnlyTransaction.close()
  483. t.WriteTransaction.Release()
  484. }
  485. // putFile stores a file in the database, taking care of indirected fields.
  486. func (t readWriteTransaction) putFile(fkey []byte, fi protocol.FileInfo) error {
  487. var bkey []byte
  488. // Always set the blocks hash when there are blocks.
  489. if len(fi.Blocks) > 0 {
  490. fi.BlocksHash = protocol.BlocksHash(fi.Blocks)
  491. } else {
  492. fi.BlocksHash = nil
  493. }
  494. // Indirect the blocks if the block list is large enough.
  495. if len(fi.Blocks) > blocksIndirectionCutoff {
  496. bkey = t.keyer.GenerateBlockListKey(bkey, fi.BlocksHash)
  497. if _, err := t.Get(bkey); backend.IsNotFound(err) {
  498. // Marshal the block list and save it
  499. blocksBs := mustMarshal(&BlockList{Blocks: fi.Blocks})
  500. if err := t.Put(bkey, blocksBs); err != nil {
  501. return err
  502. }
  503. } else if err != nil {
  504. return err
  505. }
  506. fi.Blocks = nil
  507. }
  508. // Indirect the version vector if it's large enough.
  509. if len(fi.Version.Counters) > versionIndirectionCutoff {
  510. fi.VersionHash = protocol.VectorHash(fi.Version)
  511. bkey = t.keyer.GenerateVersionKey(bkey, fi.VersionHash)
  512. if _, err := t.Get(bkey); backend.IsNotFound(err) {
  513. // Marshal the version vector and save it
  514. versionBs := mustMarshal(&fi.Version)
  515. if err := t.Put(bkey, versionBs); err != nil {
  516. return err
  517. }
  518. } else if err != nil {
  519. return err
  520. }
  521. fi.Version = protocol.Vector{}
  522. } else {
  523. fi.VersionHash = nil
  524. }
  525. fiBs := mustMarshal(&fi)
  526. return t.Put(fkey, fiBs)
  527. }
  528. // updateGlobal adds this device+version to the version list for the given
  529. // file. If the device is already present in the list, the version is updated.
  530. // If the file does not have an entry in the global list, it is created.
  531. func (t readWriteTransaction) updateGlobal(gk, keyBuf, folder, device []byte, file protocol.FileInfo, meta *metadataTracker) ([]byte, bool, error) {
  532. deviceID, err := protocol.DeviceIDFromBytes(device)
  533. if err != nil {
  534. return nil, false, err
  535. }
  536. l.Debugf("update global; folder=%q device=%v file=%q version=%v invalid=%v", folder, deviceID, file.Name, file.Version, file.IsInvalid())
  537. fl, err := t.getGlobalVersionsByKey(gk)
  538. if err != nil && !backend.IsNotFound(err) {
  539. return nil, false, err
  540. }
  541. globalFV, oldGlobalFV, removedFV, haveOldGlobal, haveRemoved, globalChanged, err := fl.update(folder, device, file, t.readOnlyTransaction)
  542. if err != nil {
  543. return nil, false, err
  544. }
  545. name := []byte(file.Name)
  546. l.Debugf(`new global for "%v" after update: %v`, file.Name, fl)
  547. if err := t.Put(gk, mustMarshal(&fl)); err != nil {
  548. return nil, false, err
  549. }
  550. // Only load those from db if actually needed
  551. var gotGlobal, gotOldGlobal bool
  552. var global, oldGlobal protocol.FileIntf
  553. // Check the need of the device that was updated
  554. // Must happen before updating global meta: If this is the first
  555. // item from this device, it will be initialized with the global state.
  556. needBefore := false
  557. if haveOldGlobal {
  558. needBefore = Need(oldGlobalFV, haveRemoved, removedFV.Version)
  559. }
  560. needNow := Need(globalFV, true, file.Version)
  561. if needBefore {
  562. if keyBuf, oldGlobal, err = t.getGlobalFromFileVersion(keyBuf, folder, name, true, oldGlobalFV); err != nil {
  563. return nil, false, err
  564. }
  565. gotOldGlobal = true
  566. meta.removeNeeded(deviceID, oldGlobal)
  567. if !needNow && bytes.Equal(device, protocol.LocalDeviceID[:]) {
  568. if keyBuf, err = t.updateLocalNeed(keyBuf, folder, name, false); err != nil {
  569. return nil, false, err
  570. }
  571. }
  572. }
  573. if needNow {
  574. if keyBuf, global, err = t.updateGlobalGetGlobal(keyBuf, folder, name, file, globalFV); err != nil {
  575. return nil, false, err
  576. }
  577. gotGlobal = true
  578. meta.addNeeded(deviceID, global)
  579. if !needBefore && bytes.Equal(device, protocol.LocalDeviceID[:]) {
  580. if keyBuf, err = t.updateLocalNeed(keyBuf, folder, name, true); err != nil {
  581. return nil, false, err
  582. }
  583. }
  584. }
  585. // Update global size counter if necessary
  586. if !globalChanged {
  587. // Neither the global state nor the needs of any devices, except
  588. // the one updated, changed.
  589. return keyBuf, true, nil
  590. }
  591. // Remove the old global from the global size counter
  592. if haveOldGlobal {
  593. if !gotOldGlobal {
  594. if keyBuf, oldGlobal, err = t.getGlobalFromFileVersion(keyBuf, folder, name, true, oldGlobalFV); err != nil {
  595. return nil, false, err
  596. }
  597. gotOldGlobal = true
  598. }
  599. // Remove the old global from the global size counter
  600. meta.removeFile(protocol.GlobalDeviceID, oldGlobal)
  601. }
  602. // Add the new global to the global size counter
  603. if !gotGlobal {
  604. if keyBuf, global, err = t.updateGlobalGetGlobal(keyBuf, folder, name, file, globalFV); err != nil {
  605. return nil, false, err
  606. }
  607. gotGlobal = true
  608. }
  609. meta.addFile(protocol.GlobalDeviceID, global)
  610. // check for local (if not already done before)
  611. if !bytes.Equal(device, protocol.LocalDeviceID[:]) {
  612. localFV, haveLocal := fl.Get(protocol.LocalDeviceID[:])
  613. needBefore := false
  614. if haveOldGlobal {
  615. needBefore = Need(oldGlobalFV, haveLocal, localFV.Version)
  616. }
  617. needNow := Need(globalFV, haveLocal, localFV.Version)
  618. if needBefore {
  619. meta.removeNeeded(protocol.LocalDeviceID, oldGlobal)
  620. if !needNow {
  621. if keyBuf, err = t.updateLocalNeed(keyBuf, folder, name, false); err != nil {
  622. return nil, false, err
  623. }
  624. }
  625. }
  626. if Need(globalFV, haveLocal, localFV.Version) {
  627. meta.addNeeded(protocol.LocalDeviceID, global)
  628. if !needBefore {
  629. if keyBuf, err = t.updateLocalNeed(keyBuf, folder, name, true); err != nil {
  630. return nil, false, err
  631. }
  632. }
  633. }
  634. }
  635. for _, dev := range meta.devices() {
  636. if bytes.Equal(dev[:], device) {
  637. // Already handled above
  638. continue
  639. }
  640. fv, have := fl.Get(dev[:])
  641. if haveOldGlobal && Need(oldGlobalFV, have, fv.Version) {
  642. meta.removeNeeded(dev, oldGlobal)
  643. }
  644. if Need(globalFV, have, fv.Version) {
  645. meta.addNeeded(dev, global)
  646. }
  647. }
  648. return keyBuf, true, nil
  649. }
  650. func (t readWriteTransaction) updateGlobalGetGlobal(keyBuf, folder, name []byte, file protocol.FileInfo, fv FileVersion) ([]byte, protocol.FileIntf, error) {
  651. if fv.Version.Equal(file.Version) {
  652. // Inserted a new newest version
  653. return keyBuf, file, nil
  654. }
  655. return t.getGlobalFromFileVersion(keyBuf, folder, name, true, fv)
  656. }
  657. func (t readWriteTransaction) updateLocalNeed(keyBuf, folder, name []byte, add bool) ([]byte, error) {
  658. var err error
  659. keyBuf, err = t.keyer.GenerateNeedFileKey(keyBuf, folder, name)
  660. if err != nil {
  661. return nil, err
  662. }
  663. if add {
  664. l.Debugf("local need insert; folder=%q, name=%q", folder, name)
  665. err = t.Put(keyBuf, nil)
  666. } else {
  667. l.Debugf("local need delete; folder=%q, name=%q", folder, name)
  668. err = t.Delete(keyBuf)
  669. }
  670. return keyBuf, err
  671. }
  672. func Need(global FileVersion, haveLocal bool, localVersion protocol.Vector) bool {
  673. // We never need an invalid file.
  674. if global.IsInvalid() {
  675. return false
  676. }
  677. // We don't need a deleted file if we don't have it.
  678. if global.Deleted && !haveLocal {
  679. return false
  680. }
  681. // We don't need the global file if we already have the same version.
  682. if haveLocal && localVersion.GreaterEqual(global.Version) {
  683. return false
  684. }
  685. return true
  686. }
  687. // removeFromGlobal removes the device from the global version list for the
  688. // given file. If the version list is empty after this, the file entry is
  689. // removed entirely.
  690. func (t readWriteTransaction) removeFromGlobal(gk, keyBuf, folder, device, file []byte, meta *metadataTracker) ([]byte, error) {
  691. deviceID, err := protocol.DeviceIDFromBytes(device)
  692. if err != nil {
  693. return nil, err
  694. }
  695. l.Debugf("remove from global; folder=%q device=%v file=%q", folder, deviceID, file)
  696. fl, err := t.getGlobalVersionsByKey(gk)
  697. if backend.IsNotFound(err) {
  698. // We might be called to "remove" a global version that doesn't exist
  699. // if the first update for the file is already marked invalid.
  700. return keyBuf, nil
  701. } else if err != nil {
  702. return nil, err
  703. }
  704. oldGlobalFV, haveOldGlobal := fl.GetGlobal()
  705. if !haveOldGlobal {
  706. // Shouldn't ever happen, but doesn't hurt to handle.
  707. return keyBuf, t.Delete(gk)
  708. }
  709. removedFV, haveRemoved, globalChanged, err := fl.pop(folder, device, file, t.readOnlyTransaction)
  710. if err != nil {
  711. return nil, err
  712. }
  713. if !haveRemoved {
  714. // There is no version for the given device
  715. return keyBuf, nil
  716. }
  717. var global protocol.FileIntf
  718. var gotGlobal, ok bool
  719. globalFV, ok := fl.GetGlobal()
  720. // Add potential needs of the removed device
  721. if ok && !globalFV.IsInvalid() && Need(globalFV, false, protocol.Vector{}) && !Need(oldGlobalFV, haveRemoved, removedFV.Version) {
  722. keyBuf, global, _, err = t.getGlobalFromVersionList(keyBuf, folder, file, true, fl)
  723. if err != nil {
  724. return nil, err
  725. }
  726. gotGlobal = true
  727. meta.addNeeded(deviceID, global)
  728. if bytes.Equal(protocol.LocalDeviceID[:], device) {
  729. if keyBuf, err = t.updateLocalNeed(keyBuf, folder, file, true); err != nil {
  730. return nil, err
  731. }
  732. }
  733. }
  734. // Global hasn't changed, abort early
  735. if !globalChanged {
  736. l.Debugf("new global after remove: %v", fl)
  737. if err := t.Put(gk, mustMarshal(&fl)); err != nil {
  738. return nil, err
  739. }
  740. return keyBuf, nil
  741. }
  742. var f protocol.FileIntf
  743. keyBuf, f, err = t.getGlobalFromFileVersion(keyBuf, folder, file, true, oldGlobalFV)
  744. if err != nil {
  745. return nil, err
  746. }
  747. meta.removeFile(protocol.GlobalDeviceID, f)
  748. // Remove potential device needs
  749. if fv, have := fl.Get(protocol.LocalDeviceID[:]); Need(removedFV, have, fv.Version) {
  750. meta.removeNeeded(protocol.LocalDeviceID, f)
  751. if keyBuf, err = t.updateLocalNeed(keyBuf, folder, file, false); err != nil {
  752. return nil, err
  753. }
  754. }
  755. for _, dev := range meta.devices() {
  756. if bytes.Equal(dev[:], device) { // Was the previous global
  757. continue
  758. }
  759. if fv, have := fl.Get(dev[:]); Need(removedFV, have, fv.Version) {
  760. meta.removeNeeded(deviceID, f)
  761. }
  762. }
  763. // Nothing left, i.e. nothing to add to the global counter below.
  764. if fl.Empty() {
  765. if err := t.Delete(gk); err != nil {
  766. return nil, err
  767. }
  768. return keyBuf, nil
  769. }
  770. // Add to global
  771. if !gotGlobal {
  772. keyBuf, global, _, err = t.getGlobalFromVersionList(keyBuf, folder, file, true, fl)
  773. if err != nil {
  774. return nil, err
  775. }
  776. }
  777. meta.addFile(protocol.GlobalDeviceID, global)
  778. l.Debugf(`new global for "%s" after remove: %v`, file, fl)
  779. if err := t.Put(gk, mustMarshal(&fl)); err != nil {
  780. return nil, err
  781. }
  782. return keyBuf, nil
  783. }
  784. func (t readWriteTransaction) deleteKeyPrefix(prefix []byte) error {
  785. dbi, err := t.NewPrefixIterator(prefix)
  786. if err != nil {
  787. return err
  788. }
  789. defer dbi.Release()
  790. for dbi.Next() {
  791. if err := t.Delete(dbi.Key()); err != nil {
  792. return err
  793. }
  794. }
  795. return dbi.Error()
  796. }
  797. func (t *readWriteTransaction) withAllFolderTruncated(folder []byte, fn func(device []byte, f FileInfoTruncated) bool) error {
  798. key, err := t.keyer.GenerateDeviceFileKey(nil, folder, nil, nil)
  799. if err != nil {
  800. return err
  801. }
  802. dbi, err := t.NewPrefixIterator(key.WithoutNameAndDevice())
  803. if err != nil {
  804. return err
  805. }
  806. defer dbi.Release()
  807. var gk, keyBuf []byte
  808. for dbi.Next() {
  809. device, ok := t.keyer.DeviceFromDeviceFileKey(dbi.Key())
  810. if !ok {
  811. // Not having the device in the index is bad. Clear it.
  812. if err := t.Delete(dbi.Key()); err != nil {
  813. return err
  814. }
  815. continue
  816. }
  817. intf, err := t.unmarshalTrunc(dbi.Value(), true)
  818. if err != nil {
  819. return err
  820. }
  821. f := intf.(FileInfoTruncated)
  822. switch f.Name {
  823. case "", ".", "..", "/": // A few obviously invalid filenames
  824. l.Infof("Dropping invalid filename %q from database", f.Name)
  825. name := []byte(f.Name)
  826. gk, err = t.keyer.GenerateGlobalVersionKey(gk, folder, name)
  827. if err != nil {
  828. return err
  829. }
  830. keyBuf, err = t.removeFromGlobal(gk, keyBuf, folder, device, name, nil)
  831. if err != nil {
  832. return err
  833. }
  834. if err := t.Delete(dbi.Key()); err != nil {
  835. return err
  836. }
  837. continue
  838. }
  839. if !fn(device, f) {
  840. return nil
  841. }
  842. }
  843. return dbi.Error()
  844. }
  845. type marshaller interface {
  846. Marshal() ([]byte, error)
  847. }
  848. func mustMarshal(f marshaller) []byte {
  849. bs, err := f.Marshal()
  850. if err != nil {
  851. panic(err)
  852. }
  853. return bs
  854. }