summaryrefslogtreecommitdiffstats
path: root/src/vnet/util/refcount.h
blob: 4c7d7bdbdd5ce6ec12e57b13e92ef9c655df98ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
/*
 * Copyright (c) 2016 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * vlib provides lock-free counters but those
 * - Have 16bits per-CPU counter, which may overflow.
 * - Would only increment.
 *
 * This is very similar to vlib counters, but may be used to count reference.
 * Such a counter includes an arbitrary number of counters. Each counter
 * is identified by its index. This is used to aggregate per-cpu memory.
 *
 * Warning:
 *   This reference counter is lock-free but is not race-condition free.
 *   The counting result is approximate and another mechanism needs to be used
 *   in order to ensure that an object may be freed.
 *
 */

#include <vnet/vnet.h>
#include <vppinfra/lock.h>

/*
 * Reference counting
 * A specific reference counter is used. The design is quite
 * similar to vlib counters but:
 *   - It is possible to decrease the value
 *   - Summing will not zero the per-thread counters
 *   - Only the thread can reallocate its own counters vector (to avoid concurrency issues)
*/
typedef struct {
  u32 *counters;
  clib_spinlock_t counter_lock;
  CLIB_CACHE_LINE_ALIGN_MARK(o);
} vlib_refcount_per_cpu_t;

typedef struct {
  vlib_refcount_per_cpu_t *per_cpu;
} vlib_refcount_t;

static_always_inline
void vlib_refcount_lock (clib_spinlock_t counter_lock)
{
  clib_spinlock_lock (&counter_lock);
}

static_always_inline
void vlib_refcount_unlock (clib_spinlock_t counter_lock)
{
  clib_spinlock_unlock (&counter_lock);
}

void __vlib_refcount_resize(vlib_refcount_per_cpu_t *per_cpu, u32 size);

static_always_inline
void vlib_refcount_add(vlib_refcount_t *r, u32 thread_index, u32 counter_index, i32 v)
{
  vlib_refcount_per_cpu_t *per_cpu = &r->per_cpu[thread_index];
  if (PREDICT_FALSE(counter_index >= vec_len(per_cpu->counters)))
    __vlib_refcount_resize(per_cpu, clib_max(counter_index + 16,(vec_len(per_cpu->counters)) * 2));

  per_cpu->counters[counter_index] += v;
}

u64 vlib_refcount_get(vlib_refcount_t *r, u32 index);

static_always_inline
void vlib_refcount_init(vlib_refcount_t *r)
{
  vlib_thread_main_t *tm = vlib_get_thread_main ();
  u32 thread_index;
  r->per_cpu = 0;
  vec_validate (r->per_cpu, tm->n_vlib_mains - 1);

  for (thread_index = 0; thread_index < tm->n_vlib_mains; thread_index++)
    {
      clib_spinlock_init (&r->per_cpu[thread_index].counter_lock);
    }
}
, m_itf_from(itf_from) , m_itf_to(itf_to) {} bool unconfig_cmd::operator==(const unconfig_cmd& o) const { return ((m_itf_from == o.m_itf_from) && (m_itf_to == o.m_itf_to)); } rc_t unconfig_cmd::issue(connection& con) { msg_t req(con.ctx(), std::ref(*this)); auto& payload = req.get_request().get_payload(); payload.is_l2 = 0; payload.sw_if_index_from = m_itf_from.value(); payload.sw_if_index_to = m_itf_to.value(); payload.state = SPAN_STATE_API_DISABLED; VAPI_CALL(req.execute()); wait(); m_hw_item.set(rc_t::NOOP); return rc_t::OK; } std::string unconfig_cmd::to_string() const { std::ostringstream s; s << "itf-span-unconfig: " << m_hw_item.to_string() << " itf-from:" << m_itf_from.to_string() << " itf-to:" << m_itf_to.to_string(); return (s.str()); } dump_cmd::dump_cmd() {} bool dump_cmd::operator==(const dump_cmd& other) const { return (true); } rc_t dump_cmd::issue(connection& con) { m_dump.reset(new msg_t(con.ctx(), std::ref(*this))); auto& payload = m_dump->get_request().get_payload(); payload.is_l2 = 0; VAPI_CALL(m_dump->execute()); wait(); return rc_t::OK; } std::string dump_cmd::to_string() const { return ("interface-span-dump"); } }; // namespace interface_span_cmds }; // namespace VOM /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "mozilla") * End: */