include/topology.h

Go to the documentation of this file.

/*
 * libtopology - a library for discovering Linux system topology
 *
 * Copyright 2008 Nathan Lynch, IBM Corporation
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * 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; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

#ifndef _TOPOLOGY_H_
#define _TOPOLOGY_H_

#ifdef __cplusplus
extern "C" {
#endif

#ifndef LIBTOPOLOGY_DOXYGEN_SKIP

#include <sched.h> /* for cpu_set_t */

#endif /* LIBTOPOLOGY_DOXYGEN_SKIP */

typedef unsigned long topo_context_t;
typedef unsigned long topo_procent_t;
typedef unsigned long topo_device_t;

typedef enum topology_level {
        TOPOLOGY_THREAD = 1,
        TOPOLOGY_CORE,
        TOPOLOGY_PACKAGE,
        TOPOLOGY_NODE,
        TOPOLOGY_SYSTEM,
} topo_level_t;

extern int topology_init_context(topo_context_t *ctx, topo_procent_t *system);

extern void topology_free_context(topo_context_t ctx);

extern size_t topology_sizeof_cpumask(topo_context_t ctx);

extern topo_procent_t
topology_traverse(topo_procent_t start,
                  topo_procent_t iter,
                  topo_level_t to_level);
extern void topology_procent_cpumask(topo_procent_t ent, cpu_set_t *dest);

extern topo_device_t
topology_find_device_by_type(topo_context_t ctx,
                             topo_device_t prev,
                             const char *type);


extern void topology_device_cpumask(topo_device_t dev, cpu_set_t *dest);

extern const char *
topology_device_get_attribute(topo_device_t dev, const char *name);

#define topology_for_each_device_of_type(ctx, dev, type)                            \
        for ((dev) = topology_find_device_by_type((ctx), (topo_device_t)0, (type)); \
             (dev) != 0;                                                            \
             (dev) = topology_find_device_by_type((ctx), (dev), (type)))

#ifdef __cplusplus
}
#endif

#endif /* _TOPOLOGY_H_ */

---