| 1 |
'\" t |
| 2 |
.TH "ORG\&.FREEDESKTOP\&.OOM1" "5" "" "systemd 261~rc3" "org.freedesktop.oom1" |
| 3 |
.\" ----------------------------------------------------------------- |
| 4 |
.\" * Define some portability stuff |
| 5 |
.\" ----------------------------------------------------------------- |
| 6 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 7 |
.\" http://bugs.debian.org/507673 |
| 8 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| 9 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 10 |
.ie \n(.g .ds Aq \(aq |
| 11 |
.el .ds Aq ' |
| 12 |
.\" ----------------------------------------------------------------- |
| 13 |
.\" * set default formatting |
| 14 |
.\" ----------------------------------------------------------------- |
| 15 |
.\" disable hyphenation |
| 16 |
.nh |
| 17 |
.\" disable justification (adjust text to left margin only) |
| 18 |
.ad l |
| 19 |
.\" ----------------------------------------------------------------- |
| 20 |
.\" * MAIN CONTENT STARTS HERE * |
| 21 |
.\" ----------------------------------------------------------------- |
| 22 |
.SH "NAME" |
| 23 |
org.freedesktop.oom1 \- The D\-Bus interface of systemd\-oomd |
| 24 |
.SH "INTRODUCTION" |
| 25 |
.PP |
| 26 |
\fBsystemd-oomd.service\fR(8) |
| 27 |
is a system service which implements a userspace out\-of\-memory (OOM) killer\&. This page describes the D\-Bus interface\&. |
| 28 |
.SH "THE MANAGER OBJECT" |
| 29 |
.PP |
| 30 |
The service exposes the following interfaces on the Manager object on the bus: |
| 31 |
.sp |
| 32 |
.if n \{\ |
| 33 |
.RS 4 |
| 34 |
.\} |
| 35 |
.nf |
| 36 |
node /org/freedesktop/oom1 { |
| 37 |
interface org\&.freedesktop\&.oom1\&.Manager { |
| 38 |
methods: |
| 39 |
DumpByFileDescriptor(out h fd); |
| 40 |
signals: |
| 41 |
Killed(s cgroup, |
| 42 |
s reason); |
| 43 |
}; |
| 44 |
interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. }; |
| 45 |
interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. }; |
| 46 |
interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. }; |
| 47 |
}; |
| 48 |
.fi |
| 49 |
.if n \{\ |
| 50 |
.RE |
| 51 |
.\} |
| 52 |
|
| 53 |
|
| 54 |
|
| 55 |
.SS "Methods" |
| 56 |
.PP |
| 57 |
\fBKilled()\fR |
| 58 |
signal is sent when any cgroup is killed by oomd\&. |
| 59 |
.PP |
| 60 |
Note that more reasons will be added in the future, and the table below will be expanded accordingly\&. |
| 61 |
.sp |
| 62 |
.it 1 an-trap |
| 63 |
.nr an-no-space-flag 1 |
| 64 |
.nr an-break-flag 1 |
| 65 |
.br |
| 66 |
.B Table\ \&1.\ \&Killing reasons |
| 67 |
.TS |
| 68 |
allbox tab(:); |
| 69 |
lB lB. |
| 70 |
T{ |
| 71 |
Reason |
| 72 |
T}:T{ |
| 73 |
Description |
| 74 |
T} |
| 75 |
.T& |
| 76 |
l l |
| 77 |
l l. |
| 78 |
T{ |
| 79 |
memory\-used |
| 80 |
T}:T{ |
| 81 |
Application took too much memory and swap\&. |
| 82 |
T} |
| 83 |
T{ |
| 84 |
memory\-pressure |
| 85 |
T}:T{ |
| 86 |
Application took enough memory and swap to cause sufficient slowdown of other applications\&. |
| 87 |
T} |
| 88 |
.TE |
| 89 |
.sp 1 |
| 90 |
.SH "VERSIONING" |
| 91 |
.PP |
| 92 |
These D\-Bus interfaces follow |
| 93 |
\m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[1]\d\s+2\&. |
| 94 |
.SH "HISTORY" |
| 95 |
.SS "The Manager Object" |
| 96 |
.PP |
| 97 |
\fBKilled()\fR |
| 98 |
was added in version 252\&. |
| 99 |
.SH "SEE ALSO" |
| 100 |
.PP |
| 101 |
\fBsystemd\fR(1), \fBsystemd-oomd.service\fR(8), \fBoomctl\fR(1) |
| 102 |
.SH "NOTES" |
| 103 |
.IP " 1." 4 |
| 104 |
the usual interface versioning guidelines |
| 105 |
.RS 4 |
| 106 |
\%https://0pointer.de/blog/projects/versioning-dbus.html |
| 107 |
.RE |