Method add_mapping

qiling/os/mapper.py:189–218

Create a new mapping in the virtual filesystem. Args: vpath: a virtual path to bind binding: a target to use whenever the bound virtual path is referenced. such a target can be either a path on the host filesystem, an object instance or a class. the beha

(self, vpath: QlPath, binding: Union[QlPath, QlFsMappedObject, Callable], *, force: bool = False)

        raise TypeError(path)

    def add_mapping(self, vpath: QlPath, binding: Union[QlPath, QlFsMappedObject, Callable], *, force: bool = False) -> None:
        """Create a new mapping in the virtual filesystem.

        Args:
            vpath: a virtual path to bind

            binding: a target to use whenever the bound virtual path is referenced. such a target can be
            either a path on the host filesystem, an object instance or a class. the behavior of the mapping
            is determined by the bound object type:
                [*] a string: bind a path on the host filesystem (e.g. "/dev/urandom"). use with caution!
                [*] an object: bind an object instance which will be returned each time the virtual path is opened
                [*] a class: bind a class that will be instantiated each time the virtual path is opened

            force: when set to `True`, re-mapping an existing vpath becomes possible. In such case, the
            old mapping will be discarded

        Raises:
            `KeyError`: in case the specified vpath has already been mapped (default behavior).
        """

        vpath = self.__fspath(vpath)
        absvpath = self.path.virtual_abspath(vpath)

        if self.has_mapping(absvpath) and not force:
            raise KeyError(f'mapping already exists: "{absvpath}"')

        if isinstance(binding, (str, bytes, PathLike)):
            binding = self.__fspath(binding)

        self._mapping[absvpath] = binding

    def remove_mapping(self, vpath: QlPath) -> None:
        """Remove a mapping from the fs mapper.