manual/util-linux/original/man1/uclampset.1

   1 '\" t
   2 .\"     Title: uclampset
   3 .\"    Author: [see the "AUTHOR(S)" section]
   4 .\" Generator: Asciidoctor 2.0.15
   5 .\"      Date: 2022-02-17
   6 .\"    Manual: User Commands
   7 .\"    Source: util-linux 2.38
   8 .\"  Language: English
   9 .\"
  10 .TH "UCLAMPSET" "1" "2022-02-17" "util\-linux 2.38" "User Commands"
  11 .ie \n(.g .ds Aq \(aq
  12 .el       .ds Aq '
  13 .ss \n[.ss] 0
  14 .nh
  15 .ad l
  16 .de URL
  17 \fI\\$2\fP <\\$1>\\$3
  18 ..
  19 .als MTO URL
  20 .if \n[.g] \{\
  21 .  mso www.tmac
  22 .  am URL
  23 .    ad l
  24 .  .
  25 .  am MTO
  26 .    ad l
  27 .  .
  28 .  LINKSTYLE blue R < >
  29 .\}
  30 .SH "NAME"
  31 uclampset \- manipulate the utilization clamping attributes of the system or a process
  32 .SH "SYNOPSIS"
  33 .sp
  34 \fBuclampset\fP [options] [\fB\-m\fP \fIuclamp_min\fP] [\fB\-M\fP \fIuclamp_max] _command argument\fP
  35 .sp
  36 \fBuclampset\fP [options] [\fB\-m\fP \fIuclamp_min\fP] [\fB\-M\fP \fIuclamp_max\fP] \fB\-p\fP \fIPID\fP
  37 .SH "DESCRIPTION"
  38 .sp
  39 \fBuclampset\fP sets or retrieves the utilization clamping attributes of an existing \fIPID\fP, or runs \fIcommand\fP with the given attributes.
  40 .sp
  41 Utilization clamping is a new feature added in v5.3. It gives a hint to the scheduler about the allowed range of utilization the task should be operating at.
  42 .sp
  43 The utilization of the task affects frequency selection and task placement. Only schedutil cpufreq governor understands handling util clamp hints at the time of writing. Consult your kernel docs for further info about other cpufreq governors support.
  44 .sp
  45 If you\(cqre running on asymmetric heterogeneous system like Arm\(cqs big.LITTLE. Utilization clamping can help bias task placement. If the task is boosted such that \fIutil_min\fP value is higher than the little cores\(aq capacity, then the scheduler will do its best to place it on a big core.
  46 .sp
  47 Similarly, if \fIutil_max\fP is smaller than or equal the capacity of the little cores, then the scheduler can still choose to place it there even if the actual utilization of the task is at max.
  48 .sp
  49 Setting a task\(cqs \fIuclamp_min\fP to a none zero value will effectively boost the task as when it runs it\(cqll always start from this utilization value.
  50 .sp
  51 By setting a task\(cqs \fIuclamp_max\fP below 1024, this will effectively cap the task as when it runs it\(cqll never be able to go above this utilization value.
  52 .sp
  53 The full utilization range is: [0:1024]. The special value \-1 is used to reset to system\(cqs default.
  54 .SH "OPTIONS"
  55 .sp
  56 \fB\-m\fP
  57 .RS 4
  58 Set \fIutil_min\fP value.
  59 .RE
  60 .sp
  61 \fB\-M\fP
  62 .RS 4
  63 Set \fIutil_max\fP value.
  64 .RE
  65 .sp
  66 \fB\-a\fP, \fB\-\-all\-tasks\fP
  67 .RS 4
  68 Set or retrieve the utilization clamping attributes of all the tasks (threads) for a given PID.
  69 .RE
  70 .sp
  71 \fB\-p\fP, \fB\-\-pid\fP
  72 .RS 4
  73 Operate on an existing PID and do not launch a new task.
  74 .RE
  75 .sp
  76 \fB\-s\fP, \fB\-\-system\fP
  77 .RS 4
  78 Set or retrieve the system\-wide utilization clamping attributes.
  79 .RE
  80 .sp
  81 \fB\-R\fP, \fB\-\-reset\-on\-fork\fP
  82 .RS 4
  83 Set \fBSCHED_FLAG_RESET_ON_FORK\fP flag.
  84 .RE
  85 .sp
  86 \fB\-v\fP, \fB\-\-verbose\fP
  87 .RS 4
  88 Show status information.
  89 .RE
  90 .sp
  91 \fB\-h\fP, \fB\-\-help\fP
  92 .RS 4
  93 Display help text and exit.
  94 .RE
  95 .sp
  96 \fB\-V\fP, \fB\-\-version\fP
  97 .RS 4
  98 Print version and exit.
  99 .RE
 100 .SH "USAGE"
 101 .sp
 102 The default behavior is to run a new command:
 103 .RS 4
 104 \fBuclampset\fP \fI[\-m uclamp_min]\fP \fI[\-M uclamp_max]\fP \fIcommand\fP [\fIarguments\fP]
 105 .RE
 106 .sp
 107 You can also retrieve the utilization clamping attributes of an existing task:
 108 .RS 4
 109 \fBuclampset \-p\fP \fIPID\fP
 110 .RE
 111 .sp
 112 Or set them:
 113 .RS 4
 114 \fBuclampset \-p\fP \fIPID\fP \fI[\-m uclamp_min]\fP \fI[\-M uclamp_max]\fP
 115 .RE
 116 .sp
 117 Or control the system\-wide attributes:
 118 .RS 4
 119 \fBuclampset \-s\fP \fI[\-m uclamp_min]\fP \fI[\-M uclamp_max]\fP
 120 .RE
 121 .SH "PERMISSIONS"
 122 .sp
 123 A user must possess \fBCAP_SYS_NICE\fP to change the scheduling attributes of a process. Any user can retrieve the scheduling information.
 124 .SH "NOTES"
 125 .sp
 126 The system wide utilization clamp attributes are there to control the \fIallowed\fP range the tasks can use. By default both \fIuclamp_min\fP and \fIuclamp_max\fP are set to 1024. This means users can set the utilization clamp values for their task across the full range [0:1024].
 127 .sp
 128 For example:
 129 .RS 4
 130 \fBuclampset \-s\fP \f(CR\-m 512\fP \f(CR\-M 700\fP
 131 .RE
 132 .sp
 133 will prevent any task from being boosted higher than 512. And all tasks in the systems are capped to a utilization of 700. Effectively rendering the maximum performance of the system to 700.
 134 .sp
 135 Consult your kernel docs for the exact expected behavior on that kernel.
 136 .SH "AUTHORS"
 137 .sp
 138 .MTO "qais.yousef\(atarm.com" "Qais Yousef" ""
 139 .SH "SEE ALSO"
 140 .sp
 141 \fBnice\fP(1),
 142 \fBrenice\fP(1),
 143 \fBtaskset\fP(1),
 144 \fBsched\fP(7)
 145 .sp
 146 See \fBsched_setscheduler\fP(2) and \fBsched_setattr\fP(2) for a description of the Linux scheduling scheme.
 147 .SH "REPORTING BUGS"
 148 .sp
 149 For bug reports, use the issue tracker at \c
 150 .URL "https://github.com/util\-linux/util\-linux/issues" "" "."
 151 .SH "AVAILABILITY"
 152 .sp
 153 The \fBuclampset\fP command is part of the util\-linux package which can be downloaded from \c
 154 .URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."