Module `rsyscall.sys.prctl`

#include <sys/prctl.h>

Expand source code Browse git

"`#include <sys/prctl.h>`"
from rsyscall._raw import lib # type: ignore
import typing as t
import enum

__all__ = [
    "PR",
    "PR_CAP_AMBIENT",
    "PrctlTask",
]

class PR(enum.IntEnum):
    GET_NAME = lib.PR_GET_NAME
    SET_NAME = lib.PR_SET_NAME
    SET_PDEATHSIG = lib.PR_SET_PDEATHSIG
    CAP_AMBIENT = lib.PR_CAP_AMBIENT

class PR_CAP_AMBIENT(enum.IntEnum):
    RAISE = lib.PR_CAP_AMBIENT_RAISE

#### Classes ####
import rsyscall.far
from rsyscall.handle.pointer import Pointer, WrittenPointer, ReadablePointer
from rsyscall.sys.capability import CAP
from rsyscall.signal import SIG

class PrctlTask(rsyscall.far.Task):
    "A base class providing the `prctl` syscall"

    async def prctl_set_pdeathsig(self, option: t.Literal[PR.SET_PDEATHSIG], arg2: t.Union[SIG, t.Literal[0]]) -> None:
        await _prctl(self.sysif, option, arg2)

    async def prctl_cap_ambient(self, option: t.Literal[PR.CAP_AMBIENT], arg2: PR_CAP_AMBIENT, arg3: CAP) -> int:
        return await _prctl(self.sysif, option, arg2, arg3)

    async def prctl_get_name(self, option: t.Literal[PR.GET_NAME], arg2: Pointer[str]) -> ReadablePointer[str]:
        with arg2.borrow(self) as arg2_n:
            await _prctl(self.sysif, option, arg2_n)
            return arg2.readable_split(16)[0]

    async def prctl_set_name(self, option: t.Literal[PR.SET_NAME], arg2: WrittenPointer[str]) -> None:
        with arg2.borrow(self) as arg2_n:
            await _prctl(self.sysif, option, arg2_n)
            return None

    @t.overload
    async def prctl(self, option: t.Literal[PR.SET_PDEATHSIG], arg2: t.Union[SIG, t.Literal[0]]) -> None: ...
    @t.overload
    async def prctl(self, option: t.Literal[PR.CAP_AMBIENT], arg2: PR_CAP_AMBIENT, arg3: CAP) -> int: ...
    @t.overload
    async def prctl(self, option: t.Literal[PR.GET_NAME], arg2: Pointer[str]) -> ReadablePointer[str]: ...
    @t.overload
    async def prctl(self, option: t.Literal[PR.SET_NAME], arg2: WrittenPointer[str]) -> None: ...

    async def prctl(self, option: PR, arg2, arg3=0, arg4=0, arg5=0) -> t.Union[int, Pointer, None]:
        """operations on a process or thread

        This has overloads for each prctl option, so it's type-safe to use this method.

        man: prctl(2)
        """
        if option is PR.SET_PDEATHSIG:
            return await self.prctl_set_pdeathsig(option, arg2)
        elif option is PR.CAP_AMBIENT:
            return await self.prctl_cap_ambient(option, arg2, arg3)
        elif option is PR.GET_NAME:
            return await self.prctl_get_name(option, arg2)
        elif option is PR.SET_NAME:
            return await self.prctl_set_name(option, arg2)
        else:
            return await _prctl(self.sysif, option, arg2, arg3, arg4, arg5)

#### Raw syscalls ####
import rsyscall.near.types as near
from rsyscall.near.sysif import SyscallInterface
from rsyscall.sys.syscall import SYS

async def _prctl(sysif: SyscallInterface, option: PR, arg2: t.Union[int, near.Address],
                 arg3: t.Optional[t.Union[int, near.Address]]=None, arg4: t.Optional[t.Union[int, near.Address]]=None,
                 arg5: t.Optional[t.Union[int, near.Address]]=None) -> int:
    if arg3 is None:
        arg3 = 0
    if arg4 is None:
        arg4 = 0
    if arg5 is None:
        arg5 = 0
    return (await sysif.syscall(SYS.prctl, option, arg2, arg3, arg4, arg5))

Classes

class PR (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code Browse git

class PR(enum.IntEnum):
    GET_NAME = lib.PR_GET_NAME
    SET_NAME = lib.PR_SET_NAME
    SET_PDEATHSIG = lib.PR_SET_PDEATHSIG
    CAP_AMBIENT = lib.PR_CAP_AMBIENT

Ancestors

enum.IntEnum
builtins.int
enum.Enum

Class variables

var GET_NAME
var SET_NAME
var SET_PDEATHSIG
var CAP_AMBIENT

class PR_CAP_AMBIENT (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code Browse git

class PR_CAP_AMBIENT(enum.IntEnum):
    RAISE = lib.PR_CAP_AMBIENT_RAISE

Ancestors

enum.IntEnum
builtins.int
enum.Enum

Class variables

var RAISE

class PrctlTask (sysif: SyscallInterface, near_process: Process, fd_table: FDTable, address_space: AddressSpace, pidns: PidNamespace)

A base class providing the prctl syscall

Expand source code Browse git

class PrctlTask(rsyscall.far.Task):
    "A base class providing the `prctl` syscall"

    async def prctl_set_pdeathsig(self, option: t.Literal[PR.SET_PDEATHSIG], arg2: t.Union[SIG, t.Literal[0]]) -> None:
        await _prctl(self.sysif, option, arg2)

    async def prctl_cap_ambient(self, option: t.Literal[PR.CAP_AMBIENT], arg2: PR_CAP_AMBIENT, arg3: CAP) -> int:
        return await _prctl(self.sysif, option, arg2, arg3)

    async def prctl_get_name(self, option: t.Literal[PR.GET_NAME], arg2: Pointer[str]) -> ReadablePointer[str]:
        with arg2.borrow(self) as arg2_n:
            await _prctl(self.sysif, option, arg2_n)
            return arg2.readable_split(16)[0]

    async def prctl_set_name(self, option: t.Literal[PR.SET_NAME], arg2: WrittenPointer[str]) -> None:
        with arg2.borrow(self) as arg2_n:
            await _prctl(self.sysif, option, arg2_n)
            return None

    @t.overload
    async def prctl(self, option: t.Literal[PR.SET_PDEATHSIG], arg2: t.Union[SIG, t.Literal[0]]) -> None: ...
    @t.overload
    async def prctl(self, option: t.Literal[PR.CAP_AMBIENT], arg2: PR_CAP_AMBIENT, arg3: CAP) -> int: ...
    @t.overload
    async def prctl(self, option: t.Literal[PR.GET_NAME], arg2: Pointer[str]) -> ReadablePointer[str]: ...
    @t.overload
    async def prctl(self, option: t.Literal[PR.SET_NAME], arg2: WrittenPointer[str]) -> None: ...

    async def prctl(self, option: PR, arg2, arg3=0, arg4=0, arg5=0) -> t.Union[int, Pointer, None]:
        """operations on a process or thread

        This has overloads for each prctl option, so it's type-safe to use this method.

        man: prctl(2)
        """
        if option is PR.SET_PDEATHSIG:
            return await self.prctl_set_pdeathsig(option, arg2)
        elif option is PR.CAP_AMBIENT:
            return await self.prctl_cap_ambient(option, arg2, arg3)
        elif option is PR.GET_NAME:
            return await self.prctl_get_name(option, arg2)
        elif option is PR.SET_NAME:
            return await self.prctl_set_name(option, arg2)
        else:
            return await _prctl(self.sysif, option, arg2, arg3, arg4, arg5)

Ancestors

Task

Subclasses

Task

Class variables

var sysif : SyscallInterface
var near_process : Process
var fd_table : FDTable
var address_space : AddressSpace
var pidns : PidNamespace

Methods

async def prctl_set_pdeathsig(self, option: Literal[<PR.SET_PDEATHSIG: 1>], arg2: Union[SIG, Literal[0]]) ‑> NoneType

Expand source code Browse git

async def prctl_set_pdeathsig(self, option: t.Literal[PR.SET_PDEATHSIG], arg2: t.Union[SIG, t.Literal[0]]) -> None:
    await _prctl(self.sysif, option, arg2)

async def prctl_cap_ambient(self, option: Literal[<PR.CAP_AMBIENT: 47>], arg2: PR_CAP_AMBIENT, arg3: CAP) ‑> int

Expand source code Browse git

async def prctl_cap_ambient(self, option: t.Literal[PR.CAP_AMBIENT], arg2: PR_CAP_AMBIENT, arg3: CAP) -> int:
    return await _prctl(self.sysif, option, arg2, arg3)

async def prctl_get_name(self, option: Literal[<PR.GET_NAME: 16>], arg2: Pointer[str]) ‑> ReadablePointer[str]

Expand source code Browse git

async def prctl_get_name(self, option: t.Literal[PR.GET_NAME], arg2: Pointer[str]) -> ReadablePointer[str]:
    with arg2.borrow(self) as arg2_n:
        await _prctl(self.sysif, option, arg2_n)
        return arg2.readable_split(16)[0]

async def prctl_set_name(self, option: Literal[<PR.SET_NAME: 15>], arg2: WrittenPointer[str]) ‑> NoneType

Expand source code Browse git

async def prctl_set_name(self, option: t.Literal[PR.SET_NAME], arg2: WrittenPointer[str]) -> None:
    with arg2.borrow(self) as arg2_n:
        await _prctl(self.sysif, option, arg2_n)
        return None

async def prctl(self, option: PR, arg2, arg3=0, arg4=0, arg5=0) ‑> Union[int, Pointer, NoneType]

operations on a process or thread

This has overloads for each prctl option, so it's type-safe to use this method.

man: prctl(2)

Expand source code Browse git

async def prctl(self, option: PR, arg2, arg3=0, arg4=0, arg5=0) -> t.Union[int, Pointer, None]:
    """operations on a process or thread

    This has overloads for each prctl option, so it's type-safe to use this method.

    man: prctl(2)
    """
    if option is PR.SET_PDEATHSIG:
        return await self.prctl_set_pdeathsig(option, arg2)
    elif option is PR.CAP_AMBIENT:
        return await self.prctl_cap_ambient(option, arg2, arg3)
    elif option is PR.GET_NAME:
        return await self.prctl_get_name(option, arg2)
    elif option is PR.SET_NAME:
        return await self.prctl_set_name(option, arg2)
    else:
        return await _prctl(self.sysif, option, arg2, arg3, arg4, arg5)