transactions.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971
  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. "github.com/syncthing/syncthing/lib/osutil"
  11. "github.com/syncthing/syncthing/lib/db/backend"
  12. "github.com/syncthing/syncthing/lib/protocol"
  13. )
  14. var (
  15. errEntryFromGlobalMissing = errors.New("device present in global list but missing as device/fileinfo entry")
  16. errEmptyGlobal = errors.New("no versions in global list")
  17. errEmptyFileVersion = errors.New("no devices in global file version")
  18. )
  19. // A readOnlyTransaction represents a database snapshot.
  20. type readOnlyTransaction struct {
  21. backend.ReadTransaction
  22. keyer keyer
  23. }
  24. func (db *Lowlevel) newReadOnlyTransaction() (readOnlyTransaction, error) {
  25. tran, err := db.NewReadTransaction()
  26. if err != nil {
  27. return readOnlyTransaction{}, err
  28. }
  29. return readOnlyTransaction{
  30. ReadTransaction: tran,
  31. keyer: db.keyer,
  32. }, nil
  33. }
  34. func (t readOnlyTransaction) close() {
  35. t.Release()
  36. }
  37. func (t readOnlyTransaction) getFile(folder, device, file []byte) (protocol.FileInfo, bool, error) {
  38. key, err := t.keyer.GenerateDeviceFileKey(nil, folder, device, file)
  39. if err != nil {
  40. return protocol.FileInfo{}, false, err
  41. }
  42. return t.getFileByKey(key)
  43. }
  44. func (t readOnlyTransaction) getFileByKey(key []byte) (protocol.FileInfo, bool, error) {
  45. f, ok, err := t.getFileTrunc(key, false)
  46. if err != nil || !ok {
  47. return protocol.FileInfo{}, false, err
  48. }
  49. return f.(protocol.FileInfo), true, nil
  50. }
  51. func (t readOnlyTransaction) getFileTrunc(key []byte, trunc bool) (protocol.FileIntf, bool, error) {
  52. bs, err := t.Get(key)
  53. if backend.IsNotFound(err) {
  54. return nil, false, nil
  55. }
  56. if err != nil {
  57. return nil, false, err
  58. }
  59. f, err := t.unmarshalTrunc(bs, trunc)
  60. if backend.IsNotFound(err) {
  61. return nil, false, nil
  62. }
  63. if err != nil {
  64. return nil, false, err
  65. }
  66. return f, true, nil
  67. }
  68. func (t readOnlyTransaction) unmarshalTrunc(bs []byte, trunc bool) (protocol.FileIntf, error) {
  69. if trunc {
  70. var tf FileInfoTruncated
  71. err := tf.Unmarshal(bs)
  72. if err != nil {
  73. return nil, err
  74. }
  75. if err := t.fillTruncated(&tf); err != nil {
  76. return nil, err
  77. }
  78. return tf, nil
  79. }
  80. var fi protocol.FileInfo
  81. if err := fi.Unmarshal(bs); err != nil {
  82. return nil, err
  83. }
  84. if err := t.fillFileInfo(&fi); err != nil {
  85. return nil, err
  86. }
  87. return fi, nil
  88. }
  89. // fillFileInfo follows the (possible) indirection of blocks and version
  90. // vector and fills it out.
  91. func (t readOnlyTransaction) fillFileInfo(fi *protocol.FileInfo) error {
  92. var key []byte
  93. if len(fi.Blocks) == 0 && len(fi.BlocksHash) != 0 {
  94. // The blocks list is indirected and we need to load it.
  95. key = t.keyer.GenerateBlockListKey(key, fi.BlocksHash)
  96. bs, err := t.Get(key)
  97. if err != nil {
  98. return err
  99. }
  100. var bl BlockList
  101. if err := bl.Unmarshal(bs); err != nil {
  102. return err
  103. }
  104. fi.Blocks = bl.Blocks
  105. }
  106. if len(fi.VersionHash) != 0 {
  107. key = t.keyer.GenerateVersionKey(key, fi.VersionHash)
  108. bs, err := t.Get(key)
  109. if err != nil {
  110. return err
  111. }
  112. var v protocol.Vector
  113. if err := v.Unmarshal(bs); err != nil {
  114. return err
  115. }
  116. fi.Version = v
  117. }
  118. return nil
  119. }
  120. // fillTruncated follows the (possible) indirection of version vector and
  121. // fills it.
  122. func (t readOnlyTransaction) fillTruncated(fi *FileInfoTruncated) error {
  123. var key []byte
  124. if len(fi.VersionHash) == 0 {
  125. return nil
  126. }
  127. key = t.keyer.GenerateVersionKey(key, fi.VersionHash)
  128. bs, err := t.Get(key)
  129. if err != nil {
  130. return err
  131. }
  132. var v protocol.Vector
  133. if err := v.Unmarshal(bs); err != nil {
  134. return err
  135. }
  136. fi.Version = v
  137. return nil
  138. }
  139. func (t readOnlyTransaction) getGlobalVersions(keyBuf, folder, file []byte) (VersionList, error) {
  140. var err error
  141. keyBuf, err = t.keyer.GenerateGlobalVersionKey(keyBuf, folder, file)
  142. if err != nil {
  143. return VersionList{}, err
  144. }
  145. return t.getGlobalVersionsByKey(keyBuf)
  146. }
  147. func (t readOnlyTransaction) getGlobalVersionsByKey(key []byte) (VersionList, error) {
  148. bs, err := t.Get(key)
  149. if err != nil {
  150. return VersionList{}, err
  151. }
  152. var vl VersionList
  153. if err := vl.Unmarshal(bs); err != nil {
  154. return VersionList{}, err
  155. }
  156. return vl, nil
  157. }
  158. func (t readOnlyTransaction) getGlobal(keyBuf, folder, file []byte, truncate bool) ([]byte, protocol.FileIntf, bool, error) {
  159. vl, err := t.getGlobalVersions(keyBuf, folder, file)
  160. if backend.IsNotFound(err) {
  161. return keyBuf, nil, false, nil
  162. } else if err != nil {
  163. return nil, nil, false, err
  164. }
  165. var fi protocol.FileIntf
  166. keyBuf, fi, _, err = t.getGlobalFromVersionList(keyBuf, folder, file, truncate, vl)
  167. return keyBuf, fi, true, err
  168. }
  169. func (t readOnlyTransaction) getGlobalFromVersionList(keyBuf, folder, file []byte, truncate bool, vl VersionList) ([]byte, protocol.FileIntf, FileVersion, error) {
  170. fv, ok := vl.GetGlobal()
  171. if !ok {
  172. return keyBuf, nil, FileVersion{}, errEmptyGlobal
  173. }
  174. keyBuf, fi, err := t.getGlobalFromFileVersion(keyBuf, folder, file, truncate, fv)
  175. return keyBuf, fi, fv, err
  176. }
  177. func (t readOnlyTransaction) getGlobalFromFileVersion(keyBuf, folder, file []byte, truncate bool, fv FileVersion) ([]byte, protocol.FileIntf, error) {
  178. dev, ok := fv.FirstDevice()
  179. if !ok {
  180. return keyBuf, nil, errEmptyFileVersion
  181. }
  182. keyBuf, err := t.keyer.GenerateDeviceFileKey(keyBuf, folder, dev, file)
  183. if err != nil {
  184. return keyBuf, nil, err
  185. }
  186. fi, ok, err := t.getFileTrunc(keyBuf, truncate)
  187. if err != nil {
  188. return keyBuf, nil, err
  189. }
  190. if !ok {
  191. return keyBuf, nil, errEntryFromGlobalMissing
  192. }
  193. return keyBuf, fi, nil
  194. }
  195. func (t *readOnlyTransaction) withHave(folder, device, prefix []byte, truncate bool, fn Iterator) error {
  196. if len(prefix) > 0 {
  197. unslashedPrefix := prefix
  198. if bytes.HasSuffix(prefix, []byte{'/'}) {
  199. unslashedPrefix = unslashedPrefix[:len(unslashedPrefix)-1]
  200. } else {
  201. prefix = append(prefix, '/')
  202. }
  203. key, err := t.keyer.GenerateDeviceFileKey(nil, folder, device, unslashedPrefix)
  204. if err != nil {
  205. return err
  206. }
  207. if f, ok, err := t.getFileTrunc(key, truncate); err != nil {
  208. return err
  209. } else if ok && !fn(f) {
  210. return nil
  211. }
  212. }
  213. key, err := t.keyer.GenerateDeviceFileKey(nil, folder, device, prefix)
  214. if err != nil {
  215. return err
  216. }
  217. dbi, err := t.NewPrefixIterator(key)
  218. if err != nil {
  219. return err
  220. }
  221. defer dbi.Release()
  222. for dbi.Next() {
  223. name := t.keyer.NameFromDeviceFileKey(dbi.Key())
  224. if len(prefix) > 0 && !bytes.HasPrefix(name, prefix) {
  225. return nil
  226. }
  227. f, err := t.unmarshalTrunc(dbi.Value(), truncate)
  228. if err != nil {
  229. l.Debugln("unmarshal error:", err)
  230. continue
  231. }
  232. if !fn(f) {
  233. return nil
  234. }
  235. }
  236. return dbi.Error()
  237. }
  238. func (t *readOnlyTransaction) withHaveSequence(folder []byte, startSeq int64, fn Iterator) error {
  239. first, err := t.keyer.GenerateSequenceKey(nil, folder, startSeq)
  240. if err != nil {
  241. return err
  242. }
  243. last, err := t.keyer.GenerateSequenceKey(nil, folder, maxInt64)
  244. if err != nil {
  245. return err
  246. }
  247. dbi, err := t.NewRangeIterator(first, last)
  248. if err != nil {
  249. return err
  250. }
  251. defer dbi.Release()
  252. for dbi.Next() {
  253. f, ok, err := t.getFileByKey(dbi.Value())
  254. if err != nil {
  255. return err
  256. }
  257. if !ok {
  258. l.Debugln("missing file for sequence number", t.keyer.SequenceFromSequenceKey(dbi.Key()))
  259. continue
  260. }
  261. if shouldDebug() {
  262. if seq := t.keyer.SequenceFromSequenceKey(dbi.Key()); f.Sequence != seq {
  263. l.Debugf("Sequence index corruption (folder %v, file %v): sequence %d != expected %d", string(folder), f.Name, f.Sequence, seq)
  264. }
  265. }
  266. if !fn(f) {
  267. return nil
  268. }
  269. }
  270. return dbi.Error()
  271. }
  272. func (t *readOnlyTransaction) withGlobal(folder, prefix []byte, truncate bool, fn Iterator) error {
  273. if len(prefix) > 0 {
  274. unslashedPrefix := prefix
  275. if bytes.HasSuffix(prefix, []byte{'/'}) {
  276. unslashedPrefix = unslashedPrefix[:len(unslashedPrefix)-1]
  277. } else {
  278. prefix = append(prefix, '/')
  279. }
  280. if _, f, ok, err := t.getGlobal(nil, folder, unslashedPrefix, truncate); err != nil {
  281. return err
  282. } else if ok && !fn(f) {
  283. return nil
  284. }
  285. }
  286. key, err := t.keyer.GenerateGlobalVersionKey(nil, folder, prefix)
  287. if err != nil {
  288. return err
  289. }
  290. dbi, err := t.NewPrefixIterator(key)
  291. if err != nil {
  292. return err
  293. }
  294. defer dbi.Release()
  295. var dk []byte
  296. for dbi.Next() {
  297. name := t.keyer.NameFromGlobalVersionKey(dbi.Key())
  298. if len(prefix) > 0 && !bytes.HasPrefix(name, prefix) {
  299. return nil
  300. }
  301. var vl VersionList
  302. if err := vl.Unmarshal(dbi.Value()); err != nil {
  303. return err
  304. }
  305. var f protocol.FileIntf
  306. dk, f, _, err = t.getGlobalFromVersionList(dk, folder, name, truncate, vl)
  307. if err != nil {
  308. return err
  309. }
  310. if !fn(f) {
  311. return nil
  312. }
  313. }
  314. if err != nil {
  315. return err
  316. }
  317. return dbi.Error()
  318. }
  319. func (t *readOnlyTransaction) withBlocksHash(folder, hash []byte, iterator Iterator) error {
  320. key, err := t.keyer.GenerateBlockListMapKey(nil, folder, hash, nil)
  321. if err != nil {
  322. return err
  323. }
  324. iter, err := t.NewPrefixIterator(key)
  325. if err != nil {
  326. return err
  327. }
  328. defer iter.Release()
  329. for iter.Next() {
  330. file := string(t.keyer.NameFromBlockListMapKey(iter.Key()))
  331. f, ok, err := t.getFile(folder, protocol.LocalDeviceID[:], []byte(osutil.NormalizedFilename(file)))
  332. if err != nil {
  333. return err
  334. }
  335. if !ok {
  336. continue
  337. }
  338. f.Name = osutil.NativeFilename(f.Name)
  339. if !bytes.Equal(f.BlocksHash, hash) {
  340. l.Warnf("Mismatching block map list hashes: got %x expected %x", f.BlocksHash, hash)
  341. continue
  342. }
  343. if f.IsDeleted() || f.IsInvalid() || f.IsDirectory() || f.IsSymlink() {
  344. l.Warnf("Found something of unexpected type in block list map: %s", f)
  345. continue
  346. }
  347. if !iterator(f) {
  348. break
  349. }
  350. }
  351. return iter.Error()
  352. }
  353. func (t *readOnlyTransaction) availability(folder, file []byte) ([]protocol.DeviceID, error) {
  354. vl, err := t.getGlobalVersions(nil, folder, file)
  355. if backend.IsNotFound(err) {
  356. return nil, nil
  357. }
  358. if err != nil {
  359. return nil, err
  360. }
  361. fv, ok := vl.GetGlobal()
  362. if !ok {
  363. return nil, nil
  364. }
  365. devices := make([]protocol.DeviceID, len(fv.Devices))
  366. for i, dev := range fv.Devices {
  367. n, err := protocol.DeviceIDFromBytes(dev)
  368. if err != nil {
  369. return nil, err
  370. }
  371. devices[i] = n
  372. }
  373. return devices, nil
  374. }
  375. func (t *readOnlyTransaction) withNeed(folder, device []byte, truncate bool, fn Iterator) error {
  376. if bytes.Equal(device, protocol.LocalDeviceID[:]) {
  377. return t.withNeedLocal(folder, truncate, fn)
  378. }
  379. key, err := t.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. devID, err := protocol.DeviceIDFromBytes(device)
  390. if err != nil {
  391. return err
  392. }
  393. for dbi.Next() {
  394. var vl VersionList
  395. if err := vl.Unmarshal(dbi.Value()); err != nil {
  396. return err
  397. }
  398. globalFV, ok := vl.GetGlobal()
  399. if !ok {
  400. return errEmptyGlobal
  401. }
  402. haveFV, have := vl.Get(device)
  403. if !need(globalFV, have, haveFV.Version) {
  404. continue
  405. }
  406. name := t.keyer.NameFromGlobalVersionKey(dbi.Key())
  407. var gf protocol.FileIntf
  408. dk, gf, err = t.getGlobalFromFileVersion(dk, folder, name, truncate, globalFV)
  409. if err != nil {
  410. return err
  411. }
  412. globalDev, ok := globalFV.FirstDevice()
  413. if !ok {
  414. return errEmptyFileVersion
  415. }
  416. 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(), globalDev)
  417. if !fn(gf) {
  418. return dbi.Error()
  419. }
  420. }
  421. return dbi.Error()
  422. }
  423. func (t *readOnlyTransaction) withNeedLocal(folder []byte, truncate bool, fn Iterator) error {
  424. key, err := t.keyer.GenerateNeedFileKey(nil, folder, nil)
  425. if err != nil {
  426. return err
  427. }
  428. dbi, err := t.NewPrefixIterator(key.WithoutName())
  429. if err != nil {
  430. return err
  431. }
  432. defer dbi.Release()
  433. var keyBuf []byte
  434. var f protocol.FileIntf
  435. var ok bool
  436. for dbi.Next() {
  437. keyBuf, f, ok, err = t.getGlobal(keyBuf, folder, t.keyer.NameFromGlobalVersionKey(dbi.Key()), truncate)
  438. if err != nil {
  439. return err
  440. }
  441. if !ok {
  442. continue
  443. }
  444. if !fn(f) {
  445. return nil
  446. }
  447. }
  448. return dbi.Error()
  449. }
  450. // A readWriteTransaction is a readOnlyTransaction plus a batch for writes.
  451. // The batch will be committed on close() or by checkFlush() if it exceeds the
  452. // batch size.
  453. type readWriteTransaction struct {
  454. backend.WriteTransaction
  455. readOnlyTransaction
  456. }
  457. func (db *Lowlevel) newReadWriteTransaction() (readWriteTransaction, error) {
  458. tran, err := db.NewWriteTransaction()
  459. if err != nil {
  460. return readWriteTransaction{}, err
  461. }
  462. return readWriteTransaction{
  463. WriteTransaction: tran,
  464. readOnlyTransaction: readOnlyTransaction{
  465. ReadTransaction: tran,
  466. keyer: db.keyer,
  467. },
  468. }, nil
  469. }
  470. func (t readWriteTransaction) Commit() error {
  471. // The readOnlyTransaction must close after commit, because they may be
  472. // backed by the same actual lower level transaction.
  473. defer t.readOnlyTransaction.close()
  474. return t.WriteTransaction.Commit()
  475. }
  476. func (t readWriteTransaction) close() {
  477. t.readOnlyTransaction.close()
  478. t.WriteTransaction.Release()
  479. }
  480. // putFile stores a file in the database, taking care of indirected fields.
  481. // Set the truncated flag when putting a file that deliberatly can have an
  482. // empty block list but a non-empty block list hash. This should normally be
  483. // false.
  484. func (t readWriteTransaction) putFile(fkey []byte, fi protocol.FileInfo, truncated bool) error {
  485. var bkey []byte
  486. // Always set the blocks hash when there are blocks. Leave the blocks
  487. // hash alone when there are no blocks and we might be putting a
  488. // "truncated" FileInfo (no blocks, but the hash reference is live).
  489. if len(fi.Blocks) > 0 {
  490. fi.BlocksHash = protocol.BlocksHash(fi.Blocks)
  491. } else if !truncated {
  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. keyBuf, err = t.keyer.GenerateDeviceFileKey(keyBuf, folder, device, file)
  743. if err != nil {
  744. return nil, err
  745. }
  746. f, ok, err := t.getFileTrunc(keyBuf, true)
  747. if err != nil {
  748. return nil, err
  749. } else if !ok {
  750. return nil, errEntryFromGlobalMissing
  751. }
  752. meta.removeFile(protocol.GlobalDeviceID, f)
  753. // Remove potential device needs
  754. if fv, have := fl.Get(protocol.LocalDeviceID[:]); need(removedFV, have, fv.Version) {
  755. meta.removeNeeded(protocol.LocalDeviceID, f)
  756. if keyBuf, err = t.updateLocalNeed(keyBuf, folder, file, false); err != nil {
  757. return nil, err
  758. }
  759. }
  760. for _, dev := range meta.devices() {
  761. if bytes.Equal(dev[:], device) { // Was the previous global
  762. continue
  763. }
  764. if fv, have := fl.Get(dev[:]); need(removedFV, have, fv.Version) {
  765. meta.removeNeeded(deviceID, f)
  766. }
  767. }
  768. // Nothing left, i.e. nothing to add to the global counter below.
  769. if fl.Empty() {
  770. if err := t.Delete(gk); err != nil {
  771. return nil, err
  772. }
  773. return keyBuf, nil
  774. }
  775. // Add to global
  776. if !gotGlobal {
  777. keyBuf, global, _, err = t.getGlobalFromVersionList(keyBuf, folder, file, true, fl)
  778. if err != nil {
  779. return nil, err
  780. }
  781. }
  782. meta.addFile(protocol.GlobalDeviceID, global)
  783. l.Debugf(`new global for "%s" after remove: %v`, file, fl)
  784. if err := t.Put(gk, mustMarshal(&fl)); err != nil {
  785. return nil, err
  786. }
  787. return keyBuf, nil
  788. }
  789. func (t readWriteTransaction) deleteKeyPrefix(prefix []byte) error {
  790. dbi, err := t.NewPrefixIterator(prefix)
  791. if err != nil {
  792. return err
  793. }
  794. defer dbi.Release()
  795. for dbi.Next() {
  796. if err := t.Delete(dbi.Key()); err != nil {
  797. return err
  798. }
  799. }
  800. return dbi.Error()
  801. }
  802. func (t *readWriteTransaction) withAllFolderTruncated(folder []byte, fn func(device []byte, f FileInfoTruncated) bool) error {
  803. key, err := t.keyer.GenerateDeviceFileKey(nil, folder, nil, nil)
  804. if err != nil {
  805. return err
  806. }
  807. dbi, err := t.NewPrefixIterator(key.WithoutNameAndDevice())
  808. if err != nil {
  809. return err
  810. }
  811. defer dbi.Release()
  812. var gk, keyBuf []byte
  813. for dbi.Next() {
  814. device, ok := t.keyer.DeviceFromDeviceFileKey(dbi.Key())
  815. if !ok {
  816. // Not having the device in the index is bad. Clear it.
  817. if err := t.Delete(dbi.Key()); err != nil {
  818. return err
  819. }
  820. continue
  821. }
  822. intf, err := t.unmarshalTrunc(dbi.Value(), true)
  823. if err != nil {
  824. return err
  825. }
  826. f := intf.(FileInfoTruncated)
  827. switch f.Name {
  828. case "", ".", "..", "/": // A few obviously invalid filenames
  829. l.Infof("Dropping invalid filename %q from database", f.Name)
  830. name := []byte(f.Name)
  831. gk, err = t.keyer.GenerateGlobalVersionKey(gk, folder, name)
  832. if err != nil {
  833. return err
  834. }
  835. keyBuf, err = t.removeFromGlobal(gk, keyBuf, folder, device, name, nil)
  836. if err != nil {
  837. return err
  838. }
  839. if err := t.Delete(dbi.Key()); err != nil {
  840. return err
  841. }
  842. continue
  843. }
  844. if !fn(device, f) {
  845. return nil
  846. }
  847. }
  848. return dbi.Error()
  849. }
  850. type marshaller interface {
  851. Marshal() ([]byte, error)
  852. }
  853. func mustMarshal(f marshaller) []byte {
  854. bs, err := f.Marshal()
  855. if err != nil {
  856. panic(err)
  857. }
  858. return bs
  859. }