arch/x86/kernel/cpu/intel_rdt.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _ASM_X86_INTEL_RDT_H
   3 #define _ASM_X86_INTEL_RDT_H
   4
   5 #include <linux/sched.h>
   6 #include <linux/kernfs.h>
   7 #include <linux/jump_label.h>
   8
   9 #define IA32_L3_QOS_CFG         0xc81
  10 #define IA32_L2_QOS_CFG         0xc82
  11 #define IA32_L3_CBM_BASE        0xc90
  12 #define IA32_L2_CBM_BASE        0xd10
  13 #define IA32_MBA_THRTL_BASE     0xd50
  14
  15 #define L3_QOS_CDP_ENABLE       0x01ULL
  16
  17 #define L2_QOS_CDP_ENABLE       0x01ULL
  18
  19 /*
  20  * Event IDs are used to program IA32_QM_EVTSEL before reading event
  21  * counter from IA32_QM_CTR
  22  */
  23 #define QOS_L3_OCCUP_EVENT_ID           0x01
  24 #define QOS_L3_MBM_TOTAL_EVENT_ID       0x02
  25 #define QOS_L3_MBM_LOCAL_EVENT_ID       0x03
  26
  27 #define CQM_LIMBOCHECK_INTERVAL 1000
  28
  29 #define MBM_CNTR_WIDTH                  24
  30 #define MBM_OVERFLOW_INTERVAL           1000
  31
  32 #define RMID_VAL_ERROR                  BIT_ULL(63)
  33 #define RMID_VAL_UNAVAIL                BIT_ULL(62)
  34
  35 DECLARE_STATIC_KEY_FALSE(rdt_enable_key);
  36
  37 /**
  38  * struct mon_evt - Entry in the event list of a resource
  39  * @evtid:              event id
  40  * @name:               name of the event
  41  */
  42 struct mon_evt {
  43         u32                     evtid;
  44         char                    *name;
  45         struct list_head        list;
  46 };
  47
  48 /**
  49  * struct mon_data_bits - Monitoring details for each event file
  50  * @rid:               Resource id associated with the event file.
  51  * @evtid:             Event id associated with the event file
  52  * @domid:             The domain to which the event file belongs
  53  */
  54 union mon_data_bits {
  55         void *priv;
  56         struct {
  57                 unsigned int rid        : 10;
  58                 unsigned int evtid      : 8;
  59                 unsigned int domid      : 14;
  60         } u;
  61 };
  62
  63 struct rmid_read {
  64         struct rdtgroup         *rgrp;
  65         struct rdt_domain       *d;
  66         int                     evtid;
  67         bool                    first;
  68         u64                     val;
  69 };
  70
  71 extern unsigned int intel_cqm_threshold;
  72 extern bool rdt_alloc_capable;
  73 extern bool rdt_mon_capable;
  74 extern unsigned int rdt_mon_features;
  75
  76 enum rdt_group_type {
  77         RDTCTRL_GROUP = 0,
  78         RDTMON_GROUP,
  79         RDT_NUM_GROUP,
  80 };
  81
  82 /**
  83  * struct mongroup - store mon group's data in resctrl fs.
  84  * @mon_data_kn         kernlfs node for the mon_data directory
  85  * @parent:                     parent rdtgrp
  86  * @crdtgrp_list:               child rdtgroup node list
  87  * @rmid:                       rmid for this rdtgroup
  88  */
  89 struct mongroup {
  90         struct kernfs_node      *mon_data_kn;
  91         struct rdtgroup         *parent;
  92         struct list_head        crdtgrp_list;
  93         u32                     rmid;
  94 };
  95
  96 /**
  97  * struct rdtgroup - store rdtgroup's data in resctrl file system.
  98  * @kn:                         kernfs node
  99  * @rdtgroup_list:              linked list for all rdtgroups
 100  * @closid:                     closid for this rdtgroup
 101  * @cpu_mask:                   CPUs assigned to this rdtgroup
 102  * @flags:                      status bits
 103  * @waitcount:                  how many cpus expect to find this
 104  *                              group when they acquire rdtgroup_mutex
 105  * @type:                       indicates type of this rdtgroup - either
 106  *                              monitor only or ctrl_mon group
 107  * @mon:                        mongroup related data
 108  */
 109 struct rdtgroup {
 110         struct kernfs_node      *kn;
 111         struct list_head        rdtgroup_list;
 112         u32                     closid;
 113         struct cpumask          cpu_mask;
 114         int                     flags;
 115         atomic_t                waitcount;
 116         enum rdt_group_type     type;
 117         struct mongroup         mon;
 118 };
 119
 120 /* rdtgroup.flags */
 121 #define RDT_DELETED             1
 122
 123 /* rftype.flags */
 124 #define RFTYPE_FLAGS_CPUS_LIST  1
 125
 126 /*
 127  * Define the file type flags for base and info directories.
 128  */
 129 #define RFTYPE_INFO                     BIT(0)
 130 #define RFTYPE_BASE                     BIT(1)
 131 #define RF_CTRLSHIFT                    4
 132 #define RF_MONSHIFT                     5
 133 #define RF_TOPSHIFT                     6
 134 #define RFTYPE_CTRL                     BIT(RF_CTRLSHIFT)
 135 #define RFTYPE_MON                      BIT(RF_MONSHIFT)
 136 #define RFTYPE_TOP                      BIT(RF_TOPSHIFT)
 137 #define RFTYPE_RES_CACHE                BIT(8)
 138 #define RFTYPE_RES_MB                   BIT(9)
 139 #define RF_CTRL_INFO                    (RFTYPE_INFO | RFTYPE_CTRL)
 140 #define RF_MON_INFO                     (RFTYPE_INFO | RFTYPE_MON)
 141 #define RF_TOP_INFO                     (RFTYPE_INFO | RFTYPE_TOP)
 142 #define RF_CTRL_BASE                    (RFTYPE_BASE | RFTYPE_CTRL)
 143
 144 /* List of all resource groups */
 145 extern struct list_head rdt_all_groups;
 146
 147 extern int max_name_width, max_data_width;
 148
 149 int __init rdtgroup_init(void);
 150
 151 /**
 152  * struct rftype - describe each file in the resctrl file system
 153  * @name:       File name
 154  * @mode:       Access mode
 155  * @kf_ops:     File operations
 156  * @flags:      File specific RFTYPE_FLAGS_* flags
 157  * @fflags:     File specific RF_* or RFTYPE_* flags
 158  * @seq_show:   Show content of the file
 159  * @write:      Write to the file
 160  */
 161 struct rftype {
 162         char                    *name;
 163         umode_t                 mode;
 164         struct kernfs_ops       *kf_ops;
 165         unsigned long           flags;
 166         unsigned long           fflags;
 167
 168         int (*seq_show)(struct kernfs_open_file *of,
 169                         struct seq_file *sf, void *v);
 170         /*
 171          * write() is the generic write callback which maps directly to
 172          * kernfs write operation and overrides all other operations.
 173          * Maximum write size is determined by ->max_write_len.
 174          */
 175         ssize_t (*write)(struct kernfs_open_file *of,
 176                          char *buf, size_t nbytes, loff_t off);
 177 };
 178
 179 /**
 180  * struct mbm_state - status for each MBM counter in each domain
 181  * @chunks:     Total data moved (multiply by rdt_group.mon_scale to get bytes)
 182  * @prev_msr    Value of IA32_QM_CTR for this RMID last time we read it
 183  */
 184 struct mbm_state {
 185         u64     chunks;
 186         u64     prev_msr;
 187 };
 188
 189 /**
 190  * struct rdt_domain - group of cpus sharing an RDT resource
 191  * @list:       all instances of this resource
 192  * @id:         unique id for this instance
 193  * @cpu_mask:   which cpus share this resource
 194  * @rmid_busy_llc:
 195  *              bitmap of which limbo RMIDs are above threshold
 196  * @mbm_total:  saved state for MBM total bandwidth
 197  * @mbm_local:  saved state for MBM local bandwidth
 198  * @mbm_over:   worker to periodically read MBM h/w counters
 199  * @cqm_limbo:  worker to periodically read CQM h/w counters
 200  * @mbm_work_cpu:
 201  *              worker cpu for MBM h/w counters
 202  * @cqm_work_cpu:
 203  *              worker cpu for CQM h/w counters
 204  * @ctrl_val:   array of cache or mem ctrl values (indexed by CLOSID)
 205  * @mbps_val:   When mba_sc is enabled, this holds the bandwidth in MBps
 206  * @new_ctrl:   new ctrl value to be loaded
 207  * @have_new_ctrl: did user provide new_ctrl for this domain
 208  */
 209 struct rdt_domain {
 210         struct list_head        list;
 211         int                     id;
 212         struct cpumask          cpu_mask;
 213         unsigned long           *rmid_busy_llc;
 214         struct mbm_state        *mbm_total;
 215         struct mbm_state        *mbm_local;
 216         struct delayed_work     mbm_over;
 217         struct delayed_work     cqm_limbo;
 218         int                     mbm_work_cpu;
 219         int                     cqm_work_cpu;
 220         u32                     *ctrl_val;
 221         u32                     *mbps_val;
 222         u32                     new_ctrl;
 223         bool                    have_new_ctrl;
 224 };
 225
 226 /**
 227  * struct msr_param - set a range of MSRs from a domain
 228  * @res:       The resource to use
 229  * @low:       Beginning index from base MSR
 230  * @high:      End index
 231  */
 232 struct msr_param {
 233         struct rdt_resource     *res;
 234         int                     low;
 235         int                     high;
 236 };
 237
 238 /**
 239  * struct rdt_cache - Cache allocation related data
 240  * @cbm_len:            Length of the cache bit mask
 241  * @min_cbm_bits:       Minimum number of consecutive bits to be set
 242  * @cbm_idx_mult:       Multiplier of CBM index
 243  * @cbm_idx_offset:     Offset of CBM index. CBM index is computed by:
 244  *                      closid * cbm_idx_multi + cbm_idx_offset
 245  *                      in a cache bit mask
 246  * @shareable_bits:     Bitmask of shareable resource with other
 247  *                      executing entities
 248  */
 249 struct rdt_cache {
 250         unsigned int    cbm_len;
 251         unsigned int    min_cbm_bits;
 252         unsigned int    cbm_idx_mult;
 253         unsigned int    cbm_idx_offset;
 254         unsigned int    shareable_bits;
 255 };
 256
 257 /**
 258  * struct rdt_membw - Memory bandwidth allocation related data
 259  * @max_delay:          Max throttle delay. Delay is the hardware
 260  *                      representation for memory bandwidth.
 261  * @min_bw:             Minimum memory bandwidth percentage user can request
 262  * @bw_gran:            Granularity at which the memory bandwidth is allocated
 263  * @delay_linear:       True if memory B/W delay is in linear scale
 264  * @mba_sc:             True if MBA software controller(mba_sc) is enabled
 265  * @mb_map:             Mapping of memory B/W percentage to memory B/W delay
 266  */
 267 struct rdt_membw {
 268         u32             max_delay;
 269         u32             min_bw;
 270         u32             bw_gran;
 271         u32             delay_linear;
 272         bool            mba_sc;
 273         u32             *mb_map;
 274 };
 275
 276 static inline bool is_llc_occupancy_enabled(void)
 277 {
 278         return (rdt_mon_features & (1 << QOS_L3_OCCUP_EVENT_ID));
 279 }
 280
 281 static inline bool is_mbm_total_enabled(void)
 282 {
 283         return (rdt_mon_features & (1 << QOS_L3_MBM_TOTAL_EVENT_ID));
 284 }
 285
 286 static inline bool is_mbm_local_enabled(void)
 287 {
 288         return (rdt_mon_features & (1 << QOS_L3_MBM_LOCAL_EVENT_ID));
 289 }
 290
 291 static inline bool is_mbm_enabled(void)
 292 {
 293         return (is_mbm_total_enabled() || is_mbm_local_enabled());
 294 }
 295
 296 static inline bool is_mbm_event(int e)
 297 {
 298         return (e >= QOS_L3_MBM_TOTAL_EVENT_ID &&
 299                 e <= QOS_L3_MBM_LOCAL_EVENT_ID);
 300 }
 301
 302 /**
 303  * struct rdt_resource - attributes of an RDT resource
 304  * @rid:                The index of the resource
 305  * @alloc_enabled:      Is allocation enabled on this machine
 306  * @mon_enabled:                Is monitoring enabled for this feature
 307  * @alloc_capable:      Is allocation available on this machine
 308  * @mon_capable:                Is monitor feature available on this machine
 309  * @name:               Name to use in "schemata" file
 310  * @num_closid:         Number of CLOSIDs available
 311  * @cache_level:        Which cache level defines scope of this resource
 312  * @default_ctrl:       Specifies default cache cbm or memory B/W percent.
 313  * @msr_base:           Base MSR address for CBMs
 314  * @msr_update:         Function pointer to update QOS MSRs
 315  * @data_width:         Character width of data when displaying
 316  * @domains:            All domains for this resource
 317  * @cache:              Cache allocation related data
 318  * @format_str:         Per resource format string to show domain value
 319  * @parse_ctrlval:      Per resource function pointer to parse control values
 320  * @evt_list:                   List of monitoring events
 321  * @num_rmid:                   Number of RMIDs available
 322  * @mon_scale:                  cqm counter * mon_scale = occupancy in bytes
 323  * @fflags:                     flags to choose base and info files
 324  */
 325 struct rdt_resource {
 326         int                     rid;
 327         bool                    alloc_enabled;
 328         bool                    mon_enabled;
 329         bool                    alloc_capable;
 330         bool                    mon_capable;
 331         char                    *name;
 332         int                     num_closid;
 333         int                     cache_level;
 334         u32                     default_ctrl;
 335         unsigned int            msr_base;
 336         void (*msr_update)      (struct rdt_domain *d, struct msr_param *m,
 337                                  struct rdt_resource *r);
 338         int                     data_width;
 339         struct list_head        domains;
 340         struct rdt_cache        cache;
 341         struct rdt_membw        membw;
 342         const char              *format_str;
 343         int (*parse_ctrlval)    (char *buf, struct rdt_resource *r,
 344                                  struct rdt_domain *d);
 345         struct list_head        evt_list;
 346         int                     num_rmid;
 347         unsigned int            mon_scale;
 348         unsigned long           fflags;
 349 };
 350
 351 int parse_cbm(char *buf, struct rdt_resource *r, struct rdt_domain *d);
 352 int parse_bw(char *buf, struct rdt_resource *r,  struct rdt_domain *d);
 353
 354 extern struct mutex rdtgroup_mutex;
 355
 356 extern struct rdt_resource rdt_resources_all[];
 357 extern struct rdtgroup rdtgroup_default;
 358 DECLARE_STATIC_KEY_FALSE(rdt_alloc_enable_key);
 359
 360 int __init rdtgroup_init(void);
 361
 362 enum {
 363         RDT_RESOURCE_L3,
 364         RDT_RESOURCE_L3DATA,
 365         RDT_RESOURCE_L3CODE,
 366         RDT_RESOURCE_L2,
 367         RDT_RESOURCE_L2DATA,
 368         RDT_RESOURCE_L2CODE,
 369         RDT_RESOURCE_MBA,
 370
 371         /* Must be the last */
 372         RDT_NUM_RESOURCES,
 373 };
 374
 375 #define for_each_capable_rdt_resource(r)                                      \
 376         for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
 377              r++)                                                             \
 378                 if (r->alloc_capable || r->mon_capable)
 379
 380 #define for_each_alloc_capable_rdt_resource(r)                                \
 381         for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
 382              r++)                                                             \
 383                 if (r->alloc_capable)
 384
 385 #define for_each_mon_capable_rdt_resource(r)                                  \
 386         for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
 387              r++)                                                             \
 388                 if (r->mon_capable)
 389
 390 #define for_each_alloc_enabled_rdt_resource(r)                                \
 391         for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
 392              r++)                                                             \
 393                 if (r->alloc_enabled)
 394
 395 #define for_each_mon_enabled_rdt_resource(r)                                  \
 396         for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
 397              r++)                                                             \
 398                 if (r->mon_enabled)
 399
 400 /* CPUID.(EAX=10H, ECX=ResID=1).EAX */
 401 union cpuid_0x10_1_eax {
 402         struct {
 403                 unsigned int cbm_len:5;
 404         } split;
 405         unsigned int full;
 406 };
 407
 408 /* CPUID.(EAX=10H, ECX=ResID=3).EAX */
 409 union cpuid_0x10_3_eax {
 410         struct {
 411                 unsigned int max_delay:12;
 412         } split;
 413         unsigned int full;
 414 };
 415
 416 /* CPUID.(EAX=10H, ECX=ResID).EDX */
 417 union cpuid_0x10_x_edx {
 418         struct {
 419                 unsigned int cos_max:16;
 420         } split;
 421         unsigned int full;
 422 };
 423
 424 void rdt_last_cmd_clear(void);
 425 void rdt_last_cmd_puts(const char *s);
 426 void rdt_last_cmd_printf(const char *fmt, ...);
 427
 428 void rdt_ctrl_update(void *arg);
 429 struct rdtgroup *rdtgroup_kn_lock_live(struct kernfs_node *kn);
 430 void rdtgroup_kn_unlock(struct kernfs_node *kn);
 431 struct rdt_domain *rdt_find_domain(struct rdt_resource *r, int id,
 432                                    struct list_head **pos);
 433 ssize_t rdtgroup_schemata_write(struct kernfs_open_file *of,
 434                                 char *buf, size_t nbytes, loff_t off);
 435 int rdtgroup_schemata_show(struct kernfs_open_file *of,
 436                            struct seq_file *s, void *v);
 437 struct rdt_domain *get_domain_from_cpu(int cpu, struct rdt_resource *r);
 438 int alloc_rmid(void);
 439 void free_rmid(u32 rmid);
 440 int rdt_get_mon_l3_config(struct rdt_resource *r);
 441 void mon_event_count(void *info);
 442 int rdtgroup_mondata_show(struct seq_file *m, void *arg);
 443 void rmdir_mondata_subdir_allrdtgrp(struct rdt_resource *r,
 444                                     unsigned int dom_id);
 445 void mkdir_mondata_subdir_allrdtgrp(struct rdt_resource *r,
 446                                     struct rdt_domain *d);
 447 void mon_event_read(struct rmid_read *rr, struct rdt_domain *d,
 448                     struct rdtgroup *rdtgrp, int evtid, int first);
 449 void mbm_setup_overflow_handler(struct rdt_domain *dom,
 450                                 unsigned long delay_ms);
 451 void mbm_handle_overflow(struct work_struct *work);
 452 bool is_mba_sc(struct rdt_resource *r);
 453 void setup_default_ctrlval(struct rdt_resource *r, u32 *dc, u32 *dm);
 454 void cqm_setup_limbo_handler(struct rdt_domain *dom, unsigned long delay_ms);
 455 void cqm_handle_limbo(struct work_struct *work);
 456 bool has_busy_rmid(struct rdt_resource *r, struct rdt_domain *d);
 457 void __check_limbo(struct rdt_domain *d, bool force_free);
 458
 459 #endif /* _ASM_X86_INTEL_RDT_H */