te
 Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
 The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
 You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
 When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
 FSTYP_MOD_INIT 3FSTYP "Jun 29, 2006"
 NAME
fstyp_mod_init, fstyp_mod_fini, fstyp_mod_ident, fstyp_mod_get_attr,
fstyp_mod_dump - libfstyp module interface

 SYNOPSIS


cc [ flag.\|.\|. ] file.\|.\|. -lfstyp  -lnvpair  [ library.\|.\|. ]
#include <libnvpair.h>
#include <libfstyp.h>

int fstyp_mod_init(int fd, off64_t **offset, fstyp_mod_handle_t *handle);






void fstyp_mod_fini(fstyp_mod_handle_t handle);






int fstyp_mod_ident(fstyp_mod_handle_t handle);






int fstyp_mod_get_attr(fstyp_mod_handle_t handle, nvlist_t **attr);






int fstyp_mod_dump(fstyp_mod_handle_t handle, FILE *fout, FILE *ferr);




 PARAMETERS
fd


Open file descriptor of a block or a raw device that contains the file system
to be identified.



offset


Offset from the beginning of the device where the file system is located.



handle


Opaque handle that the module returns in fstyp_mod_init() and is used
with other module functions.



fout


Output stream.



ferr


Error stream.




 DESCRIPTION

A libfstyp module implements heuristics required to identify a file
system type. The modules are shared objects loaded by libfstyp. The
libfstyp modules are located in /usr/lib/fs subdirectories. A
subdirectory name defines the name of the file system.


Each module exports the fstyp_mod_init(), fstyp_mod_fini(),
fstyp_mod_ident(), and fstyp_mod_get_attr() functions. All of these
functions map directly to the respective libfstyp interfaces.


The fstyp_mod_dump() function is optional. It can be used to output
unformatted information about the file system. This function is used by the
fstyp(1M) command when the -v option is specified. The
fstyp_mod_dump() function is not recommended and should be used only in
legacy modules.

 FILES
/usr/lib/fs/


Default module directory.



/usr/lib/fs/fstype/fstyp.so.1


Default path to a libfstyp module for an fstype file system.




 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:






ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level MT-Safe



 SEE ALSO

fstyp(1M), fstyp_strerror(3FSTYP), libfstyp(3LIB),
attributes(5)