memory/mozalloc/mozalloc_oom.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=4 et :
   3  */
   4 /* This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   7
   8 #ifndef mozilla_mozalloc_oom_h
   9 #define mozilla_mozalloc_oom_h
  10
  11 #include "mozalloc.h"
  12
  13 /**
  14  * Called when memory is critically low.  Returns iff it was able to
  15  * remedy the critical memory situation; if not, it will abort().
  16  */
  17 MFBT_API void mozalloc_handle_oom(size_t requestedSize);
  18
  19 /**
  20  * Called by embedders (specifically Mozilla breakpad) which wants to be
  21  * notified of an intentional abort, to annotate any crash report with
  22  * the size of the allocation on which we aborted.
  23  */
  24 typedef void (*mozalloc_oom_abort_handler)(size_t size);
  25 MFBT_API void mozalloc_set_oom_abort_handler(
  26     mozalloc_oom_abort_handler handler);
  27
  28 /* TODO: functions to query system memory usage and register
  29  * critical-memory handlers. */
  30
  31 #endif /* ifndef mozilla_mozalloc_oom_h */