xnu-1699.22.73.tar.gz

[apple/xnu.git] / bsd / hfs / hfs_dbg.h

diff --git a/bsd/hfs/hfs_dbg.h b/bsd/hfs/hfs_dbg.h
index 9033f82ad9b67aaf74a1546e8296bd6261e27da1..f39271fe42e77a3314b9fc733144aefa0b4398a2 100644 (file)
--- a/bsd/hfs/hfs_dbg.h
+++ b/bsd/hfs/hfs_dbg.h
@@ -1,23 +1,29 @@
 /*
 /*

- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000, 2005 Apple Computer, Inc. All rights reserved.

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER

  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.

  * 
  * 

- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*     hfs_dbg.h
  *
  */
 /*     hfs_dbg.h
  *


@@ -33,6 +39,7 @@
  */
 
 struct componentname;
  */
 
 struct componentname;

+extern void Debugger(const char *message);

 
 /* Define the debugging stage...
                4 -> Do all, aggresive, call_kdp
 
 /* Define the debugging stage...
                4 -> Do all, aggresive, call_kdp


@@ -81,22 +88,13 @@ struct componentname;
  */
 #if    HFS_DIAGNOSTIC
 extern int hfs_dbg_all;
  */
 #if    HFS_DIAGNOSTIC
 extern int hfs_dbg_all;

-extern int hfs_dbg_vfs;
-extern int hfs_dbg_vop;
-extern int hfs_dbg_load;
-extern int hfs_dbg_io;
-extern int hfs_dbg_utils;
-extern int hfs_dbg_rw;
-extern int hfs_dbg_lookup;
-extern int hfs_dbg_tree;

 extern int hfs_dbg_err;
 extern int hfs_dbg_err;

-extern int hfs_dbg_test;

 
 #ifdef KERNEL
     #if (HFS_DEBUG_STAGE == 4)
                char            gDebugAssertStr[255];
                #define DBG_ASSERT(a) { if (!(a)) { \
 
 #ifdef KERNEL
     #if (HFS_DEBUG_STAGE == 4)
                char            gDebugAssertStr[255];
                #define DBG_ASSERT(a) { if (!(a)) { \

-                               sprintf(gDebugAssertStr,"Oops - File "__FILE__", line %d: assertion '%s' failed.\n", __LINE__, #a); \
+                               snprintf(gDebugAssertStr, sizeof (gDebugAssertStr), "Oops - File "__FILE__", line %d: assertion '%s' failed.\n", __LINE__, #a); \

                 Debugger(gDebugAssertStr); } }
        #else
 #define DBG_ASSERT(a) { if (!(a)) { panic("File "__FILE__", line %d: assertion '%s' failed.\n", __LINE__, #a); } }
                 Debugger(gDebugAssertStr); } }
        #else
 #define DBG_ASSERT(a) { if (!(a)) { panic("File "__FILE__", line %d: assertion '%s' failed.\n", __LINE__, #a); } }


@@ -105,233 +103,19 @@ extern int hfs_dbg_test;
     #define DBG_ASSERT(a) assert(a)
 #endif /* KERNEL */
 
     #define DBG_ASSERT(a) assert(a)
 #endif /* KERNEL */
 

-//#define DBG_VFS if (hfs_dbg_all || hfs_dbg_vfs) PRINTIT
-#define DBG_VFS(x)     {               \
-       if(hfs_dbg_all || hfs_dbg_vfs) {        \
-        PRINTIT("%X: ", current_proc()->p_pid); \
-        PRINTIT x;             \
-           PRINT_DELAY;  \
-       };                      \
-}
-#define DBG_VFS_CONT(x)        {               \
-    if(hfs_dbg_all || hfs_dbg_vfs) {   \
-        PRINTIT x;             \
-        PRINT_DELAY;  \
-    };                 \
-}
-#define DBG_VOP(x)     {               \
-    if(hfs_dbg_all || hfs_dbg_vop) {   \
-        PRINTIT("%X: ", current_proc()->p_pid); \
-        PRINTIT x;                     \
-        PRINT_DELAY;  \
-    };                 \
-}
-#define DBG_VOP_CONT(x)        {               \
-    if(hfs_dbg_all || hfs_dbg_vop) {   \
-        PRINTIT x;                     \
-        PRINT_DELAY;  \
-    };                 \
-}
-#define DBG_LOAD(x)    {               \
-       if(hfs_dbg_all || hfs_dbg_load) {       \
-        PRINTIT("%X: ", current_proc()->p_pid); \
-           PRINTIT x;                  \
-           PRINT_DELAY;  \
-       };                      \
-}
-#define DBG_IO(x)      {               \
-       if(hfs_dbg_all || hfs_dbg_io) { \
-        PRINTIT("%X: ", current_proc()->p_pid); \
-           PRINTIT x;                  \
-           PRINT_DELAY;  \
-       };                      \
-}
-#define DBG_UTILS(x)   {               \
-       if(hfs_dbg_all || hfs_dbg_utils) {      \
-        PRINTIT("%X: ", current_proc()->p_pid); \
-           PRINTIT x;                  \
-        PRINT_DELAY;  \
-       };                      \
-}
-#define DBG_RW(x)      {               \
-       if(hfs_dbg_all || hfs_dbg_rw) { \
-        PRINTIT("%X: ", current_proc()->p_pid); \
-           PRINTIT x;                  \
-           PRINT_DELAY;  \
-       };                      \
-}
-#define DBG_LOOKUP(x)  {               \
-       if(hfs_dbg_all || hfs_dbg_lookup) {     \
-        PRINTIT("%X: ", current_proc()->p_pid); \
-           PRINTIT x;                  \
-           PRINT_DELAY;  \
-       };                      \
-}
-#define DBG_TREE(x)    {               \
-       if(hfs_dbg_all || hfs_dbg_tree) {       \
-        PRINTIT("%X: ", current_proc()->p_pid); \
-           PRINTIT x;                  \
-        PRINT_DELAY;  \
-       };                      \
-}

 #define DBG_ERR(x)     {               \
        if(hfs_dbg_all || hfs_dbg_err) {        \
 #define DBG_ERR(x)     {               \
        if(hfs_dbg_all || hfs_dbg_err) {        \

-        PRINTIT("%X: ", current_proc()->p_pid); \
+        PRINTIT("%X: ", proc_selfpid()); \

            PRINTIT("HFS ERROR: "); \
            PRINTIT x;                  \
            PRINT_DELAY;  \
        };                      \
 }
            PRINTIT("HFS ERROR: "); \
            PRINTIT x;                  \
            PRINT_DELAY;  \
        };                      \
 }

-#define DBG_TEST(x)    {               \
-       if(hfs_dbg_all || hfs_dbg_test) {       \
-        PRINTIT("%X: ", current_proc()->p_pid); \
-           PRINTIT x;                  \
-           PRINT_DELAY;  \
-       };                      \
-}
-#else  // HFS_DIAGNOSTIC
-#define DBG_ASSERT(a)
-#define DBG_VFS(x)
-#define DBG_VFS_CONT(x)
-#define DBG_VOP(x)
-#define DBG_VOP_CONT(x)
-#define DBG_LOAD(x)
-#define DBG_IO(x)
-#define DBG_UTILS(x)
-#define DBG_RW(x)
-#define DBG_LOOKUP(x)
-#define DBG_TREE(x)
-#define DBG_ERR(x)
-#define DBG_TEST(x)
-#endif // HFS_DIAGNOSTIC
-
-
-/* Used to help print commone values in the vnode ops */
-#if HFS_DIAGNOSTIC
-    extern void debug_vn_status (char* introStr, struct vnode *vn);
-    extern void debug_vn_print (char* introStr, struct vnode *vn);
-       extern void debug_check_vnode(struct vnode *vp, int stage);
-
-    #define DBG_VN_STATUS (introStr, vn)       debug_vn_status (introStr, vn)
-    #define DBG_VN_PRINT (introStr, vn)        debug_vn_print (introStr, vn)
-    #define DBG_FUNC_NAME(FSTR)                        static char *funcname = FSTR
-       #define DBG_PRINT_FUNC_NAME()                   DBG_VFS(("%s: ", funcname));
-       #define DBG_VOP_PRINT_FUNCNAME()                DBG_VOP(("%s: ", funcname));
-
-
-    /* This checks to make sure the passed in node is valid and HFS */
-    #define    DBG_HFS_NODE_CHECK(VP)  {                                                       \
-        if ((VP) == NULL || VTOH((VP))->h_valid != HFS_VNODE_MAGIC) {          \
-            DBG_VOP_CONT(("%s: INVALID VNODE: ", funcname));   \
-                DBG_VOP_PRINT_VNODE_INFO(VP);                          \
-                    DBG_VOP_CONT(("\n"));                                                      \
-                        return (EINVAL);                                                       \
-                            }                                                                                  \
-        }
-
-    #define DBG_VOP_PRINT_VNODE_INFO(VP)       { if (VP && VTOH((VP))->h_valid == HFS_VNODE_MAGIC)             { \
-        DBG_VOP_CONT(("\tn: %s, p: %d, id: %d, f: %d, u: %d, v: 0x%x ",H_NAME(VTOH(VP)),       \
-                H_DIRID(VTOH(VP)), H_FILEID(VTOH(VP)), H_FORKTYPE(VTOH(VP)), (VP)->v_usecount, (u_int)(VP))); \
-                    } else { \
-                        DBG_VOP_CONT(("\tBAD MACNODE"));}}
-
-       #define DBG_VOP_PRINT_CPN_INFO(CN) DBG_VOP_CONT(("name: %s",(CN)->cn_nameptr));
-
-#else /* HFS_DIAGNOSTIC */
-
-    #define DBG_VN_PRINT(introStr,vn)
-    #define DBG_VN_STATUS(introStr,vn)
-    #define DBG_FUNC_NAME(FSTR)
-    #define DBG_PRINT_FUNC_NAME()
-    #define DBG_HFS_NODE_CHECK(VP)
-    #define DBG_VOP_PRINT_FUNCNAME()
-    #define DBG_VOP_PRINT_VNODE_INFO(VP)
-    #define DBG_VOP_PRINT_CPN_INFO(CN)
-
-#endif /* HFS_DIAGNOSTIC */
-

 
 

-#if HFS_DIAGNOSTIC
-#define        DBG_VOP_TEST_LOCKS      1
-#else /* HFS_DIAGNOSTIC */
-#undef DBG_VOP_TEST_LOCKS
-#endif /* HFS_DIAGNOSTIC */
-
-
-
-#if DBG_VOP_TEST_LOCKS
-
-typedef struct VopDbgStoreRec {
-    short      id;
-    struct vnode       *vp;
-    short      inState;
-    short      outState;
-    short      errState;
-    int                inValue;
-    int                outValue;
-    } VopDbgStoreRec;
-
-    
-void DbgVopTest (int max, int error, VopDbgStoreRec *VopDbgStore, char *funcname);
-void DbgLookupTest(char *funcname,     struct componentname  *cnp, struct vnode *dvp, struct vnode *vp);
-
-#define        VOPDBG_IGNORE                   0
-#define        VOPDBG_LOCKED                   1
-#define        VOPDBG_UNLOCKED                 -1
-#define        VOPDBG_LOCKNOTNIL               2
-#define        VOPDBG_SAME                             3
+#else  /* HFS_DIAGNOSTIC */

 
 

-#define        VOPDBG_ZERO     0
-#define        VOPDBG_POS      1
-
-/*             This sets up the test for the lock state of vnodes. The entry paramaters are:
- *                     I = index of paramater
- *                     VP = pointer to a vnode
- *                     ENTRYSTATE = the inState of the lock
- *                     EXITSTATE = the outState of the lock
- *                     ERRORSTATE = the error state of the lock
- *             It initializes the structure, does some preliminary validity checks, but does nothing
- *             if the instate is set to be ignored.
- */
-
-
-#define  DBG_VOP_LOCKS_DECL(I) VopDbgStoreRec  VopDbgStore[I];short numOfLockSlots=I
-#define  DBG_VOP_LOCKS_INIT(I,VP,ENTRYSTATE,EXITSTATE,ERRORSTATE,CHECKFLAG)            \
-               if (I >= numOfLockSlots) { \
-                DEBUG_BREAK_MSG(("%s: DBG_VOP_LOCKS_INIT: Entry #%d greater than allocated slots!\n", funcname, I)); \
-            }; \
-           VopDbgStore[I].id                   = I; \
-                       VopDbgStore[I].vp                       = VP; \
-                       VopDbgStore[I].inState          = ENTRYSTATE; \
-                       VopDbgStore[I].outState         = EXITSTATE; \
-                       VopDbgStore[I].errState         = ERRORSTATE; \
-                       VopDbgStore[I].inValue          = 0; \
-                       VopDbgStore[I].outValue         = 0; \
-                       if ((VopDbgStore[I].inState != VOPDBG_IGNORE)) {                                                        \
-                               if ((VP) == NULL)                                                                                                               \
-                PRINTIT ("%X: %s: DBG_VOP_LOCK on start: Null vnode ptr\n", current_proc()->p_pid, funcname);  \
-                               else                                                                                                                                    \
-                                       VopDbgStore[I].inValue = lockstatus (&(VTOH(VP))->h_lock);                      \
-                               }                                                                                                                                               \
-                       if ((VP) != NULL)                                                                                                                       \
-                               {                                                                                                                                               \
-                               if (CHECKFLAG==VOPDBG_POS && (VP)->v_usecount <= 0)                                     \
-                PRINTIT("%X: %s: BAD USECOUNT OF %d !!!!\n", current_proc()->p_pid, funcname, (VP)->v_usecount);       \
-                               else if ((VP)->v_usecount < 0)                                                                                                  \
-                PRINTIT("%X: %s: BAD USECOUNT OF %d !!!!\n", current_proc()->p_pid, funcname, (VP)->v_usecount);       \
-                               }
-
-    #define DBG_VOP_UPDATE_VP(I, VP) \
-               VopDbgStore[I].vp                       = VP;
-
-    #define  DBG_VOP_LOCKS_TEST(status) DbgVopTest (numOfLockSlots, status, VopDbgStore, funcname);
-    #define  DBG_VOP_LOOKUP_TEST(funcname, cnp, dvp, vp) DbgLookupTest (funcname, cnp, dvp, vp);
+#define DBG_ASSERT(a)
+#define DBG_ERR(x)

 
 

-#else   /* DBG_VOP_TEST_LOCKS */
+#endif /* HFS_DIAGNOSTIC */

 
 

-    #define  DBG_VOP_LOCKS_DECL(A)
-    #define  DBG_VOP_LOCKS_INIT(A,B,C,D,E,F)
-    #define  DBG_VOP_LOCKS_TEST(a)
-    #define  DBG_VOP_LOOKUP_TEST(funcname, cnp, dvp, vp)
-    #define  DBG_VOP_UPDATE_VP(I, VP)
-#endif /* DBG_VOP_TEST_LOCKS */