printk.c 65 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647
  1. /*
  2. * linux/kernel/printk.c
  3. *
  4. * Copyright (C) 1991, 1992 Linus Torvalds
  5. *
  6. * Modified to make sys_syslog() more flexible: added commands to
  7. * return the last 4k of kernel messages, regardless of whether
  8. * they've been read or not. Added option to suppress kernel printk's
  9. * to the console. Added hook for sending the console messages
  10. * elsewhere, in preparation for a serial line console (someday).
  11. * Ted Ts'o, 2/11/93.
  12. * Modified for sysctl support, 1/8/97, Chris Horn.
  13. * Fixed SMP synchronization, 08/08/99, Manfred Spraul
  14. * manfred@colorfullife.com
  15. * Rewrote bits to get rid of console_lock
  16. * 01Mar01 Andrew Morton
  17. */
  18. #include <linux/kernel.h>
  19. #include <linux/mm.h>
  20. #include <linux/tty.h>
  21. #include <linux/tty_driver.h>
  22. #include <linux/console.h>
  23. #include <linux/init.h>
  24. #include <linux/jiffies.h>
  25. #include <linux/nmi.h>
  26. #include <linux/module.h>
  27. #include <linux/moduleparam.h>
  28. #include <linux/interrupt.h> /* For in_interrupt() */
  29. #include <linux/delay.h>
  30. #include <linux/smp.h>
  31. #include <linux/security.h>
  32. #include <linux/bootmem.h>
  33. #include <linux/memblock.h>
  34. #include <linux/syscalls.h>
  35. #include <linux/kexec.h>
  36. #include <linux/kdb.h>
  37. #include <linux/ratelimit.h>
  38. #include <linux/kmsg_dump.h>
  39. #include <linux/syslog.h>
  40. #include <linux/cpu.h>
  41. #include <linux/notifier.h>
  42. #include <linux/rculist.h>
  43. #include <linux/poll.h>
  44. #include <asm/uaccess.h>
  45. #define CREATE_TRACE_POINTS
  46. #include <trace/events/printk.h>
  47. /*
  48. * Architectures can override it:
  49. */
  50. void asmlinkage __attribute__((weak)) early_printk(const char *fmt, ...)
  51. {
  52. }
  53. /* printk's without a loglevel use this.. */
  54. #define DEFAULT_MESSAGE_LOGLEVEL CONFIG_DEFAULT_MESSAGE_LOGLEVEL
  55. /* We show everything that is MORE important than this.. */
  56. #define MINIMUM_CONSOLE_LOGLEVEL 1 /* Minimum loglevel we let people use */
  57. #define DEFAULT_CONSOLE_LOGLEVEL 7 /* anything MORE serious than KERN_DEBUG */
  58. DECLARE_WAIT_QUEUE_HEAD(log_wait);
  59. int console_printk[4] = {
  60. DEFAULT_CONSOLE_LOGLEVEL, /* console_loglevel */
  61. DEFAULT_MESSAGE_LOGLEVEL, /* default_message_loglevel */
  62. MINIMUM_CONSOLE_LOGLEVEL, /* minimum_console_loglevel */
  63. DEFAULT_CONSOLE_LOGLEVEL, /* default_console_loglevel */
  64. };
  65. /*
  66. * Low level drivers may need that to know if they can schedule in
  67. * their unblank() callback or not. So let's export it.
  68. */
  69. int oops_in_progress;
  70. EXPORT_SYMBOL(oops_in_progress);
  71. /*
  72. * console_sem protects the console_drivers list, and also
  73. * provides serialisation for access to the entire console
  74. * driver system.
  75. */
  76. static DEFINE_SEMAPHORE(console_sem);
  77. struct console *console_drivers;
  78. EXPORT_SYMBOL_GPL(console_drivers);
  79. /*
  80. * This is used for debugging the mess that is the VT code by
  81. * keeping track if we have the console semaphore held. It's
  82. * definitely not the perfect debug tool (we don't know if _WE_
  83. * hold it are racing, but it helps tracking those weird code
  84. * path in the console code where we end up in places I want
  85. * locked without the console sempahore held
  86. */
  87. static int console_locked, console_suspended;
  88. /*
  89. * If exclusive_console is non-NULL then only this console is to be printed to.
  90. */
  91. static struct console *exclusive_console;
  92. /*
  93. * Array of consoles built from command line options (console=)
  94. */
  95. struct console_cmdline
  96. {
  97. char name[8]; /* Name of the driver */
  98. int index; /* Minor dev. to use */
  99. char *options; /* Options for the driver */
  100. #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
  101. char *brl_options; /* Options for braille driver */
  102. #endif
  103. };
  104. #define MAX_CMDLINECONSOLES 8
  105. static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
  106. static int selected_console = -1;
  107. static int preferred_console = -1;
  108. int console_set_on_cmdline;
  109. EXPORT_SYMBOL(console_set_on_cmdline);
  110. /* Flag: console code may call schedule() */
  111. static int console_may_schedule;
  112. /*
  113. * The printk log buffer consists of a chain of concatenated variable
  114. * length records. Every record starts with a record header, containing
  115. * the overall length of the record.
  116. *
  117. * The heads to the first and last entry in the buffer, as well as the
  118. * sequence numbers of these both entries are maintained when messages
  119. * are stored..
  120. *
  121. * If the heads indicate available messages, the length in the header
  122. * tells the start next message. A length == 0 for the next message
  123. * indicates a wrap-around to the beginning of the buffer.
  124. *
  125. * Every record carries the monotonic timestamp in microseconds, as well as
  126. * the standard userspace syslog level and syslog facility. The usual
  127. * kernel messages use LOG_KERN; userspace-injected messages always carry
  128. * a matching syslog facility, by default LOG_USER. The origin of every
  129. * message can be reliably determined that way.
  130. *
  131. * The human readable log message directly follows the message header. The
  132. * length of the message text is stored in the header, the stored message
  133. * is not terminated.
  134. *
  135. * Optionally, a message can carry a dictionary of properties (key/value pairs),
  136. * to provide userspace with a machine-readable message context.
  137. *
  138. * Examples for well-defined, commonly used property names are:
  139. * DEVICE=b12:8 device identifier
  140. * b12:8 block dev_t
  141. * c127:3 char dev_t
  142. * n8 netdev ifindex
  143. * +sound:card0 subsystem:devname
  144. * SUBSYSTEM=pci driver-core subsystem name
  145. *
  146. * Valid characters in property names are [a-zA-Z0-9.-_]. The plain text value
  147. * follows directly after a '=' character. Every property is terminated by
  148. * a '\0' character. The last property is not terminated.
  149. *
  150. * Example of a message structure:
  151. * 0000 ff 8f 00 00 00 00 00 00 monotonic time in nsec
  152. * 0008 34 00 record is 52 bytes long
  153. * 000a 0b 00 text is 11 bytes long
  154. * 000c 1f 00 dictionary is 23 bytes long
  155. * 000e 03 00 LOG_KERN (facility) LOG_ERR (level)
  156. * 0010 69 74 27 73 20 61 20 6c "it's a l"
  157. * 69 6e 65 "ine"
  158. * 001b 44 45 56 49 43 "DEVIC"
  159. * 45 3d 62 38 3a 32 00 44 "E=b8:2\0D"
  160. * 52 49 56 45 52 3d 62 75 "RIVER=bu"
  161. * 67 "g"
  162. * 0032 00 00 00 padding to next message header
  163. *
  164. * The 'struct log' buffer header must never be directly exported to
  165. * userspace, it is a kernel-private implementation detail that might
  166. * need to be changed in the future, when the requirements change.
  167. *
  168. * /dev/kmsg exports the structured data in the following line format:
  169. * "level,sequnum,timestamp;<message text>\n"
  170. *
  171. * The optional key/value pairs are attached as continuation lines starting
  172. * with a space character and terminated by a newline. All possible
  173. * non-prinatable characters are escaped in the "\xff" notation.
  174. *
  175. * Users of the export format should ignore possible additional values
  176. * separated by ',', and find the message after the ';' character.
  177. */
  178. enum log_flags {
  179. LOG_DEFAULT = 0,
  180. LOG_NOCONS = 1, /* already flushed, do not print to console */
  181. };
  182. struct log {
  183. u64 ts_nsec; /* timestamp in nanoseconds */
  184. u16 len; /* length of entire record */
  185. u16 text_len; /* length of text buffer */
  186. u16 dict_len; /* length of dictionary buffer */
  187. u8 facility; /* syslog facility */
  188. u8 flags:5; /* internal record flags */
  189. u8 level:3; /* syslog level */
  190. };
  191. /*
  192. * The logbuf_lock protects kmsg buffer, indices, counters. It is also
  193. * used in interesting ways to provide interlocking in console_unlock();
  194. */
  195. static DEFINE_RAW_SPINLOCK(logbuf_lock);
  196. /* the next printk record to read by syslog(READ) or /proc/kmsg */
  197. static u64 syslog_seq;
  198. static u32 syslog_idx;
  199. /* index and sequence number of the first record stored in the buffer */
  200. static u64 log_first_seq;
  201. static u32 log_first_idx;
  202. /* index and sequence number of the next record to store in the buffer */
  203. static u64 log_next_seq;
  204. #ifdef CONFIG_PRINTK
  205. static u32 log_next_idx;
  206. /* the next printk record to read after the last 'clear' command */
  207. static u64 clear_seq;
  208. static u32 clear_idx;
  209. #define LOG_LINE_MAX 1024
  210. /* record buffer */
  211. #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
  212. #define LOG_ALIGN 4
  213. #else
  214. #define LOG_ALIGN __alignof__(struct log)
  215. #endif
  216. #define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
  217. static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
  218. static char *log_buf = __log_buf;
  219. static u32 log_buf_len = __LOG_BUF_LEN;
  220. /* cpu currently holding logbuf_lock */
  221. static volatile unsigned int logbuf_cpu = UINT_MAX;
  222. /* human readable text of the record */
  223. static char *log_text(const struct log *msg)
  224. {
  225. return (char *)msg + sizeof(struct log);
  226. }
  227. /* optional key/value pair dictionary attached to the record */
  228. static char *log_dict(const struct log *msg)
  229. {
  230. return (char *)msg + sizeof(struct log) + msg->text_len;
  231. }
  232. /* get record by index; idx must point to valid msg */
  233. static struct log *log_from_idx(u32 idx)
  234. {
  235. struct log *msg = (struct log *)(log_buf + idx);
  236. /*
  237. * A length == 0 record is the end of buffer marker. Wrap around and
  238. * read the message at the start of the buffer.
  239. */
  240. if (!msg->len)
  241. return (struct log *)log_buf;
  242. return msg;
  243. }
  244. /* get next record; idx must point to valid msg */
  245. static u32 log_next(u32 idx)
  246. {
  247. struct log *msg = (struct log *)(log_buf + idx);
  248. /* length == 0 indicates the end of the buffer; wrap */
  249. /*
  250. * A length == 0 record is the end of buffer marker. Wrap around and
  251. * read the message at the start of the buffer as *this* one, and
  252. * return the one after that.
  253. */
  254. if (!msg->len) {
  255. msg = (struct log *)log_buf;
  256. return msg->len;
  257. }
  258. return idx + msg->len;
  259. }
  260. /* insert record into the buffer, discard old ones, update heads */
  261. static void log_store(int facility, int level,
  262. enum log_flags flags, u64 ts_nsec,
  263. const char *dict, u16 dict_len,
  264. const char *text, u16 text_len)
  265. {
  266. struct log *msg;
  267. u32 size, pad_len;
  268. /* number of '\0' padding bytes to next message */
  269. size = sizeof(struct log) + text_len + dict_len;
  270. pad_len = (-size) & (LOG_ALIGN - 1);
  271. size += pad_len;
  272. while (log_first_seq < log_next_seq) {
  273. u32 free;
  274. if (log_next_idx > log_first_idx)
  275. free = max(log_buf_len - log_next_idx, log_first_idx);
  276. else
  277. free = log_first_idx - log_next_idx;
  278. if (free > size + sizeof(struct log))
  279. break;
  280. /* drop old messages until we have enough contiuous space */
  281. log_first_idx = log_next(log_first_idx);
  282. log_first_seq++;
  283. }
  284. if (log_next_idx + size + sizeof(struct log) >= log_buf_len) {
  285. /*
  286. * This message + an additional empty header does not fit
  287. * at the end of the buffer. Add an empty header with len == 0
  288. * to signify a wrap around.
  289. */
  290. memset(log_buf + log_next_idx, 0, sizeof(struct log));
  291. log_next_idx = 0;
  292. }
  293. /* fill message */
  294. msg = (struct log *)(log_buf + log_next_idx);
  295. memcpy(log_text(msg), text, text_len);
  296. msg->text_len = text_len;
  297. memcpy(log_dict(msg), dict, dict_len);
  298. msg->dict_len = dict_len;
  299. msg->facility = facility;
  300. msg->level = level & 7;
  301. msg->flags = flags & 0x1f;
  302. if (ts_nsec > 0)
  303. msg->ts_nsec = ts_nsec;
  304. else
  305. msg->ts_nsec = local_clock();
  306. memset(log_dict(msg) + dict_len, 0, pad_len);
  307. msg->len = sizeof(struct log) + text_len + dict_len + pad_len;
  308. /* insert message */
  309. log_next_idx += msg->len;
  310. log_next_seq++;
  311. }
  312. /* /dev/kmsg - userspace message inject/listen interface */
  313. struct devkmsg_user {
  314. u64 seq;
  315. u32 idx;
  316. struct mutex lock;
  317. char buf[8192];
  318. };
  319. static ssize_t devkmsg_writev(struct kiocb *iocb, const struct iovec *iv,
  320. unsigned long count, loff_t pos)
  321. {
  322. char *buf, *line;
  323. int i;
  324. int level = default_message_loglevel;
  325. int facility = 1; /* LOG_USER */
  326. size_t len = iov_length(iv, count);
  327. ssize_t ret = len;
  328. if (len > LOG_LINE_MAX)
  329. return -EINVAL;
  330. buf = kmalloc(len+1, GFP_KERNEL);
  331. if (buf == NULL)
  332. return -ENOMEM;
  333. line = buf;
  334. for (i = 0; i < count; i++) {
  335. if (copy_from_user(line, iv[i].iov_base, iv[i].iov_len))
  336. goto out;
  337. line += iv[i].iov_len;
  338. }
  339. /*
  340. * Extract and skip the syslog prefix <[0-9]*>. Coming from userspace
  341. * the decimal value represents 32bit, the lower 3 bit are the log
  342. * level, the rest are the log facility.
  343. *
  344. * If no prefix or no userspace facility is specified, we
  345. * enforce LOG_USER, to be able to reliably distinguish
  346. * kernel-generated messages from userspace-injected ones.
  347. */
  348. line = buf;
  349. if (line[0] == '<') {
  350. char *endp = NULL;
  351. i = simple_strtoul(line+1, &endp, 10);
  352. if (endp && endp[0] == '>') {
  353. level = i & 7;
  354. if (i >> 3)
  355. facility = i >> 3;
  356. endp++;
  357. len -= endp - line;
  358. line = endp;
  359. }
  360. }
  361. line[len] = '\0';
  362. printk_emit(facility, level, NULL, 0, "%s", line);
  363. out:
  364. kfree(buf);
  365. return ret;
  366. }
  367. static ssize_t devkmsg_read(struct file *file, char __user *buf,
  368. size_t count, loff_t *ppos)
  369. {
  370. struct devkmsg_user *user = file->private_data;
  371. struct log *msg;
  372. u64 ts_usec;
  373. size_t i;
  374. size_t len;
  375. ssize_t ret;
  376. if (!user)
  377. return -EBADF;
  378. ret = mutex_lock_interruptible(&user->lock);
  379. if (ret)
  380. return ret;
  381. raw_spin_lock_irq(&logbuf_lock);
  382. while (user->seq == log_next_seq) {
  383. if (file->f_flags & O_NONBLOCK) {
  384. ret = -EAGAIN;
  385. raw_spin_unlock_irq(&logbuf_lock);
  386. goto out;
  387. }
  388. raw_spin_unlock_irq(&logbuf_lock);
  389. ret = wait_event_interruptible(log_wait,
  390. user->seq != log_next_seq);
  391. if (ret)
  392. goto out;
  393. raw_spin_lock_irq(&logbuf_lock);
  394. }
  395. if (user->seq < log_first_seq) {
  396. /* our last seen message is gone, return error and reset */
  397. user->idx = log_first_idx;
  398. user->seq = log_first_seq;
  399. ret = -EPIPE;
  400. raw_spin_unlock_irq(&logbuf_lock);
  401. goto out;
  402. }
  403. msg = log_from_idx(user->idx);
  404. ts_usec = msg->ts_nsec;
  405. do_div(ts_usec, 1000);
  406. len = sprintf(user->buf, "%u,%llu,%llu;",
  407. (msg->facility << 3) | msg->level, user->seq, ts_usec);
  408. /* escape non-printable characters */
  409. for (i = 0; i < msg->text_len; i++) {
  410. unsigned char c = log_text(msg)[i];
  411. if (c < ' ' || c >= 127 || c == '\\')
  412. len += sprintf(user->buf + len, "\\x%02x", c);
  413. else
  414. user->buf[len++] = c;
  415. }
  416. user->buf[len++] = '\n';
  417. if (msg->dict_len) {
  418. bool line = true;
  419. for (i = 0; i < msg->dict_len; i++) {
  420. unsigned char c = log_dict(msg)[i];
  421. if (line) {
  422. user->buf[len++] = ' ';
  423. line = false;
  424. }
  425. if (c == '\0') {
  426. user->buf[len++] = '\n';
  427. line = true;
  428. continue;
  429. }
  430. if (c < ' ' || c >= 127 || c == '\\') {
  431. len += sprintf(user->buf + len, "\\x%02x", c);
  432. continue;
  433. }
  434. user->buf[len++] = c;
  435. }
  436. user->buf[len++] = '\n';
  437. }
  438. user->idx = log_next(user->idx);
  439. user->seq++;
  440. raw_spin_unlock_irq(&logbuf_lock);
  441. if (len > count) {
  442. ret = -EINVAL;
  443. goto out;
  444. }
  445. if (copy_to_user(buf, user->buf, len)) {
  446. ret = -EFAULT;
  447. goto out;
  448. }
  449. ret = len;
  450. out:
  451. mutex_unlock(&user->lock);
  452. return ret;
  453. }
  454. static loff_t devkmsg_llseek(struct file *file, loff_t offset, int whence)
  455. {
  456. struct devkmsg_user *user = file->private_data;
  457. loff_t ret = 0;
  458. if (!user)
  459. return -EBADF;
  460. if (offset)
  461. return -ESPIPE;
  462. raw_spin_lock_irq(&logbuf_lock);
  463. switch (whence) {
  464. case SEEK_SET:
  465. /* the first record */
  466. user->idx = log_first_idx;
  467. user->seq = log_first_seq;
  468. break;
  469. case SEEK_DATA:
  470. /*
  471. * The first record after the last SYSLOG_ACTION_CLEAR,
  472. * like issued by 'dmesg -c'. Reading /dev/kmsg itself
  473. * changes no global state, and does not clear anything.
  474. */
  475. user->idx = clear_idx;
  476. user->seq = clear_seq;
  477. break;
  478. case SEEK_END:
  479. /* after the last record */
  480. user->idx = log_next_idx;
  481. user->seq = log_next_seq;
  482. break;
  483. default:
  484. ret = -EINVAL;
  485. }
  486. raw_spin_unlock_irq(&logbuf_lock);
  487. return ret;
  488. }
  489. static unsigned int devkmsg_poll(struct file *file, poll_table *wait)
  490. {
  491. struct devkmsg_user *user = file->private_data;
  492. int ret = 0;
  493. if (!user)
  494. return POLLERR|POLLNVAL;
  495. poll_wait(file, &log_wait, wait);
  496. raw_spin_lock_irq(&logbuf_lock);
  497. if (user->seq < log_next_seq) {
  498. /* return error when data has vanished underneath us */
  499. if (user->seq < log_first_seq)
  500. ret = POLLIN|POLLRDNORM|POLLERR|POLLPRI;
  501. ret = POLLIN|POLLRDNORM;
  502. }
  503. raw_spin_unlock_irq(&logbuf_lock);
  504. return ret;
  505. }
  506. static int devkmsg_open(struct inode *inode, struct file *file)
  507. {
  508. struct devkmsg_user *user;
  509. int err;
  510. /* write-only does not need any file context */
  511. if ((file->f_flags & O_ACCMODE) == O_WRONLY)
  512. return 0;
  513. err = security_syslog(SYSLOG_ACTION_READ_ALL);
  514. if (err)
  515. return err;
  516. user = kmalloc(sizeof(struct devkmsg_user), GFP_KERNEL);
  517. if (!user)
  518. return -ENOMEM;
  519. mutex_init(&user->lock);
  520. raw_spin_lock_irq(&logbuf_lock);
  521. user->idx = log_first_idx;
  522. user->seq = log_first_seq;
  523. raw_spin_unlock_irq(&logbuf_lock);
  524. file->private_data = user;
  525. return 0;
  526. }
  527. static int devkmsg_release(struct inode *inode, struct file *file)
  528. {
  529. struct devkmsg_user *user = file->private_data;
  530. if (!user)
  531. return 0;
  532. mutex_destroy(&user->lock);
  533. kfree(user);
  534. return 0;
  535. }
  536. const struct file_operations kmsg_fops = {
  537. .open = devkmsg_open,
  538. .read = devkmsg_read,
  539. .aio_write = devkmsg_writev,
  540. .llseek = devkmsg_llseek,
  541. .poll = devkmsg_poll,
  542. .release = devkmsg_release,
  543. };
  544. #ifdef CONFIG_KEXEC
  545. /*
  546. * This appends the listed symbols to /proc/vmcoreinfo
  547. *
  548. * /proc/vmcoreinfo is used by various utiilties, like crash and makedumpfile to
  549. * obtain access to symbols that are otherwise very difficult to locate. These
  550. * symbols are specifically used so that utilities can access and extract the
  551. * dmesg log from a vmcore file after a crash.
  552. */
  553. void log_buf_kexec_setup(void)
  554. {
  555. VMCOREINFO_SYMBOL(log_buf);
  556. VMCOREINFO_SYMBOL(log_buf_len);
  557. VMCOREINFO_SYMBOL(log_first_idx);
  558. VMCOREINFO_SYMBOL(log_next_idx);
  559. }
  560. #endif
  561. /* requested log_buf_len from kernel cmdline */
  562. static unsigned long __initdata new_log_buf_len;
  563. /* save requested log_buf_len since it's too early to process it */
  564. static int __init log_buf_len_setup(char *str)
  565. {
  566. unsigned size = memparse(str, &str);
  567. if (size)
  568. size = roundup_pow_of_two(size);
  569. if (size > log_buf_len)
  570. new_log_buf_len = size;
  571. return 0;
  572. }
  573. early_param("log_buf_len", log_buf_len_setup);
  574. void __init setup_log_buf(int early)
  575. {
  576. unsigned long flags;
  577. char *new_log_buf;
  578. int free;
  579. if (!new_log_buf_len)
  580. return;
  581. if (early) {
  582. unsigned long mem;
  583. mem = memblock_alloc(new_log_buf_len, PAGE_SIZE);
  584. if (!mem)
  585. return;
  586. new_log_buf = __va(mem);
  587. } else {
  588. new_log_buf = alloc_bootmem_nopanic(new_log_buf_len);
  589. }
  590. if (unlikely(!new_log_buf)) {
  591. pr_err("log_buf_len: %ld bytes not available\n",
  592. new_log_buf_len);
  593. return;
  594. }
  595. raw_spin_lock_irqsave(&logbuf_lock, flags);
  596. log_buf_len = new_log_buf_len;
  597. log_buf = new_log_buf;
  598. new_log_buf_len = 0;
  599. free = __LOG_BUF_LEN - log_next_idx;
  600. memcpy(log_buf, __log_buf, __LOG_BUF_LEN);
  601. raw_spin_unlock_irqrestore(&logbuf_lock, flags);
  602. pr_info("log_buf_len: %d\n", log_buf_len);
  603. pr_info("early log buf free: %d(%d%%)\n",
  604. free, (free * 100) / __LOG_BUF_LEN);
  605. }
  606. #ifdef CONFIG_BOOT_PRINTK_DELAY
  607. static int boot_delay; /* msecs delay after each printk during bootup */
  608. static unsigned long long loops_per_msec; /* based on boot_delay */
  609. static int __init boot_delay_setup(char *str)
  610. {
  611. unsigned long lpj;
  612. lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
  613. loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
  614. get_option(&str, &boot_delay);
  615. if (boot_delay > 10 * 1000)
  616. boot_delay = 0;
  617. pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
  618. "HZ: %d, loops_per_msec: %llu\n",
  619. boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
  620. return 1;
  621. }
  622. __setup("boot_delay=", boot_delay_setup);
  623. static void boot_delay_msec(void)
  624. {
  625. unsigned long long k;
  626. unsigned long timeout;
  627. if (boot_delay == 0 || system_state != SYSTEM_BOOTING)
  628. return;
  629. k = (unsigned long long)loops_per_msec * boot_delay;
  630. timeout = jiffies + msecs_to_jiffies(boot_delay);
  631. while (k) {
  632. k--;
  633. cpu_relax();
  634. /*
  635. * use (volatile) jiffies to prevent
  636. * compiler reduction; loop termination via jiffies
  637. * is secondary and may or may not happen.
  638. */
  639. if (time_after(jiffies, timeout))
  640. break;
  641. touch_nmi_watchdog();
  642. }
  643. }
  644. #else
  645. static inline void boot_delay_msec(void)
  646. {
  647. }
  648. #endif
  649. #ifdef CONFIG_SECURITY_DMESG_RESTRICT
  650. int dmesg_restrict = 1;
  651. #else
  652. int dmesg_restrict;
  653. #endif
  654. static int syslog_action_restricted(int type)
  655. {
  656. if (dmesg_restrict)
  657. return 1;
  658. /* Unless restricted, we allow "read all" and "get buffer size" for everybody */
  659. return type != SYSLOG_ACTION_READ_ALL && type != SYSLOG_ACTION_SIZE_BUFFER;
  660. }
  661. static int check_syslog_permissions(int type, bool from_file)
  662. {
  663. /*
  664. * If this is from /proc/kmsg and we've already opened it, then we've
  665. * already done the capabilities checks at open time.
  666. */
  667. if (from_file && type != SYSLOG_ACTION_OPEN)
  668. return 0;
  669. if (syslog_action_restricted(type)) {
  670. if (capable(CAP_SYSLOG))
  671. return 0;
  672. /* For historical reasons, accept CAP_SYS_ADMIN too, with a warning */
  673. if (capable(CAP_SYS_ADMIN)) {
  674. printk_once(KERN_WARNING "%s (%d): "
  675. "Attempt to access syslog with CAP_SYS_ADMIN "
  676. "but no CAP_SYSLOG (deprecated).\n",
  677. current->comm, task_pid_nr(current));
  678. return 0;
  679. }
  680. return -EPERM;
  681. }
  682. return 0;
  683. }
  684. #if defined(CONFIG_PRINTK_TIME)
  685. static bool printk_time = 1;
  686. #else
  687. static bool printk_time;
  688. #endif
  689. module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
  690. static size_t print_time(u64 ts, char *buf)
  691. {
  692. unsigned long rem_nsec;
  693. if (!printk_time)
  694. return 0;
  695. if (!buf)
  696. return 15;
  697. rem_nsec = do_div(ts, 1000000000);
  698. return sprintf(buf, "[%5lu.%06lu] ",
  699. (unsigned long)ts, rem_nsec / 1000);
  700. }
  701. static size_t print_prefix(const struct log *msg, bool syslog, char *buf)
  702. {
  703. size_t len = 0;
  704. unsigned int prefix = (msg->facility << 3) | msg->level;
  705. if (syslog) {
  706. if (buf) {
  707. len += sprintf(buf, "<%u>", prefix);
  708. } else {
  709. len += 3;
  710. if (prefix > 999)
  711. len += 3;
  712. else if (prefix > 99)
  713. len += 2;
  714. else if (prefix > 9)
  715. len++;
  716. }
  717. }
  718. len += print_time(msg->ts_nsec, buf ? buf + len : NULL);
  719. return len;
  720. }
  721. static size_t msg_print_text(const struct log *msg, bool syslog,
  722. char *buf, size_t size)
  723. {
  724. const char *text = log_text(msg);
  725. size_t text_size = msg->text_len;
  726. size_t len = 0;
  727. do {
  728. const char *next = memchr(text, '\n', text_size);
  729. size_t text_len;
  730. if (next) {
  731. text_len = next - text;
  732. next++;
  733. text_size -= next - text;
  734. } else {
  735. text_len = text_size;
  736. }
  737. if (buf) {
  738. if (print_prefix(msg, syslog, NULL) +
  739. text_len + 1>= size - len)
  740. break;
  741. len += print_prefix(msg, syslog, buf + len);
  742. memcpy(buf + len, text, text_len);
  743. len += text_len;
  744. buf[len++] = '\n';
  745. } else {
  746. /* SYSLOG_ACTION_* buffer size only calculation */
  747. len += print_prefix(msg, syslog, NULL);
  748. len += text_len + 1;
  749. }
  750. text = next;
  751. } while (text);
  752. return len;
  753. }
  754. static int syslog_print(char __user *buf, int size)
  755. {
  756. char *text;
  757. struct log *msg;
  758. int len = 0;
  759. text = kmalloc(LOG_LINE_MAX, GFP_KERNEL);
  760. if (!text)
  761. return -ENOMEM;
  762. while (size > 0) {
  763. size_t n;
  764. raw_spin_lock_irq(&logbuf_lock);
  765. if (syslog_seq < log_first_seq) {
  766. /* messages are gone, move to first one */
  767. syslog_seq = log_first_seq;
  768. syslog_idx = log_first_idx;
  769. }
  770. if (syslog_seq == log_next_seq) {
  771. raw_spin_unlock_irq(&logbuf_lock);
  772. break;
  773. }
  774. msg = log_from_idx(syslog_idx);
  775. n = msg_print_text(msg, true, text, LOG_LINE_MAX);
  776. if (n <= size) {
  777. syslog_idx = log_next(syslog_idx);
  778. syslog_seq++;
  779. } else
  780. n = 0;
  781. raw_spin_unlock_irq(&logbuf_lock);
  782. if (!n)
  783. break;
  784. len += n;
  785. size -= n;
  786. buf += n;
  787. n = copy_to_user(buf - n, text, n);
  788. if (n) {
  789. len -= n;
  790. if (!len)
  791. len = -EFAULT;
  792. break;
  793. }
  794. }
  795. kfree(text);
  796. return len;
  797. }
  798. static int syslog_print_all(char __user *buf, int size, bool clear)
  799. {
  800. char *text;
  801. int len = 0;
  802. text = kmalloc(LOG_LINE_MAX, GFP_KERNEL);
  803. if (!text)
  804. return -ENOMEM;
  805. raw_spin_lock_irq(&logbuf_lock);
  806. if (buf) {
  807. u64 next_seq;
  808. u64 seq;
  809. u32 idx;
  810. if (clear_seq < log_first_seq) {
  811. /* messages are gone, move to first available one */
  812. clear_seq = log_first_seq;
  813. clear_idx = log_first_idx;
  814. }
  815. /*
  816. * Find first record that fits, including all following records,
  817. * into the user-provided buffer for this dump.
  818. */
  819. seq = clear_seq;
  820. idx = clear_idx;
  821. while (seq < log_next_seq) {
  822. struct log *msg = log_from_idx(idx);
  823. len += msg_print_text(msg, true, NULL, 0);
  824. idx = log_next(idx);
  825. seq++;
  826. }
  827. /* move first record forward until length fits into the buffer */
  828. seq = clear_seq;
  829. idx = clear_idx;
  830. while (len > size && seq < log_next_seq) {
  831. struct log *msg = log_from_idx(idx);
  832. len -= msg_print_text(msg, true, NULL, 0);
  833. idx = log_next(idx);
  834. seq++;
  835. }
  836. /* last message fitting into this dump */
  837. next_seq = log_next_seq;
  838. len = 0;
  839. while (len >= 0 && seq < next_seq) {
  840. struct log *msg = log_from_idx(idx);
  841. int textlen;
  842. textlen = msg_print_text(msg, true, text, LOG_LINE_MAX);
  843. if (textlen < 0) {
  844. len = textlen;
  845. break;
  846. }
  847. idx = log_next(idx);
  848. seq++;
  849. raw_spin_unlock_irq(&logbuf_lock);
  850. if (copy_to_user(buf + len, text, textlen))
  851. len = -EFAULT;
  852. else
  853. len += textlen;
  854. raw_spin_lock_irq(&logbuf_lock);
  855. if (seq < log_first_seq) {
  856. /* messages are gone, move to next one */
  857. seq = log_first_seq;
  858. idx = log_first_idx;
  859. }
  860. }
  861. }
  862. if (clear) {
  863. clear_seq = log_next_seq;
  864. clear_idx = log_next_idx;
  865. }
  866. raw_spin_unlock_irq(&logbuf_lock);
  867. kfree(text);
  868. return len;
  869. }
  870. int do_syslog(int type, char __user *buf, int len, bool from_file)
  871. {
  872. bool clear = false;
  873. static int saved_console_loglevel = -1;
  874. int error;
  875. error = check_syslog_permissions(type, from_file);
  876. if (error)
  877. goto out;
  878. error = security_syslog(type);
  879. if (error)
  880. return error;
  881. switch (type) {
  882. case SYSLOG_ACTION_CLOSE: /* Close log */
  883. break;
  884. case SYSLOG_ACTION_OPEN: /* Open log */
  885. break;
  886. case SYSLOG_ACTION_READ: /* Read from log */
  887. error = -EINVAL;
  888. if (!buf || len < 0)
  889. goto out;
  890. error = 0;
  891. if (!len)
  892. goto out;
  893. if (!access_ok(VERIFY_WRITE, buf, len)) {
  894. error = -EFAULT;
  895. goto out;
  896. }
  897. error = wait_event_interruptible(log_wait,
  898. syslog_seq != log_next_seq);
  899. if (error)
  900. goto out;
  901. error = syslog_print(buf, len);
  902. break;
  903. /* Read/clear last kernel messages */
  904. case SYSLOG_ACTION_READ_CLEAR:
  905. clear = true;
  906. /* FALL THRU */
  907. /* Read last kernel messages */
  908. case SYSLOG_ACTION_READ_ALL:
  909. error = -EINVAL;
  910. if (!buf || len < 0)
  911. goto out;
  912. error = 0;
  913. if (!len)
  914. goto out;
  915. if (!access_ok(VERIFY_WRITE, buf, len)) {
  916. error = -EFAULT;
  917. goto out;
  918. }
  919. error = syslog_print_all(buf, len, clear);
  920. break;
  921. /* Clear ring buffer */
  922. case SYSLOG_ACTION_CLEAR:
  923. syslog_print_all(NULL, 0, true);
  924. break;
  925. /* Disable logging to console */
  926. case SYSLOG_ACTION_CONSOLE_OFF:
  927. if (saved_console_loglevel == -1)
  928. saved_console_loglevel = console_loglevel;
  929. console_loglevel = minimum_console_loglevel;
  930. break;
  931. /* Enable logging to console */
  932. case SYSLOG_ACTION_CONSOLE_ON:
  933. if (saved_console_loglevel != -1) {
  934. console_loglevel = saved_console_loglevel;
  935. saved_console_loglevel = -1;
  936. }
  937. break;
  938. /* Set level of messages printed to console */
  939. case SYSLOG_ACTION_CONSOLE_LEVEL:
  940. error = -EINVAL;
  941. if (len < 1 || len > 8)
  942. goto out;
  943. if (len < minimum_console_loglevel)
  944. len = minimum_console_loglevel;
  945. console_loglevel = len;
  946. /* Implicitly re-enable logging to console */
  947. saved_console_loglevel = -1;
  948. error = 0;
  949. break;
  950. /* Number of chars in the log buffer */
  951. case SYSLOG_ACTION_SIZE_UNREAD:
  952. raw_spin_lock_irq(&logbuf_lock);
  953. if (syslog_seq < log_first_seq) {
  954. /* messages are gone, move to first one */
  955. syslog_seq = log_first_seq;
  956. syslog_idx = log_first_idx;
  957. }
  958. if (from_file) {
  959. /*
  960. * Short-cut for poll(/"proc/kmsg") which simply checks
  961. * for pending data, not the size; return the count of
  962. * records, not the length.
  963. */
  964. error = log_next_idx - syslog_idx;
  965. } else {
  966. u64 seq;
  967. u32 idx;
  968. error = 0;
  969. seq = syslog_seq;
  970. idx = syslog_idx;
  971. while (seq < log_next_seq) {
  972. struct log *msg = log_from_idx(idx);
  973. error += msg_print_text(msg, true, NULL, 0);
  974. idx = log_next(idx);
  975. seq++;
  976. }
  977. }
  978. raw_spin_unlock_irq(&logbuf_lock);
  979. break;
  980. /* Size of the log buffer */
  981. case SYSLOG_ACTION_SIZE_BUFFER:
  982. error = log_buf_len;
  983. break;
  984. default:
  985. error = -EINVAL;
  986. break;
  987. }
  988. out:
  989. return error;
  990. }
  991. SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
  992. {
  993. return do_syslog(type, buf, len, SYSLOG_FROM_CALL);
  994. }
  995. #ifdef CONFIG_KGDB_KDB
  996. /* kdb dmesg command needs access to the syslog buffer. do_syslog()
  997. * uses locks so it cannot be used during debugging. Just tell kdb
  998. * where the start and end of the physical and logical logs are. This
  999. * is equivalent to do_syslog(3).
  1000. */
  1001. void kdb_syslog_data(char *syslog_data[4])
  1002. {
  1003. syslog_data[0] = log_buf;
  1004. syslog_data[1] = log_buf + log_buf_len;
  1005. syslog_data[2] = log_buf + log_first_idx;
  1006. syslog_data[3] = log_buf + log_next_idx;
  1007. }
  1008. #endif /* CONFIG_KGDB_KDB */
  1009. static bool __read_mostly ignore_loglevel;
  1010. static int __init ignore_loglevel_setup(char *str)
  1011. {
  1012. ignore_loglevel = 1;
  1013. printk(KERN_INFO "debug: ignoring loglevel setting.\n");
  1014. return 0;
  1015. }
  1016. early_param("ignore_loglevel", ignore_loglevel_setup);
  1017. module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
  1018. MODULE_PARM_DESC(ignore_loglevel, "ignore loglevel setting, to"
  1019. "print all kernel messages to the console.");
  1020. /*
  1021. * Call the console drivers, asking them to write out
  1022. * log_buf[start] to log_buf[end - 1].
  1023. * The console_lock must be held.
  1024. */
  1025. static void call_console_drivers(int level, const char *text, size_t len)
  1026. {
  1027. struct console *con;
  1028. trace_console(text, 0, len, len);
  1029. if (level >= console_loglevel && !ignore_loglevel)
  1030. return;
  1031. if (!console_drivers)
  1032. return;
  1033. for_each_console(con) {
  1034. if (exclusive_console && con != exclusive_console)
  1035. continue;
  1036. if (!(con->flags & CON_ENABLED))
  1037. continue;
  1038. if (!con->write)
  1039. continue;
  1040. if (!cpu_online(smp_processor_id()) &&
  1041. !(con->flags & CON_ANYTIME))
  1042. continue;
  1043. con->write(con, text, len);
  1044. }
  1045. }
  1046. /*
  1047. * Zap console related locks when oopsing. Only zap at most once
  1048. * every 10 seconds, to leave time for slow consoles to print a
  1049. * full oops.
  1050. */
  1051. static void zap_locks(void)
  1052. {
  1053. static unsigned long oops_timestamp;
  1054. if (time_after_eq(jiffies, oops_timestamp) &&
  1055. !time_after(jiffies, oops_timestamp + 30 * HZ))
  1056. return;
  1057. oops_timestamp = jiffies;
  1058. debug_locks_off();
  1059. /* If a crash is occurring, make sure we can't deadlock */
  1060. raw_spin_lock_init(&logbuf_lock);
  1061. /* And make sure that we print immediately */
  1062. sema_init(&console_sem, 1);
  1063. }
  1064. /* Check if we have any console registered that can be called early in boot. */
  1065. static int have_callable_console(void)
  1066. {
  1067. struct console *con;
  1068. for_each_console(con)
  1069. if (con->flags & CON_ANYTIME)
  1070. return 1;
  1071. return 0;
  1072. }
  1073. /*
  1074. * Can we actually use the console at this time on this cpu?
  1075. *
  1076. * Console drivers may assume that per-cpu resources have
  1077. * been allocated. So unless they're explicitly marked as
  1078. * being able to cope (CON_ANYTIME) don't call them until
  1079. * this CPU is officially up.
  1080. */
  1081. static inline int can_use_console(unsigned int cpu)
  1082. {
  1083. return cpu_online(cpu) || have_callable_console();
  1084. }
  1085. /*
  1086. * Try to get console ownership to actually show the kernel
  1087. * messages from a 'printk'. Return true (and with the
  1088. * console_lock held, and 'console_locked' set) if it
  1089. * is successful, false otherwise.
  1090. *
  1091. * This gets called with the 'logbuf_lock' spinlock held and
  1092. * interrupts disabled. It should return with 'lockbuf_lock'
  1093. * released but interrupts still disabled.
  1094. */
  1095. static int console_trylock_for_printk(unsigned int cpu)
  1096. __releases(&logbuf_lock)
  1097. {
  1098. int retval = 0, wake = 0;
  1099. if (console_trylock()) {
  1100. retval = 1;
  1101. /*
  1102. * If we can't use the console, we need to release
  1103. * the console semaphore by hand to avoid flushing
  1104. * the buffer. We need to hold the console semaphore
  1105. * in order to do this test safely.
  1106. */
  1107. if (!can_use_console(cpu)) {
  1108. console_locked = 0;
  1109. wake = 1;
  1110. retval = 0;
  1111. }
  1112. }
  1113. logbuf_cpu = UINT_MAX;
  1114. if (wake)
  1115. up(&console_sem);
  1116. raw_spin_unlock(&logbuf_lock);
  1117. return retval;
  1118. }
  1119. int printk_delay_msec __read_mostly;
  1120. static inline void printk_delay(void)
  1121. {
  1122. if (unlikely(printk_delay_msec)) {
  1123. int m = printk_delay_msec;
  1124. while (m--) {
  1125. mdelay(1);
  1126. touch_nmi_watchdog();
  1127. }
  1128. }
  1129. }
  1130. /*
  1131. * Continuation lines are buffered, and not committed to the record buffer
  1132. * until the line is complete, or a race forces it. The line fragments
  1133. * though, are printed immediately to the consoles to ensure everything has
  1134. * reached the console in case of a kernel crash.
  1135. */
  1136. static struct cont {
  1137. char buf[LOG_LINE_MAX];
  1138. size_t len; /* length == 0 means unused buffer */
  1139. size_t cons; /* bytes written to console */
  1140. struct task_struct *owner; /* task of first print*/
  1141. u64 ts_nsec; /* time of first print */
  1142. u8 level; /* log level of first message */
  1143. u8 facility; /* log level of first message */
  1144. bool flushed:1; /* buffer sealed and committed */
  1145. } cont;
  1146. static void cont_flush(void)
  1147. {
  1148. if (cont.flushed)
  1149. return;
  1150. if (cont.len == 0)
  1151. return;
  1152. log_store(cont.facility, cont.level, LOG_NOCONS, cont.ts_nsec,
  1153. NULL, 0, cont.buf, cont.len);
  1154. cont.flushed = true;
  1155. }
  1156. static bool cont_add(int facility, int level, const char *text, size_t len)
  1157. {
  1158. if (cont.len && cont.flushed)
  1159. return false;
  1160. if (cont.len + len > sizeof(cont.buf)) {
  1161. cont_flush();
  1162. return false;
  1163. }
  1164. if (!cont.len) {
  1165. cont.facility = facility;
  1166. cont.level = level;
  1167. cont.owner = current;
  1168. cont.ts_nsec = local_clock();
  1169. cont.cons = 0;
  1170. cont.flushed = false;
  1171. }
  1172. memcpy(cont.buf + cont.len, text, len);
  1173. cont.len += len;
  1174. return true;
  1175. }
  1176. static size_t cont_print_text(char *text, size_t size)
  1177. {
  1178. size_t textlen = 0;
  1179. size_t len;
  1180. if (cont.cons == 0) {
  1181. textlen += print_time(cont.ts_nsec, text);
  1182. size -= textlen;
  1183. }
  1184. len = cont.len - cont.cons;
  1185. if (len > 0) {
  1186. if (len+1 > size)
  1187. len = size-1;
  1188. memcpy(text + textlen, cont.buf + cont.cons, len);
  1189. textlen += len;
  1190. cont.cons = cont.len;
  1191. }
  1192. if (cont.flushed) {
  1193. text[textlen++] = '\n';
  1194. /* got everything, release buffer */
  1195. cont.len = 0;
  1196. }
  1197. return textlen;
  1198. }
  1199. asmlinkage int vprintk_emit(int facility, int level,
  1200. const char *dict, size_t dictlen,
  1201. const char *fmt, va_list args)
  1202. {
  1203. static int recursion_bug;
  1204. static char textbuf[LOG_LINE_MAX];
  1205. char *text = textbuf;
  1206. size_t text_len;
  1207. unsigned long flags;
  1208. int this_cpu;
  1209. bool newline = false;
  1210. bool prefix = false;
  1211. int printed_len = 0;
  1212. boot_delay_msec();
  1213. printk_delay();
  1214. /* This stops the holder of console_sem just where we want him */
  1215. local_irq_save(flags);
  1216. this_cpu = smp_processor_id();
  1217. /*
  1218. * Ouch, printk recursed into itself!
  1219. */
  1220. if (unlikely(logbuf_cpu == this_cpu)) {
  1221. /*
  1222. * If a crash is occurring during printk() on this CPU,
  1223. * then try to get the crash message out but make sure
  1224. * we can't deadlock. Otherwise just return to avoid the
  1225. * recursion and return - but flag the recursion so that
  1226. * it can be printed at the next appropriate moment:
  1227. */
  1228. if (!oops_in_progress && !lockdep_recursing(current)) {
  1229. recursion_bug = 1;
  1230. goto out_restore_irqs;
  1231. }
  1232. zap_locks();
  1233. }
  1234. lockdep_off();
  1235. raw_spin_lock(&logbuf_lock);
  1236. logbuf_cpu = this_cpu;
  1237. if (recursion_bug) {
  1238. static const char recursion_msg[] =
  1239. "BUG: recent printk recursion!";
  1240. recursion_bug = 0;
  1241. printed_len += strlen(recursion_msg);
  1242. /* emit KERN_CRIT message */
  1243. log_store(0, 2, LOG_DEFAULT, 0,
  1244. NULL, 0, recursion_msg, printed_len);
  1245. }
  1246. /*
  1247. * The printf needs to come first; we need the syslog
  1248. * prefix which might be passed-in as a parameter.
  1249. */
  1250. text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
  1251. /* mark and strip a trailing newline */
  1252. if (text_len && text[text_len-1] == '\n') {
  1253. text_len--;
  1254. newline = true;
  1255. }
  1256. /* strip syslog prefix and extract log level or control flags */
  1257. if (text[0] == '<' && text[1] && text[2] == '>') {
  1258. switch (text[1]) {
  1259. case '0' ... '7':
  1260. if (level == -1)
  1261. level = text[1] - '0';
  1262. case 'd': /* KERN_DEFAULT */
  1263. prefix = true;
  1264. case 'c': /* KERN_CONT */
  1265. text += 3;
  1266. text_len -= 3;
  1267. }
  1268. }
  1269. if (level == -1)
  1270. level = default_message_loglevel;
  1271. if (dict) {
  1272. prefix = true;
  1273. newline = true;
  1274. }
  1275. if (!newline) {
  1276. /*
  1277. * Flush the conflicting buffer. An earlier newline was missing,
  1278. * or another task also prints continuation lines.
  1279. */
  1280. if (cont.len && (prefix || cont.owner != current))
  1281. cont_flush();
  1282. /* buffer line if possible, otherwise store it right away */
  1283. if (!cont_add(facility, level, text, text_len))
  1284. log_store(facility, level, LOG_DEFAULT, 0,
  1285. dict, dictlen, text, text_len);
  1286. } else {
  1287. bool stored = false;
  1288. /*
  1289. * If an earlier newline was missing and it was the same task,
  1290. * either merge it with the current buffer and flush, or if
  1291. * there was a race with interrupts (prefix == true) then just
  1292. * flush it out and store this line separately.
  1293. */
  1294. if (cont.len && cont.owner == current) {
  1295. if (!prefix)
  1296. stored = cont_add(facility, level, text, text_len);
  1297. cont_flush();
  1298. }
  1299. if (!stored)
  1300. log_store(facility, level, LOG_DEFAULT, 0,
  1301. dict, dictlen, text, text_len);
  1302. }
  1303. printed_len += text_len;
  1304. /*
  1305. * Try to acquire and then immediately release the console semaphore.
  1306. * The release will print out buffers and wake up /dev/kmsg and syslog()
  1307. * users.
  1308. *
  1309. * The console_trylock_for_printk() function will release 'logbuf_lock'
  1310. * regardless of whether it actually gets the console semaphore or not.
  1311. */
  1312. if (console_trylock_for_printk(this_cpu))
  1313. console_unlock();
  1314. lockdep_on();
  1315. out_restore_irqs:
  1316. local_irq_restore(flags);
  1317. return printed_len;
  1318. }
  1319. EXPORT_SYMBOL(vprintk_emit);
  1320. asmlinkage int vprintk(const char *fmt, va_list args)
  1321. {
  1322. return vprintk_emit(0, -1, NULL, 0, fmt, args);
  1323. }
  1324. EXPORT_SYMBOL(vprintk);
  1325. asmlinkage int printk_emit(int facility, int level,
  1326. const char *dict, size_t dictlen,
  1327. const char *fmt, ...)
  1328. {
  1329. va_list args;
  1330. int r;
  1331. va_start(args, fmt);
  1332. r = vprintk_emit(facility, level, dict, dictlen, fmt, args);
  1333. va_end(args);
  1334. return r;
  1335. }
  1336. EXPORT_SYMBOL(printk_emit);
  1337. /**
  1338. * printk - print a kernel message
  1339. * @fmt: format string
  1340. *
  1341. * This is printk(). It can be called from any context. We want it to work.
  1342. *
  1343. * We try to grab the console_lock. If we succeed, it's easy - we log the
  1344. * output and call the console drivers. If we fail to get the semaphore, we
  1345. * place the output into the log buffer and return. The current holder of
  1346. * the console_sem will notice the new output in console_unlock(); and will
  1347. * send it to the consoles before releasing the lock.
  1348. *
  1349. * One effect of this deferred printing is that code which calls printk() and
  1350. * then changes console_loglevel may break. This is because console_loglevel
  1351. * is inspected when the actual printing occurs.
  1352. *
  1353. * See also:
  1354. * printf(3)
  1355. *
  1356. * See the vsnprintf() documentation for format string extensions over C99.
  1357. */
  1358. asmlinkage int printk(const char *fmt, ...)
  1359. {
  1360. va_list args;
  1361. int r;
  1362. #ifdef CONFIG_KGDB_KDB
  1363. if (unlikely(kdb_trap_printk)) {
  1364. va_start(args, fmt);
  1365. r = vkdb_printf(fmt, args);
  1366. va_end(args);
  1367. return r;
  1368. }
  1369. #endif
  1370. va_start(args, fmt);
  1371. r = vprintk_emit(0, -1, NULL, 0, fmt, args);
  1372. va_end(args);
  1373. return r;
  1374. }
  1375. EXPORT_SYMBOL(printk);
  1376. #else
  1377. #define LOG_LINE_MAX 0
  1378. static struct cont {
  1379. size_t len;
  1380. size_t cons;
  1381. u8 level;
  1382. bool flushed:1;
  1383. } cont;
  1384. static struct log *log_from_idx(u32 idx) { return NULL; }
  1385. static u32 log_next(u32 idx) { return 0; }
  1386. static void call_console_drivers(int level, const char *text, size_t len) {}
  1387. static size_t msg_print_text(const struct log *msg, bool syslog,
  1388. char *buf, size_t size) { return 0; }
  1389. static size_t cont_print_text(char *text, size_t size) { return 0; }
  1390. #endif /* CONFIG_PRINTK */
  1391. static int __add_preferred_console(char *name, int idx, char *options,
  1392. char *brl_options)
  1393. {
  1394. struct console_cmdline *c;
  1395. int i;
  1396. /*
  1397. * See if this tty is not yet registered, and
  1398. * if we have a slot free.
  1399. */
  1400. for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
  1401. if (strcmp(console_cmdline[i].name, name) == 0 &&
  1402. console_cmdline[i].index == idx) {
  1403. if (!brl_options)
  1404. selected_console = i;
  1405. return 0;
  1406. }
  1407. if (i == MAX_CMDLINECONSOLES)
  1408. return -E2BIG;
  1409. if (!brl_options)
  1410. selected_console = i;
  1411. c = &console_cmdline[i];
  1412. strlcpy(c->name, name, sizeof(c->name));
  1413. c->options = options;
  1414. #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
  1415. c->brl_options = brl_options;
  1416. #endif
  1417. c->index = idx;
  1418. return 0;
  1419. }
  1420. /*
  1421. * Set up a list of consoles. Called from init/main.c
  1422. */
  1423. static int __init console_setup(char *str)
  1424. {
  1425. char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for index */
  1426. char *s, *options, *brl_options = NULL;
  1427. int idx;
  1428. #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
  1429. if (!memcmp(str, "brl,", 4)) {
  1430. brl_options = "";
  1431. str += 4;
  1432. } else if (!memcmp(str, "brl=", 4)) {
  1433. brl_options = str + 4;
  1434. str = strchr(brl_options, ',');
  1435. if (!str) {
  1436. printk(KERN_ERR "need port name after brl=\n");
  1437. return 1;
  1438. }
  1439. *(str++) = 0;
  1440. }
  1441. #endif
  1442. /*
  1443. * Decode str into name, index, options.
  1444. */
  1445. if (str[0] >= '0' && str[0] <= '9') {
  1446. strcpy(buf, "ttyS");
  1447. strncpy(buf + 4, str, sizeof(buf) - 5);
  1448. } else {
  1449. strncpy(buf, str, sizeof(buf) - 1);
  1450. }
  1451. buf[sizeof(buf) - 1] = 0;
  1452. if ((options = strchr(str, ',')) != NULL)
  1453. *(options++) = 0;
  1454. #ifdef __sparc__
  1455. if (!strcmp(str, "ttya"))
  1456. strcpy(buf, "ttyS0");
  1457. if (!strcmp(str, "ttyb"))
  1458. strcpy(buf, "ttyS1");
  1459. #endif
  1460. for (s = buf; *s; s++)
  1461. if ((*s >= '0' && *s <= '9') || *s == ',')
  1462. break;
  1463. idx = simple_strtoul(s, NULL, 10);
  1464. *s = 0;
  1465. __add_preferred_console(buf, idx, options, brl_options);
  1466. console_set_on_cmdline = 1;
  1467. return 1;
  1468. }
  1469. __setup("console=", console_setup);
  1470. /**
  1471. * add_preferred_console - add a device to the list of preferred consoles.
  1472. * @name: device name
  1473. * @idx: device index
  1474. * @options: options for this console
  1475. *
  1476. * The last preferred console added will be used for kernel messages
  1477. * and stdin/out/err for init. Normally this is used by console_setup
  1478. * above to handle user-supplied console arguments; however it can also
  1479. * be used by arch-specific code either to override the user or more
  1480. * commonly to provide a default console (ie from PROM variables) when
  1481. * the user has not supplied one.
  1482. */
  1483. int add_preferred_console(char *name, int idx, char *options)
  1484. {
  1485. return __add_preferred_console(name, idx, options, NULL);
  1486. }
  1487. int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options)
  1488. {
  1489. struct console_cmdline *c;
  1490. int i;
  1491. for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
  1492. if (strcmp(console_cmdline[i].name, name) == 0 &&
  1493. console_cmdline[i].index == idx) {
  1494. c = &console_cmdline[i];
  1495. strlcpy(c->name, name_new, sizeof(c->name));
  1496. c->name[sizeof(c->name) - 1] = 0;
  1497. c->options = options;
  1498. c->index = idx_new;
  1499. return i;
  1500. }
  1501. /* not found */
  1502. return -1;
  1503. }
  1504. bool console_suspend_enabled = 1;
  1505. EXPORT_SYMBOL(console_suspend_enabled);
  1506. static int __init console_suspend_disable(char *str)
  1507. {
  1508. console_suspend_enabled = 0;
  1509. return 1;
  1510. }
  1511. __setup("no_console_suspend", console_suspend_disable);
  1512. module_param_named(console_suspend, console_suspend_enabled,
  1513. bool, S_IRUGO | S_IWUSR);
  1514. MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
  1515. " and hibernate operations");
  1516. /**
  1517. * suspend_console - suspend the console subsystem
  1518. *
  1519. * This disables printk() while we go into suspend states
  1520. */
  1521. void suspend_console(void)
  1522. {
  1523. if (!console_suspend_enabled)
  1524. return;
  1525. printk("Suspending console(s) (use no_console_suspend to debug)\n");
  1526. console_lock();
  1527. console_suspended = 1;
  1528. up(&console_sem);
  1529. }
  1530. void resume_console(void)
  1531. {
  1532. if (!console_suspend_enabled)
  1533. return;
  1534. down(&console_sem);
  1535. console_suspended = 0;
  1536. console_unlock();
  1537. }
  1538. /**
  1539. * console_cpu_notify - print deferred console messages after CPU hotplug
  1540. * @self: notifier struct
  1541. * @action: CPU hotplug event
  1542. * @hcpu: unused
  1543. *
  1544. * If printk() is called from a CPU that is not online yet, the messages
  1545. * will be spooled but will not show up on the console. This function is
  1546. * called when a new CPU comes online (or fails to come up), and ensures
  1547. * that any such output gets printed.
  1548. */
  1549. static int __cpuinit console_cpu_notify(struct notifier_block *self,
  1550. unsigned long action, void *hcpu)
  1551. {
  1552. switch (action) {
  1553. case CPU_ONLINE:
  1554. case CPU_DEAD:
  1555. case CPU_DYING:
  1556. case CPU_DOWN_FAILED:
  1557. case CPU_UP_CANCELED:
  1558. console_lock();
  1559. console_unlock();
  1560. }
  1561. return NOTIFY_OK;
  1562. }
  1563. /**
  1564. * console_lock - lock the console system for exclusive use.
  1565. *
  1566. * Acquires a lock which guarantees that the caller has
  1567. * exclusive access to the console system and the console_drivers list.
  1568. *
  1569. * Can sleep, returns nothing.
  1570. */
  1571. void console_lock(void)
  1572. {
  1573. BUG_ON(in_interrupt());
  1574. down(&console_sem);
  1575. if (console_suspended)
  1576. return;
  1577. console_locked = 1;
  1578. console_may_schedule = 1;
  1579. }
  1580. EXPORT_SYMBOL(console_lock);
  1581. /**
  1582. * console_trylock - try to lock the console system for exclusive use.
  1583. *
  1584. * Tried to acquire a lock which guarantees that the caller has
  1585. * exclusive access to the console system and the console_drivers list.
  1586. *
  1587. * returns 1 on success, and 0 on failure to acquire the lock.
  1588. */
  1589. int console_trylock(void)
  1590. {
  1591. if (down_trylock(&console_sem))
  1592. return 0;
  1593. if (console_suspended) {
  1594. up(&console_sem);
  1595. return 0;
  1596. }
  1597. console_locked = 1;
  1598. console_may_schedule = 0;
  1599. return 1;
  1600. }
  1601. EXPORT_SYMBOL(console_trylock);
  1602. int is_console_locked(void)
  1603. {
  1604. return console_locked;
  1605. }
  1606. /*
  1607. * Delayed printk version, for scheduler-internal messages:
  1608. */
  1609. #define PRINTK_BUF_SIZE 512
  1610. #define PRINTK_PENDING_WAKEUP 0x01
  1611. #define PRINTK_PENDING_SCHED 0x02
  1612. static DEFINE_PER_CPU(int, printk_pending);
  1613. static DEFINE_PER_CPU(char [PRINTK_BUF_SIZE], printk_sched_buf);
  1614. void printk_tick(void)
  1615. {
  1616. if (__this_cpu_read(printk_pending)) {
  1617. int pending = __this_cpu_xchg(printk_pending, 0);
  1618. if (pending & PRINTK_PENDING_SCHED) {
  1619. char *buf = __get_cpu_var(printk_sched_buf);
  1620. printk(KERN_WARNING "[sched_delayed] %s", buf);
  1621. }
  1622. if (pending & PRINTK_PENDING_WAKEUP)
  1623. wake_up_interruptible(&log_wait);
  1624. }
  1625. }
  1626. int printk_needs_cpu(int cpu)
  1627. {
  1628. if (cpu_is_offline(cpu))
  1629. printk_tick();
  1630. return __this_cpu_read(printk_pending);
  1631. }
  1632. void wake_up_klogd(void)
  1633. {
  1634. if (waitqueue_active(&log_wait))
  1635. this_cpu_or(printk_pending, PRINTK_PENDING_WAKEUP);
  1636. }
  1637. /* the next printk record to write to the console */
  1638. static u64 console_seq;
  1639. static u32 console_idx;
  1640. /**
  1641. * console_unlock - unlock the console system
  1642. *
  1643. * Releases the console_lock which the caller holds on the console system
  1644. * and the console driver list.
  1645. *
  1646. * While the console_lock was held, console output may have been buffered
  1647. * by printk(). If this is the case, console_unlock(); emits
  1648. * the output prior to releasing the lock.
  1649. *
  1650. * If there is output waiting, we wake /dev/kmsg and syslog() users.
  1651. *
  1652. * console_unlock(); may be called from any context.
  1653. */
  1654. void console_unlock(void)
  1655. {
  1656. static char text[LOG_LINE_MAX];
  1657. static u64 seen_seq;
  1658. unsigned long flags;
  1659. bool wake_klogd = false;
  1660. bool retry;
  1661. if (console_suspended) {
  1662. up(&console_sem);
  1663. return;
  1664. }
  1665. console_may_schedule = 0;
  1666. /* flush buffered message fragment immediately to console */
  1667. raw_spin_lock_irqsave(&logbuf_lock, flags);
  1668. if (cont.len && (cont.cons < cont.len || cont.flushed)) {
  1669. size_t len;
  1670. len = cont_print_text(text, sizeof(text));
  1671. raw_spin_unlock(&logbuf_lock);
  1672. stop_critical_timings();
  1673. call_console_drivers(cont.level, text, len);
  1674. start_critical_timings();
  1675. local_irq_restore(flags);
  1676. } else
  1677. raw_spin_unlock_irqrestore(&logbuf_lock, flags);
  1678. again:
  1679. for (;;) {
  1680. struct log *msg;
  1681. size_t len;
  1682. int level;
  1683. raw_spin_lock_irqsave(&logbuf_lock, flags);
  1684. if (seen_seq != log_next_seq) {
  1685. wake_klogd = true;
  1686. seen_seq = log_next_seq;
  1687. }
  1688. if (console_seq < log_first_seq) {
  1689. /* messages are gone, move to first one */
  1690. console_seq = log_first_seq;
  1691. console_idx = log_first_idx;
  1692. }
  1693. skip:
  1694. if (console_seq == log_next_seq)
  1695. break;
  1696. msg = log_from_idx(console_idx);
  1697. if (msg->flags & LOG_NOCONS) {
  1698. /*
  1699. * Skip record we have buffered and already printed
  1700. * directly to the console when we received it.
  1701. */
  1702. console_idx = log_next(console_idx);
  1703. console_seq++;
  1704. goto skip;
  1705. }
  1706. level = msg->level;
  1707. len = msg_print_text(msg, false, text, sizeof(text));
  1708. console_idx = log_next(console_idx);
  1709. console_seq++;
  1710. raw_spin_unlock(&logbuf_lock);
  1711. stop_critical_timings(); /* don't trace print latency */
  1712. call_console_drivers(level, text, len);
  1713. start_critical_timings();
  1714. local_irq_restore(flags);
  1715. }
  1716. console_locked = 0;
  1717. /* Release the exclusive_console once it is used */
  1718. if (unlikely(exclusive_console))
  1719. exclusive_console = NULL;
  1720. raw_spin_unlock(&logbuf_lock);
  1721. up(&console_sem);
  1722. /*
  1723. * Someone could have filled up the buffer again, so re-check if there's
  1724. * something to flush. In case we cannot trylock the console_sem again,
  1725. * there's a new owner and the console_unlock() from them will do the
  1726. * flush, no worries.
  1727. */
  1728. raw_spin_lock(&logbuf_lock);
  1729. retry = console_seq != log_next_seq;
  1730. raw_spin_unlock_irqrestore(&logbuf_lock, flags);
  1731. if (retry && console_trylock())
  1732. goto again;
  1733. if (wake_klogd)
  1734. wake_up_klogd();
  1735. }
  1736. EXPORT_SYMBOL(console_unlock);
  1737. /**
  1738. * console_conditional_schedule - yield the CPU if required
  1739. *
  1740. * If the console code is currently allowed to sleep, and
  1741. * if this CPU should yield the CPU to another task, do
  1742. * so here.
  1743. *
  1744. * Must be called within console_lock();.
  1745. */
  1746. void __sched console_conditional_schedule(void)
  1747. {
  1748. if (console_may_schedule)
  1749. cond_resched();
  1750. }
  1751. EXPORT_SYMBOL(console_conditional_schedule);
  1752. void console_unblank(void)
  1753. {
  1754. struct console *c;
  1755. /*
  1756. * console_unblank can no longer be called in interrupt context unless
  1757. * oops_in_progress is set to 1..
  1758. */
  1759. if (oops_in_progress) {
  1760. if (down_trylock(&console_sem) != 0)
  1761. return;
  1762. } else
  1763. console_lock();
  1764. console_locked = 1;
  1765. console_may_schedule = 0;
  1766. for_each_console(c)
  1767. if ((c->flags & CON_ENABLED) && c->unblank)
  1768. c->unblank();
  1769. console_unlock();
  1770. }
  1771. /*
  1772. * Return the console tty driver structure and its associated index
  1773. */
  1774. struct tty_driver *console_device(int *index)
  1775. {
  1776. struct console *c;
  1777. struct tty_driver *driver = NULL;
  1778. console_lock();
  1779. for_each_console(c) {
  1780. if (!c->device)
  1781. continue;
  1782. driver = c->device(c, index);
  1783. if (driver)
  1784. break;
  1785. }
  1786. console_unlock();
  1787. return driver;
  1788. }
  1789. /*
  1790. * Prevent further output on the passed console device so that (for example)
  1791. * serial drivers can disable console output before suspending a port, and can
  1792. * re-enable output afterwards.
  1793. */
  1794. void console_stop(struct console *console)
  1795. {
  1796. console_lock();
  1797. console->flags &= ~CON_ENABLED;
  1798. console_unlock();
  1799. }
  1800. EXPORT_SYMBOL(console_stop);
  1801. void console_start(struct console *console)
  1802. {
  1803. console_lock();
  1804. console->flags |= CON_ENABLED;
  1805. console_unlock();
  1806. }
  1807. EXPORT_SYMBOL(console_start);
  1808. static int __read_mostly keep_bootcon;
  1809. static int __init keep_bootcon_setup(char *str)
  1810. {
  1811. keep_bootcon = 1;
  1812. printk(KERN_INFO "debug: skip boot console de-registration.\n");
  1813. return 0;
  1814. }
  1815. early_param("keep_bootcon", keep_bootcon_setup);
  1816. /*
  1817. * The console driver calls this routine during kernel initialization
  1818. * to register the console printing procedure with printk() and to
  1819. * print any messages that were printed by the kernel before the
  1820. * console driver was initialized.
  1821. *
  1822. * This can happen pretty early during the boot process (because of
  1823. * early_printk) - sometimes before setup_arch() completes - be careful
  1824. * of what kernel features are used - they may not be initialised yet.
  1825. *
  1826. * There are two types of consoles - bootconsoles (early_printk) and
  1827. * "real" consoles (everything which is not a bootconsole) which are
  1828. * handled differently.
  1829. * - Any number of bootconsoles can be registered at any time.
  1830. * - As soon as a "real" console is registered, all bootconsoles
  1831. * will be unregistered automatically.
  1832. * - Once a "real" console is registered, any attempt to register a
  1833. * bootconsoles will be rejected
  1834. */
  1835. void register_console(struct console *newcon)
  1836. {
  1837. int i;
  1838. unsigned long flags;
  1839. struct console *bcon = NULL;
  1840. /*
  1841. * before we register a new CON_BOOT console, make sure we don't
  1842. * already have a valid console
  1843. */
  1844. if (console_drivers && newcon->flags & CON_BOOT) {
  1845. /* find the last or real console */
  1846. for_each_console(bcon) {
  1847. if (!(bcon->flags & CON_BOOT)) {
  1848. printk(KERN_INFO "Too late to register bootconsole %s%d\n",
  1849. newcon->name, newcon->index);
  1850. return;
  1851. }
  1852. }
  1853. }
  1854. if (console_drivers && console_drivers->flags & CON_BOOT)
  1855. bcon = console_drivers;
  1856. if (preferred_console < 0 || bcon || !console_drivers)
  1857. preferred_console = selected_console;
  1858. if (newcon->early_setup)
  1859. newcon->early_setup();
  1860. /*
  1861. * See if we want to use this console driver. If we
  1862. * didn't select a console we take the first one
  1863. * that registers here.
  1864. */
  1865. if (preferred_console < 0) {
  1866. if (newcon->index < 0)
  1867. newcon->index = 0;
  1868. if (newcon->setup == NULL ||
  1869. newcon->setup(newcon, NULL) == 0) {
  1870. newcon->flags |= CON_ENABLED;
  1871. if (newcon->device) {
  1872. newcon->flags |= CON_CONSDEV;
  1873. preferred_console = 0;
  1874. }
  1875. }
  1876. }
  1877. /*
  1878. * See if this console matches one we selected on
  1879. * the command line.
  1880. */
  1881. for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0];
  1882. i++) {
  1883. if (strcmp(console_cmdline[i].name, newcon->name) != 0)
  1884. continue;
  1885. if (newcon->index >= 0 &&
  1886. newcon->index != console_cmdline[i].index)
  1887. continue;
  1888. if (newcon->index < 0)
  1889. newcon->index = console_cmdline[i].index;
  1890. #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
  1891. if (console_cmdline[i].brl_options) {
  1892. newcon->flags |= CON_BRL;
  1893. braille_register_console(newcon,
  1894. console_cmdline[i].index,
  1895. console_cmdline[i].options,
  1896. console_cmdline[i].brl_options);
  1897. return;
  1898. }
  1899. #endif
  1900. if (newcon->setup &&
  1901. newcon->setup(newcon, console_cmdline[i].options) != 0)
  1902. break;
  1903. newcon->flags |= CON_ENABLED;
  1904. newcon->index = console_cmdline[i].index;
  1905. if (i == selected_console) {
  1906. newcon->flags |= CON_CONSDEV;
  1907. preferred_console = selected_console;
  1908. }
  1909. break;
  1910. }
  1911. if (!(newcon->flags & CON_ENABLED))
  1912. return;
  1913. /*
  1914. * If we have a bootconsole, and are switching to a real console,
  1915. * don't print everything out again, since when the boot console, and
  1916. * the real console are the same physical device, it's annoying to
  1917. * see the beginning boot messages twice
  1918. */
  1919. if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
  1920. newcon->flags &= ~CON_PRINTBUFFER;
  1921. /*
  1922. * Put this console in the list - keep the
  1923. * preferred driver at the head of the list.
  1924. */
  1925. console_lock();
  1926. if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
  1927. newcon->next = console_drivers;
  1928. console_drivers = newcon;
  1929. if (newcon->next)
  1930. newcon->next->flags &= ~CON_CONSDEV;
  1931. } else {
  1932. newcon->next = console_drivers->next;
  1933. console_drivers->next = newcon;
  1934. }
  1935. if (newcon->flags & CON_PRINTBUFFER) {
  1936. /*
  1937. * console_unlock(); will print out the buffered messages
  1938. * for us.
  1939. */
  1940. raw_spin_lock_irqsave(&logbuf_lock, flags);
  1941. console_seq = syslog_seq;
  1942. console_idx = syslog_idx;
  1943. raw_spin_unlock_irqrestore(&logbuf_lock, flags);
  1944. /*
  1945. * We're about to replay the log buffer. Only do this to the
  1946. * just-registered console to avoid excessive message spam to
  1947. * the already-registered consoles.
  1948. */
  1949. exclusive_console = newcon;
  1950. }
  1951. console_unlock();
  1952. console_sysfs_notify();
  1953. /*
  1954. * By unregistering the bootconsoles after we enable the real console
  1955. * we get the "console xxx enabled" message on all the consoles -
  1956. * boot consoles, real consoles, etc - this is to ensure that end
  1957. * users know there might be something in the kernel's log buffer that
  1958. * went to the bootconsole (that they do not see on the real console)
  1959. */
  1960. if (bcon &&
  1961. ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
  1962. !keep_bootcon) {
  1963. /* we need to iterate through twice, to make sure we print
  1964. * everything out, before we unregister the console(s)
  1965. */
  1966. printk(KERN_INFO "console [%s%d] enabled, bootconsole disabled\n",
  1967. newcon->name, newcon->index);
  1968. for_each_console(bcon)
  1969. if (bcon->flags & CON_BOOT)
  1970. unregister_console(bcon);
  1971. } else {
  1972. printk(KERN_INFO "%sconsole [%s%d] enabled\n",
  1973. (newcon->flags & CON_BOOT) ? "boot" : "" ,
  1974. newcon->name, newcon->index);
  1975. }
  1976. }
  1977. EXPORT_SYMBOL(register_console);
  1978. int unregister_console(struct console *console)
  1979. {
  1980. struct console *a, *b;
  1981. int res = 1;
  1982. #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
  1983. if (console->flags & CON_BRL)
  1984. return braille_unregister_console(console);
  1985. #endif
  1986. console_lock();
  1987. if (console_drivers == console) {
  1988. console_drivers=console->next;
  1989. res = 0;
  1990. } else if (console_drivers) {
  1991. for (a=console_drivers->next, b=console_drivers ;
  1992. a; b=a, a=b->next) {
  1993. if (a == console) {
  1994. b->next = a->next;
  1995. res = 0;
  1996. break;
  1997. }
  1998. }
  1999. }
  2000. /*
  2001. * If this isn't the last console and it has CON_CONSDEV set, we
  2002. * need to set it on the next preferred console.
  2003. */
  2004. if (console_drivers != NULL && console->flags & CON_CONSDEV)
  2005. console_drivers->flags |= CON_CONSDEV;
  2006. console_unlock();
  2007. console_sysfs_notify();
  2008. return res;
  2009. }
  2010. EXPORT_SYMBOL(unregister_console);
  2011. static int __init printk_late_init(void)
  2012. {
  2013. struct console *con;
  2014. for_each_console(con) {
  2015. if (!keep_bootcon && con->flags & CON_BOOT) {
  2016. printk(KERN_INFO "turn off boot console %s%d\n",
  2017. con->name, con->index);
  2018. unregister_console(con);
  2019. }
  2020. }
  2021. hotcpu_notifier(console_cpu_notify, 0);
  2022. return 0;
  2023. }
  2024. late_initcall(printk_late_init);
  2025. #if defined CONFIG_PRINTK
  2026. int printk_sched(const char *fmt, ...)
  2027. {
  2028. unsigned long flags;
  2029. va_list args;
  2030. char *buf;
  2031. int r;
  2032. local_irq_save(flags);
  2033. buf = __get_cpu_var(printk_sched_buf);
  2034. va_start(args, fmt);
  2035. r = vsnprintf(buf, PRINTK_BUF_SIZE, fmt, args);
  2036. va_end(args);
  2037. __this_cpu_or(printk_pending, PRINTK_PENDING_SCHED);
  2038. local_irq_restore(flags);
  2039. return r;
  2040. }
  2041. /*
  2042. * printk rate limiting, lifted from the networking subsystem.
  2043. *
  2044. * This enforces a rate limit: not more than 10 kernel messages
  2045. * every 5s to make a denial-of-service attack impossible.
  2046. */
  2047. DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
  2048. int __printk_ratelimit(const char *func)
  2049. {
  2050. return ___ratelimit(&printk_ratelimit_state, func);
  2051. }
  2052. EXPORT_SYMBOL(__printk_ratelimit);
  2053. /**
  2054. * printk_timed_ratelimit - caller-controlled printk ratelimiting
  2055. * @caller_jiffies: pointer to caller's state
  2056. * @interval_msecs: minimum interval between prints
  2057. *
  2058. * printk_timed_ratelimit() returns true if more than @interval_msecs
  2059. * milliseconds have elapsed since the last time printk_timed_ratelimit()
  2060. * returned true.
  2061. */
  2062. bool printk_timed_ratelimit(unsigned long *caller_jiffies,
  2063. unsigned int interval_msecs)
  2064. {
  2065. if (*caller_jiffies == 0
  2066. || !time_in_range(jiffies, *caller_jiffies,
  2067. *caller_jiffies
  2068. + msecs_to_jiffies(interval_msecs))) {
  2069. *caller_jiffies = jiffies;
  2070. return true;
  2071. }
  2072. return false;
  2073. }
  2074. EXPORT_SYMBOL(printk_timed_ratelimit);
  2075. static DEFINE_SPINLOCK(dump_list_lock);
  2076. static LIST_HEAD(dump_list);
  2077. /**
  2078. * kmsg_dump_register - register a kernel log dumper.
  2079. * @dumper: pointer to the kmsg_dumper structure
  2080. *
  2081. * Adds a kernel log dumper to the system. The dump callback in the
  2082. * structure will be called when the kernel oopses or panics and must be
  2083. * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
  2084. */
  2085. int kmsg_dump_register(struct kmsg_dumper *dumper)
  2086. {
  2087. unsigned long flags;
  2088. int err = -EBUSY;
  2089. /* The dump callback needs to be set */
  2090. if (!dumper->dump)
  2091. return -EINVAL;
  2092. spin_lock_irqsave(&dump_list_lock, flags);
  2093. /* Don't allow registering multiple times */
  2094. if (!dumper->registered) {
  2095. dumper->registered = 1;
  2096. list_add_tail_rcu(&dumper->list, &dump_list);
  2097. err = 0;
  2098. }
  2099. spin_unlock_irqrestore(&dump_list_lock, flags);
  2100. return err;
  2101. }
  2102. EXPORT_SYMBOL_GPL(kmsg_dump_register);
  2103. /**
  2104. * kmsg_dump_unregister - unregister a kmsg dumper.
  2105. * @dumper: pointer to the kmsg_dumper structure
  2106. *
  2107. * Removes a dump device from the system. Returns zero on success and
  2108. * %-EINVAL otherwise.
  2109. */
  2110. int kmsg_dump_unregister(struct kmsg_dumper *dumper)
  2111. {
  2112. unsigned long flags;
  2113. int err = -EINVAL;
  2114. spin_lock_irqsave(&dump_list_lock, flags);
  2115. if (dumper->registered) {
  2116. dumper->registered = 0;
  2117. list_del_rcu(&dumper->list);
  2118. err = 0;
  2119. }
  2120. spin_unlock_irqrestore(&dump_list_lock, flags);
  2121. synchronize_rcu();
  2122. return err;
  2123. }
  2124. EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
  2125. static bool always_kmsg_dump;
  2126. module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);
  2127. /**
  2128. * kmsg_dump - dump kernel log to kernel message dumpers.
  2129. * @reason: the reason (oops, panic etc) for dumping
  2130. *
  2131. * Call each of the registered dumper's dump() callback, which can
  2132. * retrieve the kmsg records with kmsg_dump_get_line() or
  2133. * kmsg_dump_get_buffer().
  2134. */
  2135. void kmsg_dump(enum kmsg_dump_reason reason)
  2136. {
  2137. struct kmsg_dumper *dumper;
  2138. unsigned long flags;
  2139. if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
  2140. return;
  2141. rcu_read_lock();
  2142. list_for_each_entry_rcu(dumper, &dump_list, list) {
  2143. if (dumper->max_reason && reason > dumper->max_reason)
  2144. continue;
  2145. /* initialize iterator with data about the stored records */
  2146. dumper->active = true;
  2147. raw_spin_lock_irqsave(&logbuf_lock, flags);
  2148. dumper->cur_seq = clear_seq;
  2149. dumper->cur_idx = clear_idx;
  2150. dumper->next_seq = log_next_seq;
  2151. dumper->next_idx = log_next_idx;
  2152. raw_spin_unlock_irqrestore(&logbuf_lock, flags);
  2153. /* invoke dumper which will iterate over records */
  2154. dumper->dump(dumper, reason);
  2155. /* reset iterator */
  2156. dumper->active = false;
  2157. }
  2158. rcu_read_unlock();
  2159. }
  2160. /**
  2161. * kmsg_dump_get_line - retrieve one kmsg log line
  2162. * @dumper: registered kmsg dumper
  2163. * @syslog: include the "<4>" prefixes
  2164. * @line: buffer to copy the line to
  2165. * @size: maximum size of the buffer
  2166. * @len: length of line placed into buffer
  2167. *
  2168. * Start at the beginning of the kmsg buffer, with the oldest kmsg
  2169. * record, and copy one record into the provided buffer.
  2170. *
  2171. * Consecutive calls will return the next available record moving
  2172. * towards the end of the buffer with the youngest messages.
  2173. *
  2174. * A return value of FALSE indicates that there are no more records to
  2175. * read.
  2176. */
  2177. bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
  2178. char *line, size_t size, size_t *len)
  2179. {
  2180. unsigned long flags;
  2181. struct log *msg;
  2182. size_t l = 0;
  2183. bool ret = false;
  2184. if (!dumper->active)
  2185. goto out;
  2186. raw_spin_lock_irqsave(&logbuf_lock, flags);
  2187. if (dumper->cur_seq < log_first_seq) {
  2188. /* messages are gone, move to first available one */
  2189. dumper->cur_seq = log_first_seq;
  2190. dumper->cur_idx = log_first_idx;
  2191. }
  2192. /* last entry */
  2193. if (dumper->cur_seq >= log_next_seq) {
  2194. raw_spin_unlock_irqrestore(&logbuf_lock, flags);
  2195. goto out;
  2196. }
  2197. msg = log_from_idx(dumper->cur_idx);
  2198. l = msg_print_text(msg, syslog,
  2199. line, size);
  2200. dumper->cur_idx = log_next(dumper->cur_idx);
  2201. dumper->cur_seq++;
  2202. ret = true;
  2203. raw_spin_unlock_irqrestore(&logbuf_lock, flags);
  2204. out:
  2205. if (len)
  2206. *len = l;
  2207. return ret;
  2208. }
  2209. EXPORT_SYMBOL_GPL(kmsg_dump_get_line);
  2210. /**
  2211. * kmsg_dump_get_buffer - copy kmsg log lines
  2212. * @dumper: registered kmsg dumper
  2213. * @syslog: include the "<4>" prefixes
  2214. * @buf: buffer to copy the line to
  2215. * @size: maximum size of the buffer
  2216. * @len: length of line placed into buffer
  2217. *
  2218. * Start at the end of the kmsg buffer and fill the provided buffer
  2219. * with as many of the the *youngest* kmsg records that fit into it.
  2220. * If the buffer is large enough, all available kmsg records will be
  2221. * copied with a single call.
  2222. *
  2223. * Consecutive calls will fill the buffer with the next block of
  2224. * available older records, not including the earlier retrieved ones.
  2225. *
  2226. * A return value of FALSE indicates that there are no more records to
  2227. * read.
  2228. */
  2229. bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
  2230. char *buf, size_t size, size_t *len)
  2231. {
  2232. unsigned long flags;
  2233. u64 seq;
  2234. u32 idx;
  2235. u64 next_seq;
  2236. u32 next_idx;
  2237. size_t l = 0;
  2238. bool ret = false;
  2239. if (!dumper->active)
  2240. goto out;
  2241. raw_spin_lock_irqsave(&logbuf_lock, flags);
  2242. if (dumper->cur_seq < log_first_seq) {
  2243. /* messages are gone, move to first available one */
  2244. dumper->cur_seq = log_first_seq;
  2245. dumper->cur_idx = log_first_idx;
  2246. }
  2247. /* last entry */
  2248. if (dumper->cur_seq >= dumper->next_seq) {
  2249. raw_spin_unlock_irqrestore(&logbuf_lock, flags);
  2250. goto out;
  2251. }
  2252. /* calculate length of entire buffer */
  2253. seq = dumper->cur_seq;
  2254. idx = dumper->cur_idx;
  2255. while (seq < dumper->next_seq) {
  2256. struct log *msg = log_from_idx(idx);
  2257. l += msg_print_text(msg, true, NULL, 0);
  2258. idx = log_next(idx);
  2259. seq++;
  2260. }
  2261. /* move first record forward until length fits into the buffer */
  2262. seq = dumper->cur_seq;
  2263. idx = dumper->cur_idx;
  2264. while (l > size && seq < dumper->next_seq) {
  2265. struct log *msg = log_from_idx(idx);
  2266. l -= msg_print_text(msg, true, NULL, 0);
  2267. idx = log_next(idx);
  2268. seq++;
  2269. }
  2270. /* last message in next interation */
  2271. next_seq = seq;
  2272. next_idx = idx;
  2273. l = 0;
  2274. while (seq < dumper->next_seq) {
  2275. struct log *msg = log_from_idx(idx);
  2276. l += msg_print_text(msg, syslog,
  2277. buf + l, size - l);
  2278. idx = log_next(idx);
  2279. seq++;
  2280. }
  2281. dumper->next_seq = next_seq;
  2282. dumper->next_idx = next_idx;
  2283. ret = true;
  2284. raw_spin_unlock_irqrestore(&logbuf_lock, flags);
  2285. out:
  2286. if (len)
  2287. *len = l;
  2288. return ret;
  2289. }
  2290. EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
  2291. /**
  2292. * kmsg_dump_rewind - reset the interator
  2293. * @dumper: registered kmsg dumper
  2294. *
  2295. * Reset the dumper's iterator so that kmsg_dump_get_line() and
  2296. * kmsg_dump_get_buffer() can be called again and used multiple
  2297. * times within the same dumper.dump() callback.
  2298. */
  2299. void kmsg_dump_rewind(struct kmsg_dumper *dumper)
  2300. {
  2301. unsigned long flags;
  2302. raw_spin_lock_irqsave(&logbuf_lock, flags);
  2303. dumper->cur_seq = clear_seq;
  2304. dumper->cur_idx = clear_idx;
  2305. dumper->next_seq = log_next_seq;
  2306. dumper->next_idx = log_next_idx;
  2307. raw_spin_unlock_irqrestore(&logbuf_lock, flags);
  2308. }
  2309. EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
  2310. #endif