sys/sys/pcpu.h

   1 /*-
   2  * Copyright (c) 2001 Wind River Systems, Inc.
   3  * All rights reserved.
   4  * Written by: John Baldwin <jhb@FreeBSD.org>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 4. Neither the name of the author nor the names of any co-contributors
  15  *    may be used to endorse or promote products derived from this software
  16  *    without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _SYS_PCPU_H_
  34 #define _SYS_PCPU_H_
  35
  36 #ifndef _KERNEL
  37 #error "no user-serviceable parts inside"
  38 #endif
  39
  40 #ifdef LOCORE
  41 #error "no assembler-serviceable parts inside"
  42 #endif
  43
  44 #include <sys/queue.h>
  45 #include <sys/vmmeter.h>
  46 #include <machine/pcpu.h>
  47
  48 struct pcb;
  49 struct thread;
  50
  51 /*
  52  * This structure maps out the global data that needs to be kept on a
  53  * per-cpu basis.  The members are accessed via the PCPU_GET/SET/PTR
  54  * macros defined in <machine/pcpu.h>.  Machine dependent fields are
  55  * defined in the PCPU_MD_FIELDS macro defined in <machine/pcpu.h>.
  56  */
  57 struct pcpu {
  58         struct thread   *pc_curthread;          /* Current thread */
  59         struct thread   *pc_idlethread;         /* Idle thread */
  60         struct thread   *pc_fpcurthread;        /* Fp state owner */
  61         struct thread   *pc_deadthread;         /* Zombie thread or NULL */
  62         struct pcb      *pc_curpcb;             /* Current pcb */
  63         struct bintime  pc_switchtime;
  64         int             pc_switchticks;
  65         u_int           pc_cpuid;               /* This cpu number */
  66         cpumask_t       pc_cpumask;             /* This cpu mask */
  67         cpumask_t       pc_other_cpus;          /* Mask of all other cpus */
  68         SLIST_ENTRY(pcpu) pc_allcpu;
  69         struct lock_list_entry *pc_spinlocks;
  70 #ifdef KTR_PERCPU
  71         int             pc_ktr_idx;             /* Index into trace table */
  72         char            *pc_ktr_buf;
  73 #endif
  74         PCPU_MD_FIELDS;
  75         struct vmmeter  pc_cnt;                 /* VM stats counters */
  76         struct device   *pc_device;
  77 };
  78
  79 SLIST_HEAD(cpuhead, pcpu);
  80
  81 extern struct cpuhead cpuhead;
  82
  83 #define curcpu          PCPU_GET(cpuid)
  84 #define curproc         (curthread->td_proc)
  85 #ifndef curthread
  86 #define curthread       PCPU_GET(curthread)
  87 #endif
  88
  89 /*
  90  * MI PCPU support functions
  91  *
  92  * PCPU_LAZY_INC() -    Lazily increment a per-cpu stats counter, without
  93  *                      guarenteeing atomicity or even necessarily consistency.
  94  *
  95  *                      XXX we need to create MD primitives to support
  96  *                      this to guarentee at least some level of consistency,
  97  *                      i.e., to prevent us from totally corrupting the
  98  *                      counters due to preemption in a multi-instruction
  99  *                      increment sequence for architectures that do not
 100  *                      support single-instruction memory increments.
 101  */
 102 #define PCPU_LAZY_INC(var)      (++*PCPU_PTR(var))
 103
 104 /*
 105  * Machine dependent callouts.  cpu_pcpu_init() is responsible for
 106  * initializing machine dependent fields of struct pcpu, and
 107  * db_show_mdpcpu() is responsible for handling machine dependent
 108  * fields for the DDB 'show pcpu' command.
 109  */
 110 void    cpu_pcpu_init(struct pcpu *pcpu, int cpuid, size_t size);
 111 void    db_show_mdpcpu(struct pcpu *pcpu);
 112
 113 void    pcpu_destroy(struct pcpu *pcpu);
 114 struct  pcpu *pcpu_find(u_int cpuid);
 115 void    pcpu_init(struct pcpu *pcpu, int cpuid, size_t size);
 116
 117 #endif /* !_SYS_PCPU_H_ */