Copyright (c) 2004 Pawel Jakub Dawidek <pjd@FreeBSD.org> All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the d...
NAMEg_wither_geom - destroy geom and related providers and consumers when you get a chance
SYNOPSISIn geom/geom.h Ft void Fn g_wither_geom struct g_geom *gp int error
DESCRIPTIONThe Fn g_wither_geom function tells GEOM that geom Fa gp is to be destroyed. GEOM sets an error on each provider of the given geom (in the orphaning process) and waits for a chance to destroy the geom. If the access count of any possessed consumer goes to 0, the consumer will be detached and destroyed automatically. If the last consumer attached to any possessed provider will be detached, the provider will be destroyed. If there are no more providers nor consumers, the geom will be destroyed.
This is an automatic ``garbage collect'' to avoid duplicated code in all classes. Before it is called, field softc should be disposed of and set to NULL Note that the Fn g_wither_geom function gives no guarantee that the geom will be immediately destroyed, mostly because the access counts of the geom's consumers and providers may not be 0. That is why calling this function for every geom from a given class is not enough to be sure that the class can be unloaded.
RESTRICTIONS/CONDITIONSThe argument Fa error must be nonzero.
The topology lock has to be held.