xref: /onnv-gate/usr/src/cmd/latencytop/common/klog.c (revision 10673:b22eb20aa9ca)
1*10673SKrishnendu.Sadhukhan@Sun.COM /*
2*10673SKrishnendu.Sadhukhan@Sun.COM  * CDDL HEADER START
3*10673SKrishnendu.Sadhukhan@Sun.COM  *
4*10673SKrishnendu.Sadhukhan@Sun.COM  * The contents of this file are subject to the terms of the
5*10673SKrishnendu.Sadhukhan@Sun.COM  * Common Development and Distribution License (the "License").
6*10673SKrishnendu.Sadhukhan@Sun.COM  * You may not use this file except in compliance with the License.
7*10673SKrishnendu.Sadhukhan@Sun.COM  *
8*10673SKrishnendu.Sadhukhan@Sun.COM  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*10673SKrishnendu.Sadhukhan@Sun.COM  * or http://www.opensolaris.org/os/licensing.
10*10673SKrishnendu.Sadhukhan@Sun.COM  * See the License for the specific language governing permissions
11*10673SKrishnendu.Sadhukhan@Sun.COM  * and limitations under the License.
12*10673SKrishnendu.Sadhukhan@Sun.COM  *
13*10673SKrishnendu.Sadhukhan@Sun.COM  * When distributing Covered Code, include this CDDL HEADER in each
14*10673SKrishnendu.Sadhukhan@Sun.COM  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*10673SKrishnendu.Sadhukhan@Sun.COM  * If applicable, add the following below this CDDL HEADER, with the
16*10673SKrishnendu.Sadhukhan@Sun.COM  * fields enclosed by brackets "[]" replaced with your own identifying
17*10673SKrishnendu.Sadhukhan@Sun.COM  * information: Portions Copyright [yyyy] [name of copyright owner]
18*10673SKrishnendu.Sadhukhan@Sun.COM  *
19*10673SKrishnendu.Sadhukhan@Sun.COM  * CDDL HEADER END
20*10673SKrishnendu.Sadhukhan@Sun.COM  */
21*10673SKrishnendu.Sadhukhan@Sun.COM /*
22*10673SKrishnendu.Sadhukhan@Sun.COM  * Copyright (c) 2008-2009, Intel Corporation.
23*10673SKrishnendu.Sadhukhan@Sun.COM  * All Rights Reserved.
24*10673SKrishnendu.Sadhukhan@Sun.COM  */
25*10673SKrishnendu.Sadhukhan@Sun.COM 
26*10673SKrishnendu.Sadhukhan@Sun.COM #include <stdio.h>
27*10673SKrishnendu.Sadhukhan@Sun.COM #include <stdlib.h>
28*10673SKrishnendu.Sadhukhan@Sun.COM #include <memory.h>
29*10673SKrishnendu.Sadhukhan@Sun.COM #include <string.h>
30*10673SKrishnendu.Sadhukhan@Sun.COM #include <procfs.h>
31*10673SKrishnendu.Sadhukhan@Sun.COM #include <sys/types.h>
32*10673SKrishnendu.Sadhukhan@Sun.COM #include <sys/stat.h>
33*10673SKrishnendu.Sadhukhan@Sun.COM #include <fcntl.h>
34*10673SKrishnendu.Sadhukhan@Sun.COM #include <limits.h>
35*10673SKrishnendu.Sadhukhan@Sun.COM #include <unistd.h>
36*10673SKrishnendu.Sadhukhan@Sun.COM 
37*10673SKrishnendu.Sadhukhan@Sun.COM #include "latencytop.h"
38*10673SKrishnendu.Sadhukhan@Sun.COM 
39*10673SKrishnendu.Sadhukhan@Sun.COM static GHashTable *proc_table = NULL; /* pid -> char * */
40*10673SKrishnendu.Sadhukhan@Sun.COM static GHashTable *klog_table = NULL; /* char * -> uint64_t total */
41*10673SKrishnendu.Sadhukhan@Sun.COM static char klog_filename[PATH_MAX] = DEFAULT_KLOG_FILE;
42*10673SKrishnendu.Sadhukhan@Sun.COM static int klog_level = LT_KLOG_LEVEL_NONE;
43*10673SKrishnendu.Sadhukhan@Sun.COM 
44*10673SKrishnendu.Sadhukhan@Sun.COM static void
print_proc(void * key,const char * args,FILE * fp)45*10673SKrishnendu.Sadhukhan@Sun.COM print_proc(void *key, const char *args, FILE *fp)
46*10673SKrishnendu.Sadhukhan@Sun.COM {
47*10673SKrishnendu.Sadhukhan@Sun.COM 	(void) fprintf(fp, "%-8ld \"%s\"\n", (long)key, args);
48*10673SKrishnendu.Sadhukhan@Sun.COM }
49*10673SKrishnendu.Sadhukhan@Sun.COM 
50*10673SKrishnendu.Sadhukhan@Sun.COM static void
print_stat(const char * key,lt_stat_data_t * log,FILE * fp)51*10673SKrishnendu.Sadhukhan@Sun.COM print_stat(const char *key, lt_stat_data_t *log, FILE *fp)
52*10673SKrishnendu.Sadhukhan@Sun.COM {
53*10673SKrishnendu.Sadhukhan@Sun.COM 	(void) fprintf(fp, "%lld, %lld, %lld, %s\n",
54*10673SKrishnendu.Sadhukhan@Sun.COM 	    (long long)log->lt_s_total,
55*10673SKrishnendu.Sadhukhan@Sun.COM 	    (long long)log->lt_s_count,
56*10673SKrishnendu.Sadhukhan@Sun.COM 	    (long long)log->lt_s_max,
57*10673SKrishnendu.Sadhukhan@Sun.COM 	    key);
58*10673SKrishnendu.Sadhukhan@Sun.COM }
59*10673SKrishnendu.Sadhukhan@Sun.COM 
60*10673SKrishnendu.Sadhukhan@Sun.COM /*
61*10673SKrishnendu.Sadhukhan@Sun.COM  * Initialization for kernel logging.
62*10673SKrishnendu.Sadhukhan@Sun.COM  */
63*10673SKrishnendu.Sadhukhan@Sun.COM void
lt_klog_init(void)64*10673SKrishnendu.Sadhukhan@Sun.COM lt_klog_init(void)
65*10673SKrishnendu.Sadhukhan@Sun.COM {
66*10673SKrishnendu.Sadhukhan@Sun.COM 	if (klog_table != NULL || proc_table != NULL) {
67*10673SKrishnendu.Sadhukhan@Sun.COM 		return;
68*10673SKrishnendu.Sadhukhan@Sun.COM 	}
69*10673SKrishnendu.Sadhukhan@Sun.COM 
70*10673SKrishnendu.Sadhukhan@Sun.COM 	klog_table = g_hash_table_new_full(g_str_hash, g_str_equal,
71*10673SKrishnendu.Sadhukhan@Sun.COM 	    (GDestroyNotify)free, (GDestroyNotify)free);
72*10673SKrishnendu.Sadhukhan@Sun.COM 	lt_check_null(klog_table);
73*10673SKrishnendu.Sadhukhan@Sun.COM 
74*10673SKrishnendu.Sadhukhan@Sun.COM 	proc_table = g_hash_table_new_full(g_direct_hash, g_direct_equal,
75*10673SKrishnendu.Sadhukhan@Sun.COM 	    NULL, (GDestroyNotify)free);
76*10673SKrishnendu.Sadhukhan@Sun.COM 	lt_check_null(proc_table);
77*10673SKrishnendu.Sadhukhan@Sun.COM }
78*10673SKrishnendu.Sadhukhan@Sun.COM 
79*10673SKrishnendu.Sadhukhan@Sun.COM /*
80*10673SKrishnendu.Sadhukhan@Sun.COM  * Set log file path.
81*10673SKrishnendu.Sadhukhan@Sun.COM  */
82*10673SKrishnendu.Sadhukhan@Sun.COM int
lt_klog_set_log_file(const char * filename)83*10673SKrishnendu.Sadhukhan@Sun.COM lt_klog_set_log_file(const char *filename)
84*10673SKrishnendu.Sadhukhan@Sun.COM {
85*10673SKrishnendu.Sadhukhan@Sun.COM 	FILE *fp;
86*10673SKrishnendu.Sadhukhan@Sun.COM 	int file_exist;
87*10673SKrishnendu.Sadhukhan@Sun.COM 
88*10673SKrishnendu.Sadhukhan@Sun.COM 	g_assert(strlen(filename) < sizeof (klog_filename));
89*10673SKrishnendu.Sadhukhan@Sun.COM 
90*10673SKrishnendu.Sadhukhan@Sun.COM 	file_exist = lt_file_exist(filename);
91*10673SKrishnendu.Sadhukhan@Sun.COM 	/* Test if we can write to the file */
92*10673SKrishnendu.Sadhukhan@Sun.COM 	fp = fopen(filename, "a");
93*10673SKrishnendu.Sadhukhan@Sun.COM 
94*10673SKrishnendu.Sadhukhan@Sun.COM 	if (fp == NULL) {
95*10673SKrishnendu.Sadhukhan@Sun.COM 		return (-2);
96*10673SKrishnendu.Sadhukhan@Sun.COM 	}
97*10673SKrishnendu.Sadhukhan@Sun.COM 
98*10673SKrishnendu.Sadhukhan@Sun.COM 	(void) fclose(fp);
99*10673SKrishnendu.Sadhukhan@Sun.COM 	/* Don't leave empty file around */
100*10673SKrishnendu.Sadhukhan@Sun.COM 	if (!file_exist) {
101*10673SKrishnendu.Sadhukhan@Sun.COM 		(void) unlink(filename);
102*10673SKrishnendu.Sadhukhan@Sun.COM 	}
103*10673SKrishnendu.Sadhukhan@Sun.COM 
104*10673SKrishnendu.Sadhukhan@Sun.COM 	(void) strncpy(klog_filename, filename,
105*10673SKrishnendu.Sadhukhan@Sun.COM 	    sizeof (klog_filename));
106*10673SKrishnendu.Sadhukhan@Sun.COM 
107*10673SKrishnendu.Sadhukhan@Sun.COM 	return (0);
108*10673SKrishnendu.Sadhukhan@Sun.COM }
109*10673SKrishnendu.Sadhukhan@Sun.COM 
110*10673SKrishnendu.Sadhukhan@Sun.COM /*
111*10673SKrishnendu.Sadhukhan@Sun.COM  * Set log level.
112*10673SKrishnendu.Sadhukhan@Sun.COM  */
113*10673SKrishnendu.Sadhukhan@Sun.COM int
lt_klog_set_log_level(int level)114*10673SKrishnendu.Sadhukhan@Sun.COM lt_klog_set_log_level(int level)
115*10673SKrishnendu.Sadhukhan@Sun.COM {
116*10673SKrishnendu.Sadhukhan@Sun.COM 	if (level < 0 || level > (int)LT_KLOG_LEVEL_ALL) {
117*10673SKrishnendu.Sadhukhan@Sun.COM 		return (-1);
118*10673SKrishnendu.Sadhukhan@Sun.COM 	}
119*10673SKrishnendu.Sadhukhan@Sun.COM 
120*10673SKrishnendu.Sadhukhan@Sun.COM 	klog_level = level;
121*10673SKrishnendu.Sadhukhan@Sun.COM 
122*10673SKrishnendu.Sadhukhan@Sun.COM 	return (0);
123*10673SKrishnendu.Sadhukhan@Sun.COM }
124*10673SKrishnendu.Sadhukhan@Sun.COM 
125*10673SKrishnendu.Sadhukhan@Sun.COM /*
126*10673SKrishnendu.Sadhukhan@Sun.COM  * Write content to log file.
127*10673SKrishnendu.Sadhukhan@Sun.COM  */
128*10673SKrishnendu.Sadhukhan@Sun.COM void
lt_klog_write(void)129*10673SKrishnendu.Sadhukhan@Sun.COM lt_klog_write(void)
130*10673SKrishnendu.Sadhukhan@Sun.COM {
131*10673SKrishnendu.Sadhukhan@Sun.COM 	FILE *fp;
132*10673SKrishnendu.Sadhukhan@Sun.COM 	char buffer[32];
133*10673SKrishnendu.Sadhukhan@Sun.COM 
134*10673SKrishnendu.Sadhukhan@Sun.COM 	if (klog_level == LT_KLOG_LEVEL_NONE) {
135*10673SKrishnendu.Sadhukhan@Sun.COM 		return;
136*10673SKrishnendu.Sadhukhan@Sun.COM 	}
137*10673SKrishnendu.Sadhukhan@Sun.COM 
138*10673SKrishnendu.Sadhukhan@Sun.COM 	g_assert(klog_table != NULL && proc_table != NULL);
139*10673SKrishnendu.Sadhukhan@Sun.COM 	fp = fopen(klog_filename, "a");
140*10673SKrishnendu.Sadhukhan@Sun.COM 
141*10673SKrishnendu.Sadhukhan@Sun.COM 	if (fp == NULL) {
142*10673SKrishnendu.Sadhukhan@Sun.COM 		return;
143*10673SKrishnendu.Sadhukhan@Sun.COM 	}
144*10673SKrishnendu.Sadhukhan@Sun.COM 
145*10673SKrishnendu.Sadhukhan@Sun.COM 	lt_time_str(buffer, sizeof (buffer));
146*10673SKrishnendu.Sadhukhan@Sun.COM 
147*10673SKrishnendu.Sadhukhan@Sun.COM 	(void) fprintf(fp, "# Log generated at %s by %s\n", buffer, TITLE);
148*10673SKrishnendu.Sadhukhan@Sun.COM 	(void) fprintf(fp, "# List of processes\n");
149*10673SKrishnendu.Sadhukhan@Sun.COM 	(void) fprintf(fp, "PID, CMD\n");
150*10673SKrishnendu.Sadhukhan@Sun.COM 	g_hash_table_foreach(proc_table, (GHFunc)print_proc, fp);
151*10673SKrishnendu.Sadhukhan@Sun.COM 
152*10673SKrishnendu.Sadhukhan@Sun.COM 	(void) fprintf(fp, "# Statistics\n");
153*10673SKrishnendu.Sadhukhan@Sun.COM 	(void) fprintf(fp, "TOTAL, COUNT, MAX, PID, KSTACK\n");
154*10673SKrishnendu.Sadhukhan@Sun.COM 	g_hash_table_foreach(klog_table, (GHFunc)print_stat, fp);
155*10673SKrishnendu.Sadhukhan@Sun.COM 
156*10673SKrishnendu.Sadhukhan@Sun.COM 	(void) fclose(fp);
157*10673SKrishnendu.Sadhukhan@Sun.COM }
158*10673SKrishnendu.Sadhukhan@Sun.COM 
159*10673SKrishnendu.Sadhukhan@Sun.COM /*
160*10673SKrishnendu.Sadhukhan@Sun.COM  * Clean up. It flushes all log content in memory to log file.
161*10673SKrishnendu.Sadhukhan@Sun.COM  */
162*10673SKrishnendu.Sadhukhan@Sun.COM void
lt_klog_deinit(void)163*10673SKrishnendu.Sadhukhan@Sun.COM lt_klog_deinit(void)
164*10673SKrishnendu.Sadhukhan@Sun.COM {
165*10673SKrishnendu.Sadhukhan@Sun.COM 	if (klog_table != NULL) {
166*10673SKrishnendu.Sadhukhan@Sun.COM 		g_hash_table_destroy(klog_table);
167*10673SKrishnendu.Sadhukhan@Sun.COM 		klog_table = NULL;
168*10673SKrishnendu.Sadhukhan@Sun.COM 	}
169*10673SKrishnendu.Sadhukhan@Sun.COM 
170*10673SKrishnendu.Sadhukhan@Sun.COM 	if (proc_table != NULL) {
171*10673SKrishnendu.Sadhukhan@Sun.COM 		g_hash_table_destroy(proc_table);
172*10673SKrishnendu.Sadhukhan@Sun.COM 		proc_table = NULL;
173*10673SKrishnendu.Sadhukhan@Sun.COM 	}
174*10673SKrishnendu.Sadhukhan@Sun.COM }
175*10673SKrishnendu.Sadhukhan@Sun.COM 
176*10673SKrishnendu.Sadhukhan@Sun.COM /*
177*10673SKrishnendu.Sadhukhan@Sun.COM  * Write a kernel stack and its statistics to log file. Only "total" will
178*10673SKrishnendu.Sadhukhan@Sun.COM  * be logged, others are internally discarded.
179*10673SKrishnendu.Sadhukhan@Sun.COM  */
180*10673SKrishnendu.Sadhukhan@Sun.COM /* ARGSUSED */
181*10673SKrishnendu.Sadhukhan@Sun.COM void
lt_klog_log(int level,pid_t pid,char * stack,lt_stat_type_t type,uint64_t value)182*10673SKrishnendu.Sadhukhan@Sun.COM lt_klog_log(int level, pid_t pid, char *stack,
183*10673SKrishnendu.Sadhukhan@Sun.COM 	lt_stat_type_t type, uint64_t value)
184*10673SKrishnendu.Sadhukhan@Sun.COM {
185*10673SKrishnendu.Sadhukhan@Sun.COM 	lt_stat_data_t *entry = NULL;
186*10673SKrishnendu.Sadhukhan@Sun.COM 	char *psargs;
187*10673SKrishnendu.Sadhukhan@Sun.COM 	char *str;
188*10673SKrishnendu.Sadhukhan@Sun.COM 	int str_len;
189*10673SKrishnendu.Sadhukhan@Sun.COM 
190*10673SKrishnendu.Sadhukhan@Sun.COM 	if ((level & klog_level) == 0) {
191*10673SKrishnendu.Sadhukhan@Sun.COM 		return;
192*10673SKrishnendu.Sadhukhan@Sun.COM 	}
193*10673SKrishnendu.Sadhukhan@Sun.COM 
194*10673SKrishnendu.Sadhukhan@Sun.COM 	g_assert(klog_table != NULL && proc_table != NULL);
195*10673SKrishnendu.Sadhukhan@Sun.COM 	psargs = (char *)g_hash_table_lookup(proc_table,
196*10673SKrishnendu.Sadhukhan@Sun.COM 	    LT_INT_TO_POINTER(pid));
197*10673SKrishnendu.Sadhukhan@Sun.COM 
198*10673SKrishnendu.Sadhukhan@Sun.COM 	if (psargs == NULL) {
199*10673SKrishnendu.Sadhukhan@Sun.COM 		psargs = lt_get_proc_field(pid, LT_FIELD_PSARGS);
200*10673SKrishnendu.Sadhukhan@Sun.COM 
201*10673SKrishnendu.Sadhukhan@Sun.COM 		if (psargs == NULL) {
202*10673SKrishnendu.Sadhukhan@Sun.COM 			psargs = lt_get_proc_field(pid, LT_FIELD_FNAME);
203*10673SKrishnendu.Sadhukhan@Sun.COM 		}
204*10673SKrishnendu.Sadhukhan@Sun.COM 
205*10673SKrishnendu.Sadhukhan@Sun.COM 		if (psargs == NULL) {
206*10673SKrishnendu.Sadhukhan@Sun.COM 			return;
207*10673SKrishnendu.Sadhukhan@Sun.COM 		}
208*10673SKrishnendu.Sadhukhan@Sun.COM 
209*10673SKrishnendu.Sadhukhan@Sun.COM 		g_hash_table_insert(proc_table,
210*10673SKrishnendu.Sadhukhan@Sun.COM 		    LT_INT_TO_POINTER(pid), psargs);
211*10673SKrishnendu.Sadhukhan@Sun.COM 	}
212*10673SKrishnendu.Sadhukhan@Sun.COM 
213*10673SKrishnendu.Sadhukhan@Sun.COM 	str_len = strlen(stack) + 20;
214*10673SKrishnendu.Sadhukhan@Sun.COM 	str = lt_malloc(str_len);
215*10673SKrishnendu.Sadhukhan@Sun.COM 	(void) snprintf(str, str_len, "%ld, \"%s\"", pid, stack);
216*10673SKrishnendu.Sadhukhan@Sun.COM 	entry = (lt_stat_data_t *)g_hash_table_lookup(klog_table, str);
217*10673SKrishnendu.Sadhukhan@Sun.COM 
218*10673SKrishnendu.Sadhukhan@Sun.COM 	if (entry == NULL) {
219*10673SKrishnendu.Sadhukhan@Sun.COM 		entry = (lt_stat_data_t *)lt_zalloc(sizeof (lt_stat_data_t));
220*10673SKrishnendu.Sadhukhan@Sun.COM 		g_hash_table_insert(klog_table, str, entry);
221*10673SKrishnendu.Sadhukhan@Sun.COM 	} else {
222*10673SKrishnendu.Sadhukhan@Sun.COM 		free(str);
223*10673SKrishnendu.Sadhukhan@Sun.COM 	}
224*10673SKrishnendu.Sadhukhan@Sun.COM 
225*10673SKrishnendu.Sadhukhan@Sun.COM 	lt_update_stat_value(entry, type, value);
226*10673SKrishnendu.Sadhukhan@Sun.COM }
227