hphp/runtime/base/weakref-data.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-present Facebook, Inc. (http://www.facebook.com)  |
   6    +----------------------------------------------------------------------+
   7    | This source file is subject to version 3.01 of the PHP license,      |
   8    | that is bundled with this package in the file LICENSE, and is        |
   9    | available through the world-wide-web at the following url:           |
  10    | http://www.php.net/license/3_01.txt                                  |
  11    | If you did not receive a copy of the PHP license and are unable to   |
  12    | obtain it through the world-wide-web, please send a note to          |
  13    | license@php.net so we can mail you a copy immediately.               |
  14    +----------------------------------------------------------------------+
  15 */
  16 #ifndef incl_HPHP_WEAKREF_DATA_H_
  17 #define incl_HPHP_WEAKREF_DATA_H_
  18
  19 #include "hphp/runtime/base/req-memory.h"
  20 #include "hphp/runtime/base/typed-value.h"
  21
  22 #include "hphp/util/type-scan.h"
  23
  24 namespace HPHP {
  25
  26 struct Object;
  27
  28 // A single WeakRefData is shared between all WeakRefs to a given refcounted
  29 // object.
  30 struct WeakRefData {
  31   TypedValue pointee; // Object being weakly referenced.
  32   TYPE_SCAN_CUSTOM() {
  33     scanner.weak(this);
  34   }
  35
  36   // Invalidate WeakRefData associated with a refcounted object.
  37   static void invalidateWeakRef(uintptr_t ptr);
  38
  39   // Create or find WeakRefData for a given refcounted object.
  40   static req::shared_ptr<WeakRefData> forObject(Object obj);
  41
  42   ~WeakRefData();
  43   explicit WeakRefData(const TypedValue& tv): pointee(tv) {}
  44
  45   bool isValid() const;
  46 };
  47
  48 void weakref_cleanup();
  49
  50 } // namespace HPHP
  51 #endif // incl_HPHP_WEAKREF_DATA_H_