From nobody Wed Dec 17 13:53:22 2025 Received: from mail-io1-f52.google.com (mail-io1-f52.google.com [209.85.166.52]) (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 9981E1A0721; Thu, 4 Jul 2024 14:57:21 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.166.52 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720105043; cv=none; b=PFpIE9ZTgrSNirCKv9zTbwT0vy26g9rwr6K2+7/XuWv5tt0afzKw08uNUTywJkNIpuXooy3UkGm0y8wH8Y8aaxA1gSvxKOFBSY6LUeO42RkKNDrPGAp6flveE0bRONH1KIospCzL/JYqKxYHQu4qNLaU8WJgWlUxkKngAGMKu7w= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720105043; c=relaxed/simple; bh=LT1u95/fiPf6qBJThFV+qOYRYj5VyAeLQh9sOwz40tI=; h=From:To:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=R9zua8aa7JF4Ef68oHOXa96B5mP/fUSaJgb342q0OGw4VOHSgA9dlJD8kR2As33NjCHFNkjDd+LP8IoQ3csUtnDNzaogx++QioGziL19KQOuo5hUNYVAHCfzFgtglQuC9n2Xs9lFyj3n+cUIleFsLiBRQaSnVMNMVQJWVfwIo2g= 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=h3Q0lpmc; arc=none smtp.client-ip=209.85.166.52 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="h3Q0lpmc" Received: by mail-io1-f52.google.com with SMTP id ca18e2360f4ac-7ebde93bf79so32175939f.1; Thu, 04 Jul 2024 07:57:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1720105040; x=1720709840; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=OxB0HCmHdrPChIVkH+RJRLuJmgHYPb3NqnatSG36g50=; b=h3Q0lpmcV6kplaJzTCkWMsevey4Usjl332aXozFY9cIreYzXPaiCBH9c+xBGQWtCHL wbJYRMiqv2wQxsAV2mG5kF7NWB3CpuWnUkSvUKyQ6R3M7xRexR3FG4avusnHzbOZOUkH Ix2tAgKeevgC0GgvNyrHJ542yzJww7C+h4afMLfJjAGHu1zAsqKBsREF4OWg1YqJ8bj+ 4ZEBT6hX3ezfJ7pb+GCDEh0E30oT1UViK/NdEBbeaxipneJYEhmQHkI1gQH2pjGOZ8+o ADM8+KmbzXYk8sO66qy/TqTwIpAdkT9RQFZYObuSLKF0Va37QdRCQtGIXUFJNZPSSyq3 FRhA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720105040; x=1720709840; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=OxB0HCmHdrPChIVkH+RJRLuJmgHYPb3NqnatSG36g50=; b=a7YQrRRG8FBjDKFUfCeAvsmGSxEjvVhTTkvQ8f6UAwIeSguF8d+idr5sJ9zX6APWnn k9drIWmbwFc6OtCPLMn/QJzO4Q3fR/1UxHMVBRpiSyNEFeGDvOyrK0D7hn/XWp/q9nRL nRFXywdmHkvgMbw3gG8uNiMiUZOHND8pJ5RIz7rXWUedPaDlS3NNwl15+MF3u1GIroOw Rb0vsMDDhxxmU16JOT/Fzq+6I0ecZaPcFz2WFnXd35XLszChIgfqW6TkU+VqgUdTeEtj K0f5ciQaGxVWs4/EVS9oXyEErJmNni6F9av0Vqgnwd727eDR2BJpxeY1Bx5M/rHrzH9n xD/A== X-Forwarded-Encrypted: i=1; AJvYcCUT5TT5l1JESGJy7b8CrmApHpxDscdK2gNvudcM9jdyEITw96H6riS/tVrlZeuhDf2ClF2q3bmkNZfBSqCpgOLrtnsBevR0pqfKCvcd1u0Bsum+BqtDqSvxJpbOzJOdASA9ERnlOm6ToZMlEus= X-Gm-Message-State: AOJu0YzVodX6++QlLnIDspVQHmzxVwLvBhVq1zp/wkkrcMEEAoyQCPRt DLZqxDUnZ4Xr7q0RyfJuSZuKb5ZxRbNn3YS1z3+ljGHvHyQsXWEy X-Google-Smtp-Source: AGHT+IGuhFwdMfUuo2moIks7z3toCz9jwt/WRl+4jyA/pzWWMVxhWrHG67fXVypdQuTOugdo3VJd4g== X-Received: by 2002:a6b:7848:0:b0:7f6:1ea5:de97 with SMTP id ca18e2360f4ac-7f66de9994bmr228523939f.3.1720105040514; Thu, 04 Jul 2024 07:57:20 -0700 (PDT) Received: from localhost.localdomain (h135-131-130-199.ashwwi.broadband.dynamic.tds.net. [135.131.130.199]) by smtp.gmail.com with ESMTPSA id 8926c6da1cb9f-4bb73bb388asm3940867173.5.2024.07.04.07.57.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 04 Jul 2024 07:57:20 -0700 (PDT) From: "Ethan D. Twardy" To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Martin Rodriguez Reboredo , "Ethan D. Twardy" , Trevor Gross , Aswin Unnikrishnan , rust-for-linux@vger.kernel.org (open list:RUST), linux-kernel@vger.kernel.org (open list) Subject: [PATCH v3 1/4] kbuild: rust: Expand rusttest target for macros Date: Thu, 4 Jul 2024 09:55:42 -0500 Message-ID: <20240704145607.17732-2-ethan.twardy@gmail.com> X-Mailer: git-send-email 2.44.2 In-Reply-To: <20240704145607.17732-1-ethan.twardy@gmail.com> References: <20240704145607.17732-1-ethan.twardy@gmail.com> 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" Previously, the rusttest target for the macros crate did not specify the dependencies necessary to run the rustdoc tests. These test rely on the kernel crate, so add a specialized rustdoc tests command for this particular crate. Signed-off-by: Ethan D. Twardy diff --git a/rust/Makefile b/rust/Makefile index f70d5e244fee..df389df4db9c 100644 --- a/rust/Makefile +++ b/rust/Makefile @@ -147,6 +147,15 @@ rusttestlib-macros: private rustc_test_library_proc = =3D yes rusttestlib-macros: $(src)/macros/lib.rs rusttest-prepare FORCE +$(call if_changed,rustc_test_library) =20 +rusttestlib-kernel: private rustc_target_flags =3D --extern alloc \ + --extern build_error --extern macros=3D$(objtree)/$(obj)/libmacros.so \ + --extern bindings --extern uapi +rusttestlib-kernel: $(src)/kernel/lib.rs rustdoc-compiler_builtins \ + rustdoc-alloc rusttestlib-bindings rusttestlib-uapi rusttestlib-build_= error \ + $(obj)/libmacros.so \ + $(obj)/bindings.o FORCE + +$(call if_changed,rustc_test_library) + rusttestlib-bindings: $(src)/bindings/lib.rs rusttest-prepare FORCE +$(call if_changed,rustc_test_library) =20 @@ -245,11 +254,24 @@ quiet_cmd_rustsysroot =3D RUSTSYSROOT rusttest-prepare: FORCE +$(call if_changed,rustsysroot) =20 -rusttest-macros: private rustc_target_flags =3D --extern proc_macro +quiet_cmd_rustdoc_test_macros =3D RUSTDOC T $< + cmd_rustdoc_test_macros =3D \ + OBJTREE=3D$(abspath $(objtree)) \ + $(RUSTDOC) --test $(rust_common_flags) \ + @$(objtree)/include/generated/rustc_cfg \ + $(rustc_target_flags) $(rustdoc_test_target_flags) \ + --sysroot $(objtree)/$(obj)/test/sysroot $(rustdoc_test_quiet) \ + -L$(objtree)/$(obj)/test --output $(rustdoc_output) \ + -Zproc-macro-backtrace \ + --crate-name $(subst rusttest-,,$@) $< + +rusttest-macros: private rustc_target_flags =3D --extern proc_macro \ + --extern macros=3D$(objtree)/$(obj)/libmacros.so --extern kernel rusttest-macros: private rustdoc_test_target_flags =3D --crate-type proc-m= acro -rusttest-macros: $(src)/macros/lib.rs rusttest-prepare FORCE +rusttest-macros: $(src)/macros/lib.rs rusttest-prepare \ + rusttestlib-macros rusttestlib-kernel FORCE +$(call if_changed,rustc_test) - +$(call if_changed,rustdoc_test) + +$(call if_changed,rustdoc_test_macros) =20 rusttest-kernel: private rustc_target_flags =3D --extern alloc \ --extern build_error --extern macros --extern bindings --extern uapi --=20 2.44.2 From nobody Wed Dec 17 13:53:22 2025 Received: from mail-io1-f52.google.com (mail-io1-f52.google.com [209.85.166.52]) (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 F28D11B120A; Thu, 4 Jul 2024 14:57:28 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.166.52 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720105050; cv=none; b=QCOGZoDOzXTUPOHGEVsAWD8lBS1/qYHfLpmTei6ndyCWpQQ+CdzafbW8xUCkymoncEel6tr6ggb7OBjSVWvN6o1au/h9qcXSaJ+MzW2UtFRNX5ul2ktC0ku2BPVpdtPb84xdtObMnsVPWZHe/Mijw357KYpGoKxGjyu2rcmyXeg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720105050; c=relaxed/simple; bh=Asb3OsmaU4xur7jTKhpefAUeM3PR7wjkzqbeEqFt1vk=; h=From:To:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=f7u0SKgHg65Gfjr3n2ibbXkTkxTyH5DM2CdACUG2f++A++nJKn+DPwCPnJLj3e4GyCgF8qIIMaOlhHIXN6y/updHPCEu8bxRaBNbBsoJzNnRRyTyrD/3jjVQwE0QHXhjhe9EDJjFN39zXEb72+HrPkqGij9VWRUo9gzD3BakuO8= 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=WBAsuh/Y; arc=none smtp.client-ip=209.85.166.52 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="WBAsuh/Y" Received: by mail-io1-f52.google.com with SMTP id ca18e2360f4ac-7f3c5af0a04so40382539f.0; Thu, 04 Jul 2024 07:57:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1720105048; x=1720709848; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=YS4FeN8/6jzuogXItnqNR+Y++d8T9MSODY7gDNOWrGo=; b=WBAsuh/YtWqF5OJUvPklrQnRyL9eDcmQg9eAGSefGLCJFA8SRmnOmDwyMgrBFSwhwe YkcAoN6rMvOaCY+VA3onqfTaUZvHLqNcSlXbMFEiPvuCZTOX8DnTpEZ8abBWOsAlrKwk K0RfJelbcphtiIhrf6TXtxjdLGeKUYk1ci4Gxp9P8GhvqQ1Ifs6ER7ML+Um5MsAdyduF 0NUlBWysWT7aQgWemr4iCIJjKe2LNzu7fGNxZKoioUQMWArofUY0Mbz+z7gm+xAfQqpZ xRty3+4FOnYuF1jze88+DTDyPBHZoPlT1uxiLZmdYy3fVZsOG0Pl50OioyPi5GsGKmAu ITTQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720105048; x=1720709848; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=YS4FeN8/6jzuogXItnqNR+Y++d8T9MSODY7gDNOWrGo=; b=dgRtLnYMNSobq/0YZOhZo8pCK9E20+hfY++54wqcUHcHJ9yDEDL90LZZgI+PdAeg6o lxTD13Bkro8u9kQQ3Z5jIK02bCk7ozVYna758cc/HHBk2xqfY5dVZC8/0acvktjiIyR5 3Z3hdlU0N8FIwvesgmJFzfIYvf+cf6CNCNIZx8FuunMHgA0TTHCTm3RNfZw2BhGDo8JC SQB59/C1V0Xut+7XNiNiYlxhoTmpbg9wL3lGyxsTYKBu6Xfb0jQIW7X5lo7dBTboLc9w 8VyHdoJFXpgi4NBo4+1IiITJijsU3hWDRUb272yv9MgZeSX81wv7/8NE9SjtbUrjJV6K 4kVA== X-Forwarded-Encrypted: i=1; AJvYcCUENB8NeaHuIhMAiVmNMYN3LXDwoZG4hgF8VhkKDzVJuHPEZtpXYY6G8QfyAGtiEu4kB0v0eSJLOEW8zZlhGR+xHB6lY1HWKL41vQet3jNym93a2Y7EqlOWXe1ypcjyci0nGOEN0bnDLeuvjFE= X-Gm-Message-State: AOJu0Yy29FyTJbgIzPvNQnTlFzTofPDoz1hInlL0geajDk53xxcrNb57 9mPlkeT3QPPQmkoZSA3VqkdYalOxsg2Lf53zvMHjoBp6p33R1xsa X-Google-Smtp-Source: AGHT+IHmT4M+fJI4PcJf4RElkH9Xa6Im8XFst1pbdkA3tOoDRK2h+O7oGNWrVw2ZDlnqNaZ2H1FcIA== X-Received: by 2002:a6b:7b4c:0:b0:7f6:522d:2714 with SMTP id ca18e2360f4ac-7f66def0274mr213062839f.16.1720105047999; Thu, 04 Jul 2024 07:57:27 -0700 (PDT) Received: from localhost.localdomain (h135-131-130-199.ashwwi.broadband.dynamic.tds.net. [135.131.130.199]) by smtp.gmail.com with ESMTPSA id 8926c6da1cb9f-4bb73bb388asm3940867173.5.2024.07.04.07.57.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 04 Jul 2024 07:57:27 -0700 (PDT) From: "Ethan D. Twardy" To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Martin Rodriguez Reboredo , "Ethan D. Twardy" , Aswin Unnikrishnan , Trevor Gross , rust-for-linux@vger.kernel.org (open list:RUST), linux-kernel@vger.kernel.org (open list) Subject: [PATCH v3 2/4] rust: Enable test for macros::module Date: Thu, 4 Jul 2024 09:55:43 -0500 Message-ID: <20240704145607.17732-3-ethan.twardy@gmail.com> X-Mailer: git-send-email 2.44.2 In-Reply-To: <20240704145607.17732-1-ethan.twardy@gmail.com> References: <20240704145607.17732-1-ethan.twardy@gmail.com> 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" Previously, this test was ignored due to a missing necessary dependency on the `kernel` crate. Enable the test, and update it to remove the use of a kernel parameter mechanism that was never merged. Signed-off-by: Ethan D. Twardy Reviewed-by: Alice Ryhl diff --git a/rust/Makefile b/rust/Makefile index df389df4db9c..3ace8506ee8d 100644 --- a/rust/Makefile +++ b/rust/Makefile @@ -256,6 +256,7 @@ rusttest-prepare: FORCE =20 quiet_cmd_rustdoc_test_macros =3D RUSTDOC T $< cmd_rustdoc_test_macros =3D \ + export RUST_MODFILE=3Dtest.rs; \ OBJTREE=3D$(abspath $(objtree)) \ $(RUSTDOC) --test $(rust_common_flags) \ @$(objtree)/include/generated/rustc_cfg \ diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs index 520eae5fd792..1c4ae5789cfa 100644 --- a/rust/macros/lib.rs +++ b/rust/macros/lib.rs @@ -26,9 +26,13 @@ /// /// # Examples /// -/// ```ignore +/// ```rust +/// # #[macro_use] extern crate macros; +/// # #[macro_use] extern crate kernel; /// use kernel::prelude::*; /// +/// struct MyModule(i32); +/// /// module!{ /// type: MyModule, /// name: "my_kernel_module", @@ -37,22 +41,14 @@ /// license: "GPL", /// } /// -/// struct MyModule; -/// /// impl kernel::Module for MyModule { -/// fn init() -> Result { -/// // If the parameter is writeable, then the kparam lock must be -/// // taken to read the parameter: -/// { -/// let lock =3D THIS_MODULE.kernel_param_lock(); -/// pr_info!("i32 param is: {}\n", writeable_i32.read(&lock)); -/// } -/// // If the parameter is read only, it can be read without locki= ng -/// // the kernel parameters: -/// pr_info!("i32 param is: {}\n", my_i32.read()); -/// Ok(Self) +/// fn init(module: &'static ThisModule) -> Result { +/// let foo: i32 =3D 42; +/// pr_info!("I contain: {}\n", foo); +/// Ok(Self(foo)) /// } /// } +/// # fn main() {} /// ``` /// /// # Supported argument types --=20 2.44.2 From nobody Wed Dec 17 13:53:22 2025 Received: from mail-io1-f46.google.com (mail-io1-f46.google.com [209.85.166.46]) (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 BC1A21B11EE; Thu, 4 Jul 2024 14:57:37 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.166.46 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720105059; cv=none; b=IZNlUK6WWfTu1Nc/3lcSFR1/n/Ckyj/fOH5HVYAkduhADDwU6jz+etsNqxjUR0FYLShgKG86YEl+Nsq7TT3B+V20WCstU7iwyFjZHrKEsh2sqMNEFDFDLx9+9jaTfH/WKyLe4/G7r8gkwY0lnGSdshMzS+xd/bIFLcVBTBw3iG0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720105059; c=relaxed/simple; bh=AgRx+RE90Nsd+3SC1MJNAZFTOkBW1aGkM1cwxyvfbW0=; h=From:To:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=aphCUT7kqAy+sWTNZkgnnc0YI95E7sM3P3LjZt2m3dm7l8Q/KS6s3riV6JKXzTgXvhCLdNBasBmA59AUOrUWub/l60AxjSZhC9SbXeS1nD5nIonrKfqnS9+zMwy1rTu0zUUWJoNXF6rjoPf/aZwzyy6enkvxEvT1JCnsTccvWzU= 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=jedAyiBa; arc=none smtp.client-ip=209.85.166.46 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="jedAyiBa" Received: by mail-io1-f46.google.com with SMTP id ca18e2360f4ac-7f3d3919a4aso25767639f.1; Thu, 04 Jul 2024 07:57:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1720105057; x=1720709857; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=H1IOl0BzF8HgBSBcBwDW60PY7M8R5w3VEjOB+eb5FzM=; b=jedAyiBav6BV73Q2RaNJBHoc3R8N+2xmG9UFiOidPWJ+H7bFt5H81NcQdt9bGjZDzc N7rQ4C7eiyxaNoFjkC9u3UN+XYAvbKapv7yhP/QcEM1wsFk5blNR8eGhWZR5teKeDlBU qUH5NYcbQys7lTTNjshaKpUxOKm10xa8/3ZATzPr7vo9VgMOgM92qKNZad6q+zITn5jF u84eXcxQ07+zV9OlNAaa4ZRoAtTRXDHTpJW/2ODejmtDt4rHlTalRO18t5ZK97CjFgHq Uay29iZyAtPiDwFdyZITuNGQn5m0XaQ8MpNXePo3/lcWc81wlguMXwM8CwdXoonhUwXm aZ8Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720105057; x=1720709857; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=H1IOl0BzF8HgBSBcBwDW60PY7M8R5w3VEjOB+eb5FzM=; b=iiQ/U23XJkEy8QAfPj8VDl4VpJSTeAKJvc/Zmx/MT+G9jWE4lB/fRHEdv/ewTvLTjv zCtS1LgXu+jVghZi7wmKbztzlysVeA7UhLjoJyX7tQQMAmrf2dCxlq3Gf5kiAD7fA7TE RjiHH5Gr7xitZWEsWl3XsQyZCeD5qtAS7oH7sTCOp0fHSkXnNzPSX6W38CUsXWzvsDuo HXq5lMxpM54app01R1W5BpxuUVuPIXa5BQJdjJmlOePChABr5xlEZC5+nrBIC7+QfkDZ O8QV1Y++6/Ww/mxy32rM7NdnDjwXzvwZUtYi/q50+Bj0lZc4NfYd4MXZWA7PWKDQSweD oeGA== X-Forwarded-Encrypted: i=1; AJvYcCW/o14IXjUr5mWwW5PTgTxnEz43mZXXqhecIwFw8U4BvzKxKLa8RJRm2tpbVk2JbAHCoRPqlNMQlt94EqibcU0rwscG0aGmH5iPsCDSVJ8ToB6ndzSK58GOG58A4Jdl82xr+ccJLjV6yWiRBVw= X-Gm-Message-State: AOJu0YxXu4aduGlE+4XBizxbn7ZeCJK/34nABMffPu7K1Nn1puboNpBl J48snb5NOo8/W3Xa+Rxz0obu4tnxGCin39eVW/sYvzclRypKE/GU X-Google-Smtp-Source: AGHT+IEycvy1RUeZggngRqiGufk5KXpqiCYij8IVXDZxf8SybcASMYnCrcrSkp5sq8AHJ95p6Pligg== X-Received: by 2002:a6b:dc06:0:b0:7f6:19bb:7939 with SMTP id ca18e2360f4ac-7f66dec26b9mr240357239f.11.1720105056885; Thu, 04 Jul 2024 07:57:36 -0700 (PDT) Received: from localhost.localdomain (h135-131-130-199.ashwwi.broadband.dynamic.tds.net. [135.131.130.199]) by smtp.gmail.com with ESMTPSA id 8926c6da1cb9f-4bb73bb388asm3940867173.5.2024.07.04.07.57.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 04 Jul 2024 07:57:36 -0700 (PDT) From: "Ethan D. Twardy" To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Martin Rodriguez Reboredo , "Ethan D. Twardy" , Trevor Gross , Aswin Unnikrishnan , rust-for-linux@vger.kernel.org (open list:RUST), linux-kernel@vger.kernel.org (open list) Subject: [PATCH v3 3/4] rust: macros: Enable use from macro_rules! Date: Thu, 4 Jul 2024 09:55:44 -0500 Message-ID: <20240704145607.17732-4-ethan.twardy@gmail.com> X-Mailer: git-send-email 2.44.2 In-Reply-To: <20240704145607.17732-1-ethan.twardy@gmail.com> References: <20240704145607.17732-1-ethan.twardy@gmail.com> 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" According to the rustdoc for the proc_macro crate[1], tokens captured from a "macro variable" (e.g. from within macro_rules!) may be delimited by invisible tokens and be contained within a proc_macro::Group. Previously, this scenario was not handled by macros::paste, which caused a proc-macro panic when the corresponding tests are enabled. Enable the tests, and handle this case by making macros::paste::concat recursive. Link: https://doc.rust-lang.org/stable/proc_macro/enum.Delimiter.html [1] Signed-off-by: Ethan D. Twardy Reviewed-by: Alice Ryhl diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs index 1c4ae5789cfa..3278f7c8aa5e 100644 --- a/rust/macros/lib.rs +++ b/rust/macros/lib.rs @@ -268,12 +268,25 @@ pub fn pinned_drop(args: TokenStream, input: TokenStr= eam) -> TokenStream { /// /// # Example /// -/// ```ignore -/// use kernel::macro::paste; -/// +/// ``` +/// # const binder_driver_return_protocol_BR_OK: u32 =3D 0; +/// # const binder_driver_return_protocol_BR_ERROR: u32 =3D 1; +/// # const binder_driver_return_protocol_BR_TRANSACTION: u32 =3D 2; +/// # const binder_driver_return_protocol_BR_REPLY: u32 =3D 3; +/// # const binder_driver_return_protocol_BR_DEAD_REPLY: u32 =3D 4; +/// # const binder_driver_return_protocol_BR_TRANSACTION_COMPLETE: u32 =3D= 5; +/// # const binder_driver_return_protocol_BR_INCREFS: u32 =3D 6; +/// # const binder_driver_return_protocol_BR_ACQUIRE: u32 =3D 7; +/// # const binder_driver_return_protocol_BR_RELEASE: u32 =3D 8; +/// # const binder_driver_return_protocol_BR_DECREFS: u32 =3D 9; +/// # const binder_driver_return_protocol_BR_NOOP: u32 =3D 10; +/// # const binder_driver_return_protocol_BR_SPAWN_LOOPER: u32 =3D 11; +/// # const binder_driver_return_protocol_BR_DEAD_BINDER: u32 =3D 12; +/// # const binder_driver_return_protocol_BR_CLEAR_DEATH_NOTIFICATION_DONE= : u32 =3D 13; +/// # const binder_driver_return_protocol_BR_FAILED_REPLY: u32 =3D 14; /// macro_rules! pub_no_prefix { /// ($prefix:ident, $($newname:ident),+) =3D> { -/// paste! { +/// kernel::macros::paste! { /// $(pub(crate) const $newname: u32 =3D [<$prefix $newname>];= )+ /// } /// }; @@ -312,13 +325,28 @@ pub fn pinned_drop(args: TokenStream, input: TokenStr= eam) -> TokenStream { /// * `lower`: change the identifier to lower case. /// * `upper`: change the identifier to upper case. /// -/// ```ignore -/// use kernel::macro::paste; -/// +/// ```rust +/// # const binder_driver_return_protocol_BR_OK: u32 =3D 0; +/// # const binder_driver_return_protocol_BR_ERROR: u32 =3D 1; +/// # const binder_driver_return_protocol_BR_TRANSACTION: u32 =3D 2; +/// # const binder_driver_return_protocol_BR_REPLY: u32 =3D 3; +/// # const binder_driver_return_protocol_BR_DEAD_REPLY: u32 =3D 4; +/// # const binder_driver_return_protocol_BR_TRANSACTION_COMPLETE: u32 =3D= 5; +/// # const binder_driver_return_protocol_BR_INCREFS: u32 =3D 6; +/// # const binder_driver_return_protocol_BR_ACQUIRE: u32 =3D 7; +/// # const binder_driver_return_protocol_BR_RELEASE: u32 =3D 8; +/// # const binder_driver_return_protocol_BR_DECREFS: u32 =3D 9; +/// # const binder_driver_return_protocol_BR_NOOP: u32 =3D 10; +/// # const binder_driver_return_protocol_BR_SPAWN_LOOPER: u32 =3D 11; +/// # const binder_driver_return_protocol_BR_DEAD_BINDER: u32 =3D 12; +/// # const binder_driver_return_protocol_BR_CLEAR_DEATH_NOTIFICATION_DONE= : u32 =3D 13; +/// # const binder_driver_return_protocol_BR_FAILED_REPLY: u32 =3D 14; /// macro_rules! pub_no_prefix { /// ($prefix:ident, $($newname:ident),+) =3D> { /// kernel::macros::paste! { -/// $(pub(crate) const fn [<$newname:lower:span>]: u32 =3D [<$= prefix $newname:span>];)+ +/// $(pub(crate) const fn [<$newname:lower:span>]() -> u32 { +/// [<$prefix $newname:span>] +/// })+ /// } /// }; /// } @@ -349,7 +377,7 @@ pub fn pinned_drop(args: TokenStream, input: TokenStrea= m) -> TokenStream { /// /// Literals can also be concatenated with other identifiers: /// -/// ```ignore +/// ```rust /// macro_rules! create_numbered_fn { /// ($name:literal, $val:literal) =3D> { /// kernel::macros::paste! { diff --git a/rust/macros/paste.rs b/rust/macros/paste.rs index f40d42b35b58..6529a387673f 100644 --- a/rust/macros/paste.rs +++ b/rust/macros/paste.rs @@ -2,7 +2,7 @@ =20 use proc_macro::{Delimiter, Group, Ident, Spacing, Span, TokenTree}; =20 -fn concat(tokens: &[TokenTree], group_span: Span) -> TokenTree { +fn concat_helper(tokens: &[TokenTree]) -> Vec<(String, Span)> { let mut tokens =3D tokens.iter(); let mut segments =3D Vec::new(); let mut span =3D None; @@ -46,12 +46,21 @@ fn concat(tokens: &[TokenTree], group_span: Span) -> To= kenTree { }; segments.push((value, sp)); } - _ =3D> panic!("unexpected token in paste segments"), + Some(TokenTree::Group(group)) if group.delimiter() =3D=3D Deli= miter::None =3D> { + let tokens =3D group.stream().into_iter().collect::>(); + segments.append(&mut concat_helper(tokens.as_slice())); + } + token =3D> panic!("unexpected token in paste segments: {:?}", = token), }; } =20 + segments +} + +fn concat(tokens: &[TokenTree], group_span: Span) -> TokenTree { + let segments =3D concat_helper(tokens); let pasted: String =3D segments.into_iter().map(|x| x.0).collect(); - TokenTree::Ident(Ident::new(&pasted, span.unwrap_or(group_span))) + TokenTree::Ident(Ident::new(&pasted, group_span)) } =20 pub(crate) fn expand(tokens: &mut Vec) { --=20 2.44.2 From nobody Wed Dec 17 13:53:22 2025 Received: from mail-il1-f170.google.com (mail-il1-f170.google.com [209.85.166.170]) (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 8D66E1B1204; Thu, 4 Jul 2024 14:57:46 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.166.170 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720105068; cv=none; b=ClpBc44vR6BEEPIOyN8gUSk/MMHqI/d8EAdHhambjAK9qe7mnaADA6f2OVB8K07JID51VPleFN30lCNNN0Jovj9ys8Nq1Dx7uQBFHiuM81oUgDf2FIqJnsu9IgOEHdYdmqfLONvjaN1PqIfwyDiNUY07wXYg/qa6FKihcaYUa2s= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720105068; c=relaxed/simple; bh=tIdZYPxmJW4E0hW6Pl84dUGKRz0hq/errAVHljq1tM8=; h=From:To:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=ny4wdL5fLLcupfS8QzknGKJ1TQntYF5ROkL8XEbAOjwknU9V+RYfwjmCezgaLVTpDz9VvzkXXetPAA42HSujxmLGxcFeaf+Ox8OdfRZTAt+ghRWodAT4NwK4FWsMJ4KCJNX7q0XKJYXnlIESzUyAvYEIu/UsVZOViE/HDCfu+aI= 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=WzJ3Q9u7; arc=none smtp.client-ip=209.85.166.170 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="WzJ3Q9u7" Received: by mail-il1-f170.google.com with SMTP id e9e14a558f8ab-3833cd120e5so2996485ab.1; Thu, 04 Jul 2024 07:57:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1720105065; x=1720709865; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=5fctaVAQ0sznMfei827CWV0YvJyDf9holFy0vo6SoIg=; b=WzJ3Q9u7QLb6z33b2kIqt0J1pBrZOu3STL1YCVVwb9vze9fCCqMEVRo3mhmda6fCRY KAO3jRYTsuP9v5FrlryTVPqYRYYZARetDgcEGQ1QtSU6omFO+k/9bWkQL3CCO//cgz/+ 2x2pQm+LcRm6fVIqEJyEkxAHJQD5Qi4Pe+oXghQ9ISk2YCH/CA+OnnrqI/hoSfMrh80f A874CVNSLnuj8AKUcbFEnpmyFBnZOOd2YhW2C9PHmA4IHtPhLX3j+Wha8Mp7xM9aIen8 s8jUuMpuCxs/QsKn3/ilmFJWa0E/UUGWuMOcrkXZaPmhq/yRydlmh3Gkn3J9mcG2N60f lBhw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720105065; x=1720709865; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=5fctaVAQ0sznMfei827CWV0YvJyDf9holFy0vo6SoIg=; b=oURtcfdG93wPaL8tbfaK/8HqqvU9DWt1Tcb32W9dDCP+ac+SDSXhQcuuBkaXZd0TC9 LOZyc6J/F+UDZccKEah23rVsllrGqlCask5Y6vezkYht5Zg1Md6RKXFQjuh3nLFR8rln 5SbmTkLznjJypU2oe0bta4luhFagI0UGiBr866XRQtKG+xof6YkWOonVGrlIGAWpKtm0 RvLTzNpyUGEYWR5ssFY5SldqsNvX4eHIhrk82bxkY11a9dPMfsiitxvFjHg9gN6QfIKC 5sOvoklYDvpz+0I3KEzuYU2ObJWmF072C4mSgTthwWG+rvXzWQ4jYSnGdrX3BaDQ04xV BNoQ== X-Forwarded-Encrypted: i=1; AJvYcCWSCPnvZqdfshZgXt0TOekaEavrXqi8mxSMHPmyc7eKYc03Ujqca77p5EMDhMbd6LfcLLxQNXIOY8f6bWN8bi+9zwf8oRFZVV/5eF4MIJ9vvi88N+0URR4MyFZ7+sERYB7XDapAGGJjPT+XrJs= X-Gm-Message-State: AOJu0YxLKe0SUENWyAv/38hMDjfZMLEFNg4lEAuGORNWF2YRtD7+njRc 1emKyzeX2F/lcLIdSLTlcL5yMEPNJuqlDrlNrcDCDWAEbc3mf+aa X-Google-Smtp-Source: AGHT+IHF/3Xb/rvxqzMr2y4ttn2MOVLHOmLw+ef2wq2Yox/+TeekF94oApSViMpjVahzbes9MMD9oQ== X-Received: by 2002:a05:6e02:1aa7:b0:381:1509:7487 with SMTP id e9e14a558f8ab-383cbec00e5mr8882015ab.7.1720105065517; Thu, 04 Jul 2024 07:57:45 -0700 (PDT) Received: from localhost.localdomain (h135-131-130-199.ashwwi.broadband.dynamic.tds.net. [135.131.130.199]) by smtp.gmail.com with ESMTPSA id 8926c6da1cb9f-4bb73bb388asm3940867173.5.2024.07.04.07.57.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 04 Jul 2024 07:57:45 -0700 (PDT) From: "Ethan D. Twardy" To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Martin Rodriguez Reboredo , "Ethan D. Twardy" , Aswin Unnikrishnan , Trevor Gross , rust-for-linux@vger.kernel.org (open list:RUST), linux-kernel@vger.kernel.org (open list) Subject: [PATCH v3 4/4] rust: macros: Enable the rest of the tests Date: Thu, 4 Jul 2024 09:55:45 -0500 Message-ID: <20240704145607.17732-5-ethan.twardy@gmail.com> X-Mailer: git-send-email 2.44.2 In-Reply-To: <20240704145607.17732-1-ethan.twardy@gmail.com> References: <20240704145607.17732-1-ethan.twardy@gmail.com> 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" Now that the rusttest target for the macros crate is compiled with the kernel crate as a dependency, the rest of the rustdoc tests can be enabled. Signed-off-by: Ethan D. Twardy Reviewed-by: Alice Ryhl diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs index 3278f7c8aa5e..16ab53634099 100644 --- a/rust/macros/lib.rs +++ b/rust/macros/lib.rs @@ -101,7 +101,9 @@ pub fn module(ts: TokenStream) -> TokenStream { /// /// # Examples /// -/// ```ignore +/// ```rust +/// # #[macro_use] extern crate macros; +/// # #[macro_use] extern crate kernel; /// use kernel::error::VTABLE_DEFAULT_ERROR; /// use kernel::prelude::*; /// @@ -146,12 +148,27 @@ pub fn vtable(attr: TokenStream, ts: TokenStream) -> = TokenStream { /// /// # Examples /// -/// ```ignore -/// use kernel::macro::concat_idents; +/// ```rust +/// # const binder_driver_return_protocol_BR_OK: u32 =3D 0; +/// # const binder_driver_return_protocol_BR_ERROR: u32 =3D 1; +/// # const binder_driver_return_protocol_BR_TRANSACTION: u32 =3D 2; +/// # const binder_driver_return_protocol_BR_REPLY: u32 =3D 3; +/// # const binder_driver_return_protocol_BR_DEAD_REPLY: u32 =3D 4; +/// # const binder_driver_return_protocol_BR_TRANSACTION_COMPLETE: u32 =3D= 5; +/// # const binder_driver_return_protocol_BR_INCREFS: u32 =3D 6; +/// # const binder_driver_return_protocol_BR_ACQUIRE: u32 =3D 7; +/// # const binder_driver_return_protocol_BR_RELEASE: u32 =3D 8; +/// # const binder_driver_return_protocol_BR_DECREFS: u32 =3D 9; +/// # const binder_driver_return_protocol_BR_NOOP: u32 =3D 10; +/// # const binder_driver_return_protocol_BR_SPAWN_LOOPER: u32 =3D 11; +/// # const binder_driver_return_protocol_BR_DEAD_BINDER: u32 =3D 12; +/// # const binder_driver_return_protocol_BR_CLEAR_DEATH_NOTIFICATION_DONE= : u32 =3D 13; +/// # const binder_driver_return_protocol_BR_FAILED_REPLY: u32 =3D 14; +/// use kernel::macros::concat_idents; /// /// macro_rules! pub_no_prefix { /// ($prefix:ident, $($newname:ident),+) =3D> { -/// $(pub(crate) const $newname: u32 =3D kernel::macros::concat_id= ents!($prefix, $newname);)+ +/// $(pub(crate) const $newname: u32 =3D concat_idents!($prefix, $= newname);)+ /// }; /// } /// @@ -197,7 +214,9 @@ pub fn concat_idents(ts: TokenStream) -> TokenStream { /// /// # Examples /// -/// ```rust,ignore +/// ```rust +/// # use std::{sync::Mutex, process::Command}; +/// # use kernel::macros::pin_data; /// #[pin_data] /// struct DriverData { /// #[pin] @@ -206,7 +225,15 @@ pub fn concat_idents(ts: TokenStream) -> TokenStream { /// } /// ``` /// -/// ```rust,ignore +/// ```rust +/// # use std::{sync::Mutex, process::Command}; +/// # use core::pin::Pin; +/// # pub struct Info; +/// # mod bindings { +/// # pub unsafe fn destroy_info(_ptr: *mut super::Info) {} +/// # } +/// use kernel::macros::{pin_data, pinned_drop}; +/// /// #[pin_data(PinnedDrop)] /// struct DriverData { /// #[pin] @@ -221,6 +248,7 @@ pub fn concat_idents(ts: TokenStream) -> TokenStream { /// unsafe { bindings::destroy_info(self.raw_info) }; /// } /// } +/// # fn main() {} /// ``` /// /// [`pin_init!`]: ../kernel/macro.pin_init.html @@ -236,13 +264,20 @@ pub fn pin_data(inner: TokenStream, item: TokenStream= ) -> TokenStream { /// /// # Examples /// -/// ```rust,ignore +/// ```rust +/// # use macros::{pin_data, pinned_drop}; +/// # use std::{sync::Mutex, process::Command}; +/// # use core::pin::Pin; +/// # mod bindings { +/// # pub struct Info; +/// # pub unsafe fn destroy_info(_ptr: *mut Info) {} +/// # } /// #[pin_data(PinnedDrop)] /// struct DriverData { /// #[pin] /// queue: Mutex>, /// buf: Box<[u8; 1024 * 1024]>, -/// raw_info: *mut Info, +/// raw_info: *mut bindings::Info, /// } /// /// #[pinned_drop] @@ -405,7 +440,9 @@ pub fn paste(input: TokenStream) -> TokenStream { /// /// # Examples /// -/// ```rust,ignore +/// ```rust +/// use kernel::macros::Zeroable; +/// /// #[derive(Zeroable)] /// pub struct DriverData { /// id: i64, --=20 2.44.2