]> git.decadent.org.uk Git - nfs-utils.git/blob - utils/mount/error.c
mount.nfs: Create a common source module for reporting mount errors
[nfs-utils.git] / utils / mount / error.c
1 /*
2  * error.c -- Common error handling functions
3  *
4  * Copyright (C) 2007 Oracle.  All rights reserved.
5  * Copyright (C) 2007 Chuck Lever <chuck.lever@oracle.com>
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public
18  * License along with this program; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 021110-1307, USA.
21  *
22  * To Do:
23  *  + Proper support for internationalization
24  */
25
26 #include "config.h"
27 #include <unistd.h>
28 #include <sys/types.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <errno.h>
32 #include <fcntl.h>
33 #include <syslog.h>
34 #include <rpc/rpc.h>
35 #include <rpc/pmap_prot.h>
36 #include <rpc/pmap_clnt.h>
37
38 #include "xcommon.h"
39 #include "nls.h"
40 #include "mount.h"
41 #include "error.h"
42
43 #ifdef HAVE_RPCSVC_NFS_PROT_H
44 #include <rpcsvc/nfs_prot.h>
45 #else
46 #include <linux/nfs.h>
47 #define nfsstat nfs_stat
48 #endif
49
50 extern char *progname;
51
52 static char errbuf[BUFSIZ];
53 static char *erreob = &errbuf[BUFSIZ];
54
55 /* Convert RPC errors into strings */
56 static int rpc_strerror(int spos)
57 {
58         int cf_stat = rpc_createerr.cf_stat;
59         int pos = 0, cf_errno = rpc_createerr.cf_error.re_errno;
60         char *ptr, *estr = clnt_sperrno(cf_stat);
61         char *tmp;
62
63         if (estr) {
64                 if ((ptr = index(estr, ':')))
65                         estr = ++ptr;
66
67                 tmp = &errbuf[spos];
68                 if (cf_stat == RPC_SYSTEMERROR)
69                         pos = snprintf(tmp, (erreob - tmp),
70                                 "System Error: %s", strerror(cf_errno));
71                 else
72                         pos = snprintf(tmp, (erreob - tmp), "RPC Error:%s", estr);
73         }
74         return pos;
75 }
76
77 void mount_errors(char *server, int will_retry, int bg)
78 {
79         int pos = 0;
80         char *tmp;
81         static int onlyonce = 0;
82
83         tmp = &errbuf[pos];
84         if (bg)
85                 pos = snprintf(tmp, (erreob - tmp),
86                         "mount to NFS server '%s' failed: ", server);
87         else
88                 pos = snprintf(tmp, (erreob - tmp),
89                         "mount: mount to NFS server '%s' failed: ", server);
90
91         tmp = &errbuf[pos];
92         if (rpc_createerr.cf_stat == RPC_TIMEDOUT) {
93                 pos = snprintf(tmp, (erreob - tmp), "timed out %s",
94                         will_retry ? "(retrying)" : "(giving up)");
95         } else {
96                 pos += rpc_strerror(pos);
97                 tmp = &errbuf[pos];
98                 if (bg) {
99                         pos = snprintf(tmp, (erreob - tmp), " %s",
100                                 will_retry ? "(retrying)" : "(giving up)");
101                 }
102         }
103         if (bg) {
104                 if (onlyonce++ < 1)
105                         openlog("mount", LOG_CONS|LOG_PID, LOG_AUTH);
106                 syslog(LOG_ERR, "%s.", errbuf);
107         } else
108                 fprintf(stderr, "%s.\n", errbuf);
109 }
110
111 void mount_error(const char *spec, const char *mount_point, int error)
112 {
113         switch(error) {
114         case ENOTDIR:
115                 nfs_error(_("%s: mount point %s is not a directory"),
116                                 progname, mount_point);
117                 break;
118         case EBUSY:
119                 nfs_error(_("%s: %s is already mounted or busy"),
120                         progname, mount_point);
121                 break;
122         case ENOENT:
123                 if (spec)
124                         nfs_error(_("%s: mounting %s failed, "
125                                 "reason given by server:\n  %s"),
126                                 progname, spec, strerror(error));
127                 else
128                         nfs_error(_("%s: mount point %s does not exist"),
129                                 progname, mount_point);
130                 break;
131         default:
132                 nfs_error(_("%s: %s"),
133                         progname, strerror(error));
134         }
135 }
136
137 /*
138  * Report a failed umount
139  */
140 void umount_error(int err, const char *dev)
141 {
142         switch (err) {
143         case ENXIO:
144                 nfs_error(_("%s: %s: invalid block device"),
145                         progname, dev);
146                 break;
147         case EINVAL:
148                 nfs_error(_("%s: %s: not mounted"),
149                         progname, dev);
150                 break;
151         case EIO:
152                 nfs_error(_("%s: %s: can't write superblock"),
153                         progname, dev);
154                 break;
155         case EBUSY:
156                 nfs_error(_("%s: %s: device is busy"),
157                         progname, dev);
158                 break;
159         case ENOENT:
160                 nfs_error(_("%s: %s: not found"),
161                         progname, dev);
162                 break;
163         case EPERM:
164                 nfs_error(_("%s: %s: must be superuser to umount"),
165                         progname, dev);
166                 break;
167         case EACCES:
168                 nfs_error(_("%s: %s: block devices not permitted on fs"),
169                         progname, dev);
170                 break;
171         default:
172                 nfs_error(_("%s: %s: %s"),
173                         progname, dev, strerror(err));
174                 break;
175         }
176 }
177
178 /*
179  * We need to translate between nfs status return values and
180  * the local errno values which may not be the same.
181  *
182  * Andreas Schwab <schwab@LS5.informatik.uni-dortmund.de>: change errno:
183  * "after #include <errno.h> the symbol errno is reserved for any use,
184  *  it cannot even be used as a struct tag or field name".
185  */
186
187 #ifndef EDQUOT
188 #define EDQUOT  ENOSPC
189 #endif
190
191 static struct {
192         enum nfsstat stat;
193         int errnum;
194 } nfs_errtbl[] = {
195         { NFS_OK,               0               },
196         { NFSERR_PERM,          EPERM           },
197         { NFSERR_NOENT,         ENOENT          },
198         { NFSERR_IO,            EIO             },
199         { NFSERR_NXIO,          ENXIO           },
200         { NFSERR_ACCES,         EACCES          },
201         { NFSERR_EXIST,         EEXIST          },
202         { NFSERR_NODEV,         ENODEV          },
203         { NFSERR_NOTDIR,        ENOTDIR         },
204         { NFSERR_ISDIR,         EISDIR          },
205 #ifdef NFSERR_INVAL
206         { NFSERR_INVAL,         EINVAL          },      /* that Sun forgot */
207 #endif
208         { NFSERR_FBIG,          EFBIG           },
209         { NFSERR_NOSPC,         ENOSPC          },
210         { NFSERR_ROFS,          EROFS           },
211         { NFSERR_NAMETOOLONG,   ENAMETOOLONG    },
212         { NFSERR_NOTEMPTY,      ENOTEMPTY       },
213         { NFSERR_DQUOT,         EDQUOT          },
214         { NFSERR_STALE,         ESTALE          },
215 #ifdef EWFLUSH
216         { NFSERR_WFLUSH,        EWFLUSH         },
217 #endif
218         /* Throw in some NFSv3 values for even more fun (HP returns these) */
219         { 71,                   EREMOTE         },
220
221         { -1,                   EIO             }
222 };
223
224 char *nfs_strerror(int stat)
225 {
226         int i;
227         static char buf[256];
228
229         for (i = 0; nfs_errtbl[i].stat != -1; i++) {
230                 if (nfs_errtbl[i].stat == stat)
231                         return strerror(nfs_errtbl[i].errnum);
232         }
233         sprintf(buf, _("unknown nfs status return value: %d"), stat);
234         return buf;
235 }