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