Crate kernel

The kernel crate.

This crate contains the kernel APIs that have been ported or wrapped for usage by Rust code in the kernel and is shared by all of them.

In other words, all the rest of the Rust code in the kernel (e.g. kernel modules written in Rust) depends on core and this crate.

If you need a kernel C API that is not ported or wrapped yet here, then do so first instead of bypassing this crate.

Re-exports

• pub use ffi;
• pub use macros;
• pub use uapi;

Modules

• acpi
  Advanced Configuration and Power Interface abstractions.
• alloc
  Implementation of the kernel’s memory allocation infrastructure.
• auxiliary
  Abstractions for the auxiliary bus.
• bitmap
  Rust API for bitmap.
• bits
  Bit manipulation macros.
• block
  Types for working with the block layer.
• bug
  Support for BUG and WARN functionality.
• clk
  Clock abstractions.
• configfs
  configfs interface: Userspace-driven Kernel Object Configuration
• cpu
  Generic CPU definitions.
• cpufreq
  CPU frequency scaling.
• cpumask
  CPU Mask abstractions.
• cred
  Credentials management.
• debugfs
  DebugFS Abstraction
• device
  Generic devices that are part of the kernel’s driver model.
• device_id
  Generic implementation of device IDs.
• devres
  Devres abstraction
• dma
  Direct memory access (DMA).
• driver
  Generic support for drivers of different buses (e.g., PCI, Platform, Amba, etc.).
• drm
  DRM subsystem abstractions.
• error
  Kernel errors.
• faux
  Abstractions for the faux bus.
• firmware
  Firmware abstraction
• fmt
  Formatting utilities.
• fs
  Kernel file systems.
• id_pool
  Rust API for an ID pool backed by a BitmapVec.
• init
  Extensions to the pin-init crate.
• io
  Memory-mapped IO.
• ioctl
  ioctl() number definitions.
• iov
  IO vectors.
• irq
  IRQ abstractions.
• jump_label
  Logic for static keys.
• kunit
  KUnit-based macros for Rust unit tests.
• list
  A linked list implementation.
• maple_tree
  Maple trees.
• miscdevice
  Miscdevice support.
• mm
  Memory management.
• net
  Networking.
• of
  Device Tree / Open Firmware abstractions.
• opp
  Operating performance points.
• page
  Kernel page allocation and management.
• pci
  Abstractions for the PCI bus.
• pid_namespace
  Pid namespaces.
• platform
  Abstractions for the platform bus.
• prelude
  The kernel prelude.
• print
  Printing facilities.
• processor
  Processor related primitives.
• ptr
  Types and functions to work with pointers and addresses.
• rbtree
  Red-black trees.
• regulator
  Regulator abstractions, providing a standard kernel interface to control voltage and current regulators.
• revocable
  Revocable objects.
• scatterlist
  Abstractions for scatter-gather lists.
• security
  Linux Security Modules (LSM).
• seq_file
  Seq file bindings.
• sizes
  Commonly used sizes.
• str
  String representations.
• sync
  Synchronisation primitives.
• task
  Tasks (threads and processes).
• time
  Time related primitives.
• tracepoint
  Logic for tracepoints.
• transmute
  Traits for transmuting types.
• types
  Kernel types.
• uaccess
  Slices to user space memory regions.
• workqueue
  Work queues.
• xarray
  XArray abstraction.

Macros

• acpi_device_table
  Create an ACPI IdTable with an “alias” for modpost.
• asm
  Wrapper around asm! configured for use in the kernel.
• auxiliary_device_table
  Create a auxiliary IdTable with its alias for modpost.
• b_str
  Creates a new BStr from a string literal.
• build_assert
  Asserts that a boolean expression is true at compile time.
• build_error
  Fails the build if the code path calling build_error! can possibly be executed.
• c_str
  Creates a new CStr from a string literal.
• configfs_attrs
  Define a list of configfs attributes statically.
• container_of
  Produces a pointer to an object from a pointer to one of its fields.
• current
  Returns the currently running task.
• dbg
  std::dbg, but using pr_info instead of eprintln.
• declare_drm_ioctls
  Declare the DRM ioctls for a driver.
• declare_trace
  Declare the Rust entry point for a tracepoint.
• define_list_arc_field_getter
  Defines getters for a ListArcField.
• dev_alert
  Prints an alert-level message (level 1) prefixed with device information.
• dev_crit
  Prints a critical-level message (level 2) prefixed with device information.
• dev_dbg
  Prints a debug-level message (level 7) prefixed with device information.
• dev_emerg
  Prints an emergency-level message (level 0) prefixed with device information.
• dev_err
  Prints an error-level message (level 3) prefixed with device information.
• dev_info
  Prints an info-level message (level 6) prefixed with device information.
• dev_notice
  Prints a notice-level message (level 5) prefixed with device information.
• dev_warn
  Prints a warning-level message (level 4) prefixed with device information.
• dma_read
  Reads a field of an item from an allocated region of structs.
• dma_write
  Writes to a field of an item from an allocated region of structs.
• global_lock
  Defines a global lock.
• impl_device_context_deref
  Implement core::ops::Deref traits for allowed DeviceContext conversions of a (bus specific) device.
• impl_device_context_into_aref
  Implement core::convert::From, such that all &Device<Ctx> can be converted to an ARef<Device>.
• impl_has_delayed_work
  Used to safely implement the HasDelayedWork<T, ID> trait.
• impl_has_hr_timer
  Use to implement the HasHrTimer<T> trait.
• impl_has_list_links
  Implements the HasListLinks trait for the given type.
• impl_has_list_links_self_ptr
  Implements the HasListLinks and HasSelfPtr traits for the given type.
• impl_has_work
  Used to safely implement the HasWork<T, ID> trait.
• impl_list_arc_safe
  Declares that this type supports ListArc.
• impl_list_item
  Implements the ListItem trait for the given type.
• kvec
  Create a KVec containing the arguments.
• module_auxiliary_driver
  Declares a kernel module that exposes a single auxiliary driver.
• module_device_table
  Create device table alias for modpost.
• module_driver
  Declares a kernel module that exposes a single driver.
• module_firmware
  Create firmware .modinfo entries.
• module_pci_driver
  Declares a kernel module that exposes a single PCI driver.
• module_phy_driver
  Declares a kernel module for PHYs drivers.
• module_platform_driver
  Declares a kernel module that exposes a single platform driver.
• new_condvar
  Creates a CondVar initialiser with the given name and a newly-created lock class.
• new_delayed_work
  Creates a DelayedWork initialiser with the given name and a newly-created lock class.
• new_mutex
  Creates a Mutex initialiser with the given name and a newly-created lock class.
• new_poll_condvar
  Creates a PollCondVar initialiser with the given name and a newly-created lock class.
• new_spinlock
  Creates a SpinLock initialiser with the given name and a newly-created lock class.
• new_work
  Creates a Work initialiser with the given name and a newly-created lock class.
• of_device_table
  Create an OF IdTable with an “alias” for modpost.
• pci_device_table
  Create a PCI IdTable with its alias for modpost.
• pr_alert
  Prints an alert-level message (level 1).
• pr_cont
  Continues a previous log message in the same line.
• pr_crit
  Prints a critical-level message (level 2).
• pr_debug
  Prints a debug-level message (level 7).
• pr_emerg
  Prints an emergency-level message (level 0).
• pr_err
  Prints an error-level message (level 3).
• pr_info
  Prints an info-level message (level 6).
• pr_notice
  Prints a notice-level message (level 5).
• pr_warn
  Prints a warning-level message (level 4).
• seq_print
  Write to a SeqFile with the ordinary Rust formatting syntax.
• static_assert
  Static assert (i.e. compile-time assert).
• static_branch_unlikely
  Branch based on a static key.
• try_init
  Construct an in-place fallible initializer for structs.
• try_pin_init
  Construct an in-place, fallible pinned initializer for structs.
• warn_on
  Report a warning if cond is true and return the condition’s evaluation result.

Structs

• ThisModule
  Equivalent to THIS_MODULE in the C API.

Traits

• InPlaceModule
  A module that is pinned and initialised in-place.
• Module
  The top level entrypoint to implementing a kernel module.
• ModuleMetadata
  Metadata attached to a Module or InPlaceModule.

Functions

• file_from_location
  Gets the C string file name of a Location.