From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-3.8 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, USER_AGENT_GIT autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id EBD87C54E49 for ; Thu, 7 May 2020 18:06:10 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id C570C2063A for ; Thu, 7 May 2020 18:06:10 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=unikie-com.20150623.gappssmtp.com header.i=@unikie-com.20150623.gappssmtp.com header.b="iR2ssMXC" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726367AbgEGSGK (ORCPT ); Thu, 7 May 2020 14:06:10 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54868 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S1728387AbgEGSGJ (ORCPT ); Thu, 7 May 2020 14:06:09 -0400 Received: from mail-lf1-x144.google.com (mail-lf1-x144.google.com [IPv6:2a00:1450:4864:20::144]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5D987C05BD0A for ; Thu, 7 May 2020 11:06:08 -0700 (PDT) Received: by mail-lf1-x144.google.com with SMTP id 188so5255853lfa.10 for ; Thu, 07 May 2020 11:06:08 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=unikie-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id; bh=uPvUkFT01w2TDYWgbcI7ufjq3faBUrMBaYiJbDvssNE=; b=iR2ssMXC/ymlyFfbbDiNpySrdnRo65etLifVTjA1sILNi21+i+/w1pVDIiYP8PDwN0 Y8/5pexTjm9m2vEb10yLbpWNr+dt1DPUFPYhtdJRH3Cpso/Y2fwo6h3dmsyl+5OSG2pj UgjhDs1ea2d/fTmTYWLBQUmENy58rhFSIkJ7EsScFGyNEIerdsUZOMWXi9JPzEW4j/ZZ kn5zVDGxyLwh3TiGCKys3xX2QtgFmyv6+OCEjxDgvYTENyzjXi3P1AtdLJxeYRRvZBSX nvWftHxqhv4aCDQSuMum5SEVavGonpAA1arUvNOtD7HO9pKwL9eWzkZltGzLYtCH0/W6 9yjg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=uPvUkFT01w2TDYWgbcI7ufjq3faBUrMBaYiJbDvssNE=; b=PTzrZZ/Vtl1nf6F3MQFemO/qrdSkVSAuorTd8q4TfchDLnI775JgcMU9QweRb6Fbug KmNV/QXbVOqAPYuSCorYH3v9TLT9E5J/0aJFdHNmL2EQudUyI0ut+BHEELOQ4ogaoPJH vdXef6HTPe8MCHJmAw/u34TdjiT+j3jHBZR95PW7V1PBvTVd3EXcyj+fde9JKABj3ZlC iV0npN6Ve7DtUDHVxgEfyg+YmPPqFdXxmTt0DwVy4/byUsHeu7G1yPAe8ya3jwQ/PldB Q1aLsgtd0pMbF3n1K/Vbnw/6x8hMTN6mvfcnC4Ypjm5eNN8DsGnkjFGwv4fWLs/blc9T Tn8Q== X-Gm-Message-State: AOAM532Za2qmtrSAO+zXa3W9Do1jB6pHKipWpB9eLjSrVgR2CzgTG6il 1ScBg/utqqR/HCTj60uWe/6pz/87IoCg2nMr X-Google-Smtp-Source: ABdhPJzestKpxUSSr1Kh6hfHv2V8zg6qbH1ZR5V8CcoNiTTzU5SJjjMRO8zPDL+5Kctwnesh/bow+Q== X-Received: by 2002:a19:cc07:: with SMTP id c7mr2367026lfg.163.1588874766524; Thu, 07 May 2020 11:06:06 -0700 (PDT) Received: from localhost.localdomain (84-253-205-124.bb.dnainternet.fi. [84.253.205.124]) by smtp.googlemail.com with ESMTPSA id w21sm3715392lji.26.2020.05.07.11.06.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 07 May 2020 11:06:05 -0700 (PDT) From: John Mathew To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, corbet@lwn.net, mingo@redhat.com, peterz@infradead.org, juri.lelli@redhat.com, vincent.guittot@linaro.org, dietmar.eggemann@arm.com, rostedt@goodmis.org, bsegall@google.com, mgorman@suse.de, bristot@redhat.com, tsbogend@alpha.franken.de, lukas.bulwahn@gmail.com, x86@kernel.org, linux-mips@vger.kernel.org, tglx@linutronix.de, mostafa.chamanara@basemark.com, rdunlap@infradead.org, John Mathew Subject: [RFC PATCH v3 0/3] Add scheduler overview documentation Date: Thu, 7 May 2020 21:05:50 +0300 Message-Id: <20200507180553.9993-1-john.mathew@unikie.com> X-Mailer: git-send-email 2.17.1 Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org This patch series updates the scheduler documentation to add more topics wrt to scheduler overview. New sections are added to provide a brief overview of the kernel structs used by the scheduler, scheduler invocation and context switch. The previous version was reviewed at Link: https://lkml.org/lkml/2020/5/6/630 version 3: Fix spelling, spacing and typo errors. version 2: - Remove :c:func: directive as it was redundant - Limit document width (line symbol count) to 75 - Replace dot file with ASCII art - Describe prepare_task_switch(), ASID use, kernel/user transtion, MIPS FPU affinity correctly - Add missing references to files - Removed internal APIs from scheduler API reference - Described rq struct member as kernel-doc comments - Replaced CFS history with CFS current status - Added documentation for sched_class fields - Refined explanation of context swtich functionality - Replace CFS history with recent changes - Added kernel-doc comments for struct rq John Mathew (3): docs: scheduler: Restructure scheduler documentation. docs: scheduler: Add scheduler overview documentation docs: scheduler: Add introduction to scheduler context-switch Documentation/scheduler/arch-specific.rst | 14 + Documentation/scheduler/cfs-overview.rst | 113 ++++++++ Documentation/scheduler/context-switching.rst | 125 ++++++++ Documentation/scheduler/index.rst | 33 ++- .../scheduler/mips-context-switch.rst | 89 ++++++ Documentation/scheduler/overview.rst | 271 ++++++++++++++++++ .../scheduler/sched-data-structs.rst | 253 ++++++++++++++++ Documentation/scheduler/sched-debugging.rst | 14 + Documentation/scheduler/sched-features.rst | 20 ++ Documentation/scheduler/scheduler-api.rst | 31 ++ .../scheduler/x86-context-switch.rst | 65 +++++ kernel/sched/core.c | 28 +- kernel/sched/sched.h | 169 ++++++++++- 13 files changed, 1205 insertions(+), 20 deletions(-) create mode 100644 Documentation/scheduler/arch-specific.rst create mode 100644 Documentation/scheduler/cfs-overview.rst create mode 100644 Documentation/scheduler/context-switching.rst create mode 100644 Documentation/scheduler/mips-context-switch.rst create mode 100644 Documentation/scheduler/overview.rst create mode 100644 Documentation/scheduler/sched-data-structs.rst create mode 100644 Documentation/scheduler/sched-debugging.rst create mode 100644 Documentation/scheduler/sched-features.rst create mode 100644 Documentation/scheduler/scheduler-api.rst create mode 100644 Documentation/scheduler/x86-context-switch.rst -- 2.17.1