aboutsummaryrefslogtreecommitdiff
path: root/libpkgconf/stdinc.h
blob: 418a06a84b01951ffd50b4dae74d0cef1f57a419 (plain)
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
/*
 * stdinc.h
 * pull in standard headers (including portability hacks)
 *
 * Copyright (c) 2012 pkgconf authors (see AUTHORS).
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * This software is provided 'as is' and without any warranty, express or
 * implied.  In no event shall the authors be liable for any damages arising
 * from the use of this software.
 */

#ifndef __STDINC_H
#define __STDINC_H

#include <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <stddef.h>
#include <stdbool.h>
#include <stdarg.h>
#include <string.h>
#include <sys/types.h>
#include <stdint.h>

/*
 * The original libpkgconf package uses PKGCONF_BUFSIZE size for all
 * stack-allocated buffers, imposing high requirements for the thread stack
 * size. This make it unusable on MacOS (as of 10.12) for non-main threads that
 * are created with the default 512KB stack size. In particular that make it
 * impossible to use libpkgconf API in threads created with C++11 std::thread
 * class, that doesn't allow stack size customization.
 *
 * As an example, using pkgconf_pkg_find() for quite a simple .pc file consumes
 * at least 460KB. The measurement was made as a difference between addresses
 * of 2 stack-allocated variables: one was defined right before the function
 * call, another right after the buffer definition in pkgconf_tuple_parse()
 * function.
 *
 * To relax the stack size requirements we will minimize the usage of
 * PKGCONF_BUFSIZE, inventing the smaller PKGCONF_ITEM_SIZE, and using it
 * wherever it is possible instead. The PKGCONF_ITEM_SIZE is selected in such a
 * way that a buffer of this size can accommodate the file system path, the
 * value fragment, the variable name or the package dependency specification.
 * The latest implies it also fits for the package key or the package version.
 * This optimization decreased the stack usage for the described use case to
 * 140KB.
 *
 * Issue #149 is reported.
 */
#ifdef _WIN32
# define WIN32_LEAN_AND_MEAN
# include <windows.h>
# include <malloc.h>
# define PATH_DEV_NULL	"nul"
# ifdef _WIN64
#  define SIZE_FMT_SPECIFIER	"%I64u"
# else
#  define SIZE_FMT_SPECIFIER	"%u"
# endif
# ifndef ssize_t
# ifndef __MINGW32__
#  include <BaseTsd.h>
# else
#  include <basetsd.h>
# endif
#  define ssize_t SSIZE_T
# endif
# ifndef __MINGW32__
#  include "win-dirent.h"
# else
# include <dirent.h>
# endif
# define PKGCONF_ITEM_SIZE (_MAX_PATH + 1024)
#else
# define PATH_DEV_NULL	"/dev/null"
# define SIZE_FMT_SPECIFIER	"%zu"
# include <dirent.h>
# include <unistd.h>
# include <limits.h>
# ifdef PATH_MAX
#  define PKGCONF_ITEM_SIZE (PATH_MAX + 1024)
# else
#  define PKGCONF_ITEM_SIZE (4096 + 1024)
# endif
#endif

#endif