2 Unix SMB/CIFS implementation.
3 store smbd profiling information in shared memory
4 Copyright (C) Andrew Tridgell 1999
5 Copyright (C) James Peach 2006
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #define IPC_PERMS ((S_IRUSR | S_IWUSR) | S_IRGRP | S_IROTH)
27 #endif /* WITH_PROFILE */
31 static BOOL read_only;
32 #if defined(HAVE_CLOCK_GETTIME)
33 clockid_t __profile_clock;
34 BOOL have_profiling_clock = False;
38 struct profile_header *profile_h;
39 struct profile_stats *profile_p;
41 BOOL do_profile_flag = False;
42 BOOL do_profile_times = False;
44 /****************************************************************************
45 receive a set profile level message
46 ****************************************************************************/
47 void profile_message(int msg_type, struct process_id src,
48 void *buf, size_t len, void *private_data)
52 memcpy(&level, buf, sizeof(int));
55 case 0: /* turn off profiling */
56 do_profile_flag = False;
57 do_profile_times = False;
58 DEBUG(1,("INFO: Profiling turned OFF from pid %d\n",
59 (int)procid_to_pid(&src)));
61 case 1: /* turn on counter profiling only */
62 do_profile_flag = True;
63 do_profile_times = False;
64 DEBUG(1,("INFO: Profiling counts turned ON from pid %d\n",
65 (int)procid_to_pid(&src)));
67 case 2: /* turn on complete profiling */
69 #if defined(HAVE_CLOCK_GETTIME)
70 if (!have_profiling_clock) {
71 do_profile_flag = True;
72 do_profile_times = False;
73 DEBUG(1,("INFO: Profiling counts turned ON from "
74 "pid %d\n", (int)procid_to_pid(&src)));
75 DEBUGADD(1,("INFO: Profiling times disabled "
76 "due to lack of a suitable clock\n"));
81 do_profile_flag = True;
82 do_profile_times = True;
83 DEBUG(1,("INFO: Full profiling turned ON from pid %d\n",
84 (int)procid_to_pid(&src)));
86 case 3: /* reset profile values */
87 memset((char *)profile_p, 0, sizeof(*profile_p));
88 DEBUG(1,("INFO: Profiling values cleared from pid %d\n",
89 (int)procid_to_pid(&src)));
92 #else /* WITH_PROFILE */
93 DEBUG(1,("INFO: Profiling support unavailable in this build.\n"));
94 #endif /* WITH_PROFILE */
97 /****************************************************************************
98 receive a request profile level message
99 ****************************************************************************/
100 void reqprofile_message(int msg_type, struct process_id src,
101 void *buf, size_t len, void *private_data)
106 level = 1 + (do_profile_flag?2:0) + (do_profile_times?4:0);
110 DEBUG(1,("INFO: Received REQ_PROFILELEVEL message from PID %u\n",
111 (unsigned int)procid_to_pid(&src)));
112 message_send_pid(src, MSG_PROFILELEVEL, &level, sizeof(int), True);
115 /*******************************************************************
116 open the profiling shared memory area
117 ******************************************************************/
120 #ifdef HAVE_CLOCK_GETTIME
122 /* Find a clock. Just because the definition for a particular clock ID is
123 * present doesn't mean the system actually supports it.
125 static void init_clock_gettime(void)
129 have_profiling_clock = False;
131 #ifdef HAVE_CLOCK_PROCESS_CPUTIME_ID
132 /* CLOCK_PROCESS_CPUTIME_ID is sufficiently fast that the
133 * always profiling times is plausible. Unfortunately on Linux
134 * it is only accurate if we can guarantee we will not be scheduled
135 * scheduled onto a different CPU between samples. Until there is
136 * some way to set processor affinity, we can only use this on
139 if (!this_is_smp()) {
140 if (clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &ts) == 0) {
141 DEBUG(10, ("Using CLOCK_PROCESS_CPUTIME_ID "
142 "for profile_clock\n"));
143 __profile_clock = CLOCK_PROCESS_CPUTIME_ID;
144 have_profiling_clock = True;
149 #ifdef HAVE_CLOCK_MONOTONIC
150 if (!have_profiling_clock &&
151 clock_gettime(CLOCK_MONOTONIC, &ts) == 0) {
152 DEBUG(10, ("Using CLOCK_MONOTONIC for profile_clock\n"));
153 __profile_clock = CLOCK_MONOTONIC;
154 have_profiling_clock = True;
158 #ifdef HAVE_CLOCK_REALTIME
159 /* POSIX says that CLOCK_REALTIME should be defined everywhere
160 * where we have clock_gettime...
162 if (!have_profiling_clock &&
163 clock_gettime(CLOCK_REALTIME, &ts) == 0) {
164 __profile_clock = CLOCK_REALTIME;
165 have_profiling_clock = True;
167 SMB_WARN(__profile_clock != CLOCK_REALTIME,
168 ("forced to use a slow profiling clock"));
173 SMB_WARN(have_profiling_clock == True,
174 ("could not find a working clock for profiling"));
179 BOOL profile_setup(BOOL rdonly)
181 struct shmid_ds shm_ds;
185 #ifdef HAVE_CLOCK_GETTIME
186 init_clock_gettime();
190 /* try to use an existing key */
191 shm_id = shmget(PROF_SHMEM_KEY, 0, 0);
193 /* if that failed then create one. There is a race condition here
194 if we are running from inetd. Bad luck. */
196 if (read_only) return False;
197 shm_id = shmget(PROF_SHMEM_KEY, sizeof(*profile_h),
198 IPC_CREAT | IPC_EXCL | IPC_PERMS);
202 DEBUG(0,("Can't create or use IPC area. Error was %s\n",
208 profile_h = (struct profile_header *)shmat(shm_id, 0,
209 read_only?SHM_RDONLY:0);
210 if ((long)profile_p == -1) {
211 DEBUG(0,("Can't attach to IPC area. Error was %s\n",
216 /* find out who created this memory area */
217 if (shmctl(shm_id, IPC_STAT, &shm_ds) != 0) {
218 DEBUG(0,("ERROR shmctl : can't IPC_STAT. Error was %s\n",
223 if (shm_ds.shm_perm.cuid != sec_initial_uid() ||
224 shm_ds.shm_perm.cgid != sec_initial_gid()) {
225 DEBUG(0,("ERROR: we did not create the shmem "
226 "(owned by another user, uid %u, gid %u)\n",
227 shm_ds.shm_perm.cuid,
228 shm_ds.shm_perm.cgid));
232 if (shm_ds.shm_segsz != sizeof(*profile_h)) {
233 DEBUG(0,("WARNING: profile size is %d (expected %lu). Deleting\n",
234 (int)shm_ds.shm_segsz, sizeof(*profile_h)));
235 if (shmctl(shm_id, IPC_RMID, &shm_ds) == 0) {
242 if (!read_only && (shm_ds.shm_nattch == 1)) {
243 memset((char *)profile_h, 0, sizeof(*profile_h));
244 profile_h->prof_shm_magic = PROF_SHM_MAGIC;
245 profile_h->prof_shm_version = PROF_SHM_VERSION;
246 DEBUG(3,("Initialised profile area\n"));
249 profile_p = &profile_h->stats;
250 message_register(MSG_PROFILE, profile_message, NULL);
251 message_register(MSG_REQ_PROFILELEVEL, reqprofile_message, NULL);
255 const char * profile_value_name(enum profile_stats_values val)
257 static const char * valnames[PR_VALUE_MAX + 1] =
259 "smbd_idle", /* PR_VALUE_SMBD_IDLE */
260 "syscall_opendir", /* PR_VALUE_SYSCALL_OPENDIR */
261 "syscall_readdir", /* PR_VALUE_SYSCALL_READDIR */
262 "syscall_seekdir", /* PR_VALUE_SYSCALL_SEEKDIR */
263 "syscall_telldir", /* PR_VALUE_SYSCALL_TELLDIR */
264 "syscall_rewinddir", /* PR_VALUE_SYSCALL_REWINDDIR */
265 "syscall_mkdir", /* PR_VALUE_SYSCALL_MKDIR */
266 "syscall_rmdir", /* PR_VALUE_SYSCALL_RMDIR */
267 "syscall_closedir", /* PR_VALUE_SYSCALL_CLOSEDIR */
268 "syscall_open", /* PR_VALUE_SYSCALL_OPEN */
269 "syscall_close", /* PR_VALUE_SYSCALL_CLOSE */
270 "syscall_read", /* PR_VALUE_SYSCALL_READ */
271 "syscall_pread", /* PR_VALUE_SYSCALL_PREAD */
272 "syscall_write", /* PR_VALUE_SYSCALL_WRITE */
273 "syscall_pwrite", /* PR_VALUE_SYSCALL_PWRITE */
274 "syscall_lseek", /* PR_VALUE_SYSCALL_LSEEK */
275 "syscall_sendfile", /* PR_VALUE_SYSCALL_SENDFILE */
276 "syscall_rename", /* PR_VALUE_SYSCALL_RENAME */
277 "syscall_fsync", /* PR_VALUE_SYSCALL_FSYNC */
278 "syscall_stat", /* PR_VALUE_SYSCALL_STAT */
279 "syscall_fstat", /* PR_VALUE_SYSCALL_FSTAT */
280 "syscall_lstat", /* PR_VALUE_SYSCALL_LSTAT */
281 "syscall_unlink", /* PR_VALUE_SYSCALL_UNLINK */
282 "syscall_chmod", /* PR_VALUE_SYSCALL_CHMOD */
283 "syscall_fchmod", /* PR_VALUE_SYSCALL_FCHMOD */
284 "syscall_chown", /* PR_VALUE_SYSCALL_CHOWN */
285 "syscall_fchown", /* PR_VALUE_SYSCALL_FCHOWN */
286 "syscall_chdir", /* PR_VALUE_SYSCALL_CHDIR */
287 "syscall_getwd", /* PR_VALUE_SYSCALL_GETWD */
288 "syscall_utime", /* PR_VALUE_SYSCALL_UTIME */
289 "syscall_ftruncate", /* PR_VALUE_SYSCALL_FTRUNCATE */
290 "syscall_fcntl_lock", /* PR_VALUE_SYSCALL_FCNTL_LOCK */
291 "syscall_kernel_flock", /* PR_VALUE_SYSCALL_KERNEL_FLOCK */
292 "syscall_linux_setlease", /* PR_VALUE_SYSCALL_LINUX_SETLEASE */
293 "syscall_fcntl_getlock", /* PR_VALUE_SYSCALL_FCNTL_GETLOCK */
294 "syscall_readlink", /* PR_VALUE_SYSCALL_READLINK */
295 "syscall_symlink", /* PR_VALUE_SYSCALL_SYMLINK */
296 "syscall_link", /* PR_VALUE_SYSCALL_LINK */
297 "syscall_mknod", /* PR_VALUE_SYSCALL_MKNOD */
298 "syscall_realpath", /* PR_VALUE_SYSCALL_REALPATH */
299 "syscall_get_quota", /* PR_VALUE_SYSCALL_GET_QUOTA */
300 "syscall_set_quota", /* PR_VALUE_SYSCALL_SET_QUOTA */
301 "SMBmkdir", /* PR_VALUE_SMBMKDIR */
302 "SMBrmdir", /* PR_VALUE_SMBRMDIR */
303 "SMBopen", /* PR_VALUE_SMBOPEN */
304 "SMBcreate", /* PR_VALUE_SMBCREATE */
305 "SMBclose", /* PR_VALUE_SMBCLOSE */
306 "SMBflush", /* PR_VALUE_SMBFLUSH */
307 "SMBunlink", /* PR_VALUE_SMBUNLINK */
308 "SMBmv", /* PR_VALUE_SMBMV */
309 "SMBgetatr", /* PR_VALUE_SMBGETATR */
310 "SMBsetatr", /* PR_VALUE_SMBSETATR */
311 "SMBread", /* PR_VALUE_SMBREAD */
312 "SMBwrite", /* PR_VALUE_SMBWRITE */
313 "SMBlock", /* PR_VALUE_SMBLOCK */
314 "SMBunlock", /* PR_VALUE_SMBUNLOCK */
315 "SMBctemp", /* PR_VALUE_SMBCTEMP */
316 "SMBmknew", /* PR_VALUE_SMBMKNEW */
317 "SMBcheckpath", /* PR_VALUE_SMBCHECKPATH */
318 "SMBexit", /* PR_VALUE_SMBEXIT */
319 "SMBlseek", /* PR_VALUE_SMBLSEEK */
320 "SMBlockread", /* PR_VALUE_SMBLOCKREAD */
321 "SMBwriteunlock", /* PR_VALUE_SMBWRITEUNLOCK */
322 "SMBreadbraw", /* PR_VALUE_SMBREADBRAW */
323 "SMBreadBmpx", /* PR_VALUE_SMBREADBMPX */
324 "SMBreadBs", /* PR_VALUE_SMBREADBS */
325 "SMBwritebraw", /* PR_VALUE_SMBWRITEBRAW */
326 "SMBwriteBmpx", /* PR_VALUE_SMBWRITEBMPX */
327 "SMBwriteBs", /* PR_VALUE_SMBWRITEBS */
328 "SMBwritec", /* PR_VALUE_SMBWRITEC */
329 "SMBsetattrE", /* PR_VALUE_SMBSETATTRE */
330 "SMBgetattrE", /* PR_VALUE_SMBGETATTRE */
331 "SMBlockingX", /* PR_VALUE_SMBLOCKINGX */
332 "SMBtrans", /* PR_VALUE_SMBTRANS */
333 "SMBtranss", /* PR_VALUE_SMBTRANSS */
334 "SMBioctl", /* PR_VALUE_SMBIOCTL */
335 "SMBioctls", /* PR_VALUE_SMBIOCTLS */
336 "SMBcopy", /* PR_VALUE_SMBCOPY */
337 "SMBmove", /* PR_VALUE_SMBMOVE */
338 "SMBecho", /* PR_VALUE_SMBECHO */
339 "SMBwriteclose", /* PR_VALUE_SMBWRITECLOSE */
340 "SMBopenX", /* PR_VALUE_SMBOPENX */
341 "SMBreadX", /* PR_VALUE_SMBREADX */
342 "SMBwriteX", /* PR_VALUE_SMBWRITEX */
343 "SMBtrans2", /* PR_VALUE_SMBTRANS2 */
344 "SMBtranss2", /* PR_VALUE_SMBTRANSS2 */
345 "SMBfindclose", /* PR_VALUE_SMBFINDCLOSE */
346 "SMBfindnclose", /* PR_VALUE_SMBFINDNCLOSE */
347 "SMBtcon", /* PR_VALUE_SMBTCON */
348 "SMBtdis", /* PR_VALUE_SMBTDIS */
349 "SMBnegprot", /* PR_VALUE_SMBNEGPROT */
350 "SMBsesssetupX", /* PR_VALUE_SMBSESSSETUPX */
351 "SMBulogoffX", /* PR_VALUE_SMBULOGOFFX */
352 "SMBtconX", /* PR_VALUE_SMBTCONX */
353 "SMBdskattr", /* PR_VALUE_SMBDSKATTR */
354 "SMBsearch", /* PR_VALUE_SMBSEARCH */
355 "SMBffirst", /* PR_VALUE_SMBFFIRST */
356 "SMBfunique", /* PR_VALUE_SMBFUNIQUE */
357 "SMBfclose", /* PR_VALUE_SMBFCLOSE */
358 "SMBnttrans", /* PR_VALUE_SMBNTTRANS */
359 "SMBnttranss", /* PR_VALUE_SMBNTTRANSS */
360 "SMBntcreateX", /* PR_VALUE_SMBNTCREATEX */
361 "SMBntcancel", /* PR_VALUE_SMBNTCANCEL */
362 "SMBntrename", /* PR_VALUE_SMBNTRENAME */
363 "SMBsplopen", /* PR_VALUE_SMBSPLOPEN */
364 "SMBsplwr", /* PR_VALUE_SMBSPLWR */
365 "SMBsplclose", /* PR_VALUE_SMBSPLCLOSE */
366 "SMBsplretq", /* PR_VALUE_SMBSPLRETQ */
367 "SMBsends", /* PR_VALUE_SMBSENDS */
368 "SMBsendb", /* PR_VALUE_SMBSENDB */
369 "SMBfwdname", /* PR_VALUE_SMBFWDNAME */
370 "SMBcancelf", /* PR_VALUE_SMBCANCELF */
371 "SMBgetmac", /* PR_VALUE_SMBGETMAC */
372 "SMBsendstrt", /* PR_VALUE_SMBSENDSTRT */
373 "SMBsendend", /* PR_VALUE_SMBSENDEND */
374 "SMBsendtxt", /* PR_VALUE_SMBSENDTXT */
375 "SMBinvalid", /* PR_VALUE_SMBINVALID */
376 "pathworks_setdir", /* PR_VALUE_PATHWORKS_SETDIR */
377 "Trans2_open", /* PR_VALUE_TRANS2_OPEN */
378 "Trans2_findfirst", /* PR_VALUE_TRANS2_FINDFIRST */
379 "Trans2_findnext", /* PR_VALUE_TRANS2_FINDNEXT */
380 "Trans2_qfsinfo", /* PR_VALUE_TRANS2_QFSINFO */
381 "Trans2_setfsinfo", /* PR_VALUE_TRANS2_SETFSINFO */
382 "Trans2_qpathinfo", /* PR_VALUE_TRANS2_QPATHINFO */
383 "Trans2_setpathinfo", /* PR_VALUE_TRANS2_SETPATHINFO */
384 "Trans2_qfileinfo", /* PR_VALUE_TRANS2_QFILEINFO */
385 "Trans2_setfileinfo", /* PR_VALUE_TRANS2_SETFILEINFO */
386 "Trans2_fsctl", /* PR_VALUE_TRANS2_FSCTL */
387 "Trans2_ioctl", /* PR_VALUE_TRANS2_IOCTL */
388 "Trans2_findnotifyfirst", /* PR_VALUE_TRANS2_FINDNOTIFYFIRST */
389 "Trans2_findnotifynext", /* PR_VALUE_TRANS2_FINDNOTIFYNEXT */
390 "Trans2_mkdir", /* PR_VALUE_TRANS2_MKDIR */
391 "Trans2_session_setup", /* PR_VALUE_TRANS2_SESSION_SETUP */
392 "Trans2_get_dfs_referral", /* PR_VALUE_TRANS2_GET_DFS_REFERRAL */
393 "Trans2_report_dfs_inconsistancy", /* PR_VALUE_TRANS2_REPORT_DFS_INCONSISTANCY */
394 "NT_transact_create", /* PR_VALUE_NT_TRANSACT_CREATE */
395 "NT_transact_ioctl", /* PR_VALUE_NT_TRANSACT_IOCTL */
396 "NT_transact_set_security_desc", /* PR_VALUE_NT_TRANSACT_SET_SECURITY_DESC */
397 "NT_transact_notify_change",/* PR_VALUE_NT_TRANSACT_NOTIFY_CHANGE */
398 "NT_transact_rename", /* PR_VALUE_NT_TRANSACT_RENAME */
399 "NT_transact_query_security_desc", /* PR_VALUE_NT_TRANSACT_QUERY_SECURITY_DESC */
400 "NT_transact_get_user_quota",/* PR_VALUE_NT_TRANSACT_GET_USER_QUOTA */
401 "NT_transact_set_user_quota",/* PR_VALUE_NT_TRANSACT_SET_USER_QUOTA */
402 "get_nt_acl", /* PR_VALUE_GET_NT_ACL */
403 "fget_nt_acl", /* PR_VALUE_FGET_NT_ACL */
404 "set_nt_acl", /* PR_VALUE_SET_NT_ACL */
405 "fset_nt_acl", /* PR_VALUE_FSET_NT_ACL */
406 "chmod_acl", /* PR_VALUE_CHMOD_ACL */
407 "fchmod_acl", /* PR_VALUE_FCHMOD_ACL */
408 "name_release", /* PR_VALUE_NAME_RELEASE */
409 "name_refresh", /* PR_VALUE_NAME_REFRESH */
410 "name_registration", /* PR_VALUE_NAME_REGISTRATION */
411 "node_status", /* PR_VALUE_NODE_STATUS */
412 "name_query", /* PR_VALUE_NAME_QUERY */
413 "host_announce", /* PR_VALUE_HOST_ANNOUNCE */
414 "workgroup_announce", /* PR_VALUE_WORKGROUP_ANNOUNCE */
415 "local_master_announce", /* PR_VALUE_LOCAL_MASTER_ANNOUNCE */
416 "master_browser_announce", /* PR_VALUE_MASTER_BROWSER_ANNOUNCE */
417 "lm_host_announce", /* PR_VALUE_LM_HOST_ANNOUNCE */
418 "get_backup_list", /* PR_VALUE_GET_BACKUP_LIST */
419 "reset_browser", /* PR_VALUE_RESET_BROWSER */
420 "announce_request", /* PR_VALUE_ANNOUNCE_REQUEST */
421 "lm_announce_request", /* PR_VALUE_LM_ANNOUNCE_REQUEST */
422 "domain_logon", /* PR_VALUE_DOMAIN_LOGON */
423 "sync_browse_lists", /* PR_VALUE_SYNC_BROWSE_LISTS */
424 "run_elections", /* PR_VALUE_RUN_ELECTIONS */
425 "election", /* PR_VALUE_ELECTION */
426 "" /* PR_VALUE_MAX */
429 SMB_ASSERT(val >= 0);
430 SMB_ASSERT(val < PR_VALUE_MAX);
431 return valnames[val];
434 #endif /* WITH_PROFILE */