Method add_memory_region

python/binaryview.py:2384–2431

Adds a memory region to the memory map. Depending on the source parameter, the memory region is created as one of the following types: - **BinaryMemoryRegion** (***Unimplemented***): Represents a memory region loaded from a binary format, providing persistence across sessions. - **DataMemory

(self, name: str, start: int, source: Union['os.PathLike', str, bytes, bytearray, 'BinaryView', 'databuffer.DataBuffer', 'fileaccessor.FileAccessor'], flags: SegmentFlag = 0)

		core.BNSetLogicalMemoryMapEnabled(self.handle, enabled)

	def add_memory_region(self, name: str, start: int, source: Union['os.PathLike', str, bytes, bytearray, 'BinaryView', 'databuffer.DataBuffer', 'fileaccessor.FileAccessor'], flags: SegmentFlag = 0) -> bool:
		"""
		Adds a memory region to the memory map. Depending on the source parameter, the memory region is created as one of the following types:

		- **BinaryMemoryRegion** (***Unimplemented***): Represents a memory region loaded from a binary format, providing persistence across sessions.
		- **DataMemoryRegion**: Represents a memory region loaded from flat files or raw bytes, providing persistence across sessions.
		- **RemoteMemoryRegion**: Represents a memory region managed via a proxy callback interface. This region is ephemeral and not persisted across sessions.

		The type of memory region created is determined by the `source` parameter:
		- `os.PathLike` or `str`: Treated as a file path to be loaded into memory as a `DataMemoryRegion`.
		- `bytes` or `bytearray`: Directly loaded into memory as a `DataMemoryRegion`.
		- `databuffer.DataBuffer`: Loaded as a `DataMemoryRegion`.
		- `fileaccessor.FileAccessor`: Creates a `RemoteMemoryRegion` that fetches data via a remote source.
		- `BinaryView`: (Not yet implemented) Intended for future exploration.

		.. note:: If no flags are specified and the new memory region overlaps with one or more existing regions, the overlapping portions of the new region will inherit the flags of the respective underlying regions.

		Parameters:
			name (str): A unique name for the memory region.
			start (int): The starting address in memory for the region.
			source (Union[os.PathLike, str, bytes, bytearray, BinaryView, databuffer.DataBuffer, fileaccessor.FileAccessor]): The source from which the memory is loaded.
			flags (SegmentFlag, optional): Flags to apply to the memory region. Defaults to 0 (no flags).

		Returns:
			bool: `True` if the memory region was successfully added, `False` otherwise.

		Raises:
			NotImplementedError: If the specified `source` type is unsupported.
		"""
		if isinstance(source, os.PathLike):
			source = str(source)
		if isinstance(source, bytes) or isinstance(source, bytearray):
			source = databuffer.DataBuffer(source)
		if isinstance(source, str):
			with open(source, "rb") as f:
				source = databuffer.DataBuffer(f.read())

		if name is None:
			name = ""

		if isinstance(source, BinaryView):
			return core.BNAddBinaryMemoryRegion(self.handle, name, start, source.handle, flags)
		elif isinstance(source, databuffer.DataBuffer):
			return core.BNAddDataMemoryRegion(self.handle, name, start, source.handle, flags)
		elif isinstance(source, fileaccessor.FileAccessor):
			return core.BNAddRemoteMemoryRegion(self.handle, name, start, source._cb, flags)
		else:
			raise NotImplementedError

	def remove_memory_region(self, name: str) -> bool:
		return core.BNRemoveMemoryRegion(self.handle, name)