aboutsummaryrefslogtreecommitdiffstats
path: root/src/vppinfra/lock.h
blob: dd79c40b7f277890da31ccd9da15f7eed7b1df4c (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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/*
 * Copyright (c) 2017 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.
 */

#ifndef included_clib_lock_h
#define included_clib_lock_h

#include <vppinfra/clib.h>

#if __x86_64__
#define CLIB_PAUSE() __builtin_ia32_pause ()
#else
#define CLIB_PAUSE()
#endif

#if CLIB_DEBUG > 1
#define CLIB_LOCK_DBG(_p)				\
do {							\
    (*_p)->frame_address = __builtin_frame_address (0);	\
    (*_p)->pid = getpid ();				\
    (*_p)->thread_index = os_get_thread_index ();	\
} while (0)
#define CLIB_LOCK_DBG_CLEAR(_p)				\
do {							\
    (*_p)->frame_address = 0;				\
    (*_p)->pid = 0;					\
    (*_p)->thread_index = 0;				\
} while (0)
#else
#define CLIB_LOCK_DBG(_p)
#define CLIB_LOCK_DBG_CLEAR(_p)
#endif

typedef struct
{
  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  u32 lock;
#if CLIB_DEBUG > 0
  pid_t pid;
  uword thread_index;
  void *frame_address;
#endif
} *clib_spinlock_t;

static inline void
clib_spinlock_init (clib_spinlock_t * p)
{
  *p = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
  memset ((void *) *p, 0, CLIB_CACHE_LINE_BYTES);
}

static inline void
clib_spinlock_free (clib_spinlock_t * p)
{
  if (*p)
    {
      clib_mem_free ((void *) *p);
      *p = 0;
    }
}

static_always_inline void
clib_spinlock_lock (clib_spinlock_t * p)
{
  while (__sync_lock_test_and_set (&(*p)->lock, 1))
    CLIB_PAUSE ();
  CLIB_LOCK_DBG (p);
}

static_always_inline void
clib_spinlock_lock_if_init (clib_spinlock_t * p)
{
  if (PREDICT_FALSE (*p != 0))
    clib_spinlock_lock (p);
}

static_always_inline void
clib_spinlock_unlock (clib_spinlock_t * p)
{
  CLIB_LOCK_DBG_CLEAR (p);
  /* Make sure all writes are complete before releasing the lock */
  CLIB_MEMORY_BARRIER ();
  (*p)->lock = 0;
}

static_always_inline void
clib_spinlock_unlock_if_init (clib_spinlock_t * p)
{
  if (PREDICT_FALSE (*p != 0))
    clib_spinlock_unlock (p);
}

/*
 * Readers-Writer Lock
 */

typedef struct clib_rw_lock_
{
  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  volatile u32 n_readers;
  volatile u32 n_readers_lock;
  volatile u32 writer_lock;
#if CLIB_DEBUG > 0
  pid_t pid;
  uword thread_index;
  void *frame_address;
#endif
} *clib_rwlock_t;

always_inline void
clib_rwlock_init (clib_rwlock_t * p)
{
  *p = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
  memset ((void *) *p, 0, CLIB_CACHE_LINE_BYTES);
}

always_inline void
clib_rwlock_free (clib_rwlock_t * p)
{
  if (*p)
    {
      clib_mem_free ((void *) *p);
      *p = 0;
    }
}

always_inline void
clib_rwlock_reader_lock (clib_rwlock_t * p)
{
  while (__sync_lock_test_and_set (&(*p)->n_readers_lock, 1))
    CLIB_PAUSE ();

  (*p)->n_readers += 1;
  if ((*p)->n_readers == 1)
    {
      while (__sync_lock_test_and_set (&(*p)->writer_lock, 1))
	CLIB_PAUSE ();
    }
  CLIB_MEMORY_BARRIER ();
  (*p)->n_readers_lock = 0;

  CLIB_LOCK_DBG (p);
}

always_inline void
clib_rwlock_reader_unlock (clib_rwlock_t * p)
{
  ASSERT ((*p)->n_readers > 0);
  CLIB_LOCK_DBG_CLEAR (p);

  while (__sync_lock_test_and_set (&(*p)->n_readers_lock, 1))
    CLIB_PAUSE ();

  (*p)->n_readers -= 1;
  if ((*p)->n_readers == 0)
    {
      CLIB_MEMORY_BARRIER ();
      (*p)->writer_lock = 0;
    }

  CLIB_MEMORY_BARRIER ();
  (*p)->n_readers_lock = 0;
}

always_inline void
clib_rwlock_writer_lock (clib_rwlock_t * p)
{
  while (__sync_lock_test_and_set (&(*p)->writer_lock, 1))
    CLIB_PAUSE ();
  CLIB_LOCK_DBG (p);
}

always_inline void
clib_rwlock_writer_unlock (clib_rwlock_t * p)
{
  CLIB_LOCK_DBG_CLEAR (p);
  CLIB_MEMORY_BARRIER ();
  (*p)->writer_lock = 0;
}

#endif

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
class="p">: (u8 *) "", w->registration ? w->registration->name : "", w->lwp); line = format (line, "%-25U", format_sched_policy_and_priority, w->lwp); int cpu_id = w->cpu_id; if (cpu_id > -1) { int core_id = w->core_id; int socket_id = w->socket_id; line = format (line, "%-7u%-7u%-7u%", cpu_id, core_id, socket_id); } else { line = format (line, "%-7s%-7s%-7s%", "n/a", "n/a", "n/a"); } vlib_cli_output (vm, "%v", line); vec_free (line); } #endif return 0; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (show_threads_command, static) = { .path = "show threads", .short_help = "Show threads", .function = show_threads_fn, }; /* *INDENT-ON* */ /* * Trigger threads to grab frame queue trace data */ static clib_error_t * trace_frame_queue (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { unformat_input_t _line_input, *line_input = &_line_input; clib_error_t *error = NULL; frame_queue_trace_t *fqt; frame_queue_nelt_counter_t *fqh; vlib_thread_main_t *tm = vlib_get_thread_main (); vlib_frame_queue_main_t *fqm; u32 num_fq; u32 fqix; u32 enable = 2; u32 index = ~(u32) 0; if (!unformat_user (input, unformat_line_input, line_input)) return 0; while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "on")) enable = 1; else if (unformat (line_input, "off")) enable = 0; else if (unformat (line_input, "index %u", &index)) ; else { error = clib_error_return (0, "parse error: '%U'", format_unformat_error, line_input); goto done; } } if (enable > 1) { error = clib_error_return (0, "expecting on or off"); goto done; } if (vec_len (tm->frame_queue_mains) == 0) { error = clib_error_return (0, "no worker handoffs exist"); goto done; } if (index > vec_len (tm->frame_queue_mains) - 1) { error = clib_error_return (0, "expecting valid worker handoff queue index"); goto done; } fqm = vec_elt_at_index (tm->frame_queue_mains, index); num_fq = vec_len (fqm->vlib_frame_queues); if (num_fq == 0) { vlib_cli_output (vm, "No frame queues exist\n"); goto done; } // Allocate storage for trace if necessary vec_validate_aligned (fqm->frame_queue_traces, num_fq - 1, CLIB_CACHE_LINE_BYTES); vec_validate_aligned (fqm->frame_queue_histogram, num_fq - 1, CLIB_CACHE_LINE_BYTES); for (fqix = 0; fqix < num_fq; fqix++) { fqt = &fqm->frame_queue_traces[fqix]; fqh = &fqm->frame_queue_histogram[fqix]; clib_memset (fqt->n_vectors, 0xff, sizeof (fqt->n_vectors)); fqt->written = 0; clib_memset (fqh, 0, sizeof (*fqh)); fqm->vlib_frame_queues[fqix]->trace = enable; } done: unformat_free (line_input); return error; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (cmd_trace_frame_queue,static) = { .path = "trace frame-queue", .short_help = "trace frame-queue (on|off)", .function = trace_frame_queue, .is_mp_safe = 1, }; /* *INDENT-ON* */ /* * Adding two counters and compute percent of total * Round up, e.g. 0.000001 => 1% */ static u32 compute_percent (u64 * two_counters, u64 total) { if (total == 0) { return 0; } else { return (((two_counters[0] + two_counters[1]) * 100) + (total - 1)) / total; } } /* * Display frame queue trace data gathered by threads. */ static clib_error_t * show_frame_queue_internal (vlib_main_t * vm, vlib_frame_queue_main_t * fqm, u32 histogram) { clib_error_t *error = NULL; frame_queue_trace_t *fqt; frame_queue_nelt_counter_t *fqh; u32 num_fq; u32 fqix; num_fq = vec_len (fqm->frame_queue_traces); if (num_fq == 0) { vlib_cli_output (vm, "No trace data for frame queues\n"); return error; } if (histogram) { vlib_cli_output (vm, "0-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\n"); } for (fqix = 0; fqix < num_fq; fqix++) { fqt = &(fqm->frame_queue_traces[fqix]); vlib_cli_output (vm, "Thread %d %v\n", fqix, vlib_worker_threads[fqix].name); if (fqt->written == 0) { vlib_cli_output (vm, " no trace data\n"); continue; } if (histogram) { fqh = &(fqm->frame_queue_histogram[fqix]); u32 nelt; u64 total = 0; for (nelt = 0; nelt < FRAME_QUEUE_MAX_NELTS; nelt++) { total += fqh->count[nelt]; } /* * Print in pairs to condense the output. * Allow entries with 0 counts to be clearly identified, by rounding up. * Any non-zero value will be displayed as at least one percent. This * also means the sum of percentages can be > 100, but that is fine. The * histogram is counted from the last time "trace frame on" was issued. */ vlib_cli_output (vm, "%3d%% %3d%% %3d%% %3d%% %3d%% %3d%% %3d%% %3d%% " "%3d%% %3d%% %3d%% %3d%% %3d%% %3d%% %3d%% %3d%%\n", compute_percent (&fqh->count[0], total), compute_percent (&fqh->count[2], total), compute_percent (&fqh->count[4], total), compute_percent (&fqh->count[6], total), compute_percent (&fqh->count[8], total), compute_percent (&fqh->count[10], total), compute_percent (&fqh->count[12], total), compute_percent (&fqh->count[14], total), compute_percent (&fqh->count[16], total), compute_percent (&fqh->count[18], total), compute_percent (&fqh->count[20], total), compute_percent (&fqh->count[22], total), compute_percent (&fqh->count[24], total), compute_percent (&fqh->count[26], total), compute_percent (&fqh->count[28], total), compute_percent (&fqh->count[30], total)); } else { vlib_cli_output (vm, " vector-threshold %d ring size %d in use %d\n", fqt->threshold, fqt->nelts, fqt->n_in_use); vlib_cli_output (vm, " head %12d head_hint %12d tail %12d\n", fqt->head, fqt->head_hint, fqt->tail); vlib_cli_output (vm, " %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d\n", fqt->n_vectors[0], fqt->n_vectors[1], fqt->n_vectors[2], fqt->n_vectors[3], fqt->n_vectors[4], fqt->n_vectors[5], fqt->n_vectors[6], fqt->n_vectors[7], fqt->n_vectors[8], fqt->n_vectors[9], fqt->n_vectors[10], fqt->n_vectors[11], fqt->n_vectors[12], fqt->n_vectors[13], fqt->n_vectors[14], fqt->n_vectors[15]); if (fqt->nelts > 16) { vlib_cli_output (vm, " %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d %3d\n", fqt->n_vectors[16], fqt->n_vectors[17], fqt->n_vectors[18], fqt->n_vectors[19], fqt->n_vectors[20], fqt->n_vectors[21], fqt->n_vectors[22], fqt->n_vectors[23], fqt->n_vectors[24], fqt->n_vectors[25], fqt->n_vectors[26], fqt->n_vectors[27], fqt->n_vectors[28], fqt->n_vectors[29], fqt->n_vectors[30], fqt->n_vectors[31]); } } } return error; } static clib_error_t * show_frame_queue_trace (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { vlib_thread_main_t *tm = vlib_get_thread_main (); vlib_frame_queue_main_t *fqm; clib_error_t *error; vec_foreach (fqm, tm->frame_queue_mains) { vlib_cli_output (vm, "Worker handoff queue index %u (next node '%U'):", fqm - tm->frame_queue_mains, format_vlib_node_name, vm, fqm->node_index); error = show_frame_queue_internal (vm, fqm, 0); if (error) return error; } return 0; } static clib_error_t * show_frame_queue_histogram (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { vlib_thread_main_t *tm = vlib_get_thread_main (); vlib_frame_queue_main_t *fqm; clib_error_t *error; vec_foreach (fqm, tm->frame_queue_mains) { vlib_cli_output (vm, "Worker handoff queue index %u (next node '%U'):", fqm - tm->frame_queue_mains, format_vlib_node_name, vm, fqm->node_index); error = show_frame_queue_internal (vm, fqm, 1); if (error) return error; } return 0; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (cmd_show_frame_queue_trace,static) = { .path = "show frame-queue", .short_help = "show frame-queue trace", .function = show_frame_queue_trace, }; /* *INDENT-ON* */ /* *INDENT-OFF* */ VLIB_CLI_COMMAND (cmd_show_frame_queue_histogram,static) = { .path = "show frame-queue histogram", .short_help = "show frame-queue histogram", .function = show_frame_queue_histogram, }; /* *INDENT-ON* */ /* * Modify the number of elements on the frame_queues */ static clib_error_t * test_frame_queue_nelts (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { unformat_input_t _line_input, *line_input = &_line_input; vlib_thread_main_t *tm = vlib_get_thread_main (); vlib_frame_queue_main_t *fqm; clib_error_t *error = NULL; u32 num_fq; u32 fqix; u32 nelts = 0; u32 index = ~(u32) 0; if (!unformat_user (input, unformat_line_input, line_input)) return 0; while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "nelts %u", &nelts)) ; else if (unformat (line_input, "index %u", &index)) ; else { error = clib_error_return (0, "parse error: '%U'", format_unformat_error, line_input); goto done; } } if (index > vec_len (tm->frame_queue_mains) - 1) { error = clib_error_return (0, "expecting valid worker handoff queue index"); goto done; } fqm = vec_elt_at_index (tm->frame_queue_mains, index); if ((nelts != 4) && (nelts != 8) && (nelts != 16) && (nelts != 32)) { error = clib_error_return (0, "expecting 4,8,16,32"); goto done; } num_fq = vec_len (fqm->vlib_frame_queues); if (num_fq == 0) { vlib_cli_output (vm, "No frame queues exist\n"); goto done; } for (fqix = 0; fqix < num_fq; fqix++) { fqm->vlib_frame_queues[fqix]->nelts = nelts; } done: unformat_free (line_input); return error; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (cmd_test_frame_queue_nelts,static) = { .path = "test frame-queue nelts", .short_help = "test frame-queue nelts (4,8,16,32)", .function = test_frame_queue_nelts, }; /* *INDENT-ON* */ /* * Modify the max number of packets pulled off the frame queues */ static clib_error_t * test_frame_queue_threshold (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { unformat_input_t _line_input, *line_input = &_line_input; vlib_thread_main_t *tm = vlib_get_thread_main (); vlib_frame_queue_main_t *fqm; clib_error_t *error = NULL; u32 num_fq; u32 fqix; u32 threshold = ~(u32) 0; u32 index = ~(u32) 0; if (!unformat_user (input, unformat_line_input, line_input)) return 0; while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "threshold %u", &threshold)) ; else if (unformat (line_input, "index %u", &index)) ; else { error = clib_error_return (0, "parse error: '%U'", format_unformat_error, line_input); goto done; } } if (index > vec_len (tm->frame_queue_mains) - 1) { error = clib_error_return (0, "expecting valid worker handoff queue index"); goto done; } fqm = vec_elt_at_index (tm->frame_queue_mains, index); if (threshold == ~(u32) 0) { vlib_cli_output (vm, "expecting threshold value\n"); goto done; } if (threshold == 0) threshold = ~0; num_fq = vec_len (fqm->vlib_frame_queues); if (num_fq == 0) { vlib_cli_output (vm, "No frame queues exist\n"); goto done; } for (fqix = 0; fqix < num_fq; fqix++) { fqm->vlib_frame_queues[fqix]->vector_threshold = threshold; } done: unformat_free (line_input); return error; } /* *INDENT-OFF* */ VLIB_CLI_COMMAND (cmd_test_frame_queue_threshold,static) = { .path = "test frame-queue threshold", .short_help = "test frame-queue threshold N (0=no limit)", .function = test_frame_queue_threshold, }; /* *INDENT-ON* */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */