/*
 * Copyright (c) 1996  Peter Wemm <peter@FreeBSD.org>.
 * All rights reserved.
 * Copyright (c) 2002 Networks Associates Technology, Inc.
 * All rights reserved.
 *
 * Portions of this software were developed for the FreeBSD Project by
 * ThinkSec AS and NAI Labs, the Security Research Division of Network
 * Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
 * ("CBOSS"), as part of the DARPA CHATS research program.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, is 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.
 * 3. The name of the author may not be used to endorse or promote
 *    products derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
 *
 * $FreeBSD: head/lib/libutil/libutil.h 247919 2013-03-07 19:00:00Z db $
 */

#ifndef _LIBUTIL_H_
#define _LIBUTIL_H_

#include <sys/types.h>

#ifdef _PWD_H_
#define _PWSCAN_MASTER  0x01
#define _PWSCAN_WARN    0x02
#endif

#define PROPERTY_MAX_NAME       64
#define PROPERTY_MAX_VALUE      512

/* For properties.c. */
typedef struct _property {
        struct _property *next;
        char    *name;
        char    *value;
} *properties;

/* Avoid pulling in all the include files for no need. */
struct in_addr;
struct pidfh;
struct sockaddr;
struct termios;
struct winsize;
struct utmpx;

__BEGIN_DECLS
char    *auth_getval(const char *_name);
void    loginx(const struct utmpx *);
int     login_tty(int);
int     logoutx(const char *, int, int);
void    logwtmpx(const char *, const char *, const char *, int, int);
void    trimdomain(char *, int);
int     flopen(const char *_path, int _flags, ...);
int     forkpty(int *_amaster, char *_name,
            struct termios *_termp, struct winsize *_winp);
int     dehumanize_number(const char *, int64_t *);
void    hexdump(const void *_ptr, int _length, const char *_hdr, int _flags);
int     humanize_number(char *_buf, size_t _len, int64_t _number,
            const char *_suffix, int _scale, int _flags);
int     humanize_unsigned(char *buf, size_t len, uint64_t bytes,
                                        const char *suffix, int divisor);
int     format_bytes(char *buf, size_t len, uint64_t bytes);
const char *uu_lockerr(int);
int     uu_lock(const char *);
int     uu_unlock(const char *);
int     uu_lock_txfr(const char *, pid_t);
int     _secure_path(const char *, uid_t, gid_t);
int     openpty(int *_amaster, int *_aslave, char *_name,
            struct termios *_termp, struct winsize *_winp);
int     pidfile_close(struct pidfh *_pfh);
int     pidfile_fileno(const struct pidfh *_pfh);
struct pidfh *
        pidfile_open(const char *_path, mode_t _mode, pid_t *_pidptr);
int     pidfile_remove(struct pidfh *_pfh);
int     pidfile_write(struct pidfh *_pfh);
void    properties_free(properties _list);
char    *property_find(properties _list, const char *_name);
properties
        properties_read(int fd);
int     realhostname(char *, size_t, const struct in_addr *);
int     realhostname_sa(char *, size_t, struct sockaddr *, int);
int     sockaddr_snprintf(char *, size_t, const char *,
            const struct sockaddr *);
int     snprintb(char *buf, size_t buflen, const char *bitfmt, uint64_t val);
int     snprintb_m(char *buf, size_t buflen, const char *bitfmt, uint64_t val,
            size_t l_max);

#ifdef _PWD_H_
int     pw_copy(int _ffd, int _tfd, const struct passwd *_pw,
            struct passwd *_old_pw);
struct passwd
        *pw_dup(const struct passwd *_pw);
int     pw_edit(int _notsetuid);
int     pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
void    pw_fini(void);
int     pw_init(const char *_dir, const char *_master);
char    *pw_make(const struct passwd *_pw);
char    *pw_make_v7(const struct passwd *_pw);
int     pw_mkdb(const char *_user);
int     pw_lock(void);
struct passwd *
        pw_scan(const char *_line, int _flags);
const char *
        pw_tempname(void);
int     pw_tmp(int _mfd);
#endif

#ifdef _GRP_H_
int     gr_copy(int __ffd, int _tfd, const struct group *_gr,
            struct group *_old_gr);
struct group *
        gr_dup(const struct group *_gr);
struct group *
        gr_add(const struct group *_gr, const char *_newmember);
int     gr_equal(const struct group *_gr1, const struct group *_gr2);
void    gr_fini(void);
int     gr_init(const char *_dir, const char *_master);
int     gr_lock(void);
char    *gr_make(const struct group *_gr);
int     gr_mkdb(void);
struct group *
        gr_scan(const char *_line);
int     gr_tmp(int _mdf);
#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

/* Flags for hexdump(3). */
#define HD_COLUMN_MASK          0xff
#define HD_DELIM_MASK           0xff00
#define HD_OMIT_COUNT           (1 << 16)
#define HD_OMIT_HEX             (1 << 17)
#define HD_OMIT_CHARS           (1 << 18)

/* Values for humanize_number(3)'s flags parameter. */
#define HN_DECIMAL              0x01
#define HN_NOSPACE              0x02
#define HN_B                    0x04
#define HN_DIVISOR_1000         0x08
#define HN_IEC_PREFIXES         0x10
#define HN_FRACTIONAL           0x20

/* Values for humanize_number(3)'s scale parameter. */
#define HN_GETSCALE             0x10
#define HN_AUTOSCALE            0x20

/* Return values from realhostname(). */
#define HOSTNAME_FOUND          0
#define HOSTNAME_INCORRECTNAME  1
#define HOSTNAME_INVALIDADDR    2
#define HOSTNAME_INVALIDNAME    3

/* Flags for pw_scan(). */
#define PWSCAN_MASTER           0x01
#define PWSCAN_WARN             0x02

/* Return values from uu_lock(). */
#define UU_LOCK_INUSE           1
#define UU_LOCK_OK              0
#define UU_LOCK_OPEN_ERR        (-1)
#define UU_LOCK_READ_ERR        (-2)
#define UU_LOCK_CREAT_ERR       (-3)
#define UU_LOCK_WRITE_ERR       (-4)
#define UU_LOCK_LINK_ERR        (-5)
#define UU_LOCK_TRY_ERR         (-6)
#define UU_LOCK_OWNER_ERR       (-7)

#endif /* !_LIBUTIL_H_ */