Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help
kmupdate(1M)							  kmupdate(1M)

       kmupdate	- update default kernel, or update specified kernel modules.


       -M module_name module_name]...]


       is  used	to update the default kernel and its associated	component set,
       to update only the specified loadable kernel modules, or	 to  remove  a
       kernel and associated component set from	the system.

   Updating the	Kernel
       The  first  form	 of is used to schedule	the move of a main kernel file
       and all the associated kernel component set files to their default  lo-
       cations during the next system shutdown or startup.  For	any given ker-
       nel, the	kernel_name corresponds	to the name of the main	 kernel	 file,
       which  contains	the  static  portion of	the kernel.  If	not specified,
       uses as the main	kernel file to update to the default

       Each kernel configured via the config(1M) command is composed  of  sev-
       eral  distributed files which are all required for a kernel to boot and
       run properly.  The main kernel file  is	associated  to	its  component
       files  via  a Kernel ID String (KIS) in the main	kernel image.  For any
       given kernel, all the files required by the boot	loader need to be  ac-
       cessible	 from  the directory, where KIS	uniquely identifies the	kernel
       being booted.  also initiates the process of  creating  and  populating
       for the specified kernel.  This means that is a step to be able to suc-
       cessfully boot a	newly configured kernel.

       is often	called indirectly from the config(1M) command line via the op-

   Updating Specified Loadable Kernel Modules
       supports	 updating  a  specified	 loadable kernel module	immediately or
       asynchronously.	A module update	is essential to	make the kernel	 aware
       of  a  newly generated loadable image.  A module	update includes	regis-
       tering the module with the kernel, making it ready to load.

       A successful immediate kernel module update registers the loadable mod-
       ule  with the running kernel and	performs module	type specific initial-
       ization,	if required, without the need to reboot	the system.  If	an ex-
       isting  module_name  is	currently  registered with the running kernel,
       tries to	unregister it, and register the	newly generated	 loadable  im-
       age,  leaving it	in the same load state as the previous loadable	image.
       That is,	if an existing module_name is loaded, a	 successful  immediate
       update will leave the newly generated loadable image loaded.  If	an ex-
       isting module_name is registered, but not loaded, a successful  immedi-
       ate  update  will  leave	 the newly generated loadable image registered
       with the	running	kernel,	but unloaded.  If cannot successfully unregis-
       ter  the	 existing  module_name	(because  it is	busy and cannot	be un-
       loaded, for example), the immediate update is unsuccessful.

       An asynchronous kernel module update schedules the  module  update  for
       the next	system reboot.	When the system	shuts down, the	module's load-
       able image is moved into	place.	When the system	is restarted, the mod-
       ule  is registered with the kernel, and any required type specific ini-
       tialization is performed.

       Update the specified
	    module_name	module.	 Without or will attempt to update module_name
	    immediately.   If  module_name  cannot be updated immediately, the
	    module will	be scheduled for asynchronous update.

       When specified,
	    will only attempt an immediate kernel module update	of the	speci-
	    fied  module.   If	the module cannot be updated immediately, will
	    exit with an error.

       When specified,
	    will schedule the module for asynchronous update without  attempt-
	    ing	an immediate update.

       When specified,
	    will unschedule a previously scheduled asynchronous	update.

       Remove the specified kernel from	the system.
	    This  will	remove	from the system	the specified main kernel file
	    and	all the	files in the associated	kernel component set.  All the
	    necessary cleanup is performed.

       is  a required step after a whole kernel	configuration [see config(1M)]
       to be able to successfully boot a newly configured kernel.  Overwriting
       or  replacing  the  kernel file and associated component	set using com-
       mands like or should be avoided,	because	this will result  in  orphaned
       kernel component	files.

       is a required step after	a kernel module	configuration [see config(1M)]
       to register the module with the kernel, which makes it  ready  to  load
       either by demand	or by the auto load DLKM mechanism.

       returns 0 upon normal completion, and 1 if an error occurred.

       Messages	that notify an update is successful are	sent to	stdout.	 Error
       messages	are sent to stderr.

       Default main kernel file.

       Main kernel file	for kernel named kernel_name.

       Directory containing DLKM-related elements of the kernel	component set.
	      (KIS is the Kernel ID string in the corresponding	kernel image).

       Kernel-specific kernel registry file.  Element of the kernel  component
       set that	contains
	      kernel-specific  configuration data persistent across system re-
	      boot.  (KIS is the Kernel	ID string in the corresponding	kernel

       Directory  that	contains  links	 to  all files in the kernel component
       files that
	      are required by the boot loader during the process of booting  a
	      kernel with Kernel ID String KIS.

       mk_kernel(1M), config(1M), kmadmin(1M), kmpath(1M), kmmodreg(1M).



Want to link to this manual page? Use this URL:

home | help