1
2/*-
3 * SPDX-License-Identifier: BSD-2-Clause
4 *
5 * Copyright (C) 2009 Gabor Kovesdan <gabor@FreeBSD.org>
6 * Copyright (C) 2012 Oleg Moskalenko <mom040267@gmail.com>
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 */
30
31#if !defined(__BSD_SORT_H__)
32#define	__BSD_SORT_H__
33
34#include <errno.h>
35#include <stdbool.h>
36#include <stdio.h>
37#include <sysexits.h>
38#include <wchar.h>
39
40#include <sys/types.h>
41#include <md5.h>
42
43#define	VERSION	"2.3-FreeBSD"
44
45#define	getstr(n)	 nlsstr[n]
46
47extern const char *nlsstr[];
48
49#if defined(SORT_THREADS)
50#define	MT_SORT_THRESHOLD (10000)
51extern unsigned int ncpu;
52extern size_t nthreads;
53#endif
54
55/*
56 * If true, we output some debug information.
57 */
58extern bool debug_sort;
59
60/*
61 * MD5 context for random hash function
62 */
63extern MD5_CTX md5_ctx;
64
65/*
66 * sort.c
67 */
68
69/*
70 * This structure holds main sort options which are NOT affecting the sort ordering.
71 */
72struct sort_opts
73{
74	wint_t		field_sep;
75	int		sort_method;
76	bool		cflag;
77	bool		csilentflag;
78	bool		kflag;
79	bool		mflag;
80	bool		sflag;
81	bool		uflag;
82	bool		zflag;
83	bool		tflag;
84	bool		complex_sort;
85};
86
87/*
88 * Key value structure forward declaration
89 */
90struct key_value;
91
92/*
93 * Cmp function
94 */
95typedef int (*cmpcoll_t)(struct key_value *kv1, struct key_value *kv2, size_t offset);
96
97/*
98 * This structure holds "sort modifiers" - options which are affecting the sort ordering.
99 */
100struct sort_mods
101{
102	cmpcoll_t	func;
103	bool		bflag;
104	bool		dflag;
105	bool		fflag;
106	bool		gflag;
107	bool		iflag;
108	bool		Mflag;
109	bool		nflag;
110	bool		rflag;
111	bool		Rflag;
112	bool		Vflag;
113	bool		hflag;
114};
115
116extern bool need_hint;
117
118extern struct sort_opts sort_opts_vals;
119
120extern struct sort_mods * const default_sort_mods;
121
122/*
123 * Cached value of MB_CUR_MAX. Because MB_CUR_MAX is used often throughout the program,
124 * this avoids frequent calls to __mb_cur_max.
125 */
126extern size_t mb_cur_max;
127
128#endif /* __BSD_SORT_H__ */
129