src/TortoiseProc/gitlogcache.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2008-2013, 2015-2016 - TortoiseGit
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 #pragma once
  20
  21 #include "Git.h"
  22 #include "TGitPath.h"
  23 #include "GitRevLoglist.h"
  24 #include "GitHash.h"
  25
  26 #define LOG_INDEX_MAGIC         0x88AA5566
  27 #define LOG_DATA_MAGIC          0x99BB0FFF
  28 #define LOG_DATA_ITEM_MAGIC 0x0FCC9ACC
  29 #define LOG_DATA_FILE_MAGIC 0x19EE9DFF
  30 #define LOG_INDEX_VERSION   0x10
  31
  32 #pragma pack (1)
  33 struct SLogCacheIndexHeader
  34 {
  35         DWORD m_Magic;
  36         DWORD m_Version;
  37         DWORD m_ItemCount;
  38 };
  39
  40 struct SLogCacheIndexItem
  41 {
  42         CGitHash  m_Hash;
  43         ULONGLONG m_Offset;
  44 };
  45
  46 struct SLogCacheIndexFile
  47 {
  48         struct SLogCacheIndexHeader m_Header;
  49         struct SLogCacheIndexItem       m_Item[1]; //dynmatic size
  50 };
  51
  52 struct SLogCacheRevFileHeader
  53 {
  54         DWORD m_Magic;
  55         DWORD m_Version;
  56         DWORD m_Action;
  57         DWORD m_Stage;
  58         DWORD m_ParentNo;
  59         DWORD m_Add;
  60         DWORD m_Del;
  61         DWORD m_IsSubmodule;
  62         DWORD m_FileNameSize;
  63         DWORD m_OldFileNameSize;
  64         TCHAR m_FileName[1];
  65 };
  66 # pragma pack ()
  67
  68 struct SLogCacheRevItemHeader
  69 {
  70         DWORD m_Magic;
  71         DWORD m_Version;
  72         DWORD m_FileCount;
  73 };
  74
  75 struct SLogCacheDataFileHeader
  76 {
  77         DWORD m_Magic;
  78         DWORD m_Version;
  79 };
  80
  81 class CGitHashMap : public std::unordered_map<CGitHash, GitRevLoglist>
  82 {
  83 public:
  84         bool IsExist(CGitHash &hash)
  85         {
  86                 return find(hash) != end();
  87         }
  88 };
  89
  90 #define INDEX_FILE_NAME L"tortoisegit.index"
  91 #define DATA_FILE_NAME L"tortoisegit.data"
  92
  93 class CLogCache
  94 {
  95 public:
  96
  97 protected:
  98         BOOL m_bEnabled;
  99
 100         HANDLE m_IndexFile;
 101         HANDLE m_IndexFileMap;
 102         SLogCacheIndexFile *m_pCacheIndex;
 103
 104
 105
 106         HANDLE m_DataFile;
 107         HANDLE m_DataFileMap;
 108         BYTE  *m_pCacheData;
 109         DWORD m_DataFileLength;
 110
 111         void CloseDataHandles();
 112         void CloseIndexHandles();
 113         void Sort();
 114
 115         BOOL CheckHeader(SLogCacheIndexHeader *header)
 116         {
 117                 if (header->m_Magic != LOG_INDEX_MAGIC)
 118                         return FALSE;
 119
 120                 if (header->m_Version != LOG_INDEX_VERSION)
 121                         return FALSE;
 122
 123                 return TRUE;
 124         }
 125
 126         BOOL CheckHeader(SLogCacheRevFileHeader *header)
 127         {
 128                 if (header->m_Magic != LOG_DATA_FILE_MAGIC)
 129                         return FALSE;
 130
 131                 if (header->m_Version != LOG_INDEX_VERSION)
 132                         return FALSE;
 133
 134                 return TRUE;
 135         }
 136
 137         BOOL CheckHeader(SLogCacheRevItemHeader *header)
 138         {
 139                 if (header->m_Magic != LOG_DATA_ITEM_MAGIC)
 140                         return FALSE;
 141
 142                 if (header->m_Version != LOG_INDEX_VERSION)
 143                         return FALSE;
 144
 145                 return TRUE;
 146         }
 147
 148         BOOL CheckHeader(SLogCacheDataFileHeader *header)
 149         {
 150                 if (header->m_Magic != LOG_DATA_MAGIC)
 151                         return FALSE;
 152
 153                 if (header->m_Version != LOG_INDEX_VERSION)
 154                         return FALSE;
 155
 156                 return TRUE;
 157         }
 158
 159         int SaveOneItem(const GitRevLoglist& Rev, LONG offset);
 160
 161         CString m_GitDir;
 162         int RebuildCacheFile();
 163
 164 public:
 165         CLogCache();
 166         ~CLogCache();
 167         int FetchCacheIndex(CString GitDir);
 168         int LoadOneItem(GitRevLoglist& Rev, ULONGLONG offset);
 169         ULONGLONG GetOffset(const CGitHash& hash, SLogCacheIndexFile* pData = nullptr);
 170
 171         CGitHashMap m_HashMap;
 172
 173         GitRevLoglist* GetCacheData(const CGitHash& hash);
 174         int SaveCache();
 175
 176         int ClearAllParent();
 177         void ClearAllLanes();
 178 };