Reorganized the reposize database directory, and split up a column.
checkStaleSizeChanges needs to run before needLiveUpdate,
otherwise the process won't be holding a lock on its pid file, and
another process could go in and expire the live update it records. It
just so happens that they do get called in the correct order, since
checking balanced preferred content calls getLiveRepoSizes before
needLiveUpdate.
The 1 minute delay between checks is arbitrary, but will avoid excess
work. The downside of it is that, if a process is dropping a file and
gets interrupted, for 1 minute another process can expect a repository
will soon be smaller than it is. And so a process might send data to a
repository when a file is not really going to be dropped from it. But
note that can already happen if a drop takes some time in eg locking and
then fails. So it seems possible that live updates should only be
allowed to increase, rather than decrease the size of a repository.
gitAnnexImportFeedDbLock,
gitAnnexRepoSizeDbDir,
gitAnnexRepoSizeDbLock,
+ gitAnnexRepoSizeLiveDir,
gitAnnexScheduleState,
gitAnnexTransferDir,
gitAnnexCredsDir,
objectDir = P.addTrailingPathSeparator $ annexDir P.</> "objects"
{- Annexed file's possible locations relative to the .git directory
- - in a non-bare repository.
+ - in a non-bare eepository.
+
+{- Checks for other git-annex processes that might have been interrupted
+ - and left the database populated with stale live size changes. Those
+ - are removed from the database.
+ -
+ - Also registers the current process so that other calls to this will not
+ - consider it stale while it's running.
+ -
+ - This checks the first time it is called, and again if it's been more
+ - than 1 minute since the last check.
+ -}
+checkStaleSizeChanges :: Db.RepoSizeHandle -> Annex ()
+checkStaleSizeChanges h = do
+ undefined
-
- Normally it is hashDirMixed. However, it's always possible that a
- bare repository was converted to non-bare, or that the cripped
{- Directory containing reposize database. -}
gitAnnexRepoSizeDbDir :: Git.Repo -> GitConfig -> RawFilePath
gitAnnexRepoSizeDbDir r c =
- fromMaybe (gitAnnexDir r) (annexDbDir c) P.</> "reposize"
+ fromMaybe (gitAnnexDir r) (annexDbDir c) P.</> "reposize" P.</> "db"
{- Lock file for the reposize database. -}
gitAnnexRepoSizeDbLock :: Git.Repo -> GitConfig -> RawFilePath
-gitAnnexRepoSizeDbLock r c = gitAnnexRepoSizeDbDir r c <> ".lck"
+gitAnnexRepoSizeDbLock r c =
+ fromMaybe (gitAnnexDir r) (annexDbDir c) P.</> "reposize" P.</> "lock"
+
+{- Directory containing liveness pid files. -}
+gitAnnexRepoSizeLiveDir :: Git.Repo -> GitConfig -> RawFilePath
+gitAnnexRepoSizeLiveDir r c =
+ fromMaybe (gitAnnexDir r) (annexDbDir c) P.</> "reposize" P.</> "live"
{- .git/annex/schedulestate is used to store information about when
- scheduled jobs were last run. -}
import Annex.Branch (UnmergedBranches(..), getBranch)
import qualified Database.RepoSize as Db
import Annex.Journal
+import Annex.RepoSize.LiveUpdate
import Logs
import Logs.Location
import Logs.UUID
where
go sizemap = do
h <- Db.getRepoSizeHandle
+ checkStaleSizeChanges h
liveoffsets <- liftIO $ Db.liveRepoOffsets h
let calc u (RepoSize size, SizeOffset startoffset) =
case M.lookup u liveoffsets of
calculatefromscratch h = do
unless quiet $
showSideAction "calculating repository sizes"
- (sizemap, branchsha) <- calcBranchRepoSizes
- liftIO $ Db.setRepoSizes h sizemap branchsha
- calcJournalledRepoSizes h sizemap branchsha
+ use h =<< calcBranchRepoSizes
- incrementalupdate h oldsizemap oldbranchsha currbranchsha = do
- (sizemap, branchsha) <- diffBranchRepoSizes quiet oldsizemap oldbranchsha currbranchsha
+ incrementalupdate h oldsizemap oldbranchsha currbranchsha =
+ use h =<< diffBranchRepoSizes quiet oldsizemap oldbranchsha currbranchsha
+
+ use h (sizemap, branchsha) = do
liftIO $ Db.setRepoSizes h sizemap branchsha
calcJournalledRepoSizes h sizemap branchsha
import Annex.Common
import Logs.Presence.Pure
-import qualified Database.RepoSize as Db
+import Database.RepoSize.Handle
import Annex.UUID
import Types.FileMatcher
+import Annex.LockFile
+import Annex.LockPool
+import qualified Database.RepoSize as Db
import qualified Utility.Matcher as Matcher
import Control.Concurrent
import System.Process
+import Text.Read
+import Data.Time.Clock.POSIX
+import qualified Utility.RawFilePath as R
+import qualified System.FilePath.ByteString as P
{- Called when a location log change is journalled, so the LiveUpdate
- is done. This is called with the journal still locked, so no concurrent
tryNonAsync (putMVar (liveUpdateDone lu) (Just (u, k, sc, finishv))) >>= \case
Right () -> void $ tryNonAsync $ takeMVar finishv
Left _ -> noop
+
+{- Checks for other git-annex processes that might have been interrupted
+ - and left the database populated with stale live size changes. Those
+ - are removed from the database.
+ -
+ - Also registers the current process so that other calls to this will not
+ - consider it stale while it's running.
+ -
+ - This checks the first time it is called, and again if it's been more
+ - than 1 minute since the last check.
+ -}
+checkStaleSizeChanges :: RepoSizeHandle -> Annex ()
+checkStaleSizeChanges h@(RepoSizeHandle (Just _) livev) = do
+ livedir <- calcRepo' gitAnnexRepoSizeLiveDir
+ pid <- liftIO getCurrentPid
+ let pidlockfile = show pid
+ now <- liftIO getPOSIXTime
+ liftIO (takeMVar livev) >>= \case
+ Nothing -> do
+ lck <- takeExclusiveLock $
+ livedir P.</> toRawFilePath pidlockfile
+ go livedir lck pidlockfile now
+ Just v@(lck, lastcheck)
+ | now >= lastcheck + 60 ->
+ go livedir lck pidlockfile now
+ | otherwise ->
+ liftIO $ putMVar livev (Just v)
+ where
+ go livedir lck pidlockfile now = do
+ void $ tryNonAsync $ do
+ lockfiles <- liftIO $ filter (not . dirCruft)
+ <$> getDirectoryContents (fromRawFilePath livedir)
+ stale <- forM lockfiles $ \lockfile ->
+ if (lockfile /= pidlockfile)
+ then case readMaybe lockfile of
+ Nothing -> return Nothing
+ Just pid -> checkstale livedir lockfile pid
+ else return Nothing
+ let stale' = catMaybes stale
+ unless (null stale') $ liftIO $ do
+ Db.removeStaleLiveSizeChanges h (map fst stale')
+ mapM_ snd stale'
+ liftIO $ putMVar livev (Just (lck, now))
+
+ checkstale livedir lockfile pid =
+ let f = livedir P.</> toRawFilePath lockfile
+ in tryLockShared Nothing f >>= \case
+ Nothing -> return Nothing
+ Just lck -> do
+ return $ Just
+ ( StaleSizeChanger (SizeChangeProcessId pid)
+ , do
+ dropLock lck
+ removeWhenExistsWith R.removeLink f
+ )
+checkStaleSizeChanges (RepoSizeHandle Nothing _) = noop
startingLiveSizeChange,
successfullyFinishedLiveSizeChange,
removeStaleLiveSizeChange,
+ removeStaleLiveSizeChanges,
recordedRepoOffsets,
liveRepoOffsets,
) where
import qualified Data.Map.Strict as M
import qualified Data.Set as S
import Control.Exception
+import Control.Concurrent
share [mkPersist sqlSettings, mkMigrate "migrateRepoSizes"] [persistLowerCase|
-- Corresponds to location log information from the git-annex branch.
LiveSizeChanges
repo UUID
key Key
- changeid SizeChangeId
+ changeid SizeChangeUniqueId
+ changepid SizeChangeProcessId
change SizeChange
- UniqueLiveSizeChange repo key changeid
+ UniqueLiveSizeChange repo key changeid changepid
-- A rolling total of size changes that were removed from LiveSizeChanges
-- upon successful completion.
SizeChanges
initDb db $ void $
runMigrationSilent migrateRepoSizes
h <- liftIO $ H.openDb db "repo_sizes"
- return $ RepoSizeHandle (Just h)
+ mkhandle (Just h)
where
+ mkhandle mh = do
+ livev <- liftIO $ newMVar Nothing
+ return $ RepoSizeHandle mh livev
+
-- If permissions don't allow opening the database,
-- just don't use it. Since this database is just a cache
-- of information available in the git-annex branch, the same
-- information can be queried from the branch, though much less
-- efficiently.
- permerr _e = return (RepoSizeHandle Nothing)
+ permerr _e = mkhandle Nothing
closeDb :: RepoSizeHandle -> Annex ()
-closeDb (RepoSizeHandle (Just h)) = liftIO $ H.closeDb h
-closeDb (RepoSizeHandle Nothing) = noop
+closeDb (RepoSizeHandle (Just h) _) = liftIO $ H.closeDb h
+closeDb (RepoSizeHandle Nothing _) = noop
-- This does not prevent another process that has already
-- opened the db from changing it at the same time.
{- Gets the sizes of repositories as of a commit to the git-annex
- branch. -}
getRepoSizes :: RepoSizeHandle -> IO (M.Map UUID RepoSize, Maybe Sha)
-getRepoSizes (RepoSizeHandle (Just h)) = H.queryDb h $ do
+getRepoSizes (RepoSizeHandle (Just h) _) = H.queryDb h $ do
sizemap <- M.fromList <$> getRepoSizes'
annexbranchsha <- getAnnexBranchCommit
return (sizemap, annexbranchsha)
-getRepoSizes (RepoSizeHandle Nothing) = return (mempty, Nothing)
+getRepoSizes (RepoSizeHandle Nothing _) = return (mempty, Nothing)
getRepoSizes' :: SqlPersistM [(UUID, RepoSize)]
getRepoSizes' = map conv <$> selectList [] []
- happen, but ensures that the database is consistent.
-}
setRepoSizes :: RepoSizeHandle -> M.Map UUID RepoSize -> Sha -> IO ()
-setRepoSizes (RepoSizeHandle (Just h)) sizemap branchcommitsha =
+setRepoSizes (RepoSizeHandle (Just h) _) sizemap branchcommitsha =
H.commitDb h $ do
l <- getRepoSizes'
forM_ (map fst l) $ \u ->
uncurry setRepoSize
clearRecentChanges
recordAnnexBranchCommit branchcommitsha
-setRepoSizes (RepoSizeHandle Nothing) _ _ = noop
+setRepoSizes (RepoSizeHandle Nothing _) _ _ = noop
setRepoSize :: UUID -> RepoSize -> SqlPersistM ()
setRepoSize u (RepoSize sz) =
void $ insertUniqueFast $ AnnexBranch $ toSSha branchcommitsha
startingLiveSizeChange :: RepoSizeHandle -> UUID -> Key -> SizeChange -> SizeChangeId -> IO ()
-startingLiveSizeChange (RepoSizeHandle (Just h)) u k sc sid =
+startingLiveSizeChange (RepoSizeHandle (Just h) _) u k sc cid =
H.commitDb h $ void $ upsertBy
- (UniqueLiveSizeChange u k sid)
- (LiveSizeChanges u k sid sc)
+ (UniqueLiveSizeChange u k
+ (sizeChangeUniqueId cid)
+ (sizeChangeProcessId cid))
+ (LiveSizeChanges u k
+ (sizeChangeUniqueId cid)
+ (sizeChangeProcessId cid)
+ sc)
[ LiveSizeChangesChange =. sc
- , LiveSizeChangesChangeid =. sid
+ , LiveSizeChangesChangeid =. sizeChangeUniqueId cid
+ , LiveSizeChangesChangepid =. sizeChangeProcessId cid
]
-startingLiveSizeChange (RepoSizeHandle Nothing) _ _ _ _ = noop
+startingLiveSizeChange (RepoSizeHandle Nothing _) _ _ _ _ = noop
{- A live size change has successfully finished.
-
- total.
-}
successfullyFinishedLiveSizeChange :: RepoSizeHandle -> UUID -> Key -> SizeChange -> SizeChangeId -> IO ()
-successfullyFinishedLiveSizeChange (RepoSizeHandle (Just h)) u k sc sid =
+successfullyFinishedLiveSizeChange (RepoSizeHandle (Just h) _) u k sc cid =
H.commitDb h $ do
getRecentChange u k >>= \case
Just sc' | sc == sc' -> remove
setSizeChangeFor u (updateRollingTotal rollingtotal sc k)
addRecentChange u k sc
remove
- remove = removeLiveSizeChange u k sc sid
-successfullyFinishedLiveSizeChange (RepoSizeHandle Nothing) _ _ _ _ = noop
+ remove = removeLiveSizeChange u k sc cid
+successfullyFinishedLiveSizeChange (RepoSizeHandle Nothing _) _ _ _ _ = noop
updateRollingTotal :: FileSize -> SizeChange -> Key -> FileSize
updateRollingTotal t sc k = case sc of
ksz = fromMaybe 0 $ fromKey keySize k
removeStaleLiveSizeChange :: RepoSizeHandle -> UUID -> Key -> SizeChange -> SizeChangeId -> IO ()
-removeStaleLiveSizeChange (RepoSizeHandle (Just h)) u k sc sid =
- H.commitDb h $ removeLiveSizeChange u k sc sid
-removeStaleLiveSizeChange (RepoSizeHandle Nothing) _ _ _ _ = noop
+removeStaleLiveSizeChange (RepoSizeHandle (Just h) _) u k sc cid =
+ H.commitDb h $ removeLiveSizeChange u k sc cid
+removeStaleLiveSizeChange (RepoSizeHandle Nothing _) _ _ _ _ = noop
removeLiveSizeChange :: UUID -> Key -> SizeChange -> SizeChangeId -> SqlPersistM ()
-removeLiveSizeChange u k sc sid =
+removeLiveSizeChange u k sc cid =
deleteWhere
[ LiveSizeChangesRepo ==. u
, LiveSizeChangesKey ==. k
- , LiveSizeChangesChangeid ==. sid
+ , LiveSizeChangesChangeid ==. sizeChangeUniqueId cid
+ , LiveSizeChangesChangepid ==. sizeChangeProcessId cid
, LiveSizeChangesChange ==. sc
]
+removeStaleLiveSizeChanges :: RepoSizeHandle -> [StaleSizeChanger] -> IO ()
+removeStaleLiveSizeChanges (RepoSizeHandle (Just h) _) stale = do
+ let stalepids = map staleSizeChangerProcessId stale
+ H.commitDb h $ deleteWhere [ LiveSizeChangesChangepid <-. stalepids ]
+removeStaleLiveSizeChanges (RepoSizeHandle Nothing _) _ = noop
+
getLiveSizeChangesMap :: SqlPersistM (M.Map UUID [(Key, (SizeChange, SizeChangeId))])
getLiveSizeChangesMap = M.fromListWith (++) . map conv <$> getLiveSizeChanges
where
- conv (LiveSizeChanges u k sid sc) = (u, [(k, (sc, sid))])
+ conv (LiveSizeChanges u k cid pid sc) = (u, [(k, (sc, sid))])
+ where
+ sid = SizeChangeId cid pid
getLiveSizeChangesList :: SqlPersistM [(UUID, Key, SizeChange)]
getLiveSizeChangesList = map conv <$> getLiveSizeChanges
where
- conv (LiveSizeChanges u k _sid sc) = (u, k, sc)
+ conv (LiveSizeChanges u k _cid _pid sc) = (u, k, sc)
getLiveSizeChanges :: SqlPersistM [LiveSizeChanges]
getLiveSizeChanges = map entityVal <$> selectList [] []
{- Gets the recorded offsets to sizes of Repos, not including live
- changes. -}
recordedRepoOffsets :: RepoSizeHandle -> IO (M.Map UUID SizeOffset)
-recordedRepoOffsets (RepoSizeHandle (Just h)) =
+recordedRepoOffsets (RepoSizeHandle (Just h) _) =
M.map SizeOffset <$> H.queryDb h getSizeChanges
-recordedRepoOffsets (RepoSizeHandle Nothing) = pure mempty
+recordedRepoOffsets (RepoSizeHandle Nothing _) = pure mempty
{- Gets the offsets to sizes of Repos, including all live changes that
- are happening now.
- the same time.
-}
liveRepoOffsets :: RepoSizeHandle -> IO (M.Map UUID SizeOffset)
-liveRepoOffsets (RepoSizeHandle (Just h)) = H.queryDb h $ do
+liveRepoOffsets (RepoSizeHandle (Just h) _) = H.queryDb h $ do
sizechanges <- getSizeChanges
livechanges <- getLiveSizeChangesMap
let us = S.toList $ S.fromList $
filter (\(sc', cid') -> cid /= cid' && sc' == AddingKey)
(fromMaybe [] $ M.lookup k livechangesbykey)
competinglivechanges _ _ AddingKey _ = []
-liveRepoOffsets (RepoSizeHandle Nothing) = pure mempty
+liveRepoOffsets (RepoSizeHandle Nothing _) = pure mempty
module Database.RepoSize.Handle where
import qualified Database.Handle as H
+import Utility.LockPool (LockHandle)
--- Contains Nothing if the database was not able to be opened due to
--- permissions.
-newtype RepoSizeHandle = RepoSizeHandle (Maybe H.DbHandle)
+import Control.Concurrent
+import Data.Time.Clock.POSIX
+
+data RepoSizeHandle = RepoSizeHandle
+ (Maybe H.DbHandle)
+ -- ^ Nothing if the database was not able to be opened due to
+ -- permissions.
+ (MVar (Maybe (LockHandle, POSIXTime)))
+ -- ^ Live update lock and time of last check for stale live
+ -- updates.
import Control.Concurrent
import Database.Persist.Sql hiding (Key)
-import qualified Data.Text as T
import Data.Unique
import Text.Read
import System.Process (Pid)
-import Utility.Split
+import qualified Data.Text as T
+import qualified Data.Set as S
-- The current size of a repo.
newtype RepoSize = RepoSize { fromRepoSize :: Integer }
sqlType _ = SqlInt32
data SizeChangeId = SizeChangeId
- { sizeChangeUniqueId :: Int
- -- ^ unique per process
- , sizeChangeProcessId :: Integer
- -- ^ a pid, using Integer for portability
+ { sizeChangeUniqueId :: SizeChangeUniqueId
+ , sizeChangeProcessId :: SizeChangeProcessId
}
- deriving (Show, Eq)
+ deriving (Show, Eq, Ord)
+
+-- A unique value for the current process.
+newtype SizeChangeUniqueId = SizeChangeUniqueId Int
+ deriving (Show, Eq, Ord)
+
+-- A pid, using Integer for portability
+newtype SizeChangeProcessId = SizeChangeProcessId Integer
+ deriving (Show, Eq, Ord)
mkSizeChangeId :: Pid -> IO SizeChangeId
mkSizeChangeId pid = do
u <- newUnique
return $ SizeChangeId
- { sizeChangeProcessId = fromIntegral pid
- , sizeChangeUniqueId = hashUnique u
+ { sizeChangeUniqueId =
+ SizeChangeUniqueId $ hashUnique u
+ , sizeChangeProcessId =
+ SizeChangeProcessId $ fromIntegral pid
}
-instance PersistField SizeChangeId where
- toPersistValue cid = toPersistValue $
- show (sizeChangeProcessId cid) ++ ":" ++
- show (sizeChangeUniqueId cid)
+instance PersistField SizeChangeUniqueId where
+ toPersistValue (SizeChangeUniqueId i) = toPersistValue (show i)
+ fromPersistValue b = fromPersistValue b >>= parse
+ where
+ parse s = maybe
+ (Left $ T.pack $ "bad serialized SizeChangeUniqueId " ++ show s)
+ Right
+ (SizeChangeUniqueId <$> readMaybe s)
+
+instance PersistFieldSql SizeChangeUniqueId where
+ sqlType _ = SqlString
+
+instance PersistField SizeChangeProcessId where
+ toPersistValue (SizeChangeProcessId i) = toPersistValue (show i)
fromPersistValue b = fromPersistValue b >>= parse
where
parse s = maybe
- (Left $ T.pack $ "bad serialized SizeChangeId " ++ show s)
+ (Left $ T.pack $ "bad serialized SizeChangeProcessId " ++ show s)
Right
- (parse' s)
- parse' s = case splitc ':' s of
- (pid:uid:[]) -> SizeChangeId
- <$> readMaybe pid
- <*> readMaybe uid
- _ -> Nothing
-
-instance PersistFieldSql SizeChangeId where
+ (SizeChangeProcessId <$> readMaybe s)
+
+instance PersistFieldSql SizeChangeProcessId where
sqlType _ = SqlString
+
+newtype StaleSizeChanger = StaleSizeChanger
+ { staleSizeChangerProcessId :: SizeChangeProcessId }
+ deriving (Show, Eq, Ord)
+
+isStaleSizeChangeId :: S.Set StaleSizeChanger -> SizeChangeId -> Bool
+isStaleSizeChangeId s cid =
+ StaleSizeChanger (sizeChangeProcessId cid) `S.member` s
* Test that live repo size data is correct and really works.
-* When loading the live update table, check if PIDs in it are still
- running (and are still git-annex), and if not, remove stale entries
- from it, which can accumulate when processes are interrupted.
- Note that it will be ok for the wrong git-annex process, running again
- at a pid to keep a stale item in the live update table, because that
- is unlikely and exponentially unlikely to happen repeatedly, so stale
- information will only be used for a short time.
-
- But then, how to check if a PID is git-annex or not? /proc of course,
- but what about other OS's? Windows?
-
- A plan: Have git-annex lock a per-pid file at startup. Then before
- loading the live updates table, check each other per-pid file, by
- try to take a shared lock. If able to, that process is no longer running,
- and its live updates should be considered stale, and can be removed
- while loading the live updates table.
-
- Might be better to not lock at startup, but only once live updates are
- used. annex.pidlock might otherwise prevent running more than one
- git-annex at a time.
-
* The assistant is using NoLiveUpdate, but it should be posssible to plumb
a LiveUpdate through it from preferred content checking to location log
updating.
projects / git-annex.git / commitdiff