Top | ![]() |
![]() |
![]() |
![]() |
int | igt_debugfs_open () |
FILE * | igt_debugfs_fopen () |
bool | igt_debugfs_search () |
#define | igt_debugfs_read() |
void | igt_assert_crc_equal () |
char * | igt_crc_to_string () |
void | igt_require_pipe_crc () |
igt_pipe_crc_t * | igt_pipe_crc_new () |
igt_pipe_crc_t * | igt_pipe_crc_new_nonblock () |
void | igt_pipe_crc_free () |
void | igt_pipe_crc_start () |
void | igt_pipe_crc_stop () |
int | igt_pipe_crc_get_crcs () |
void | igt_pipe_crc_collect_crc () |
bool | igt_crc_equal () |
void | igt_drop_caches_set () |
void | igt_disable_prefault () |
void | igt_enable_prefault () |
int | igt_get_stable_obj_count () |
typedef | igt_pipe_crc_t |
igt_crc_t | |
enum | intel_pipe_crc_source |
#define | DROP_UNBOUND |
#define | DROP_BOUND |
#define | DROP_RETIRE |
#define | DROP_ACTIVE |
#define | DROP_ALL |
This library provides helpers to access debugfs features. On top of some
basic functions to access debugfs files with e.g. igt_debugfs_open()
it also
provides higher-level wrappers for some debugfs features
This library wraps up the kernel's support for capturing pipe CRCs into a neat and tidy package. For the detailed usage see all the functions which work on igt_pipe_crc_t. This is supported on all platforms and outputs.
Actually using pipe CRCs to write modeset tests is a bit tricky though, so there is no way to directly check a CRC: Both the details of the plane blending, color correction and other hardware and how exactly the CRC is computed at each tap point vary by hardware generation and are not disclosed.
The only way to use igt_crc_t CRCs therefore is to compare CRCs among each
another either for equality or difference. Otherwise CRCs must be treated as
completely opaque values. Note that not even CRCs from different pipes or tap
points on the same platform can be compared. Hence only use
igt_assert_crc_equal()
to inspect CRC values captured by the same
igt_pipe_crc_t object.
This covers the miscellaneous debugfs interface wrappers:
drm/i915 supports interfaces to evict certain classes of gem buffer
objects, see igt_drop_caches_set()
.
drm/i915 supports an interface to disable prefaulting, useful to test
slow paths in ioctls. See igt_disable_prefault()
.
int igt_debugfs_open (const char *filename
,int mode
);
This opens a debugfs file as a Unix file descriptor. The filename should be relative to the drm device's root, i.e. without "drm/<minor>".
FILE * igt_debugfs_fopen (const char *filename
,const char *mode
);
This opens a debugfs file as a libc FILE. The filename should be relative to the drm device's root, i.e. without "drm/<minor>".
bool igt_debugfs_search (const char *filename
,const char *substring
);
Searches each line in filename
for the substring specified in substring
.
#define igt_debugfs_read(filename, buf)
This is just a convenience wrapper for __igt_debugfs_read. See its documentation.
void igt_assert_crc_equal (igt_crc_t *a
,igt_crc_t *b
);
Compares two CRC values and fails the testcase if they don't match with
igt_fail()
. Note that due to CRC collisions CRC based testcase can only
assert that CRCs match, never that they are different. Otherwise there might
be random testcase failures when different screen contents end up with the
same CRC by chance.
char *
igt_crc_to_string (igt_crc_t *crc
);
This formats crc
into a string buffer which is owned by igt_crc_to_string()
.
The next call will override the buffer again, which makes this multithreading
unsafe.
This should only ever be used for diagnostic debug output.
void
igt_require_pipe_crc (void
);
Convenience helper to check whether pipe CRC capturing is supported by the kernel. Uses igt_skip to automatically skip the test/subtest if this isn't the case.
igt_pipe_crc_t * igt_pipe_crc_new (enum pipe pipe
,enum intel_pipe_crc_source source
);
This sets up a new pipe CRC capture object for the given pipe
and source
in blocking mode.
igt_pipe_crc_t * igt_pipe_crc_new_nonblock (enum pipe pipe
,enum intel_pipe_crc_source source
);
This sets up a new pipe CRC capture object for the given pipe
and source
in nonblocking mode.
void
igt_pipe_crc_free (igt_pipe_crc_t *pipe_crc
);
Frees all resources associated with pipe_crc
.
void
igt_pipe_crc_start (igt_pipe_crc_t *pipe_crc
);
Starts the CRC capture process on pipe_crc
.
void
igt_pipe_crc_stop (igt_pipe_crc_t *pipe_crc
);
Stops the CRC capture process on pipe_crc
.
int igt_pipe_crc_get_crcs (igt_pipe_crc_t *pipe_crc
,int n_crcs
,igt_crc_t **out_crcs
);
Read up to n_crcs
from pipe_crc
. This function does not block, and will
return early if not enough CRCs can be captured, if pipe_crc
has been
opened using igt_pipe_crc_new_nonblock()
. It will block until n_crcs
are
retrieved if pipe_crc
has been opened using igt_pipe_crc_new()
. out_crcs
is
alloced by this function and must be released with free()
by the caller.
Callers must start and stop the capturing themselves by calling
igt_pipe_crc_start()
and igt_pipe_crc_stop()
. For one-shot CRC collecting
look at igt_pipe_crc_collect_crc()
.
void igt_pipe_crc_collect_crc (igt_pipe_crc_t *pipe_crc
,igt_crc_t *out_crc
);
Read a single CRC from pipe_crc
. This function blocks until the CRC is
retrieved, irrespective of whether pipe_crc
has been opened with
igt_pipe_crc_new()
or igt_pipe_crc_new_nonblock()
. out_crc
must be
allocated by the caller.
This function takes care of the pipe_crc book-keeping, it will start/stop the collection of the CRC.
This function also calls the interactive debug with the "crc" domain, so you can make use of this feature to actually see the screen that is being CRC'd.
For continuous CRC collection look at igt_pipe_crc_start()
,
igt_pipe_crc_get_crcs()
and igt_pipe_crc_stop()
.
void
igt_drop_caches_set (uint64_t val
);
This calls the debugfs interface the drm/i915 GEM driver exposes to drop or evict certain classes of gem buffer objects.
void
igt_disable_prefault (void
);
Disable prefaulting in certain gem ioctls through the debugfs interface. As usual this installs an exit handler to clean up and re-enable prefaulting even when the test exited abnormally.
igt_enable_prefault() will enable normale operation again.
void
igt_enable_prefault (void
);
Enable prefault (again) through the debugfs interface.
typedef struct _igt_pipe_crc igt_pipe_crc_t;
Pipe CRC support structure. Needs to be allocated and set up with
igt_pipe_crc_new()
for a specific pipe and pipe CRC source value.
typedef struct { uint32_t frame; int n_words; uint32_t crc[5]; } igt_crc_t;
Pipe CRC value. All other members than frame
are private and should not be
inspected by testcases.
Enumeration of all supported pipe CRC sources. Not all platforms and all outputs support all of them. Generic tests should just use INTEL_PIPE_CRC_SOURCE_AUTO. It should always map to an end-of-pipe CRC suitable for checking planes, cursor, color correction and any other output-agnostic features.
#define DROP_BOUND 0x2
Drop all inactive objects which are bound into some gpu address space.
#define DROP_RETIRE 0x4
Wait for all outstanding gpu commands to complete, but do not take any further actions.