Endpoint.cpp File Reference

#include "geopm_endpoint.h"
#include "EndpointImp.hpp"
#include <cmath>
#include <cstring>
#include <unistd.h>
#include <algorithm>
#include <string>
#include <fstream>
#include <thread>
#include <chrono>
#include <stdexcept>
#include "geopm/Environment.hpp"
#include "geopm/SharedMemory.hpp"
#include "geopm/Exception.hpp"
#include "geopm/Helper.hpp"
#include "geopm/Agent.hpp"

Include dependency graph for Endpoint.cpp:

Namespaces
	geopm

Functions
int	geopm_endpoint_create (const char *endpoint_name, geopm_endpoint_c **endpoint)
	Create an endpoint object for other API functions. More...
int	geopm_endpoint_destroy (struct geopm_endpoint_c *endpoint)
	Release resources associated with endpoint. More...
int	geopm_endpoint_open (struct geopm_endpoint_c *endpoint)
	Create shmem regions within the endpoint for policy/sample handling. More...
int	geopm_endpoint_close (struct geopm_endpoint_c *endpoint)
	Destroy shmem regions within the endpoint. More...
int	geopm_endpoint_agent (struct geopm_endpoint_c *endpoint, size_t agent_name_max, char *agent_name)
	Check if an agent has attached. More...
int	geopm_endpoint_wait_for_agent_attach (struct geopm_endpoint_c *endpoint, double timeout)
	Blocks until an agent has attached or the timeout is reached. More...
int	geopm_endpoint_stop_wait_loop (struct geopm_endpoint_c *endpoint)
	Stops any current wait loops the endpoint is running. More...
int	geopm_endpoint_reset_wait_loop (struct geopm_endpoint_c *endpoint)
	Resets the endpoint to prepare for a subsequent call to geopm_endpoint_wait_for_agent_attach(). More...
int	geopm_endpoint_profile_name (struct geopm_endpoint_c *endpoint, size_t profile_name_max, char *profile_name)
	Check profile name for an attached job. More...
int	geopm_endpoint_num_node (struct geopm_endpoint_c *endpoint, int *num_node)
	Get the number of nodes managed by the agent. More...
int	geopm_endpoint_node_name (struct geopm_endpoint_c *endpoint, int node_idx, size_t node_name_max, char *node_name)
	Get the hostname of the indexed compute node. More...
int	geopm_endpoint_write_policy (struct geopm_endpoint_c *endpoint, size_t agent_num_policy, const double *policy_array)
	Set the policy values for the agent to follow. More...
int	geopm_endpoint_read_sample (struct geopm_endpoint_c *endpoint, size_t agent_num_sample, double *sample_array, double *sample_age_sec)
	Get a sample from the agent and amount of time that has passed since the agent last provided an update. More...

Function Documentation

geopm_endpoint_agent()

int geopm_endpoint_agent	(	struct geopm_endpoint_c *	endpoint,
		size_t	agent_name_max,
		char *	agent_name
	)

Check if an agent has attached.

Parameters

[in]	endpoint	Object created by call to geopm_endpoint_create().
[in]	agent_name_max	Number of bytes allocated for the agent_name string.
[out]	agent_name	Name of agent if one has attached to the endpoint. If no agent has attached string is unaltered.

Returns

Zero if endpoint has an agent attached and agent name can be stored in provided buffer, error code otherwise. If no agent has attached, error code GEOPM_ERROR_NO_AGENT is returned.

geopm_endpoint_close()

int geopm_endpoint_close

(

struct geopm_endpoint_c *

endpoint

)

Destroy shmem regions within the endpoint.

Parameters

[in]

endpoint

Object created by call to geopm_endpoint_create().

Returns

Zero on success, error code on failure.

geopm_endpoint_create()

int geopm_endpoint_create	(	const char *	endpoint_name,
		struct geopm_endpoint_c **	endpoint
	)

Create an endpoint object for other API functions.

Parameters

[in]	endpoint_name	Shared memory key substring used to create an endpoint that an agent can attach to.
[out]	endpoint	Opaque pointer to geopm_endpoint_c object, or NULL upon failure.

Returns

Zero on success, error code on failure.

geopm_endpoint_destroy()

int geopm_endpoint_destroy

(

struct geopm_endpoint_c *

endpoint

)

Release resources associated with endpoint.

Additionally will send a signal to the agent that the manager is detaching from the policy and will no longer send updates.

Parameters

[in]

endpoint

Object to be destroyed which was previously created by call to geopm_endpoint_create().

Returns

Zero on success, error code on failure.

geopm_endpoint_node_name()

int geopm_endpoint_node_name	(	struct geopm_endpoint_c *	endpoint,
		int	node_idx,
		size_t	node_name_max,
		char *	node_name
	)

Get the hostname of the indexed compute node.

Parameters

[in]	endpoint	Object created by call to geopm_endpoint_create() that has reported an attached agent.
[in]	node_idx	the index from zero to the value returned by geopm_agent_num_node() - 1.
[in]	node_name_max	Number of bytes allocated for the node_name string.
[out]	node_name	The compute node hostname.

Returns

Zero on success, error code on failure

geopm_endpoint_num_node()

int geopm_endpoint_num_node	(	struct geopm_endpoint_c *	endpoint,
		int *	num_node
	)

Get the number of nodes managed by the agent.

Parameters

[in]	endpoint	Object created by call to geopm_endpoint_create() that has reported an attached agent.
[out]	num_node	Number of compute nodes controlled by attached agent.

Returns

Zero on success, error code on failure.

geopm_endpoint_open()

int geopm_endpoint_open

(

struct geopm_endpoint_c *

endpoint

)

Create shmem regions within the endpoint for policy/sample handling.

Parameters

[in]

endpoint

Object created by call to geopm_endpoint_create().

Returns

Zero on success, error code on failure.

geopm_endpoint_profile_name()

int geopm_endpoint_profile_name	(	struct geopm_endpoint_c *	endpoint,
		size_t	profile_name_max,
		char *	profile_name
	)

Check profile name for an attached job.

Parameters

[in]	endpoint	Object created by call to geopm_endpoint_create().
[in]	profile_name_max	Number of bytes allocated for the profile_name string.
[out]	profile_name	Profile name of the job if one has attached to the endpoint. If no agent has attached string is unaltered.

Returns

Zero if endpoint has an agent attached and profile name can be stored in provided buffer, error code otherwise. If no agent has attached, error code GEOPM_ERROR_NO_AGENT is returned.

geopm_endpoint_read_sample()

int geopm_endpoint_read_sample	(	struct geopm_endpoint_c *	endpoint,
		size_t	num_sample,
		double *	sample_array,
		double *	sample_age_sec
	)

Get a sample from the agent and amount of time that has passed since the agent last provided an update.

Parameters

[in]	endpoint	Object created by call to geopm_endpoint_create() that has reported an attached agent that provides samples (i.e. value given by geopm_agent_num_sample() is greater than zero).
[out]	sample_array	Array of sampled values provide by the agent.
[out]	timestamp	The timestamp of the agent's last update to the sample.

Returns

Zero on success, error code on failure

geopm_endpoint_reset_wait_loop()

int geopm_endpoint_reset_wait_loop

(

struct geopm_endpoint_c *

endpoint

)

Resets the endpoint to prepare for a subsequent call to geopm_endpoint_wait_for_agent_attach().

Parameters

[in]

endpoint

Object created by call to geopm_endpoint_create().

geopm_endpoint_stop_wait_loop()

int geopm_endpoint_stop_wait_loop

(

struct geopm_endpoint_c *

endpoint

)

Stops any current wait loops the endpoint is running.

Parameters

[in]

endpoint

Object created by call to geopm_endpoint_create().

geopm_endpoint_wait_for_agent_attach()

int geopm_endpoint_wait_for_agent_attach	(	struct geopm_endpoint_c *	endpoint,
		double	timeout
	)

Blocks until an agent has attached or the timeout is reached.

Parameters

[in]	endpoint	Object created by call to geopm_endpoint_create().
[in]	timeout	Timeout in seconds.

geopm_endpoint_write_policy()

int geopm_endpoint_write_policy	(	struct geopm_endpoint_c *	endpoint,
		size_t	num_policy,
		const double *	policy_array
	)

Set the policy values for the agent to follow.

Parameters

[in]	endpoint	Object created by call to geopm_endpoint_create() that has reported an attached agent.
[in]	policy_array	Array of length returned by geopm_agent_num_policy() specifying the value of each policy parameter.

Returns

Zero on success, error code on failure