prt_channel.h File Reference

PRT data channel. More...

#include "prt.h"

Include dependency graph for prt_channel.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	prt_channel_s
	VDP's data channel Implements a data link between a pair of VDPs. Identifies the source and destination VDPs by tuples. Contains a list of data packets, protected by a spinlock. More...

Typedefs
typedef struct prt_channel_s	prt_channel_t
	VDP's data channel Implements a data link between a pair of VDPs. Identifies the source and destination VDPs by tuples. Contains a list of data packets, protected by a spinlock. More...
typedef enum prt_channel_direction_e	prt_channel_direction_t
	VDP's data channel direction Identifies the direction of a VDP channel during insertion. More...

Enumerations
enum	prt_channel_direction_e { PrtInputChannel, PrtOutputChannel }
	VDP's data channel direction Identifies the direction of a VDP channel during insertion. More...

Functions
prt_channel_t *	prt_channel_new (int count, MPI_Datatype datatype, int *src_tuple, int src_slot, int *dst_tuple, int dst_slot)
	channel constructor More...
void	prt_channel_delete (prt_channel_t *channel)
	channel destructor More...
void	prt_channel_push (prt_channel_t *channel, struct prt_packet_s *packet)
	Sends a packed down a channel. Increments the packet's number of active references. More...
struct prt_packet_s *	prt_channel_pop (prt_channel_t *channel)
	Fetches a packef from a channel. Does not decrement the number of active references. The packet leaves the channel, but enters the VDP. More...
int	prt_channel_empty (prt_channel_t *channel)
	Checks if a channel is empty. More...
int	prt_channel_compare (void *channel1, void *channel2)
	Compare two channels. Channels are equal if they have the same source and destination tuples and slots. More...

Detailed Description

PRT data channel.

Author

Jakub Kurzak

PULSAR Runtime /pulsar/ Copyright (C) 2012-2013 University of Tennessee.

Definition in file prt_channel.h.

Typedef Documentation

typedef enum prt_channel_direction_e prt_channel_direction_t

VDP's data channel direction Identifies the direction of a VDP channel during insertion.

typedef struct prt_channel_s prt_channel_t

VDP's data channel Implements a data link between a pair of VDPs. Identifies the source and destination VDPs by tuples. Contains a list of data packets, protected by a spinlock.

Enumeration Type Documentation

enum prt_channel_direction_e

VDP's data channel direction Identifies the direction of a VDP channel during insertion.

Enumerator
PrtInputChannel
PrtOutputChannel

Definition at line 46 of file prt_channel.h.

                                     {
    PrtInputChannel, PrtOutputChannel
} prt_channel_direction_t;

Function Documentation

int prt_channel_compare	(	void *	channel1,
		void *	channel2
	)

Compare two channels. Channels are equal if they have the same source and destination tuples and slots.

Parameters

channel1
channel2

Return values

0	Channels are equal. @
1	Channels are not equal.

Definition at line 171 of file prt_channel.c.

References prt_channel_s::dst_slot, prt_channel_s::dst_tuple, prt_tuple_compare(), prt_channel_s::src_slot, and prt_channel_s::src_tuple.

{
    prt_channel_t *c1 = (prt_channel_t*)channel1;
    prt_channel_t *c2 = (prt_channel_t*)channel2;
    if (prt_tuple_compare(c1->src_tuple, c2->src_tuple) != 0) return 1;
    if (prt_tuple_compare(c1->dst_tuple, c2->dst_tuple) != 0) return 1;
    if (c1->src_slot != c2->src_slot) return 1;
    if (c1->dst_slot != c2->dst_slot) return 1;
    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void prt_channel_delete

(

prt_channel_t *

channel

)

channel destructor

Parameters

channel

Definition at line 63 of file prt_channel.c.

References prt_channel_s::dst_tuple, icl_deque_destroy(), icl_deque_size(), prt_channel_s::packets, prt_assert, and prt_channel_s::src_tuple.

{
    // Check for a NULL channel.
    prt_assert(channel != NULL, "NULL channel");

    // Free the source tuple.
    prt_assert(channel->src_tuple != NULL, "NULL tuple");
    free(channel->src_tuple);

    // Free the destination tuple.
    prt_assert(channel->dst_tuple != NULL, "NULL tuple");
    free(channel->dst_tuple);

    // Destroy the list of packets.
    // Only an empty list can be destroyed.
    // Therefore NULL given as the packet destructor.
    prt_assert(channel->packets != NULL, "NULL packets list");
    int size = icl_deque_size(channel->packets);
    prt_assert(size == 0, "non-epty packet list");
    icl_deque_destroy(channel->packets, NULL);
//printf("delete\n"); fflush(stdout);
    // Free the channel.
    free(channel);
}

Here is the call graph for this function:

Here is the caller graph for this function:

int prt_channel_empty

(

prt_channel_t *

channel

)

Checks if a channel is empty.

Parameters

channel

Return values

0	Channel is not empty. @
1	Channel is empty.

Definition at line 150 of file prt_channel.c.

References icl_deque_first(), prt_channel_s::packets, and prt_assert.

{
    // Check for a NULL input params.
    prt_assert(channel != NULL, "NULL channel");
    prt_assert(channel->packets != NULL, "NULL packet list");

    // Return the status.
    return (icl_deque_first(channel->packets) == NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

prt_channel_t* prt_channel_new	(	int	count,
		MPI_Datatype	datatype,
		int *	src_tuple,
		int	src_slot,
		int *	dst_tuple,
		int	dst_slot
	)

channel constructor

Parameters

count	number of data elements in a packet
datatype	MPI data type of elements in a packet
src_tuple	tuple of the source VDP
src_slot	slot number in the source VDP
dst_tuple	tuple of the destination VDP
dst_slot	slot number in the destination VDP

Returns

new channel

Definition at line 26 of file prt_channel.c.

References prt_channel_s::count, prt_channel_s::datatype, prt_channel_s::dst_slot, prt_channel_s::dst_tuple, icl_deque_new(), prt_channel_s::packets, prt_assert, prt_channel_s::src_slot, prt_channel_s::src_tuple, and prt_channel_s::vdp.

{
    // Allocate the channel.
    prt_channel_t *channel = (prt_channel_t*)malloc(sizeof(prt_channel_t));
    prt_assert(channel != NULL, "malloc failed");

    // Check parameters.
    prt_assert(count > 0, "count less or equal zero");
    prt_assert(src_tuple != NULL, "NULL source tuple");
    prt_assert(src_tuple != NULL, "NULL destination tuple");

    // Initialize the channel.
    channel->vdp = NULL;
    channel->count = count;
    channel->datatype = datatype;
    channel->src_tuple = src_tuple;
    channel->dst_tuple = dst_tuple;
    channel->src_slot = src_slot;
    channel->dst_slot = dst_slot;

    // Create the list of packets.
    channel->packets = icl_deque_new();
    prt_assert(channel->packets != NULL, "icl_deque_new() failed");
//printf("new\n"); fflush(stdout);
    // Return the channel.
    return channel;
}

Here is the call graph for this function:

struct prt_packet_s* prt_channel_pop

(

prt_channel_t *

channel

)

Fetches a packef from a channel. Does not decrement the number of active references. The packet leaves the channel, but enters the VDP.

Parameters

channel

Returns

data packet

Definition at line 125 of file prt_channel.c.

References icl_list_s::data, icl_deque_delete(), icl_deque_first(), prt_channel_s::packets, and prt_assert.

{
    // Check for a NULL input params.
    prt_assert(channel != NULL, "popping from a NULL channel");
    prt_assert(channel->packets != NULL, "popping from a NULL packet list");

    icl_node_t *node = icl_deque_first(channel->packets);
    prt_assert(node != NULL, "empty packet list");

    prt_packet_t *packet = (prt_packet_t*)node->data;
    prt_assert(packet != NULL, "NULL packet");

    icl_deque_delete(channel->packets, node, NULL);
    return packet;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void prt_channel_push	(	prt_channel_t *	channel,
		prt_packet_t *	packet
	)

Sends a packed down a channel. Increments the packet's number of active references.

Parameters

channel
packet

Definition at line 96 of file prt_channel.c.

References prt_channel_s::dst_node, icl_deque_append(), prt_vsa_s::node_rank, prt_packet_s::num_refs, prt_channel_s::packets, prt_vsa_s::proxy, prt_assert, prt_proxy_send(), prt_thread_s::rank, prt_vdp_s::thread, prt_channel_s::vdp, and prt_thread_s::vsa.

{
    // Check for a NULL input params.
    prt_assert(packet != NULL, "NULL packet");
    prt_assert(channel != NULL, "NULL channel");
    prt_assert(channel->packets != NULL, "NULL packet list");

    __sync_fetch_and_add(&packet->num_refs, 1);
    icl_deque_append(channel->packets, (void*)packet);

    // IF a dangling channel.
    if (channel->dst_node != channel->vdp->thread->vsa->node_rank)
        // Notify the proxy.
        prt_proxy_send(
            channel->vdp->thread->vsa->proxy,
            channel->vdp->thread->rank,
            channel);
}

Here is the call graph for this function:

Here is the caller graph for this function: