diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +CPU load and memory usage indicators +==================================== + +`nc-indicators` displays a CPU load and memory usage mini-graphs in +your `i3bar`, much like Gnome's `indicator-multiload` applet. + +To use `nc-indicators` simply `exec` it on startup: + +``` +exec --no-startup-id nc-indicators +``` + +You can turn off either indicator and change the update interval, eg.: + +``` +exec --no-startup-id nc-indicators --show_mem=0 --update_interval=300 +``` + +`nc-indicators` uses the standard system tray icon protocol, so it +can be used with any system tray-like application, not just +`i3bar`. But it was originally created to be used with `i3bar`. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/nc-indicators.cabal b/nc-indicators.cabal new file mode 100644 --- /dev/null +++ b/nc-indicators.cabal @@ -0,0 +1,56 @@ +Name: nc-indicators +Version: 0.1 +License: Apache-2.0 +License-File: LICENSE +Author: Mihaly Barasz, Gergely Risko +Maintainer: Mihaly Barasz , Gergely Risko +Cabal-Version: >= 1.10 +Build-Type: Simple +Category: System +Stability: experimental +Homepage: https://github.com/nilcons/nc-indicators/issues +Bug-Reports: https://github.com/nilcons/nc-indicators/issues +Synopsis: CPU load and memory usage indicators for i3bar +Description: + @nc-indicators@ displays a CPU load and memory usage mini-graphs in + your @i3bar@, much like Gnome's @indicator-multiload@ applet. + . + To use @nc-indicators@ simply @exec@ it on startup: + . + @ + exec --no-startup-id nc-indicators + @ + . + You can turn off either indicator and change the update interval, eg.: + . + @ + exec --no-startup-id nc-indicators --show_mem=0 --update_interval=300 + @ + . + @nc-indicators@ uses the standard system tray icon protocol, so it + can be used with any system tray-like application, not just + @i3bar@. But it was originally created to be used with @i3bar@. + +Extra-Source-Files: + README.md + +Source-Repository head + Type: git + Location: https://github.com/nilcons/nc-indicators.git + +Executable nc-indicators + Main-Is: nc-indicators.hs + Default-Language: Haskell2010 + GHC-Options: -Wall -threaded + Build-Depends: + base >= 4.6 && < 5 + , array >= 0.4 + , attoparsec >= 0.10 + , bytestring >= 0.10 + , containers >= 0.5 + , gtk >= 0.12 + , hflags >= 0.4 + , lens >= 3.10 + , pipes >= 4.0 + , stm >= 2.4 + , unix >= 2.6 diff --git a/nc-indicators.hs b/nc-indicators.hs new file mode 100644 --- /dev/null +++ b/nc-indicators.hs @@ -0,0 +1,232 @@ +-- Copyright 2014 Mihaly Barasz & Gergely Risko +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. + + +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE FlexibleContexts #-} + +module Main (main) where + +import Control.Applicative +import Control.Concurrent (forkIO, threadDelay) +import Control.Concurrent.STM +import Control.Lens +import Control.Monad +import qualified Data.Array.MArray as MA +import Data.Attoparsec.ByteString.Char8 (decimal, (.*>), skipSpace, skipWhile) +import qualified Data.Attoparsec.ByteString as AP +import Data.ByteString (ByteString) +import qualified Data.ByteString as BS +import Data.Char +import Data.Sequence (Seq) +import qualified Data.Sequence as S +import Data.Word (Word32) +import qualified Graphics.UI.Gtk as Gtk +import HFlags +import Pipes (Producer, yield, (>->), await, Consumer, Pipe, lift, runEffect) +import System.Environment +import System.IO +import System.Posix.Signals +import Text.Printf + + +defineFlag "show_cpu" True "Show the CPU load indicator/icon." +defineFlag "show_mem" True "Show the memory usage indicator/icon." +defineFlag "update_interval" (500 :: Int) + "Update interval for all indicators in milliseconds." + +-------------------------------------------------------------------------------- +-- Acquiring raw CPU and RAM numbers + +data CPUCounters = + CPUCounters { cpuUser :: {-# UNPACK #-} !Int + , cpuAllSys :: {-# UNPACK #-} !Int + , cpuIdle :: {-# UNPACK #-} !Int + } deriving (Show) + +-- The counters are in milliseconds and cumulative since system start. +readCPUCounters :: IO CPUCounters +readCPUCounters = parseProcStat <$> readProcFile "/proc/stat" + where + parseProcStat = forceParse parseFirstLine + parseFirstLine = wrapResult <$ "cpu " .*> skipSpace + <*> decimal <* skipSpace <*> decimal <* skipSpace + <*> decimal <* skipSpace <*> decimal <* skipSpace + <*> decimal <* skipSpace <*> decimal <* skipSpace + <*> decimal + wrapResult user nice system idle iowait irq softirq = + CPUCounters (user+nice) (system+iowait+irq+softirq) idle + +data MEMCounters = + MEMCounters { ramTotal :: {-# UNPACK #-} !Int + , ramCached :: {-# UNPACK #-} !Int + , ramFree :: {-# UNPACK #-} !Int + } deriving (Show) + +-- The counters are in kB. +readMEMCounters :: IO MEMCounters +readMEMCounters = parseProcMeminfo <$> readProcFile "/proc/meminfo" + where + parseProcMeminfo = forceParse parseHead + parseHead :: AP.Parser MEMCounters + parseHead = + wrapResult <$ "MemTotal:" .*> skipSpace <*> decimal <* kb <* + "MemFree:" .*> skipSpace <*> decimal <* kb <* + "Buffers:" .*> skipSpace <* (skipWhile isDigit) <* kb <* + "Cached:" .*> skipSpace <*> decimal <* kb + kb = skipSpace *> "kB" .*> skipSpace + wrapResult total free cached = + MEMCounters total cached free + +forceParse :: AP.Parser a -> BS.ByteString -> a +forceParse parser = either error id . AP.parseOnly parser + +-- If you stat /proc/stat or /proc/meminfo they look 0 sized, so we +-- cannot use BS.readFile. +-- We assume that all files of interest fit in 4k. +readProcFile :: FilePath -> IO ByteString +readProcFile file = withBinaryFile file ReadMode $ flip BS.hGetSome 4096 + +-------------------------------------------------------------------------------- +-- Pipes + +-- TODO(klao): use strict pairs +type Measurement = (Double, Double) + +measureMEM :: Producer Measurement IO r +measureMEM = forever $ do + MEMCounters total cached free <- lift readMEMCounters + yield (fromIntegral (total-cached-free) / fromIntegral total, + fromIntegral cached / fromIntegral total) + +measureCPU :: Producer Measurement IO r +measureCPU = lift readCPUCounters >>= go + where + go (CPUCounters user0 sys0 idle0) = do + m@(CPUCounters user sys idle) <- lift readCPUCounters + -- TODO(klao): handle overflows! + let total = fromIntegral $ user + sys + idle - user0 - sys0 - idle0 + when (total > 0) $ yield (fromIntegral (user - user0) / total, + fromIntegral (sys - sys0) / total) + go m + +delay :: Pipe a a IO r +delay = execU (threadDelay $ flags_update_interval * 1000) + +prettyPrint :: String -> Consumer Measurement IO r +prettyPrint label = forever $ do + (x1, x2) <- await + lift $ printf "%s: %4.1f%% %4.1f%%\n" label (x1*100) (x2*100) + +collectN :: Int -> Pipe Measurement (Seq Measurement) IO r +collectN n = go S.empty + where + go l = do + m <- await + let l' = S.take n $ m <| l + yield l' + go l' + +-------------------------------------------------------------------------------- +-- Random helpers + +replaceTMVar :: TMVar a -> a -> STM () +replaceTMVar var v = tryTakeTMVar var >> putTMVar var v + + +execU :: Monad m => m () -> Pipe a a m r +execU mOp = forever $ do + lift mOp + await >>= yield + +-------------------------------------------------------------------------------- +-- Status Icon handling + +data MeasuredIcon + = MI { miIcon :: Gtk.StatusIcon + , miPixbuf :: TMVar Gtk.Pixbuf + } + +type Pixel = Word32 + + +createIcon :: IO MeasuredIcon +createIcon = do + icon <- Gtk.statusIconNew + pixbufVar <- newEmptyTMVarIO + _ <- Gtk.on icon Gtk.statusIconSizeChanged $ \size -> do + pixbuf <- Gtk.pixbufNew Gtk.ColorspaceRgb True 8 size size + atomically $ replaceTMVar pixbufVar pixbuf + return True + + return $ MI icon pixbufVar + +updateIcon :: MeasuredIcon -> Pixel -> Pixel -> Consumer (Seq Measurement) IO r +updateIcon (MI icon pixbufVar) color1 color2 = forever $ do + measurements <- await + pixbuf <- lift $ atomically $ readTMVar pixbufVar + n <- lift $ Gtk.pixbufGetWidth pixbuf + lift $ drawPixbuf pixbuf (S.take n measurements) color1 color2 + lift $ Gtk.postGUIAsync $ Gtk.statusIconSetFromPixbuf icon pixbuf + +drawPixbuf :: (FoldableWithIndex Int t) => Gtk.Pixbuf -> t Measurement + -> Pixel -> Pixel -> IO () +drawPixbuf pb measurements color1 color2 = do + -- Clear the pixbuf first + Gtk.pixbufFill pb 0 0 0 0 + h <- Gtk.pixbufGetHeight pb + w <- Gtk.pixbufGetWidth pb + rs <- (`div` 4) <$> Gtk.pixbufGetRowstride pb + pixels <- Gtk.pixbufGetPixels pb :: IO (Gtk.PixbufData Int Pixel) + -- TODO(klao): do this much more efficiently + let + setP x y c = MA.writeArray pixels ((h-1-y)*rs + (w-1-x)) c + drawC x y0 y1 c = forM_ [y0..y1-1] $ \y -> setP x y c + toH m = max 0 $ min h $ round $ fromIntegral h * m + drawM x (m1,m2) = do + drawC x 0 y1 color1 + drawC x y1 y2 color2 + where + y1 = toH m1 + y2 = toH (m1+m2) + + imapMOf_ ifolded drawM measurements + + +main :: IO () +main = do + nonGtkArgs <- Gtk.unsafeInitGUIForThreadedRTS + [] <- withArgs nonGtkArgs $ $initHFlags "Show CPU and MEM graph with tray icons" + + when flags_show_cpu $ do + -- Colors are in ABGR (RGBA little-endian) + let blue1 = 0xffff4400 + blue2 = 0x88ff4400 + cpuIcon <- createIcon + _ <- forkIO $ runEffect $ measureCPU >-> delay >-> collectN 100 + >-> updateIcon cpuIcon blue1 blue2 + return () + + when flags_show_mem $ do + let green1 = 0xff44ff00 + green2 = 0x8844ff00 + memIcon <- createIcon + _ <- forkIO $ runEffect $ measureMEM >-> delay >-> collectN 100 + >-> updateIcon memIcon green1 green2 + return () + + -- Properly handle Ctrl-C: + _ <- installHandler sigINT (Catch $ Gtk.postGUIAsync Gtk.mainQuit) Nothing + Gtk.mainGUI