/* * wavemon - a wireless network monitoring aplication * * Copyright (c) 2001-2002 Jan Morgenstern * Copyright (c) 2009 Gerrit Renker * * wavemon is free software; you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free * Software Foundation; either version 2, or (at your option) any later * version. * * wavemon is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more * details. * * You should have received a copy of the GNU General Public License along * with wavemon; see the file COPYING. If not, write to the Free Software * Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "llist.h" #define CFNAME ".wavemonrc" /* * Minimum screen dimensions. * The number of lines depends on the size requirements of scr_info(). The * number of columns comes from the menubar length (10 items of length 6 * plus the 'Fxx'). This value was also chosen since 24x80 is a very common * screen size, in particular allowing the use on the console. */ enum info_screen_geometry { WH_IFACE = 2, /* 'Interface' area at the top */ WH_LEVEL = 9, /* Level meters (signal/noise/SNR) */ WH_STATS = 3, /* WiFi statistics area */ WH_INFO_MIN = 6, /* WiFi information area */ WH_NET_MIN = 3, /* Network interface information area */ WH_NET_MAX = 5, /* Network interface information area */ WH_MENU = 1 /* Menu bar at the bottom */ }; #define WH_INFO_SCR_BASE (WH_IFACE + WH_LEVEL + WH_STATS + WH_MENU) #define WH_INFO_SCR_MIN (WH_INFO_SCR_BASE + WH_INFO_MIN + WH_NET_MIN) #define MIN_SCREEN_LINES WH_INFO_SCR_MIN #define MIN_SCREEN_COLS 80 /* * Screen layout constants. * * All windows extend over the whole screen width; the vertical number of * rows is reduced by one due to the menubar at the bottom of the screen. */ #define WAV_WIDTH (COLS) #define WAV_HEIGHT (LINES-1) /* * Maximum lengths/coordinates inside the bordered screen. * * The printable window area is constrained by the frame lines connecting * the corner points (0, 0), (0, COLS-1), (LINES-1, 0), (LINES-1, COLS-1). */ #define MAXXLEN (WAV_WIDTH - 2) #define MAXYLEN (WAV_HEIGHT - 2) /* Number of seconds to display a warning message outside ncurses mode */ #define WARN_DISPLAY_DELAY 3 /* * Symbolic names of actions to take when crossing thresholds. * These actions invoke the corresponding ncurses functions. */ enum threshold_action { TA_DISABLED, TA_BEEP, TA_FLASH, TA_BEEP_FLASH }; static inline void threshold_action(enum threshold_action action) { if (action & TA_FLASH) flash(); if (action & TA_BEEP) beep(); } /* * Global in-memory representation of current wavemon configuration state */ extern struct wavemon_conf { int if_idx; /* Index into interface list */ int stat_iv, info_iv; int sig_min, sig_max, noise_min, noise_max; int lthreshold, hthreshold; int slotsize, meter_decay; /* Boolean values */ int check_geometry, /* ensure window is large enough */ cisco_mac, /* Cisco-style MAC addresses */ random, /* random signals */ override_bounds; /* override autodetection */ /* Enumerated values */ int lthreshold_action, /* disabled|beep|flash|beep+flash */ hthreshold_action, /* disabled|beep|flash|beep+flash */ startup_scr; /* info|histogram|aplist */ } conf; /* * Initialisation & Configuration */ extern void getconf(int argc, char *argv[]); /* Configuration items to manipulate the current configuration */ struct conf_item { char *name, /* name for preferences screen */ *cfname; /* name for ~/.wavemonrc */ enum { /* type of parameter */ t_int, /* @v.i is interpreted as raw value */ t_list, /* @v.i is an index into @list */ t_sep, /* dummy, separator entry */ t_func /* void (*fp) (void) */ } type; union { /* type-dependent container for value */ int *i; /* t_int and t_list index into @list */ void (*fp)(); /* t_func */ } v; char **list; /* t_list: NULL-terminated array of strings */ int *dep; /* dependency */ double min, /* value boundaries */ max, inc; /* increment for value changes */ char *unit; /* name of units to display */ }; /* * Screen functions */ enum wavemon_screen { SCR_INFO, /* F1 */ SCR_LHIST, /* F2 */ SCR_APLIST, /* F3 */ SCR_EMPTY_F4, /* placeholder */ SCR_EMPTY_F5, /* placeholder */ SCR_EMPTY_F6, /* placeholder */ SCR_CONF, /* F7 */ SCR_HELP, /* F8 */ SCR_ABOUT, /* F9 */ SCR_QUIT /* F10 */ }; extern void scr_info_init(void); extern int scr_info_loop(WINDOW *w_menu); extern void scr_info_fini(void); extern void scr_lhist_init(void); extern int scr_lhist_loop(WINDOW *w_menu); extern void scr_lhist_fini(void); extern void scr_aplst_init(void); extern int scr_aplst_loop(WINDOW *w_menu); extern void scr_aplst_fini(void); extern void scr_conf_init(void); extern int scr_conf_loop(WINDOW *w_menu); extern void scr_conf_fini(void); extern void scr_help_init(void); extern int scr_help_loop(WINDOW *w_menu); extern void scr_help_fini(void); extern void scr_about_init(void); extern int scr_about_loop(WINDOW *w_menu); extern void scr_about_fini(void); /* * Ncurses definitions and functions */ extern WINDOW *newwin_title(int y, int h, const char *title, bool nobottom); extern WINDOW *wmenubar(const enum wavemon_screen active); extern void wclrtoborder(WINDOW *win); extern void mvwclrtoborder(WINDOW *win, int y, int x); extern void waddstr_b(WINDOW * win, const char *s); extern void waddstr_center(WINDOW * win, int y, const char *s); extern const char *curtail(const char *str, const char *sep, int len); extern void waddbar(WINDOW *win, int y, float v, float min, float max, char *cscale, bool rev); extern void waddthreshold(WINDOW *win, int y, float v, float tv, float minv, float maxv, char *cscale, chtype tch); enum colour_pair { CP_STANDARD = 1, CP_SCALEHI, CP_SCALEMID, CP_SCALELOW, CP_WTITLE, CP_INACTIVE, CP_ACTIVE, CP_STATSIG, CP_STATNOISE, CP_STATSNR, CP_STATBKG, CP_STATSIG_S, CP_STATNOISE_S, CP_PREF_NORMAL, CP_PREF_SELECT, CP_PREF_ARROW, CP_SCAN_CRYPT, CP_SCAN_UNENC, CP_SCAN_NON_AP }; static inline int cp_from_scale(float value, const char *cscale, bool reverse) { enum colour_pair cp; if (value < (float)cscale[0]) cp = reverse ? CP_SCALEHI : CP_SCALELOW; else if (value < (float)cscale[1]) cp = CP_SCALEMID; else cp = reverse ? CP_SCALELOW : CP_SCALEHI; return COLOR_PAIR(cp); } /* * Wireless interfaces */ extern const char *conf_ifname(void); extern void conf_get_interface_list(void); extern char **iw_get_interface_list(void); extern void dump_parameters(void); /* * Timers */ struct timer { unsigned long long stime; unsigned long duration; }; extern void start_timer(struct timer *t, unsigned long d); extern int end_timer(struct timer *t); /* * Error handling */ extern bool has_net_admin_capability(void); extern void err_msg(const char *format, ...); extern void err_quit(const char *format, ...); extern void err_sys(const char *format, ...); /* * Helper functions */ #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0])) static inline void (*xsignal(int signo, void (*handler)(int)))(int) { struct sigaction old_sa, sa = { .sa_handler = handler, .sa_flags = 0 }; if (sigemptyset(&sa.sa_mask) < 0 || sigaction(signo, &sa, &old_sa) < 0) err_sys("xsignal(%d) failed", signo); return old_sa.sa_handler; } static inline size_t argv_count(char **argv) { int cnt = 0; assert(argv != NULL); while (*argv++) cnt++; return cnt; } static inline int argv_find(char **argv, const char *what) { int cnt = argv_count(argv), len, i; assert(what != NULL); for (i = 0, len = strlen(what); i < cnt; i++) if (strncasecmp(argv[i], what, len) == 0) return i; return -1; } static inline void str_tolower(char *s) { for (; s && *s; s++) *s = tolower(*s); } /* Check if @str is printable (compare iw_essid_escape()) */ static inline bool str_is_ascii(char *s) { if (!s || !*s) return false; for (; *s; s++) if (!isascii(*s) || iscntrl(*s)) return false; return true; } /* number of digits needed to display integer part of @val */ static inline int num_int_digits(const double val) { return 1 + (val > 1.0 ? log10(val) : val < -1.0 ? log10(-val) : 0); } static inline int max(const int a, const int b) { return a > b ? a : b; } static inline bool in_range(int val, int min, int max) { return min <= val && val <= max; } static inline int clamp(int val, int min, int max) { return val < min ? min : (val > max ? max : val); } /* SI units -- see units(7) */ static inline char *byte_units(const double bytes) { static char result[0x100]; if (bytes >= 1 << 30) sprintf(result, "%0.2lf GiB", bytes / (1 << 30)); else if (bytes >= 1 << 20) sprintf(result, "%0.2lf MiB", bytes / (1 << 20)); else if (bytes >= 1 << 10) sprintf(result, "%0.2lf KiB", bytes / (1 << 10)); else sprintf(result, "%.0lf B", bytes); return result; } /** * Compute exponentially weighted moving average * @mavg: old value of the moving average * @sample: new sample to update @mavg * @weight: decay factor for new samples, 0 < weight <= 1 */ static inline double ewma(double mavg, double sample, double weight) { return mavg == 0 ? sample : weight * mavg + (1.0 - weight) * sample; } /* map 0.0 <= ratio <= 1.0 into min..max */ static inline double map_val(double ratio, double min, double max) { return min + ratio * (max - min); } /* map minv <= val <= maxv into the range min..max (no clamping) */ static inline double map_range(double val, double minv, double maxv, double min, double max) { return map_val((val - minv) / (maxv - minv), min, max); } /* map val into the reverse range max..min */ static inline int reverse_range(int val, int min, int max) { assert(min <= val && val <= max); return max - (val - min); } a id='n229' href='#n229'>229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
/*
 * wavemon - a wireless network monitoring aplication
 *
 * Copyright (c) 2001-2002 Jan Morgenstern <jan@jm-music.de>
 *
 * wavemon is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2, or (at your option) any later
 * version.
 *
 * wavemon is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along
 * with wavemon; see the file COPYING.  If not, write to the Free Software
 * Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */
#include "iw_if.h"

/* Number of lines in the key window at the bottom */
#define KEY_WIN_HEIGHT	3

/* Total number of lines in the histogram window */
#define HIST_WIN_HEIGHT	(WAV_HEIGHT - KEY_WIN_HEIGHT)

/*
 * Analogous to MAXYLEN, the following sets both the
 * - highest y/line index and the
 * - total count of lines inside the histogram window.
 */
#define HIST_MAXYLEN	(HIST_WIN_HEIGHT - 1)

/* Position (relative to right border) and maximum length of dBm level tags. */
#define LEVEL_TAG_POS	5

/* GLOBALS */
static WINDOW *w_lhist, *w_key;

/*
 *	Keeping track of global minima/maxima
 */
static struct iw_extrema {
	bool	initialised;
	float	min;
	float	max;
} e_signal, e_noise, e_snr;

static void init_extrema(struct iw_extrema *ie)
{
	memset(ie, 0, sizeof(*ie));
}

static void track_extrema(const float new_sample, struct iw_extrema *ie)
{
	if (! ie->initialised) {
		ie->initialised = true;
		ie->min = ie->max = new_sample;
	} else if (new_sample < ie->min) {
		ie->min = new_sample;
	} else if (new_sample > ie->max) {
		ie->max = new_sample;
	}
}

static char *fmt_extrema(const struct iw_extrema *ie, const char *unit)
{
	static char range[256];

	if (! ie->initialised)
		snprintf(range, sizeof(range), "unknown");
	else if (ie->min == ie->max)
		snprintf(range, sizeof(range), "%+.0f %s", ie->min, unit);
	else
		snprintf(range, sizeof(range), "%+.0f..%+.0f %s", ie->min,
								ie->max, unit);
	return range;
}

/*
 * Simple array-based circular FIFO buffer
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 * Insertion works from lower to higher indices.
 * Access works from higher down to lower indices.
 *
 * Cases & assumptions:
 * ~~~~~~~~~~~~~~~~~~~~
 * - principle: unsigned counter + hash function to handle array wrap-around;
 * - buffer is empty if count == 0;
 * - else count indicates the next place to insert(modulo %IW_STACKSIZE).
 */
#define IW_STACKSIZE		1024
static struct iw_levelstat	iw_stats_cache[IW_STACKSIZE];
static uint32_t			count;
#define COUNTMAX		(typeof(count))-1

static void iw_cache_insert(const struct iw_levelstat new)
{
	iw_stats_cache[count % IW_STACKSIZE] = new;
	/*
	 * Handle counter overflow by mapping into a smaller index which is
	 * identical (modulo %IW_STACKSIZE) to the old value. (The datatype
	 * of 'count' must be able to express at least 2 * IW_STACKSIZE.)
	 */
	if (++count == COUNTMAX)
		count = IW_STACKSIZE + (COUNTMAX % IW_STACKSIZE);
}

static struct iw_levelstat iw_cache_get(const uint32_t index)
{
	struct iw_levelstat zero = IW_LSTAT_INIT;

	if (index > IW_STACKSIZE || index > count)
		return zero;
	return iw_stats_cache[(count - index) % IW_STACKSIZE];
}

void iw_cache_update(struct iw_stat *iw)
{
	static struct iw_levelstat prev, avg = IW_LSTAT_INIT;
	static int slot;

	if (! (iw->stat.qual.updated & IW_QUAL_LEVEL_INVALID)) {
		avg.flags  &= ~IW_QUAL_LEVEL_INVALID;
		avg.signal += iw->dbm.signal / conf.slotsize;
		track_extrema(iw->dbm.signal, &e_signal);
	}

	if (! (iw->stat.qual.updated & IW_QUAL_NOISE_INVALID)) {
		avg.flags &= ~IW_QUAL_NOISE_INVALID;
		avg.noise += iw->dbm.noise / conf.slotsize;
		track_extrema(iw->dbm.noise, &e_noise);
		track_extrema(iw->dbm.signal - iw->dbm.noise, &e_snr);
	}

	if (++slot >= conf.slotsize) {
		iw_cache_insert(avg);

		if (conf.lthreshold_action &&
		    prev.signal < conf.lthreshold &&
		    avg.signal >= conf.lthreshold)
			threshold_action(conf.lthreshold);
		else if (conf.hthreshold_action &&
			 prev.signal > conf.hthreshold &&
			 avg.signal <= conf.hthreshold)
			threshold_action(conf.hthreshold);

		prev = avg;
		avg.signal = avg.noise = slot = 0;
		avg.flags  = IW_QUAL_LEVEL_INVALID | IW_QUAL_NOISE_INVALID;
	}
}

/*
 * Histogram-specific display functions
 */
static double hist_level(double val, int min, int max)
{
	return map_range(val, min, max, 1, HIST_MAXYLEN);
}

static double hist_level_inverse(int y_level, int min, int max)
{
	return map_range(y_level, 1, HIST_MAXYLEN, min, max);
}

/* Order needs to be reversed as y-coordinates grow downwards */
static int hist_y(int yval)
{
	return reverse_range(yval, 1, HIST_MAXYLEN);
}

/* Values come in from the right, so 'x' also needs to be reversed */
static int hist_x(int xval)
{
	return reverse_range(xval, 1, MAXXLEN);
}

/* plot single values, without clamping to min/max */
static void hist_plot(double yval, int xval, enum colour_pair plot_colour)
{
	double level, fraction;
	chtype ch;

	fraction = modf(yval, &level);

	if (in_range(level, 1, HIST_MAXYLEN)) {
		/*
		 * The 5 different scanline chars provide a pretty good accuracy.
		 * ncurses will fall back to standard ASCII chars anyway if they
		 * are not available.
		 */
		if (fraction < 0.2)
			ch = ACS_S9;
		else if (fraction < 0.4)
			ch = ACS_S7;
		else if (fraction < 0.6)
			ch = ACS_HLINE;
		else if (fraction < 0.8)
			ch = ACS_S3;
		else
			ch = ACS_S1;

		wattrset(w_lhist, COLOR_PAIR(plot_colour) | A_BOLD);
		mvwaddch(w_lhist, hist_y(level), hist_x(xval), ch);
	}
}

static void display_lhist(void)
{
	struct iw_levelstat iwl;
	double snr_level, noise_level, sig_level;
	enum colour_pair plot_colour;
	int x, y;

	for (x = 1; x <= MAXXLEN; x++) {

		iwl = iw_cache_get(x);

		/* Clear screen and set up horizontal grid lines */
		wattrset(w_lhist, COLOR_PAIR(CP_STATBKG));
		for (y = 1; y <= HIST_MAXYLEN; y++)
			mvwaddch(w_lhist, hist_y(y), hist_x(x), y % 5 ? ' ' : '-');

		/*
		 * SNR comes first, as it determines the background. If either
		 * noise or signal is invalid, set level below minimum value to
		 * indicate that no background is present.
		 */
		if (iwl.flags & (IW_QUAL_NOISE_INVALID | IW_QUAL_LEVEL_INVALID)) {
			snr_level = 0;
		} else {
			snr_level = hist_level(iwl.signal - iwl.noise,
					       conf.sig_min - conf.noise_max,
					       conf.sig_max - conf.noise_min);

			wattrset(w_lhist, COLOR_PAIR(CP_STATSNR));
			for (y = 1; y <= clamp(snr_level, 1, HIST_MAXYLEN); y++)
				mvwaddch(w_lhist, hist_y(y), hist_x(x), ' ');
		}

		if (! (iwl.flags & IW_QUAL_NOISE_INVALID)) {
			noise_level = hist_level(iwl.noise, conf.noise_min, conf.noise_max);
			plot_colour = noise_level > snr_level ? CP_STATNOISE : CP_STATNOISE_S;
			hist_plot(noise_level, x, plot_colour);

		} else if (x == LEVEL_TAG_POS && ! (iwl.flags & IW_QUAL_LEVEL_INVALID)) {
			char	tmp[LEVEL_TAG_POS + 1];
			int	len;
			/*
			 * Tag the horizontal grid lines with dBm levels.
			 * This is only supported for signal levels, when the screen is not
			 * shared by several graphs (each having a different scale).
			 */
			wattrset(w_lhist, COLOR_PAIR(CP_STATSIG));
			for (y = 1; y <= HIST_MAXYLEN; y++) {
				if (y != 1 && (y % 5) && y != HIST_MAXYLEN)
					continue;
				len = snprintf(tmp, sizeof(tmp), "%.0f",
					       hist_level_inverse(y, conf.sig_min,
								     conf.sig_max));
				mvwaddstr(w_lhist, hist_y(y), hist_x(len), tmp);
			}
		}

		if (! (iwl.flags & IW_QUAL_LEVEL_INVALID)) {
			sig_level   = hist_level(iwl.signal, conf.sig_min, conf.sig_max);
			plot_colour = sig_level > snr_level ? CP_STATSIG : CP_STATSIG_S;
			hist_plot(sig_level, x, plot_colour);
		}
	}

	wrefresh(w_lhist);
}

static void display_key(WINDOW *w_key)
{
	/* Clear the (one-line) screen) */
	wmove(w_key, 1, 1);
	wclrtoborder(w_key);

	wattrset(w_key, COLOR_PAIR(CP_STANDARD));
	waddch(w_key, '[');
	wattrset(w_key, COLOR_PAIR(CP_STATSIG));
	waddch(w_key, ACS_HLINE);
	wattrset(w_key, COLOR_PAIR(CP_STANDARD));

	wprintw(w_key, "] sig lvl (%s)  [", fmt_extrema(&e_signal, "dBm"));

	wattrset(w_key, COLOR_PAIR(CP_STATNOISE));
	waddch(w_key, ACS_HLINE);
	wattrset(w_key, COLOR_PAIR(CP_STANDARD));

	wprintw(w_key, "] ns lvl (%s)  [", fmt_extrema(&e_noise, "dBm"));

	wattrset(w_key, COLOR_PAIR(CP_STATSNR));
	waddch(w_key, ' ');

	wattrset(w_key, COLOR_PAIR(CP_STANDARD));
	wprintw(w_key, "] S-N ratio (%s)", fmt_extrema(&e_snr, "dB"));

	wrefresh(w_key);
}

static void redraw_lhist(int signum)
{
	static int vcount = 1;

	sampling_do_poll();
	if (!--vcount) {
		vcount = conf.slotsize;
		display_lhist();
		display_key(w_key);
	}
}

void scr_lhist_init(void)
{
	w_lhist = newwin_title(0, HIST_WIN_HEIGHT, "Level histogram", true);
	w_key   = newwin_title(HIST_MAXYLEN + 1, KEY_WIN_HEIGHT, "Key", false);

	init_extrema(&e_signal);
	init_extrema(&e_noise);
	init_extrema(&e_snr);
	sampling_init(redraw_lhist);

	display_key(w_key);
}

int scr_lhist_loop(WINDOW *w_menu)
{
	return wgetch(w_menu);
}

void scr_lhist_fini(void)
{
	sampling_stop();
	delwin(w_lhist);
	delwin(w_key);
}