fast_copy_dword0 ()

uint32_t
fast_copy_dword0 (unsigned int src_tiling,
                  unsigned int dst_tiling);

fast_copy_dword1 ()

uint32_t
fast_copy_dword1 (int fd,
                  unsigned int src_tiling,
                  unsigned int dst_tiling,
                  int bpp);

igt_blitter_copy ()

void
igt_blitter_copy (int fd,
                  uint64_t ahnd,
                  uint32_t ctx,
                  const intel_ctx_cfg_t *cfg,
                  uint32_t src_handle,
                  uint32_t src_delta,
                  uint32_t src_stride,
                  uint32_t src_tiling,
                  uint32_t src_x,
                  uint32_t src_y,
                  uint64_t src_size,
                  uint32_t width,
                  uint32_t height,
                  uint32_t bpp,
                  uint32_t dst_handle,
                  uint32_t dst_delta,
                  uint32_t dst_stride,
                  uint32_t dst_tiling,
                  uint32_t dst_x,
                  uint32_t dst_y,
                  uint64_t dst_size);

Wrapper API to call appropriate blitter copy function.

igt_blitter_src_copy ()

void
igt_blitter_src_copy (int fd,
                      uint64_t ahnd,
                      uint32_t ctx,
                      const intel_ctx_cfg_t *cfg,
                      uint32_t src_handle,
                      uint32_t src_delta,
                      uint32_t src_stride,
                      uint32_t src_tiling,
                      uint32_t src_x,
                      uint32_t src_y,
                      uint64_t src_size,
                      uint32_t width,
                      uint32_t height,
                      uint32_t bpp,
                      uint32_t dst_handle,
                      uint32_t dst_delta,
                      uint32_t dst_stride,
                      uint32_t dst_tiling,
                      uint32_t dst_x,
                      uint32_t dst_y,
                      uint64_t dst_size);

Copy src into dst using the XY_SRC blit command.

igt_blitter_fast_copy__raw ()

void
igt_blitter_fast_copy__raw (int fd,
                            uint64_t ahnd,
                            uint32_t ctx,
                            const intel_ctx_cfg_t *cfg,
                            uint32_t src_handle,
                            unsigned int src_delta,
                            unsigned int src_stride,
                            unsigned int src_tiling,
                            unsigned int src_x,
                            unsigned  src_y,
                            uint64_t src_size,
                            unsigned int width,
                            unsigned int height,
                            int bpp,
                            uint32_t dst_handle,
                            unsigned int dst_delta,
                            unsigned int dst_stride,
                            unsigned int dst_tiling,
                            unsigned int dst_x,
                            unsigned  dst_y,
                            uint64_t dst_size);

Like igt_blitter_fast_copy(), but talking to the kernel directly.

igt_render_copyfunc_t ()

void
(*igt_render_copyfunc_t) (struct intel_bb *ibb,
                          struct intel_buf *src,
                          uint32_t src_x,
                          uint32_t src_y,
                          uint32_t width,
                          uint32_t height,
                          struct intel_buf *dst,
                          uint32_t dst_x,
                          uint32_t dst_y);

This is the type of the per-platform render copy functions. The platform-specific implementation can be obtained by calling igt_get_render_copyfunc().

A render copy function will emit a batchbuffer to the kernel which executes the specified blit copy operation using the render engine. ctx is optional and can be 0.

igt_get_render_copyfunc ()

igt_render_copyfunc_t
igt_get_render_copyfunc (int devid);

igt_vebox_copyfunc_t ()

void
(*igt_vebox_copyfunc_t) (struct intel_bb *ibb,
                         struct intel_buf *src,
                         unsigned int width,
                         unsigned int height,
                         struct intel_buf *dst);

This is the type of the per-platform vebox copy functions. The platform-specific implementation can be obtained by calling igt_get_vebox_copyfunc().

A vebox copy function will emit a batchbuffer to the kernel which executes the specified blit copy operation using the vebox engine.

igt_get_vebox_copyfunc ()

igt_vebox_copyfunc_t
igt_get_vebox_copyfunc (int devid);

igt_render_clearfunc_t ()

void
(*igt_render_clearfunc_t) (struct intel_bb *ibb,
                           struct intel_buf *dst,
                           unsigned int dst_x,
                           unsigned int dst_y,
                           unsigned int width,
                           unsigned int height,
                           const float cc_color[4]);

igt_get_render_clearfunc ()

igt_render_clearfunc_t
igt_get_render_clearfunc (int devid);

igt_fillfunc_t ()

void
(*igt_fillfunc_t) (int i915,
                   struct intel_buf *buf,
                   unsigned  x,
                   unsigned  y,
                   unsigned  width,
                   unsigned  height,
                   uint8_t color);

This is the type of the per-platform fill functions using media or gpgpu pipeline. The platform-specific implementation can be obtained by calling igt_get_media_fillfunc() or igt_get_gpgpu_fillfunc().

A fill function will emit a batchbuffer to the kernel which executes the specified blit fill operation using the media/gpgpu engine.

igt_get_gpgpu_fillfunc ()

igt_fillfunc_t
igt_get_gpgpu_fillfunc (int devid);

igt_get_media_fillfunc ()

igt_fillfunc_t
igt_get_media_fillfunc (int devid);

igt_vme_func_t ()

void
(*igt_vme_func_t) (int i915,
                   uint32_t ctx,
                   struct intel_buf *src,
                   unsigned int width,
                   unsigned int height,
                   struct intel_buf *dst);

igt_get_media_vme_func ()

igt_vme_func_t
igt_get_media_vme_func (int devid);

igt_media_spinfunc_t ()

void
(*igt_media_spinfunc_t) (int i915,
                         struct intel_buf *buf,
                         uint32_t spins);

This is the type of the per-platform media spin functions. The platform-specific implementation can be obtained by calling igt_get_media_spinfunc().

The media spin function emits a batchbuffer for the render engine with the media pipeline selected. The workload consists of a single thread which spins in a tight loop the requested number of times. Each spin increments a counter whose final 32-bit value is written to the destination buffer on completion. This utility provides a simple way to keep the render engine busy for a set time for various tests.

igt_get_media_spinfunc ()

igt_media_spinfunc_t
igt_get_media_spinfunc (int devid);

intel_bb_create_full ()

struct intel_bb *
intel_bb_create_full (int fd,
                      uint32_t ctx,
                      uint32_t vm,
                      const intel_ctx_cfg_t *cfg,
                      uint32_t size,
                      uint64_t start,
                      uint64_t end,
                      uint64_t alignment,
                      uint8_t allocator_type,
                      enum allocator_strategy strategy,
                      uint64_t region);

Creates bb with context passed in ctx , size in size and allocator type in allocator_type , in memory region passed in region . Relocations are set to false because IGT allocator is used in that case. VM range is passed to allocator (start and end ) and allocation strategy (suggestion to allocator about address allocation preferences).

intel_bb_create_with_allocator ()

struct intel_bb *
intel_bb_create_with_allocator (int fd,
                                uint32_t ctx,
                                uint32_t vm,
                                const intel_ctx_cfg_t *cfg,
                                uint32_t size,
                                uint8_t allocator_type);

Creates bb with context passed in ctx , size in size and allocator type in allocator_type . Relocations are set to false because IGT allocator is used in that case.

intel_bb_create ()

struct intel_bb *
intel_bb_create (int fd,
                 uint32_t size);

Creates bb with default context.

intel_bb_create_with_context ()

struct intel_bb *
intel_bb_create_with_context (int fd,
                              uint32_t ctx,
                              uint32_t vm,
                              const intel_ctx_cfg_t *cfg,
                              uint32_t size);

Creates bb with context passed in ctx and cfg configuration (when working with custom engines layout).

intel_bb_create_with_context_in_region ()

struct intel_bb *
intel_bb_create_with_context_in_region
                               (int fd,
                                uint32_t ctx,
                                uint32_t vm,
                                const intel_ctx_cfg_t *cfg,
                                uint32_t size,
                                uint64_t region);

Creates bb with context passed in ctx in memory region passed in memory .

intel_bb_create_with_relocs ()

struct intel_bb *
intel_bb_create_with_relocs (int fd,
                             uint32_t size);

Creates bb which will disable passing addresses. This will lead to relocations when objects are not previously pinned.

intel_bb_create_with_relocs_and_context ()

struct intel_bb *
intel_bb_create_with_relocs_and_context
                               (int fd,
                                uint32_t ctx,
                                const intel_ctx_cfg_t *cfg,
                                uint32_t size);

Creates bb with default context which will disable passing addresses. This will lead to relocations when objects are not previously pinned.

intel_bb_create_no_relocs ()

struct intel_bb *
intel_bb_create_no_relocs (int fd,
                           uint32_t size);

Creates bb with disabled relocations. This enables passing addresses and requires pinning objects.

intel_bb_destroy ()

void
intel_bb_destroy (struct intel_bb *ibb);

Frees all relocations / objects allocated during filling the batch.

intel_bb_reinit_allocator ()

void
intel_bb_reinit_allocator (void);

Reinit allocator and get offsets in tracked intel_batchbuffers.

intel_bb_track ()

void
intel_bb_track (bool do_tracking);

Turn on (true) or off (false) tracking for intel_batchbuffers.

intel_bb_reset ()

void
intel_bb_reset (struct intel_bb *ibb,
                bool purge_objects_cache);

intel_bb_sync ()

int
intel_bb_sync (struct intel_bb *ibb);

intel_bb_print ()

void
intel_bb_print (struct intel_bb *ibb);

intel_bb_dump ()

void
intel_bb_dump (struct intel_bb *ibb,
               const char *filename,
               bool in_hex);

intel_bb_set_debug ()

void
intel_bb_set_debug (struct intel_bb *ibb,
                    bool debug);

Sets debug to true / false. Execbuf is then called synchronously and object/reloc arrays are printed after execution.

intel_bb_set_dump_base64 ()

void
intel_bb_set_dump_base64 (struct intel_bb *ibb,
                          bool dump);

Do bb dump as base64 string before execbuf call.

intel_bb_set_pxp ()

void
intel_bb_set_pxp (struct intel_bb *ibb,
                  bool new_state,
                  uint32_t apptype,
                  uint32_t appid);

intel_bb_add_object ()

struct drm_i915_gem_exec_object2 *
intel_bb_add_object (struct intel_bb *ibb,
                     uint32_t handle,
                     uint64_t size,
                     uint64_t offset,
                     uint64_t alignment,
                     bool write);

intel_bb_remove_object ()

bool
intel_bb_remove_object (struct intel_bb *ibb,
                        uint32_t handle,
                        uint64_t offset,
                        uint64_t size);

intel_bb_add_intel_buf ()

struct drm_i915_gem_exec_object2 *
intel_bb_add_intel_buf (struct intel_bb *ibb,
                        struct intel_buf *buf,
                        bool write);

intel_bb_add_intel_buf_with_alignment ()

struct drm_i915_gem_exec_object2 *
intel_bb_add_intel_buf_with_alignment (struct intel_bb *ibb,
                                       struct intel_buf *buf,
                                       uint64_t alignment,
                                       bool write);

intel_bb_remove_intel_buf ()

bool
intel_bb_remove_intel_buf (struct intel_bb *ibb,
                           struct intel_buf *buf);

intel_bb_print_intel_bufs ()

void
intel_bb_print_intel_bufs (struct intel_bb *ibb);

intel_bb_find_object ()

struct drm_i915_gem_exec_object2 *
intel_bb_find_object (struct intel_bb *ibb,
                      uint32_t handle);

intel_bb_object_set_flag ()

bool
intel_bb_object_set_flag (struct intel_bb *ibb,
                          uint32_t handle,
                          uint64_t flag);

intel_bb_object_clear_flag ()

bool
intel_bb_object_clear_flag (struct intel_bb *ibb,
                            uint32_t handle,
                            uint64_t flag);

intel_bb_emit_reloc ()

uint64_t
intel_bb_emit_reloc (struct intel_bb *ibb,
                     uint32_t handle,
                     uint32_t read_domains,
                     uint32_t write_domain,
                     uint64_t delta,
                     uint64_t presumed_offset);

Function prepares relocation (execobj if required + reloc) and emits offset in bb. For I915_EXEC_NO_RELOC presumed_offset is a hint we already have object in valid place and relocation step can be skipped in this case.

Note: delta is value added to address, mostly used when some instructions require modify-bit set to apply change. Which delta is valid depends on instruction (see instruction specification).

intel_bb_emit_reloc_fenced ()

uint64_t
intel_bb_emit_reloc_fenced (struct intel_bb *ibb,
                            uint32_t handle,
                            uint32_t read_domains,
                            uint32_t write_domain,
                            uint64_t delta,
                            uint64_t presumed_offset);

intel_bb_offset_reloc ()

uint64_t
intel_bb_offset_reloc (struct intel_bb *ibb,
                       uint32_t handle,
                       uint32_t read_domains,
                       uint32_t write_domain,
                       uint32_t offset,
                       uint64_t presumed_offset);

Function prepares relocation (execobj if required + reloc). It it used for editing batchbuffer via modifying structures. It means when we're preparing batchbuffer it is more descriptive to edit the structure than emitting dwords. But it require for some fields to point the relocation. For that case offset is passed by the user and it points to the offset in bb where the relocation will be applied.

intel_bb_offset_reloc_with_delta ()

uint64_t
intel_bb_offset_reloc_with_delta (struct intel_bb *ibb,
                                  uint32_t handle,
                                  uint32_t read_domains,
                                  uint32_t write_domain,
                                  uint32_t delta,
                                  uint32_t offset,
                                  uint64_t presumed_offset);

intel_bb_offset_reloc_to_object ()

uint64_t
intel_bb_offset_reloc_to_object (struct intel_bb *ibb,
                                 uint32_t handle,
                                 uint32_t to_handle,
                                 uint32_t read_domains,
                                 uint32_t write_domain,
                                 uint32_t delta,
                                 uint32_t offset,
                                 uint64_t presumed_offset);

intel_bb_dump_cache ()

void
intel_bb_dump_cache (struct intel_bb *ibb);

intel_bb_exec ()

void
intel_bb_exec (struct intel_bb *ibb,
               uint32_t end_offset,
               uint64_t flags,
               bool sync);

Do execbuf on context selected during bb creation. Asserts on failure.

intel_bb_get_object_offset ()

uint64_t
intel_bb_get_object_offset (struct intel_bb *ibb,
                            uint32_t handle);

intel_bb_object_offset_to_buf ()

bool
intel_bb_object_offset_to_buf (struct intel_bb *ibb,
                               struct intel_buf *buf);

intel_bb_emit_bbe ()

uint32_t
intel_bb_emit_bbe (struct intel_bb *ibb);

intel_bb_emit_flush_common ()

uint32_t
intel_bb_emit_flush_common (struct intel_bb *ibb);

intel_bb_flush ()

void
intel_bb_flush (struct intel_bb *ibb,
                uint32_t ring);

intel_bb_flush_render ()

void
intel_bb_flush_render (struct intel_bb *ibb);

intel_bb_flush_blit ()

void
intel_bb_flush_blit (struct intel_bb *ibb);

intel_bb_copy_data ()

uint32_t
intel_bb_copy_data (struct intel_bb *ibb,
                    const void *data,
                    unsigned int bytes,
                    uint32_t align);

intel_bb_blit_start ()

void
intel_bb_blit_start (struct intel_bb *ibb,
                     uint32_t flags);

intel_bb_emit_blt_copy ()

void
intel_bb_emit_blt_copy (struct intel_bb *ibb,
                        struct intel_buf *src,
                        int src_x1,
                        int src_y1,
                        int src_pitch,
                        struct intel_buf *dst,
                        int dst_x1,
                        int dst_y1,
                        int dst_pitch,
                        int width,
                        int height,
                        int bpp);

intel_bb_blt_copy ()

void
intel_bb_blt_copy (struct intel_bb *ibb,
                   struct intel_buf *src,
                   int src_x1,
                   int src_y1,
                   int src_pitch,
                   struct intel_buf *dst,
                   int dst_x1,
                   int dst_y1,
                   int dst_pitch,
                   int width,
                   int height,
                   int bpp);

intel_bb_copy_intel_buf ()

void
intel_bb_copy_intel_buf (struct intel_bb *ibb,
                         struct intel_buf *dst,
                         struct intel_buf *src,
                         long int size);

Emits a copy operation using blitter commands into the supplied batch. A total of size bytes from the start of src is copied over to dst . Note that size must be page-aligned.

igt_huc_copyfunc_t ()

void
(*igt_huc_copyfunc_t) (int fd,
                       uint64_t ahnd,
                       struct drm_i915_gem_exec_object2 *obj,
                       uint64_t *objsize);

This is the type of the per-platform huc copy functions.

The huc copy function emits a batchbuffer to the VDBOX engine to invoke the HuC Copy kernel to copy 4K bytes from the source buffer to the destination buffer.

igt_get_huc_copyfunc ()

igt_huc_copyfunc_t
igt_get_huc_copyfunc (int devid);

BATCH_SZ

#define BATCH_SZ 4096

I915_TILING_4

#define I915_TILING_4 (I915_TILING_LAST + 1)

I915_TILING_Yf

#define I915_TILING_Yf (I915_TILING_LAST + 2)

I915_TILING_Ys

#define I915_TILING_Ys (I915_TILING_LAST + 3)

I915_TILING_64

#define I915_TILING_64 (I915_TILING_LAST + 4)

enum i915_compression

struct igt_pxp

struct igt_pxp {
	bool     enabled;
	uint32_t apptype;
	uint32_t appid;
};

struct intel_bb

struct intel_bb {
	struct igt_list_head link;

	uint64_t allocator_handle;
	uint64_t allocator_start, allocator_end;
	uint8_t allocator_type;
	enum allocator_strategy allocator_strategy;

	enum intel_driver driver;
	int fd;
	unsigned int gen;
	bool debug;
	bool dump_base64;
	bool enforce_relocs;
	uint32_t devid;
	uint32_t handle;
	uint32_t size;
	uint32_t *batch;
	uint32_t *ptr;
	uint64_t alignment;
	int fence;

	uint64_t gtt_size;
	bool supports_48b_address;
	bool uses_full_ppgtt;
	bool allows_obj_alignment;

	struct igt_pxp pxp;
	uint32_t ctx;
	uint32_t vm_id;

	bool xe_bound;
	uint32_t engine_syncobj;
	uint32_t engine_id;
	uint32_t last_engine;

	/* Context configuration */
	intel_ctx_cfg_t *cfg;

	/* Cache */
	void *root;

	/* Current objects for execbuf */
	void *current;

	/* Objects for current execbuf */
	struct drm_i915_gem_exec_object2 **objects;
	uint32_t num_objects;
	uint32_t allocated_objects;
	uint64_t batch_offset;

	struct drm_i915_gem_relocation_entry *relocs;
	uint32_t num_relocs;
	uint32_t allocated_relocs;

	/* Tracked intel_bufs */
	struct igt_list_head intel_bufs;

	/*
	 * BO recreate in reset path only when refcount == 0
	 * Currently we don't need to use atomics because intel_bb
	 * is not thread-safe.
	 */
	int32_t refcount;

	/* long running mode */
	bool lr_mode;
	int64_t user_fence_offset;
	uint64_t user_fence_value;
};

previous_offset

	uint32_t previous_offset = intel_bb_offset(ibb);

struct intel_buf

struct intel_buf {
	struct buf_ops *bops;

	bool is_owner;
	uint32_t handle;
	uint64_t size;
	uint32_t width;
	uint32_t height;
	uint32_t tiling;
	uint32_t bpp, depth;
	uint32_t compression;
	uint32_t swizzle_mode;
	uint32_t yuv_semiplanar_bpp;
	bool format_is_yuv;
	bool format_is_yuv_semiplanar;
	struct {
		uint32_t offset;
		uint32_t stride;
		uint64_t size;
	} surface[2];
	struct {
		uint32_t offset;
		uint32_t stride;
	} ccs[2];
	struct {
		uint32_t offset;
		bool disable;
	} cc;
	struct {
		uint64_t offset;
		uint32_t ctx;
	} addr;

	uint64_t bo_size;
	uint64_t region;

	/* Tracking */
	struct intel_bb *ibb;
	struct igt_list_head link;

	/* CPU mapping */
	uint32_t *ptr;
	bool cpu_write;

	/* Content Protection*/
	bool is_protected;

	/* pat_index to use for mapping this buf. Only used in Xe. */
	uint8_t pat_index;

	/* mocs_index to use for operations using this intel_buf, like render_copy  */
	uint8_t mocs_index;

	/* For debugging purposes */
	char name[INTEL_BUF_NAME_MAXSIZE + 1];
};