printk.c 69 KB

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