source: branches/samba-3.0/source/include/smb_macros.h@ 105

Last change on this file since 105 was 62, checked in by Paul Smedley, 18 years ago

Update source to 3.0.25c level
File size: 15.2 KB
Line 
1/*
2 Unix SMB/CIFS implementation.
3 SMB parameters and setup
4 Copyright (C) Andrew Tridgell 1992-1999
5 Copyright (C) John H Terpstra 1996-1999
6 Copyright (C) Luke Kenneth Casson Leighton 1996-1999
7 Copyright (C) Paul Ashton 1998 - 1999
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22*/
23
24#ifndef _SMB_MACROS_H
25#define _SMB_MACROS_H
26
27/* Misc bit macros */
28#define BOOLSTR(b) ((b) ? "Yes" : "No")
29#define BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
30
31/* for readability... */
32#define IS_DOS_READONLY(test_mode) (((test_mode) & aRONLY) != 0)
33#define IS_DOS_DIR(test_mode) (((test_mode) & aDIR) != 0)
34#define IS_DOS_ARCHIVE(test_mode) (((test_mode) & aARCH) != 0)
35#define IS_DOS_SYSTEM(test_mode) (((test_mode) & aSYSTEM) != 0)
36#define IS_DOS_HIDDEN(test_mode) (((test_mode) & aHIDDEN) != 0)
37
38#ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
39
40/**
41 * Free memory if the pointer and zero the pointer.
42 *
43 * @note You are explicitly allowed to pass NULL pointers -- they will
44 * always be ignored.
45 **/
46#define SAFE_FREE(x) do { if ((x) != NULL) {free(x); x=NULL;} } while(0)
47#endif
48
49/* assert macros */
50#ifdef DEVELOPER
51#define SMB_ASSERT(b) ( (b) ? (void)0 : \
52 (DEBUG(0,("PANIC: assert failed at %s(%d)\n", \
53 __FILE__, __LINE__)), smb_panic("assert failed")))
54#else
55/* redefine the assert macro for non-developer builds */
56#define SMB_ASSERT(b) ( (b) ? (void)0 : \
57 (DEBUG(0,("PANIC: assert failed at %s(%d)\n", __FILE__, __LINE__))))
58#endif
59
60#define SMB_WARN(condition, message) \
61 ((condition) ? (void)0 : \
62 DEBUG(0, ("WARNING: %s: %s\n", #condition, message)))
63
64#define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
65
66/* these are useful macros for checking validity of handles */
67#define IS_IPC(conn) ((conn) && (conn)->ipc)
68#define IS_PRINT(conn) ((conn) && (conn)->printer)
69/* you must add the following extern declaration to files using this macro
70 * (do not add it to the macro as that causes nested extern declaration warnings)
71 * extern struct current_user current_user;
72 */
73#define FSP_BELONGS_CONN(fsp,conn) do {\
74 if (!((fsp) && (conn) && ((conn)==(fsp)->conn) && (current_user.vuid==(fsp)->vuid))) \
75 return ERROR_NT(NT_STATUS_INVALID_HANDLE); \
76 } while(0)
77
78#define FNUM_OK(fsp,c) ((fsp) && !(fsp)->is_directory && (c)==(fsp)->conn && current_user.vuid==(fsp)->vuid)
79
80/* you must add the following extern declaration to files using this macro
81 * (do not add it to the macro as that causes nested extern declaration warnings)
82 * extern struct current_user current_user;
83 */
84#define CHECK_FSP(fsp,conn) do {\
85 if (!(fsp) || !(conn)) \
86 return ERROR_NT(NT_STATUS_INVALID_HANDLE); \
87 else if (((conn) != (fsp)->conn) || current_user.vuid != (fsp)->vuid) \
88 return ERROR_NT(NT_STATUS_INVALID_HANDLE); \
89 else if ((fsp)->is_directory) \
90 return ERROR_NT(NT_STATUS_INVALID_DEVICE_REQUEST); \
91 else if ((fsp)->fh->fd == -1) \
92 return ERROR_NT(NT_STATUS_ACCESS_DENIED); \
93 (fsp)->num_smb_operations++;\
94 } while(0)
95
96#define CHECK_READ(fsp,inbuf) (((fsp)->fh->fd != -1) && ((fsp)->can_read || \
97 ((SVAL((inbuf),smb_flg2) & FLAGS2_READ_PERMIT_EXECUTE) && \
98 (fsp->access_mask & FILE_EXECUTE))))
99
100#define CHECK_WRITE(fsp) ((fsp)->can_write && ((fsp)->fh->fd != -1))
101
102#define ERROR_WAS_LOCK_DENIED(status) (NT_STATUS_EQUAL((status), NT_STATUS_LOCK_NOT_GRANTED) || \
103 NT_STATUS_EQUAL((status), NT_STATUS_FILE_LOCK_CONFLICT) )
104
105/* the service number for the [globals] defaults */
106#define GLOBAL_SECTION_SNUM (-1)
107/* translates a connection number into a service number */
108#define SNUM(conn) ((conn)?(conn)->params->service:GLOBAL_SECTION_SNUM)
109
110
111/* access various service details */
112#define SERVICE(snum) (lp_servicename(snum))
113#define PRINTERNAME(snum) (lp_printername(snum))
114#define CAN_WRITE(conn) (!conn->read_only)
115#define VALID_SNUM(snum) (lp_snum_ok(snum))
116#define GUEST_OK(snum) (VALID_SNUM(snum) && lp_guest_ok(snum))
117#define GUEST_ONLY(snum) (VALID_SNUM(snum) && lp_guest_only(snum))
118#define CAN_SETDIR(snum) (!lp_no_set_dir(snum))
119#define CAN_PRINT(conn) ((conn) && lp_print_ok(SNUM(conn)))
120#define MAP_HIDDEN(conn) ((conn) && lp_map_hidden(SNUM(conn)))
121#define MAP_SYSTEM(conn) ((conn) && lp_map_system(SNUM(conn)))
122#define MAP_ARCHIVE(conn) ((conn) && lp_map_archive(SNUM(conn)))
123#define IS_HIDDEN_PATH(conn,path) ((conn) && is_in_path((path),(conn)->hide_list,(conn)->case_sensitive))
124#define IS_VETO_PATH(conn,path) ((conn) && is_in_path((path),(conn)->veto_list,(conn)->case_sensitive))
125#define IS_VETO_OPLOCK_PATH(conn,path) ((conn) && is_in_path((path),(conn)->veto_oplock_list,(conn)->case_sensitive))
126
127/*
128 * Used by the stat cache code to check if a returned
129 * stat structure is valid.
130 */
131
132#define VALID_STAT(st) ((st).st_nlink != 0)
133#define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_mode))
134#define SET_STAT_INVALID(st) ((st).st_nlink = 0)
135
136#ifndef MIN
137#define MIN(a,b) ((a)<(b)?(a):(b))
138#endif
139#ifndef MAX
140#define MAX(a,b) ((a)>(b)?(a):(b))
141#endif