geopm-runtime-dox/geopm__ctl_8h_source.html

/*

 * Copyright (c) 2015 - 2024 Intel Corporation

 * SPDX-License-Identifier: BSD-3-Clause

 */


#ifndef GEOPM_CTL_H_INCLUDE

#define GEOPM_CTL_H_INCLUDE


#include <mpi.h>

#include <stdio.h>

#include <stdint.h>

#include <pthread.h>

#include "geopm_public.h"


#ifdef __cplusplus

extern "C" {

#endif


/* Opaque structure which is a handle for a geopm::Controller object. */

struct geopm_ctl_c;


/************************/

/* OBJECT INSTANTIATION */

/************************/


int GEOPM_PUBLIC

    geopm_ctl_create(MPI_Comm comm,

                     struct geopm_ctl_c **ctl);


int GEOPM_PUBLIC

    geopm_ctl_destroy(struct geopm_ctl_c *ctl);


/********************/

/* POWER MANAGEMENT */

/********************/


int GEOPM_PUBLIC

    geopm_ctl_run(struct geopm_ctl_c *ctl);


int GEOPM_PUBLIC

    geopm_ctl_pthread(struct geopm_ctl_c *ctl,

                      const pthread_attr_t *attr,

                      pthread_t *thread);

#ifdef __cplusplus

}

#endif

#endif

geopm_ctl_destroy
int GEOPM_PUBLIC geopm_ctl_destroy(struct geopm_ctl_c *ctl)
destroys all resources associated with the ctl structure which allocated by a previous call to geopm_...
Definition Controller.cpp:102

geopm_ctl_create
int GEOPM_PUBLIC geopm_ctl_create(MPI_Comm comm, struct geopm_ctl_c **ctl)
creates a geopm_ctl_c object, ctl which is an opaque structure that holds the state used to execute t...
Definition MPICommSplit.cpp:23

geopm_ctl_pthread
int GEOPM_PUBLIC geopm_ctl_pthread(struct geopm_ctl_c *ctl, const pthread_attr_t *attr, pthread_t *thread)
creates a POSIX thread running the control algorithm continuously until the application signals shutd...
Definition Controller.cpp:47

geopm_ctl_run
int GEOPM_PUBLIC geopm_ctl_run(struct geopm_ctl_c *ctl)
steps the control algorithm continuously until the application signals shutdown.
Definition Controller.cpp:128