1300819Sallanjude#ifndef _SKEIN_DEBUG_H_
2300819Sallanjude#define _SKEIN_DEBUG_H_
3300819Sallanjude/***********************************************************************
4300819Sallanjude**
5300819Sallanjude** Interface definitions for Skein hashing debug output.
6300819Sallanjude**
7300819Sallanjude** Source code author: Doug Whiting, 2008.
8300819Sallanjude**
9300819Sallanjude** This algorithm and source code is released to the public domain.
10300819Sallanjude**
11300819Sallanjude************************************************************************/
12300819Sallanjude
13300819Sallanjude#ifdef  SKEIN_DEBUG
14300819Sallanjude/* callout functions used inside Skein code */
15300819Sallanjudevoid    Skein_Show_Block(uint_t bits,const Skein_Ctxt_Hdr_t *h,const u64b_t *X,const u08b_t *blkPtr,
16300819Sallanjude                         const u64b_t *wPtr,const u64b_t *ksPtr,const u64b_t *tsPtr);
17300819Sallanjudevoid    Skein_Show_Round(uint_t bits,const Skein_Ctxt_Hdr_t *h,size_t r,const u64b_t *X);
18300819Sallanjudevoid    Skein_Show_R_Ptr(uint_t bits,const Skein_Ctxt_Hdr_t *h,size_t r,const u64b_t *X_ptr[]);
19300819Sallanjudevoid    Skein_Show_Final(uint_t bits,const Skein_Ctxt_Hdr_t *h,size_t cnt,const u08b_t *outPtr);
20300819Sallanjudevoid    Skein_Show_Key  (uint_t bits,const Skein_Ctxt_Hdr_t *h,const u08b_t *key,size_t keyBytes);
21300819Sallanjude
22300819Sallanjudeextern  uint_t skein_DebugFlag;            /* flags to control debug output (0 --> none) */
23300819Sallanjude
24300819Sallanjude#define SKEIN_RND_SPECIAL       (1000u)
25300819Sallanjude#define SKEIN_RND_KEY_INITIAL   (SKEIN_RND_SPECIAL+0u)
26300819Sallanjude#define SKEIN_RND_KEY_INJECT    (SKEIN_RND_SPECIAL+1u)
27300819Sallanjude#define SKEIN_RND_FEED_FWD      (SKEIN_RND_SPECIAL+2u)
28300819Sallanjude
29300819Sallanjude/* flag bits:  skein_DebugFlag */
30300819Sallanjude#define SKEIN_DEBUG_KEY         (1u << 1)  /* show MAC key */
31300819Sallanjude#define SKEIN_DEBUG_CONFIG      (1u << 2)  /* show config block processing */
32300819Sallanjude#define SKEIN_DEBUG_STATE       (1u << 3)  /* show input state during Show_Block() */
33300819Sallanjude#define SKEIN_DEBUG_TWEAK       (1u << 4)  /* show input state during Show_Block() */
34300819Sallanjude#define SKEIN_DEBUG_KEYSCHED    (1u << 5)  /* show expanded key schedule */
35300819Sallanjude#define SKEIN_DEBUG_INPUT_64    (1u << 6)  /* show input block as 64-bit words */
36300819Sallanjude#define SKEIN_DEBUG_INPUT_08    (1u << 7)  /* show input block as  8-bit bytes */
37300819Sallanjude#define SKEIN_DEBUG_INJECT      (1u << 8)  /* show state after key injection & feedforward points */
38300819Sallanjude#define SKEIN_DEBUG_ROUNDS      (1u << 9)  /* show state after all rounds */
39300819Sallanjude#define SKEIN_DEBUG_FINAL       (1u <<10)  /* show final output of Skein */
40300819Sallanjude#define SKEIN_DEBUG_HDR         (1u <<11)  /* show block header */
41300819Sallanjude#define SKEIN_DEBUG_THREEFISH   (1u <<12)  /* use Threefish name instead of Skein */
42300819Sallanjude#define SKEIN_DEBUG_PERMUTE     (1u <<13)  /* use word permutations */
43300819Sallanjude#define SKEIN_DEBUG_ALL         ((~0u) & ~(SKEIN_DEBUG_THREEFISH | SKEIN_DEBUG_PERMUTE))
44300819Sallanjude#define THREEFISH_DEBUG_ALL     (SKEIN_DEBUG_ALL | SKEIN_DEBUG_THREEFISH)
45300819Sallanjude
46300819Sallanjude#endif /*  SKEIN_DEBUG    */
47300819Sallanjude
48300819Sallanjude#endif /* _SKEIN_DEBUG_H_ */
49