libmpathpersist: Fix possible overrun in devt2devname()
[multipath-tools/.git] / libmpathpersist / mpath_persistent_reserve_in.3
1 .\"
2 .TH MPATH_PERSISTENT_RESERVE_IN 3  2011-04-08 "Linux Manpage" 
3 .SH NAME
4 mpath_persistent_reserve_in
5 .SH SYNOPSIS
6 .B #include <mpath_persist.h>
7 .sp
8 .BI "int mpath_persistent_reserve_in (int fd, int rq_servact, struct prin_resp *resp, int noisy, int verbose)"
9 .sp
10 .SH DESCRIPTION
11 The function in the
12 .BR mpath_persistent_reserve_in ()
13 sends PRIN command to the DM device and gets the response.
14 .br
15 .BI Parameters:
16 .br
17 .I fd
18 .B The file descriptor of a multipath device. Input argument.
19 .br
20 .I rq_servact
21 .B PRIN command service action. Input argument
22 .br
23 .I resp
24 .B The response from PRIN service action. The caller should manage the memory allocation of this structure
25 .br
26 .I noisy
27 .B Turn on debugging trace: Input argument. 0->Disable, 1->Enable
28 .br
29 .I verbose
30 .B Set verbosity level. Input argument. value:[0-3]. 0->Crits and Errors, 1->Warnings, 2->Info, 3->Debug
31 .br
32
33 .SH "RETURNS"
34 .I MPATH_PR_SUCCESS
35 .B if PR command successful
36 .br
37 .I MPATH_PR_SYNTAX_ERROR        
38 .B if  syntax error or invalid parameter
39 .br
40 .I MPATH_PR_SENSE_NOT_READY     
41 .B  if command fails with [sk,asc,ascq: 0x2,*,*]
42 .br
43 .I MPATH_PR_SENSE_MEDIUM_ERROR
44 .B  if command fails with [sk,asc,ascq: 0x3,*,*]
45 .br
46 .I MPATH_PR_SENSE_HARDWARE_ERROR
47 .B  if command fails with [sk,asc,ascq: 0x4,*,*]
48 .br
49 .I MPATH_PR_SENSE_INVALID_OP
50 .B  if command fails with [sk,asc,ascq: 0x5,0x20,0x0]
51 .br
52 .I MPATH_PR_ILLEGAL_REQ
53 .B  if command fails with [sk,asc,ascq: 0x5,*,*]
54 .br
55 .I MPATH_PR_SENSE_UNIT_ATTENTION
56 .B  if command fails with [sk,asc,ascq: 0x6,*,*]
57 .br
58 .I MPATH_PR_SENSE_ABORTED_COMMAND
59 .B  if command fails with [sk,asc,ascq: 0xb,*,*]
60 .br
61 .I MPATH_PR_NO_SENSE
62 .B  if command fails with [sk,asc,ascq: 0x0,*,*]
63 .br
64 .I MPATH_PR_SENSE_MALFORMED  
65 .B if command fails with SCSI command malformed
66 .br
67 .I MPATH_PR_FILE_ERROR
68 .B if command fails while accessing file (device node) problems(e.g. not found)
69 .br
70 .I MPATH_PR_DMMP_ERROR
71 .B if Device Mapper related error.(e.g Error in getting dm info) 
72 .br
73 .I MPATH_PR_OTHER
74 .B if other error/warning has occurred(e.g transport or driver error)
75 .br
76
77
78 .SH "SEE ALSO"
79 .I  mpath_persistent_reserve_out      mpathpersist     /usr/share/doc/mpathpersist/README
80 .br