coretemp_freebsd.c File Reference

This component is intended to access CPU On-Die Thermal Sensors in the Intel Core architecture in a FreeBSD machine using the coretemp.ko kernel module. More...

Include dependency graph for coretemp_freebsd.c:

Go to the source code of this file.

Data Structures
struct	coretemp_register_t
struct	coretemp_native_event_entry_t
struct	coretemp_reg_alloc_t
struct	coretemp_control_state_t
struct	coretemp_context_t

Macros
#define	CORETEMP_MAX_COUNTERS   32 /* Can we tune this dynamically? */
#define	TRUE   (1==1)
#define	FALSE   (1!=1)
#define	UNREFERENCED(x)   (void)x

Functions
int	coretemp_init_thread (hwd_context_t *ctx)
int	coretemp_init_component ()
int	coretemp_init_control_state (hwd_control_state_t *ctrl)
int	coretemp_ntv_enum_events (unsigned int *EventCode, int modifier)
int	coretemp_ntv_code_to_name (unsigned int EventCode, char *name, int len)
int	coretemp_ntv_code_to_descr (unsigned int EventCode, char *name, int len)
int	coretemp_ntv_code_to_bits (unsigned int EventCode, hwd_register_t *bits)
int	coretemp_update_control_state (hwd_control_state_t *ptr, NativeInfo_t *native, int count, hwd_context_t *ctx)
int	coretemp_start (hwd_context_t *ctx, hwd_control_state_t *ctrl)
int	coretemp_stop (hwd_context_t *ctx, hwd_control_state_t *ctrl)
int	coretemp_read (hwd_context_t *ctx, hwd_control_state_t *ctrl, long_long **events, int flags)
int	coretemp_write (hwd_context_t *ctx, hwd_control_state_t *ctrl, long_long events[])
int	coretemp_reset (hwd_context_t *ctx, hwd_control_state_t *ctrl)
int	coretemp_shutdown_component (void)
int	coretemp_ctl (hwd_context_t *ctx, int code, _papi_int_option_t *option)
int	coretemp_set_domain (hwd_control_state_t *cntrl, int domain)

Variables
static coretemp_native_event_entry_t *	coretemp_native_table
static int	CORETEMP_NUM_EVENTS = 0
papi_vector_t	_coretemp_freebsd_vector

Detailed Description

Author

Joachim Protze joach.nosp@m.im.p.nosp@m.rotze.nosp@m.@zih.nosp@m..tu-d.nosp@m.resd.nosp@m.en.de

Vince Weaver vweav.nosp@m.er1@.nosp@m.eecs..nosp@m.utk..nosp@m.edu

Harald Servat haral.nosp@m.d.se.nosp@m.rvat@.nosp@m.gmai.nosp@m.l.com

Definition in file coretemp_freebsd.c.

Macro Definition Documentation

CORETEMP_MAX_COUNTERS

#define CORETEMP_MAX_COUNTERS   32 /* Can we tune this dynamically? */

Definition at line 37 of file coretemp_freebsd.c.

FALSE

#define FALSE   (1!=1)

Definition at line 39 of file coretemp_freebsd.c.

TRUE

#define TRUE   (1==1)

Definition at line 38 of file coretemp_freebsd.c.

UNREFERENCED

#define UNREFERENCED

(

x

)

(void)x

Definition at line 40 of file coretemp_freebsd.c.

Function Documentation

coretemp_ctl()

int coretemp_ctl	(	hwd_context_t *	ctx,
		int	code,
		_papi_int_option_t *	option
	)

This function sets various options in the component

Parameters

ctx	unused
code	valid are PAPI_SET_DEFDOM, PAPI_SET_DOMAIN, PAPI_SETDEFGRN, PAPI_SET_GRANUL and PAPI_SET_INHERIT
option	unused

Definition at line 401 of file coretemp_freebsd.c.

{
    UNREFERENCED(ctx);
    UNREFERENCED(code);
    UNREFERENCED(option);

    SUBDBG( "coretemp_ctl... %p %d %p\n", ctx, code, option );

    /* FIXME.  This should maybe set up more state, such as which counters are active and */
    /*         counter mappings. */

    return PAPI_OK;
}

Here is the caller graph for this function:

coretemp_init_component()

int coretemp_init_component

(

)

Initialize hardware counters, setup the function vector table and get hardware information, this routine is called when the PAPI process is initialized (IE PAPI_library_init)

Definition at line 121 of file coretemp_freebsd.c.

{
    int ret;
    int i;
    int mib[4];
    size_t len;
    char tmp[128];

    SUBDBG("coretemp_init_component...\n");

    /* Count the number of cores (counters) that have sensors allocated */
    i = 0;
    CORETEMP_NUM_EVENTS = 0;
    sprintf (tmp, "dev.coretemp.%d.%%driver", i);
    len = 4;
    ret = sysctlnametomib (tmp, mib, &len);
    while (ret != -1)
    {
        CORETEMP_NUM_EVENTS++;
        i++;
        sprintf (tmp, "dev.coretemp.%d.%%driver", i);
        len = 4;
        ret = sysctlnametomib (tmp, mib, &len);
    }

    if (CORETEMP_NUM_EVENTS == 0)
        return PAPI_OK;

    /* Allocate memory for the our event table */
    coretemp_native_table = (coretemp_native_event_entry_t *)
        papi_malloc (sizeof (coretemp_native_event_entry_t) * CORETEMP_NUM_EVENTS);
    if (coretemp_native_table == NULL)
    {
        perror( "malloc():Could not get memory for coretemp events table" );
        return PAPI_ENOMEM;
    }

    /* Allocate native events internal structures */
    for (i = 0; i < CORETEMP_NUM_EVENTS; i++)
    {
        /* Event name */
        sprintf (coretemp_native_table[i].name, "CORETEMP_CPU_%d", i);

        /* Event description */
        sprintf (coretemp_native_table[i].description, "CPU On-Die Thermal Sensor #%d", i);

        /* Event extra bits -> save MIB to faster access later */
        sprintf (tmp, "dev.cpu.%d.temperature", i);
        len = 4;
        if (sysctlnametomib (tmp, coretemp_native_table[i].resources.mib, &len) == -1)
            return PAPI_ECMP;

        coretemp_native_table[i].resources.selector = i+1;
    }

    return PAPI_OK;
}

coretemp_init_control_state()

int coretemp_init_control_state

(

hwd_control_state_t *

ctrl

)

Setup the counter control structure

Definition at line 181 of file coretemp_freebsd.c.

{
    int i;

    SUBDBG("coretemp_init_control_state... %p\n", ctrl);
    coretemp_control_state_t *c = (coretemp_control_state_t *) ctrl;

    for (i = 0; i < CORETEMP_MAX_COUNTERS; i++)
        c->added[i] = FALSE;

    return PAPI_OK;
}

coretemp_init_thread()

int coretemp_init_thread

(

hwd_context_t *

ctx

)

This is called whenever a thread is initialized

Definition at line 94 of file coretemp_freebsd.c.

{
    int mib[4];
    size_t len;
    UNREFERENCED(ctx);

    ( void ) mib; /*unused */
    ( void ) len; /*unused */

    SUBDBG("coretemp_init_thread %p...\n", ctx);

#if 0
    /* what does this do?  VMW */

    len = 4;
    if (sysctlnametomib ("dev.coretemp.0.%driver", mib, &len) == -1)
        return PAPI_ECMP;
#endif

    return PAPI_OK;
}

coretemp_ntv_code_to_bits()

int coretemp_ntv_code_to_bits	(	unsigned int	EventCode,
		hwd_register_t *	bits
	)

This takes an event and returns the bits that would be written out to the hardware device (this is very much tied to CPU-type support

Definition at line 262 of file coretemp_freebsd.c.

{
    UNREFERENCED(EventCode);
    UNREFERENCED(bits);

    return PAPI_OK;
}

coretemp_ntv_code_to_descr()

int coretemp_ntv_code_to_descr	(	unsigned int	EventCode,
		char *	name,
		int	len
	)

Takes a native event code and passes back the event description

Parameters

EventCode	is the native event code
name	is a pointer for the description to be copied to
len	is the size of the string

Definition at line 251 of file coretemp_freebsd.c.

{
    int index = EventCode;

    strncpy( name, coretemp_native_table[index].description, len );

    return PAPI_OK;
}

coretemp_ntv_code_to_name()

int coretemp_ntv_code_to_name	(	unsigned int	EventCode,
		char *	name,
		int	len
	)

Takes a native event code and passes back the name

Parameters

EventCode	is the native event code
name	is a pointer for the name to be copied to
len	is the size of the string

Definition at line 237 of file coretemp_freebsd.c.

{
    int index = EventCode;

    strncpy( name, coretemp_native_table[index].name, len );

    return PAPI_OK;
}

coretemp_ntv_enum_events()

int coretemp_ntv_enum_events	(	unsigned int *	EventCode,
		int	modifier
	)

Enumerate Native Events

Parameters

EventCode	is the event of interest
modifier	is one of PAPI_ENUM_FIRST, PAPI_ENUM_EVENTS

Definition at line 199 of file coretemp_freebsd.c.

{

    switch ( modifier )
    {
        /* return EventCode of first event */
        case PAPI_ENUM_FIRST:
        *EventCode = 0;
        return PAPI_OK;
        break;

        /* return EventCode of passed-in Event */
        case PAPI_ENUM_EVENTS:
        {
            int index = *EventCode;

            if ( index < CORETEMP_NUM_EVENTS - 1 )
            {
                *EventCode = *EventCode + 1;
                return PAPI_OK;
            }
            else
                return PAPI_ENOEVNT;
            break;
        }

        default:
            return PAPI_EINVAL;
    }

    return PAPI_EINVAL;
}

coretemp_read()

int coretemp_read	(	hwd_context_t *	ctx,
		hwd_control_state_t *	ctrl,
		long_long **	events,
		int	flags
	)

Triggered by PAPI_read()

Definition at line 322 of file coretemp_freebsd.c.

{
    int i;
    coretemp_control_state_t *c = (coretemp_control_state_t *) ctrl;
    UNREFERENCED(ctx);
    UNREFERENCED(flags);

    SUBDBG("coretemp_read... %p %d\n", ctx, flags);

    for (i = 0; i < CORETEMP_MAX_COUNTERS; i++)
        if (c->added[i])
        {
            int tmp;
            size_t len = sizeof(tmp);

            if (sysctl (coretemp_native_table[i].resources.mib, 4, &tmp, &len, NULL, 0) == -1)
                c->counters[i] = 0;
            else
                c->counters[i] = tmp/10;
                /* Coretemp module returns temperature in tenths of kelvin 
                   Kelvin are useful to avoid negative values... but will have
                   negative temperatures ??? */
        }

    *events = c->counters;

    return PAPI_OK;
}

coretemp_reset()

int coretemp_reset	(	hwd_context_t *	ctx,
		hwd_control_state_t *	ctrl
	)

Triggered by PAPI_reset

Definition at line 370 of file coretemp_freebsd.c.

{
    UNREFERENCED(ctx);
    UNREFERENCED(ctrl);

    SUBDBG("coretemp_reset ctx=%p ctrl=%p...\n", ctx, ctrl);

    /* These sensors cannot be reseted */

    return PAPI_OK;
}

coretemp_set_domain()

int coretemp_set_domain	(	hwd_control_state_t *	cntrl,
		int	domain
	)

This function has to set the bits needed to count different domains In particular: PAPI_DOM_USER, PAPI_DOM_KERNEL PAPI_DOM_OTHER By default return PAPI_EINVAL if none of those are specified and PAPI_OK with success PAPI_DOM_USER is only user context is counted PAPI_DOM_KERNEL is only the Kernel/OS context is counted PAPI_DOM_OTHER is Exception/transient mode (like user TLB misses) PAPI_DOM_ALL is all of the domains

Definition at line 424 of file coretemp_freebsd.c.

{
    UNREFERENCED(cntrl);

    SUBDBG ("coretemp_set_domain... %p %d\n", cntrl, domain);

    if (PAPI_DOM_ALL & domain)
    {
        SUBDBG( " PAPI_DOM_ALL \n" );
        return PAPI_OK;
    }
    return PAPI_EINVAL ;

}

coretemp_shutdown_component()

int coretemp_shutdown_component

(

void

)

Triggered by PAPI_shutdown()

Definition at line 383 of file coretemp_freebsd.c.

{

    SUBDBG( "coretemp_shutdown_component...\n");

    /* Last chance to clean up */
    papi_free (coretemp_native_table);

    return PAPI_OK;
}

coretemp_start()

int coretemp_start	(	hwd_context_t *	ctx,
		hwd_control_state_t *	ctrl
	)

Triggered by PAPI_start()

Definition at line 294 of file coretemp_freebsd.c.

{
    UNREFERENCED(ctx);
    UNREFERENCED(ctrl);

    SUBDBG( "coretemp_start %p %p...\n", ctx, ctrl );

    /* Nothing to be done */

    return PAPI_OK;
}

coretemp_stop()

int coretemp_stop	(	hwd_context_t *	ctx,
		hwd_control_state_t *	ctrl
	)

Triggered by PAPI_stop()

Definition at line 308 of file coretemp_freebsd.c.

{
    UNREFERENCED(ctx);
    UNREFERENCED(ctrl);

    SUBDBG("coretemp_stop %p %p...\n", ctx, ctrl);

    /* Nothing to be done */

    return PAPI_OK;
}

coretemp_update_control_state()

int coretemp_update_control_state	(	hwd_control_state_t *	ptr,
		NativeInfo_t *	native,
		int	count,
		hwd_context_t *	ctx
	)

Triggered by eventset operations like add or remove

Definition at line 271 of file coretemp_freebsd.c.

{
    int i, index;
    coretemp_control_state_t *c = (coretemp_control_state_t *) ptr;
    UNREFERENCED(ctx);

    SUBDBG("coretemp_update_control_state %p %p...\n", ptr, ctx);

    for (i = 0; i < count; i++)
    {
        index = native[i].ni_event;
        native[i].ni_position = coretemp_native_table[index].resources.selector - 1;
        c->added[native[i].ni_position] = TRUE;

        SUBDBG ("\nnative[%i].ni_position = coretemp_native_table[%i].resources.selector-1 = %i;\n",
          i, index, native[i].ni_position );
    }

    return PAPI_OK;
}

coretemp_write()

int coretemp_write	(	hwd_context_t *	ctx,
		hwd_control_state_t *	ctrl,
		long_long	events[]
	)

Triggered by PAPI_write(), but only if the counters are running

Definition at line 354 of file coretemp_freebsd.c.

{
    UNREFERENCED(ctx);
    UNREFERENCED(events);
    UNREFERENCED(ctrl);

    SUBDBG("coretemp_write... %p %p\n", ctx, ctrl);

    /* These sensor counters cannot be writtn */

    return PAPI_OK;
}

Variable Documentation

_coretemp_freebsd_vector

papi_vector_t _coretemp_freebsd_vector

Vector that points to entry points for our component

Definition at line 441 of file coretemp_freebsd.c.

coretemp_native_table

coretemp_native_event_entry_t* coretemp_native_table

static

This table contains the native events

Definition at line 83 of file coretemp_freebsd.c.

CORETEMP_NUM_EVENTS

int CORETEMP_NUM_EVENTS = 0

static

number of events in the table

Definition at line 86 of file coretemp_freebsd.c.