[PATCH net-next] ip: Add color output option

[PATCH net-next] ip: Add color output option

[Mathias Nyman]

It is hard to quickly find what you are looking for in the output of the ip
command. Color helps.

This patch adds a '-c' flag to highlight these with individual colors:
   - interface name
   - ip addresse
   - mac addresse
   - up/down state


---
  include/color.h | 17 ++++++++++++++++
  ip/Makefile     |  2 +-
  ip/color.c      | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  ip/ip.c         |  5 ++++-
  ip/ipaddress.c  | 43 +++++++++++++++++++++++++++++----------
  man/man8/ip.8   |  7 ++++++-
  6 files changed, 123 insertions(+), 14 deletions(-)
  create mode 100644 include/color.h
  create mode 100644 ip/color.c

diff --git a/include/color.h b/include/color.h
new file mode 100644
index 0000000..1662c62
--- /dev/null
+++ b/include/color.h
@@ -0,0 +1,17 @@
+#ifndef __COLOR_H__
+#define __COLOR_H__ 1
+
+enum color_attr
+{
+       COLOR_IFNAME,
+       COLOR_MAC,
+       COLOR_INET,
+       COLOR_INET6,
+       COLOR_OPERSTATE_UP,
+       COLOR_OPERSTATE_DOWN
+};
+
+void enable_color(void);
+int color_fprintf(FILE *fp, enum color_attr attr, const char *fmt, ...);
+
+#endif
diff --git a/ip/Makefile b/ip/Makefile
index 5637bcf..ac35131 100644
--- a/ip/Makefile
+++ b/ip/Makefile
@@ -6,7 +6,7 @@ IPOBJ=ip.o ipaddress.o ipaddrlabel.o iproute.o iprule.o ipnetns.o \
      iplink_macvlan.o iplink_macvtap.o ipl2tp.o link_vti.o link_vti6.o \
      iplink_vxlan.o tcp_metrics.o iplink_ipoib.o ipnetconf.o link_ip6tnl.o \
      link_iptnl.o link_gre6.o iplink_bond.o iplink_bond_slave.o iplink_hsr.o \
-    iplink_bridge.o iplink_bridge_slave.o ipfou.o iplink_ipvlan.o
+    iplink_bridge.o iplink_bridge_slave.o ipfou.o iplink_ipvlan.o color.o
  
  RTMONOBJ=rtmon.o
  
diff --git a/ip/color.c b/ip/color.c
new file mode 100644
index 0000000..2e73fcb
--- /dev/null
+++ b/ip/color.c
@@ -0,0 +1,63 @@
+#include <stdio.h>
+#include <stdarg.h>
+
+#include "color.h"
+
+enum color
+{
+       C_RED,
+       C_GREEN,
+       C_YELLOW,
+       C_BLUE,
+       C_MAGENTA,
+       C_CYAN,
+       C_WHITE,
+       C_CLEAR
+};
+
+static const char * const color_codes[] =
+{
+       "\e[31m",
+       "\e[32m",
+       "\e[33m",
+       "\e[34m",
+       "\e[35m",
+       "\e[36m",
+       "\e[37m",
+       "\e[0m",
+       NULL,
+};
+
+static enum color attr_colors[] =
+{
+       C_CYAN,
+       C_YELLOW,
+       C_MAGENTA,
+       C_BLUE,
+       C_GREEN,
+       C_RED
+};
+
+static int color_enable = 0;
+
+void enable_color(void)
+{
+       ++color_enable;
+}
+
+int color_fprintf(FILE *fp, enum color_attr attr, const char *fmt, ...)
+{
+       int ret = 0;
+       va_list args;
+       va_start(args, fmt);
+
+       if (!color_enable)
+               return vfprintf(fp, fmt, args);
+
+       ret += fprintf(fp, "%s", color_codes[attr_colors[attr]]);
+       ret += vfprintf(fp, fmt, args);
+       ret += fprintf(fp, "%s", color_codes[C_CLEAR]);
+
+       va_end(args);
+       return ret;
+}
diff --git a/ip/ip.c b/ip/ip.c
index f7f214b..c23de74 100644
--- a/ip/ip.c
+++ b/ip/ip.c
@@ -23,6 +23,7 @@
  #include "utils.h"
  #include "ip_common.h"
  #include "namespace.h"
+#include "color.h"
  
  int preferred_family = AF_UNSPEC;
  int human_readable = 0;
@@ -56,7 +57,7 @@ static void usage(void)
  "                    -4 | -6 | -I | -D | -B | -0 |\n"
  "                    -l[oops] { maximum-addr-flush-attempts } |\n"
  "                    -o[neline] | -t[imestamp] | -ts[hort] | -b[atch] [filename] |\n"
-"                    -rc[vbuf] [size] | -n[etns] name | -a[ll] }\n");
+"                    -rc[vbuf] [size] | -n[etns] name | -a[ll] | -c[olor]}\n");
         exit(-1);
  }
  
@@ -257,6 +258,8 @@ int main(int argc, char **argv)
                                 exit(-1);
                         }
                         rcvbuf = size;
+               } else if (matches(opt, "-color") == 0) {
+                       enable_color();
                 } else if (matches(opt, "-help") == 0) {
                         usage();
                 } else if (matches(opt, "-netns") == 0) {
diff --git a/ip/ipaddress.c b/ip/ipaddress.c
index e582da0..92afa49 100644
--- a/ip/ipaddress.c
+++ b/ip/ipaddress.c
@@ -34,6 +34,7 @@
  #include "utils.h"
  #include "ll_map.h"
  #include "ip_common.h"
+#include "color.h"
  
  enum {
         IPADD_LIST,
@@ -136,8 +137,15 @@ static void print_operstate(FILE *f, __u8 state)
  {
         if (state >= sizeof(oper_states)/sizeof(oper_states[0]))
                 fprintf(f, "state %#x ", state);
-       else
-               fprintf(f, "state %s ", oper_states[state]);
+       else {
+               fprintf(f, "state ");
+               if (strcmp(oper_states[state], "UP") == 0)
+                       color_fprintf(f, COLOR_OPERSTATE_UP, "%s ", oper_states[state]);
+               else if (strcmp(oper_states[state], "DOWN") == 0)
+                       color_fprintf(f, COLOR_OPERSTATE_DOWN, "%s ", oper_states[state]);
+               else
+                       fprintf(f, "%s ", oper_states[state]);
+       }
  }
  
  int get_operstate(const char *name)
@@ -606,7 +614,8 @@ int print_linkinfo(const struct sockaddr_nl *who,
         if (n->nlmsg_type == RTM_DELLINK)
                 fprintf(fp, "Deleted ");
  
-       fprintf(fp, "%d: %s", ifi->ifi_index,
+       fprintf(fp, "%d: ", ifi->ifi_index);
+       color_fprintf(fp, COLOR_IFNAME, "%s",
                 tb[IFLA_IFNAME] ? rta_getattr_str(tb[IFLA_IFNAME]) : "<nil>");
  
         if (tb[IFLA_LINK]) {
@@ -666,10 +675,11 @@ int print_linkinfo(const struct sockaddr_nl *who,
                 fprintf(fp, "    link/%s ", ll_type_n2a(ifi->ifi_type, b1, sizeof(b1)));
  
                 if (tb[IFLA_ADDRESS]) {
-                       fprintf(fp, "%s", ll_addr_n2a(RTA_DATA(tb[IFLA_ADDRESS]),
-                                                     RTA_PAYLOAD(tb[IFLA_ADDRESS]),
-                                                     ifi->ifi_type,
-                                                     b1, sizeof(b1)));
+                       color_fprintf(fp, COLOR_MAC, "%s",
+                                       ll_addr_n2a(RTA_DATA(tb[IFLA_ADDRESS]),
+                                               RTA_PAYLOAD(tb[IFLA_ADDRESS]),
+                                               ifi->ifi_type,
+                                               b1, sizeof(b1)));
                 }
                 if (tb[IFLA_BROADCAST]) {
                         if (ifi->ifi_flags&IFF_POINTOPOINT)
@@ -849,10 +859,21 @@ int print_addrinfo(const struct sockaddr_nl *who, struct nlmsghdr *n,
                 fprintf(fp, "    family %d ", ifa->ifa_family);
  
         if (rta_tb[IFA_LOCAL]) {
-               fprintf(fp, "%s", format_host(ifa->ifa_family,
-                                             RTA_PAYLOAD(rta_tb[IFA_LOCAL]),
-                                             RTA_DATA(rta_tb[IFA_LOCAL]),
-                                             abuf, sizeof(abuf)));
+               if (ifa->ifa_family == AF_INET)
+                       color_fprintf(fp, COLOR_INET, "%s", format_host(ifa->ifa_family,
+                                               RTA_PAYLOAD(rta_tb[IFA_LOCAL]),
+                                               RTA_DATA(rta_tb[IFA_LOCAL]),
+                                               abuf, sizeof(abuf)));
+               else if (ifa->ifa_family == AF_INET6)
+                       color_fprintf(fp, COLOR_INET6, "%s", format_host(ifa->ifa_family,
+                                               RTA_PAYLOAD(rta_tb[IFA_LOCAL]),
+                                               RTA_DATA(rta_tb[IFA_LOCAL]),
+                                               abuf, sizeof(abuf)));
+               else
+                       fprintf(fp, "%s", format_host(ifa->ifa_family,
+                                               RTA_PAYLOAD(rta_tb[IFA_LOCAL]),
+                                               RTA_DATA(rta_tb[IFA_LOCAL]),
+                                               abuf, sizeof(abuf)));
  
                 if (rta_tb[IFA_ADDRESS] == NULL ||
                     memcmp(RTA_DATA(rta_tb[IFA_ADDRESS]), RTA_DATA(rta_tb[IFA_LOCAL]),
diff --git a/man/man8/ip.8 b/man/man8/ip.8
index 44d1ee6..43ddac9 100644
--- a/man/man8/ip.8
+++ b/man/man8/ip.8
@@ -33,7 +33,8 @@ ip \- show / manipulate routing, devices, policy routing and tunnels
  .BR inet " | " inet6 " | " ipx " | " dnet " | " link " } | "
  \fB\-o\fR[\fIneline\fR] |
  \fB\-n\fR[\fIetns\fR] name |
-\fB\-a\fR[\fIll\fR] }
+\fB\-a\fR[\fIll\fR] |
+\fB\-c\fR[\fIolor\fR] }
  
  
  .SH OPTIONS
@@ -165,6 +166,10 @@ to
  .BR "\-a" , " \-all"
  executes specified command over all objects, it depends if command supports this option.
  
+.TP
+.BR "\-c" , " -color"
+Use color output.
+
  .SH IP - COMMAND SYNTAX
  
  .SS
-- 
2.3.5

Re: [PATCH net-next] ip: Add color output option

[Alexei Starovoitov]

On Fri, Apr 17, 2015 at 04:02:02PM +0300, Mathias Nyman wrote:
> It is hard to quickly find what you are looking for in the output of the ip
> command. Color helps.
> 
> This patch adds a '-c' flag to highlight these with individual colors:
>   - interface name
>   - ip addresse
>   - mac addresse
>   - up/down state

idea looks good, but the patch doesn't apply at all, since it's
whitespace damaged. Also there is no SOB.

Re: [PATCH net-next] ip: Add color output option

[Daniel Borkmann]

On 04/17/2015 06:44 PM, Alexei Starovoitov wrote:
> On Fri, Apr 17, 2015 at 04:02:02PM +0300, Mathias Nyman wrote:
>> It is hard to quickly find what you are looking for in the output of the ip
>> command. Color helps.
>>
>> This patch adds a '-c' flag to highlight these with individual colors:
>>    - interface name
>>    - ip addresse
>>    - mac addresse
>>    - up/down state
>
> idea looks good, but the patch doesn't apply at all, since it's
> whitespace damaged. Also there is no SOB.

You also might want to move the library bits into lib/ so that
not only ip but also other tools could use it in future. So -c
is neither taken in ip nor in tc or ss, that's good. ;)

Re: [PATCH net-next] ip: Add color output option

[Mathias Nyman]

On 2015-04-17 19:26+0200, Daniel Borkmann wrote:
>On 04/17/2015 06:44 PM, Alexei Starovoitov wrote:
>>On Fri, Apr 17, 2015 at 04:02:02PM +0300, Mathias Nyman wrote:
>>>It is hard to quickly find what you are looking for in the output of the ip
>>>command. Color helps.
>>>
>>>This patch adds a '-c' flag to highlight these with individual colors:
>>>   - interface name
>>>   - ip addresse
>>>   - mac addresse
>>>   - up/down state
>>
>>idea looks good, but the patch doesn't apply at all, since it's
>>whitespace damaged. Also there is no SOB.

First timer; the v2 should fix these.


>You also might want to move the library bits into lib/ so that
>not only ip but also other tools could use it in future. So -c
>is neither taken in ip nor in tc or ss, that's good. ;)
>

I don't understand what you mean by "-c is neither taken in ip nor in
tc or ss". I am not finding a common place where to handle the -color
flag for ip, tc and ss, if that's what you mean. The common color.c is
under lib/ in v2 though.


Thanks for super fast feedback guys!

Re: [PATCH net-next] ip: Add color output option

[Daniel Borkmann]

On 04/18/2015 12:22 PM, Mathias Nyman wrote:
...
> I don't understand what you mean by "-c is neither taken in ip nor in
> tc or ss".

That just means we could in future consider to consistently add support
for -c flag in those tools, too.