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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<TITLE>
FastCGI Programmer's Guide - Chapter 2, Developing FastCGI Applications in C
</TITLE>
<STYLE TYPE="text/css">
body {
background-color: #ffffff;
}
li.c2 {list-style: none}
div.c1 {text-align: center}
</STYLE>
</HEAD>
<BODY>
<A HREF="cover.htm">[Top]</A> <A HREF="ch1intro.htm">[Prev]</A> <A HREF="ch3perl.htm">[Next]</A> <A HREF=
"ap_guida.htm">[Bottom]</A>
<HR>
<BR>
<A NAME="3659"></A>
<DIV CLASS="c1">
<H1>
2 Developing FastCGI<BR>
Applications in C
</H1>
</DIV>
<A NAME="917"></A>
<P>
This chapter explains how to code FastCGI applications in C and how to build them into executables.
</P>
<P>
<A NAME="4230"></A> If you are converting a CGI application into a FastCGI application, in many cases you will
only need to add a few lines of code. For more complex applications, you may also need to rearrange some code.
</P>
<BR>
<BR>
<H1>
The I/O Libraries
</H1>
<A NAME="5384"></A>
<P>
The FastCGI Software Development Kit that accompanies Open Market WebServer 2.0 includes I/O libraries to
simplify the job of converting existing CGI applications to FastCGI or writing new FastCGI applications. There
are two libraries in the kit: fcgi_stdio and fcgiapp. You must include one of these header files in your
program:
</P>
<BR>
<BR>
<UL>
<LI CLASS="c2">
<A NAME="5386"></A>
</LI>
<LI>
<CODE>fcgi_stdio.h</CODE> <A NAME="4237"></A>
</LI>
<LI>
<CODE>fcgiapp.h</CODE>
</LI>
</UL>
<A NAME="4199"></A>
<P>
The <CODE>fcgi_stdio</CODE> library is a layer on top of the <CODE>fcgiapp</CODE> library, and we recommend
strongly that you use it, both for converting existing CGI applications and for writing new FastCGI
applications. The fcgi_stdio library offers several advantages:
</P>
<BR>
<BR>
<UL>
<LI CLASS="c2">
<A NAME="5811"></A>
</LI>
<LI>
Simplicity: there are only 3 new API calls to learn <A NAME="5828"></A>
</LI>
<LI>
Familiarity: If you are converting a CGI application to FastCGI, you will find few changes between CGI and
FastCGI. We designed our library to make the job of building a FastCGI application as similar as possible
to that of building a FastCGI application: you use the same environment variables, same techniques for
parsing query strings, the same I/O routines, and so on. <A NAME="5817"></A>
</LI>
<LI>
Convenience: the library provides full binary compatibility between CGI and FastCGI. That is, you can run
the same binary as either CGI or FastCGI.
</LI>
</UL>
<A NAME="5399"></A>
<P>
The fcgiapp library is more specific to FastCGI, without trying to provide the veneer of familiarity with CGI.
This manual describes the fcgi_stdio library; the fcgiapp library is documented in the header files that
accompany the development kit.
</P>
<BR>
<BR>
<H1>
Code Structure
</H1>
<A NAME="4240"></A>
<P>
To structure code for FastCGI, you separate your code into two sections:
</P>
<BR>
<BR>
<UL>
<LI CLASS="c2">
<A NAME="4200"></A>
</LI>
<LI>
Initialization section, which is executed only once. <A NAME="4201"></A>
</LI>
<LI>
Response loop section, which gets executed every time the FastCGI script gets called.
</LI>
</UL>
<A NAME="4202"></A>
<P>
A response loop typically has the following format:
</P>
<BR>
<BR>
<PRE>
<A NAME="4203">while (FCGI_Accept() >= 0) {
</A>
<A NAME="4204"># body of response loop
</A>
<A NAME="4205">}
</A>
</PRE>
<A NAME="4206"></A>
<P>
The <CODE>FCGI_Accept</CODE> blocks until a client request comes in, and then returns 0. If there is a system
failure, or the system administrator terminates the process, Accept will return -1.
</P>
<P>
<A NAME="5852"></A> If the application was invoked as a CGI program, the first call to Accept returns 0 and
the second always returns -1, producing CGI behavior. (See <A HREF="apaman.htm#95683">"FCGI_Accept
(3)" on page 21</A> for details.)
</P>
<P>
<A NAME="5909"></A> Also note that the CGI world encourages small scripts, whereas FastCGI encourages
combining scripts. You may choose to rethink the overall structure of your applications to take better
advantage of FastCGI performance gains.
</P>
<BR>
<BR>
<H1>
Example 1: TinyFastCGI
</H1>
<A NAME="4263">Here is a simple example of a responder FastCGI application written in C:</A><BR>
<BR>
<PRE>
#include "fcgi_stdio.h" /* fcgi library; put it first*/<BR>
#include <stdlib.h>
int count;
void initialize(void)
{
count=0;
}
void main(void)
{
/* Initialization. */
initialize();
/* Response loop. */
while (FCGI_Accept() >= 0) {
printf("Content-type: text/html\r\n"
"\r\n"
"<title>FastCGI Hello! (C, fcgi_stdio library)</title>"
"<h1>FastCGI Hello! (C, fcgi_stdio library)</h1>"
"Request number %d running on host <i>%s</i>\n",
++count, getenv("SERVER_HOSTNAME"));
}
}
</PRE>
<H1>
Example 2: Prime Number Generator
</H1>
<A NAME="4182"></A>
<P>
Consider a responder application that generates the n-th prime number.
</P>
<P>
<A NAME="5217"></A> A CGI application would have no efficient way of solving this problem. For example, if the
user asks for the 50,000th prime number, a CGI application would have to calculate the first prime number,
then the second, and so on, up until the 50,000th. The application would then terminate, taking with it all
its hard-earned calculations. If a client then asks for the 49,000th prime number, the server will have to
spawn a new CGI application which will have to start calculating prime numbers from scratch.
</P>
<P>
<A NAME="4315"></A> FastCGI applications can be much more efficient at this sort of problem, since they can
maintain state. A FastCGI application can calculate an extensive table of prime numbers in its initialization
phase and then keep the table around indefinitely. Whenever a client requests a particular prime number, the
response loop merely needs to look it up in the table.
</P>
<P>
<A NAME="4343"></A> Here is the code for the prime number example:
</P>
<BR>
<BR>
<PRE>
#include "fcgi_stdio.h"
#include <stdlib.h>
#include <string.h>
#define POTENTIALLY_PRIME 0
#define COMPOSITE 1
#define VALS_IN_SIEVE_TABLE 1000000
#define MAX_NUMBER_OF_PRIME_NUMBERS 78600
/* All initialized to POTENTIALLY_PRIME */
long int sieve_table[VALS_IN_SIEVE_TABLE];
long int prime_table[MAX_NUMBER_OF_PRIME_NUMBERS];
/* Use Sieve of Erastothenes method of building
a prime number table. */
void
initialize_prime_table(void)
{
long int prime_counter=1;
long int current_prime=2, c, d;
prime_table[prime_counter]=current_prime;
while (current_prime < VALS_IN_SIEVE_TABLE) {
/* Mark off composite numbers. */
for (c = current_prime; c <= VALS_IN_SIEVE_TABLE;
c += current_prime) {
sieve_table[c] = COMPOSITE;
}
/* Find the next prime number. */
for (d=current_prime+1; sieve_table[d] == COMPOSITE; d++);
/* Put the new prime number into the table. */
prime_table[++prime_counter]=d;
current_prime=d;
}
}
void main(void)
{
char *query_string;
long int n;
initialize_prime_table();
while(FCGI_Accept() >= 0) {
/*
* Produce the necessary HTTP header.
*/
printf("Content-type: text/html\r\n"
"\r\n");
/*
* Produce the constant part of the HTML document.
*/
printf("<title>Prime FastCGI</title>\n"
"<h1>Prime FastCGI</h1>\n");
/*
* Read the query string and produce the variable part
* of the HTML document.
*/
query_string = getenv("QUERY_STRING");
if(query_string == NULL) {
printf("Usage: Specify a positive number in the query string.\n");
} else {
query_string = strchr(query_string, `=') + 1;
n = strtol(query_string);
if(n < 1) {
printf("The query string `%s' is not a positive number.\n",
query_string);
} else if(n > MAX_NUMBER_OF_PRIME_NUMBERS) {
printf("The number %d is too large for this program.\n", n);
} else
printf("The %ldth prime number is %ld.\n", n, prime_table[n]);
}
}
} /* while FCGI_Accept */
}
</PRE>
<A NAME="5349"></A>
<P>
This application has a noticeable start up cost while it initializes the table, but subsequent accesses are
fast.
</P>
<BR>
<BR>
<H1>
Building
</H1>
<A NAME="4630"></A>
<P>
This section explains how to build and debug FastCGI applications written in C.
</P>
<P>
<A NAME="4629"></A> The C preprocessor needs to know the location of the <CODE>fcgi_stdio.h</CODE> header
file, which is at the following pathname:
</P>
<BR>
<BR>
<PRE>
<A NAME="4642"><EM>$toolkit</EM>/include/fcgi_stdio.h
</A>
</PRE>
<A NAME="4645"></A>
<P>
where <EM>$toolkit</EM> symbolizes the directory in which you have installed the Software Development Kit for
FastCGI.
</P>
<P>
<A NAME="4760"></A> The linker needs to know the location of the <CODE>libfcgi.a</CODE> library file, which is
at the following pathname:
</P>
<BR>
<BR>
<PRE>
<A NAME="4647"><EM>$toolkit</EM>/libfcgi/libfcgi.a
</A>
</PRE>
<A NAME="4648"></A>
<P>
If your linker does not search the Berkeley socket library, then you must add linker directives to force this
search.
</P>
<P>
<A NAME="4773"></A> We provide a sample application <CODE>Makefile</CODE> at the following pathname:
</P>
<BR>
<BR>
<PRE>
<A NAME="4649"><EM>$toolkit</EM>/examples/Makefile
</A>
</PRE>
<A NAME="4652"></A>
<P>
This <CODE>Makefile</CODE> contains the necessary rules and pathnames to build the C FastCGI applications
accompanying the toolkit. To build all the applications, type:
</P>
<BR>
<BR>
<PRE>
<A NAME="4653">$ ./configure<BR>
$ make
</A>
</PRE>
<H1>
Memory Leaks
</H1>
<A NAME="4178"></A>
<P>
Memory leaks are seldom a problem in CGI programming because CGI applications rarely run long enough to be
concerned with leaks. However, memory leaks can become a problem in FastCGI applications, particularly if each
call to a popular FastCGI application causes additional memory to leak.
</P>
<P>
<A NAME="4785"></A> When converting to FastCGI, you can either use a tool such as Purify from Pure Software to
discover and fix storage leaks or you can run a C garbage collector such as Great Circle from Geodesic
Systems.
</P>
<P>
<A NAME="4972"></A>
</P>
<P>
</P>
<HR>
<BR>
<A HREF="cover.htm">[Top]</A> <A HREF="ch1intro.htm">[Prev]</A> <A HREF="ch3perl.htm">[Next]</A> <A HREF=
"ap_guida.htm">[Bottom]</A>
<HR>
<BR>
<!-- This file was created with Quadralay WebWorks Publisher 3.0.3 -->
<!-- -->
<!-- For more information on how this document, and how the rest of -->
<!-- this server was created, email yourEmail@xyzcorp.com -->
<!-- -->
<!-- Last updated: 04/15/96 08:00:16 -->
</BODY>
</HTML>
|
