Use the same mutex for gethostbyname() and gethostbyaddr() to prevent
[privoxy.git] / jcc.h
1 #ifndef JCC_H_INCLUDED
2 #define JCC_H_INCLUDED
3 #define JCC_H_VERSION "$Id: jcc.h,v 1.21 2007/04/22 13:18:06 fabiankeil Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/jcc.h,v $
7  *
8  * Purpose     :  Main file.  Contains main() method, main loop, and 
9  *                the main connection-handling function.
10  *
11  * Copyright   :  Written by and Copyright (C) 2001-2006 the SourceForge
12  *                Privoxy team. http://www.privoxy.org/
13  *
14  *                Based on the Internet Junkbuster originally written
15  *                by and Copyright (C) 1997 Anonymous Coders and 
16  *                Junkbusters Corporation.  http://www.junkbusters.com
17  *
18  *                This program is free software; you can redistribute it 
19  *                and/or modify it under the terms of the GNU General
20  *                Public License as published by the Free Software
21  *                Foundation; either version 2 of the License, or (at
22  *                your option) any later version.
23  *
24  *                This program is distributed in the hope that it will
25  *                be useful, but WITHOUT ANY WARRANTY; without even the
26  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
27  *                PARTICULAR PURPOSE.  See the GNU General Public
28  *                License for more details.
29  *
30  *                The GNU General Public License should be included with
31  *                this file.  If not, you can view it at
32  *                http://www.gnu.org/copyleft/gpl.html
33  *                or write to the Free Software Foundation, Inc., 59
34  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
35  *
36  * Revisions   :
37  *    $Log: jcc.h,v $
38  *    Revision 1.21  2007/04/22 13:18:06  fabiankeil
39  *    Keep the HTTP snippets local.
40  *
41  *    Revision 1.20  2006/12/26 17:31:41  fabiankeil
42  *    Mutex protect rand() if POSIX threading
43  *    is used, warn the user if that's not possible
44  *    and stop using it on _WIN32 where it could
45  *    cause crashes.
46  *
47  *    Revision 1.19  2006/12/06 19:41:39  fabiankeil
48  *    Privoxy is now able to run as intercepting
49  *    proxy in combination with any packet filter
50  *    that does the port redirection. The destination
51  *    is extracted from the "Host:" header which
52  *    should be available for nearly all requests.
53  *
54  *    Moved HTTP snipplets into jcc.c.
55  *    Added error message for gopher proxy requests.
56  *
57  *    Revision 1.18  2006/11/13 19:05:51  fabiankeil
58  *    Make pthread mutex locking more generic. Instead of
59  *    checking for OSX and OpenBSD, check for FEATURE_PTHREAD
60  *    and use mutex locking unless there is an _r function
61  *    available. Better safe than sorry.
62  *
63  *    Fixes "./configure --disable-pthread" and should result
64  *    in less threading-related problems on pthread-using platforms,
65  *    but it still doesn't fix BR#1122404.
66  *
67  *    Revision 1.17  2006/11/06 19:58:23  fabiankeil
68  *    Move pthread.h inclusion from jcc.c to jcc.h.
69  *    Fixes build on x86-freebsd1 (FreeBSD 5.4-RELEASE).
70  *
71  *    Revision 1.16  2006/09/02 15:36:42  fabiankeil
72  *    Follow the OpenBSD port's lead and protect the resolve
73  *    functions on OpenBSD as well.
74  *
75  *    Revision 1.15  2006/09/02 10:24:30  fabiankeil
76  *    Include pthread.h for OpenBSD to make Privoxy build again.
77  *
78  *    Tested shortly on OpenBSD 3.9 without problems, but the OpenBSD
79  *    port has additional patches to use the mutexes OSX_DARWIN needs,
80  *    and it should be investigated if they are still required for
81  *    reliable operation.
82  *
83  *    Revision 1.14  2006/07/18 14:48:46  david__schmidt
84  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
85  *    with what was really the latest development (the v_3_0_branch branch)
86  *
87  *    Revision 1.12.2.3  2006/01/21 16:16:08  david__schmidt
88  *    Thanks to  Edward Carrel for his patch to modernize OSX's\rpthreads support.  See bug #1409623.
89  *
90  *    Revision 1.12.2.2  2005/04/03 20:10:50  david__schmidt
91  *    Thanks to Jindrich Makovicka for a race condition fix for the log
92  *    file.  The race condition remains for non-pthread implementations.
93  *    Reference patch #1175720.
94  *
95  *    Revision 1.12.2.1  2003/03/07 03:41:05  david__schmidt
96  *    Wrapping all *_r functions (the non-_r versions of them) with mutex 
97  *    semaphores for OSX.  Hopefully this will take care of all of those pesky
98  *    crash reports.
99  *
100  *    Revision 1.12  2002/03/26 22:29:55  swa
101  *    we have a new homepage!
102  *
103  *    Revision 1.11  2002/03/24 13:25:43  swa
104  *    name change related issues
105  *
106  *    Revision 1.10  2002/03/16 23:54:06  jongfoster
107  *    Adding graceful termination feature, to help look for memory leaks.
108  *    If you enable this (which, by design, has to be done by hand
109  *    editing config.h) and then go to http://i.j.b/die, then the program
110  *    will exit cleanly after the *next* request.  It should free all the
111  *    memory that was used.
112  *
113  *    Revision 1.9  2002/03/07 03:52:44  oes
114  *    Set logging to tty for --no-daemon mode
115  *
116  *    Revision 1.8  2002/03/04 18:19:49  oes
117  *    Added extern const char *pidfile
118  *
119  *    Revision 1.7  2001/11/05 21:41:43  steudten
120  *    Add changes to be a real daemon just for unix os.
121  *    (change cwd to /, detach from controlling tty, set
122  *    process group and session leader to the own process.
123  *    Add DBG() Macro.
124  *    Add some fatal-error log message for failed malloc().
125  *    Add '-d' if compiled with 'configure --with-debug' to
126  *    enable debug output.
127  *
128  *    Revision 1.6  2001/07/30 22:08:36  jongfoster
129  *    Tidying up #defines:
130  *    - All feature #defines are now of the form FEATURE_xxx
131  *    - Permanently turned off WIN_GUI_EDIT
132  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
133  *
134  *    Revision 1.5  2001/07/29 19:32:00  jongfoster
135  *    Renaming _main() [mingw32 only] to real_main(), for ANSI compliance.
136  *
137  *    Revision 1.4  2001/07/29 18:58:15  jongfoster
138  *    Removing nested #includes, adding forward declarations for needed
139  *    structures, and changing the #define _FILENAME_H to FILENAME_H_INCLUDED.
140  *
141  *    Revision 1.3  2001/07/18 12:31:58  oes
142  *    moved #define freez from jcc.h to project.h
143  *
144  *    Revision 1.2  2001/05/31 21:24:47  jongfoster
145  *    Changed "permission" to "action" throughout.
146  *    Removed DEFAULT_USER_AGENT - it must now be specified manually.
147  *    Moved vanilla wafer check into chat(), since we must now
148  *    decide whether or not to add it based on the URL.
149  *
150  *    Revision 1.1.1.1  2001/05/15 13:58:56  oes
151  *    Initial import of version 2.9.3 source tree
152  *
153  *
154  *********************************************************************/
155 \f
156
157 #ifdef __cplusplus
158 extern "C" {
159 #endif
160
161 struct client_state;
162 struct file_list;
163
164 /* Global variables */
165
166 #ifdef FEATURE_STATISTICS
167 extern int urls_read;
168 extern int urls_rejected;
169 #endif /*def FEATURE_STATISTICS*/
170
171 extern struct client_state clients[1];
172 extern struct file_list    files[1];
173
174 #ifdef unix
175 extern const char *pidfile;
176 #endif
177 extern int no_daemon;
178
179 #ifdef FEATURE_GRACEFUL_TERMINATION
180 extern int g_terminate;
181 #endif
182
183 #ifdef FEATURE_PTHREAD
184 #include <pthread.h>
185 extern pthread_mutex_t log_mutex;
186 extern pthread_mutex_t log_init_mutex;
187
188 #ifndef HAVE_GMTIME_R
189 extern pthread_mutex_t gmtime_mutex;
190 #endif /* ndef HAVE_GMTIME_R */
191
192 #ifndef HAVE_LOCALTIME_R
193 extern pthread_mutex_t localtime_mutex;
194 #endif /* ndef HAVE_GMTIME_R */
195
196 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
197 extern pthread_mutex_t resolver_mutex;
198 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
199
200 #ifndef HAVE_RANDOM
201 extern pthread_mutex_t rand_mutex;
202 #endif /* ndef HAVE_RANDOM */
203
204 #endif /* FEATURE_PTHREAD */
205
206 /* Functions */
207
208 #ifdef __MINGW32__
209 int real_main(int argc, const char *argv[]);
210 #else
211 int main(int argc, const char *argv[]);
212 #endif
213
214 /* Revision control strings from this header and associated .c file */
215 extern const char jcc_rcs[];
216 extern const char jcc_h_rcs[];
217
218 #ifdef __cplusplus
219 } /* extern "C" */
220 #endif
221
222 #endif /* ndef JCC_H_INCLUDED */
223
224 /*
225   Local Variables:
226   tab-width: 3
227   end:
228 */