udev.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  4. <!ENTITY % general-entities SYSTEM "../general.ent">
  5. %general-entities;
  6. ]>
  7. <sect1 id="ch-system-udev" role="wrap">
  8. <?dbhtml filename="udev.html"?>
  9. <title>Udev-&udev-version;</title>
  10. <indexterm zone="ch-system-udev">
  11. <primary sortas="a-Udev">Udev</primary>
  12. </indexterm>
  13. <sect2 role="package">
  14. <title/>
  15. <para>The Udev package contains programs for dynamic creation of device
  16. nodes.</para>
  17. <segmentedlist>
  18. <segtitle>&buildtime;</segtitle>
  19. <segtitle>&diskspace;</segtitle>
  20. <seglistitem>
  21. <seg>&udev-ch6-sbu;</seg>
  22. <seg>&udev-ch6-du;</seg>
  23. </seglistitem>
  24. </segmentedlist>
  25. </sect2>
  26. <sect2 role="installation">
  27. <title>Installation of Udev</title>
  28. <para>The udev-config tarball contains LFS-specific files used to configure
  29. Udev.</para>
  30. <screen><userinput>tar xf ../&udev-config;.tar.bz2</userinput></screen>
  31. <para>Create some devices and directories that Udev cannot handle due to
  32. them being required very early in the boot process:</para>
  33. <screen><userinput>install -dv /lib/{firmware,udev/devices/{pts,shm}}
  34. mknod -m0666 /lib/udev/devices/null c 1 3
  35. ln -sv /proc/self/fd /lib/udev/devices/fd
  36. ln -sv /proc/self/fd/0 /lib/udev/devices/stdin
  37. ln -sv /proc/self/fd/1 /lib/udev/devices/stdout
  38. ln -sv /proc/self/fd/2 /lib/udev/devices/stderr
  39. ln -sv /proc/kcore /lib/udev/devices/core</userinput></screen>
  40. <para>Compile the package:</para>
  41. <screen><userinput>make EXTRAS="extras/ata_id extras/cdrom_id extras/edd_id \
  42. extras/firmware extras/floppy extras/path_id \
  43. extras/scsi_id extras/usb_id extras/volume_id"</userinput></screen>
  44. <variablelist>
  45. <title>The meaning of the make option:</title>
  46. <varlistentry>
  47. <term><parameter>EXTRAS=...</parameter></term>
  48. <listitem>
  49. <para>This builds several helper binaries that can aid in writing custom
  50. Udev rules.</para>
  51. </listitem>
  52. </varlistentry>
  53. </variablelist>
  54. <para>To test the results, issue:
  55. <userinput>make test</userinput>.</para>
  56. <para>Install the package:</para>
  57. <screen><userinput>make DESTDIR=/ \
  58. EXTRAS="extras/ata_id extras/cdrom_id extras/edd_id \
  59. extras/firmware extras/floppy extras/path_id \
  60. extras/scsi_id extras/usb_id extras/volume_id" install</userinput></screen>
  61. <variablelist>
  62. <title>The meaning of the make parameter:</title>
  63. <varlistentry>
  64. <term><parameter>DESTDIR=/</parameter></term>
  65. <listitem>
  66. <para>This prevents the Udev build process from killing any
  67. <command>udevd</command> processes that may be running on the
  68. host system.</para>
  69. </listitem>
  70. </varlistentry>
  71. </variablelist>
  72. <para>Udev's configuration is far from ideal by default, so install
  73. the configuration files here:</para>
  74. <!-- FIXME: 90-bug.rules should be removed from the tarball once the book is released -->
  75. <screen><userinput>cp -v &udev-config;/[0-9]* /etc/udev/rules.d/</userinput></screen>
  76. <para>Now install a helper script that is not included in the main Udev
  77. tarball:</para>
  78. <screen><userinput>install -v -m 744 &udev-config;/write_cd_aliases /lib/udev/</userinput></screen>
  79. <para>Install the documentation that explains how to create Udev rules:</para>
  80. <screen><userinput>install -m644 -D -v docs/writing_udev_rules/index.html \
  81. /usr/share/doc/udev-&udev-version;/index.html</userinput></screen>
  82. <important>
  83. <para>When Udev is started by the LFS-Bootscripts, a replay of all kernel
  84. device events happens. These events tell Udev what devices exist.
  85. Sometimes the Udev bootscript doesn't wait long enough for
  86. <command>udevd</command> to process all of the replayed events and
  87. consequently the devices for those missed events are not created before the
  88. script exits. Since <command>udevd</command> is still running in the
  89. background, the devices will be created a few milliseconds later, but the
  90. next bootscript to run may require a device to exist before it has been
  91. created. To avoid such missed events, and to avoid hardcoding an overly
  92. long wait time, It is recommended that you run the following commands to
  93. aid the LFS development team in debugging these missed events and finding
  94. an acceptable solution more quickly.</para>
  95. <para>First, create a simple C file:</para>
  96. <screen><userinput>cat &gt; bug.c &lt;&lt; EOF
  97. <literal>/* Simple event recorder */
  98. #define _GNU_SOURCE
  99. #include &lt;sys/types.h&gt;
  100. #include &lt;sys/stat.h&gt;
  101. #include &lt;fcntl.h&gt;
  102. #include &lt;unistd.h&gt;
  103. #include &lt;stdlib.h&gt;
  104. #include &lt;argz.h&gt;
  105. int main(int argc, char * argv[])
  106. {
  107. char * envar;
  108. char * envz;
  109. size_t len;
  110. int bug;
  111. bug = open("/dev/bug", O_WRONLY | O_APPEND);
  112. if (bug == -1)
  113. return 0;
  114. /* Ignore everything USB-related to avoid spamming the list */
  115. envar = getenv("PHYSDEVPATH");
  116. if (envar &amp;&amp; strstr(envar, "usb"))
  117. return 0;
  118. envar = getenv("DEVPATH");
  119. if (envar &amp;&amp; strstr(envar, "usb"))
  120. return 0;
  121. setenv("_SEPARATOR", "-------------------------------", 1);
  122. argz_create(environ, &amp;envz, &amp;len);
  123. argz_stringify(envz, len, '\n');
  124. envz[len-1]='\n';
  125. write(bug, envz, len);
  126. close(bug);
  127. free(envz);
  128. return 0;
  129. }</literal>
  130. EOF</userinput></screen>
  131. <para>Now compile it:</para>
  132. <screen><userinput>gcc -o /lib/udev/bug bug.c</userinput></screen>
  133. <para>When booting the new LFS system, if any events are missed, a warning
  134. message will appear and a <filename>/dev/bugreport</filename> file will be
  135. created. The warning message will tell you where to send feedback.</para>
  136. </important>
  137. </sect2>
  138. <sect2 id="contents-udev" role="content">
  139. <title>Contents of Udev</title>
  140. <segmentedlist>
  141. <segtitle>Installed programs</segtitle>
  142. <segtitle>Installed directory</segtitle>
  143. <seglistitem>
  144. <seg>ata_id, cdrom_id, create_floppy_devices, edd_id, firmware_helper,
  145. path_id, scsi_id, udevcontrol, udevd, udevinfo, udevmonitor, udevsettle,
  146. udevtest, udevtrigger, usb_id, vol_id, and write_cd_aliases</seg>
  147. <seg>/etc/udev</seg>
  148. </seglistitem>
  149. </segmentedlist>
  150. <variablelist>
  151. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  152. <?dbfo list-presentation="list"?>
  153. <?dbhtml list-presentation="table"?>
  154. <varlistentry id="ata_id">
  155. <term><command>ata_id</command></term>
  156. <listitem>
  157. <para>Provides Udev with a unique string and
  158. additional information (uuid, label) for an ATA drive</para>
  159. <indexterm zone="ch-system-udev ata_id">
  160. <primary sortas="b-ata_id">ata_id</primary>
  161. </indexterm>
  162. </listitem>
  163. </varlistentry>
  164. <varlistentry id="cdrom_id">
  165. <term><command>cdrom_id</command></term>
  166. <listitem>
  167. <para>Provides Udev with the capabilities of a
  168. CD-ROM or DVD-ROM drive</para>
  169. <indexterm zone="ch-system-udev cdrom_id">
  170. <primary sortas="b-cdrom_id">cdrom_id</primary>
  171. </indexterm>
  172. </listitem>
  173. </varlistentry>
  174. <varlistentry id="create_floppy_devices">
  175. <term><command>create_floppy_devices</command></term>
  176. <listitem>
  177. <para>Creates all possible floppy devices based on the CMOS type</para>
  178. <indexterm zone="ch-system-udev create_floppy_devices">
  179. <primary sortas="b-create_floppy_devices">create_floppy_devices</primary>
  180. </indexterm>
  181. </listitem>
  182. </varlistentry>
  183. <varlistentry id="edd_id">
  184. <term><command>edd_id</command></term>
  185. <listitem>
  186. <para>Provides Udev with the EDD ID for a BIOS disk drive</para>
  187. <indexterm zone="ch-system-udev edd_id">
  188. <primary sortas="b-edd_id">edd_id</primary>
  189. </indexterm>
  190. </listitem>
  191. </varlistentry>
  192. <varlistentry id="firmware_helper">
  193. <term><command>firmware_helper</command></term>
  194. <listitem>
  195. <para>Uploads firmware to devices</para>
  196. <indexterm zone="ch-system-udev firmware_helper">
  197. <primary sortas="b-firmware_helper">firmware_helper</primary>
  198. </indexterm>
  199. </listitem>
  200. </varlistentry>
  201. <varlistentry id="path_id">
  202. <term><command>path_id</command></term>
  203. <listitem>
  204. <para>Provide the shortest possible unique hardware path to a
  205. device</para>
  206. <indexterm zone="ch-system-udev path_id">
  207. <primary sortas="b-path_id">path_id</primary>
  208. </indexterm>
  209. </listitem>
  210. </varlistentry>
  211. <varlistentry id="scsi_id">
  212. <term><command>scsi_id</command></term>
  213. <listitem>
  214. <para>Provides Udev with a unique SCSI identifier
  215. based on the data returned from sending a SCSI INQUIRY command to
  216. the specified device</para>
  217. <indexterm zone="ch-system-udev scsi_id">
  218. <primary sortas="b-scsi_id">scsi_id</primary>
  219. </indexterm>
  220. </listitem>
  221. </varlistentry>
  222. <varlistentry id="udevcontrol">
  223. <term><command>udevcontrol</command></term>
  224. <listitem>
  225. <para>Configures a number of options for the running
  226. <command>udevd</command> daemon, such as the log level.</para>
  227. <indexterm zone="ch-system-udev udevcontrol">
  228. <primary sortas="b-udevcontrol">udevcontrol</primary>
  229. </indexterm>
  230. </listitem>
  231. </varlistentry>
  232. <varlistentry id="udevd">
  233. <term><command>udevd</command></term>
  234. <listitem>
  235. <para>A daemon that listens for uevents on the netlink socket,
  236. creates devices and runs the configured external programs in
  237. response to these uevents</para>
  238. <indexterm zone="ch-system-udev udevd">
  239. <primary sortas="b-udevd">udevd</primary>
  240. </indexterm>
  241. </listitem>
  242. </varlistentry>
  243. <varlistentry id="udevinfo">
  244. <term><command>udevinfo</command></term>
  245. <listitem>
  246. <para>Allows users to query the Udev database for
  247. information on any device currently present on the system; it also
  248. provides a way to query any device in the <systemitem
  249. class="filesystem">sysfs</systemitem> tree to help create udev
  250. rules</para>
  251. <indexterm zone="ch-system-udev udevinfo">
  252. <primary sortas="b-udevinfo">udevinfo</primary>
  253. </indexterm>
  254. </listitem>
  255. </varlistentry>
  256. <varlistentry id="udevmonitor">
  257. <term><command>udevmonitor</command></term>
  258. <listitem>
  259. <para>Prints the event received from the kernel and the environment
  260. which Udev sends out after rule processing</para>
  261. <indexterm zone="ch-system-udev udevmonitor">
  262. <primary sortas="b-udevmonitor">udevmonitor</primary>
  263. </indexterm>
  264. </listitem>
  265. </varlistentry>
  266. <varlistentry id="udevsettle">
  267. <term><command>udevsettle</command></term>
  268. <listitem>
  269. <para>Watches the Udev event queue and exits if all current uevents
  270. have been handled</para>
  271. <indexterm zone="ch-system-udev udevsettle">
  272. <primary sortas="b-udevsettle">udevsettle</primary>
  273. </indexterm>
  274. </listitem>
  275. </varlistentry>
  276. <varlistentry id="udevtest">
  277. <term><command>udevtest</command></term>
  278. <listitem>
  279. <para>Simulates a uevent for the given device, and prints out the
  280. name of the node the real <command>udevd</command> would have created,
  281. or the name of the renamed network interface</para>
  282. <indexterm zone="ch-system-udev udevtest">
  283. <primary sortas="b-udevtest">udevtest</primary>
  284. </indexterm>
  285. </listitem>
  286. </varlistentry>
  287. <varlistentry id="udevtrigger">
  288. <term><command>udevtrigger</command></term>
  289. <listitem>
  290. <para>Triggers kernel device uevents to be replayed</para>
  291. <indexterm zone="ch-system-udev udevtrigger">
  292. <primary sortas="b-udevtrigger">udevtrigger</primary>
  293. </indexterm>
  294. </listitem>
  295. </varlistentry>
  296. <varlistentry id="usb_id">
  297. <term><command>usb_id</command></term>
  298. <listitem>
  299. <para>Provides Udev with information about USB
  300. devices</para>
  301. <indexterm zone="ch-system-udev usb_id">
  302. <primary sortas="b-usb_id">usb_id</primary>
  303. </indexterm>
  304. </listitem>
  305. </varlistentry>
  306. <varlistentry id="vol_id">
  307. <term><command>vol_id</command></term>
  308. <listitem>
  309. <para>Provides Udev with the label and uuid of a
  310. filesystem</para>
  311. <indexterm zone="ch-system-udev vol_id">
  312. <primary sortas="b-vol_id">vol_id</primary>
  313. </indexterm>
  314. </listitem>
  315. </varlistentry>
  316. <varlistentry id="etc-udev">
  317. <term><filename class="directory">/etc/udev</filename></term>
  318. <listitem>
  319. <para>Contains Udev configuation files,
  320. device permissions, and rules for device naming</para>
  321. <indexterm zone="ch-system-udev etc-udev">
  322. <primary sortas="e-/etc/udev">/etc/udev</primary>
  323. </indexterm>
  324. </listitem>
  325. </varlistentry>
  326. </variablelist>
  327. </sect2>
  328. </sect1>