lib/libutil/libutil.h

   1 /*
   2  * Copyright (c) 1996  Peter Wemm <peter@FreeBSD.org>.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, is permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/lib/libutil/libutil.h,v 1.26.2.3 2000/11/22 03:49:49 murray Exp $
  27  * $DragonFly: src/lib/libutil/libutil.h,v 1.5 2004/11/05 17:05:26 dillon Exp $
  28  */
  29
  30 #ifndef _LIBUTIL_H_
  31 #define _LIBUTIL_H_
  32
  33 #include <sys/cdefs.h>
  34
  35 #define PROPERTY_MAX_NAME       64
  36 #define PROPERTY_MAX_VALUE      512
  37
  38 /* for properties.c */
  39 typedef struct _property {
  40         struct _property *next;
  41         char *name;
  42         char *value;
  43 } *properties;
  44
  45 /* Avoid pulling in all the include files for no need */
  46 struct termios;
  47 struct winsize;
  48 struct utmp;
  49 struct in_addr;
  50
  51 __BEGIN_DECLS
  52 void    login (struct utmp *_ut);
  53 int     login_tty (int _fd);
  54 int     logout (const char *_line);
  55 void    logwtmp (const char *_line, const char *_name, const char *_host);
  56 void    trimdomain (char *_fullhost, int _hostsize);
  57 int     openpty (int *_amaster, int *_aslave, char *_name,
  58                      struct termios *_termp, struct winsize *_winp);
  59 int     forkpty (int *_amaster, char *_name,
  60                      struct termios *_termp, struct winsize *_winp);
  61 int     humanize_number(char *_buf, size_t _len, int64_t _number,
  62                const char *_suffix, int _scale, int _flags);
  63 const char *uu_lockerr (int _uu_lockresult);
  64 int     uu_lock (const char *_ttyname);
  65 int     uu_unlock (const char *_ttyname);
  66 int     uu_lock_txfr (const char *_ttyname, pid_t _pid);
  67 int     _secure_path (const char *_path, uid_t _uid, gid_t _gid);
  68 int     pidfile(const char *);
  69 properties properties_read (int fd);
  70 void    properties_free (properties list);
  71 char    *property_find (properties list, const char *name);
  72 char    *auth_getval (const char *name);
  73 int     realhostname (char *host, size_t hsize, const struct in_addr *ip);
  74 struct sockaddr;
  75 int     realhostname_sa (char *host, size_t hsize, struct sockaddr *addr,
  76                              int addrlen);
  77 #ifdef _STDIO_H_        /* avoid adding new includes */
  78 char   *fparseln (FILE *, size_t *, size_t *, const char[3], int);
  79 #endif
  80 __END_DECLS
  81
  82 #define UU_LOCK_INUSE (1)
  83 #define UU_LOCK_OK (0)
  84 #define UU_LOCK_OPEN_ERR (-1)
  85 #define UU_LOCK_READ_ERR (-2)
  86 #define UU_LOCK_CREAT_ERR (-3)
  87 #define UU_LOCK_WRITE_ERR (-4)
  88 #define UU_LOCK_LINK_ERR (-5)
  89 #define UU_LOCK_TRY_ERR (-6)
  90 #define UU_LOCK_OWNER_ERR (-7)
  91
  92 /* return values from realhostname() */
  93 #define HOSTNAME_FOUND          (0)
  94 #define HOSTNAME_INCORRECTNAME  (1)
  95 #define HOSTNAME_INVALIDADDR    (2)
  96 #define HOSTNAME_INVALIDNAME    (3)
  97
  98 /* fparseln(3) */
  99 #define FPARSELN_UNESCESC       0x01
 100 #define FPARSELN_UNESCCONT      0x02
 101 #define FPARSELN_UNESCCOMM      0x04
 102 #define FPARSELN_UNESCREST      0x08
 103 #define FPARSELN_UNESCALL       0x0f
 104
 105 /* humanize_number(3) */
 106 #define HN_DECIMAL              0x01
 107 #define HN_NOSPACE              0x02
 108 #define HN_B                    0x04
 109 #define HN_DIVISOR_1000         0x08
 110 #define HN_GETSCALE             0x10
 111 #define HN_AUTOSCALE            0x20
 112
 113 #endif /* !_LIBUTIL_H_ */