src/hotspot/share/jfr/utilities/jfrRefCountPointer.hpp
author stefank
Mon, 25 Nov 2019 12:31:39 +0100
changeset 59249 29b0d0b61615
parent 53244 9807daeb47c4
permissions -rw-r--r--
8234737: Harmonize parameter order in Atomic - add Reviewed-by: rehn, dholmes
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     1
/*
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 50113
diff changeset
     2
 * Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     4
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     7
 * published by the Free Software Foundation.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     8
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    13
 * accompanied this code).
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    14
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    18
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    21
 * questions.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    22
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    23
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    24
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 50113
diff changeset
    25
#ifndef SHARE_JFR_UTILITIES_JFRREFCOUNTPOINTER_HPP
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 50113
diff changeset
    26
#define SHARE_JFR_UTILITIES_JFRREFCOUNTPOINTER_HPP
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
#include "jfr/utilities/jfrAllocation.hpp"
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
#include "runtime/atomic.hpp"
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
template <typename T>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
class RefCountHandle {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
  template <typename, typename>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
  friend class RefCountPointer;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
 private:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
  const T* _ptr;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
  RefCountHandle(const T* ptr) : _ptr(ptr) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
    assert(_ptr != NULL, "invariant");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
    _ptr->add_ref();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
  RefCountHandle() : _ptr(NULL) {}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
  RefCountHandle(const RefCountHandle<T>& rhs) : _ptr(rhs._ptr) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
    if (_ptr != NULL) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
      _ptr->add_ref();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
  ~RefCountHandle() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
    if (_ptr != NULL) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
      const T* temp = _ptr;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
      _ptr = NULL;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
      temp->remove_ref();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
  // The copy-and-swap idiom upholds reference counting semantics
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
  void operator=(RefCountHandle<T> rhs) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
    const T* temp = rhs._ptr;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
    rhs._ptr = _ptr;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
    _ptr = temp;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
  bool operator==(const RefCountHandle<T>& rhs) const {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
    return _ptr == rhs._ptr;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
  bool operator!=(const RefCountHandle<T>& rhs) const {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
    return !operator==(rhs);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    73
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    74
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
  bool valid() const {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
    return _ptr != NULL;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    77
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    78
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    79
  const T & operator->() const {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    80
    return *_ptr;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    81
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    82
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    83
  T& operator->() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    84
    return *const_cast<T*>(_ptr);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    85
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    86
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    87
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    88
class MultiThreadedRefCounter {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    89
 private:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    90
  mutable volatile int _refs;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    91
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    92
  MultiThreadedRefCounter() : _refs(0) {}
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    93
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    94
  void inc() const {
59249
29b0d0b61615 8234737: Harmonize parameter order in Atomic - add
stefank
parents: 53244
diff changeset
    95
    Atomic::add(&_refs, 1);
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    96
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    97
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    98
  bool dec() const {
59249
29b0d0b61615 8234737: Harmonize parameter order in Atomic - add
stefank
parents: 53244
diff changeset
    99
    return 0 == Atomic::add(&_refs, (-1));
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   100
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   101
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   102
  int current() const {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   103
   return _refs;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   104
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   105
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   106
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   107
template <typename T, typename RefCountImpl = MultiThreadedRefCounter>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   108
class RefCountPointer : public JfrCHeapObj {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   109
  template <typename>
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   110
  friend class RefCountHandle;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   111
  typedef RefCountHandle<RefCountPointer<T, RefCountImpl> > RefHandle;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   112
 private:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   113
  const T* _ptr;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   114
  mutable RefCountImpl _refs;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   115
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   116
  // disallow multiple copies
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   117
  RefCountPointer(const RefCountPointer<T, RefCountImpl>& rhs);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   118
  void operator=(const RefCountPointer<T, RefCountImpl>& rhs);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   119
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   120
  ~RefCountPointer() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   121
    assert(_refs.current() == 0, "invariant");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   122
    delete const_cast<T*>(_ptr);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   123
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   124
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   125
  void add_ref() const {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   126
    _refs.inc();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   127
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   128
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   129
  void remove_ref() const {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   130
    if (_refs.dec()) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   131
      delete this;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   132
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   133
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   134
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   135
  RefCountPointer(const T* ptr) : _ptr(ptr), _refs() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   136
    assert(_ptr != NULL, "invariant");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   137
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   138
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   139
 public:
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   140
  const T* operator->() const {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   141
    return _ptr;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   142
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   143
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   144
  T* operator->() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   145
    return const_cast<T*>(_ptr);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   146
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   147
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   148
  static RefHandle make(const T* ptr) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   149
    assert(ptr != NULL, "invariant");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   150
    return RefHandle(new RefCountPointer<T, RefCountImpl>(ptr));
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   151
  }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   152
};
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   153
53244
9807daeb47c4 8216167: Update include guards to reflect correct directories
coleenp
parents: 50113
diff changeset
   154
#endif // SHARE_JFR_UTILITIES_JFRREFCOUNTPOINTER_HPP