1/* $NetBSD: util.h,v 1.70.2.1 2025/12/20 13:51:19 martin Exp $ */
2
3/*-
4 * Copyright (c) 1995
5 * The Regents of the University of California. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _UTIL_H_
33#define _UTIL_H_
34
35#include <sys/cdefs.h>
36#include <sys/types.h>
37#include <sys/ansi.h>
38#include <sys/inttypes.h>
39#include <sys/featuretest.h>
40
41#ifdef _BSD_TIME_T_
42typedef _BSD_TIME_T_ time_t;
43#undef _BSD_TIME_T_
44#endif
45#ifdef _BSD_SIZE_T_
46typedef _BSD_SIZE_T_ size_t;
47#undef _BSD_SIZE_T_
48#endif
49
50#if defined(_POSIX_C_SOURCE)
51#ifndef __VA_LIST_DECLARED
52typedef __va_list va_list;
53#define __VA_LIST_DECLARED
54#endif
55#endif
56
57#define PIDLOCK_NONBLOCK 1
58#define PIDLOCK_USEHOSTNAME 2
59
60#define PW_POLICY_BYSTRING 0
61#define PW_POLICY_BYPASSWD 1
62#define PW_POLICY_BYGROUP 2
63
64/* Definitions for the strpct() functions rounding modes */
65#define STRPCT_RTN 0U /* Round to nearest */
66#define STRPCT_RAZ 2U /* Round away from zero */
67#define STRPCT_RTZ 3U /* Round towards zero */
68#define STRPCT_RTI 6U /* Round towards +Inf */
69#define STRPCT_RAI 7U /* Round away from +Inf (to -Inf) */
70/* Do not alter those 5 values, the implementation depends upon them */
71#define STRPCT_RQRY 8U /* Any value not one of the above */
72
73__BEGIN_DECLS
74struct disklabel;
75struct iovec;
76struct passwd;
77struct termios;
78struct utmp;
79struct utmpx;
80struct winsize;
81struct sockaddr;
82
83char *flags_to_string(unsigned long, const char *);
84pid_t forkpty(int *, char *, struct termios *, struct winsize *);
85const char *getbootfile(void);
86int getbyteorder(void);
87off_t getlabeloffset(void);
88int getlabelsector(void);
89int getlabelusesmbr(void);
90int getmaxpartitions(void);
91int getrawpartition(void);
92const char *getdiskrawname(char *, size_t, const char *);
93const char *getdiskcookedname(char *, size_t, const char *);
94const char *getfstypename(int);
95const char *getfsspecname(char *, size_t, const char *);
96struct kinfo_vmentry *kinfo_getvmmap(pid_t, size_t *);
97#ifndef __LIBC12_SOURCE__
98void login(const struct utmp *) __RENAME(__login50);
99void loginx(const struct utmpx *) __RENAME(__loginx50);
100#endif
101int login_tty(int);
102int logout(const char *);
103int logoutx(const char *, int, int);
104void logwtmp(const char *, const char *, const char *);
105void logwtmpx(const char *, const char *, const char *, int, int);
106int opendisk(const char *, int, char *, size_t, int);
107int opendisk1(const char *, int, char *, size_t, int,
108 int (*)(const char *, int, ...));
109int openpty(int *, int *, char *, struct termios *,
110 struct winsize *);
111#ifndef __LIBC12_SOURCE__
112time_t parsedate(const char *, const time_t *, const int *)
113 __RENAME(__parsedate50);
114#endif
115int pidfile(const char *);
116pid_t pidfile_lock(const char *);
117pid_t pidfile_read(const char *);
118int pidfile_clean(void);
119int pidlock(const char *, int, pid_t *, const char *);
120int pw_abort(void);
121#ifndef __LIBC12_SOURCE__
122void pw_copy(int, int, struct passwd *, struct passwd *)
123 __RENAME(__pw_copy50);
124int pw_copyx(int, int, struct passwd *, struct passwd *,
125 char *, size_t) __RENAME(__pw_copyx50);
126#endif
127void pw_edit(int, const char *);
128__dead void pw_error(const char *, int, int);
129void pw_getconf(char *, size_t, const char *, const char *);
130#ifndef __LIBC12_SOURCE__
131void pw_getpwconf(char *, size_t, const struct passwd *,
132 const char *) __RENAME(__pw_getpwconf50);
133#endif
134const char *pw_getprefix(void);
135void pw_init(void);
136int pw_lock(int);
137int pw_mkdb(const char *, int);
138void pw_prompt(void);
139int pw_setprefix(const char *);
140int raise_default_signal(int);
141int secure_path(const char *);
142int snprintb_m(char *, size_t, const char *, uint64_t, size_t);
143int snprintb(char *, size_t, const char *, uint64_t);
144int sockaddr_snprintf(char *, size_t, const char *,
145 const struct sockaddr *);
146char *strpct(char *, size_t, uintmax_t, uintmax_t, size_t);
147char *strspct(char *, size_t, intmax_t, intmax_t, size_t);
148char *strpct_r(char *, size_t, uintmax_t, uintmax_t, size_t,
149 uint32_t);
150char *strspct_r(char *,size_t, intmax_t, intmax_t, size_t, uint32_t);
151uint32_t strpct_round(uint32_t);
152int string_to_flags(char **, unsigned long *, unsigned long *);
153int ttyaction(const char *, const char *, const char *);
154int ttylock(const char *, int, pid_t *);
155char *ttymsg(struct iovec *, int, const char *, int);
156int ttyunlock(const char *);
157
158uint16_t disklabel_dkcksum(struct disklabel *);
159int disklabel_scan(struct disklabel *, char *, size_t);
160
161/* Error checked functions */
162void (*esetfunc(void (*)(int, const char *, ...)))
163 (int, const char *, ...);
164size_t estrlcpy(char *, const char *, size_t);
165size_t estrlcat(char *, const char *, size_t);
166char *estrdup(const char *);
167char *estrndup(const char *, size_t);
168intmax_t estrtoi(const char *, int, intmax_t, intmax_t);
169uintmax_t estrtou(const char *, int, uintmax_t, uintmax_t);
170void *ecalloc(size_t, size_t);
171void *emalloc(size_t);
172void *erealloc(void *, size_t);
173void ereallocarr(void *, size_t, size_t);
174struct __sFILE *efopen(const char *, const char *);
175int easprintf(char ** __restrict, const char * __restrict, ...)
176 __printflike(2, 3);
177int evasprintf(char ** __restrict, const char * __restrict,
178 __va_list) __printflike(2, 0);
179__END_DECLS
180
181#endif /* !_UTIL_H_ */