man/org.freedesktop.oom1.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" >
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="org.freedesktop.oom1" conditional='ENABLE_OOMD'
   7     xmlns:xi="http://www.w3.org/2001/XInclude">
   8   <refentryinfo>
   9     <title>org.freedesktop.oom1</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>org.freedesktop.oom1</refentrytitle>
  15     <manvolnum>5</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>org.freedesktop.oom1</refname>
  20     <refpurpose>The D-Bus interface of systemd-oomd</refpurpose>
  21   </refnamediv>
  22
  23   <refsect1>
  24     <title>Introduction</title>
  25
  26     <para>
  27     <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  28     is a system service which implements a userspace out-of-memory (OOM) killer. This page describes the
  29     D-Bus interface.</para>
  30   </refsect1>
  31
  32   <refsect1>
  33     <title>The Manager Object</title>
  34
  35     <para>The service exposes the following interfaces on the Manager object on the bus:</para>
  36
  37     <programlisting executable="systemd-oomd" node="/org/freedesktop/oom1" interface="org.freedesktop.oom1.Manager">
  38 node /org/freedesktop/oom1 {
  39   interface org.freedesktop.oom1.Manager {
  40     methods:
  41       DumpByFileDescriptor(out h fd);
  42     signals:
  43       Killed(s cgroup,
  44              s reason);
  45   };
  46   interface org.freedesktop.DBus.Peer { ... };
  47   interface org.freedesktop.DBus.Introspectable { ... };
  48   interface org.freedesktop.DBus.Properties { ... };
  49 };
  50     </programlisting>
  51
  52     <!--method DumpByFileDescriptor is not documented!-->
  53
  54     <!--Autogenerated cross-references for systemd.directives, do not edit-->
  55
  56     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.oom1.Manager"/>
  57
  58     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.oom1.Manager"/>
  59
  60     <variablelist class="dbus-method" generated="True" extra-ref="DumpByFileDescriptor()"/>
  61
  62     <variablelist class="dbus-signal" generated="True" extra-ref="Killed"/>
  63
  64     <!--End of Autogenerated section-->
  65
  66     <refsect2>
  67       <title>Methods</title>
  68
  69       <para><function>Killed</function> signal is sent when any cgroup is killed by oomd.</para>
  70       <para>Note that more reasons will be added in the future, and the table below will be expanded accordingly.</para>
  71       <table>
  72         <title>Killing reasons</title>
  73         <tgroup cols="2" align="left" colsep="1" rowsep="1">
  74         <colspec colname="reason"/>
  75         <colspec colname="description"/>
  76         <thead>
  77           <row>
  78             <entry>Reason</entry>
  79             <entry>Description</entry>
  80           </row>
  81         </thead>
  82         <tbody>
  83           <row>
  84             <entry>memory-used</entry>
  85             <entry>Application took too much memory and swap.</entry>
  86           </row>
  87           <row>
  88             <entry>memory-pressure</entry>
  89             <entry>Application took enough memory and swap to cause sufficient slowdown of other applications.</entry>
  90           </row>
  91         </tbody>
  92         </tgroup>
  93       </table>
  94     </refsect2>
  95   </refsect1>
  96
  97   <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/>
  98
  99   <refsect1>
 100     <title>History</title>
 101     <refsect2>
 102       <title>The Manager Object</title>
 103       <para><function>Killed</function> was added in version 252.</para>
 104     </refsect2>
 105   </refsect1>
 106 </refentry>