synapse.lib.platforms package

Home for platform specific code such as thishost info.

all platform modules must be importable from any platform.

( guard any platform specific code with appropriate conditionals )

Submodules

synapse.lib.platforms.common module

synapse.lib.platforms.common.daemonize()

For unix platforms, form a new process group using fork().

synapse.lib.platforms.common.getLibC()

Return a ctypes reference to libc

synapse.lib.platforms.common.getTempDir()

synapse.lib.platforms.common.getVolInfo(*paths)

Retrieve volume usage info for the given path.

synapse.lib.platforms.common.inet_ntop(afam, byts)

synapse.lib.platforms.common.inet_pton(afam, text)

synapse.lib.platforms.common.initHostInfo()

synapse.lib.platforms.common.setProcName(name)

Set the process title/name for process listing.

synapse.lib.platforms.darwin module

synapse.lib.platforms.darwin.initHostInfo()

synapse.lib.platforms.freebsd module

synapse.lib.platforms.freebsd.initHostInfo()

synapse.lib.platforms.linux module

synapse.lib.platforms.linux.getAvailableMemory()

Returns the available memory of the system

synapse.lib.platforms.linux.getCurrentLockedMemory()

Return the amount of memory this process has locked

synapse.lib.platforms.linux.getFileMappedRegion(filename)

Return a tuple of address and length of a particular file memory mapped into this process

synapse.lib.platforms.linux.getMaxLockedMemory()

Returns the maximum amount of memory this process can lock

synapse.lib.platforms.linux.getSysctls()

synapse.lib.platforms.linux.getTotalMemory()

Get the total amount of memory in the system.

Notes

This attempts to get information from cgroup data before falling back to /proc/meminfo data.

Returns:

The number of bytes of memory available in the system.

Return type:

int

synapse.lib.platforms.linux.initHostInfo()

synapse.lib.platforms.linux.maximizeMaxLockedMemory()

Remove any discretionary (i.e. soft) limits

synapse.lib.platforms.linux.mlock(address, length)

Lock a chunk of memory to prevent it from being swapped out, raising an OSError on error

synapse.lib.platforms.linux.mmap(address, length, prot, flags, fd, offset)

A simple mmap context manager that releases the GIL while mapping and unmapping. It raises an OSError on error

synapse.lib.platforms.linux.munlock(address, length)

Unlock a chunk of memory, raising an OSError on error

synapse.lib.platforms.windows module

synapse.lib.platforms.windows.daemonize()

synapse.lib.platforms.windows.getLibC()

Override to account for python on windows not being able to find libc sometimes…

synapse.lib.platforms.windows.initHostInfo()

class synapse.lib.platforms.windows.sockaddr

Bases: Structure

ipv4

Structure/Union member

ipv6

Structure/Union member

sa_family

Structure/Union member