FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
os.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  Copyright (c) 2001-2005 Eliot Dresselhaus
17 
18  Permission is hereby granted, free of charge, to any person obtaining
19  a copy of this software and associated documentation files (the
20  "Software"), to deal in the Software without restriction, including
21  without limitation the rights to use, copy, modify, merge, publish,
22  distribute, sublicense, and/or sell copies of the Software, and to
23  permit persons to whom the Software is furnished to do so, subject to
24  the following conditions:
25 
26  The above copyright notice and this permission notice shall be
27  included in all copies or substantial portions of the Software.
28 
29  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
33  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
34  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
35  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
36 */
37 
38 #ifndef included_os_h
39 #define included_os_h
40 
41 #include <vppinfra/clib.h>
42 #include <vppinfra/types.h>
43 
44 /* External panic function. */
45 void os_panic (void);
46 
47 /* External exit function analogous to unix exit. */
48 void os_exit (int code);
49 
50 /* External function to print a line. */
51 void os_puts (u8 * string, uword length, uword is_error);
52 
53 /* External function to handle out of memory. */
54 void os_out_of_memory (void);
55 
56 /* Estimate, measure or divine CPU timestamp clock frequency. */
58 
59 extern __thread uword __os_thread_index;
60 
63 {
64  return __os_thread_index;
65 }
66 
68 os_set_thread_index (uword thread_index)
69 {
70  __os_thread_index = thread_index;
71 }
72 
74 os_get_cpu_number (void) __attribute__ ((deprecated));
75 
78 {
79  return __os_thread_index;
80 }
81 
82 uword os_get_nthreads (void);
83 
84 #include <vppinfra/smp.h>
85 
86 #endif /* included_os_h */
87 
88 /*
89  * fd.io coding-style-patch-verification: ON
90  *
91  * Local Variables:
92  * eval: (c-set-style "gnu")
93  * End:
94  */
void os_puts(u8 *string, uword length, uword is_error)
Definition: unix-misc.c:191
void os_panic(void)
Definition: unix-misc.c:174
void os_out_of_memory(void)
Definition: unix-misc.c:219
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
#define static_always_inline
Definition: clib.h:100
static_always_inline uword os_get_cpu_number(void)
Definition: os.h:77
void os_exit(int code)
Definition: unix-misc.c:182
u64 uword
Definition: types.h:112
uword os_get_nthreads(void)
Definition: unix-misc.c:226
static_always_inline uword os_get_thread_index(void)
Definition: os.h:62
static_always_inline void os_set_thread_index(uword thread_index)
Definition: os.h:68
f64 os_cpu_clock_frequency(void)
Definition: time.c:139