/*
|
* Copyright (C) 2011-2017 ARM Limited. All rights reserved.
|
*
|
* This program is free software and is provided to you under the terms of the GNU General Public License version 2
|
* as published by the Free Software Foundation, and any use by you of this program is subject to the terms of such GNU licence.
|
*
|
* A copy of the licence is included with the program, and can also be obtained from Free Software
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
*/
|
|
#ifndef __MALI_GP_JOB_H__
|
#define __MALI_GP_JOB_H__
|
|
#include "mali_osk.h"
|
#include "mali_osk_list.h"
|
#include "mali_uk_types.h"
|
#include "mali_session.h"
|
#include "mali_timeline.h"
|
#include "mali_scheduler_types.h"
|
#include "mali_scheduler.h"
|
#include "mali_executor.h"
|
#include "mali_timeline.h"
|
|
struct mali_defer_mem;
|
/**
|
* This structure represents a GP job
|
*
|
* The GP job object itself is not protected by any single lock,
|
* but relies on other locks instead (scheduler, executor and timeline lock).
|
* Think of the job object as moving between these sub systems through-out
|
* its lifetime. Different part of the GP job struct is used by different
|
* subsystems. Accessor functions ensure that correct lock is taken.
|
* Do NOT access any data members directly from outside this module!
|
*/
|
struct mali_gp_job {
|
/*
|
* These members are typically only set at creation,
|
* and only read later on.
|
* They do not require any lock protection.
|
*/
|
_mali_uk_gp_start_job_s uargs; /**< Arguments from user space */
|
struct mali_session_data *session; /**< Session which submitted this job */
|
u32 pid; /**< Process ID of submitting process */
|
u32 tid; /**< Thread ID of submitting thread */
|
u32 id; /**< Identifier for this job in kernel space (sequential numbering) */
|
u32 cache_order; /**< Cache order used for L2 cache flushing (sequential numbering) */
|
struct mali_timeline_tracker tracker; /**< Timeline tracker for this job */
|
struct mali_timeline_tracker *pp_tracker; /**< Pointer to Timeline tracker for PP job that depends on this job. */
|
_mali_osk_notification_t *finished_notification; /**< Notification sent back to userspace on job complete */
|
|
/*
|
* These members are used by the scheduler,
|
* protected by scheduler lock
|
*/
|
_mali_osk_list_t list; /**< Used to link jobs together in the scheduler queue */
|
|
/*
|
* These members are used by the executor and/or group,
|
* protected by executor lock
|
*/
|
_mali_osk_notification_t *oom_notification; /**< Notification sent back to userspace on OOM */
|
|
/*
|
* Set by executor/group on job completion, read by scheduler when
|
* returning job to user. Hold executor lock when setting,
|
* no lock needed when reading
|
*/
|
u32 heap_current_addr; /**< Holds the current HEAP address when the job has completed */
|
u32 perf_counter_value0; /**< Value of performance counter 0 (to be returned to user space) */
|
u32 perf_counter_value1; /**< Value of performance counter 1 (to be returned to user space) */
|
struct mali_defer_mem *dmem; /** < used for defer bind to store dmem info */
|
struct list_head varying_alloc; /**< hold the list of varying allocations */
|
u32 bind_flag; /** < flag for deferbind*/
|
u32 *varying_list; /**< varying memory list need to to defer bind*/
|
struct list_head vary_todo; /**< list of backend list need to do defer bind*/
|
u32 required_varying_memsize; /** < size of varying memory to reallocate*/
|
u32 big_job; /** < if the gp job have large varying output and may take long time*/
|
};
|
|
#define MALI_DEFER_BIND_MEMORY_PREPARED (0x1 << 0)
|
#define MALI_DEFER_BIND_MEMORY_BINDED (0x1 << 2)
|
|
struct mali_gp_allocation_node {
|
struct list_head node;
|
mali_mem_allocation *alloc;
|
};
|
|
struct mali_gp_job *mali_gp_job_create(struct mali_session_data *session, _mali_uk_gp_start_job_s *uargs, u32 id, struct mali_timeline_tracker *pp_tracker);
|
void mali_gp_job_delete(struct mali_gp_job *job);
|
|
u32 mali_gp_job_get_gp_counter_src0(void);
|
void mali_gp_job_set_gp_counter_src0(u32 counter);
|
u32 mali_gp_job_get_gp_counter_src1(void);
|
void mali_gp_job_set_gp_counter_src1(u32 counter);
|
|
MALI_STATIC_INLINE u32 mali_gp_job_get_id(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return (NULL == job) ? 0 : job->id;
|
}
|
|
MALI_STATIC_INLINE void mali_gp_job_set_cache_order(struct mali_gp_job *job,
|
u32 cache_order)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
MALI_DEBUG_ASSERT_SCHEDULER_LOCK_HELD();
|
job->cache_order = cache_order;
|
}
|
|
MALI_STATIC_INLINE u32 mali_gp_job_get_cache_order(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return (NULL == job) ? 0 : job->cache_order;
|
}
|
|
MALI_STATIC_INLINE u64 mali_gp_job_get_user_id(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return job->uargs.user_job_ptr;
|
}
|
|
MALI_STATIC_INLINE u32 mali_gp_job_get_frame_builder_id(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return job->uargs.frame_builder_id;
|
}
|
|
MALI_STATIC_INLINE u32 mali_gp_job_get_flush_id(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return job->uargs.flush_id;
|
}
|
|
MALI_STATIC_INLINE u32 mali_gp_job_get_pid(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return job->pid;
|
}
|
|
MALI_STATIC_INLINE u32 mali_gp_job_get_tid(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return job->tid;
|
}
|
|
MALI_STATIC_INLINE u32 *mali_gp_job_get_frame_registers(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return job->uargs.frame_registers;
|
}
|
|
MALI_STATIC_INLINE struct mali_session_data *mali_gp_job_get_session(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return job->session;
|
}
|
|
MALI_STATIC_INLINE mali_bool mali_gp_job_has_vs_job(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return (job->uargs.frame_registers[0] != job->uargs.frame_registers[1]) ? MALI_TRUE : MALI_FALSE;
|
}
|
|
MALI_STATIC_INLINE mali_bool mali_gp_job_has_plbu_job(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return (job->uargs.frame_registers[2] != job->uargs.frame_registers[3]) ? MALI_TRUE : MALI_FALSE;
|
}
|
|
MALI_STATIC_INLINE u32 mali_gp_job_get_current_heap_addr(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return job->heap_current_addr;
|
}
|
|
MALI_STATIC_INLINE void mali_gp_job_set_current_heap_addr(struct mali_gp_job *job, u32 heap_addr)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
MALI_DEBUG_ASSERT_EXECUTOR_LOCK_HELD();
|
job->heap_current_addr = heap_addr;
|
}
|
|
MALI_STATIC_INLINE u32 mali_gp_job_get_perf_counter_flag(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return job->uargs.perf_counter_flag;
|
}
|
|
MALI_STATIC_INLINE u32 mali_gp_job_get_perf_counter_src0(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return job->uargs.perf_counter_src0;
|
}
|
|
MALI_STATIC_INLINE u32 mali_gp_job_get_perf_counter_src1(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return job->uargs.perf_counter_src1;
|
}
|
|
MALI_STATIC_INLINE u32 mali_gp_job_get_perf_counter_value0(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return job->perf_counter_value0;
|
}
|
|
MALI_STATIC_INLINE u32 mali_gp_job_get_perf_counter_value1(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return job->perf_counter_value1;
|
}
|
|
MALI_STATIC_INLINE void mali_gp_job_set_perf_counter_src0(struct mali_gp_job *job, u32 src)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
job->uargs.perf_counter_src0 = src;
|
}
|
|
MALI_STATIC_INLINE void mali_gp_job_set_perf_counter_src1(struct mali_gp_job *job, u32 src)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
job->uargs.perf_counter_src1 = src;
|
}
|
|
MALI_STATIC_INLINE void mali_gp_job_set_perf_counter_value0(struct mali_gp_job *job, u32 value)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
MALI_DEBUG_ASSERT_EXECUTOR_LOCK_HELD();
|
job->perf_counter_value0 = value;
|
}
|
|
MALI_STATIC_INLINE void mali_gp_job_set_perf_counter_value1(struct mali_gp_job *job, u32 value)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
MALI_DEBUG_ASSERT_EXECUTOR_LOCK_HELD();
|
job->perf_counter_value1 = value;
|
}
|
|
void mali_gp_job_list_add(struct mali_gp_job *job, _mali_osk_list_t *list);
|
|
MALI_STATIC_INLINE void mali_gp_job_list_move(struct mali_gp_job *job,
|
_mali_osk_list_t *list)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
MALI_DEBUG_ASSERT_SCHEDULER_LOCK_HELD();
|
MALI_DEBUG_ASSERT(!_mali_osk_list_empty(&job->list));
|
_mali_osk_list_move(&job->list, list);
|
}
|
|
MALI_STATIC_INLINE void mali_gp_job_list_remove(struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
MALI_DEBUG_ASSERT_SCHEDULER_LOCK_HELD();
|
_mali_osk_list_delinit(&job->list);
|
}
|
|
MALI_STATIC_INLINE _mali_osk_notification_t *
|
mali_gp_job_get_finished_notification(struct mali_gp_job *job)
|
{
|
_mali_osk_notification_t *notification;
|
|
MALI_DEBUG_ASSERT_POINTER(job);
|
MALI_DEBUG_ASSERT_POINTER(job->finished_notification);
|
|
notification = job->finished_notification;
|
job->finished_notification = NULL;
|
|
return notification;
|
}
|
|
MALI_STATIC_INLINE _mali_osk_notification_t *mali_gp_job_get_oom_notification(
|
struct mali_gp_job *job)
|
{
|
_mali_osk_notification_t *notification;
|
|
MALI_DEBUG_ASSERT_POINTER(job);
|
MALI_DEBUG_ASSERT_EXECUTOR_LOCK_HELD();
|
MALI_DEBUG_ASSERT_POINTER(job->oom_notification);
|
|
notification = job->oom_notification;
|
job->oom_notification = NULL;
|
|
return notification;
|
}
|
|
MALI_STATIC_INLINE void mali_gp_job_set_oom_notification(
|
struct mali_gp_job *job,
|
_mali_osk_notification_t *notification)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
MALI_DEBUG_ASSERT_EXECUTOR_LOCK_HELD();
|
MALI_DEBUG_ASSERT(NULL == job->oom_notification);
|
job->oom_notification = notification;
|
}
|
|
MALI_STATIC_INLINE struct mali_timeline_tracker *mali_gp_job_get_tracker(
|
struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return &(job->tracker);
|
}
|
|
|
MALI_STATIC_INLINE u32 *mali_gp_job_get_timeline_point_ptr(
|
struct mali_gp_job *job)
|
{
|
MALI_DEBUG_ASSERT_POINTER(job);
|
return (u32 __user *)(uintptr_t)job->uargs.timeline_point_ptr;
|
}
|
|
|
/**
|
* Release reference on tracker for PP job that depends on this GP job.
|
*
|
* @note If GP job has a reference on tracker, this function MUST be called before the GP job is
|
* deleted.
|
*
|
* @param job GP job that is done.
|
* @param success MALI_TRUE if job completed successfully, MALI_FALSE if not.
|
* @return A scheduling bitmask indicating whether scheduling needs to be done.
|
*/
|
mali_scheduler_mask mali_gp_job_signal_pp_tracker(struct mali_gp_job *job, mali_bool success);
|
|
#endif /* __MALI_GP_JOB_H__ */
|