libutil -- Import error functions from NetBSD.
authorVenkatesh Srinivas <me@endeavour.zapto.org>
Tue, 26 Apr 2011 12:18:54 +0000 (05:18 -0700)
committerVenkatesh Srinivas <me@endeavour.zapto.org>
Tue, 26 Apr 2011 12:18:54 +0000 (05:18 -0700)
lib/libutil/Makefile
lib/libutil/efun.3 [new file with mode: 0644]
lib/libutil/efun.c [new file with mode: 0644]
lib/libutil/libutil.h

index a5fdef6..5a521d0 100644 (file)
@@ -11,7 +11,8 @@ SRCS= flopen.c login.c login_tty.c logout.c logwtmp.c logwtmpx.c pty.c \
        login_crypt.c loginx.c logoutx.c _secure_path.c uucplock.c \
        property.c auth.c \
        realhostname.c fparseln.c stub.c pidfile.c trimdomain.c \
-       dehumanize_number.c humanize_number.c humanize_unsigned.c pw_util.c
+       dehumanize_number.c humanize_number.c humanize_unsigned.c pw_util.c \
+       efun.c
 INCS=  libutil.h login_cap.h
 WARNS?=        3
 
@@ -22,7 +23,8 @@ MAN+= flopen.3 login.3 loginx.3 login_auth.3 login_tty.3 logout.3 logwtmp.3 \
        login_cap.3 login_class.3 login_times.3 login_ok.3 \
        _secure_path.3 uucplock.3 property.3 auth.3 realhostname.3 \
        realhostname_sa.3 trimdomain.3 fparseln.3 pidfile.3 \
-       humanize_number.3 humanize_unsigned.3
+       humanize_number.3 humanize_unsigned.3 \
+       efun.3
 MAN+=  login.conf.5 auth.conf.5
 MLINKS+= property.3 properties_read.3  property.3 properties_free.3
 MLINKS+= property.3 property_find.3
diff --git a/lib/libutil/efun.3 b/lib/libutil/efun.3
new file mode 100644 (file)
index 0000000..3ede357
--- /dev/null
@@ -0,0 +1,114 @@
+.\"     $NetBSD: efun.3,v 1.10 2010/05/03 05:40:37 jruoho Exp $
+.\"
+.\" Copyright (c) 2006 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Christos Zoulas.
+.\"
+.\" 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
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd April 26, 2011
+.Dt EFUN 3
+.Os
+.Sh NAME
+.Nm esetfunc ,
+.Nm emalloc ,
+.Nm ecalloc ,
+.Nm erealloc ,
+.Nm estrdup ,
+.Nm estrndup ,
+.Nm estrlcat ,
+.Nm estrlcpy ,
+.Nm evasprintf
+.Nd error-checked utility functions
+.Sh LIBRARY
+.Lb libutil
+.Sh SYNOPSIS
+.In libutil.h
+.Ft void (*)(int, const char *, ...)
+.Fn esetfunc "void (*)(int, const char *, ...)"
+.Ft void *
+.Fn ecalloc "size_t n" "size_t c"
+.Ft void *
+.Fn emalloc "size_t n"
+.Ft void *
+.Fn erealloc "void *p" "size_t n"
+.Ft char *
+.Fn estrdup "const char *s"
+.Ft char *
+.Fn estrndup "const char *s" "size_t len"
+.Ft size_t
+.Fn estrlcat "char *dst" "const char *src" "size_t len"
+.Ft size_t
+.Fn estrlcpy "char *dst" "const char *src" "size_t len"
+.Ft int
+.Fn evasprintf "char ** restrict str" "const char * restrict fmt" "..."
+.Sh DESCRIPTION
+The
+.Fn ecalloc ,
+.Fn emalloc ,
+.Fn erealloc ,
+.Fn estrdup ,
+.Fn estrndup ,
+.Fn estrlcat ,
+.Fn estrlcpy ,
+and
+.Fn evasprintf
+functions
+operate exactly as the corresponding functions that do not start with an
+.Sq e
+except that in case of an error, they call
+the installed error handler that can be configured with
+.Fn esetfunc .
+.Pp
+For the string handling functions, it is an error when the destination
+buffer is not large enough to hold the complete string.
+For functions that allocate memory or open a file, it is an error when
+they would return a null pointer.
+The default error handler is
+.Xr err 3 .
+The function
+.Fn esetfunc
+returns the previous error handler function.
+A
+.Dv NULL
+error handler will just call
+.Xr exit 3 .
+.Sh HISTORY
+The error functions first appeared in 
+.Dx 2.11 .
+They are originally from
+.Nx .
+.Sh SEE ALSO
+.Xr asprintf 3 ,
+.Xr calloc 3 ,
+.Xr err 3 ,
+.Xr exit 3 ,
+.Xr fopen 3 ,
+.Xr malloc 3 ,
+.Xr realloc 3 ,
+.Xr strdup 3 ,
+.Xr strlcat 3 ,
+.Xr strlcpy 3 ,
+.Xr strndup 3 ,
+.Xr vasprintf 3
diff --git a/lib/libutil/efun.c b/lib/libutil/efun.c
new file mode 100644 (file)
index 0000000..0f75b29
--- /dev/null
@@ -0,0 +1,133 @@
+/*     $NetBSD: efun.c,v 1.6 2008/04/28 20:23:02 martin Exp $  */
+
+/*-
+ * Copyright (c) 2006 The NetBSD Foundation, Inc.
+ * All rights reserved.
+ *
+ * This code is derived from software contributed to The NetBSD Foundation
+ * by Christos Zoulas.
+ *
+ * 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
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <sys/cdefs.h>
+#include <err.h>
+#include <errno.h>
+#include <string.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <stdarg.h>
+#include <libutil.h>
+
+static void (*efunc)(int, const char *, ...) = err;
+
+void (*
+esetfunc(void (*ef)(int, const char *, ...)))(int, const char *, ...)
+{
+       void (*of)(int, const char *, ...) = efunc;
+       efunc = ef == NULL ? (void (*)(int, const char *, ...))exit : ef;
+       return of;
+}
+
+size_t
+estrlcpy(char *dst, const char *src, size_t len)
+{
+       size_t rv;
+       if ((rv = strlcpy(dst, src, len)) >= len) {
+               errno = ENAMETOOLONG;
+               (*efunc)(1,
+                   "Cannot copy string; %zu chars needed %zu provided",
+                   rv, len);
+       }
+       return rv;
+}
+
+size_t
+estrlcat(char *dst, const char *src, size_t len)
+{
+       size_t rv;
+       if ((rv = strlcat(dst, src, len)) >= len) {
+               errno = ENAMETOOLONG;
+               (*efunc)(1,
+                   "Cannot append to string; %zu chars needed %zu provided",
+                   rv, len);
+       }
+       return rv;
+}
+
+char *
+estrdup(const char *s)
+{
+       char *d = strdup(s);
+       if (d == NULL)
+               (*efunc)(1, "Cannot copy string");
+       return d;
+}
+
+char *
+estrndup(const char *s, size_t len)
+{
+       char *d = strndup(s, len);
+       if (d == NULL)
+               (*efunc)(1, "Cannot copy string");
+       return d;
+}
+
+void *
+emalloc(size_t n)
+{
+       void *p = malloc(n);
+       if (p == NULL)
+               (*efunc)(1, "Cannot allocate %zu bytes", n);
+       return p;
+}
+
+void *
+ecalloc(size_t n, size_t s)
+{
+       void *p = calloc(n, s);
+       if (p == NULL)
+               (*efunc)(1, "Cannot allocate %zu bytes", n);
+       return p;
+}
+
+void *
+erealloc(void *p, size_t n)
+{
+       void *q = realloc(p, n);
+       if (q == NULL)
+               (*efunc)(1, "Cannot re-allocate %zu bytes", n);
+       return q;
+}
+
+int
+easprintf(char ** __restrict ret, const char * __restrict format, ...)
+{
+       int rv;
+       va_list ap;
+       va_start(ap, format);
+       if ((rv = vasprintf(ret, format, ap)) == -1)
+               (*efunc)(1, "Cannot format string");
+       va_end(ap);
+       return rv;
+}
+
index c79b25e..7e1492d 100644 (file)
@@ -34,7 +34,6 @@
  * SUCH DAMAGE.
  *
  * $FreeBSD: src/lib/libutil/libutil.h,v 1.26.2.3 2000/11/22 03:49:49 murray Exp $
- * $DragonFly: src/lib/libutil/libutil.h,v 1.8 2008/09/14 20:04:59 swildner Exp $
  */
 
 #ifndef _LIBUTIL_H_
@@ -110,6 +109,19 @@ struct passwd *pw_scan(const char *_line, int _flags);
 const char *pw_tempname(void);
 int    pw_tmp(int _mfd);
 #endif
+
+/* Error checked functions */
+void           (*esetfunc(void (*)(int, const char *, ...)))
+               (int, const char *, ...);
+size_t         estrlcpy(char *, const char *, size_t);
+size_t         estrlcat(char *, const char *, size_t);
+char           *estrdup(const char *);
+char           *estrndup(const char *, size_t);
+void           *ecalloc(size_t, size_t);
+void           *emalloc(size_t);
+void           *erealloc(void *, size_t);
+int            easprintf(char ** __restrict, const char * __restrict, ...)
+               __printflike(2, 3);
 __END_DECLS
 
 #define UU_LOCK_INUSE (1)