offload_api Module Reference

Fortran API for the offload package, which is written in C. More...

Data Types
type	offload_buffer_type

Functions/Subroutines
integer function, public	offload_malloc_pinned_mem (buffer, length)
	allocate pinned memory.
integer function, public	offload_free_pinned_mem (buffer)
	free pinned memory
subroutine, public	offload_init ()
	Initialize runtime.
integer function, public	offload_get_device_count ()
	Returns the number of available devices.
subroutine, public	offload_set_chosen_device (device_id)
	Selects the chosen device to be used.
integer function, public	offload_get_chosen_device ()
	Returns the chosen device.
subroutine, public	offload_activate_chosen_device ()
	Activates the device selected via offload_set_chosen_device()
subroutine, public	offload_timeset (routinen)
	Starts a timing range.
subroutine, public	offload_timestop ()
	Ends a timing range.
subroutine, public	offload_mem_info (free, total)
	Gets free and total device memory.
subroutine, public	offload_create_buffer (length, buffer)
	Allocates a buffer of given length, ie. number of elements.
subroutine, public	offload_free_buffer (buffer)
	Deallocates given buffer.
subroutine, public	offload_mempool_stats_print (mpi_comm, output_unit)
	Print allocation statistics.

Detailed Description

Fortran API for the offload package, which is written in C.

Author

Ole Schuett

Function/Subroutine Documentation

offload_malloc_pinned_mem()

integer function, public offload_api::offload_malloc_pinned_mem	(	type(c_ptr)	buffer,
		integer(c_size_t), value	length
	)

allocate pinned memory.

Parameters

buffer	address of the buffer
length	length of the buffer

Returns

0

Definition at line 48 of file offload_api.F.

Here is the caller graph for this function:

offload_free_pinned_mem()

integer function, public offload_api::offload_free_pinned_mem

(

type(c_ptr), value

buffer

)

free pinned memory

Parameters

buffer

address of the buffer

Returns

0

Definition at line 71 of file offload_api.F.

Here is the caller graph for this function:

offload_init()

subroutine, public offload_api::offload_init

(

void

)

Initialize runtime.

Returns

...

Author

Rocco Meli

Definition at line 92 of file offload_api.F.

Here is the caller graph for this function:

offload_get_device_count()

integer function, public offload_api::offload_get_device_count

(

void

)

Returns the number of available devices.

Returns

...

Author

Ole Schuett

Definition at line 108 of file offload_api.F.

Here is the caller graph for this function:

offload_set_chosen_device()

subroutine, public offload_api::offload_set_chosen_device

(

integer, intent(in)

device_id

)

Selects the chosen device to be used.

Parameters

device_id

...

Author

Ole Schuett

Definition at line 128 of file offload_api.F.

Here is the caller graph for this function:

offload_get_chosen_device()

integer function, public offload_api::offload_get_chosen_device

(

void

)

Returns the chosen device.

Returns

...

Author

Ole Schuett

Definition at line 148 of file offload_api.F.

offload_activate_chosen_device()

subroutine, public offload_api::offload_activate_chosen_device

(

void

)

Activates the device selected via offload_set_chosen_device()

Author

Ole Schuett

Definition at line 170 of file offload_api.F.

Here is the caller graph for this function:

offload_timeset()

subroutine, public offload_api::offload_timeset

(

character(len=*), intent(in)

routinen

)

Starts a timing range.

Parameters

routineN

...

Author

Ole Schuett

Definition at line 187 of file offload_api.F.

Here is the caller graph for this function:

offload_timestop()

subroutine, public offload_api::offload_timestop

(

void

)

Ends a timing range.

Author

Ole Schuett

Definition at line 205 of file offload_api.F.

Here is the caller graph for this function:

offload_mem_info()

subroutine, public offload_api::offload_mem_info	(	integer(kind=int_8), intent(out)	free,
		integer(kind=int_8), intent(out)	total
	)

Gets free and total device memory.

Parameters

free	...
total	...

Author

Ole Schuett

Definition at line 222 of file offload_api.F.

Here is the caller graph for this function:

offload_create_buffer()

subroutine, public offload_api::offload_create_buffer	(	integer, intent(in)	length,
		type(offload_buffer_type), intent(inout)	buffer
	)

Allocates a buffer of given length, ie. number of elements.

Parameters

length	...
buffer	...

Author

Ole Schuett

Definition at line 247 of file offload_api.F.

Here is the caller graph for this function:

offload_free_buffer()

subroutine, public offload_api::offload_free_buffer

(

type(offload_buffer_type), intent(inout)

buffer

)

Deallocates given buffer.

Parameters

buffer

...

Author

Ole Schuett

Definition at line 299 of file offload_api.F.

Here is the caller graph for this function:

offload_mempool_stats_print()

subroutine, public offload_api::offload_mempool_stats_print	(	type(mp_comm_type), intent(in)	mpi_comm,
		integer, intent(in)	output_unit
	)

Print allocation statistics.

Parameters

mpi_comm	...
output_unit	...

Author

Ole Schuett

Definition at line 337 of file offload_api.F.

Here is the call graph for this function: