Update copyright dates
[xfstests-dev.git] / dmapi / src / suite2 / README_for_check_dmapi
1 #
2 # Copyright (c) 2000-2001 Silicon Graphics, Inc.  All Rights Reserved.
3
4 # This program is free software; you can redistribute it and/or modify it
5 # under the terms of version 2 of the GNU General Public License as
6 # published by the Free Software Foundation.
7
8 # This program is distributed in the hope that it would be useful, but
9 # WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11
12 # Further, this software is distributed without any warranty that it is
13 # free of the rightful claim of any third person regarding infringement
14 # or the like.  Any license provided herein, whether implied or
15 # otherwise, applies only to this software file.  Patent licenses, if
16 # any, provided herein do not apply to combinations of this program with
17 # other software, or any other product whatsoever.
18
19 # You should have received a copy of the GNU General Public License along
20 # with this program; if not, write the Free Software Foundation, Inc., 59
21 # Temple Place - Suite 330, Boston MA 02111-1307, USA.
22
23 # Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
24 # Mountain View, CA  94043, or:
25
26 # http://www.sgi.com 
27
28 # For further information regarding this notice, see: 
29
30 # http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
31
32 ###  README for check_dmapi  ###
33
34 check_dmapi tests the version of DMAPI library & kernel code.
35
36 command line:  check_dmapi [-v] 
37 (v is a verbose-output flag)
38
39 Functionality:
40
41 1) Ensures that the user is running as root, using getuid().  
42
43 2) Tries to stat() /usr/include/sys/dmi.h to verify its
44    presence and its size.
45
46 3) Verifies the presence of the DMAPI kernel, using a 
47    direct call to dmi().  The call is invalid, so it should
48    return EINVAL if the kernel code is in place, ENOPKG if not.
49
50 4) Determines the status of the kernel (if it is present) using
51    a direct call to dmi().  The call is invalid, and uses an opcode
52    not present in the old kernel.  So ENOSYS means old kernel;
53    EINVAL means new kernel.
54
55 5) Determines the status of the library by calling dm_init_service().
56    If this fails, libraries are missing.  In the old library, this call
57    did not change its "name" parameter, but in the new library it does.
58    Same name means old library; changed name means new library. 
59
60 6) Outputs its findings.