File: qz_utils.h

package info (click to toggle)
qatzip 1.3.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,912 kB
  • sloc: ansic: 20,086; makefile: 188; sh: 114
file content (155 lines) | stat: -rw-r--r-- 5,072 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/***************************************************************************
 *
 *   BSD LICENSE
 *
 *   Copyright(c) 2007-2026 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ***************************************************************************/

/**
 *****************************************************************************
 * @file qz_utils.h
 *
 * @defgroup qatzip debug API
 *
 * @description
 *      These functions specify the API for debug operations.
 *
 * @remarks
 *
 *
 *****************************************************************************/

#ifndef QZ_UTILS_H
#define QZ_UTILS_H

#include <stdarg.h>
#include <stdint.h>
#include <pthread.h>
#include <stdio.h>
#include <time.h>
#include "qatzip.h"

typedef enum SERV_E {
    COMPRESSION = 0,
    DECOMPRESSION
} Serv_T;

typedef enum ENGINE_E {
    HW = 0,
    SW
} Engine_T;

typedef struct ThreadList_S {
    unsigned int thread_id;
    unsigned int comp_hw_count;
    unsigned int comp_sw_count;
    unsigned int decomp_hw_count;
    unsigned int decomp_sw_count;
    struct ThreadList_S *next;
} ThreadList_T;

typedef struct QatThread_S {
    ThreadList_T *comp_th_list;
    unsigned int num_comp_th;
    pthread_mutex_t comp_lock;
    ThreadList_T *decomp_th_list;
    unsigned int num_decomp_th;
    pthread_mutex_t decomp_lock;
} QatThread_T;

typedef struct QzRingHeadTail_S {
    uint32_t head;
    uint32_t tail;
} QzRingHeadTail_T;

typedef struct QzRing_S {
    uint32_t size;           /**< Size of ring. */
    uint32_t mask;           /**< Mask (size-1) of ring. */
    uint32_t capacity;       /**< Usable size of ring */

    void **elems;

    QzRingHeadTail_T prod;
    QzRingHeadTail_T cons;
} QzRing_T;

QzRing_T *QzRingCreate(int size);
void QzRingFree(QzRing_T *ring);
void QzClearRing(QzRing_T *ring);
int QzRingProduceEnQueue(QzRing_T *ring, void *obj, int is_single_producer);
void *QzRingConsumeDequeue(QzRing_T *ring, int is_single_consumer);

extern void initDebugLock(void);
extern void dumpThreadInfo(void);
extern void insertThread(unsigned int th_id,
                         Serv_T serv_type,
                         Engine_T engine_type);

#ifdef QZ_DEBUG_FILE
extern void qz_debug_init_log(void);
extern void qz_debug_close_log(void);
#endif

/*  QATzip log API
 *  could change the log level on runtime
 */
void logMessage(QzLogLevel_T level, const char *file, int line,
                const char *format, ...);

#define LOG(level, ...) logMessage(level, __FILE__, __LINE__, __VA_ARGS__)
#define QZ_PRINT(...) LOG(LOG_NONE, __VA_ARGS__)
#define QZ_ERROR(...) LOG(LOG_ERROR, __VA_ARGS__)
#define QZ_WARN(...) LOG(LOG_WARNING, __VA_ARGS__)
#define QZ_INFO(...) LOG(LOG_INFO, __VA_ARGS__)
#define QZ_DEBUG(...) LOG(LOG_DEBUG1, __VA_ARGS__)
#define QZ_TEST(...) LOG(LOG_DEBUG2, __VA_ARGS__)
#define QZ_MEM_PRINT(...) LOG(LOG_DEBUG3, __VA_ARGS__)

#ifdef ENABLE_TESTLOG
#define QZ_TESTLOG(debuglevel, Readable, tag, ...) { \
    FILE *fd = debuglevel > 1 ? stdout : stderr; \
    fprintf(fd, "Tag: %s; ", tag); \
    if (Readable) { \
        fprintf(fd, "Time: %s %s; Location: %s->%s->%d; ", \
                __DATE__, __TIME__, __FILE__, __func__, __LINE__); \
    } else { \
        struct timespec ts = { 0 }; \
        clock_gettime(CLOCK_MONOTONIC_RAW, &ts); \
        fprintf(fd, "Time: %ld.%06lds; ", ts.tv_sec, ts.tv_nsec / 1000); \
    } \
    fprintf(fd, "%s", "Info: "); \
    fprintf(fd, __VA_ARGS__); \
    fprintf(fd, "\n"); \
}
#endif


#endif