From patchwork Mon Jul 10 18:30:27 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Vernet X-Patchwork-Id: 13307477 X-Patchwork-Delegate: bpf@iogearbox.net Received: from lindbergh.monkeyblade.net (lindbergh.monkeyblade.net [23.128.96.19]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 0641D14AA8 for ; Mon, 10 Jul 2023 18:31:49 +0000 (UTC) Received: from mail-qt1-f179.google.com (mail-qt1-f179.google.com [209.85.160.179]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 728CD180; Mon, 10 Jul 2023 11:31:48 -0700 (PDT) Received: by mail-qt1-f179.google.com with SMTP id d75a77b69052e-40355e76338so43246531cf.3; Mon, 10 Jul 2023 11:31:48 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1689013907; x=1691605907; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=FFg6es6MnkESIGeku/OXeP7kXEnpRz2XkgXfhzN59IQ=; b=CQRUENN/RRAKPAefe+Yw8g54nVD/jpYQNE0T11vfGMSLFmVvaxH8TmOeBMMnyuAPDC oLbQDQuA7cbIe4Klvcea4WGeikoD4aFpYvyP4hwwvO3YI+LzFfDrH1whn8BXDy2LGkYr uBaHuxj4rqyU2+8VokJIKwDZGyAlXmTWgYm9rl2bxTgh+07yHRxO/Q2nfWmKVU/F6L/F 73h8OAyDZ64UBTmPexC/v8PHxpSmugQRzJXo0EwcnyF3Ze/vZ5Ph9AMiJp7Lt6lzHtC4 mDQVXosb7tjWYdej3pDPzl1kCA2Qo4IaACoSZSuzQKUxIgHENEQWhElHmPRaOKZolrw6 mWFw== X-Gm-Message-State: ABy/qLbl/QDgZqf4jz6jDcOoH7GAnwB5rC6od58R2QeeqyVX+yKVOM1e LobR9c5To7ypN1m8SnOHkdKBdZnGw3BIsCXx X-Google-Smtp-Source: APBJJlFnJy56MSvI7hBVrDADp6aJ5NB+E7GR4tyisl4jvg/ekNRgWT9+E1wpViPcJoyO6CTGRqMzyA== X-Received: by 2002:ac8:7d43:0:b0:403:a7de:ae36 with SMTP id h3-20020ac87d43000000b00403a7deae36mr8725658qtb.67.1689013906996; Mon, 10 Jul 2023 11:31:46 -0700 (PDT) Received: from localhost ([2620:10d:c091:400::5:4850]) by smtp.gmail.com with ESMTPSA id z4-20020ac87f84000000b00403a2e88d01sm180690qtj.40.2023.07.10.11.31.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 10 Jul 2023 11:31:46 -0700 (PDT) From: David Vernet To: bpf@vger.kernel.org Cc: ast@kernel.org, daniel@iogearbox.net, andrii@kernel.org, martin.lau@linux.dev, song@kernel.org, yhs@fb.com, john.fastabend@gmail.com, kpsingh@kernel.org, sdf@google.com, haoluo@google.com, jolsa@kernel.org, linux-kernel@vger.kernel.org, kernel-team@meta.com, bpf@ietf.org Subject: [PATCH bpf-next] bpf,docs: Create new standardization subdirectory Date: Mon, 10 Jul 2023 13:30:27 -0500 Message-Id: <20230710183027.15132-1-void@manifault.com> X-Mailer: git-send-email 2.40.1 Precedence: bulk X-Mailing-List: bpf@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Spam-Status: No, score=-1.4 required=5.0 tests=BAYES_00, FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS, RCVD_IN_DNSWL_BLOCKED,RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net X-Patchwork-Delegate: bpf@iogearbox.net The BPF standardization effort is actively underway with the IETF. As described in the BPF Working Group (WG) charter in [0], there are a number of proposed documents, some informational and some proposed standards, that will be drafted as part of the standardization effort. [0]: https://datatracker.ietf.org/wg/bpf/about/ Though the specific documents that will formally be standardized will exist as Internet Drafts (I-D) and WG documents in the BPF WG datatracker page, the source of truth from where those documents will be generated will reside in the kernel documentation tree (originating in the bpf-next tree). Because these documents will be used to generate the I-D and WG documents which will be standardized with the IETF, they are a bit special as far as kernel-tree documentation goes: - They will be dual licensed with LGPL-2.1 OR BSD-2-Clause - IETF I-D and WG documents (the documents which will actually be standardized) will be auto-generated from these documents. In order to keep things clearly organized in the BPF documentation tree, and to make it abundantly clear where standards-related documentation needs to go, we should move standards-relevant documents into a separate standardization/ subdirectory. Signed-off-by: David Vernet --- Documentation/bpf/index.rst | 3 +-- Documentation/bpf/standardization/index.rst | 18 ++++++++++++++++++ .../{ => standardization}/instruction-set.rst | 0 .../bpf/{ => standardization}/linux-notes.rst | 3 ++- MAINTAINERS | 2 +- 5 files changed, 22 insertions(+), 4 deletions(-) create mode 100644 Documentation/bpf/standardization/index.rst rename Documentation/bpf/{ => standardization}/instruction-set.rst (100%) rename Documentation/bpf/{ => standardization}/linux-notes.rst (96%) diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst index dbb39e8f9889..1ff177b89d66 100644 --- a/Documentation/bpf/index.rst +++ b/Documentation/bpf/index.rst @@ -12,9 +12,9 @@ that goes into great technical depth about the BPF Architecture. .. toctree:: :maxdepth: 1 - instruction-set verifier libbpf/index + standardization/index btf faq syscall_api @@ -29,7 +29,6 @@ that goes into great technical depth about the BPF Architecture. bpf_licensing test_debug clang-notes - linux-notes other redirect diff --git a/Documentation/bpf/standardization/index.rst b/Documentation/bpf/standardization/index.rst new file mode 100644 index 000000000000..09c6ba055fd7 --- /dev/null +++ b/Documentation/bpf/standardization/index.rst @@ -0,0 +1,18 @@ +.. SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) + +=================== +BPF Standardization +=================== + +This directory contains documents that are being iterated on as part of the BPF +standardization effort with the IETF. See the `IETF BPF Working Group`_ page +for the working group charter, documents, and more. + +.. toctree:: + :maxdepth: 1 + + instruction-set + linux-notes + +.. Links: +.. _IETF BPF Working Group: https://datatracker.ietf.org/wg/bpf/about/ diff --git a/Documentation/bpf/instruction-set.rst b/Documentation/bpf/standardization/instruction-set.rst similarity index 100% rename from Documentation/bpf/instruction-set.rst rename to Documentation/bpf/standardization/instruction-set.rst diff --git a/Documentation/bpf/linux-notes.rst b/Documentation/bpf/standardization/linux-notes.rst similarity index 96% rename from Documentation/bpf/linux-notes.rst rename to Documentation/bpf/standardization/linux-notes.rst index 508d009d3bed..00d2693de025 100644 --- a/Documentation/bpf/linux-notes.rst +++ b/Documentation/bpf/standardization/linux-notes.rst @@ -45,7 +45,8 @@ On Linux, this integer is a BTF ID. Legacy BPF Packet access instructions ===================================== -As mentioned in the `ISA standard documentation `_, +As mentioned in the `ISA standard documentation +`_, Linux has special eBPF instructions for access to packet data that have been carried over from classic BPF to retain the performance of legacy socket filters running in the eBPF interpreter. diff --git a/MAINTAINERS b/MAINTAINERS index acbe54087d1c..99d8dc9b2850 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -3746,7 +3746,7 @@ R: David Vernet L: bpf@vger.kernel.org L: bpf@ietf.org S: Maintained -F: Documentation/bpf/instruction-set.rst +F: Documentation/bpf/standardization/ BPF [GENERAL] (Safe Dynamic Programs and Tools) M: Alexei Starovoitov