sched: minor revisions, typo and indent

ftrace: trace options, and how to use func_stack_trace option.

Signed-off-by: Leon <[email protected]>

Author: freelancer-leon

kernel/sched/sched_rt.md

@@ -863,7 +863,7 @@ static inline u64 sched_avg_period(void)
 * `sched_rt_runtime_exceeded()`返回值为 **1** 时，`update_curr_rt()`会设置重新调度标志，表示需要限流。
 * `sched_rt_runtime_exceeded()`返回值为 **0** 时，实时任务至少不会因为 RT Throttling 的原因被抢占（当然，还有其他别的原因而被抢占）。
 * `rt_rq->rt_queued` 作为实时调度队列的标志位，大于 0 时表示未被限流。
-* 被限流的是调度实体是进程是比较简单，只是简单地关闭 `rt_rq->rt_queued = 0`，不会改变进程状态。
+* 被限流的是调度实体是进程时比较简单，只是简单地关闭 `rt_rq->rt_queued = 0`，不会改变进程状态。
 * 被限流的调度实体是调度组的情况比较复杂。调度实体会被移出所属调度组的实时调度队列，但也不会处于任何一个睡眠队列，因为它并不是真正睡眠，而且它也不是一个进程。
   * 实时调度队列 `rt_rq->rt_queued = 0`
   * 等到限流被放开时，它会被放回实时调度队列

kernel/sched/sched_rt_load_balance.md

@@ -873,8 +873,8 @@ static void pull_rt_task(struct rq *this_rq)
 			 */
 			/*有一个 p 的优先级比它在的 CPU 上正在运行的任务的优先级高的机会。这就是 p 正好被唤醒
 			  但还没有来得及被调度到。我们只在 p 的优先级比它当前运行队列上正在运行的任务优先级低的
-				时候去拉。
-				因为马上有机会被调度的进程没必要拉，所以这里 skip 该进程*/
+			  时候去拉。
+			  因为马上有机会被调度的进程没必要拉，所以这里 skip 该进程*/
 			if (p->prio < src_rq->curr->prio)
 				goto skip;
 			/*否则，开始下面的迁移操作*/

kernel/trace/ftrace.md

@@ -482,7 +482,8 @@ cpus=8
 * [KernelShark](http://rostedt.homelinux.com/kernelshark/)
 * [Using KernelShark to analyze the real-time scheduler](https://lwn.net/Articles/425583/)
 
-## trace_options
+## 跟踪选项
+### trace_options
 * `/sys/kernel/debug/tracing/trace_options`文件
 	```
 	# cat /sys/kernel/debug/tracing/trace_options
@@ -515,6 +516,72 @@ cpus=8
 	notest_nop_accept
 	notest_nop_refuse
 	```
+* 通过修改`/sys/kernel/debug/tracing/options`下的文件可以使能这些`trace_options`
+
+#### latency-format
+* 该选项会改变 trace 输出。使能的时候，trace 会显示关于延迟的额外的信息
+	```
+	# tracer: irqsoff
+	#
+	# irqsoff latency trace v1.1.5 on 3.8.0-test+
+	# --------------------------------------------------------------------
+	# latency: 259 us, #4/4, CPU#2 | (M:preempt VP:0, KP:0, SP:0 HP:0 #P:4)
+	#    -----------------
+	#    | task: ps-6143 (uid:0 nice:0 policy:0 rt_prio:0)
+	#    -----------------
+	#  => started at: __lock_task_sighand
+	#  => ended at:   _raw_spin_unlock_irqrestore
+	#
+	#
+	#                  _------=> CPU#            
+	#                 / _-----=> irqs-off        
+	#                | / _----=> need-resched    
+	#                || / _---=> hardirq/softirq
+	#                ||| / _--=> preempt-depth   
+	#                |||| /     delay             
+	#  cmd     pid   ||||| time  |   caller      
+	#     \   /      |||||  \    |   /           
+	      ps-6143    2d...    0us!: trace_hardirqs_off <-__lock_task_sighand
+	      ps-6143    2d..1  259us+: trace_hardirqs_on <-_raw_spin_unlock_irqrestore
+	      ps-6143    2d..1  263us+: time_hardirqs_on <-_raw_spin_unlock_irqrestore
+	      ps-6143    2d..1  306us : <stack trace>
+	 => trace_hardirqs_on_caller
+	 => trace_hardirqs_on
+	 => _raw_spin_unlock_irqrestore
+	 => do_task_stat
+	 => proc_tgid_stat
+	 => proc_single_show
+	 => seq_read
+	 => vfs_read
+	 => sys_read
+	 => system_call_fastpath
+	```
+#### stacktrace
+* 当设置该 option 时，任何 **trace event** 的栈跟踪将会被记录下来
+
+### function tracer option
+#### func_stack_trace
+* 如果说设置`function_graph tracer`+`set_graph_function`可以跟踪到一个函数往下的调用路径，那么`function tracer`+`set_ftrace_filter`+`func_stack_trace`则可以跟踪到它往上的调用路径
+* 需使能`CONFIG_STACKTRACE`内核选项
+* 只有当`current_tracer`设置为 **function tracer** 时才会出现
+* 当设置该 option 时，每个函数被记录的时候，它的栈跟踪也会被记录
+* **NOTE:** 在使能该选项时，务必同时设置`set_ftrace_filter`，否则系统性能会严重下降。并且在清除过滤函数的时候记得关闭该选项。
+* Example:
+	```
+	$ echo rtc_timer_enqueue > /sys/kernel/debug/tracing/set_ftrace_filter
+	$ echo function > /sys/kernel/debug/tracing/current_tracer
+	$ echo 1 > /sys/kernel/debug/tracing/options/func_stack_trace
+	$ echo 1 > /sys/kernel/debug/tracing/tracing_on
+	$ cat /sys/kernel/debug/tracing/trace_pipe
+	rtc_test.2029-2902  [001] ....  7694.641987: rtc_timer_enqueue <-rtc_update_irq_enable
+	rtc_test.2029-2902  [001] ....  7694.642015: <stack trace>
+	=> rtc_timer_enqueue
+	=> rtc_update_irq_enable
+	=> rtc_dev_ioctl
+	=> do_vfs_ioctl
+	=> SyS_ioctl
+	=> system_call_fastpath
+	```
 
 # Reference