rsys.h

Go to the documentation of this file.

/* RLIB - Convenience library for useful things
 * Copyright (C) 2016 Haakon Sporsheim <haakon.sporsheim@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3.0 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.
 * See the COPYING file at the root of the source repository.
 */
#ifndef __R_SYS_H__
#define __R_SYS_H__
 
#if !defined(__RLIB_H_INCLUDE_GUARD__) && !defined(RLIB_COMPILATION)
#error "#include <rlib.h> only please."
#endif
 
#include <rlib/rtypes.h>
#include <rlib/rref.h>
 
#include <rlib/data/rbitset.h>
 
R_BEGIN_DECLS
 
R_API ruint r_sys_cpu_packages (void);
R_API ruint r_sys_cpu_physical_count (void);
R_API ruint r_sys_cpu_logical_count (void);
R_API ruint r_sys_cpu_allowed_count (void);
R_API ruint r_sys_cpu_max_count (void);
R_API ruint r_sys_cpuset_max (void);
R_API RBitset * r_sys_cpuset_new (void) R_ATTR_MALLOC;
R_API rboolean r_sys_cpuset_possible (RBitset * cpuset);
R_API rboolean r_sys_cpuset_present (RBitset * cpuset);
R_API rboolean r_sys_cpuset_online (RBitset * cpuset);
R_API rboolean r_sys_cpuset_allowed (RBitset * cpuset);
 
R_API rboolean r_sys_cpuset_for_node (RBitset * cpuset, ruint node);
R_API ruint r_sys_node_count (void);
R_API ruint r_sys_node_count_with_online_cpus (void);
R_API ruint r_sys_node_count_with_allowed_cpus (void);
R_API ruint r_sys_nodeset_max (void);
R_API RBitset * r_sys_nodeset_new (void) R_ATTR_MALLOC;
R_API rboolean r_sys_nodeset_possible (RBitset * nodeset);
R_API rboolean r_sys_nodeset_online (RBitset * nodeset);
R_API rboolean r_sys_nodeset_with_online_cpus (RBitset * nodeset);
R_API rboolean r_sys_nodeset_with_allowed_cpus (RBitset * nodeset);
 
R_API rboolean r_sys_nodeset_for_cpuset (RBitset * nodeset, const RBitset * cpuset);
typedef struct RSysTopology  RSysTopology;
typedef struct RSysNode      RSysNode;
typedef struct RSysCpu       RSysCpu;
 
R_API RSysTopology * r_sys_topology_discover (void);
 
R_API rsize r_sys_topology_node_count (const RSysTopology * topo);
R_API RSysNode * r_sys_topology_node (RSysTopology * topo, rsize idx);
 
R_API rboolean r_sys_topology_node_cpuset (const RSysNode * node, RBitset * cpuset);
R_API rsize r_sys_topology_node_cpu_count (const RSysNode * node);
R_API RSysCpu * r_sys_topology_node_cpu (RSysNode * node, rsize idx);
R_API rsize r_sys_topology_node_available_memory (const RSysNode * node);
R_API rsize r_sys_topology_node_total_memory (const RSysNode * node);
R_API rsize r_sys_topology_node_id (const RSysNode * node);
R_API rsize r_sys_topology_node_distance (const RSysNode * node, rsize nodeid);
 
#define r_sys_topology_ref    r_ref_ref
#define r_sys_topology_unref  r_ref_unref
#define r_sys_node_ref        r_ref_ref
#define r_sys_node_unref      r_ref_unref
#define r_sys_cpu_ref         r_ref_ref
#define r_sys_cpu_unref       r_ref_unref
#define R_SYS_ID_UNKNOWN  RSIZE_MAX
 
typedef enum {
  R_SYS_CPU_CACHE_UNIFIED = 0,    
  R_SYS_CPU_CACHE_DATA,           
  R_SYS_CPU_CACHE_INSTRUCTION,    
  R_SYS_CPU_CACHE_TRACE           
} RSysCpuCacheType;
 
typedef struct {
  ruint level;                    
  RSysCpuCacheType type;          
  rsize size;                     
  rsize linesize;                 
  rsize ways;                     
  rsize sets;                     
} RSysCpuCache;
 
R_API rsize r_sys_topology_cpu_id (const RSysCpu * cpu);
R_API rsize r_sys_topology_cpu_node_id (const RSysCpu * cpu);
R_API rsize r_sys_topology_cpu_core_id (const RSysCpu * cpu);
R_API rsize r_sys_topology_cpu_package_id (const RSysCpu * cpu);
R_API rboolean r_sys_topology_cpu_siblings (const RSysCpu * cpu, RBitset * cpuset);
 
R_API ruint64 r_sys_topology_cpu_max_frequency (const RSysCpu * cpu);
R_API ruint64 r_sys_topology_cpu_min_frequency (const RSysCpu * cpu);
 
R_API rsize r_sys_topology_cpu_cache_count (const RSysCpu * cpu);
R_API rboolean r_sys_topology_cpu_cache (const RSysCpu * cpu, rsize idx,
    RSysCpuCache * cache);
R_API rboolean r_sys_topology_cpu_cache_cpuset (const RSysCpu * cpu, rsize idx,
    RBitset * cpuset);
R_END_DECLS
 
#endif /* __R_SYS_H__ */