monitのhttpのタイムアウトのコードリーディング

2017-02-21

はじめに

socket_create関数からの流れ

monitのif failed urlのコードリーディングの check_connection 関数の156行目で呼ばれている socket_create 関数の実装を追ってみます。

socket_create 関数の実装。 src/socket.c#L146-#L183

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
Socket_T socket_create(void *port) {
        int socket;
        Socket_T S = NULL;
        Port_T p = port;
        ASSERT(port);
        switch (p->family) {
                case AF_UNIX:
                        socket = create_unix_socket(p->pathname, p->type, p->timeout);
                        break;
                case AF_INET:
                        socket = create_socket(p->hostname, p->port, p->type, p->timeout);
                        break;
                default:
                        LogError("Invalid Port Protocol family\n");
                        return NULL;
        }
        if (socket < 0) {
                LogError("socket_create: Could not create socket -- %s\n", STRERROR);
        } else {
                NEW(S);
                S->socket = socket;
                S->type = p->type;
                S->port = p->port;
                S->timeout = p->timeout;
                S->connection_type = TYPE_LOCAL;
                if (p->family == AF_UNIX) {
                        S->host = Str_dup(LOCALHOST);
                } else {
                        S->host = Str_dup(p->hostname);
                }
                if (p->SSL.use_ssl && !socket_switch2ssl(S, p->SSL)) {
                        socket_free(&S);
                        return NULL;
                }
                S->Port = port;
        }
        return S;
}

create_socket 関数の実装。 src/net.c#L267-#L306

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
int create_socket(const char *hostname, int port, int type, int timeout) {
        int s, status;
        struct sockaddr_in sin;
        struct sockaddr_in *sa;
        struct addrinfo hints;
        struct addrinfo *result;
        ASSERT(hostname);
        memset(&hints, 0, sizeof(struct addrinfo));
        hints.ai_family = AF_INET;

        if((status = getaddrinfo(hostname, NULL, &hints, &result)) != 0) {
                LogError("Cannot translate '%s' to IP address -- %s\n", hostname, status == EAI_SYSTEM ? STRERROR : gai_strerror(status));
                return -1;
        }
        if((s = socket(AF_INET, type, 0)) < 0) {
                LogError("Cannot create socket -- %s\n", STRERROR);
                freeaddrinfo(result);
                return -1;
        }
        sa = (struct sockaddr_in *)result->ai_addr;
        memcpy(&sin, sa, result->ai_addrlen);
        sin.sin_family = AF_INET;
        sin.sin_port = htons(port);
        freeaddrinfo(result);
        if(! Net_setNonBlocking(s)) {
                LogError("Cannot set nonblocking socket -- %s\n", STRERROR);
                goto error;
        }
        if (fcntl(s, F_SETFD, FD_CLOEXEC) == -1) {
                LogError("Cannot set socket close on exec -- %s\n", STRERROR);
                goto error;
        }
        if (do_connect(s, (struct sockaddr *)&sin, sizeof(sin), timeout) < 0) {
                goto error;
        }
        return s;
error:
        Net_close(s);
        return -1;
}

上記の291行目で Net_setNonBlocking 関数を呼び出してソケットをノンブロッキングにしています。

Net_setNonBlocking 関数の実装。

libmonit/src/system/Net.c#L72-#L74

72
73
74
int Net_setNonBlocking(int socket) {
        return (fcntl(socket, F_SETFL, fcntl(socket, F_GETFL, 0) | O_NONBLOCK) != -1);
}

do_connect 関数の実装。 src/net.c#L161-#L199

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
/*
 * Do a non blocking connect, timeout if not connected within timeout milliseconds
 */
static int do_connect(int s, const struct sockaddr *addr, socklen_t addrlen, int timeout) {
        int error = 0;
        struct pollfd fds[1];
        error = connect(s, addr, addrlen);
        if (error == 0) {
                return 0;
        } else if (errno != EINPROGRESS) {
                LogError("Connection failed -- %s\n", STRERROR);
                return -1;
        }
        fds[0].fd = s;
        fds[0].events = POLLIN|POLLOUT;
        error = poll(fds, 1, timeout);
        if (error == 0) {
                LogError("Connection timed out\n");
                return -1;
        } else if (error == -1) {
                LogError("Poll failed -- %s\n", STRERROR);
                return -1;
        }
        if (fds[0].events & POLLIN || fds[0].events & POLLOUT) {
                socklen_t len = sizeof(error);
                if (getsockopt(s, SOL_SOCKET, SO_ERROR, &error, &len) < 0) {
                        LogError("Cannot get socket error -- %s\n", STRERROR);
                        return -1;
                } else if (error) {
                        errno = error;
                        LogError("Socket error -- %s\n", STRERROR);
                        return -1;
                }
        } else {
                LogError("Socket not ready for I/O\n");
                return -1;
        }
        return 0;
}

上記の176行目の epoll でタイムアウトした場合は 177行目の if (error == 0) が成立してエラーで抜けることになります。

socket_write関数からの流れ

monitのif failed urlのコードリーディングの check_http 関数の313行目で呼ばれている socket_write 関数の実装を追ってみます。

socket_write 関数の実装。 src/socket.c#L406-#L429

406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
int socket_write(Socket_T S, void *b, size_t size) {
        ssize_t n = 0;
        void *p = b;
        ASSERT(S);
        while (size > 0) {
                if (S->ssl) {
                        n = send_ssl_socket(S->ssl, p, size, S->timeout);
                } else {
                        if (S->type == SOCK_DGRAM)
                                n = udp_write(S->socket,  p, size, S->timeout);
                        else
                                n = sock_write(S->socket,  p, size, S->timeout);
                }
                if (n <= 0) break;
                p += n;
                size -= n;

        }
        if (n < 0) {
                /* No write or a partial write is an error */
                return -1;
        }
        return  (int)(p - b);
}

上記の417行目で呼んでいる sock_write 関数の実装。 src/net.c#L393-#L395

393
394
395
ssize_t sock_write(int socket, const void *buffer, size_t size, int timeout) {
        return Net_write(socket, buffer, size, timeout);
}

Net_write 関数の実装。 libmonit/src/system/Net.c#L124-#L139

124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
ssize_t Net_write(int socket, const void *buffer, size_t size, time_t timeout) {
	ssize_t n = 0;
        if (size > 0) {
                do {
                        n = write(socket, buffer, size);
                } while (n == -1 && errno == EINTR);
                if (n == -1 && (errno == EAGAIN || errno == EWOULDBLOCK)) {
                        if ((timeout == 0) || (Net_canWrite(socket, timeout) == false))
                                return 0;
                        do {
                                n = write(socket, buffer, size);
                        } while (n == -1 && errno == EINTR);
                }
        }
	return n;
}

Net_canWrite 関数の実装。 libmonit/src/system/Net.c#L94-#L103

 94
 95
 96
 97
 98
 99
100
101
102
103
int Net_canWrite(int socket, time_t milliseconds) {
        int r = 0;
        struct pollfd fds[1];
        fds[0].fd = socket;
        fds[0].events = POLLOUT;
        do {
                r = poll(fds, 1, (int)milliseconds);
        } while (r == -1 && errno == EINTR);
        return (r > 0);
}

socket_readln関数からの流れ

monitのif failed urlのコードリーディングの check_request 関数の208行目と222行目で呼ばれている socket_readln 関数の実装を追ってみます。

socket_readln 関数の実装。 src/socket.c#L453-#L466

453
454
455
456
457
458
459
460
461
462
463
464
465
466
char *socket_readln(Socket_T S, char *s, int size) {
        int c;
        unsigned char *p = (unsigned char *)s;
        ASSERT(S);
        while (--size && ((c = socket_read_byte(S)) > 0)) { // Stop when \0 is read
                *p++ = c;
                if (c == '\n')
                        break;
        }
        *p = 0;
        if (*s)
                return s;
        return NULL;
}

socket_read_byte 関数の実装。 src/socket.c#L432-#L439

432
433
434
435
436
437
438
439
int socket_read_byte(Socket_T S) {
        ASSERT(S);
        if (S->offset >= S->length) {
                if (fill(S, S->timeout) <= 0)
                        return -1;
        }
        return S->buffer[S->offset++];
}

fill 関数の実装。 src/socket.c#L109-#L134

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
/*
 * Fill the internal buffer. If an error occurs or if the read
 * operation timed out -1 is returned.
 * @param S A Socket object
 * @param timeout The number of milliseconds to wait for data to be read
 * @return TRUE (the length of data read) or -1 if an error occured
 */
static int fill(Socket_T S, int timeout) {
        int n;
        S->offset = 0;
        S->length = 0;
        if (S->type == SOCK_DGRAM)
                timeout = 500;
        if (S->ssl) {
                n = recv_ssl_socket(S->ssl, S->buffer + S->length, RBUFFER_SIZE-S->length, timeout);
        } else {
                n = (int)sock_read(S->socket, S->buffer + S->length,  RBUFFER_SIZE-S->length, timeout);
        }
        if (n > 0) {
                S->length += n;
        }  else if (n < 0) {
                return -1;
        } else if (! (errno == EAGAIN || errno == EWOULDBLOCK)) // Peer closed connection
                return -1;
        return n;
}

sock_read 関数の実装。 src/net.c#L398-#L400

398
399
400
ssize_t sock_read(int socket, void *buffer, int size, int timeout) {
        return Net_read(socket, buffer, size, timeout);
}

Net_read 関数の実装。 libmonit/src/system/Net.c#L106-#L121

106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
ssize_t Net_read(int socket, void *buffer, size_t size, time_t timeout) {
	ssize_t n = 0;
        if (size > 0) {
                do {
                        n = read(socket, buffer, size);
                } while (n == -1 && errno == EINTR);
                if (n == -1 && (errno == EAGAIN || errno == EWOULDBLOCK)) {
                        if ((timeout == 0) || (Net_canRead(socket, timeout) == false))
                                return 0;
                        do {
                                n = read(socket, buffer, size);
                        } while (n == -1 && errno == EINTR);
                }
        }
	return n;
}

Net_canRead 関数の実装。 libmonit/src/system/Net.c#L82-#L91

82
83
84
85
86
87
88
89
90
91
int Net_canRead(int socket, time_t milliseconds) {
        int r = 0;
        struct pollfd fds[1];
        fds[0].fd = socket;
        fds[0].events = POLLIN;
        do {
                r = poll(fds, 1, (int)milliseconds);
        } while (r == -1 && errno == EINTR);
        return (r > 0);
}

まとめ

if failed urlでretryとtimeoutを指定しない場合のデフォルトはretry=1, timeout=5秒
retryは名前に反して初回の試行＋追加試行の回数ではなく、全体の試行回数（retry=1だと1回だけ試してリトライ無し）
timeoutはconnect, write, readの個々の操作が指定のタイムアウト内に終わらなければエラー