Linux Filesystems API summary | Linux 6.18.37

요약·해설과 원문, 전문 번역을 서로 분리했습니다. API 이름, symbol, source path는 원문 표기를 사용합니다.

1. 요약·해설

원문의 핵심 논리와 kernel programming 관점의 보충 설명입니다. 아래의 전문 번역과는 별도로 작성했습니다.

요약·해설

api-summary.rst:1-147

이 문서는 VFS, proc, eventfd, epoll, sysfs, debugfs API를 실제 source file의 kernel-doc에서 조립하는 색인입니다.

filesystem API 큰 영역

영역대표 source

VFS`include/linux/fs.h`, `fs/dcache.c`, `fs/inode.c`

proc`kernel/sysctl.c`, `fs/proc/base.c`

event`fs/eventfd.c`, `fs/eventpoll.c`

sysfs`fs/sysfs/file.c`, `fs/sysfs/symlink.c`

debugfs`fs/debugfs/inode.c`, `fs/debugfs/file.c`

source API가 묶이는 상위 section입니다.

2. 영어 원문 전체

번역 기준이 된 Linux v6.18.37 원문입니다. 줄 번호는 이 버전의 파일 좌표입니다.

원문 전체 펼치기

1 =============================

2 Linux Filesystems API summary

3 =============================

5 This section contains API-level documentation, mostly taken from the source

6 code itself.

8 The Linux VFS

9 =============

11 The Filesystem types

12 --------------------

14 .. kernel-doc:: include/linux/fs.h

15 :internal:

17 The Directory Cache

18 -------------------

20 .. kernel-doc:: fs/dcache.c

21 :export:

23 .. kernel-doc:: include/linux/dcache.h

24 :internal:

26 Inode Handling

27 --------------

29 .. kernel-doc:: fs/inode.c

30 :export:

32 .. kernel-doc:: fs/bad_inode.c

33 :export:

35 Registration and Superblocks

36 ----------------------------

38 .. kernel-doc:: fs/super.c

39 :export:

41 File Locks

42 ----------

44 .. kernel-doc:: fs/locks.c

45 :export:

47 .. kernel-doc:: fs/locks.c

48 :internal:

50 Other Functions

51 ---------------

53 .. kernel-doc:: fs/mpage.c

54 :export:

56 .. kernel-doc:: fs/namei.c

57 :export:

59 .. kernel-doc:: block/bio.c

60 :export:

62 .. kernel-doc:: fs/seq_file.c

63 :export:

65 .. kernel-doc:: fs/filesystems.c

66 :export:

68 .. kernel-doc:: fs/fs-writeback.c

69 :export:

71 .. kernel-doc:: fs/anon_inodes.c

72 :export:

74 .. kernel-doc:: fs/attr.c

75 :export:

77 .. kernel-doc:: fs/d_path.c

78 :export:

80 .. kernel-doc:: fs/dax.c

81 :export:

83 .. kernel-doc:: fs/libfs.c

84 :export:

86 .. kernel-doc:: fs/posix_acl.c

87 :export:

89 .. kernel-doc:: fs/stat.c

90 :export:

92 .. kernel-doc:: fs/sync.c

93 :export:

95 .. kernel-doc:: fs/xattr.c

96 :export:

98 .. kernel-doc:: fs/namespace.c

99 :export:

100

101 The proc filesystem

102 ===================

103

104 sysctl interface

105 ----------------

106

107 .. kernel-doc:: kernel/sysctl.c

108 :export:

109

110 proc filesystem interface

111 -------------------------

112

113 .. kernel-doc:: fs/proc/base.c

114 :internal:

115

116 Events based on file descriptors

117 ================================

118

119 .. kernel-doc:: fs/eventfd.c

120 :export:

121

122 eventpoll (epoll) interfaces

123 ============================

124

125 .. kernel-doc:: fs/eventpoll.c

126 :internal:

127

128 The Filesystem for Exporting Kernel Objects

129 ===========================================

130

131 .. kernel-doc:: fs/sysfs/file.c

132 :export:

133

134 .. kernel-doc:: fs/sysfs/symlink.c

135 :export:

136

137 The debugfs filesystem

138 ======================

139

140 debugfs interface

141 -----------------

142

143 .. kernel-doc:: fs/debugfs/inode.c

144 :export:

145

146 .. kernel-doc:: fs/debugfs/file.c

147 :export:

148

3. 한국어 전문 번역

영어 원문의 문단 순서와 의미를 유지한 전체 번역입니다. 코드, 함수명, symbol과 URL은 원문 표기를 유지합니다.

filesystem API summary의 범위

1-7

이 문서는 Linux filesystem의 API-level documentation을 모은 색인입니다. 대부분의 내용은 source code의 kernel-doc comment에서 직접 추출됩니다.

`.. kernel-doc:: path` directive는 해당 source file의 문서를 가져옵니다. `:export:`는 export된 API를, `:internal:`은 내부 API를 포함한다는 뜻입니다.

kernel-doc 범위 option

option포함 범위

`:export:`외부에서 사용할 수 있도록 export된 kernel API

`:internal:`해당 source의 내부 구현 API

이 문서에서 사용하는 두 directive option입니다.

=============================
Linux Filesystems API summary
=============================

This section contains API-level documentation, mostly taken from the source
code itself.

Linux VFS API source 목록

8-100

Filesystem type은 `include/linux/fs.h`의 internal 문서에서, directory cache는 `fs/dcache.c`의 export API와 `include/linux/dcache.h`의 internal API에서 가져옵니다.

inode 처리는 `fs/inode.c`와 `fs/bad_inode.c`, registration과 superblock은 `fs/super.c`, file lock은 `fs/locks.c`의 export 및 internal 문서에서 가져옵니다.

VFS 핵심 영역

영역source path범위

Filesystem types`include/linux/fs.h``:internal:`

Directory Cache`fs/dcache.c``:export:`

Directory Cache`include/linux/dcache.h``:internal:`

Inode Handling`fs/inode.c``:export:`

Bad Inode`fs/bad_inode.c``:export:`

Registration and Superblocks`fs/super.c``:export:`

File Locks`fs/locks.c``:export:` 및 `:internal:`

원문의 section과 kernel-doc source path를 보존했습니다.

Other Functions 절은 multi-page I/O, pathname lookup, block I/O, sequence file, filesystem registration, writeback, anonymous inode, attribute, path formatting, DAX, library helper, POSIX ACL, stat, sync, xattr, mount namespace API를 모읍니다.

VFS 기타 API source

source path주요 영역범위

`fs/mpage.c`multi-page block I/O helper`:export:`

`fs/namei.c`pathname lookup`:export:`

`block/bio.c`block I/O`:export:`

`fs/seq_file.c`sequential virtual file output`:export:`

`fs/filesystems.c`filesystem registration`:export:`

`fs/fs-writeback.c`dirty data writeback`:export:`

`fs/anon_inodes.c`anonymous inode`:export:`

`fs/attr.c`inode attribute update`:export:`

`fs/d_path.c`path 문자열 생성`:export:`

`fs/dax.c`Direct Access helper`:export:`

`fs/libfs.c`filesystem library helper`:export:`

`fs/posix_acl.c`POSIX ACL`:export:`

`fs/stat.c`file status`:export:`

`fs/sync.c`filesystem sync`:export:`

`fs/xattr.c`extended attribute`:export:`

`fs/namespace.c`mount namespace`:export:`

모든 `Other Functions` kernel-doc directive를 원문 순서대로 정리했습니다.

The Linux VFS
=============

The Filesystem types
--------------------

.. kernel-doc:: include/linux/fs.h
   :internal:

The Directory Cache
-------------------

.. kernel-doc:: fs/dcache.c
   :export:

.. kernel-doc:: include/linux/dcache.h
   :internal:

Inode Handling
--------------

.. kernel-doc:: fs/inode.c
   :export:

.. kernel-doc:: fs/bad_inode.c
   :export:

Registration and Superblocks
----------------------------

.. kernel-doc:: fs/super.c
   :export:

File Locks
----------

.. kernel-doc:: fs/locks.c
   :export:

.. kernel-doc:: fs/locks.c
   :internal:

Other Functions
---------------

.. kernel-doc:: fs/mpage.c
   :export:

.. kernel-doc:: fs/namei.c
   :export:

.. kernel-doc:: block/bio.c
   :export:

.. kernel-doc:: fs/seq_file.c
   :export:

.. kernel-doc:: fs/filesystems.c
   :export:

.. kernel-doc:: fs/fs-writeback.c
   :export:

.. kernel-doc:: fs/anon_inodes.c
   :export:

.. kernel-doc:: fs/attr.c
   :export:

.. kernel-doc:: fs/d_path.c
   :export:

.. kernel-doc:: fs/dax.c
   :export:

.. kernel-doc:: fs/libfs.c
   :export:

.. kernel-doc:: fs/posix_acl.c
   :export:

.. kernel-doc:: fs/stat.c
   :export:

.. kernel-doc:: fs/sync.c
   :export:

.. kernel-doc:: fs/xattr.c
   :export:

.. kernel-doc:: fs/namespace.c
   :export:

proc filesystem API

101-115

proc filesystem의 sysctl interface는 `kernel/sysctl.c`에서 export된 API를 가져옵니다. process별 proc interface는 `fs/proc/base.c`의 internal API를 가져옵니다.

proc API source

영역source path범위

sysctl interface`kernel/sysctl.c``:export:`

proc filesystem interface`fs/proc/base.c``:internal:`

sysctl과 proc process interface를 구분합니다.

The proc filesystem
===================

sysctl interface
----------------

.. kernel-doc:: kernel/sysctl.c
   :export:

proc filesystem interface
-------------------------

.. kernel-doc:: fs/proc/base.c
   :internal:

file descriptor 기반 event API

116-121

file descriptor를 기반으로 event를 전달하는 API 문서는 `fs/eventfd.c`의 export된 kernel-doc에서 가져옵니다.

eventfd API 위치

`fs/eventfd.c`의 kernel-doc comment`:export:` symbol 선택Events based on file descriptors section에 렌더링

source에서 API summary로 이어지는 문서 경로입니다.

Events based on file descriptors
================================

.. kernel-doc:: fs/eventfd.c
   :export:

eventpoll(epoll) internal interface

122-127

eventpoll, 즉 epoll interface 문서는 `fs/eventpoll.c`의 internal kernel-doc에서 가져옵니다.

epoll API source

영역source path범위

eventpoll (epoll)`fs/eventpoll.c``:internal:`

원문 directive를 구조화했습니다.

eventpoll (epoll) interfaces
============================

.. kernel-doc:: fs/eventpoll.c
   :internal:

kernel object export용 sysfs API

128-136

kernel object를 userspace에 export하는 sysfs filesystem 문서는 `fs/sysfs/file.c`와 `fs/sysfs/symlink.c`의 export API를 포함합니다.

sysfs API source

영역source path범위

sysfs file`fs/sysfs/file.c``:export:`

sysfs symlink`fs/sysfs/symlink.c``:export:`

file과 symbolic link API source입니다.

The Filesystem for Exporting Kernel Objects
===========================================

.. kernel-doc:: fs/sysfs/file.c
   :export:

.. kernel-doc:: fs/sysfs/symlink.c
   :export:

debugfs interface API

137-147

debugfs interface 문서는 inode 생성·관리용 `fs/debugfs/inode.c`와 file operation용 `fs/debugfs/file.c`의 export API를 가져옵니다.

debugfs API source

영역source path범위

inode/interface`fs/debugfs/inode.c``:export:`

file operation`fs/debugfs/file.c``:export:`

debugfs의 두 source 영역입니다.

The debugfs filesystem
======================

debugfs interface
-----------------

.. kernel-doc:: fs/debugfs/inode.c
   :export:

.. kernel-doc:: fs/debugfs/file.c
   :export: