1 2 /* 3 * Copyright 2012 Google Inc. 4 * 5 * Use of this source code is governed by a BSD-style license that can be 6 * found in the LICENSE file. 7 */ 8 9 #include "GrTextureStripAtlas.h" 10 #include "SkPixelRef.h" 11 #include "SkTSearch.h" 12 #include "GrTexture.h" 13 14 #ifdef SK_DEBUG 15 #define VALIDATE this->validate() 16 #else 17 #define VALIDATE 18 #endif 19 20 int32_t GrTextureStripAtlas::gCacheCount = 0; 21 22 GrTHashTable<GrTextureStripAtlas::AtlasEntry, 23 GrTextureStripAtlas::AtlasHashKey, 8>* 24 GrTextureStripAtlas::gAtlasCache = NULL; 25 26 GrTHashTable<GrTextureStripAtlas::AtlasEntry, GrTextureStripAtlas::AtlasHashKey, 8>* 27 GrTextureStripAtlas::GetCache() { 28 29 if (NULL == gAtlasCache) { 30 gAtlasCache = SkNEW((GrTHashTable<AtlasEntry, AtlasHashKey, 8>)); 31 } 32 33 return gAtlasCache; 34 } 35 36 // Remove the specified atlas from the cache 37 void GrTextureStripAtlas::CleanUp(const GrContext* context, void* info) { 38 GrAssert(NULL != info); 39 40 AtlasEntry* entry = static_cast<AtlasEntry*>(info); 41 42 // remove the cache entry 43 GetCache()->remove(entry->fKey, entry); 44 45 // remove the actual entry 46 SkDELETE(entry); 47 48 if (0 == GetCache()->count()) { 49 SkDELETE(gAtlasCache); 50 gAtlasCache = NULL; 51 } 52 } 53 54 GrTextureStripAtlas* GrTextureStripAtlas::GetAtlas(const GrTextureStripAtlas::Desc& desc) { 55 AtlasHashKey key; 56 key.setKeyData(desc.asKey()); 57 AtlasEntry* entry = GetCache()->find(key); 58 if (NULL == entry) { 59 entry = SkNEW(AtlasEntry); 60 61 entry->fAtlas = SkNEW_ARGS(GrTextureStripAtlas, (desc)); 62 entry->fKey = key; 63 64 desc.fContext->addCleanUp(CleanUp, entry); 65 66 GetCache()->insert(key, entry); 67 } 68 69 return entry->fAtlas; 70 } 71 72 GrTextureStripAtlas::GrTextureStripAtlas(GrTextureStripAtlas::Desc desc) 73 : fCacheKey(sk_atomic_inc(&gCacheCount)) 74 , fLockedRows(0) 75 , fDesc(desc) 76 , fNumRows(desc.fHeight / desc.fRowHeight) 77 , fTexture(NULL) 78 , fRows(SkNEW_ARRAY(AtlasRow, fNumRows)) 79 , fLRUFront(NULL) 80 , fLRUBack(NULL) { 81 GrAssert(fNumRows * fDesc.fRowHeight == fDesc.fHeight); 82 this->initLRU(); 83 VALIDATE; 84 } 85 86 GrTextureStripAtlas::~GrTextureStripAtlas() { 87 SkDELETE_ARRAY(fRows); 88 } 89 90 int GrTextureStripAtlas::lockRow(const SkBitmap& data) { 91 VALIDATE; 92 if (0 == fLockedRows) { 93 this->lockTexture(); 94 } 95 96 int key = data.getGenerationID(); 97 int rowNumber = -1; 98 int index = this->searchByKey(key); 99 100 if (index >= 0) { 101 // We already have the data in a row, so we can just return that row 102 AtlasRow* row = fKeyTable[index]; 103 if (0 == row->fLocks) { 104 this->removeFromLRU(row); 105 } 106 ++row->fLocks; 107 ++fLockedRows; 108 109 // Since all the rows are always stored in a contiguous array, we can save the memory 110 // required for storing row numbers and just compute it with some pointer arithmetic 111 rowNumber = static_cast<int>(row - fRows); 112 } else { 113 // ~index is the index where we will insert the new key to keep things sorted 114 index = ~index; 115 116 // We don't have this data cached, so pick the least recently used row to copy into 117 AtlasRow* row = this->getLRU(); 118 119 ++fLockedRows; 120 121 if (NULL == row) { 122 // force a flush, which should unlock all the rows; then try again 123 fDesc.fContext->flush(); 124 row = this->getLRU(); 125 if (NULL == row) { 126 --fLockedRows; 127 return -1; 128 } 129 } 130 131 this->removeFromLRU(row); 132 133 uint32_t oldKey = row->fKey; 134 135 // If we are writing into a row that already held bitmap data, we need to remove the 136 // reference to that genID which is stored in our sorted table of key values. 137 if (oldKey != kEmptyAtlasRowKey) { 138 139 // Find the entry in the list; if it's before the index where we plan on adding the new 140 // entry, we decrement since it will shift elements ahead of it back by one. 141 int oldIndex = this->searchByKey(oldKey); 142 if (oldIndex < index) { 143 --index; 144 } 145 146 fKeyTable.remove(oldIndex); 147 } 148 149 row->fKey = key; 150 row->fLocks = 1; 151 fKeyTable.insert(index, 1, &row); 152 rowNumber = static_cast<int>(row - fRows); 153 154 SkAutoLockPixels lock(data); 155 156 // Pass in the kDontFlush flag, since we know we're writing to a part of this texture 157 // that is not currently in use 158 fDesc.fContext->writeTexturePixels(fTexture, 159 0, rowNumber * fDesc.fRowHeight, 160 fDesc.fWidth, fDesc.fRowHeight, 161 SkBitmapConfig2GrPixelConfig(data.config()), 162 data.getPixels(), 163 data.rowBytes(), 164 GrContext::kDontFlush_PixelOpsFlag); 165 } 166 167 GrAssert(rowNumber >= 0); 168 VALIDATE; 169 return rowNumber; 170 } 171 172 void GrTextureStripAtlas::unlockRow(int row) { 173 VALIDATE; 174 --fRows[row].fLocks; 175 --fLockedRows; 176 GrAssert(fRows[row].fLocks >= 0 && fLockedRows >= 0); 177 if (0 == fRows[row].fLocks) { 178 this->appendLRU(fRows + row); 179 } 180 if (0 == fLockedRows) { 181 this->unlockTexture(); 182 } 183 VALIDATE; 184 } 185 186 GrTextureStripAtlas::AtlasRow* GrTextureStripAtlas::getLRU() { 187 // Front is least-recently-used 188 AtlasRow* row = fLRUFront; 189 return row; 190 } 191 192 void GrTextureStripAtlas::lockTexture() { 193 GrTextureParams params; 194 GrTextureDesc texDesc; 195 texDesc.fWidth = fDesc.fWidth; 196 texDesc.fHeight = fDesc.fHeight; 197 texDesc.fConfig = fDesc.fConfig; 198 199 static const GrCacheID::Domain gTextureStripAtlasDomain = GrCacheID::GenerateDomain(); 200 GrCacheID::Key key; 201 *key.fData32 = fCacheKey; 202 memset(key.fData32 + 1, 0, sizeof(key) - sizeof(uint32_t)); 203 GrCacheID cacheID(gTextureStripAtlasDomain, key); 204 205 fTexture = fDesc.fContext->findAndRefTexture(texDesc, cacheID, ¶ms); 206 if (NULL == fTexture) { 207 fTexture = fDesc.fContext->createTexture(¶ms, texDesc, cacheID, NULL, 0); 208 // This is a new texture, so all of our cache info is now invalid 209 this->initLRU(); 210 fKeyTable.rewind(); 211 } 212 GrAssert(NULL != fTexture); 213 } 214 215 void GrTextureStripAtlas::unlockTexture() { 216 GrAssert(NULL != fTexture && 0 == fLockedRows); 217 fTexture->unref(); 218 fTexture = NULL; 219 fDesc.fContext->purgeCache(); 220 } 221 222 void GrTextureStripAtlas::initLRU() { 223 fLRUFront = NULL; 224 fLRUBack = NULL; 225 // Initially all the rows are in the LRU list 226 for (int i = 0; i < fNumRows; ++i) { 227 fRows[i].fKey = kEmptyAtlasRowKey; 228 fRows[i].fNext = NULL; 229 fRows[i].fPrev = NULL; 230 this->appendLRU(fRows + i); 231 } 232 GrAssert(NULL == fLRUFront->fPrev && NULL == fLRUBack->fNext); 233 } 234 235 void GrTextureStripAtlas::appendLRU(AtlasRow* row) { 236 GrAssert(NULL == row->fPrev && NULL == row->fNext); 237 if (NULL == fLRUFront && NULL == fLRUBack) { 238 fLRUFront = row; 239 fLRUBack = row; 240 } else { 241 row->fPrev = fLRUBack; 242 fLRUBack->fNext = row; 243 fLRUBack = row; 244 } 245 } 246 247 void GrTextureStripAtlas::removeFromLRU(AtlasRow* row) { 248 GrAssert(NULL != row); 249 if (NULL != row->fNext && NULL != row->fPrev) { 250 row->fPrev->fNext = row->fNext; 251 row->fNext->fPrev = row->fPrev; 252 } else { 253 if (NULL == row->fNext) { 254 GrAssert(row == fLRUBack); 255 fLRUBack = row->fPrev; 256 if (fLRUBack) { 257 fLRUBack->fNext = NULL; 258 } 259 } 260 if (NULL == row->fPrev) { 261 GrAssert(row == fLRUFront); 262 fLRUFront = row->fNext; 263 if (fLRUFront) { 264 fLRUFront->fPrev = NULL; 265 } 266 } 267 } 268 row->fNext = NULL; 269 row->fPrev = NULL; 270 } 271 272 int GrTextureStripAtlas::searchByKey(uint32_t key) { 273 AtlasRow target; 274 target.fKey = key; 275 return SkTSearch<AtlasRow, GrTextureStripAtlas::compareKeys>((const AtlasRow**)fKeyTable.begin(), 276 fKeyTable.count(), 277 &target, 278 sizeof(AtlasRow*)); 279 } 280 281 #ifdef SK_DEBUG 282 void GrTextureStripAtlas::validate() { 283 284 // Our key table should be sorted 285 uint32_t prev = 1 > fKeyTable.count() ? 0 : fKeyTable[0]->fKey; 286 for (int i = 1; i < fKeyTable.count(); ++i) { 287 GrAssert(prev < fKeyTable[i]->fKey); 288 GrAssert(fKeyTable[i]->fKey != kEmptyAtlasRowKey); 289 prev = fKeyTable[i]->fKey; 290 } 291 292 int lruCount = 0; 293 // Validate LRU pointers, and count LRU entries 294 GrAssert(NULL == fLRUFront || NULL == fLRUFront->fPrev); 295 GrAssert(NULL == fLRUBack || NULL == fLRUBack->fNext); 296 for (AtlasRow* r = fLRUFront; r != NULL; r = r->fNext) { 297 if (NULL == r->fNext) { 298 GrAssert(r == fLRUBack); 299 } else { 300 GrAssert(r->fNext->fPrev == r); 301 } 302 ++lruCount; 303 } 304 305 int rowLocks = 0; 306 int freeRows = 0; 307 308 for (int i = 0; i < fNumRows; ++i) { 309 rowLocks += fRows[i].fLocks; 310 if (0 == fRows[i].fLocks) { 311 ++freeRows; 312 bool inLRU = false; 313 // Step through the LRU and make sure it's present 314 for (AtlasRow* r = fLRUFront; r != NULL; r = r->fNext) { 315 if (r == &fRows[i]) { 316 inLRU = true; 317 break; 318 } 319 } 320 GrAssert(inLRU); 321 } else { 322 // If we are locked, we should have a key 323 GrAssert(kEmptyAtlasRowKey != fRows[i].fKey); 324 } 325 326 // If we have a key != kEmptyAtlasRowKey, it should be in the key table 327 GrAssert(fRows[i].fKey == kEmptyAtlasRowKey || this->searchByKey(fRows[i].fKey) >= 0); 328 } 329 330 // Our count of locks should equal the sum of row locks, unless we ran out of rows and flushed, 331 // in which case we'll have one more lock than recorded in the rows (to represent the pending 332 // lock of a row; which ensures we don't unlock the texture prematurely). 333 GrAssert(rowLocks == fLockedRows || rowLocks + 1 == fLockedRows); 334 335 // We should have one lru entry for each free row 336 GrAssert(freeRows == lruCount); 337 338 // If we have locked rows, we should have a locked texture, otherwise 339 // it should be unlocked 340 if (fLockedRows == 0) { 341 GrAssert(NULL == fTexture); 342 } else { 343 GrAssert(NULL != fTexture); 344 } 345 } 346 #endif 347
