os.h

Go to the documentation of this file.

/*
 * 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 analogous 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;
extern __thread uword __os_numa_index;
 
static_always_inline uword
os_get_thread_index (void)
{
  return __os_thread_index;
}
 
static_always_inline void
os_set_thread_index (uword thread_index)
{
  __os_thread_index = thread_index;
}
 
static_always_inline uword
os_get_numa_index (void)
{
  return __os_numa_index;
}
 
static_always_inline void
os_set_numa_index (uword numa_index)
{
  __os_numa_index = numa_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:
 */