Top | ![]() |
![]() |
![]() |
![]() |
drm_intel_bo * | gem_handle_to_libdrm_bo () |
void | gem_get_tiling () |
void | gem_set_tiling () |
void | gem_set_caching () |
uint32_t | gem_get_caching () |
uint32_t | gem_flink () |
uint32_t | gem_open () |
void | gem_close () |
void | gem_write () |
void | gem_read () |
void | gem_set_domain () |
void | gem_sync () |
uint32_t | gem_create () |
void | gem_execbuf () |
void * | gem_mmap__gtt () |
void * | gem_mmap__cpu () |
int | gem_madvise () |
uint32_t | gem_context_create () |
void | gem_sw_finish () |
bool | gem_bo_busy () |
bool | gem_has_llc () |
int | gem_get_num_rings () |
bool | gem_has_enable_ring () |
bool | gem_has_bsd () |
bool | gem_has_blt () |
bool | gem_has_vebox () |
bool | gem_uses_aliasing_ppgtt () |
int | gem_available_fences () |
uint64_t | gem_available_aperture_size () |
uint64_t | gem_aperture_size () |
uint64_t | gem_mappable_aperture_size () |
void | gem_require_caching () |
void | gem_require_ring () |
int | prime_handle_to_fd () |
uint32_t | prime_fd_to_handle () |
off_t | prime_get_size () |
This helper library contains simple functions to wrap the raw drm/i915 kernel
ioctls. The normal versions never pass any error codes to the caller and use
igt_assert()
to check for error conditions instead. For some ioctls raw
wrappers which do pass on error codes are available. These raw wrappers have
a __ prefix.
For wrappers which check for feature bits there can also be two versions: The
normal one simply returns a boolean to the caller. But when skipping the
testcase entirely is the right action then it's better to use igt_skip()
directly in the wrapper. Such functions have _require_ in their name to
distinguish them.
drm_intel_bo * gem_handle_to_libdrm_bo (drm_intel_bufmgr *bufmgr
,int fd
,const char *name
,uint32_t handle
);
This helper function imports a raw gem buffer handle into the libdrm buffer manager.
void gem_get_tiling (int fd
,uint32_t handle
,uint32_t *tiling
,uint32_t *swizzle
);
This wraps the GET_TILING ioctl.
void gem_set_tiling (int fd
,uint32_t handle
,uint32_t tiling
,uint32_t stride
);
This wraps the SET_TILING ioctl.
void gem_set_caching (int fd
,uint32_t handle
,uint32_t caching
);
This wraps the SET_CACHING ioctl. Note that this function internally calls
igt_require()
when SET_CACHING isn't available, hence automatically skips the
test. Therefore always extract test logic which uses this into its own
subtest.
uint32_t gem_get_caching (int fd
,uint32_t handle
);
This wraps the GET_CACHING ioctl.
uint32_t gem_flink (int fd
,uint32_t handle
);
This wraps the GEM_FLINK ioctl, which is used to export a gem buffer object
into the device-global flink namespace. See gem_open()
for opening such a
buffer name on a different i915 drm file descriptor.
uint32_t gem_open (int fd
,uint32_t name
);
This wraps the GEM_OPEN ioctl, which is used to import an flink name.
void gem_close (int fd
,uint32_t handle
);
This wraps the GEM_CLOSE ioctl, which to release a file-private gem buffer handle.
void gem_write (int fd
,uint32_t handle
,uint32_t offset
,const void *buf
,uint32_t length
);
This wraps the PWRITE ioctl, which is to upload a linear data to a subrange of a gem buffer object.
void gem_read (int fd
,uint32_t handle
,uint32_t offset
,void *buf
,uint32_t length
);
This wraps the PREAD ioctl, which is to download a linear data to a subrange of a gem buffer object.
void gem_set_domain (int fd
,uint32_t handle
,uint32_t read_domains
,uint32_t write_domain
);
This wraps the SET_DOMAIN ioctl, which is used to control the coherency of
the gem buffer object between the cpu and gtt mappings. It is also use to
synchronize with outstanding rendering in general, but for that use-case
please have a look at gem_sync()
.
void gem_sync (int fd
,uint32_t handle
);
This is a wrapper around gem_set_domain()
which simply blocks for any
outstanding rendering to complete.
uint32_t gem_create (int fd
,int size
);
This wraps the GEM_CREATE ioctl, which allocates a new gem buffer object of
size
.
void gem_execbuf (int fd
,struct drm_i915_gem_execbuffer2 *execbuf
);
This wraps the EXECBUFFER2 ioctl, which submits a batchbuffer for the gpu to run.
void * gem_mmap__gtt (int fd
,uint32_t handle
,int size
,int prot
);
This functions wraps up procedure to establish a memory mapping through the GTT.
void * gem_mmap__cpu (int fd
,uint32_t handle
,int offset
,int size
,int prot
);
This functions wraps up procedure to establish a memory mapping through direct cpu access, bypassing the gpu completely.
int gem_madvise (int fd
,uint32_t handle
,int state
);
This is a wraps the MADVISE ioctl, which is used in libdrm to implement opportunistic buffer object caching. Objects in the cache are set to DONTNEED (internally in the kernel tracked as purgeable objects). When such a cached object is in need again it must be set back to WILLNEED before first use.
uint32_t
gem_context_create (int fd
);
This is a wraps the CONTEXT_CREATE ioctl, which is used to allocate a new
hardware context. Not that similarly to gem_set_caching()
this wrapper calls
igt_require()
internally to correctly skip on kernels and platforms where hw
context support is not available.
void gem_sw_finish (int fd
,uint32_t handle
);
This is a wraps the SW_FINISH ioctl, which is used to flush out frontbuffer rendering done through the direct cpu memory mappings. Shipping userspace does _not_ call this after frontbuffer rendering through gtt memory mappings.
bool gem_bo_busy (int fd
,uint32_t handle
);
This is a wraps the BUSY ioctl, which tells whether a buffer object is still actively used by the gpu in a execbuffer.
int
gem_get_num_rings (int fd
);
Feature test macro to query the number of available rings. This is useful in test loops which need to step through all rings and similar logic.
For more explicit tests of ring availability see gem_has_enable_ring()
and
the ring specific versions like gem_has_bsd()
.
bool gem_has_enable_ring (int fd
,int param
);
Feature test macro to query whether a specific ring is available.
bool
gem_has_bsd (int fd
);
Feature test macro to query whether the BSD ring is available. This is simply
a specific version of gem_has_enable_ring()
for the BSD ring.
Note that recent Bspec calls this the VCS ring for Video Command Submission.
bool
gem_has_blt (int fd
);
Feature test macro to query whether the blitter ring is available. This is simply
a specific version of gem_has_enable_ring()
for the blitter ring.
Note that recent Bspec calls this the BCS ring for Blitter Command Submission.
bool
gem_has_vebox (int fd
);
Feature test macro to query whether the vebox ring is available. This is simply
a specific version of gem_has_enable_ring()
for the vebox ring.
Note that recent Bspec calls this the VECS ring for Video Enhancement Command Submission.
bool
gem_uses_aliasing_ppgtt (int fd
);
Feature test macro to check whether the kernel internally uses ppgtt to execute batches. The /aliasing/ in the function name is a bit a misnomer, this driver parameter is also true when full ppgtt address spaces are available since for batchbuffer construction only ppgtt or global gtt is relevant.
int
gem_available_fences (int fd
);
Feature test macro to query the kernel for the number of available fences usable in a batchbuffer. Only relevant for pre-gen4.
uint64_t
gem_available_aperture_size (int fd
);
Feature test macro to query the kernel for the available gpu aperture size usable in a batchbuffer.
uint64_t
gem_aperture_size (int fd
);
Feature test macro to query the kernel for the total gpu aperture size.
uint64_t
gem_mappable_aperture_size (void
);
Feature test macro to query the kernel for the mappable gpu aperture size. This is the area available for GTT memory mappings.
void
gem_require_caching (int fd
);
Feature test macro to query whether buffer object caching control is
available. Automatically skips through igt_require()
if not.
void gem_require_ring (int fd
,int ring_id
);
Feature test macro to query whether a specific ring is available.
In contrast to gem_has_enable_ring()
this automagically skips if the ring
isn't available by calling igt_require()
.
int prime_handle_to_fd (int fd
,uint32_t handle
);
This wraps the PRIME_HANDLE_TO_FD ioctl, which is used to export a gem buffer object into a global (i.e. potentially cross-device) dma-buf file-descriptor handle.
uint32_t prime_fd_to_handle (int fd
,int dma_buf_fd
);
This wraps the PRIME_FD_TO_HANDLE ioctl, which is used to import a dma-buf file-descriptor into a gem buffer object.
off_t
prime_get_size (int dma_buf_fd
);
This wraps the lseek()
protocol used to query the invariant size of a
dma-buf. Not all kernels support this, which is check with igt_require()
and
so will result in automagic test skipping.