#include "BsResources.h" #include "BsResource.h" #include "BsResourceManifest.h" #include "BsException.h" #include "BsFileSerializer.h" #include "BsFileSystem.h" #include "BsTaskScheduler.h" #include "BsUUID.h" #include "BsDebug.h" #include "BsUtility.h" #include "BsSavedResourceData.h" #include "BsResourceListenerManager.h" namespace BansheeEngine { Resources::Resources() { mDefaultResourceManifest = ResourceManifest::create("Default"); mResourceManifests.push_back(mDefaultResourceManifest); } Resources::~Resources() { // Unload and invalidate all resources UnorderedMap loadedResourcesCopy = mLoadedResources; for (auto& loadedResourcePair : loadedResourcesCopy) { unload(loadedResourcePair.second); // Invalidate the handle loadedResourcePair.second._setHandleData(nullptr, ""); } } HResource Resources::load(const Path& filePath, bool loadDependencies) { String uuid; bool foundUUID = getUUIDFromFilePath(filePath, uuid); if (!foundUUID) uuid = UUIDGenerator::generateRandom(); return loadInternal(uuid, filePath, true, loadDependencies); } HResource Resources::loadAsync(const Path& filePath, bool loadDependencies) { String uuid; bool foundUUID = getUUIDFromFilePath(filePath, uuid); if (!foundUUID) uuid = UUIDGenerator::generateRandom(); return loadInternal(uuid, filePath, false, loadDependencies); } HResource Resources::loadFromUUID(const String& uuid, bool async, bool loadDependencies) { Path filePath; // Default manifest is at 0th index but all other take priority since Default manifest could // contain obsolete data. for(auto iter = mResourceManifests.rbegin(); iter != mResourceManifests.rend(); ++iter) { if((*iter)->uuidToFilePath(uuid, filePath)) break; } return loadInternal(uuid, filePath, !async, loadDependencies); } HResource Resources::loadInternal(const String& UUID, const Path& filePath, bool synchronous, bool loadDependencies) { HResource outputResource; // Check if resource is already full loaded bool alreadyLoading = false; { BS_LOCK_MUTEX(mLoadedResourceMutex); auto iterFind = mLoadedResources.find(UUID); if(iterFind != mLoadedResources.end()) // Resource is already loaded { outputResource = iterFind->second; alreadyLoading = true; } } // Check if resource is already being loaded on a worker thread bool loadInProgress = false; if (!alreadyLoading) // If not already detected as loaded { { BS_LOCK_MUTEX(mInProgressResourcesMutex); auto iterFind2 = mInProgressResources.find(UUID); if (iterFind2 != mInProgressResources.end()) { outputResource = iterFind2->second->resource; alreadyLoading = true; loadInProgress = true; } } // Previously being loaded as async but now we want it synced, so we wait if (loadInProgress && synchronous) outputResource.blockUntilLoaded(); } // Not loaded and not in progress, start loading of new resource // (or if already loaded or in progress, load any dependencies) if (!alreadyLoading) outputResource = HResource(UUID); // We have nowhere to load from, warn and complete load if a file path was provided, // otherwise pass through as we might just want to load from memory. if (filePath.isEmpty()) { if (!alreadyLoading) { gDebug().logWarning("Cannot load resource. Resource with UUID '" + UUID + "' doesn't exist."); // Complete the load as that the depedency counter is properly reduced, in case this // is a dependency of some other resource. loadComplete(outputResource); return outputResource; } } else if (!FileSystem::isFile(filePath)) { LOGWRN("Cannot load resource. Specified file: " + filePath.toString() + " doesn't exist."); // Complete the load as that the depedency counter is properly reduced, in case this // is a dependency of some other resource. loadComplete(outputResource); assert(!loadInProgress); // Resource already being loaded but we can't find its path now? return outputResource; } // Load dependency data if a file path is provided SPtr savedResourceData; if (!filePath.isEmpty()) { FileDecoder fs(filePath); savedResourceData = std::static_pointer_cast(fs.decode()); } // If already loading keep the old load operation active, otherwise create a new one if (!alreadyLoading) { { BS_LOCK_MUTEX(mInProgressResourcesMutex); ResourceLoadData* loadData = bs_new(outputResource, 0); mInProgressResources[UUID] = loadData; loadData->resource = outputResource; loadData->remainingDependencies = 1; loadData->notifyImmediately = synchronous; // Make resource listener trigger before exit if loading synchronously // Register dependencies and count them so we know when the resource is fully loaded if (loadDependencies && savedResourceData != nullptr) { for (auto& dependency : savedResourceData->getDependencies()) { if (dependency != UUID) { mDependantLoads[dependency].push_back(loadData); loadData->remainingDependencies++; } } } } if (loadDependencies && savedResourceData != nullptr) { for (auto& dependency : savedResourceData->getDependencies()) { loadFromUUID(dependency, !synchronous); } } } else if (loadDependencies && savedResourceData != nullptr) // Queue dependencies in case they aren't already loaded { const Vector& dependencies = savedResourceData->getDependencies(); if (!dependencies.empty()) { { BS_LOCK_MUTEX(mInProgressResourcesMutex); ResourceLoadData* loadData = nullptr; auto iterFind = mInProgressResources.find(UUID); if (iterFind == mInProgressResources.end()) // Fully loaded { loadData = bs_new(outputResource, 0); loadData->resource = outputResource; loadData->remainingDependencies = 0; loadData->notifyImmediately = synchronous; // Make resource listener trigger before exit if loading synchronously mInProgressResources[UUID] = loadData; } else { loadData = iterFind->second; } // Register dependencies and count them so we know when the resource is fully loaded for (auto& dependency : dependencies) { if (dependency != UUID) { bool registerDependency = true; auto iterFind2 = mDependantLoads.find(dependency); if (iterFind2 != mDependantLoads.end()) { Vector& dependantData = iterFind2->second; auto iterFind3 = std::find_if(dependantData.begin(), dependantData.end(), [&](ResourceLoadData* x) { return x->resource.getUUID() == outputResource.getUUID(); }); registerDependency = iterFind3 == dependantData.end(); } if (registerDependency) { mDependantLoads[dependency].push_back(loadData); loadData->remainingDependencies++; } } } } for (auto& dependency : dependencies) loadFromUUID(dependency, !synchronous); } } // Actually start the file read operation if not already loaded or in progress if (!alreadyLoading && !filePath.isEmpty()) { // Synchronous or the resource doesn't support async, read the file immediately if (synchronous || !savedResourceData->allowAsyncLoading()) { loadCallback(filePath, outputResource); } else // Asynchronous, read the file on a worker thread { String fileName = filePath.getFilename(); String taskName = "Resource load: " + fileName; TaskPtr task = Task::create(taskName, std::bind(&Resources::loadCallback, this, filePath, outputResource)); TaskScheduler::instance().addTask(task); } } else // File already loaded or in progress { // Complete the load unless its in progress in which case we wait for its worker thread to complete it. // In case file is already loaded this will only decrement dependency count in case this resource is a dependency. if (!loadInProgress) loadComplete(outputResource); else { // In case loading finished in the meantime we cannot be sure at what point ::loadComplete was triggered, // so trigger it manually so that the dependency count is properly decremented in case this resource // is a dependency. BS_LOCK_MUTEX(mLoadedResourceMutex); auto iterFind = mLoadedResources.find(UUID); if (iterFind != mLoadedResources.end()) loadComplete(outputResource); } } return outputResource; } ResourcePtr Resources::loadFromDiskAndDeserialize(const Path& filePath) { FileDecoder fs(filePath); fs.skip(); // Skipped over saved resource data std::shared_ptr loadedData = fs.decode(); if(loadedData == nullptr) BS_EXCEPT(InternalErrorException, "Unable to load resource."); if(!loadedData->isDerivedFrom(Resource::getRTTIStatic())) BS_EXCEPT(InternalErrorException, "Loaded class doesn't derive from Resource."); ResourcePtr resource = std::static_pointer_cast(loadedData); return resource; } void Resources::unload(HResource resource) { if (resource == nullptr) return; if (!resource.isLoaded()) // If it's still loading wait until that finishes { LOGWRN("Performance warning: Unloading a resource that is still in process of loading " "causes a stall until resource finishes loading."); resource.blockUntilLoaded(); } Vector dependencies = Utility::findResourceDependencies(*resource.get()); // Call this before we actually destroy it onResourceDestroyed(resource); resource->destroy(); { BS_LOCK_MUTEX(mLoadedResourceMutex); mLoadedResources.erase(resource.getUUID()); } resource._setHandleData(nullptr, ""); for (auto& dependency : dependencies) { HResource dependantResource = dependency.resource; // Last reference was kept by the unloaded resource, so unload the dependency too if ((UINT32)dependantResource.mData.use_count() == (dependency.numReferences + 1)) { // TODO - Use count is not thread safe. Meaning it might increase after above check, in // which case we will be unloading a resource that is in use. I don't see a way around // it at the moment. unload(dependantResource); } } } void Resources::unloadAllUnused() { Vector resourcesToUnload; { BS_LOCK_MUTEX(mLoadedResourceMutex); for(auto iter = mLoadedResources.begin(); iter != mLoadedResources.end(); ++iter) { if (iter->second.mData.unique()) // We just have this one reference, meaning nothing is using this resource resourcesToUnload.push_back(iter->second); } } // Note: When unloading multiple resources it's possible that unloading one will also unload // another resource in "resourcesToUnload". This is fine because "unload" deals with invalid // handles gracefully. for(auto iter = resourcesToUnload.begin(); iter != resourcesToUnload.end(); ++iter) { unload(*iter); } } void Resources::save(HResource resource, const Path& filePath, bool overwrite) { if(!resource.isLoaded()) resource.blockUntilLoaded(); bool fileExists = FileSystem::isFile(filePath); if(fileExists) { if(overwrite) FileSystem::remove(filePath); else BS_EXCEPT(InvalidParametersException, "Another file exists at the specified location."); } mDefaultResourceManifest->registerResource(resource.getUUID(), filePath); Vector dependencyList = Utility::findResourceDependencies(*resource.get()); Vector dependencyUUIDs(dependencyList.size()); for (UINT32 i = 0; i < (UINT32)dependencyList.size(); i++) dependencyUUIDs[i] = dependencyList[i].resource.getUUID(); SPtr resourceData = bs_shared_ptr_new(dependencyUUIDs, resource->allowAsyncLoading()); FileEncoder fs(filePath); fs.encode(resourceData.get()); fs.encode(resource.get()); } void Resources::save(HResource resource) { if (resource == nullptr) return; Path path; if (getFilePathFromUUID(resource.getUUID(), path)) save(resource, path, true); } void Resources::registerResourceManifest(const ResourceManifestPtr& manifest) { if(manifest->getName() == "Default") return; auto findIter = std::find(mResourceManifests.begin(), mResourceManifests.end(), manifest); if(findIter == mResourceManifests.end()) mResourceManifests.push_back(manifest); else *findIter = manifest; } void Resources::unregisterResourceManifest(const ResourceManifestPtr& manifest) { if (manifest->getName() == "Default") return; auto findIter = std::find(mResourceManifests.begin(), mResourceManifests.end(), manifest); if (findIter != mResourceManifests.end()) mResourceManifests.erase(findIter); } ResourceManifestPtr Resources::getResourceManifest(const String& name) const { for(auto iter = mResourceManifests.rbegin(); iter != mResourceManifests.rend(); ++iter) { if(name == (*iter)->getName()) return (*iter); } return nullptr; } bool Resources::isLoaded(const String& uuid, bool checkInProgress) { if (checkInProgress) { BS_LOCK_MUTEX(mInProgressResourcesMutex); auto iterFind2 = mInProgressResources.find(uuid); if (iterFind2 != mInProgressResources.end()) { return true; } { BS_LOCK_MUTEX(mLoadedResourceMutex); auto iterFind = mLoadedResources.find(uuid); if (iterFind != mLoadedResources.end()) { return true; } } } return false; } HResource Resources::_createResourceHandle(const ResourcePtr& obj) { String uuid = UUIDGenerator::generateRandom(); HResource newHandle(obj, uuid); { BS_LOCK_MUTEX(mLoadedResourceMutex); mLoadedResources[uuid] = newHandle; } return newHandle; } HResource Resources::_getResourceHandle(const String& uuid) { { BS_LOCK_MUTEX(mInProgressResourcesMutex); auto iterFind2 = mInProgressResources.find(uuid); if (iterFind2 != mInProgressResources.end()) { return iterFind2->second->resource; } { BS_LOCK_MUTEX(mLoadedResourceMutex); auto iterFind = mLoadedResources.find(uuid); if (iterFind != mLoadedResources.end()) // Resource is already loaded { return iterFind->second; } } } return HResource(); } bool Resources::getFilePathFromUUID(const String& uuid, Path& filePath) const { for(auto iter = mResourceManifests.rbegin(); iter != mResourceManifests.rend(); ++iter) { if((*iter)->uuidToFilePath(uuid, filePath)) return true; } return false; } bool Resources::getUUIDFromFilePath(const Path& path, String& uuid) const { Path manifestPath = path; if (!manifestPath.isAbsolute()) manifestPath.makeAbsolute(FileSystem::getWorkingDirectoryPath()); for(auto iter = mResourceManifests.rbegin(); iter != mResourceManifests.rend(); ++iter) { if ((*iter)->filePathToUUID(manifestPath, uuid)) return true; } return false; } void Resources::loadComplete(HResource& resource) { String uuid = resource.getUUID(); ResourceLoadData* myLoadData = nullptr; bool finishLoad = true; Vector dependantLoads; { BS_LOCK_MUTEX(mInProgressResourcesMutex); auto iterFind = mInProgressResources.find(uuid); if (iterFind != mInProgressResources.end()) { myLoadData = iterFind->second; finishLoad = myLoadData->remainingDependencies == 0; if (finishLoad) mInProgressResources.erase(iterFind); } auto iterFind2 = mDependantLoads.find(uuid); if (iterFind2 != mDependantLoads.end()) dependantLoads = iterFind2->second; if (finishLoad) { mDependantLoads.erase(uuid); // If loadedData is null then we're probably completing load on an already loaded resource, triggered // by its dependencies. if (myLoadData != nullptr && myLoadData->loadedData != nullptr) { BS_LOCK_MUTEX(mLoadedResourceMutex); mLoadedResources[uuid] = resource; resource._setHandleData(myLoadData->loadedData, uuid); } for (auto& dependantLoad : dependantLoads) dependantLoad->remainingDependencies--; } } for (auto& dependantLoad : dependantLoads) loadComplete(dependantLoad->resource); if (finishLoad && myLoadData != nullptr) { onResourceLoaded(resource); // This should only ever be true on the main thread if (myLoadData->notifyImmediately) ResourceListenerManager::instance().notifyListeners(uuid); bs_delete(myLoadData); } } void Resources::loadCallback(const Path& filePath, HResource& resource) { ResourcePtr rawResource = loadFromDiskAndDeserialize(filePath); { BS_LOCK_MUTEX(mInProgressResourcesMutex); // Check if all my dependencies are loaded ResourceLoadData* myLoadData = mInProgressResources[resource.getUUID()]; myLoadData->loadedData = rawResource; myLoadData->remainingDependencies--; } loadComplete(resource); } BS_CORE_EXPORT Resources& gResources() { return Resources::instance(); } }