os/ossrv/genericopenlibs/openenvcore/include/sys/param.dosc
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
     1 /** @file ../include/sys/param.h
     2 @internalComponent
     3 */
     4 
     5 /** @def NOFILE
     6 
     7 max open files per process
     8 
     9 @publishedAll
    10 @externallyDefinedApi
    11 */
    12 
    13 
    14 /** @def MAXCOMLEN	
    15 
    16 max command name remembered
    17 
    18 @publishedAll
    19 @externallyDefinedApi
    20 */
    21 
    22 
    23 /** @def MAXINTERP	
    24 
    25 max interpreter file name length
    26 
    27 @publishedAll
    28 @externallyDefinedApi
    29 */
    30 
    31 /** @def MAXLOGNAME	
    32 
    33 max login name length (incl. NUL)
    34 
    35 @publishedAll
    36 @externallyDefinedApi
    37 */
    38 
    39 /** @def MAXUPRC	
    40 
    41 max simultaneous processes
    42 	
    43 @publishedAll
    44 @externallyDefinedApi
    45 */
    46 
    47 
    48 /** @def NCARGS		
    49 
    50 max bytes for an exec function
    51 
    52 @publishedAll
    53 @externallyDefinedApi
    54 */
    55 
    56 /** @def NGROUPS	
    57 
    58 max number groups
    59 	
    60 @publishedAll
    61 @externallyDefinedApi
    62 */
    63 
    64 
    65 /** @def NOFILE	
    66 
    67 max open files per process
    68 	
    69 @publishedAll
    70 @externallyDefinedApi
    71 */
    72 
    73 
    74 /** @def NOGROUP		
    75 
    76 marker for empty group set member
    77 
    78 @publishedAll
    79 @externallyDefinedApi
    80 */
    81 
    82 /** @def MAXHOSTNAMELEN	
    83 
    84 max hostname size
    85 
    86 @publishedAll
    87 @externallyDefinedApi
    88 */
    89 
    90 /** @def SPECNAMELEN	
    91 
    92 max length of devicename 
    93 
    94 @publishedAll
    95 @externallyDefinedApi
    96 */
    97 
    98 /** @def DEV_BSHIFT	
    99 
   100 log2(DEV_BSIZE)
   101 
   102 @publishedAll
   103 @externallyDefinedApi
   104 */
   105 
   106 /** @def DEV_BSIZE
   107 
   108 (1<<DEV_BSHIFT)
   109 
   110 @publishedAll
   111 @externallyDefinedApi
   112 */
   113 
   114 /** @def BLKDEV_IOSIZE  
   115 
   116 default block device I/O size
   117 
   118 @publishedAll
   119 @externallyDefinedApi
   120 */
   121 
   122 /** @def DFLTPHYS	
   123 
   124 default max raw IO transfer size
   125 
   126 @publishedAll
   127 @externallyDefinedApi
   128 */
   129 
   130 /** @def MAXPHYS
   131 
   132 max raw IO transfer size
   133 		
   134 @publishedAll
   135 @externallyDefinedApi
   136 */
   137 
   138 /** @def MAXDUMPPGS	
   139 
   140 (DFLTPHYS by PAGE_SIZE)
   141 
   142 @publishedAll
   143 @externallyDefinedApi
   144 */
   145 
   146 
   147 /** @def MSIZE		
   148 
   149 size of an mbuf 
   150 
   151 @publishedAll
   152 @externallyDefinedApi
   153 */
   154 
   155 /** @def ctob(x)	
   156 
   157 clicks to bytes
   158 
   159 @publishedAll
   160 @externallyDefinedApi
   161 */
   162 
   163 
   164 /** @def btoc(x)
   165 
   166 bytes to clicks
   167 
   168 @publishedAll
   169 @externallyDefinedApi
   170 */
   171 
   172 /** @def btodb(bytes)
   173 
   174 calculates (bytes by DEV_BSIZE)
   175 
   176 @publishedAll
   177 @externallyDefinedApi
   178 */
   179 
   180 /** @def dbtob(db)
   181 
   182 calculates (db)(DEV_BSIZE)
   183 
   184 @publishedAll
   185 @externallyDefinedApi
   186 */
   187 
   188 
   189 /** @def PRIMASK	
   190 
   191 Primary mask
   192 
   193 @publishedAll
   194 @externallyDefinedApi
   195 */
   196 
   197 /** @def PCATCH	
   198 
   199 ORd with pri for tsleep to check signals
   200 
   201 @publishedAll
   202 @externallyDefinedApi
   203 */
   204 
   205 /** @def PDROP	
   206 
   207 ORd with pri to stop re-entry of interlock mutex 
   208 
   209 @publishedAll
   210 @externallyDefinedApi
   211 */
   212  
   213 
   214 /** @def NZERO	
   215 
   216 default "nice"
   217 
   218 @publishedAll
   219 @externallyDefinedApi
   220 */
   221 
   222 
   223 /** @def NBBY	
   224 
   225 number of bits in a byte
   226 
   227 @publishedAll
   228 @externallyDefinedApi
   229 */
   230 
   231 
   232 /** @def NBPW	
   233 
   234 number of bytes per word (integer)
   235 
   236 @publishedAll
   237 @externallyDefinedApi
   238 */
   239 
   240 
   241 /** @def CMASK	
   242 
   243 default file mask: S_IWGRP OR S_IWOTH
   244 
   245 @publishedAll
   246 @externallyDefinedApi
   247 */
   248 
   249 
   250 /** @def NODEV	
   251 
   252 non-existent device
   253 
   254 @publishedAll
   255 @externallyDefinedApi
   256 */
   257 
   258 
   259 /** @def CBLOCK	
   260 
   261 Clist block size, must be a power of 2.
   262 
   263 @publishedAll
   264 @externallyDefinedApi
   265 */
   266 
   267 
   268 
   269 /** @def CBQSIZE
   270 
   271 Quote bytes or cblock 
   272 	
   273 @publishedAll
   274 @externallyDefinedApi
   275 */
   276 
   277 /** @def CBSIZE	
   278 
   279 Data chars or clist
   280 
   281 @publishedAll
   282 @externallyDefinedApi
   283 */
   284 
   285 
   286 /** @def CROUND	
   287 
   288 Clist rounding.
   289 
   290 @publishedAll
   291 @externallyDefinedApi
   292 */
   293 
   294 /** @def MAXBSIZE
   295 
   296 Filesystems are made out of blocks of at most MAXBSIZE bytes per block.  
   297 MAXBSIZE may be made larger without effecting any existing filesystems as long as it does not exceed MAXPHYS, and may be made smaller at the risk of not being able to use filesystems which require a block size exceeding MAXBSIZE.
   298 	
   299 @publishedAll
   300 @externallyDefinedApi
   301 */
   302 
   303 /** @def BKVASIZE	
   304 
   305 Nominal buffer space per buffer, in bytes.  BKVASIZE is the minimum KVM memory reservation the kernel is willing to make.
   306 Filesystems can of course request smaller chunks.  Actual  backing memory uses a chunk size of a page (PAGE_SIZE).
   307 
   308 @publishedAll
   309 @externallyDefinedApi
   310 */
   311 
   312 /** @def BKVAMASK
   313 
   314 File system parameter and macros
   315 	
   316 @publishedAll
   317 @externallyDefinedApi
   318 */
   319 
   320 
   321 /** @def MAXPATHLEN	
   322 
   323 MAXPATHLEN defines the longest permissible path length after expanding symbolic links. 
   324 It is used to allocate a temporary buffer from the buffer pool in which to do the name expansion, hence should be a power of two,and must be less than or equal to MAXBSIZE.  
   325 
   326 @publishedAll
   327 @externallyDefinedApi
   328 */
   329 
   330 /** @def MAXSYMLINKS	
   331 
   332 Maximum number of symbolic links that may be expanded in a path name.
   333 It should be set high enough to allow all legitimate uses, but halt infinite loops reasonably quickly.
   334 
   335 @publishedAll
   336 @externallyDefinedApi
   337 */
   338 
   339 /** @def howmany(x, y)
   340 
   341 Macros for counting and rounding.
   342 
   343 @publishedAll
   344 @externallyDefinedApi
   345 */
   346 
   347 
   348 /** @def rounddown(x, y)
   349 
   350 Macros for counting and rounding.
   351 
   352 @publishedAll
   353 @released
   354 */
   355 
   356 /** @def roundup(x, y)
   357 
   358 Macros for counting and rounding.
   359 
   360 @publishedAll
   361 @released
   362 */
   363 
   364 
   365 /** @def roundup2(x, y)
   366 
   367 Macros for counting and rounding.
   368 
   369 @publishedAll
   370 @released
   371 */
   372 
   373 
   374 /** @def powerof2(x)	
   375 
   376 Macros for counting and rounding.
   377 
   378 @publishedAll
   379 @externallyDefinedApi
   380 */
   381 
   382 
   383 /** @def MIN(a,b)
   384 
   385 Macros for min or max.
   386 
   387 @publishedAll
   388 @externallyDefinedApi
   389 */
   390 
   391 
   392 /** @def MAX(a,b) 
   393 
   394 Macros for min or max.
   395 
   396 @publishedAll
   397 @externallyDefinedApi
   398 */
   399 
   400 
   401 
   402 /** @def MINBUCKET	
   403 
   404 min allocation of 32 bytes or 16 bytes
   405 
   406 @publishedAll
   407 @externallyDefinedApi
   408 */
   409 
   410 
   411 /** @def MAXALLOCSAVE	
   412 
   413 (2)(PAGE_SIZE)
   414 
   415 @publishedAll
   416 @externallyDefinedApi
   417 */
   418 
   419 /** @def FSHIFT
   420 
   421 bits to right of fixed binary point
   422 
   423 @publishedAll
   424 @externallyDefinedApi
   425 */
   426 
   427 /** @def FSCALE
   428 
   429 bits to right 1 shift
   430 
   431 @publishedAll
   432 @externallyDefinedApi
   433 */
   434 
   435 
   436 
   437 
   438