sys/sys/kthread.h

   1 /*
   2  * Copyright (c) 1999 Peter Wemm <peter@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are 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/sys/sys/kthread.h,v 1.2 2000/01/07 08:36:44 luoqi Exp $
  27  * $DragonFly: src/sys/sys/kthread.h,v 1.9 2006/05/20 02:42:13 dillon Exp $
  28  */
  29
  30 #ifndef _SYS_KTHREAD_H_
  31 #define _SYS_KTHREAD_H_
  32
  33 #ifndef _SYS_CDEFS_H_
  34 #include <sys/cdefs.h>
  35 #endif
  36
  37 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
  38 #error "This file should not be included by userland programs."
  39 #endif
  40
  41 struct proc;
  42 struct thread;
  43
  44 /*
  45  * A kernel process descriptor; used to start "internal" daemons
  46  *
  47  * Note: global_procpp may be NULL for no global save area
  48  */
  49 struct kproc_desc {
  50         char            *arg0;                  /* arg 0 (for 'ps' listing) */
  51         void            (*func) (void);         /* "main" for kernel process */
  52         struct thread   **global_threadpp;      /* ptr to proc ptr save area */
  53 };
  54
  55 #ifdef _KERNEL
  56 void    kproc_start (const void *);
  57
  58 int     suspend_kproc (struct thread *, int);
  59 int     resume_kproc (struct thread *);
  60 void    kproc_suspend_loop (void);
  61 void    shutdown_kproc (void *, int);
  62 int     kthread_create (void (*)(void *), void *, struct thread **,
  63             const char *, ...) __printflike(4, 5);
  64 int     kthread_create_cpu (void (*)(void *), void *, struct thread **,
  65             int, const char *, ...) __printflike(5, 6);
  66 void    kthread_exit (void) __dead2;
  67 #endif /* _KERNEL */
  68
  69 #endif /* _SYS_KTHREAD_H_ */