memory/mozalloc/mozalloc_oom.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  * vim: sw=4 ts=4 et :
   3  */
   4 /* ***** BEGIN LICENSE BLOCK *****
   5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version
   8  * 1.1 (the "License"); you may not use this file except in compliance with
   9  * the License. You may obtain a copy of the License at
  10  * http://www.mozilla.org/MPL/
  11  *
  12  * Software distributed under the License is distributed on an "AS IS" basis,
  13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  14  * for the specific language governing rights and limitations under the
  15  * License.
  16  *
  17  * The Original Code is mozilla.org code.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Mozilla Foundation
  21  * Portions created by the Initial Developer are Copyright (C) 2009
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *  Chris Jones <jones.chris.g@gmail.com>
  26  *
  27  * Alternatively, the contents of this file may be used under the terms of
  28  * either of the GNU General Public License Version 2 or later (the "GPL"),
  29  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30  * in which case the provisions of the GPL or the LGPL are applicable instead
  31  * of those above. If you wish to allow use of your version of this file only
  32  * under the terms of either the GPL or the LGPL, and not to allow others to
  33  * use your version of this file under the terms of the MPL, indicate your
  34  * decision by deleting the provisions above and replace them with the notice
  35  * and other provisions required by the GPL or the LGPL. If you do not delete
  36  * the provisions above, a recipient may use your version of this file under
  37  * the terms of any one of the MPL, the GPL or the LGPL.
  38  *
  39  * ***** END LICENSE BLOCK ***** */
  40
  41 #ifndef mozilla_mozalloc_oom_h
  42 #define mozilla_mozalloc_oom_h
  43
  44 #if defined(MOZALLOC_EXPORT)
  45 // do nothing: it's been defined to __declspec(dllexport) by
  46 // mozalloc*.cpp on platforms where that's required
  47 #elif defined(XP_WIN) || (defined(XP_OS2) && defined(__declspec))
  48 #  define MOZALLOC_EXPORT __declspec(dllimport)
  49 #elif defined(HAVE_VISIBILITY_ATTRIBUTE)
  50 /* Make sure symbols are still exported even if we're wrapped in a
  51  * |visibility push(hidden)| blanket. */
  52 #  define MOZALLOC_EXPORT __attribute__ ((visibility ("default")))
  53 #else
  54 #  define MOZALLOC_EXPORT
  55 #endif
  56
  57
  58 /**
  59  * Called when memory is critically low.  Returns iff it was able to
  60  * remedy the critical memory situation; if not, it will abort().
  61  *
  62  * We have to re-#define MOZALLOC_EXPORT because this header can be
  63  * used indepedently of mozalloc.h.
  64  */
  65 MOZALLOC_EXPORT void mozalloc_handle_oom();
  66
  67
  68 /* TODO: functions to query system memory usage and register
  69  * critical-memory handlers. */
  70
  71
  72 #endif /* ifndef mozilla_mozalloc_oom_h */