/*
|
*
|
* (C) COPYRIGHT 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.
|
*
|
*/
|
|
|
|
|
|
/**
|
* @file mali_kbase_js.h
|
* Job Scheduler Type Definitions
|
*/
|
|
#ifndef _KBASE_JS_DEFS_H_
|
#define _KBASE_JS_DEFS_H_
|
|
/**
|
* @addtogroup base_api
|
* @{
|
*/
|
|
/**
|
* @addtogroup base_kbase_api
|
* @{
|
*/
|
|
/**
|
* @addtogroup kbase_js
|
* @{
|
*/
|
/* Forward decls */
|
struct kbase_device;
|
struct kbase_jd_atom;
|
|
|
typedef u32 kbase_context_flags;
|
|
struct kbasep_atom_req {
|
base_jd_core_req core_req;
|
kbase_context_flags ctx_req;
|
u32 device_nr;
|
};
|
|
/** Callback function run on all of a context's jobs registered with the Job
|
* Scheduler */
|
typedef void (*kbasep_js_ctx_job_cb)(struct kbase_device *kbdev, struct kbase_jd_atom *katom);
|
|
/**
|
* @brief Maximum number of jobs that can be submitted to a job slot whilst
|
* inside the IRQ handler.
|
*
|
* This is important because GPU NULL jobs can complete whilst the IRQ handler
|
* is running. Otherwise, it potentially allows an unlimited number of GPU NULL
|
* jobs to be submitted inside the IRQ handler, which increases IRQ latency.
|
*/
|
#define KBASE_JS_MAX_JOB_SUBMIT_PER_SLOT_PER_IRQ 2
|
|
/**
|
* @brief Context attributes
|
*
|
* Each context attribute can be thought of as a boolean value that caches some
|
* state information about either the runpool, or the context:
|
* - In the case of the runpool, it is a cache of "Do any contexts owned by
|
* the runpool have attribute X?"
|
* - In the case of a context, it is a cache of "Do any atoms owned by the
|
* context have attribute X?"
|
*
|
* The boolean value of the context attributes often affect scheduling
|
* decisions, such as affinities to use and job slots to use.
|
*
|
* To accomodate changes of state in the context, each attribute is refcounted
|
* in the context, and in the runpool for all running contexts. Specifically:
|
* - The runpool holds a refcount of how many contexts in the runpool have this
|
* attribute.
|
* - The context holds a refcount of how many atoms have this attribute.
|
*/
|
enum kbasep_js_ctx_attr {
|
/** Attribute indicating a context that contains Compute jobs. That is,
|
* the context has jobs of type @ref BASE_JD_REQ_ONLY_COMPUTE
|
*
|
* @note A context can be both 'Compute' and 'Non Compute' if it contains
|
* both types of jobs.
|
*/
|
KBASEP_JS_CTX_ATTR_COMPUTE,
|
|
/** Attribute indicating a context that contains Non-Compute jobs. That is,
|
* the context has some jobs that are \b not of type @ref
|
* BASE_JD_REQ_ONLY_COMPUTE.
|
*
|
* @note A context can be both 'Compute' and 'Non Compute' if it contains
|
* both types of jobs.
|
*/
|
KBASEP_JS_CTX_ATTR_NON_COMPUTE,
|
|
/** Attribute indicating that a context contains compute-job atoms that
|
* aren't restricted to a coherent group, and can run on all cores.
|
*
|
* Specifically, this is when the atom's \a core_req satisfy:
|
* - (\a core_req & (BASE_JD_REQ_CS | BASE_JD_REQ_ONLY_COMPUTE | BASE_JD_REQ_T) // uses slot 1 or slot 2
|
* - && !(\a core_req & BASE_JD_REQ_COHERENT_GROUP) // not restricted to coherent groups
|
*
|
* Such atoms could be blocked from running if one of the coherent groups
|
* is being used by another job slot, so tracking this context attribute
|
* allows us to prevent such situations.
|
*
|
* @note This doesn't take into account the 1-coregroup case, where all
|
* compute atoms would effectively be able to run on 'all cores', but
|
* contexts will still not always get marked with this attribute. Instead,
|
* it is the caller's responsibility to take into account the number of
|
* coregroups when interpreting this attribute.
|
*
|
* @note Whilst Tiler atoms are normally combined with
|
* BASE_JD_REQ_COHERENT_GROUP, it is possible to send such atoms without
|
* BASE_JD_REQ_COHERENT_GROUP set. This is an unlikely case, but it's easy
|
* enough to handle anyway.
|
*/
|
KBASEP_JS_CTX_ATTR_COMPUTE_ALL_CORES,
|
|
/** Must be the last in the enum */
|
KBASEP_JS_CTX_ATTR_COUNT
|
};
|
|
enum {
|
/** Bit indicating that new atom should be started because this atom completed */
|
KBASE_JS_ATOM_DONE_START_NEW_ATOMS = (1u << 0),
|
/** Bit indicating that the atom was evicted from the JS_NEXT registers */
|
KBASE_JS_ATOM_DONE_EVICTED_FROM_NEXT = (1u << 1)
|
};
|
|
/** Combination of KBASE_JS_ATOM_DONE_<...> bits */
|
typedef u32 kbasep_js_atom_done_code;
|
|
/**
|
* @brief KBase Device Data Job Scheduler sub-structure
|
*
|
* This encapsulates the current context of the Job Scheduler on a particular
|
* device. This context is global to the device, and is not tied to any
|
* particular struct kbase_context running on the device.
|
*
|
* nr_contexts_running and as_free are optimized for packing together (by making
|
* them smaller types than u32). The operations on them should rarely involve
|
* masking. The use of signed types for arithmetic indicates to the compiler that
|
* the value will not rollover (which would be undefined behavior), and so under
|
* the Total License model, it is free to make optimizations based on that (i.e.
|
* to remove masking).
|
*/
|
struct kbasep_js_device_data {
|
/* Sub-structure to collect together Job Scheduling data used in IRQ
|
* context. The hwaccess_lock must be held when accessing. */
|
struct runpool_irq {
|
/** Bitvector indicating whether a currently scheduled context is allowed to submit jobs.
|
* When bit 'N' is set in this, it indicates whether the context bound to address space
|
* 'N' is allowed to submit jobs.
|
*/
|
u16 submit_allowed;
|
|
/** Context Attributes:
|
* Each is large enough to hold a refcount of the number of contexts
|
* that can fit into the runpool. This is currently BASE_MAX_NR_AS
|
*
|
* Note that when BASE_MAX_NR_AS==16 we need 5 bits (not 4) to store
|
* the refcount. Hence, it's not worthwhile reducing this to
|
* bit-manipulation on u32s to save space (where in contrast, 4 bit
|
* sub-fields would be easy to do and would save space).
|
*
|
* Whilst this must not become negative, the sign bit is used for:
|
* - error detection in debug builds
|
* - Optimization: it is undefined for a signed int to overflow, and so
|
* the compiler can optimize for that never happening (thus, no masking
|
* is required on updating the variable) */
|
s8 ctx_attr_ref_count[KBASEP_JS_CTX_ATTR_COUNT];
|
|
/*
|
* Affinity management and tracking
|
*/
|
/** Bitvector to aid affinity checking. Element 'n' bit 'i' indicates
|
* that slot 'n' is using core i (i.e. slot_affinity_refcount[n][i] > 0) */
|
u64 slot_affinities[BASE_JM_MAX_NR_SLOTS];
|
/** Refcount for each core owned by each slot. Used to generate the
|
* slot_affinities array of bitvectors
|
*
|
* The value of the refcount will not exceed BASE_JM_SUBMIT_SLOTS,
|
* because it is refcounted only when a job is definitely about to be
|
* submitted to a slot, and is de-refcounted immediately after a job
|
* finishes */
|
s8 slot_affinity_refcount[BASE_JM_MAX_NR_SLOTS][64];
|
} runpool_irq;
|
|
/**
|
* Run Pool mutex, for managing contexts within the runpool.
|
* Unless otherwise specified, you must hold this lock whilst accessing any
|
* members that follow
|
*
|
* In addition, this is used to access:
|
* - the kbasep_js_kctx_info::runpool substructure
|
*/
|
struct mutex runpool_mutex;
|
|
/**
|
* Queue Lock, used to access the Policy's queue of contexts independently
|
* of the Run Pool.
|
*
|
* Of course, you don't need the Run Pool lock to access this.
|
*/
|
struct mutex queue_mutex;
|
|
/**
|
* Scheduling semaphore. This must be held when calling
|
* kbase_jm_kick()
|
*/
|
struct semaphore schedule_sem;
|
|
/**
|
* List of contexts that can currently be pulled from
|
*/
|
struct list_head ctx_list_pullable[BASE_JM_MAX_NR_SLOTS];
|
/**
|
* List of contexts that can not currently be pulled from, but have
|
* jobs currently running.
|
*/
|
struct list_head ctx_list_unpullable[BASE_JM_MAX_NR_SLOTS];
|
|
/** Number of currently scheduled user contexts (excluding ones that are not submitting jobs) */
|
s8 nr_user_contexts_running;
|
/** Number of currently scheduled contexts (including ones that are not submitting jobs) */
|
s8 nr_all_contexts_running;
|
|
/** Core Requirements to match up with base_js_atom's core_req memeber
|
* @note This is a write-once member, and so no locking is required to read */
|
base_jd_core_req js_reqs[BASE_JM_MAX_NR_SLOTS];
|
|
u32 scheduling_period_ns; /*< Value for JS_SCHEDULING_PERIOD_NS */
|
u32 soft_stop_ticks; /*< Value for JS_SOFT_STOP_TICKS */
|
u32 soft_stop_ticks_cl; /*< Value for JS_SOFT_STOP_TICKS_CL */
|
u32 hard_stop_ticks_ss; /*< Value for JS_HARD_STOP_TICKS_SS */
|
u32 hard_stop_ticks_cl; /*< Value for JS_HARD_STOP_TICKS_CL */
|
u32 hard_stop_ticks_dumping; /*< Value for JS_HARD_STOP_TICKS_DUMPING */
|
u32 gpu_reset_ticks_ss; /*< Value for JS_RESET_TICKS_SS */
|
u32 gpu_reset_ticks_cl; /*< Value for JS_RESET_TICKS_CL */
|
u32 gpu_reset_ticks_dumping; /*< Value for JS_RESET_TICKS_DUMPING */
|
u32 ctx_timeslice_ns; /**< Value for JS_CTX_TIMESLICE_NS */
|
|
/**< Value for JS_SOFT_JOB_TIMEOUT */
|
atomic_t soft_job_timeout_ms;
|
|
/** List of suspended soft jobs */
|
struct list_head suspended_soft_jobs_list;
|
|
#ifdef CONFIG_MALI_DEBUG
|
/* Support soft-stop on a single context */
|
bool softstop_always;
|
#endif /* CONFIG_MALI_DEBUG */
|
|
/** The initalized-flag is placed at the end, to avoid cache-pollution (we should
|
* only be using this during init/term paths).
|
* @note This is a write-once member, and so no locking is required to read */
|
int init_status;
|
|
/* Number of contexts that can currently be pulled from */
|
u32 nr_contexts_pullable;
|
|
/* Number of contexts that can either be pulled from or are currently
|
* running */
|
atomic_t nr_contexts_runnable;
|
};
|
|
/**
|
* @brief KBase Context Job Scheduling information structure
|
*
|
* This is a substructure in the struct kbase_context that encapsulates all the
|
* scheduling information.
|
*/
|
struct kbasep_js_kctx_info {
|
|
/**
|
* Job Scheduler Context information sub-structure. These members are
|
* accessed regardless of whether the context is:
|
* - In the Policy's Run Pool
|
* - In the Policy's Queue
|
* - Not queued nor in the Run Pool.
|
*
|
* You must obtain the jsctx_mutex before accessing any other members of
|
* this substructure.
|
*
|
* You may not access any of these members from IRQ context.
|
*/
|
struct kbase_jsctx {
|
struct mutex jsctx_mutex; /**< Job Scheduler Context lock */
|
|
/** Number of jobs <b>ready to run</b> - does \em not include the jobs waiting in
|
* the dispatcher, and dependency-only jobs. See kbase_jd_context::job_nr
|
* for such jobs*/
|
u32 nr_jobs;
|
|
/** Context Attributes:
|
* Each is large enough to hold a refcount of the number of atoms on
|
* the context. **/
|
u32 ctx_attr_ref_count[KBASEP_JS_CTX_ATTR_COUNT];
|
|
/**
|
* Wait queue to wait for KCTX_SHEDULED flag state changes.
|
* */
|
wait_queue_head_t is_scheduled_wait;
|
|
/** Link implementing JS queues. Context can be present on one
|
* list per job slot
|
*/
|
struct list_head ctx_list_entry[BASE_JM_MAX_NR_SLOTS];
|
} ctx;
|
|
/* The initalized-flag is placed at the end, to avoid cache-pollution (we should
|
* only be using this during init/term paths) */
|
int init_status;
|
};
|
|
/** Subset of atom state that can be available after jd_done_nolock() is called
|
* on that atom. A copy must be taken via kbasep_js_atom_retained_state_copy(),
|
* because the original atom could disappear. */
|
struct kbasep_js_atom_retained_state {
|
/** Event code - to determine whether the atom has finished */
|
enum base_jd_event_code event_code;
|
/** core requirements */
|
base_jd_core_req core_req;
|
/* priority */
|
int sched_priority;
|
/** Job Slot to retry submitting to if submission from IRQ handler failed */
|
int retry_submit_on_slot;
|
/* Core group atom was executed on */
|
u32 device_nr;
|
|
};
|
|
/**
|
* Value signifying 'no retry on a slot required' for:
|
* - kbase_js_atom_retained_state::retry_submit_on_slot
|
* - kbase_jd_atom::retry_submit_on_slot
|
*/
|
#define KBASEP_JS_RETRY_SUBMIT_SLOT_INVALID (-1)
|
|
/**
|
* base_jd_core_req value signifying 'invalid' for a kbase_jd_atom_retained_state.
|
*
|
* @see kbase_atom_retained_state_is_valid()
|
*/
|
#define KBASEP_JS_ATOM_RETAINED_STATE_CORE_REQ_INVALID BASE_JD_REQ_DEP
|
|
/**
|
* @brief The JS timer resolution, in microseconds
|
*
|
* Any non-zero difference in time will be at least this size.
|
*/
|
#define KBASEP_JS_TICK_RESOLUTION_US 1
|
|
/*
|
* Internal atom priority defines for kbase_jd_atom::sched_prio
|
*/
|
enum {
|
KBASE_JS_ATOM_SCHED_PRIO_HIGH = 0,
|
KBASE_JS_ATOM_SCHED_PRIO_MED,
|
KBASE_JS_ATOM_SCHED_PRIO_LOW,
|
KBASE_JS_ATOM_SCHED_PRIO_COUNT,
|
};
|
|
/* Invalid priority for kbase_jd_atom::sched_prio */
|
#define KBASE_JS_ATOM_SCHED_PRIO_INVALID -1
|
|
/* Default priority in the case of contexts with no atoms, or being lenient
|
* about invalid priorities from userspace */
|
#define KBASE_JS_ATOM_SCHED_PRIO_DEFAULT KBASE_JS_ATOM_SCHED_PRIO_MED
|
|
/** @} *//* end group kbase_js */
|
/** @} *//* end group base_kbase_api */
|
/** @} *//* end group base_api */
|
|
#endif /* _KBASE_JS_DEFS_H_ */
|
