Propagate curproc removal changes to files compiled by LINT.

[dragonfly.git] / sys / sys / systm.h

/*-
 * Copyright (c) 1982, 1988, 1991, 1993
 *	The Regents of the University of California.  All rights reserved.
 * (c) UNIX System Laboratories, Inc.
 * All or some portions of this file are derived from material licensed
 * to the University of California by American Telephone and Telegraph
 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
 * the permission of UNIX System Laboratories, Inc.
 *
 * 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
 *
 *	@(#)systm.h	8.7 (Berkeley) 3/29/95
 * $FreeBSD: src/sys/sys/systm.h,v 1.111.2.18 2002/12/17 18:04:02 sam Exp $
 * $DragonFly: src/sys/sys/systm.h,v 1.17 2004/01/30 05:42:18 dillon Exp $
 */

#ifndef _SYS_SYSTM_H_
#define	_SYS_SYSTM_H_

#ifndef _MACHINE_TYPES_H_
#include <machine/types.h>
#endif
#ifndef _MACHINE_STDARG_H_
#include <machine/stdarg.h>
#endif
#include <machine/atomic.h>
#include <machine/cpufunc.h>
#include <sys/callout.h>

extern int securelevel;		/* system security level (see init(8)) */

extern int cold;		/* nonzero if we are doing a cold boot */
extern const char *panicstr;	/* panic message */
extern int dumping;		/* system is dumping */
extern int safepri;		/* safe ipl when cold or panicing */
extern char version[];		/* system version */
extern char copyright[];	/* system copyright */

extern int nswap;		/* size of swap space */

extern int selwait;		/* select timeout address */

extern u_char curpriority;	/* priority of current process */

extern int physmem;		/* physical memory */

extern dev_t dumpdev;		/* dump device */
extern long dumplo;		/* offset into dumpdev */

extern dev_t rootdev;		/* root device */
extern dev_t rootdevs[2];	/* possible root devices */
extern char *rootdevnames[2];	/* names of possible root devices */
extern struct vnode *rootvp;	/* vnode equivalent to above */

extern int boothowto;		/* reboot flags, from console subsystem */
extern int bootverbose;		/* nonzero to print verbose messages */

extern int maxusers;		/* system tune hint */

extern int ncpus;		/* total number of cpus (real, hyper, virtual)*/

#ifdef	INVARIANTS		/* The option is always available */
#define	KASSERT(exp,msg)	do { if (!(exp)) panic msg; } while (0)
#define KKASSERT(exp)		if (!(exp)) panic("assertion: " #exp " in %s", __FUNCTION__)
#define	SPLASSERT(level, msg)	__CONCAT(__CONCAT(spl,level),assert)(msg)
#define	CONDSPLASSERT(cond, level, msg) do {				\
	if (cond)							\
		SPLASSERT(level, msg);					\
} while (0)
#else
#define	KASSERT(exp,msg)
#define	KKASSERT(exp)
#define	SPLASSERT(level, msg)
#define	CONDSPLASSERT(cond, level, msg)
#endif

/*
 * General function declarations.
 */

struct intrframe;
struct malloc_type;
struct proc;
struct xwait;
struct timeval;
struct tty;
struct uio;
struct globaldata;
struct thread;

void	Debugger (const char *msg);
void	backtrace(void);
void	mi_gdinit (struct globaldata *gd, int cpu);
int	dumpstatus (vm_offset_t addr, off_t count);
int	nullop (void);
int	eopnotsupp (void);
int	einval (void);
int	seltrue (dev_t dev, int which, struct thread *td);
int	ureadc (int, struct uio *);
void	*hashinit (int count, struct malloc_type *type, u_long *hashmask);
void	*phashinit (int count, struct malloc_type *type, u_long *nentries);

void	cpu_boot (int);
void	cpu_rootconf (void);
extern uint32_t crc32_tab[];
uint32_t crc32(const void *buf, size_t size);
void	init_param1 (void);
void	init_param2 (int physpages);
void	tablefull (const char *);
int	addlog (const char *, ...) __printflike(1, 2);
int	kvprintf (char const *, void (*)(int, void*), void *, int,
		      __va_list) __printflike(1, 0);
int	log (int, const char *, ...) __printflike(2, 3);
void	logwakeup (void);
void	log_console (struct uio *);
int	printf (const char *, ...) __printflike(1, 2);
int	snprintf (char *, size_t, const char *, ...) __printflike(3, 4);
int	sprintf (char *buf, const char *, ...) __printflike(2, 3);
int	uprintf (const char *, ...) __printflike(1, 2);
int	vprintf (const char *, __va_list) __printflike(1, 0);
int	vsnprintf (char *, size_t, const char *, __va_list) __printflike(3, 0);
int     vsprintf (char *buf, const char *, __va_list) __printflike(2, 0);
int	ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
int	sscanf (const char *, char const *, ...);
int	vsscanf (const char *, char const *, __va_list);
long	strtol (const char *, char **, int);
u_long	strtoul (const char *, char **, int);
quad_t	strtoq (const char *, char **, int);
u_quad_t strtouq (const char *, char **, int);

/*
 * note: some functions commonly used by device drivers may be passed
 * pointers to volatile storage, volatile set to avoid warnings.
 */
void	bcopy (volatile const void *from, volatile void *to, size_t len);
void	ovbcopy (const void *from, void *to, size_t len);

#ifdef __i386__
extern void	(*bzero) (volatile void *buf, size_t len);
#else
void	bzero (void *buf, size_t len);
#endif

void	*memcpy (void *to, const void *from, size_t len);

int	copystr (const void *kfaddr, void *kdaddr, size_t len,
		size_t *lencopied);
int	copyinstr (const void *udaddr, void *kaddr, size_t len,
		size_t *lencopied);
int	copyin (const void *udaddr, void *kaddr, size_t len);
int	copyout (const void *kaddr, void *udaddr, size_t len);

int	fubyte (const void *base);
int	subyte (void *base, int byte);
int	suibyte (void *base, int byte);
long	fuword (const void *base);
int	suword (void *base, long word);
int	fusword (void *base);
int	susword (void *base, int word);

void	realitexpire (void *);
void	DELAY(int usec);

void	startprofclock (struct proc *);
void	stopprofclock (struct proc *);
void	setstatclockrate (int hzrate);

char	*getenv (const char *name);
#define	testenv	getenv
#define	freeenv(p)
int	getenv_int (const char *name, int *data);
int	getenv_string (const char *name, char *data, int size);
int	getenv_quad (const char *name, quad_t *data);
extern char *kern_envp;

#ifdef APM_FIXUP_CALLTODO 
void	adjust_timeout_calltodo (struct timeval *time_change); 
#endif /* APM_FIXUP_CALLTODO */ 

#include <sys/libkern.h>

/* Initialize the world */
void	consinit (void);
void	cpu_initclocks (void);
void	nchinit (void);
void	usrinfoinit (void);
void	vntblinit (void);

/* Finalize the world. */
void	shutdown_nice (int);

/*
 * Kernel to clock driver interface.
 */
void	inittodr (time_t base);
void	resettodr (void);
void	startrtclock (void);

/* Timeouts */
typedef void timeout_t (void *);	/* timeout function type */
#define CALLOUT_HANDLE_INITIALIZER(handle)	\
	{ NULL }

void	callout_handle_init (struct callout_handle *);
struct	callout_handle timeout (timeout_t *, void *, int);
void	untimeout (timeout_t *, void *, struct callout_handle);

/* Interrupt management */

/* 
 * For the alpha arch, some of these functions are static __inline, and
 * the others should be.
 */
#ifdef __i386__
void		setdelayed (void);
void		setsoftast (void);
void		setsoftcambio (void);
void		setsoftcamnet (void);
void		setsoftclock (void);
void		setsoftcrypto (void);
void		setsoftnet (void);
void		setsofttty (void);
void		setsoftvm (void);
void		setsofttq (void);
void		schedsoftcamnet (void);
void		schedsoftcambio (void);
void		schedsoftnet (void);
void		schedsofttty (void);
void		schedsoftvm (void);
void		schedsofttq (void);
intrmask_t	softclockpending (void);
void		spl0 (void);
intrmask_t	splbio (void);
intrmask_t	splcam (void);
intrmask_t	splclock (void);
intrmask_t	splcrypto (void);
intrmask_t	splhigh (void);
intrmask_t	splimp (void);
intrmask_t	splnet (void);
intrmask_t	splsoftcam (void);
intrmask_t	splsoftcambio (void);
intrmask_t	splsoftcamnet (void);
intrmask_t	splsoftclock (void);
intrmask_t	splsofttty (void);
intrmask_t	splsoftvm (void);
intrmask_t	splsofttq (void);
intrmask_t	splstatclock (void);
intrmask_t	spltty (void);
intrmask_t	splvm (void);
void		splx (intrmask_t ipl);
void		splz (void);
#endif /* __i386__ */

#ifdef __alpha__
#include <machine/ipl.h>
#endif

#ifdef INVARIANT_SUPPORT
void	splbioassert (const char *msg);
void	splcamassert (const char *msg);
void	splclockassert (const char *msg);
void	splcryptoassert (const char *msg);
void	splhighassert (const char *msg);
void	splimpassert (const char *msg);
void	splnetassert (const char *msg);
void	splsoftcamassert (const char *msg);
void	splsoftcambioassert (const char *msg);
void	splsoftcamnetassert (const char *msg);
void	splsoftclockassert (const char *msg);
void	splsoftttyassert (const char *msg);
void	splsoftvmassert (const char *msg);
void	splsofttqassert (const char *msg);
void	splstatclockassert (const char *msg);
void	splttyassert (const char *msg);
void	splvmassert (const char *msg);
#endif /* INVARIANT_SUPPORT */

/*
 * XXX It's not clear how "machine independent" these will be yet, but
 * they are used all over the place especially in pci drivers.  We would
 * have to modify lots of drivers since <machine/cpufunc.h> no longer
 * implicitly causes these to be defined when it #included <machine/spl.h>
 */
extern intrmask_t bio_imask;	/* group of interrupts masked with splbio() */
extern intrmask_t cam_imask;	/* group of interrupts masked with splcam() */
extern intrmask_t net_imask;	/* group of interrupts masked with splimp() */
extern intrmask_t stat_imask;	/* interrupts masked with splstatclock() */
extern intrmask_t tty_imask;	/* group of interrupts masked with spltty() */

/* Read only */
extern const intrmask_t soft_imask;    /* interrupts masked with splsoft*() */
extern const intrmask_t softnet_imask; /* interrupt masked with splnet() */
extern const intrmask_t softtty_imask; /* interrupt masked with splsofttty() */

/*
 * Various callout lists.
 */

/* Exit callout list declarations. */
typedef void (*exitlist_fn) (struct thread *td);

int	at_exit (exitlist_fn function);
int	rm_at_exit (exitlist_fn function);

/* Fork callout list declarations. */
typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
				 int flags);

int	at_fork (forklist_fn function);
int	rm_at_fork (forklist_fn function);

/*
 * Not exactly a callout LIST, but a callout entry.
 * Allow an external module to define a hardware watchdog tickler.
 * Normally a process would do this, but there are times when the
 * kernel needs to be able to hold off the watchdog, when the process
 * is not active, e.g., when dumping core.
 */
typedef void (*watchdog_tickle_fn) (void);

extern watchdog_tickle_fn	wdog_tickler;

/* 
 * Common `proc' functions are declared here so that proc.h can be included
 * less often.
 */
int	tsleep (void *chan, int slpflags, const char *wmesg, int timo);
void	wakeup (void *chan);
void	wakeup_one (void *chan);

/*
 * Common `dev_t' stuff are declared here to avoid #include poisoning
 */

int major(dev_t x);
int minor(dev_t x);
dev_t makedev(int x, int y);
udev_t dev2udev(dev_t x);
dev_t udev2dev(udev_t x, int b);
int uminor(udev_t dev);
int umajor(udev_t dev);
udev_t makeudev(int x, int y);
#endif /* !_SYS_SYSTM_H_ */