param.h revision 28641
1/*- 2 * Copyright (c) 1990 The Regents of the University of California. 3 * All rights reserved. 4 * 5 * This code is derived from software contributed to Berkeley by 6 * William Jolitz. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the University of 19 * California, Berkeley and its contributors. 20 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * from: @(#)param.h 5.8 (Berkeley) 6/28/91 37 * $Id: param.h,v 1.14 1997/08/23 05:14:23 smp Exp $ 38 */ 39 40#ifndef _MACHINE_PARAM_H_ 41#define _MACHINE_PARAM_H_ 42 43/* 44 * Machine dependent constants for Intel 386. 45 */ 46 47#define MACHINE "i386" 48#ifdef SMP 49#define NCPUS 2 50#else 51#define NCPUS 1 52#endif 53#define MID_MACHINE MID_I386 54 55 56#ifndef LOCORE 57 58/* 59 * Round p (pointer or byte index) up to a correctly-aligned value 60 * for all data types (int, long, ...). The result is unsigned int 61 * and must be cast to any desired pointer type. 62 */ 63#define ALIGNBYTES (sizeof(int) - 1) 64#define ALIGN(p) (((unsigned)(p) + ALIGNBYTES) & ~ALIGNBYTES) 65 66#define PAGE_SHIFT 12 /* LOG2(PAGE_SIZE) */ 67#define PAGE_SIZE (1<<PAGE_SHIFT) /* bytes/page */ 68#define PAGE_MASK (PAGE_SIZE-1) 69#define NPTEPG (PAGE_SIZE/(sizeof (pt_entry_t))) 70 71#define NPDEPG (PAGE_SIZE/(sizeof (pd_entry_t))) 72#define PDRSHIFT 22 /* LOG2(NBPDR) */ 73#define NBPDR (1<<PDRSHIFT) /* bytes/page dir */ 74#define PDRMASK (NBPDR-1) 75 76#define DEV_BSHIFT 9 /* log2(DEV_BSIZE) */ 77#define DEV_BSIZE (1<<DEV_BSHIFT) 78 79#define BLKDEV_IOSIZE 2048 80#define MAXPHYS (64 * 1024) /* max raw I/O transfer size */ 81 82#define IOPAGES 2 /* pages of i/o permission bitmap */ 83#define UPAGES 2 /* pages of u-area */ 84#define UPAGES_HOLE 2 /* pages of "hole" at top of user space where */ 85 /* the upages used to be. DO NOT CHANGE! */ 86 87/* 88 * Constants related to network buffer management. 89 * MCLBYTES must be no larger than CLBYTES (the software page size), and, 90 * on machines that exchange pages of input or output buffers with mbuf 91 * clusters (MAPPED_MBUFS), MCLBYTES must also be an integral multiple 92 * of the hardware page size. 93 */ 94#ifndef MSIZE 95#define MSIZE 128 /* size of an mbuf */ 96#endif /* MSIZE */ 97 98#ifndef MCLSHIFT 99#define MCLSHIFT 11 /* convert bytes to m_buf clusters */ 100#endif /* MCLSHIFT */ 101#define MCLBYTES (1 << MCLSHIFT) /* size of an m_buf cluster */ 102#define MCLOFSET (MCLBYTES - 1) /* offset within an m_buf cluster */ 103 104/* 105 * Some macros for units conversion 106 */ 107 108/* clicks to bytes */ 109#define ctob(x) ((x)<<PAGE_SHIFT) 110 111/* bytes to clicks */ 112#define btoc(x) (((unsigned)(x)+PAGE_MASK)>>PAGE_SHIFT) 113 114/* 115 * btodb() is messy and perhaps slow because `bytes' may be an off_t. We 116 * want to shift an unsigned type to avoid sign extension and we don't 117 * want to widen `bytes' unnecessarily. Assume that the result fits in 118 * a daddr_t. 119 */ 120#define btodb(bytes) /* calculates (bytes / DEV_BSIZE) */ \ 121 (sizeof (bytes) > sizeof(long) \ 122 ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \ 123 : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT)) 124 125#define dbtob(db) /* calculates (db * DEV_BSIZE) */ \ 126 ((off_t)(db) << DEV_BSHIFT) 127 128/* 129 * Mach derived conversion macros 130 */ 131#define trunc_page(x) ((unsigned)(x) & ~PAGE_MASK) 132#define round_page(x) ((((unsigned)(x)) + PAGE_MASK) & ~PAGE_MASK) 133#define trunc_4mpage(x) ((unsigned)(x) & ~PDRMASK) 134#define round_4mpage(x) ((((unsigned)(x)) + PDRMASK) & ~PDRMASK) 135 136#define atop(x) ((unsigned)(x) >> PAGE_SHIFT) 137#define ptoa(x) ((unsigned)(x) << PAGE_SHIFT) 138 139#define i386_btop(x) ((unsigned)(x) >> PAGE_SHIFT) 140#define i386_ptob(x) ((unsigned)(x) << PAGE_SHIFT) 141 142#endif /* !LOCORE */ 143 144 145#ifndef _SIMPLELOCK_H_ 146#define _SIMPLELOCK_H_ 147 148/* 149 * XXX some temp debug control of cpl locks 150 */ 151#define REAL_ECPL /* exception.s: SCPL_LOCK/SCPL_UNLOCK */ 152#define REAL_ICPL /* ipl.s: CPL_LOCK/CPL_UNLOCK/FAST */ 153#define REAL_AICPL /* apic_ipl.s: SCPL_LOCK/SCPL_UNLOCK */ 154#define REAL_AVCPL /* apic_vector.s: CPL_LOCK/CPL_UNLOCK */ 155 156#define REAL_IFCPL /* ipl_funcs.c: SCPL_LOCK/SCPL_UNLOCK */ 157 158#define REAL_MCPL_NOT /* microtime.s: CPL_LOCK/movl $0,_cpl_lock */ 159 160 161#ifdef LOCORE 162 163#ifdef SMP 164 165#define MPLOCKED lock ; 166 167/* 168 * Some handy macros to allow logical organization and 169 * convenient reassignment of various locks. 170 */ 171 172#define FPU_LOCK call _get_fpu_lock 173#define ALIGN_LOCK call _get_align_lock 174#define SYSCALL_LOCK call _get_syscall_lock 175#define ALTSYSCALL_LOCK call _get_altsyscall_lock 176 177/* 178 * Protects INTR() ISRs. 179 */ 180#define ISR_TRYLOCK \ 181 pushl $_mp_lock ; /* GIANT_LOCK */ \ 182 call _MPtrylock ; /* try to get lock */ \ 183 add $4, %esp 184 185#define ISR_RELLOCK \ 186 pushl $_mp_lock ; /* GIANT_LOCK */ \ 187 call _MPrellock ; \ 188 add $4, %esp 189 190/* 191 * Protects the IO APIC and apic_imen as a critical region. 192 */ 193#define IMASK_LOCK \ 194 pushl $_imen_lock ; /* address of lock */ \ 195 call _s_lock ; /* MP-safe */ \ 196 addl $4, %esp 197 198#define IMASK_UNLOCK \ 199 pushl $_imen_lock ; /* address of lock */ \ 200 call _s_unlock ; /* MP-safe */ \ 201 addl $4, %esp 202 203/* 204 * Variations of CPL_LOCK protect spl updates as a critical region. 205 * Items within this 'region' include: 206 * cpl 207 * cil 208 * ipending 209 * ??? 210 */ 211 212/* 213 * Botom half routines, ie. those already protected from INTs. 214 * 215 * Used in: 216 * sys/i386/i386/microtime.s (XXX currently NOT used, possible race?) 217 * sys/i386/isa/ipl.s: _doreti 218 * sys/i386/isa/apic_vector.s: _Xintr0, ..., _Xintr23 219 */ 220#define CPL_LOCK \ 221 pushl $_cpl_lock ; /* address of lock */ \ 222 call _s_lock ; /* MP-safe */ \ 223 addl $4, %esp 224 225#define CPL_UNLOCK \ 226 pushl $_cpl_lock ; /* address of lock */ \ 227 call _s_unlock ; /* MP-safe */ \ 228 addl $4, %esp 229 230/* 231 * INT safe version for top half of kernel. 232 * 233 * Used in: 234 * sys/i386/i386/exception.s: _Xfpu, _Xalign, _Xsyscall, _Xint0x80_syscall 235 * sys/i386/isa/apic_ipl.s: splz() 236 */ 237#define SCPL_LOCK \ 238 pushl $_cpl_lock ; \ 239 call _ss_lock ; \ 240 addl $4, %esp 241 242#define SCPL_UNLOCK \ 243 pushl $_cpl_lock ; \ 244 call _ss_unlock ; \ 245 addl $4, %esp 246 247#else /* SMP */ 248 249#define MPLOCKED /* NOP */ 250 251#define FPU_LOCK /* NOP */ 252#define ALIGN_LOCK /* NOP */ 253#define SYSCALL_LOCK /* NOP */ 254#define ALTSYSCALL_LOCK /* NOP */ 255 256#endif /* SMP */ 257 258#else /* LOCORE */ 259 260#ifdef SMP 261 262/* 263 * Protects cpl/cil/ipending data as a critical region. 264 * 265 * Used in: 266 * sys/i386/isa/ipl_funcs.c: DO_SETBITS, softclockpending(), GENSPL, 267 * spl0(), splx(), splq() 268 */ 269 270/* Bottom half */ 271#define CPL_LOCK() s_lock(&cpl_lock) 272#define CPL_UNLOCK() s_unlock(&cpl_lock) 273 274/* INT safe version for top half of kernel */ 275#define SCPL_LOCK() ss_lock(&cpl_lock) 276#define SCPL_UNLOCK() ss_unlock(&cpl_lock) 277 278/* 279 * Protects com/tty data as a critical region. 280 */ 281#define COM_LOCK() s_lock(&com_lock) 282#define COM_UNLOCK() s_unlock(&com_lock) 283 284#else /* SMP */ 285 286#define CPL_LOCK() 287#define CPL_UNLOCK() 288#define SCPL_LOCK() 289#define SCPL_UNLOCK() 290 291#define COM_LOCK() 292#define COM_UNLOCK() 293 294#endif /* SMP */ 295 296/* 297 * A simple spin lock. 298 * 299 * This structure only sets one bit of data, but is sized based on the 300 * minimum word size that can be operated on by the hardware test-and-set 301 * instruction. It is only needed for multiprocessors, as uniprocessors 302 * will always run to completion or a sleep. It is an error to hold one 303 * of these locks while a process is sleeping. 304 */ 305struct simplelock { 306 volatile int lock_data; 307}; 308 309/* functions in simplelock.s */ 310void s_lock_init __P((struct simplelock *)); 311void s_lock __P((struct simplelock *)); 312int s_lock_try __P((struct simplelock *)); 313void s_unlock __P((struct simplelock *)); 314void ss_lock __P((struct simplelock *)); 315void ss_unlock __P((struct simplelock *)); 316 317/* global data in mp_machdep.c */ 318extern struct simplelock imen_lock; 319extern struct simplelock cpl_lock; 320extern struct simplelock fast_intr_lock; 321extern struct simplelock intr_lock; 322extern struct simplelock com_lock; 323 324#if !defined(SIMPLELOCK_DEBUG) && NCPUS > 1 325/* 326 * The simple-lock routines are the primitives out of which the lock 327 * package is built. The machine-dependent code must implement an 328 * atomic test_and_set operation that indivisibly sets the simple lock 329 * to non-zero and returns its old value. It also assumes that the 330 * setting of the lock to zero below is indivisible. Simple locks may 331 * only be used for exclusive locks. 332 */ 333 334#ifdef the_original_code 335 336static __inline void 337simple_lock_init(struct simplelock *lkp) 338{ 339 340 lkp->lock_data = 0; 341} 342 343static __inline void 344simple_lock(struct simplelock *lkp) 345{ 346 347 while (test_and_set(&lkp->lock_data)) 348 continue; 349} 350 351static __inline int 352simple_lock_try(struct simplelock *lkp) 353{ 354 355 return (!test_and_set(&lkp->lock_data)); 356} 357 358static __inline void 359simple_unlock(struct simplelock *lkp) 360{ 361 362 lkp->lock_data = 0; 363} 364 365#else /* the_original_code */ 366 367/* 368 * This set of defines turns on the real functions in i386/isa/apic_ipl.s. 369 * It has never actually been tested. 370 */ 371#define simple_lock_init(alp) s_lock_init(alp) 372#define simple_lock(alp) s_lock(alp) 373#define simple_lock_try(alp) s_lock_try(alp) 374#define simple_unlock(alp) s_unlock(alp) 375 376#endif /* the_original_code */ 377 378#endif /* NCPUS > 1 */ 379#endif /* LOCORE */ 380#endif /* !_SIMPLELOCK_H_ */ 381 382#endif /* !_MACHINE_PARAM_H_ */ 383