lib/librte_eal/common/include/rte_hexdump.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_HEXDUMP_H_
  35 #define _RTE_HEXDUMP_H_
  36
  37 /**
  38  * @file
  39  * Simple API to dump out memory in a special hex format.
  40  */
  41
  42 #include <stdio.h>
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 /**
  49 * Dump out memory in a special hex dump format.
  50 *
  51 * @param f
  52 *               A pointer to a file for output
  53 * @param title
  54 *               If not NULL this string is printed as a header to the output.
  55 * @param buf
  56 *               This is the buffer address to print out.
  57 * @param len
  58 *               The number of bytes to dump out
  59 * @return
  60 *               None.
  61 */
  62
  63 extern void
  64 rte_hexdump(FILE *f, const char * title, const void * buf, unsigned int len);
  65
  66 /**
  67 * Dump out memory in a hex format with colons between bytes.
  68 *
  69 * @param f
  70 *               A pointer to a file for output
  71 * @param title
  72 *               If not NULL this string is printed as a header to the output.
  73 * @param buf
  74 *               This is the buffer address to print out.
  75 * @param len
  76 *               The number of bytes to dump out
  77 * @return
  78 *               None.
  79 */
  80
  81 void
  82 rte_memdump(FILE *f, const char * title, const void * buf, unsigned int len);
  83
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif
  88
  89 #endif /* _RTE_HEXDUMP_H_ */