docs: Avoid mentioning a possibly misleading option.
[Samba/bjacke.git] / source3 / utils / status.c
blobf4b5f4e2c3d8c4bee782e7c66eb1f319924ba494
1 /*
2 Unix SMB/CIFS implementation.
3 status reporting
4 Copyright (C) Andrew Tridgell 1994-1998
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
19 Revision History:
21 12 aug 96: Erik.Devriendt@te6.siemens.be
22 added support for shared memory implementation of share mode locking
24 21-Jul-1998: rsharpe@ns.aus.com (Richard Sharpe)
25 Added -L (locks only) -S (shares only) flags and code
30 * This program reports current SMB connections
33 #include "includes.h"
34 #include "system/filesys.h"
35 #include "popt_common.h"
36 #include "dbwrap/dbwrap.h"
37 #include "dbwrap/dbwrap_open.h"
38 #include "../libcli/security/security.h"
39 #include "session.h"
40 #include "locking/proto.h"
41 #include "messages.h"
42 #include "librpc/gen_ndr/open_files.h"
43 #include "smbd/smbd.h"
44 #include "librpc/gen_ndr/notify.h"
45 #include "lib/conn_tdb.h"
46 #include "serverid.h"
48 #define SMB_MAXPIDS 2048
49 static uid_t Ucrit_uid = 0; /* added by OH */
50 static struct server_id Ucrit_pid[SMB_MAXPIDS]; /* Ugly !!! */ /* added by OH */
51 static int Ucrit_MaxPid=0; /* added by OH */
52 static unsigned int Ucrit_IsActive = 0; /* added by OH */
54 static bool verbose, brief;
55 static bool shares_only; /* Added by RJS */
56 static bool locks_only; /* Added by RJS */
57 static bool processes_only;
58 static bool show_brl;
59 static bool numeric_only;
60 static bool do_checks = true;
62 const char *username = NULL;
64 extern bool status_profile_dump(bool be_verbose);
65 extern bool status_profile_rates(bool be_verbose);
67 /* added by OH */
68 static void Ucrit_addUid(uid_t uid)
70 Ucrit_uid = uid;
71 Ucrit_IsActive = 1;
74 static unsigned int Ucrit_checkUid(uid_t uid)
76 if ( !Ucrit_IsActive )
77 return 1;
79 if ( uid == Ucrit_uid )
80 return 1;
82 return 0;
85 static unsigned int Ucrit_checkPid(struct server_id pid)
87 int i;
89 if ( !Ucrit_IsActive )
90 return 1;
92 for (i=0;i<Ucrit_MaxPid;i++) {
93 if (serverid_equal(&pid, &Ucrit_pid[i])) {
94 return 1;
98 return 0;
101 static bool Ucrit_addPid( struct server_id pid )
103 if ( !Ucrit_IsActive )
104 return True;
106 if ( Ucrit_MaxPid >= SMB_MAXPIDS ) {
107 d_printf("ERROR: More than %d pids for user %s!\n",
108 SMB_MAXPIDS, uidtoname(Ucrit_uid));
110 return False;
113 Ucrit_pid[Ucrit_MaxPid++] = pid;
115 return True;
118 static void print_share_mode(const struct share_mode_entry *e,
119 const char *sharepath,
120 const char *fname,
121 void *dummy)
123 static int count;
125 if (do_checks && !is_valid_share_mode_entry(e)) {
126 return;
129 if (count==0) {
130 d_printf("Locked files:\n");
131 d_printf("Pid Uid DenyMode Access R/W Oplock SharePath Name Time\n");
132 d_printf("--------------------------------------------------------------------------------------------------\n");
134 count++;
136 if (do_checks && !serverid_exists(&e->pid)) {
137 /* the process for this entry does not exist any more */
138 return;
141 if (Ucrit_checkPid(e->pid)) {
142 d_printf("%-11s ",procid_str_static(&e->pid));
143 d_printf("%-9u ", (unsigned int)e->uid);
144 switch (map_share_mode_to_deny_mode(e->share_access,
145 e->private_options)) {
146 case DENY_NONE: d_printf("DENY_NONE "); break;
147 case DENY_ALL: d_printf("DENY_ALL "); break;
148 case DENY_DOS: d_printf("DENY_DOS "); break;
149 case DENY_READ: d_printf("DENY_READ "); break;
150 case DENY_WRITE:printf("DENY_WRITE "); break;
151 case DENY_FCB: d_printf("DENY_FCB "); break;
152 default: {
153 d_printf("unknown-please report ! "
154 "e->share_access = 0x%x, "
155 "e->private_options = 0x%x\n",
156 (unsigned int)e->share_access,
157 (unsigned int)e->private_options );
158 break;
161 d_printf("0x%-8x ",(unsigned int)e->access_mask);
162 if ((e->access_mask & (FILE_READ_DATA|FILE_WRITE_DATA))==
163 (FILE_READ_DATA|FILE_WRITE_DATA)) {
164 d_printf("RDWR ");
165 } else if (e->access_mask & FILE_WRITE_DATA) {
166 d_printf("WRONLY ");
167 } else {
168 d_printf("RDONLY ");
171 if((e->op_type & (EXCLUSIVE_OPLOCK|BATCH_OPLOCK)) ==
172 (EXCLUSIVE_OPLOCK|BATCH_OPLOCK)) {
173 d_printf("EXCLUSIVE+BATCH ");
174 } else if (e->op_type & EXCLUSIVE_OPLOCK) {
175 d_printf("EXCLUSIVE ");
176 } else if (e->op_type & BATCH_OPLOCK) {
177 d_printf("BATCH ");
178 } else if (e->op_type & LEVEL_II_OPLOCK) {
179 d_printf("LEVEL_II ");
180 } else {
181 d_printf("NONE ");
184 d_printf(" %s %s %s",sharepath, fname, time_to_asc((time_t)e->time.tv_sec));
188 static void print_brl(struct file_id id,
189 struct server_id pid,
190 enum brl_type lock_type,
191 enum brl_flavour lock_flav,
192 br_off start,
193 br_off size,
194 void *private_data)
196 static int count;
197 unsigned int i;
198 static const struct {
199 enum brl_type lock_type;
200 const char *desc;
201 } lock_types[] = {
202 { READ_LOCK, "R" },
203 { WRITE_LOCK, "W" },
204 { PENDING_READ_LOCK, "PR" },
205 { PENDING_WRITE_LOCK, "PW" },
206 { UNLOCK_LOCK, "U" }
208 const char *desc="X";
209 const char *sharepath = "";
210 char *fname = NULL;
211 struct share_mode_lock *share_mode;
213 if (count==0) {
214 d_printf("Byte range locks:\n");
215 d_printf("Pid dev:inode R/W start size SharePath Name\n");
216 d_printf("--------------------------------------------------------------------------------\n");
218 count++;
220 share_mode = fetch_share_mode_unlocked(NULL, id);
221 if (share_mode) {
222 bool has_stream = share_mode->data->stream_name != NULL;
224 fname = talloc_asprintf(NULL, "%s%s%s",
225 share_mode->data->base_name,
226 has_stream ? ":" : "",
227 has_stream ?
228 share_mode->data->stream_name :
229 "");
230 } else {
231 fname = talloc_strdup(NULL, "");
232 if (fname == NULL) {
233 return;
237 for (i=0;i<ARRAY_SIZE(lock_types);i++) {
238 if (lock_type == lock_types[i].lock_type) {
239 desc = lock_types[i].desc;
243 d_printf("%-10s %-15s %-4s %-9.0f %-9.0f %-24s %-24s\n",
244 procid_str_static(&pid), file_id_string_tos(&id),
245 desc,
246 (double)start, (double)size,
247 sharepath, fname);
249 TALLOC_FREE(fname);
250 TALLOC_FREE(share_mode);
253 static int traverse_connections(const struct connections_key *key,
254 const struct connections_data *crec,
255 void *state)
257 if (crec->cnum == TID_FIELD_INVALID)
258 return 0;
260 if (do_checks &&
261 (!process_exists(crec->pid) || !Ucrit_checkUid(crec->uid))) {
262 return 0;
265 d_printf("%-10s %s %-12s %s",
266 crec->servicename,procid_str_static(&crec->pid),
267 crec->machine,
268 time_to_asc(crec->start));
270 return 0;
273 static int traverse_sessionid(const char *key, struct sessionid *session,
274 void *private_data)
276 fstring uid_str, gid_str;
278 if (do_checks &&
279 (!process_exists(session->pid) ||
280 !Ucrit_checkUid(session->uid))) {
281 return 0;
284 Ucrit_addPid(session->pid);
286 fstr_sprintf(uid_str, "%u", (unsigned int)session->uid);
287 fstr_sprintf(gid_str, "%u", (unsigned int)session->gid);
289 d_printf("%-7s %-12s %-12s %-12s (%s)\n",
290 procid_str_static(&session->pid),
291 numeric_only ? uid_str : uidtoname(session->uid),
292 numeric_only ? gid_str : gidtoname(session->gid),
293 session->remote_machine, session->hostname);
295 return 0;
299 static void print_notify_recs(const char *path,
300 struct notify_db_entry *entries,
301 size_t num_entries,
302 time_t deleted_time, void *private_data)
304 size_t i;
305 d_printf("%s\n", path);
307 if (num_entries == 0) {
308 d_printf("deleted %s\n", time_to_asc(deleted_time));
311 for (i=0; i<num_entries; i++) {
312 struct notify_db_entry *e = &entries[i];
313 char *str;
315 str = server_id_str(talloc_tos(), &e->server);
316 printf("%s %x %x\n", str, (unsigned)e->filter,
317 (unsigned)e->subdir_filter);
318 TALLOC_FREE(str);
320 printf("\n");
323 int main(int argc, char *argv[])
325 int c;
326 int profile_only = 0;
327 bool show_processes, show_locks, show_shares;
328 bool show_notify = false;
329 poptContext pc;
330 struct poptOption long_options[] = {
331 POPT_AUTOHELP
332 {"processes", 'p', POPT_ARG_NONE, NULL, 'p', "Show processes only" },
333 {"verbose", 'v', POPT_ARG_NONE, NULL, 'v', "Be verbose" },
334 {"locks", 'L', POPT_ARG_NONE, NULL, 'L', "Show locks only" },
335 {"shares", 'S', POPT_ARG_NONE, NULL, 'S', "Show shares only" },
336 {"notify", 'N', POPT_ARG_NONE, NULL, 'N', "Show notifies" },
337 {"user", 'u', POPT_ARG_STRING, &username, 'u', "Switch to user" },
338 {"brief", 'b', POPT_ARG_NONE, NULL, 'b', "Be brief" },
339 {"profile", 'P', POPT_ARG_NONE, NULL, 'P', "Do profiling" },
340 {"profile-rates", 'R', POPT_ARG_NONE, NULL, 'R', "Show call rates" },
341 {"byterange", 'B', POPT_ARG_NONE, NULL, 'B', "Include byte range locks"},
342 {"numeric", 'n', POPT_ARG_NONE, NULL, 'n', "Numeric uid/gid"},
343 {"fast", 'f', POPT_ARG_NONE, NULL, 'f', "Skip checks if processes still exist"},
344 POPT_COMMON_SAMBA
345 POPT_TABLEEND
347 TALLOC_CTX *frame = talloc_stackframe();
348 int ret = 0;
349 struct messaging_context *msg_ctx;
351 sec_init();
352 load_case_tables();
354 setup_logging(argv[0], DEBUG_STDERR);
356 if (getuid() != geteuid()) {
357 d_printf("smbstatus should not be run setuid\n");
358 ret = 1;
359 goto done;
362 pc = poptGetContext(NULL, argc, (const char **) argv, long_options,
363 POPT_CONTEXT_KEEP_FIRST);
365 while ((c = poptGetNextOpt(pc)) != -1) {
366 switch (c) {
367 case 'p':
368 processes_only = true;
369 break;
370 case 'v':
371 verbose = true;
372 break;
373 case 'L':
374 locks_only = true;
375 break;
376 case 'S':
377 shares_only = true;
378 break;
379 case 'N':
380 show_notify = true;
381 break;
382 case 'b':
383 brief = true;
384 break;
385 case 'u':
386 Ucrit_addUid(nametouid(poptGetOptArg(pc)));
387 break;
388 case 'P':
389 case 'R':
390 profile_only = c;
391 break;
392 case 'B':
393 show_brl = true;
394 break;
395 case 'n':
396 numeric_only = true;
397 break;
398 case 'f':
399 do_checks = false;
400 break;
404 /* setup the flags based on the possible combincations */
406 show_processes = !(shares_only || locks_only || profile_only) || processes_only;
407 show_locks = !(shares_only || processes_only || profile_only) || locks_only;
408 show_shares = !(processes_only || locks_only || profile_only) || shares_only;
410 if ( username )
411 Ucrit_addUid( nametouid(username) );
413 if (verbose) {
414 d_printf("using configfile = %s\n", get_dyn_CONFIGFILE());
417 if (!lp_load_initial_only(get_dyn_CONFIGFILE())) {
418 fprintf(stderr, "Can't load %s - run testparm to debug it\n",
419 get_dyn_CONFIGFILE());
420 ret = -1;
421 goto done;
425 if (lp_clustering()) {
427 * This implicitly initializes the global ctdbd
428 * connection, usable by the db_open() calls further
429 * down.
431 msg_ctx = messaging_init(NULL, samba_tevent_context_init(NULL));
432 if (msg_ctx == NULL) {
433 fprintf(stderr, "messaging_init failed\n");
434 ret = -1;
435 goto done;
439 if (!lp_load_global(get_dyn_CONFIGFILE())) {
440 fprintf(stderr, "Can't load %s - run testparm to debug it\n",
441 get_dyn_CONFIGFILE());
442 ret = -1;
443 goto done;
446 switch (profile_only) {
447 case 'P':
448 /* Dump profile data */
449 return status_profile_dump(verbose);
450 case 'R':
451 /* Continuously display rate-converted data */
452 return status_profile_rates(verbose);
453 default:
454 break;
457 if ( show_processes ) {
458 d_printf("\nSamba version %s\n",samba_version_string());
459 d_printf("PID Username Group Machine \n");
460 d_printf("-------------------------------------------------------------------\n");
462 sessionid_traverse_read(traverse_sessionid, NULL);
464 if (processes_only) {
465 goto done;
469 if ( show_shares ) {
470 if (verbose) {
471 d_printf("Opened %s\n", lock_path("connections.tdb"));
474 if (brief) {
475 goto done;
478 d_printf("\nService pid machine Connected at\n");
479 d_printf("-------------------------------------------------------\n");
481 connections_forall_read(traverse_connections, NULL);
483 d_printf("\n");
485 if ( shares_only ) {
486 goto done;
490 if ( show_locks ) {
491 int result;
492 struct db_context *db;
493 db = db_open(NULL, lock_path("locking.tdb"), 0,
494 TDB_CLEAR_IF_FIRST|TDB_INCOMPATIBLE_HASH, O_RDONLY, 0,
495 DBWRAP_LOCK_ORDER_1);
497 if (!db) {
498 d_printf("%s not initialised\n",
499 lock_path("locking.tdb"));
500 d_printf("This is normal if an SMB client has never "
501 "connected to your server.\n");
502 exit(0);
503 } else {
504 TALLOC_FREE(db);
507 if (!locking_init_readonly()) {
508 d_printf("Can't initialise locking module - exiting\n");
509 ret = 1;
510 goto done;
513 result = share_mode_forall(print_share_mode, NULL);
515 if (result == 0) {
516 d_printf("No locked files\n");
517 } else if (result < 0) {
518 d_printf("locked file list truncated\n");
521 d_printf("\n");
523 if (show_brl) {
524 brl_forall(print_brl, NULL);
527 locking_end();
530 if (show_notify) {
531 struct notify_context *n;
533 n = notify_init(talloc_tos(), NULL, NULL);
534 if (n == NULL) {
535 goto done;
537 notify_walk(n, print_notify_recs, NULL);
538 TALLOC_FREE(n);
541 done:
542 TALLOC_FREE(frame);
543 return ret;