summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-tumbleweed/man5/org.freedesktop.oom1.5
blob: 85840abbb7796c5c21dbc70893ead854de2a71d0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
'\" t
.TH "ORG\&.FREEDESKTOP\&.OOM1" "5" "" "systemd 255" "org.freedesktop.oom1"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
org.freedesktop.oom1 \- The D\-Bus interface of systemd\-oomd
.SH "INTRODUCTION"
.PP
\fBsystemd-oomd.service\fR(8)
is a system service which implements a userspace out\-of\-memory (OOM) killer\&. This page describes the D\-Bus interface\&.
.SH "THE MANAGER OBJECT"
.PP
The service exposes the following interfaces on the Manager object on the bus:
.sp
.if n \{\
.RS 4
.\}
.nf
node /org/freedesktop/oom1 {
  interface org\&.freedesktop\&.oom1\&.Manager {
    methods:
      DumpByFileDescriptor(out h fd);
    signals:
      Killed(s cgroup,
             s reason);
  };
  interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
  interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
  interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
};
    
.fi
.if n \{\
.RE
.\}



.SS "Methods"
.PP
\fBKilled\fR
signal is sent when any cgroup is killed by oomd\&.
.PP
Note that more reasons will be added in the future, and the table below will be expanded accordingly\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&1.\ \&Killing reasons
.TS
allbox tab(:);
lB lB.
T{
Reason
T}:T{
Description
T}
.T&
l l
l l.
T{
memory\-used
T}:T{
Application took too much memory and swap\&.
T}
T{
memory\-pressure
T}:T{
Application took enough memory and swap to cause sufficient slowdown of other applications\&.
T}
.TE
.sp 1
.SH "VERSIONING"
.PP
These D\-Bus interfaces follow
\m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[1]\d\s+2\&.
.SH "HISTORY"
.SS "The Manager Object"
.PP
\fBKilled\fR
was added in version 252\&.
.SH "NOTES"
.IP " 1." 4
the usual interface versioning guidelines
.RS 4
\%https://0pointer.de/blog/projects/versioning-dbus.html
.RE