xpcom/base/nsCycleCollector.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef nsCycleCollector_h__
   8 #define nsCycleCollector_h__
   9
  10 class nsICycleCollectorListener;
  11 class nsICycleCollectorLogSink;
  12 class nsISupports;
  13 template <class T>
  14 struct already_AddRefed;
  15
  16 #include <cstdint>
  17 #include "mozilla/Attributes.h"
  18 #include "mozilla/TimeStamp.h"
  19 #include "nsCycleCollectionParticipant.h"
  20
  21 namespace JS {
  22 class SliceBudget;
  23 }
  24
  25 namespace mozilla {
  26 class CycleCollectedJSContext;
  27 }  // namespace mozilla
  28
  29 bool nsCycleCollector_init();
  30
  31 void nsCycleCollector_startup();
  32
  33 typedef void (*CC_BeforeUnlinkCallback)(void);
  34 void nsCycleCollector_setBeforeUnlinkCallback(CC_BeforeUnlinkCallback aCB);
  35
  36 typedef void (*CC_ForgetSkippableCallback)(void);
  37 void nsCycleCollector_setForgetSkippableCallback(
  38     CC_ForgetSkippableCallback aCB);
  39
  40 void nsCycleCollector_forgetSkippable(mozilla::TimeStamp aStartTime,
  41                                       JS::SliceBudget& aBudget, bool aInIdle,
  42                                       bool aRemoveChildlessNodes = false,
  43                                       bool aAsyncSnowWhiteFreeing = false);
  44
  45 void nsCycleCollector_prepareForGarbageCollection();
  46
  47 // If an incremental cycle collection is in progress, finish it.
  48 void nsCycleCollector_finishAnyCurrentCollection();
  49
  50 void nsCycleCollector_dispatchDeferredDeletion(bool aContinuation = false,
  51                                                bool aPurge = false);
  52 bool nsCycleCollector_doDeferredDeletion();
  53 bool nsCycleCollector_doDeferredDeletionWithBudget(JS::SliceBudget& aBudget);
  54
  55 already_AddRefed<nsICycleCollectorLogSink> nsCycleCollector_createLogSink(
  56     bool aLogGC);
  57 already_AddRefed<nsICycleCollectorListener> nsCycleCollector_createLogger();
  58
  59 // Run a cycle collection and return whether anything was collected.
  60 bool nsCycleCollector_collect(mozilla::CCReason aReason,
  61                               nsICycleCollectorListener* aManualListener);
  62
  63 void nsCycleCollector_collectSlice(JS::SliceBudget& budget,
  64                                    mozilla::CCReason aReason,
  65                                    bool aPreferShorterSlices = false);
  66
  67 uint32_t nsCycleCollector_suspectedCount();
  68
  69 // If aDoCollect is true, then run the GC and CC a few times before
  70 // shutting down the CC completely.
  71 MOZ_CAN_RUN_SCRIPT
  72 void nsCycleCollector_shutdown(bool aDoCollect = true);
  73
  74 // Helpers for interacting with JS
  75 void nsCycleCollector_registerJSContext(mozilla::CycleCollectedJSContext* aCx);
  76 void nsCycleCollector_forgetJSContext();
  77
  78 #endif  // nsCycleCollector_h__