From nobody Sun Jun 7 02:10:37 2026 Received: from mail-pg1-f179.google.com (mail-pg1-f179.google.com [209.85.215.179]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 32E953DBD41 for ; Fri, 10 Apr 2026 22:13:07 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.179 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1775859188; cv=none; b=VHG+dLsrkdn0YSIJ7GcBgupk2ZWlpGhrJpQ5uMuCLlI8eZVze9hHuJm1fjT2ga/EQZ1siSlORiaJ7JjGUmf9665VoMq5W7wRorSG3krz+ChaL3QYE0nuT/K7Ia/E+2JNSJEZX2nxchKf0WRRY+2sIsftdc4JiwOVaM3bUASkjXY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1775859188; c=relaxed/simple; bh=QaN/2PunQ1R3wJZyKqY2gbgYlHT6Ws9qlntemVaF0iM=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=bHVc64Goq+TERDqkJ0uaOBgKPbYENfdKJ3bFmfIDbTQTQq27+e7Fm9cml0UQwaOuZQ/KwUhIVph4hiRPLavdzPFomtbZqnCS5ZRwIleYBZRTeffapZgRgFd3rIyxnIHcq7MlLZkE+1U0tJTG92YrVpcVDMCLA9mZC01qfob4igA= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=nH/J/hwS; arc=none smtp.client-ip=209.85.215.179 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="nH/J/hwS" Received: by mail-pg1-f179.google.com with SMTP id 41be03b00d2f7-c76b9efc299so1127929a12.0 for ; Fri, 10 Apr 2026 15:13:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1775859186; x=1776463986; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=ReVkam/qzqCEjrr/EAV6/YLmHzvOoDol2op4AuX2BSQ=; b=nH/J/hwS+KC0ItR9h/h0Bm0imy1ozDb5CEAmDHTY7nT6D28dBiV6WRgON+3hTbj+9g WRiXRwRSAB8TRIwwV3YSgRKKSd/Ktu8003fMJCUU1pwsJ9QJjI1QNG4G/VgVhokPQN0e /Wt3MASE1GKttcf9uW9PWyNPKvkSKaW+d7Nq97tqHiM6JbAe+VHURzNqV62AgHmx5klV beMnuMIU07D1ayPks2D9EC5wFmBTSbOIggclkXWrb6wtmEm8ZRS8JSVVrJ/IUopn11PL avtf6HydTF8yFV3ZxSt2LregX6EM21wNyc4gFXDd3g169lASiE48rErbT3QwPgf8RXIZ aRwQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1775859186; x=1776463986; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=ReVkam/qzqCEjrr/EAV6/YLmHzvOoDol2op4AuX2BSQ=; b=TaTSgkHzSX6OjN+E35dEXy1mM+BPqJRnZMqs/Ng3mS7ZkPqY+KAYfAF3q1Hl6m8T6x /Kn6ABDPRnuEWH/DiZtJuqmRxn7LEau5GEAE+ZEx53vkA+GkqSKzd8cJagu0o98+J+8R LaDDHrFG7EfdKZQPvTl+LszqrGJvFed2fkfaGbYL+6sp6VOqxJ2ruDFmTHlJ9Q0qHkP6 Tk2jZJCwxVO4wgS68K1H7rHR0INH0yNYLfq0GTZkEffvx8zXsGHJg5foFXZgBb+ka2X1 VhOXmK5RjPqVgLAPEdvAcRIvdRZRvT/7ScQ9SCI/dbMJzcktztm/dS2z2COk21a9TrhS fmJw== X-Forwarded-Encrypted: i=1; AJvYcCXGIpFoxG4pu7qtcnW/L4LlmNY0rVQYUoD0NZ7pBNgUFpJYs6Jf812CSq6dYwL6FiECnQfNPGlqQGKU1O8=@vger.kernel.org X-Gm-Message-State: AOJu0YwqehZUifgcTCeUF7v7Kuga0wIVQQw8GfUZpMXmg+OY2jJb2KVY t4YdE8pVDf3OPG4lAvRYSCO7OHL1w5CAmfbGUllUlwIMsV06a4UeatYq X-Gm-Gg: AeBDievCX1jJKMNgsUdv0gnHYS5Skxi3MCW1zJeIrXPgCgw3mRbArIfKcywbPFMUN72 Z3vS3cTcFa6dLO5TdhIxQz2iXtkJepj0urkXmFdAc+YIcLm4GSFGjTdowfZI90VrklIPJ2Bl2+p TLu6HFIhnZ1sRwpvQ/UYiUClqkWjej9upgsh1ahLBgEqsXGCkheSUtMLGUMM3asECSVEO+MeC8b 2zd/fQb4TCuwNLy3bVitfT5/vnoHHXzDeL+NUuKwOSL8E9Zy6qfu9fl9pVT4gjRINQjKfo0YjlE yKTuhqUkdxvGRbnOpwHzr03AePNXu/hUvalGZo25tiLaQqSIYHS7hd/w7j4E8uLj0E6Q47J0LbQ sHOUUz+HJKuy5KVIDr5SYhtwUNVOCyiIgOv/5TckDwwTDuyYULdYvenaB+zWhlck9giE10VxwoO 0/TZ32r2oF6bs8ipjnTTDEkFPA4lf4IM4Kmzz/pgRotbp93E0/VY2It7jn05orDjGzl8LO9eV7V 2AsGh3XVKeJnPphbHFAdA/U8p/S7HAv6008UD5P X-Received: by 2002:a05:6a20:4312:b0:398:b619:b624 with SMTP id adf61e73a8af0-39fe3f1d752mr5445939637.29.1775859186488; Fri, 10 Apr 2026 15:13:06 -0700 (PDT) Received: from lord-daniel-VivoBook-ASUSLaptop-K3502ZA-S3502ZA.. ([2405:201:31:d01f:a107:5c92:b303:910a]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-c79216ff41dsm3142863a12.2.2026.04.10.15.13.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 10 Apr 2026 15:13:06 -0700 (PDT) From: Piyush Patle To: Nathan Chancellor , Nicolas Schier , Jonathan Corbet , linux-kbuild@vger.kernel.org, linux-doc@vger.kernel.org Cc: Shuah Khan , Mark Rutland , Chen Pei , Randy Dunlap , Arnd Bergmann , Masahiro Yamada , linux-kernel@vger.kernel.org Subject: [PATCH] kbuild: document generation of offset header files Date: Sat, 11 Apr 2026 03:42:54 +0530 Message-ID: <20260410221257.191517-1-piyushpatle228@gmail.com> X-Mailer: git-send-email 2.43.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Replace the placeholder reference with a description of how Kbuild generates offset header files such as include/generated/asm-offsets.h. Remove the corresponding TODO entry now that this is documented. Signed-off-by: Piyush Patle Reviewed-by: Nicolas Schier --- Documentation/kbuild/makefiles.rst | 41 ++++++++++++++++++++++++------ 1 file changed, 33 insertions(+), 8 deletions(-) diff --git a/Documentation/kbuild/makefiles.rst b/Documentation/kbuild/make= files.rst index 24a4708d26e8..7521cae7d56f 100644 --- a/Documentation/kbuild/makefiles.rst +++ b/Documentation/kbuild/makefiles.rst @@ -1285,8 +1285,39 @@ Example:: In this example, the file target maketools will be processed before descending down in the subdirectories. =20 -See also chapter XXX-TODO that describes how kbuild supports -generating offset header files. +Generating offset header files +------------------------------ + +The ``include/generated/asm-offsets.h`` header exposes C structure +member offsets and other compile-time constants to assembly code. It +is generated from ``arch/$(SRCARCH)/kernel/asm-offsets.c``. + +The source file uses ``DEFINE()``, ``OFFSET()``, ``BLANK()`` and +``COMMENT()`` from ````. These emit marker strings +through inline asm that Kbuild extracts from the compiled assembly +output. + +Example:: + + #include + #include + + int main(void) + { + OFFSET(TSK_ACTIVE_MM, task_struct, active_mm); + DEFINE(THREAD_SIZE, THREAD_SIZE); + BLANK(); + return 0; + } + +The rules are defined in the top-level ``Kbuild`` and +``scripts/Makefile.lib``. The header is built during Kbuild's +``prepare`` phase, after ``archprepare`` and before descending into +subdirectories. + +The same mechanism generates ``include/generated/bounds.h`` from +``kernel/bounds.c`` and ``include/generated/rq-offsets.h`` from +``kernel/sched/rq-offsets.c``. =20 List directories to visit when descending ----------------------------------------- @@ -1690,9 +1721,3 @@ Credits - Updates by Kai Germaschewski - Updates by Sam Ravnborg - Language QA by Jan Engelhardt - -TODO -=3D=3D=3D=3D - -- Generating offset header files. -- Add more variables to chapters 7 or 9? --=20 2.43.0