← Documents Documentation/ABI/testing/sysfs-class-mic GitHub 원문 ↗

Linux 6.18.37 · ABI / testing

Intel MIC device class sysfs ABI

Intel MIC coprocessor의 identity·card OS state·shutdown reason·boot image·debug log buffer·heartbeat crash detection을 설명합니다.

Source pathDocumentation/ABI/testing/sysfs-class-mic
Source versionLinux v6.18.37
TranslationDUJINLABS 전문 번역 + 해설

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

1. 요약·해설

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

Device topology and identity

sysfs-class-mic:1-34

PCIe MIC coprocessor별 mic<X> instance와 family·silicon stepping 정보를 제공합니다.

Card OS state and shutdown

sysfs-class-mic:36-89

Card OS의 6개 read state, boot·reset·shutdown action과 5개 shutdown reason을 구분합니다.

Boot configuration

sysfs-class-mic:91-136

Kernel command line, /lib/firmware/ 아래 firmware·ramdisk image와 linux·flash bootmode를 설정합니다.

Debug log buffer

sysfs-class-mic:138-164

System.map에서 얻은 log buffer와 length의 kernel virtual address를 설정해 debugfs 접근에 사용합니다.

Crash heartbeat

sysfs-class-mic:166-178

기본 enable된 heartbeat notification과 disable 시 user-space crash detection 책임을 설명합니다.

2. 영어 원문 전체

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

원문 전체 펼치기
1 What: /sys/class/mic/
2 Date: October 2013
3 KernelVersion: 3.13
4 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
5 Description:
6 The mic class directory belongs to Intel MIC devices and
7 provides information per MIC device. An Intel MIC device is a
8 PCIe form factor add-in Coprocessor card based on the Intel Many
9 Integrated Core (MIC) architecture that runs a Linux OS.
10
11 What: /sys/class/mic/mic<X>
12 Date: October 2013
13 KernelVersion: 3.13
14 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
15 Description:
16 The directories /sys/class/mic/mic0, /sys/class/mic/mic1 etc.,
17 represent MIC devices (0,1,..etc). Each directory has
18 information specific to that MIC device.
19
20 What: /sys/class/mic/mic<X>/family
21 Date: October 2013
22 KernelVersion: 3.13
23 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
24 Description:
25 Provides information about the Coprocessor family for an Intel
26 MIC device. For example - "x100"
27
28 What: /sys/class/mic/mic<X>/stepping
29 Date: October 2013
30 KernelVersion: 3.13
31 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
32 Description:
33 Provides information about the silicon stepping for an Intel
34 MIC device. For example - "A0" or "B0"
35
36 What: /sys/class/mic/mic<X>/state
37 Date: October 2013
38 KernelVersion: 3.13
39 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
40 Description:
41 When read, this entry provides the current state of an Intel
42 MIC device in the context of the card OS. Possible values that
43 will be read are:
44
45
46 =============== ===============================================
47 "ready" The MIC device is ready to boot the card OS.
48 On reading this entry after an OSPM resume,
49 a "boot" has to be written to this entry if
50 the card was previously shutdown during OSPM
51 suspend.
52 "booting" The MIC device has initiated booting a card OS.
53 "online" The MIC device has completed boot and is online
54 "shutting_down" The card OS is shutting down.
55 "resetting" A reset has been initiated for the MIC device
56 "reset_failed" The MIC device has failed to reset.
57 =============== ===============================================
58
59 When written, this sysfs entry triggers different state change
60 operations depending upon the current state of the card OS.
61 Acceptable values are:
62
63
64 ========== ===================================================
65 "boot" Boot the card OS image specified by the combination
66 of firmware, ramdisk, cmdline and bootmode
67 sysfs entries.
68 "reset" Initiates device reset.
69 "shutdown" Initiates card OS shutdown.
70 ========== ===================================================
71
72 What: /sys/class/mic/mic<X>/shutdown_status
73 Date: October 2013
74 KernelVersion: 3.13
75 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
76 Description:
77 An Intel MIC device runs a Linux OS during its operation. This
78 OS can shutdown because of various reasons. When read, this
79 entry provides the status on why the card OS was shutdown.
80 Possible values are:
81
82 ========== ===================================================
83 "nop" shutdown status is not applicable, when the card OS
84 is "online"
85 "crashed" Shutdown because of a HW or SW crash.
86 "halted" Shutdown because of a halt command.
87 "poweroff" Shutdown because of a poweroff command.
88 "restart" Shutdown because of a restart command.
89 ========== ===================================================
90
91 What: /sys/class/mic/mic<X>/cmdline
92 Date: October 2013
93 KernelVersion: 3.13
94 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
95 Description:
96 An Intel MIC device runs a Linux OS during its operation. Before
97 booting this card OS, it is possible to pass kernel command line
98 options to configure various features in it, similar to
99 self-bootable machines. When read, this entry provides
100 information about the current kernel command line options set to
101 boot the card OS. This entry can be written to change the
102 existing kernel command line options. Typically, the user would
103 want to read the current command line options, append new ones
104 or modify existing ones and then write the whole kernel command
105 line back to this entry.
106
107 What: /sys/class/mic/mic<X>/firmware
108 Date: October 2013
109 KernelVersion: 3.13
110 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
111 Description:
112 When read, this sysfs entry provides the path name under
113 /lib/firmware/ where the firmware image to be booted on the
114 card can be found. The entry can be written to change the
115 firmware image location under /lib/firmware/.
116
117 What: /sys/class/mic/mic<X>/ramdisk
118 Date: October 2013
119 KernelVersion: 3.13
120 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
121 Description:
122 When read, this sysfs entry provides the path name under
123 /lib/firmware/ where the ramdisk image to be used during card
124 OS boot can be found. The entry can be written to change
125 the ramdisk image location under /lib/firmware/.
126
127 What: /sys/class/mic/mic<X>/bootmode
128 Date: October 2013
129 KernelVersion: 3.13
130 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
131 Description:
132 When read, this sysfs entry provides the current bootmode for
133 the card. This sysfs entry can be written with the following
134 valid strings:
135 a) linux - Boot a Linux image.
136 b) flash - Boot an image for flash updates.
137
138 What: /sys/class/mic/mic<X>/log_buf_addr
139 Date: October 2013
140 KernelVersion: 3.13
141 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
142 Description:
143 An Intel MIC device runs a Linux OS during its operation. For
144 debugging purpose and early kernel boot messages, the user can
145 access the card OS log buffer via debugfs. When read, this entry
146 provides the kernel virtual address of the buffer where the card
147 OS log buffer can be read. This entry is written by the host
148 configuration daemon to set the log buffer address. The correct
149 log buffer address to be written can be found in the System.map
150 file of the card OS.
151
152 What: /sys/class/mic/mic<X>/log_buf_len
153 Date: October 2013
154 KernelVersion: 3.13
155 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
156 Description:
157 An Intel MIC device runs a Linux OS during its operation. For
158 debugging purpose and early kernel boot messages, the user can
159 access the card OS log buffer via debugfs. When read, this entry
160 provides the kernel virtual address where the card OS log buffer
161 length can be read. This entry is written by host configuration
162 daemon to set the log buffer length address. The correct log
163 buffer length address to be written can be found in the
164 System.map file of the card OS.
165
166 What: /sys/class/mic/mic<X>/heartbeat_enable
167 Date: March 2015
168 KernelVersion: 4.4
169 Contact: Ashutosh Dixit <ashutosh.dixit@intel.com>
170 Description:
171 The MIC drivers detect and inform user space about card crashes
172 via a heartbeat mechanism (see the description of
173 shutdown_status above). User space can turn off this
174 notification by setting heartbeat_enable to 0 and enable it by
175 setting this entry to 1. If this notification is disabled it is
176 the responsibility of user space to detect card crashes via
177 alternative means such as a network ping. This setting is
178 enabled by default.
179

3. 한국어 전문 번역

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

Intel MIC device class

1-9
항목한국어 전문 번역
What/sys/class/mic/
Date2013년 10월
KernelVersion3.13
ContactSudeep Dutt <sudeep.dutt@intel.com>
Descriptionmic class directory는 Intel MIC device에 속하며 MIC device별 정보를 제공합니다. Intel MIC device는 Intel Many Integrated Core(MIC) architecture에 기반하고 Linux OS를 실행하는 PCIe form-factor add-in coprocessor card입니다.

MIC device instance

11-18
항목한국어 전문 번역
What/sys/class/mic/mic<X>
Date2013년 10월
KernelVersion3.13
ContactSudeep Dutt <sudeep.dutt@intel.com>
Description/sys/class/mic/mic0, /sys/class/mic/mic1 등의 directory는 MIC device 0, 1 등을 나타냅니다. 각 directory에는 해당 MIC device에 고유한 정보가 들어 있습니다.
MIC sysfs hierarchy
/sys/class/mic/mic<X> per Intel MIC deviceidentity·state·boot·log·heartbeat 속성

Class에서 numbered device instance와 instance별 제어·상태 속성으로 이어지는 구조입니다.

Coprocessor family

20-26
항목한국어 전문 번역
What/sys/class/mic/mic<X>/family
Date2013년 10월
KernelVersion3.13
ContactSudeep Dutt <sudeep.dutt@intel.com>
DescriptionIntel MIC device의 coprocessor family 정보를 제공합니다. 예는 x100입니다.

Silicon stepping

28-34
항목한국어 전문 번역
What/sys/class/mic/mic<X>/stepping
Date2013년 10월
KernelVersion3.13
ContactSudeep Dutt <sudeep.dutt@intel.com>
DescriptionIntel MIC device의 silicon stepping 정보를 제공합니다. 예는 A0 또는 B0입니다.
MIC identity attributes
속성의미원문 예
familyCoprocessor familyx100
steppingSilicon steppingA0 또는 B0

Coprocessor 계열과 silicon revision 정보를 구분합니다.

Card OS state and actions

36-70
항목한국어 전문 번역
What/sys/class/mic/mic<X>/state
Date2013년 10월
KernelVersion3.13
ContactSudeep Dutt <sudeep.dutt@intel.com>
Description읽으면 card OS 관점의 현재 Intel MIC device state를 제공합니다. 가능한 read 값은 ready, booting, online, shutting_down, resetting, reset_failed입니다. 쓰면 card OS의 현재 state에 따라 state-change operation을 trigger하며 허용되는 값은 boot, reset, shutdown입니다.
MIC state read value
State의미
readyCard OS를 boot할 준비가 됨. OSPM suspend 중 이전에 shutdown된 card라면 OSPM resume 뒤 이 항목을 읽고 boot를 써야 함
bootingCard OS boot를 시작함
onlineBoot를 완료하고 online 상태임
shutting_downCard OS가 shutdown 중임
resettingMIC device reset이 시작됨
reset_failedMIC device reset 실패

원문 첫 번째 ASCII 표의 read state와 의미입니다.

MIC state write action
Write 값Operation
bootfirmware·ramdisk·cmdline·bootmode 조합이 지정한 card OS image boot
resetDevice reset 시작
shutdownCard OS shutdown 시작

원문 두 번째 ASCII 표의 허용 write 값과 operation입니다.

Card OS shutdown status

72-89
항목한국어 전문 번역
What/sys/class/mic/mic<X>/shutdown_status
Date2013년 10월
KernelVersion3.13
ContactSudeep Dutt <sudeep.dutt@intel.com>
DescriptionIntel MIC device의 Linux OS가 shutdown된 이유를 읽어 제공합니다. 가능한 값은 nop, crashed, halted, poweroff, restart입니다.
MIC shutdown status
Status의미
nopCard OS가 online일 때 shutdown status가 적용되지 않음
crashedHardware 또는 software crash로 shutdown
haltedhalt command로 shutdown
poweroffpoweroff command로 shutdown
restartrestart command로 shutdown

원문 ASCII 표의 shutdown reason을 구조화했습니다.

Card OS kernel command line

91-105
항목한국어 전문 번역
What/sys/class/mic/mic<X>/cmdline
Date2013년 10월
KernelVersion3.13
ContactSudeep Dutt <sudeep.dutt@intel.com>
DescriptionCard OS를 boot하기 전에 self-bootable machine과 비슷하게 여러 feature를 구성하는 kernel command-line option을 전달할 수 있습니다. 읽으면 card OS boot에 설정된 현재 option을 제공하고 쓰면 기존 option을 변경합니다. 일반적으로 현재 command line을 읽고 새 option을 추가하거나 기존 option을 수정한 뒤 전체 kernel command line을 이 항목에 다시 씁니다.

Card firmware image

107-115
항목한국어 전문 번역
What/sys/class/mic/mic<X>/firmware
Date2013년 10월
KernelVersion3.13
ContactSudeep Dutt <sudeep.dutt@intel.com>
Description읽으면 card에서 boot할 firmware image가 있는 /lib/firmware/ 아래 path name을 제공합니다. 쓰면 /lib/firmware/ 아래 firmware image 위치를 변경합니다.

Card OS ramdisk image

117-125
항목한국어 전문 번역
What/sys/class/mic/mic<X>/ramdisk
Date2013년 10월
KernelVersion3.13
ContactSudeep Dutt <sudeep.dutt@intel.com>
Description읽으면 card OS boot 중 사용할 ramdisk image가 있는 /lib/firmware/ 아래 path name을 제공합니다. 쓰면 /lib/firmware/ 아래 ramdisk image 위치를 변경합니다.

Card boot mode

127-136
항목한국어 전문 번역
What/sys/class/mic/mic<X>/bootmode
Date2013년 10월
KernelVersion3.13
ContactSudeep Dutt <sudeep.dutt@intel.com>
Description읽으면 card의 현재 bootmode를 제공합니다. 쓸 수 있는 유효 문자열은 Linux image를 boot하는 linux와 flash update용 image를 boot하는 flash입니다.
MIC boot mode
Bootmode동작
linuxLinux image boot
flashFlash update용 image boot

원문 목록의 유효 bootmode 문자열입니다.

Card OS log buffer address

138-150
항목한국어 전문 번역
What/sys/class/mic/mic<X>/log_buf_addr
Date2013년 10월
KernelVersion3.13
ContactSudeep Dutt <sudeep.dutt@intel.com>
DescriptionDebugging과 early kernel boot message를 위해 user는 debugfs를 통해 card OS log buffer에 접근할 수 있습니다. 읽으면 card OS log buffer를 읽을 수 있는 buffer의 kernel virtual address를 제공합니다. Host configuration daemon이 log buffer address를 설정하기 위해 이 항목을 씁니다. 쓸 올바른 log buffer address는 card OS의 System.map file에서 찾을 수 있습니다.

Card OS log buffer length address

152-164
항목한국어 전문 번역
What/sys/class/mic/mic<X>/log_buf_len
Date2013년 10월
KernelVersion3.13
ContactSudeep Dutt <sudeep.dutt@intel.com>
DescriptionDebugging과 early kernel boot message를 위해 user는 debugfs를 통해 card OS log buffer에 접근할 수 있습니다. 읽으면 card OS log buffer length를 읽을 수 있는 kernel virtual address를 제공합니다. Host configuration daemon이 log buffer length address를 설정하기 위해 이 항목을 씁니다. 쓸 올바른 address는 card OS의 System.map file에서 찾을 수 있습니다.
MIC log buffer symbols
속성주소가 가리키는 대상접근 경로
log_buf_addrCard OS log bufferdebugfs
log_buf_lenCard OS log buffer lengthdebugfs

두 속성은 모두 System.map에서 찾은 kernel virtual address를 host configuration daemon이 설정합니다.

Card crash heartbeat

166-178
항목한국어 전문 번역
What/sys/class/mic/mic<X>/heartbeat_enable
Date2015년 3월
KernelVersion4.4
ContactAshutosh Dixit <ashutosh.dixit@intel.com>
DescriptionMIC driver는 heartbeat mechanism으로 card crash를 감지하고 user space에 알립니다. shutdown_status 설명도 참조하십시오. heartbeat_enable을 0으로 설정하면 notification을 끄고 1로 설정하면 켭니다. Notification을 disable하면 network ping 같은 대체 방법으로 card crash를 감지할 책임이 user space에 있습니다. 기본값은 enable입니다.
MIC heartbeat notification
NotificationCrash detection
0DisabledUser space가 network ping 등으로 감지
1Enabled, 기본값MIC driver heartbeat가 감지·통지

Heartbeat setting과 crash detection 책임을 구분합니다.