Changeset de0711ec in rtems


Ignore:
Timestamp:
Oct 13, 1999, 7:48:17 PM (22 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, 5, master
Children:
18408af
Parents:
22cbb9c
Message:

Reorganized a lot per Jennifer's suggestions.

Location:
doc/filesystem
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • doc/filesystem/filesystem.texi

    r22cbb9c rde0711ec  
    8181* System Initialization::
    8282* Mounting and Unmounting Filesystems::
    83 * Filesystem Requirements::
     83* Filesystem Implementation Requirements::
    8484* In-Memory Filesystem::
    8585* System Call Development Notes::
  • doc/filesystem/fsrequirements.t

    r22cbb9c rde0711ec  
    88
    99
    10 @chapter Filesystem Requirements
     10@chapter Filesystem Implementation Requirements
    1111
    1212This chapter details the behavioral requirements that all filesystem
     
    321321@c
    322322@c
    323 @page
     323@c @page
    324324
    325325@subsubsection evalpath Handler
     
    345345@c
    346346@c
    347 @page
     347@c @page
    348348
    349349@subsubsection evalformake Handler
     
    369369@c
    370370@c
    371 @page
     371@c @page
    372372
    373373@subsubsection link Handler
     
    404404@c
    405405@c
    406 @page
     406@c @page
    407407
    408408@subsubsection unlink Handler
     
    428428@c
    429429@c
    430 @page
     430@c @page
    431431
    432432@subsubsection node_type Handler
     
    453453@c
    454454@c
    455 @page
     455@c @page
    456456
    457457@subsubsection mknod Handler
     
    481481@c
    482482@c
    483 @page
     483@c @page
    484484
    485485@subsubsection rmnod Handler
     
    505505@c
    506506@c
    507 @page
     507@c @page
    508508
    509509@subsubsection chown Handler
     
    532532@c
    533533@c
    534 @page
     534@c @page
    535535
    536536@subsubsection freenod Handler
     
    556556@c
    557557@c
    558 @page
     558@c @page
    559559
    560560@subsubsection mount Handler
     
    581581@c
    582582@c
    583 @page
     583@c @page
    584584
    585585@subsubsection fsmount_me Handler
     
    717717@c
    718718@c
    719 @page
     719@c @page
    720720
    721721@subsubsection unmount Handler
     
    741741@c
    742742@c
    743 @page
     743@c @page
    744744
    745745@subsubsection fsunmount_me Handler
     
    767767@c
    768768@c
    769 @page
     769@c @page
    770770
    771771@subsubsection utime Handler
     
    790790@c
    791791@c
    792 @page
     792@c @page
    793793
    794794@subsubsection eval_link Handler
     
    813813@c
    814814@c
    815 @page
     815@c @page
    816816
    817817@subsubsection symlink Handler
     
    836836@c
    837837@c
    838 @page
     838@c @page
    839839@subsection File Handler Table Functions
    840840
     
    867867@c
    868868@c
    869 @page
     869@c @page
    870870
    871871@subsubsection open Handler
     
    895895@c
    896896@c
    897 @page
     897@c @page
    898898
    899899@subsubsection close Handler
     
    926926@c
    927927@c
    928 @page
     928@c @page
    929929
    930930@subsubsection read Handler
     
    958958@c
    959959@c
    960 @page
     960@c @page
    961961
    962962@subsubsection write Handler
     
    985985@c
    986986@c
    987 @page
     987@c @page
    988988
    989989@subsubsection ioctl Handler
     
    10171017@c
    10181018@c
    1019 @page
     1019@c @page
    10201020
    10211021@subsubsection lseek Handler
     
    10491049@c
    10501050@c
    1051 @page
     1051@c @page
    10521052
    10531053@subsubsection fstat Handler
     
    11011101@c
    11021102@c
    1103 @page
     1103@c @page
    11041104
    11051105@subsubsection fchmod Handler
     
    11321132@c
    11331133@c
    1134 @page
     1134@c @page
    11351135
    11361136@subsubsection ftruncate Handler
     
    11801180@c
    11811181@c
    1182 @page
     1182@c @page
    11831183
    11841184@subsubsection fsync Handler
     
    12061206@c
    12071207@c
    1208 @page
     1208@c @page
    12091209
    12101210@subsubsection fdatasync Handler
     
    12331233@c
    12341234@c
    1235 @page
     1235@c @page
    12361236
    12371237@subsubsection fcntl Handler
  • doc/filesystem/imfs.t

    r22cbb9c rde0711ec  
    206206@c
    207207@c
    208 @page
     208@c @page
    209209
    210210@subsubsection IMFS_evalpath()
     
    230230@c
    231231@c
    232 @page
     232@c @page
    233233
    234234@subsubsection IMFS_evalformake()
     
    254254@c
    255255@c
    256 @page
     256@c @page
    257257
    258258@subsubsection IMFS_link()
     
    314314@c
    315315@c
    316 @page
     316@c @page
    317317
    318318@subsubsection IMFS_unlink()
     
    338338@c
    339339@c
    340 @page
     340@c @page
    341341
    342342@subsubsection IMFS_node_type()
     
    380380@c
    381381@c
    382 @page
     382@c @page
    383383
    384384@subsubsection IMFS_mknod()
     
    418418@c
    419419@c
    420 @page
     420@c @page
    421421
    422422@subsubsection IMFS_rmnod()
     
    442442@c
    443443@c
    444 @page
     444@c @page
    445445
    446446@subsubsection IMFS_chown()
     
    478478@c
    479479@c
    480 @page
     480@c @page
    481481
    482482@subsubsection IMFS_freenod()
     
    502502@c
    503503@c
    504 @page
     504@c @page
    505505
    506506@subsubsection IMFS_mount()
     
    540540@c
    541541@c
    542 @page
     542@c @page
    543543
    544544@subsubsection IMFS_fsmount_me()
     
    676676@c
    677677@c
    678 @page
     678@c @page
    679679
    680680@subsubsection IMFS_unmount()
     
    700700@c
    701701@c
    702 @page
     702@c @page
    703703
    704704@subsubsection IMFS_fsunmount_me()
     
    726726@c
    727727@c
    728 @page
     728@c @page
    729729
    730730@subsubsection IMFS_utime()
     
    750750@c
    751751@c
    752 @page
     752@c @page
    753753
    754754@subsubsection IMFS_eval_link()
     
    773773@c
    774774@c
    775 @page
     775@c @page
    776776@subsection Regular File Handler Table Functions
    777777
     
    805805@c
    806806@c
    807 @page
     807@c @page
    808808
    809809@subsubsection memfile_open() for Regular Files
     
    834834@c
    835835@c
    836 @page
     836@c @page
    837837
    838838@subsubsection memfile_close() for Regular Files
     
    862862@c
    863863@c
    864 @page
     864@c @page
    865865
    866866@subsubsection memfile_read() for Regular Files
     
    908908@c
    909909@c
    910 @page
     910@c @page
    911911
    912912@subsubsection memfile_write() for Regular Files
     
    930930@c
    931931@c
    932 @page
     932@c @page
    933933
    934934@subsubsection memfile_ioctl() for Regular Files
     
    958958@c
    959959@c
    960 @page
     960@c @page
    961961
    962962@subsubsection memfile_lseek() for Regular Files
     
    990990@c
    991991@c
    992 @page
     992@c @page
    993993
    994994@subsubsection IMFS_stat() for Regular Files
     
    10511051@c
    10521052@c
    1053 @page
     1053@c @page
    10541054
    10551055@subsubsection IMFS_fchmod() for Regular Files
     
    10911091@c
    10921092@c
    1093 @page
     1093@c @page
    10941094
    10951095@subsubsection memfile_ftruncate() for Regular Files
     
    11331133@c
    11341134@c
    1135 @page
     1135@c @page
    11361136
    11371137@subsubsection No fsync() for Regular Files
     
    11561156@c
    11571157@c
    1158 @page
     1158@c @page
    11591159
    11601160@subsubsection IMFS_fdatasync() for Regular Files
     
    11781178@c
    11791179@c
    1180 @page
     1180@c @page
    11811181@subsection Directory Handler Table Functions
    11821182
     
    12101210@c
    12111211@c
    1212 @page
     1212@c @page
    12131213@subsubsection IMFS_dir_open() for Directories
    12141214
     
    12441244@c
    12451245@c
    1246 @page
     1246@c @page
    12471247
    12481248@subsubsection IMFS_dir_close() for Directories
     
    12701270@c
    12711271@c
    1272 @page
     1272@c @page
    12731273
    12741274@subsubsection IMFS_dir_read() for Directories
     
    13001300@c
    13011301@c
    1302 @page
     1302@c @page
    13031303
    13041304@subsubsection No write() for Directories
     
    13231323@c
    13241324@c
    1325 @page
     1325@c @page
    13261326
    13271327@subsubsection No ioctl() for Directories
     
    13451345@c
    13461346@c
    1347 @page
     1347@c @page
    13481348
    13491349@subsubsection IMFS_dir_lseek() for Directories
     
    13781378@c
    13791379@c
    1380 @page
     1380@c @page
    13811381
    13821382@subsubsection IMFS_dir_fstat() for Directories
     
    14231423@c
    14241424@c
    1425 @page
     1425@c @page
    14261426
    14271427@subsubsection IMFS_fchmod() for Directories
     
    14631463@c
    14641464@c
    1465 @page
     1465@c @page
    14661466
    14671467@subsubsection No ftruncate() for Directories
     
    14861486@c
    14871487@c
    1488 @page
     1488@c @page
    14891489
    14901490@subsubsection No fpathconf() for Directories
     
    15101510@c
    15111511@c
    1512 @page
     1512@c @page
    15131513
    15141514@subsubsection No fsync() for Directories
     
    15331533@c
    15341534@c
    1535 @page
     1535@c @page
    15361536
    15371537@subsubsection IMFS_fdatasync() for Directories
     
    15561556@c
    15571557@c
    1558 @page
     1558@c @page
    15591559@subsection Device Handler Table Functions
    15601560
     
    15861586@c
    15871587@c
    1588 @page
     1588@c @page
    15891589
    15901590@subsubsection device_open() for Devices
     
    16211621@c
    16221622@c
    1623 @page
     1623@c @page
    16241624
    16251625@subsubsection device_close() for Devices
     
    16531653@c
    16541654@c
    1655 @page
     1655@c @page
    16561656
    16571657@subsubsection device_read() for Devices
     
    17031703@c
    17041704@c
    1705 @page
     1705@c @page
    17061706
    17071707@subsubsection device_write() for Devices
     
    17251725@c
    17261726@c
    1727 @page
     1727@c @page
    17281728
    17291729@subsubsection device_ioctl() for Devices
     
    17701770@c
    17711771@c
    1772 @page
     1772@c @page
    17731773
    17741774@subsubsection device_lseek() for Devices
     
    17981798@c
    17991799@c
    1800 @page
     1800@c @page
    18011801
    18021802@subsubsection IMFS_stat() for Devices
     
    18591859@c
    18601860@c
    1861 @page
     1861@c @page
    18621862
    18631863@subsubsection IMFS_fchmod() for Devices
     
    19001900@c
    19011901@c
    1902 @page
     1902@c @page
    19031903
    19041904@subsubsection No ftruncate() for Devices
     
    19221922@c
    19231923@c
    1924 @page
     1924@c @page
    19251925
    19261926@subsubsection No fpathconf() for Devices
     
    19461946@c
    19471947@c
    1948 @page
     1948@c @page
    19491949
    19501950@subsubsection No fsync() for Devices
     
    19701970@c
    19711971@c
    1972 @page
     1972@c @page
    19731973
    19741974@subsubsection No fdatasync() for Devices
  • doc/filesystem/syscalls.t

    r22cbb9c rde0711ec  
    4646
    4747 
    48 @page
     48@c @page
    4949@section access
    5050
     
    6666function should support other filesystems without alteration.
    6767
    68 @page
     68@c @page
    6969@section chdir
    7070
     
    108108indication of what the current directory is.
    109109
    110 @page
     110@c @page
    111111@section chmod
    112112
     
    117117@subheading Processing:
    118118
    119 This routine is layered on the open(), fchmod () and close () functions. As long as
     119This routine is layered on the open(), fchmod() and close() functions. As long as
    120120the standard interpretation of the mode_t value is maintained, this routine should
    121121not need modification to support other filesystems.
     
    132132After mode modification, the open file descriptor is closed.
    133133
    134 @page
     134@c @page
    135135@section chown
    136136
     
    160160evaluation routine, the desired owner, and group information.
    161161
    162 @page
     162@c @page
    163163@section close
    164164
     
    218218@end enumerate
    219219
    220 @page
     220@c @page
    221221@section closedir
    222222
     
    229229The code was obtained from the BSD group. This routine must clean up the
    230230memory resources that are required to track an open directory. The code is layered
    231 on the close() function and standard memory free () functions. It should not
     231on the close() function and standard memory free() functions. It should not
    232232require alterations to support other filesystems.
    233233
     
    246246
    247247
    248 @page
     248@c @page
    249249@section dup()      Unimplemented
    250250
     
    262262
    263263
    264 @page
     264@c @page
    265265@section dup2()      Unimplemented
    266266
     
    279279
    280280
    281 @page
     281@c @page
    282282@section fchmod
    283283
     
    323323the desired mode as parameters.
    324324
    325 @page
     325@c @page
    326326@section fcntl()
    327327
     
    341341The only commands that have been implemented are the F_GETFD and
    342342F_SETFD. The commands manipulate the LIBIO_FLAGS_CLOSE_ON_EXEC
    343 bit in the -flags- element of the file control block associated with the file
     343bit in the @code{flags} element of the file control block associated with the file
    344344descriptor index.
    345345
     
    360360
    361361
    362 @page
     362@c @page
    363363@section fdatasync
    364364
     
    408408its parameter.
    409409
    410 @page
     410@c @page
    411411@section fpathconf
    412412
     
    491491
    492492
    493 @page
     493@c @page
    494494@section fstat
    495495
     
    538538@end enumerate
    539539
    540 @page
     540@c @page
    541541@section ioctl
    542542
     
    581581
    582582
    583 @page
     583@c @page
    584584@section link
    585585
     
    622622determine if the OPS table contains an entry for the link() function.
    623623
    624 If a link() function is defined, the OPS table link () function will be called to
     624If a link() function is defined, the OPS table link() function will be called to
    625625establish the actual link within the filesystem.
    626626
     
    628628program.
    629629
    630 @page
     630@c @page
    631631@section lseek
    632632
     
    673673
    674674
    675 @page
     675@c @page
    676676@section mkdir
    677677
     
    689689See mknod() for developmental comments.
    690690
    691 @page
     691@c @page
    692692@section mkfifo
    693693
     
    705705See mknod() for developmental comments
    706706
    707 @page
     707@c @page
    708708@section mknod
    709709
     
    771771specific mknod() function exists.
    772772
    773 If the mknod() function exists, call the filesystem specific mknod () function.
     773If the mknod() function exists, call the filesystem specific mknod() function.
    774774Pass the name, mode, device type and the location information associated with the
    775775directory under which the node will be created.
    776776
    777 @page
     777@c @page
    778778@section mount
    779779
     
    823823the mounted filesystem will be returned to the calling function. The specifics
    824824about the processing required at the mount point and within the filesystem being
    825 mounted is isolated in the filesystem specific mount() and fsmount_me ()
     825mounted is isolated in the filesystem specific mount() and fsmount_me()
    826826functions. This allows the generic mount() function to remain unaltered even if
    827827new filesystem types are introduced.
     
    860860mount table chain to record the presence of the mounted filesystem.
    861861
    862 @page
     862@c @page
    863863@section open
    864864
     
    906906and returned to the calling routine.
    907907
    908 @page
     908@c @page
    909909@section opendir
    910910
     
    924924The BSD group provided this routine.
    925925
    926 @page
     926@c @page
    927927@section pathconf
    928928
     
    934934
    935935This routine will obtain the value of one of the path configuration parameters and
    936 return it to the calling routine. It is layered on the generic open() and fpathconf ()
     936return it to the calling routine. It is layered on the generic open() and fpathconf()
    937937functions. These interfaces should not change with the addition of new filesystem
    938938types.
     
    943943
    944944If successful, the file descriptor will be used to access the pathconf value specified
    945 by -name- using the fpathconf() function.
     945by @code{name} using the fpathconf() function.
    946946
    947947The file that was accessed is then closed.
    948948
    949 @page
     949@c @page
    950950@section read
    951951
     
    993993@end enumerate
    994994
    995 @page
     995@c @page
    996996@section readdir
    997997
     
    10131013has been mapped to the Imfs_dir_read() function.
    10141014
    1015 @page
     1015@c @page
    10161016@section unmount
    10171017
     
    10621062@end enumerate
    10631063
    1064 @page
     1064@c @page
    10651065@section eval
    10661066
     
    10771077XXX
    10781078
    1079 @page
     1079@c @page
    10801080@section getdentsc
    10811081
Note: See TracChangeset for help on using the changeset viewer.