Interface DSEStorage

All Superinterfaces:
DatabaseAPI, ProxyAwareStorage
All Known Implementing Classes:
SQLiteDataSpecStorage

public interface DSEStorage extends ProxyAwareStorage
The interface supported by the DSE part of the storage system.
Author:
Donal Fellows
  • Method Details

    • listEthernetsToLoad

      List<DSEStorage.Ethernet> listEthernetsToLoad() throws StorageException
      Get a list of all ethernets that need to have DSE loading done on them.
      Returns:
      The list of ethernets.
      Throws:
      StorageException - If the database access fails.
    • listCoresToLoad

      List<CoreLocation> listCoresToLoad(DSEStorage.Ethernet ethernet, boolean loadSystemCores) throws StorageException
      Get a list of all cores that need to be done for a particular ethernet.
      Parameters:
      ethernet - The ethernet we're loading onto.
      loadSystemCores - If true, just list system cores. If false, just list application (non-system) cores.
      Returns:
      The list of core locations.
      Throws:
      StorageException - If the database access fails.
    • getRegionSizes

      Get a map of region id to size for regions with a none zero size.
      Parameters:
      xyp - Coordinates to get the region sizes for
      Returns:
      Sorted Map of Region number to size. For the regions with a none zero size
      Throws:
      StorageException - If the database access fails.
    • setStartAddress

      void setStartAddress(CoreLocation xyp, MemoryLocation start) throws StorageException
      Record the start address for the metadata on this core.
      Parameters:
      xyp - Coordinates for the core
      start - Where the load metadata starts.
      Throws:
      StorageException - If the database access fails.
    • getStartAddress

      MemoryLocation getStartAddress(CoreLocation xyp) throws StorageException
      Gets the start address for the metadata on this core.
      Parameters:
      xyp - Coordinates for the core
      Returns:
      The location of the start of the metadata region
      Throws:
      StorageException - If the database access fails.
    • getAppId

      int getAppId() throws StorageException
      Get the system wide app id.
      Returns:
      the app id
      Throws:
      StorageException - If the database access fails.
    • getMachineDimensions

      MachineDimensions getMachineDimensions() throws StorageException
      Get the machine dimensions.
      Returns:
      The machine dimensions.
      Throws:
      StorageException - If the database access fails.
    • setRegionPointer

      void setRegionPointer(CoreLocation xyp, int regionNum, int pointer) throws StorageException
      Set the pointer for where to write the region data to.
      Parameters:
      xyp - Coordinates for the core
      regionNum - region number for this pointer
      pointer - start address for this regions metadata
      Throws:
      StorageException - If the database access fails.
    • getRegionPointersAndContent

      Map<Integer,RegionInfo> getRegionPointersAndContent(CoreLocation xyp) throws StorageException
      Gets a map of region ids to pointers and content Maps only regions with a none zero size. The content may be null is no data added
      Parameters:
      xyp - Coordinates for the core
      Returns:
      map of region number to object holding pointer and content
      Throws:
      StorageException - If the database access fails.