ipfix: add SCTP, ICMP, and ICMPv6 flow reporting
[sliver-openvswitch.git] / lib / ovs-thread.c
1 /*
2  * Copyright (c) 2013, 2014 Nicira, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18 #include "ovs-thread.h"
19 #include <errno.h>
20 #include <poll.h>
21 #include <stdlib.h>
22 #include <unistd.h>
23 #include "compiler.h"
24 #include "hash.h"
25 #include "poll-loop.h"
26 #include "socket-util.h"
27 #include "util.h"
28
29 #ifdef __CHECKER__
30 /* Omit the definitions in this file because they are somewhat difficult to
31  * write without prompting "sparse" complaints, without ugliness or
32  * cut-and-paste.  Since "sparse" is just a checker, not a compiler, it
33  * doesn't matter that we don't define them. */
34 #else
35 #include "vlog.h"
36
37 VLOG_DEFINE_THIS_MODULE(ovs_thread);
38
39 /* If there is a reason that we cannot fork anymore (unless the fork will be
40  * immediately followed by an exec), then this points to a string that
41  * explains why. */
42 static const char *must_not_fork;
43
44 /* True if we created any threads beyond the main initial thread. */
45 static bool multithreaded;
46
47 #define LOCK_FUNCTION(TYPE, FUN) \
48     void \
49     ovs_##TYPE##_##FUN##_at(const struct ovs_##TYPE *l_, \
50                             const char *where) \
51         OVS_NO_THREAD_SAFETY_ANALYSIS \
52     { \
53         struct ovs_##TYPE *l = CONST_CAST(struct ovs_##TYPE *, l_); \
54         int error = pthread_##TYPE##_##FUN(&l->lock); \
55         if (OVS_UNLIKELY(error)) { \
56             ovs_abort(error, "pthread_%s_%s failed", #TYPE, #FUN); \
57         } \
58         l->where = where; \
59     }
60 LOCK_FUNCTION(mutex, lock);
61 LOCK_FUNCTION(rwlock, rdlock);
62 LOCK_FUNCTION(rwlock, wrlock);
63
64 #define TRY_LOCK_FUNCTION(TYPE, FUN) \
65     int \
66     ovs_##TYPE##_##FUN##_at(const struct ovs_##TYPE *l_, \
67                             const char *where) \
68         OVS_NO_THREAD_SAFETY_ANALYSIS \
69     { \
70         struct ovs_##TYPE *l = CONST_CAST(struct ovs_##TYPE *, l_); \
71         int error = pthread_##TYPE##_##FUN(&l->lock); \
72         if (OVS_UNLIKELY(error) && error != EBUSY) { \
73             ovs_abort(error, "pthread_%s_%s failed", #TYPE, #FUN); \
74         } \
75         if (!error) { \
76             l->where = where; \
77         } \
78         return error; \
79     }
80 TRY_LOCK_FUNCTION(mutex, trylock);
81 TRY_LOCK_FUNCTION(rwlock, tryrdlock);
82 TRY_LOCK_FUNCTION(rwlock, trywrlock);
83
84 #define UNLOCK_FUNCTION(TYPE, FUN) \
85     void \
86     ovs_##TYPE##_##FUN(const struct ovs_##TYPE *l_) \
87         OVS_NO_THREAD_SAFETY_ANALYSIS \
88     { \
89         struct ovs_##TYPE *l = CONST_CAST(struct ovs_##TYPE *, l_); \
90         int error; \
91         l->where = NULL; \
92         error = pthread_##TYPE##_##FUN(&l->lock); \
93         if (OVS_UNLIKELY(error)) { \
94             ovs_abort(error, "pthread_%s_%sfailed", #TYPE, #FUN); \
95         } \
96     }
97 UNLOCK_FUNCTION(mutex, unlock);
98 UNLOCK_FUNCTION(mutex, destroy);
99 UNLOCK_FUNCTION(rwlock, unlock);
100 UNLOCK_FUNCTION(rwlock, destroy);
101
102 #define XPTHREAD_FUNC1(FUNCTION, PARAM1)                \
103     void                                                \
104     x##FUNCTION(PARAM1 arg1)                            \
105     {                                                   \
106         int error = FUNCTION(arg1);                     \
107         if (OVS_UNLIKELY(error)) {                      \
108             ovs_abort(error, "%s failed", #FUNCTION);   \
109         }                                               \
110     }
111 #define XPTHREAD_FUNC2(FUNCTION, PARAM1, PARAM2)        \
112     void                                                \
113     x##FUNCTION(PARAM1 arg1, PARAM2 arg2)               \
114     {                                                   \
115         int error = FUNCTION(arg1, arg2);               \
116         if (OVS_UNLIKELY(error)) {                      \
117             ovs_abort(error, "%s failed", #FUNCTION);   \
118         }                                               \
119     }
120
121 XPTHREAD_FUNC1(pthread_mutex_lock, pthread_mutex_t *);
122 XPTHREAD_FUNC1(pthread_mutex_unlock, pthread_mutex_t *);
123 XPTHREAD_FUNC1(pthread_mutexattr_init, pthread_mutexattr_t *);
124 XPTHREAD_FUNC1(pthread_mutexattr_destroy, pthread_mutexattr_t *);
125 XPTHREAD_FUNC2(pthread_mutexattr_settype, pthread_mutexattr_t *, int);
126 XPTHREAD_FUNC2(pthread_mutexattr_gettype, pthread_mutexattr_t *, int *);
127
128 XPTHREAD_FUNC2(pthread_cond_init, pthread_cond_t *, pthread_condattr_t *);
129 XPTHREAD_FUNC1(pthread_cond_destroy, pthread_cond_t *);
130 XPTHREAD_FUNC1(pthread_cond_signal, pthread_cond_t *);
131 XPTHREAD_FUNC1(pthread_cond_broadcast, pthread_cond_t *);
132
133 XPTHREAD_FUNC2(pthread_join, pthread_t, void **);
134
135 typedef void destructor_func(void *);
136 XPTHREAD_FUNC2(pthread_key_create, pthread_key_t *, destructor_func *);
137 XPTHREAD_FUNC1(pthread_key_delete, pthread_key_t);
138 XPTHREAD_FUNC2(pthread_setspecific, pthread_key_t, const void *);
139
140 static void
141 ovs_mutex_init__(const struct ovs_mutex *l_, int type)
142 {
143     struct ovs_mutex *l = CONST_CAST(struct ovs_mutex *, l_);
144     pthread_mutexattr_t attr;
145     int error;
146
147     l->where = NULL;
148     xpthread_mutexattr_init(&attr);
149     xpthread_mutexattr_settype(&attr, type);
150     error = pthread_mutex_init(&l->lock, &attr);
151     if (OVS_UNLIKELY(error)) {
152         ovs_abort(error, "pthread_mutex_init failed");
153     }
154     xpthread_mutexattr_destroy(&attr);
155 }
156
157 /* Initializes 'mutex' as a normal (non-recursive) mutex. */
158 void
159 ovs_mutex_init(const struct ovs_mutex *mutex)
160 {
161     ovs_mutex_init__(mutex, PTHREAD_MUTEX_ERRORCHECK);
162 }
163
164 /* Initializes 'mutex' as a recursive mutex. */
165 void
166 ovs_mutex_init_recursive(const struct ovs_mutex *mutex)
167 {
168     ovs_mutex_init__(mutex, PTHREAD_MUTEX_RECURSIVE);
169 }
170
171 /* Initializes 'mutex' as a recursive mutex. */
172 void
173 ovs_mutex_init_adaptive(const struct ovs_mutex *mutex)
174 {
175 #ifdef PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
176     ovs_mutex_init__(mutex, PTHREAD_MUTEX_ADAPTIVE_NP);
177 #else
178     ovs_mutex_init(mutex);
179 #endif
180 }
181
182 void
183 ovs_rwlock_init(const struct ovs_rwlock *l_)
184 {
185     struct ovs_rwlock *l = CONST_CAST(struct ovs_rwlock *, l_);
186     int error;
187
188     l->where = NULL;
189     error = pthread_rwlock_init(&l->lock, NULL);
190     if (OVS_UNLIKELY(error)) {
191         ovs_abort(error, "pthread_rwlock_init failed");
192     }
193 }
194
195 void
196 ovs_mutex_cond_wait(pthread_cond_t *cond, const struct ovs_mutex *mutex_)
197 {
198     struct ovs_mutex *mutex = CONST_CAST(struct ovs_mutex *, mutex_);
199     int error = pthread_cond_wait(cond, &mutex->lock);
200     if (OVS_UNLIKELY(error)) {
201         ovs_abort(error, "pthread_cond_wait failed");
202     }
203 }
204 \f
205 DEFINE_EXTERN_PER_THREAD_DATA(ovsthread_id, 0);
206
207 struct ovsthread_aux {
208     void *(*start)(void *);
209     void *arg;
210 };
211
212 static void *
213 ovsthread_wrapper(void *aux_)
214 {
215     static atomic_uint next_id = ATOMIC_VAR_INIT(1);
216
217     struct ovsthread_aux *auxp = aux_;
218     struct ovsthread_aux aux;
219     unsigned int id;
220
221     atomic_add(&next_id, 1, &id);
222     *ovsthread_id_get() = id;
223
224     aux = *auxp;
225     free(auxp);
226
227     return aux.start(aux.arg);
228 }
229
230 void
231 xpthread_create(pthread_t *threadp, pthread_attr_t *attr,
232                 void *(*start)(void *), void *arg)
233 {
234     struct ovsthread_aux *aux;
235     pthread_t thread;
236     int error;
237
238     forbid_forking("multiple threads exist");
239     multithreaded = true;
240
241     aux = xmalloc(sizeof *aux);
242     aux->start = start;
243     aux->arg = arg;
244
245     error = pthread_create(threadp ? threadp : &thread, attr,
246                            ovsthread_wrapper, aux);
247     if (error) {
248         ovs_abort(error, "pthread_create failed");
249     }
250 }
251 \f
252 bool
253 ovsthread_once_start__(struct ovsthread_once *once)
254 {
255     ovs_mutex_lock(&once->mutex);
256     if (!ovsthread_once_is_done__(once)) {
257         return false;
258     }
259     ovs_mutex_unlock(&once->mutex);
260     return true;
261 }
262
263 void
264 ovsthread_once_done(struct ovsthread_once *once)
265 {
266     atomic_store(&once->done, true);
267     ovs_mutex_unlock(&once->mutex);
268 }
269 \f
270 /* Asserts that the process has not yet created any threads (beyond the initial
271  * thread).
272  *
273  * ('where' is used in logging.  Commonly one would use
274  * assert_single_threaded() to automatically provide the caller's source file
275  * and line number for 'where'.) */
276 void
277 assert_single_threaded_at(const char *where)
278 {
279     if (multithreaded) {
280         VLOG_FATAL("%s: attempted operation not allowed when multithreaded",
281                    where);
282     }
283 }
284
285 /* Forks the current process (checking that this is allowed).  Aborts with
286  * VLOG_FATAL if fork() returns an error, and otherwise returns the value
287  * returned by fork().
288  *
289  * ('where' is used in logging.  Commonly one would use xfork() to
290  * automatically provide the caller's source file and line number for
291  * 'where'.) */
292 pid_t
293 xfork_at(const char *where)
294 {
295     pid_t pid;
296
297     if (must_not_fork) {
298         VLOG_FATAL("%s: attempted to fork but forking not allowed (%s)",
299                    where, must_not_fork);
300     }
301
302     pid = fork();
303     if (pid < 0) {
304         VLOG_FATAL("%s: fork failed (%s)", where, ovs_strerror(errno));
305     }
306     return pid;
307 }
308
309 /* Notes that the process must not call fork() from now on, for the specified
310  * 'reason'.  (The process may still fork() if it execs itself immediately
311  * afterward.) */
312 void
313 forbid_forking(const char *reason)
314 {
315     ovs_assert(reason != NULL);
316     must_not_fork = reason;
317 }
318
319 /* Returns true if the process is allowed to fork, false otherwise. */
320 bool
321 may_fork(void)
322 {
323     return !must_not_fork;
324 }
325 \f
326 /* ovsthread_counter.
327  *
328  * We implement the counter as an array of N_COUNTERS individual counters, each
329  * with its own lock.  Each thread uses one of the counters chosen based on a
330  * hash of the thread's ID, the idea being that, statistically, different
331  * threads will tend to use different counters and therefore avoid
332  * interfering with each other.
333  *
334  * Undoubtedly, better implementations are possible. */
335
336 /* Basic counter structure. */
337 struct ovsthread_counter__ {
338     struct ovs_mutex mutex;
339     unsigned long long int value;
340 };
341
342 /* Pad the basic counter structure to 64 bytes to avoid cache line
343  * interference. */
344 struct ovsthread_counter {
345     struct ovsthread_counter__ c;
346     char pad[ROUND_UP(sizeof(struct ovsthread_counter__), 64)
347              - sizeof(struct ovsthread_counter__)];
348 };
349
350 #define N_COUNTERS 16
351
352 struct ovsthread_counter *
353 ovsthread_counter_create(void)
354 {
355     struct ovsthread_counter *c;
356     int i;
357
358     c = xmalloc(N_COUNTERS * sizeof *c);
359     for (i = 0; i < N_COUNTERS; i++) {
360         ovs_mutex_init(&c[i].c.mutex);
361         c[i].c.value = 0;
362     }
363     return c;
364 }
365
366 void
367 ovsthread_counter_destroy(struct ovsthread_counter *c)
368 {
369     if (c) {
370         int i;
371
372         for (i = 0; i < N_COUNTERS; i++) {
373             ovs_mutex_destroy(&c[i].c.mutex);
374         }
375         free(c);
376     }
377 }
378
379 void
380 ovsthread_counter_inc(struct ovsthread_counter *c, unsigned long long int n)
381 {
382     c = &c[hash_int(ovsthread_id_self(), 0) % N_COUNTERS];
383
384     ovs_mutex_lock(&c->c.mutex);
385     c->c.value += n;
386     ovs_mutex_unlock(&c->c.mutex);
387 }
388
389 unsigned long long int
390 ovsthread_counter_read(const struct ovsthread_counter *c)
391 {
392     unsigned long long int sum;
393     int i;
394
395     sum = 0;
396     for (i = 0; i < N_COUNTERS; i++) {
397         ovs_mutex_lock(&c[i].c.mutex);
398         sum += c[i].c.value;
399         ovs_mutex_unlock(&c[i].c.mutex);
400     }
401     return sum;
402 }
403 \f
404 /* Parses /proc/cpuinfo for the total number of physical cores on this system
405  * across all CPU packages, not counting hyper-threads.
406  *
407  * Sets *n_cores to the total number of cores on this system, or 0 if the
408  * number cannot be determined. */
409 static void
410 parse_cpuinfo(long int *n_cores)
411 {
412     static const char file_name[] = "/proc/cpuinfo";
413     char line[128];
414     uint64_t cpu = 0; /* Support up to 64 CPU packages on a single system. */
415     long int cores = 0;
416     FILE *stream;
417
418     stream = fopen(file_name, "r");
419     if (!stream) {
420         VLOG_DBG("%s: open failed (%s)", file_name, ovs_strerror(errno));
421         return;
422     }
423
424     while (fgets(line, sizeof line, stream)) {
425         unsigned int id;
426
427         /* Find the next CPU package. */
428         if (ovs_scan(line, "physical id%*[^:]: %u", &id)) {
429             if (id > 63) {
430                 VLOG_WARN("Counted over 64 CPU packages on this system. "
431                           "Parsing %s for core count may be inaccurate.",
432                           file_name);
433                 cores = 0;
434                 break;
435             }
436
437             if (cpu & (1 << id)) {
438                 /* We've already counted this package's cores. */
439                 continue;
440             }
441             cpu |= 1 << id;
442
443             /* Find the number of cores for this package. */
444             while (fgets(line, sizeof line, stream)) {
445                 int count;
446
447                 if (ovs_scan(line, "cpu cores%*[^:]: %u", &count)) {
448                     cores += count;
449                     break;
450                 }
451             }
452         }
453     }
454     fclose(stream);
455
456     *n_cores = cores;
457 }
458
459 /* Returns the total number of cores on this system, or 0 if the number cannot
460  * be determined.
461  *
462  * Tries not to count hyper-threads, but may be inaccurate - particularly on
463  * platforms that do not provide /proc/cpuinfo, but also if /proc/cpuinfo is
464  * formatted different to the layout that parse_cpuinfo() expects. */
465 int
466 count_cpu_cores(void)
467 {
468     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
469     static long int n_cores;
470
471     if (ovsthread_once_start(&once)) {
472         parse_cpuinfo(&n_cores);
473         if (!n_cores) {
474             n_cores = sysconf(_SC_NPROCESSORS_ONLN);
475         }
476         ovsthread_once_done(&once);
477     }
478
479     return n_cores > 0 ? n_cores : 0;
480 }
481 \f
482 /* ovsthread_key. */
483
484 #define L1_SIZE 1024
485 #define L2_SIZE 1024
486 #define MAX_KEYS (L1_SIZE * L2_SIZE)
487
488 /* A piece of thread-specific data. */
489 struct ovsthread_key {
490     struct list list_node;      /* In 'inuse_keys' or 'free_keys'. */
491     void (*destructor)(void *); /* Called at thread exit. */
492
493     /* Indexes into the per-thread array in struct ovsthread_key_slots.
494      * This key's data is stored in p1[index / L2_SIZE][index % L2_SIZE]. */
495     unsigned int index;
496 };
497
498 /* Per-thread data structure. */
499 struct ovsthread_key_slots {
500     struct list list_node;      /* In 'slots_list'. */
501     void **p1[L1_SIZE];
502 };
503
504 /* Contains "struct ovsthread_key_slots *". */
505 static pthread_key_t tsd_key;
506
507 /* Guards data structures below. */
508 static struct ovs_mutex key_mutex = OVS_MUTEX_INITIALIZER;
509
510 /* 'inuse_keys' holds "struct ovsthread_key"s that have been created and not
511  * yet destroyed.
512  *
513  * 'free_keys' holds "struct ovsthread_key"s that have been deleted and are
514  * ready for reuse.  (We keep them around only to be able to easily locate
515  * free indexes.)
516  *
517  * Together, 'inuse_keys' and 'free_keys' hold an ovsthread_key for every index
518  * from 0 to n_keys - 1, inclusive. */
519 static struct list inuse_keys OVS_GUARDED_BY(key_mutex)
520     = LIST_INITIALIZER(&inuse_keys);
521 static struct list free_keys OVS_GUARDED_BY(key_mutex)
522     = LIST_INITIALIZER(&free_keys);
523 static unsigned int n_keys OVS_GUARDED_BY(key_mutex);
524
525 /* All existing struct ovsthread_key_slots. */
526 static struct list slots_list OVS_GUARDED_BY(key_mutex)
527     = LIST_INITIALIZER(&slots_list);
528
529 static void *
530 clear_slot(struct ovsthread_key_slots *slots, unsigned int index)
531 {
532     void **p2 = slots->p1[index / L2_SIZE];
533     if (p2) {
534         void **valuep = &p2[index % L2_SIZE];
535         void *value = *valuep;
536         *valuep = NULL;
537         return value;
538     } else {
539         return NULL;
540     }
541 }
542
543 static void
544 ovsthread_key_destruct__(void *slots_)
545 {
546     struct ovsthread_key_slots *slots = slots_;
547     struct ovsthread_key *key;
548     unsigned int n;
549     int i;
550
551     ovs_mutex_lock(&key_mutex);
552     list_remove(&slots->list_node);
553     LIST_FOR_EACH (key, list_node, &inuse_keys) {
554         void *value = clear_slot(slots, key->index);
555         if (value && key->destructor) {
556             key->destructor(value);
557         }
558     }
559     n = n_keys;
560     ovs_mutex_unlock(&key_mutex);
561
562     for (i = 0; i < n / L2_SIZE; i++) {
563         free(slots->p1[i]);
564     }
565     free(slots);
566 }
567
568 /* Initializes '*keyp' as a thread-specific data key.  The data items are
569  * initially null in all threads.
570  *
571  * If a thread exits with non-null data, then 'destructor', if nonnull, will be
572  * called passing the final data value as its argument.  'destructor' must not
573  * call any thread-specific data functions in this API.
574  *
575  * This function is similar to xpthread_key_create(). */
576 void
577 ovsthread_key_create(ovsthread_key_t *keyp, void (*destructor)(void *))
578 {
579     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
580     struct ovsthread_key *key;
581
582     if (ovsthread_once_start(&once)) {
583         xpthread_key_create(&tsd_key, ovsthread_key_destruct__);
584         ovsthread_once_done(&once);
585     }
586
587     ovs_mutex_lock(&key_mutex);
588     if (list_is_empty(&free_keys)) {
589         key = xmalloc(sizeof *key);
590         key->index = n_keys++;
591         if (key->index >= MAX_KEYS) {
592             abort();
593         }
594     } else {
595         key = CONTAINER_OF(list_pop_back(&free_keys),
596                             struct ovsthread_key, list_node);
597     }
598     list_push_back(&inuse_keys, &key->list_node);
599     key->destructor = destructor;
600     ovs_mutex_unlock(&key_mutex);
601
602     *keyp = key;
603 }
604
605 /* Frees 'key'.  The destructor supplied to ovsthread_key_create(), if any, is
606  * not called.
607  *
608  * This function is similar to xpthread_key_delete(). */
609 void
610 ovsthread_key_delete(ovsthread_key_t key)
611 {
612     struct ovsthread_key_slots *slots;
613
614     ovs_mutex_lock(&key_mutex);
615
616     /* Move 'key' from 'inuse_keys' to 'free_keys'. */
617     list_remove(&key->list_node);
618     list_push_back(&free_keys, &key->list_node);
619
620     /* Clear this slot in all threads. */
621     LIST_FOR_EACH (slots, list_node, &slots_list) {
622         clear_slot(slots, key->index);
623     }
624
625     ovs_mutex_unlock(&key_mutex);
626 }
627
628 static void **
629 ovsthread_key_lookup__(const struct ovsthread_key *key)
630 {
631     struct ovsthread_key_slots *slots;
632     void **p2;
633
634     slots = pthread_getspecific(tsd_key);
635     if (!slots) {
636         slots = xzalloc(sizeof *slots);
637
638         ovs_mutex_lock(&key_mutex);
639         pthread_setspecific(tsd_key, slots);
640         list_push_back(&slots_list, &slots->list_node);
641         ovs_mutex_unlock(&key_mutex);
642     }
643
644     p2 = slots->p1[key->index / L2_SIZE];
645     if (!p2) {
646         p2 = xzalloc(L2_SIZE * sizeof *p2);
647         slots->p1[key->index / L2_SIZE] = p2;
648     }
649
650     return &p2[key->index % L2_SIZE];
651 }
652
653 /* Sets the value of thread-specific data item 'key', in the current thread, to
654  * 'value'.
655  *
656  * This function is similar to pthread_setspecific(). */
657 void
658 ovsthread_setspecific(ovsthread_key_t key, const void *value)
659 {
660     *ovsthread_key_lookup__(key) = CONST_CAST(void *, value);
661 }
662
663 /* Returns the value of thread-specific data item 'key' in the current thread.
664  *
665  * This function is similar to pthread_getspecific(). */
666 void *
667 ovsthread_getspecific(ovsthread_key_t key)
668 {
669     return *ovsthread_key_lookup__(key);
670 }
671 #endif