summaryrefslogtreecommitdiffstats
path: root/src/vppinfra/os.h
blob: 33300716103a7418f687f950855557f454379545 (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
/*
 * Copyright (c) 2015 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.
 */
/*
  Copyright (c) 2001-2005 Eliot Dresselhaus

  Permission is hereby granted, free of charge, to any person obtaining
  a copy of this software and associated documentation files (the
  "Software"), to deal in the Software without restriction, including
  without limitation the rights to use, copy, modify, merge, publish,
  distribute, sublicense, and/or sell copies of the Software, and to
  permit persons to whom the Software is furnished to do so, subject to
  the following conditions:

  The above copyright notice and this permission notice shall be
  included in all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#ifndef included_os_h
#define included_os_h

#include <vppinfra/clib.h>
#include <vppinfra/types.h>

/* External panic function. */
void os_panic (void);

/* External exit function analagous to unix exit. */
void os_exit (int code);

/* External function to print a line. */
void os_puts (u8 * string, uword length, uword is_error);

/* External function to handle out of memory. */
void os_out_of_memory (void);

/* Estimate, measure or divine CPU timestamp clock frequency. */
f64 os_cpu_clock_frequency (void);

extern __thread uword __os_thread_index;

static_always_inline uword
os_get_thread_index (void)
{
  return __os_thread_index;
}

static_always_inline uword
os_get_cpu_number (void) __attribute__ ((deprecated));

static_always_inline uword
os_get_cpu_number (void)
{
  return __os_thread_index;
}

uword os_get_nthreads (void);

#include <vppinfra/smp.h>

#endif /* included_os_h */

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
lass="cpf"><vppinfra/fifo.h> #include <vppinfra/time.h> #include <vppinfra/heap.h> #include <vppinfra/pool.h> #include <vppinfra/format.h> #include <vppinfra/lock.h> #ifndef MMAP_PAGESIZE #define MMAP_PAGESIZE (clib_mem_get_page_size()) #endif #define SSVM_N_OPAQUE 7 typedef enum ssvm_segment_type_ { SSVM_SEGMENT_SHM = 0, SSVM_SEGMENT_MEMFD, SSVM_SEGMENT_PRIVATE, SSVM_N_SEGMENT_TYPES /**< Private segments */ } ssvm_segment_type_t; typedef struct { /* Spin-lock */ volatile u32 lock; volatile u32 owner_pid; int recursion_count; u32 tag; /* for debugging */ /* The allocation arena */ void *heap; /* Segment must be mapped at this address, or no supper */ uword ssvm_va; /* The actual mmap size */ uword ssvm_size; u32 server_pid; u32 client_pid; u8 *name; void *opaque[SSVM_N_OPAQUE]; /* Set when server init done */ volatile u32 ready; ssvm_segment_type_t type; } ssvm_shared_header_t; typedef struct { ssvm_shared_header_t *sh; uword ssvm_size; uword requested_va; u32 my_pid; u8 *name; u8 numa; /**< UNUSED: numa requested at alloc time */ int is_server; union { int fd; /**< memfd segments */ int attach_timeout; /**< shm segments attach timeout (sec) */ }; } ssvm_private_t; always_inline void ssvm_lock (ssvm_shared_header_t * h, u32 my_pid, u32 tag) { if (h->owner_pid == my_pid) { h->recursion_count++; return; } while (clib_atomic_test_and_set (&h->lock)) CLIB_PAUSE (); h->owner_pid = my_pid; h->recursion_count = 1; h->tag = tag; } always_inline void ssvm_lock_non_recursive (ssvm_shared_header_t * h, u32 tag) { while (clib_atomic_test_and_set (&h->lock)) CLIB_PAUSE (); h->tag = tag; } always_inline void ssvm_unlock (ssvm_shared_header_t * h) { if (--h->recursion_count == 0) { h->owner_pid = 0; h->tag = 0; clib_atomic_release (&h->lock); } } always_inline void ssvm_unlock_non_recursive (ssvm_shared_header_t * h) { h->tag = 0; clib_atomic_release (&h->lock); } static inline void * ssvm_push_heap (ssvm_shared_header_t * sh) { clib_mem_heap_t *oldheap; oldheap = clib_mem_set_heap (sh->heap); return ((void *) oldheap); } static inline void ssvm_pop_heap (void *oldheap) { clib_mem_set_heap (oldheap); } static inline void * ssvm_mem_alloc (ssvm_private_t * ssvm, uword size) { clib_mem_heap_t *oldheap; void *rv; oldheap = clib_mem_set_heap (ssvm->sh->heap); rv = clib_mem_alloc (size); clib_mem_set_heap (oldheap); return (rv); } #define foreach_ssvm_api_error \ _(NO_NAME, "No shared segment name", -100) \ _(NO_SIZE, "Size not set (server)", -101) \ _(CREATE_FAILURE, "Create failed", -102) \ _(SET_SIZE, "Set size failed", -103) \ _(MMAP, "mmap failed", -104) \ _(CLIENT_TIMEOUT, "Client map timeout", -105) typedef enum { #define _(n,s,c) SSVM_API_ERROR_##n = c, foreach_ssvm_api_error #undef _ } ssvm_api_error_enum_t; #define SSVM_API_ERROR_NO_NAME (-10) int ssvm_server_init (ssvm_private_t * ssvm, ssvm_segment_type_t type); int ssvm_client_init (ssvm_private_t * ssvm, ssvm_segment_type_t type); void ssvm_delete (ssvm_private_t * ssvm); int ssvm_server_init_shm (ssvm_private_t * ssvm); int ssvm_client_init_shm (ssvm_private_t * ssvm); void ssvm_delete_shm (ssvm_private_t * ssvm); int ssvm_server_init_memfd (ssvm_private_t * memfd); int ssvm_client_init_memfd (ssvm_private_t * memfd); void ssvm_delete_memfd (ssvm_private_t * memfd); int ssvm_server_init_private (ssvm_private_t * ssvm); int ssvm_client_init_private (ssvm_private_t * ssvm); void ssvm_delete_private (ssvm_private_t * ssvm); ssvm_segment_type_t ssvm_type (const ssvm_private_t * ssvm); u8 *ssvm_name (const ssvm_private_t * ssvm); #endif /* __included_ssvm_h__ */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */