// SPDX-License-Identifier: GPL-2.0 use crate::helpers::*;use proc_macro::{token_stream, Delimiter, Literal, TokenStream, TokenTree};use std::fmt::Write; fn expect_string_array(it: &mut token_stream::IntoIter) -> Vec<String> { let group = expect_group(it); assert_eq!(group.delimiter(), Delimiter::Bracket); let mut values = Vec::new(); let mut it = group.stream().into_iter(); while let Some(val) = try_string(&mut it) { assert!(val.is_ascii(), "Expected ASCII string"); values.push(val); match it.next() { Some(TokenTree::Punct(punct)) => assert_eq!(punct.as_char(), ','), None => break, _ => panic!("Expected ',' or end of array"), } } values} struct ModInfoBuilder<'a> { module: &'a str, counter: usize, buffer: String, param_buffer: String,} impl<'a> ModInfoBuilder<'a> { fn new(module: &'a str) -> Self { ModInfoBuilder { module, counter: 0, buffer: String::new(), param_buffer: String::new(), } } fn emit_base(&mut self, field: &str, content: &str, builtin: bool, param: bool) { let string = if builtin { // Built-in modules prefix their modinfo strings by `module.`. format!( "{module}.{field}={content}\0", module = self.module, field = field, content = content ) } else { // Loadable modules' modinfo strings go as-is. format!("{field}={content}\0") }; let buffer = if param { &mut self.param_buffer } else { &mut self.buffer }; write!( buffer, " {cfg} #[doc(hidden)] #[cfg_attr(not(target_os = \"macos\"), link_section = \".modinfo\")] #[used(compiler)] pub static __{module}_{counter}: [u8; {length}] = *{string}; ", cfg = if builtin { "#[cfg(not(MODULE))]" } else { "#[cfg(MODULE)]" }, module = self.module.to_uppercase(), counter = self.counter, length = string.len(), string = Literal::byte_string(string.as_bytes()), ) .unwrap(); self.counter += 1; } fn emit_only_builtin(&mut self, field: &str, content: &str, param: bool) { self.emit_base(field, content, true, param) } fn emit_only_loadable(&mut self, field: &str, content: &str, param: bool) { self.emit_base(field, content, false, param) } fn emit(&mut self, field: &str, content: &str) { self.emit_internal(field, content, false); } fn emit_internal(&mut self, field: &str, content: &str, param: bool) { self.emit_only_builtin(field, content, param); self.emit_only_loadable(field, content, param); } fn emit_param(&mut self, field: &str, param: &str, content: &str) { let content = format!("{param}:{content}", param = param, content = content); self.emit_internal(field, &content, true); } fn emit_params(&mut self, info: &ModuleInfo) { let Some(params) = &info.params else { return; }; for param in params { let ops = param_ops_path(¶m.ptype); // Note: The spelling of these fields is dictated by the user space // tool `modinfo`. self.emit_param("parmtype", ¶m.name, ¶m.ptype); self.emit_param("parm", ¶m.name, ¶m.description); write!( self.param_buffer, " pub(crate) static {param_name}: ::kernel::module_param::ModuleParamAccess<{param_type}> = ::kernel::module_param::ModuleParamAccess::new({param_default}); const _: () = {{ #[link_section = \"__param\"] #[used] static __{module_name}_{param_name}_struct: ::kernel::module_param::KernelParam = ::kernel::module_param::KernelParam::new( ::kernel::bindings::kernel_param {{ name: if ::core::cfg!(MODULE) {{ ::kernel::c_str!(\"{param_name}\").to_bytes_with_nul() }} else {{ ::kernel::c_str!(\"{module_name}.{param_name}\") .to_bytes_with_nul() }}.as_ptr(), // SAFETY: `__this_module` is constructed by the kernel at load // time and will not be freed until the module is unloaded. #[cfg(MODULE)] mod_: unsafe {{ core::ptr::from_ref(&::kernel::bindings::__this_module) .cast_mut() }}, #[cfg(not(MODULE))] mod_: ::core::ptr::null_mut(), ops: core::ptr::from_ref(&{ops}), perm: 0, // Will not appear in sysfs level: -1, flags: 0, __bindgen_anon_1: ::kernel::bindings::kernel_param__bindgen_ty_1 {{ arg: {param_name}.as_void_ptr() }}, }} ); }}; ", module_name = info.name, param_type = param.ptype, param_default = param.default, param_name = param.name, ops = ops, ) .unwrap(); } }} fn param_ops_path(param_type: &str) -> &'static str { match param_type { "i8" => "::kernel::module_param::PARAM_OPS_I8", "u8" => "::kernel::module_param::PARAM_OPS_U8", "i16" => "::kernel::module_param::PARAM_OPS_I16", "u16" => "::kernel::module_param::PARAM_OPS_U16", "i32" => "::kernel::module_param::PARAM_OPS_I32", "u32" => "::kernel::module_param::PARAM_OPS_U32", "i64" => "::kernel::module_param::PARAM_OPS_I64", "u64" => "::kernel::module_param::PARAM_OPS_U64", "isize" => "::kernel::module_param::PARAM_OPS_ISIZE", "usize" => "::kernel::module_param::PARAM_OPS_USIZE", t => panic!("Unsupported parameter type {}", t), }} fn expect_param_default(param_it: &mut token_stream::IntoIter) -> String { assert_eq!(expect_ident(param_it), "default"); assert_eq!(expect_punct(param_it), ':'); let sign = try_sign(param_it); let default = try_literal(param_it).expect("Expected default param value"); assert_eq!(expect_punct(param_it), ','); let mut value = sign.map(String::from).unwrap_or_default(); value.push_str(&default); value} #[derive(Debug, Default)]struct ModuleInfo { type_: String, license: String, name: String, authors: Option<Vec<String>>, description: Option<String>, alias: Option<Vec<String>>, firmware: Option<Vec<String>>, imports_ns: Option<Vec<String>>, params: Option<Vec<Parameter>>,} #[derive(Debug)]struct Parameter { name: String, ptype: String, default: String, description: String,} fn expect_params(it: &mut token_stream::IntoIter) -> Vec<Parameter> { let params = expect_group(it); assert_eq!(params.delimiter(), Delimiter::Brace); let mut it = params.stream().into_iter(); let mut parsed = Vec::new(); loop { let param_name = match it.next() { Some(TokenTree::Ident(ident)) => ident.to_string(), Some(_) => panic!("Expected Ident or end"), None => break, }; assert_eq!(expect_punct(&mut it), ':'); let param_type = expect_ident(&mut it); let group = expect_group(&mut it); assert_eq!(group.delimiter(), Delimiter::Brace); assert_eq!(expect_punct(&mut it), ','); let mut param_it = group.stream().into_iter(); let param_default = expect_param_default(&mut param_it); let param_description = expect_string_field(&mut param_it, "description"); expect_end(&mut param_it); parsed.push(Parameter { name: param_name, ptype: param_type, default: param_default, description: param_description, }) } parsed} impl ModuleInfo { fn parse(it: &mut token_stream::IntoIter) -> Self { let mut info = ModuleInfo::default(); const EXPECTED_KEYS: &[&str] = &[ "type", "name", "authors", "description", "license", "alias", "firmware", "imports_ns", "params", ]; const REQUIRED_KEYS: &[&str] = &["type", "name", "license"]; let mut seen_keys = Vec::new(); loop { let key = match it.next() { Some(TokenTree::Ident(ident)) => ident.to_string(), Some(_) => panic!("Expected Ident or end"), None => break, }; if seen_keys.contains(&key) { panic!("Duplicated key \"{key}\". Keys can only be specified once."); } assert_eq!(expect_punct(it), ':'); match key.as_str() { "type" => info.type_ = expect_ident(it), "name" => info.name = expect_string_ascii(it), "authors" => info.authors = Some(expect_string_array(it)), "description" => info.description = Some(expect_string(it)), "license" => info.license = expect_string_ascii(it), "alias" => info.alias = Some(expect_string_array(it)), "firmware" => info.firmware = Some(expect_string_array(it)), "imports_ns" => info.imports_ns = Some(expect_string_array(it)), "params" => info.params = Some(expect_params(it)), _ => panic!("Unknown key \"{key}\". Valid keys are: {EXPECTED_KEYS:?}."), } assert_eq!(expect_punct(it), ','); seen_keys.push(key); } expect_end(it); for key in REQUIRED_KEYS { if !seen_keys.iter().any(|e| e == key) { panic!("Missing required key \"{key}\"."); } } let mut ordered_keys: Vec<&str> = Vec::new(); for key in EXPECTED_KEYS { if seen_keys.iter().any(|e| e == key) { ordered_keys.push(key); } } if seen_keys != ordered_keys { panic!("Keys are not ordered as expected. Order them like: {ordered_keys:?}."); } info }} pub(crate) fn module(ts: TokenStream) -> TokenStream { let mut it = ts.into_iter(); let info = ModuleInfo::parse(&mut it); // Rust does not allow hyphens in identifiers, use underscore instead. let ident = info.name.replace('-', "_"); let mut modinfo = ModInfoBuilder::new(ident.as_ref()); if let Some(authors) = &info.authors { for author in authors { modinfo.emit("author", author); } } if let Some(description) = &info.description { modinfo.emit("description", description); } modinfo.emit("license", &info.license); if let Some(aliases) = &info.alias { for alias in aliases { modinfo.emit("alias", alias); } } if let Some(firmware) = &info.firmware { for fw in firmware { modinfo.emit("firmware", fw); } } if let Some(imports) = &info.imports_ns { for ns in imports { modinfo.emit("import_ns", ns); } } // Built-in modules also export the `file` modinfo string. let file = std::env::var("RUST_MODFILE").expect("Unable to fetch RUST_MODFILE environmental variable"); modinfo.emit_only_builtin("file", &file, false); modinfo.emit_params(&info); format!( " /// The module name. /// /// Used by the printing macros, e.g. [`info!`]. const __LOG_PREFIX: &[u8] = b\"{name}\\0\"; // SAFETY: `__this_module` is constructed by the kernel at load time and will not be // freed until the module is unloaded. #[cfg(MODULE)] static THIS_MODULE: ::kernel::ThisModule = unsafe {{ extern \"C\" {{ static __this_module: ::kernel::types::Opaque<::kernel::bindings::module>; }} ::kernel::ThisModule::from_ptr(__this_module.get()) }}; #[cfg(not(MODULE))] static THIS_MODULE: ::kernel::ThisModule = unsafe {{ ::kernel::ThisModule::from_ptr(::core::ptr::null_mut()) }}; /// The `LocalModule` type is the type of the module created by `module!`, /// `module_pci_driver!`, `module_platform_driver!`, etc. type LocalModule = {type_}; impl ::kernel::ModuleMetadata for {type_} {{ const NAME: &'static ::kernel::str::CStr = c\"{name}\"; }} // Double nested modules, since then nobody can access the public items inside. mod __module_init {{ mod __module_init {{ use super::super::{type_}; use pin_init::PinInit; /// The \"Rust loadable module\" mark. // // This may be best done another way later on, e.g. as a new modinfo // key or a new section. For the moment, keep it simple. #[cfg(MODULE)] #[doc(hidden)] #[used(compiler)] static __IS_RUST_MODULE: () = (); static mut __MOD: ::core::mem::MaybeUninit<{type_}> = ::core::mem::MaybeUninit::uninit(); // Loadable modules need to export the `{{init,cleanup}}_module` identifiers. /// # Safety /// /// This function must not be called after module initialization, because it may be /// freed after that completes. #[cfg(MODULE)] #[doc(hidden)] #[no_mangle] #[link_section = \".init.text\"] pub unsafe extern \"C\" fn init_module() -> ::kernel::ffi::c_int {{ // SAFETY: This function is inaccessible to the outside due to the double // module wrapping it. It is called exactly once by the C side via its // unique name. unsafe {{ __init() }} }} #[cfg(MODULE)] #[doc(hidden)] #[used(compiler)] #[link_section = \".init.data\"] static __UNIQUE_ID___addressable_init_module: unsafe extern \"C\" fn() -> i32 = init_module; #[cfg(MODULE)] #[doc(hidden)] #[no_mangle] #[link_section = \".exit.text\"] pub extern \"C\" fn cleanup_module() {{ // SAFETY: // - This function is inaccessible to the outside due to the double // module wrapping it. It is called exactly once by the C side via its // unique name, // - furthermore it is only called after `init_module` has returned `0` // (which delegates to `__init`). unsafe {{ __exit() }} }} #[cfg(MODULE)] #[doc(hidden)] #[used(compiler)] #[link_section = \".exit.data\"] static __UNIQUE_ID___addressable_cleanup_module: extern \"C\" fn() = cleanup_module; // Built-in modules are initialized through an initcall pointer // and the identifiers need to be unique. #[cfg(not(MODULE))] #[cfg(not(CONFIG_HAVE_ARCH_PREL32_RELOCATIONS))] #[doc(hidden)] #[link_section = \"{initcall_section}\"] #[used(compiler)] pub static __{ident}_initcall: extern \"C\" fn() -> ::kernel::ffi::c_int = __{ident}_init; #[cfg(not(MODULE))] #[cfg(CONFIG_HAVE_ARCH_PREL32_RELOCATIONS)] ::core::arch::global_asm!( r#\".section \"{initcall_section}\", \"a\" __{ident}_initcall: .long __{ident}_init - . .previous \"# ); #[cfg(not(MODULE))] #[doc(hidden)] #[no_mangle] pub extern \"C\" fn __{ident}_init() -> ::kernel::ffi::c_int {{ // SAFETY: This function is inaccessible to the outside due to the double // module wrapping it. It is called exactly once by the C side via its // placement above in the initcall section. unsafe {{ __init() }} }} #[cfg(not(MODULE))] #[doc(hidden)] #[no_mangle] pub extern \"C\" fn __{ident}_exit() {{ // SAFETY: // - This function is inaccessible to the outside due to the double // module wrapping it. It is called exactly once by the C side via its // unique name, // - furthermore it is only called after `__{ident}_init` has // returned `0` (which delegates to `__init`). unsafe {{ __exit() }} }} /// # SafetyLines 1–500 of 545. Load more
// SPDX-License-Identifier: GPL-2.0 use crate::helpers::*; use proc_macro::{token_stream, Delimiter, Literal, TokenStream, TokenTree}; use std::fmt::Write; fn expect_string_array(it: &mut token_stream::IntoIter) -> Vec<String> { let group = expect_group(it); assert_eq!(group.delimiter(), Delimiter::Bracket); let mut values = Vec::new(); let mut it = group.stream().into_iter(); while let Some(val) = try_string(&mut it) { assert!(val.is_ascii(), "Expected ASCII string"); values.push(val); match it.next() { Some(TokenTree::Punct(punct)) => assert_eq!(punct.as_char(), ','), None => break, _ => panic!("Expected ',' or end of array"), } } values } struct ModInfoBuilder<'a> { module: &'a str, counter: usize, buffer: String, param_buffer: String, } impl<'a> ModInfoBuilder<'a> { fn new(module: &'a str) -> Self { ModInfoBuilder { module, counter: 0, buffer: String::new(), param_buffer: String::new(), } } fn emit_base(&mut self, field: &str, content: &str, builtin: bool, param: bool) { let string = if builtin { // Built-in modules prefix their modinfo strings by `module.`. format!( "{module}.{field}={content}\0", module = self.module, field = field, content = content ) } else { // Loadable modules' modinfo strings go as-is. format!("{field}={content}\0") }; let buffer = if param { &mut self.param_buffer } else { &mut self.buffer }; write!( buffer, " {cfg} #[doc(hidden)] #[cfg_attr(not(target_os = \"macos\"), link_section = \".modinfo\")] #[used(compiler)] pub static __{module}_{counter}: [u8; {length}] = *{string}; ", cfg = if builtin { "#[cfg(not(MODULE))]" } else { "#[cfg(MODULE)]" }, module = self.module.to_uppercase(), counter = self.counter, length = string.len(), string = Literal::byte_string(string.as_bytes()), ) .unwrap(); self.counter += 1; } fn emit_only_builtin(&mut self, field: &str, content: &str, param: bool) { self.emit_base(field, content, true, param) } fn emit_only_loadable(&mut self, field: &str, content: &str, param: bool) { self.emit_base(field, content, false, param) } fn emit(&mut self, field: &str, content: &str) { self.emit_internal(field, content, false); } fn emit_internal(&mut self, field: &str, content: &str, param: bool) { self.emit_only_builtin(field, content, param); self.emit_only_loadable(field, content, param); } fn emit_param(&mut self, field: &str, param: &str, content: &str) { let content = format!("{param}:{content}", param = param, content = content); self.emit_internal(field, &content, true); } fn emit_params(&mut self, info: &ModuleInfo) { let Some(params) = &info.params else { return; }; for param in params { let ops = param_ops_path(¶m.ptype); // Note: The spelling of these fields is dictated by the user space // tool `modinfo`. self.emit_param("parmtype", ¶m.name, ¶m.ptype); self.emit_param("parm", ¶m.name, ¶m.description); write!( self.param_buffer, " pub(crate) static {param_name}: ::kernel::module_param::ModuleParamAccess<{param_type}> = ::kernel::module_param::ModuleParamAccess::new({param_default}); const _: () = {{ #[link_section = \"__param\"] #[used] static __{module_name}_{param_name}_struct: ::kernel::module_param::KernelParam = ::kernel::module_param::KernelParam::new( ::kernel::bindings::kernel_param {{ name: if ::core::cfg!(MODULE) {{ ::kernel::c_str!(\"{param_name}\").to_bytes_with_nul() }} else {{ ::kernel::c_str!(\"{module_name}.{param_name}\") .to_bytes_with_nul() }}.as_ptr(), // SAFETY: `__this_module` is constructed by the kernel at load // time and will not be freed until the module is unloaded. #[cfg(MODULE)] mod_: unsafe {{ core::ptr::from_ref(&::kernel::bindings::__this_module) .cast_mut() }}, #[cfg(not(MODULE))] mod_: ::core::ptr::null_mut(), ops: core::ptr::from_ref(&{ops}), perm: 0, // Will not appear in sysfs level: -1, flags: 0, __bindgen_anon_1: ::kernel::bindings::kernel_param__bindgen_ty_1 {{ arg: {param_name}.as_void_ptr() }}, }} ); }}; ", module_name = info.name, param_type = param.ptype, param_default = param.default, param_name = param.name, ops = ops, ) .unwrap(); } } } fn param_ops_path(param_type: &str) -> &'static str { match param_type { "i8" => "::kernel::module_param::PARAM_OPS_I8", "u8" => "::kernel::module_param::PARAM_OPS_U8", "i16" => "::kernel::module_param::PARAM_OPS_I16", "u16" => "::kernel::module_param::PARAM_OPS_U16", "i32" => "::kernel::module_param::PARAM_OPS_I32", "u32" => "::kernel::module_param::PARAM_OPS_U32", "i64" => "::kernel::module_param::PARAM_OPS_I64", "u64" => "::kernel::module_param::PARAM_OPS_U64", "isize" => "::kernel::module_param::PARAM_OPS_ISIZE", "usize" => "::kernel::module_param::PARAM_OPS_USIZE", t => panic!("Unsupported parameter type {}", t), } } fn expect_param_default(param_it: &mut token_stream::IntoIter) -> String { assert_eq!(expect_ident(param_it), "default"); assert_eq!(expect_punct(param_it), ':'); let sign = try_sign(param_it); let default = try_literal(param_it).expect("Expected default param value"); assert_eq!(expect_punct(param_it), ','); let mut value = sign.map(String::from).unwrap_or_default(); value.push_str(&default); value } #[derive(Debug, Default)] struct ModuleInfo { type_: String, license: String, name: String, authors: Option<Vec<String>>, description: Option<String>, alias: Option<Vec<String>>, firmware: Option<Vec<String>>, imports_ns: Option<Vec<String>>, params: Option<Vec<Parameter>>, } #[derive(Debug)] struct Parameter { name: String, ptype: String, default: String, description: String, } fn expect_params(it: &mut token_stream::IntoIter) -> Vec<Parameter> { let params = expect_group(it); assert_eq!(params.delimiter(), Delimiter::Brace); let mut it = params.stream().into_iter(); let mut parsed = Vec::new(); loop { let param_name = match it.next() { Some(TokenTree::Ident(ident)) => ident.to_string(), Some(_) => panic!("Expected Ident or end"), None => break, }; assert_eq!(expect_punct(&mut it), ':'); let param_type = expect_ident(&mut it); let group = expect_group(&mut it); assert_eq!(group.delimiter(), Delimiter::Brace); assert_eq!(expect_punct(&mut it), ','); let mut param_it = group.stream().into_iter(); let param_default = expect_param_default(&mut param_it); let param_description = expect_string_field(&mut param_it, "description"); expect_end(&mut param_it); parsed.push(Parameter { name: param_name, ptype: param_type, default: param_default, description: param_description, }) } parsed } impl ModuleInfo { fn parse(it: &mut token_stream::IntoIter) -> Self { let mut info = ModuleInfo::default(); const EXPECTED_KEYS: &[&str] = &[ "type", "name", "authors", "description", "license", "alias", "firmware", "imports_ns", "params", ]; const REQUIRED_KEYS: &[&str] = &["type", "name", "license"]; let mut seen_keys = Vec::new(); loop { let key = match it.next() { Some(TokenTree::Ident(ident)) => ident.to_string(), Some(_) => panic!("Expected Ident or end"), None => break, }; if seen_keys.contains(&key) { panic!("Duplicated key \"{key}\". Keys can only be specified once."); } assert_eq!(expect_punct(it), ':'); match key.as_str() { "type" => info.type_ = expect_ident(it), "name" => info.name = expect_string_ascii(it), "authors" => info.authors = Some(expect_string_array(it)), "description" => info.description = Some(expect_string(it)), "license" => info.license = expect_string_ascii(it), "alias" => info.alias = Some(expect_string_array(it)), "firmware" => info.firmware = Some(expect_string_array(it)), "imports_ns" => info.imports_ns = Some(expect_string_array(it)), "params" => info.params = Some(expect_params(it)), _ => panic!("Unknown key \"{key}\". Valid keys are: {EXPECTED_KEYS:?}."), } assert_eq!(expect_punct(it), ','); seen_keys.push(key); } expect_end(it); for key in REQUIRED_KEYS { if !seen_keys.iter().any(|e| e == key) { panic!("Missing required key \"{key}\"."); } } let mut ordered_keys: Vec<&str> = Vec::new(); for key in EXPECTED_KEYS { if seen_keys.iter().any(|e| e == key) { ordered_keys.push(key); } } if seen_keys != ordered_keys { panic!("Keys are not ordered as expected. Order them like: {ordered_keys:?}."); } info } } pub(crate) fn module(ts: TokenStream) -> TokenStream { let mut it = ts.into_iter(); let info = ModuleInfo::parse(&mut it); // Rust does not allow hyphens in identifiers, use underscore instead. let ident = info.name.replace('-', "_"); let mut modinfo = ModInfoBuilder::new(ident.as_ref()); if let Some(authors) = &info.authors { for author in authors { modinfo.emit("author", author); } } if let Some(description) = &info.description { modinfo.emit("description", description); } modinfo.emit("license", &info.license); if let Some(aliases) = &info.alias { for alias in aliases { modinfo.emit("alias", alias); } } if let Some(firmware) = &info.firmware { for fw in firmware { modinfo.emit("firmware", fw); } } if let Some(imports) = &info.imports_ns { for ns in imports { modinfo.emit("import_ns", ns); } } // Built-in modules also export the `file` modinfo string. let file = std::env::var("RUST_MODFILE").expect("Unable to fetch RUST_MODFILE environmental variable"); modinfo.emit_only_builtin("file", &file, false); modinfo.emit_params(&info); format!( " /// The module name. /// /// Used by the printing macros, e.g. [`info!`]. const __LOG_PREFIX: &[u8] = b\"{name}\\0\"; // SAFETY: `__this_module` is constructed by the kernel at load time and will not be // freed until the module is unloaded. #[cfg(MODULE)] static THIS_MODULE: ::kernel::ThisModule = unsafe {{ extern \"C\" {{ static __this_module: ::kernel::types::Opaque<::kernel::bindings::module>; }} ::kernel::ThisModule::from_ptr(__this_module.get()) }}; #[cfg(not(MODULE))] static THIS_MODULE: ::kernel::ThisModule = unsafe {{ ::kernel::ThisModule::from_ptr(::core::ptr::null_mut()) }}; /// The `LocalModule` type is the type of the module created by `module!`, /// `module_pci_driver!`, `module_platform_driver!`, etc. type LocalModule = {type_}; impl ::kernel::ModuleMetadata for {type_} {{ const NAME: &'static ::kernel::str::CStr = c\"{name}\"; }} // Double nested modules, since then nobody can access the public items inside. mod __module_init {{ mod __module_init {{ use super::super::{type_}; use pin_init::PinInit; /// The \"Rust loadable module\" mark. // // This may be best done another way later on, e.g. as a new modinfo // key or a new section. For the moment, keep it simple. #[cfg(MODULE)] #[doc(hidden)] #[used(compiler)] static __IS_RUST_MODULE: () = (); static mut __MOD: ::core::mem::MaybeUninit<{type_}> = ::core::mem::MaybeUninit::uninit(); // Loadable modules need to export the `{{init,cleanup}}_module` identifiers. /// # Safety /// /// This function must not be called after module initialization, because it may be /// freed after that completes. #[cfg(MODULE)] #[doc(hidden)] #[no_mangle] #[link_section = \".init.text\"] pub unsafe extern \"C\" fn init_module() -> ::kernel::ffi::c_int {{ // SAFETY: This function is inaccessible to the outside due to the double // module wrapping it. It is called exactly once by the C side via its // unique name. unsafe {{ __init() }} }} #[cfg(MODULE)] #[doc(hidden)] #[used(compiler)] #[link_section = \".init.data\"] static __UNIQUE_ID___addressable_init_module: unsafe extern \"C\" fn() -> i32 = init_module; #[cfg(MODULE)] #[doc(hidden)] #[no_mangle] #[link_section = \".exit.text\"] pub extern \"C\" fn cleanup_module() {{ // SAFETY: // - This function is inaccessible to the outside due to the double // module wrapping it. It is called exactly once by the C side via its // unique name, // - furthermore it is only called after `init_module` has returned `0` // (which delegates to `__init`). unsafe {{ __exit() }} }} #[cfg(MODULE)] #[doc(hidden)] #[used(compiler)] #[link_section = \".exit.data\"] static __UNIQUE_ID___addressable_cleanup_module: extern \"C\" fn() = cleanup_module; // Built-in modules are initialized through an initcall pointer // and the identifiers need to be unique. #[cfg(not(MODULE))] #[cfg(not(CONFIG_HAVE_ARCH_PREL32_RELOCATIONS))] #[doc(hidden)] #[link_section = \"{initcall_section}\"] #[used(compiler)] pub static __{ident}_initcall: extern \"C\" fn() -> ::kernel::ffi::c_int = __{ident}_init; #[cfg(not(MODULE))] #[cfg(CONFIG_HAVE_ARCH_PREL32_RELOCATIONS)] ::core::arch::global_asm!( r#\".section \"{initcall_section}\", \"a\" __{ident}_initcall: .long __{ident}_init - . .previous \"# ); #[cfg(not(MODULE))] #[doc(hidden)] #[no_mangle] pub extern \"C\" fn __{ident}_init() -> ::kernel::ffi::c_int {{ // SAFETY: This function is inaccessible to the outside due to the double // module wrapping it. It is called exactly once by the C side via its // placement above in the initcall section. unsafe {{ __init() }} }} #[cfg(not(MODULE))] #[doc(hidden)] #[no_mangle] pub extern \"C\" fn __{ident}_exit() {{ // SAFETY: // - This function is inaccessible to the outside due to the double // module wrapping it. It is called exactly once by the C side via its // unique name, // - furthermore it is only called after `__{ident}_init` has // returned `0` (which delegates to `__init`). unsafe {{ __exit() }} }} /// # Safety