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
|
/*
* ProFTPD - FTP server daemon
* Copyright (c) 2001-2015 The ProFTPD Project team
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA.
*
* As a special exemption, The ProFTPD Project and other respective copyright
* holders give permission to link this program with OpenSSL, and distribute
* the resulting executable, without including the source code for OpenSSL in
* the source distribution.
*/
/* Scoreboard routines */
#ifndef PR_SCOREBOARD_H
#define PR_SCOREBOARD_H
/* PR_SCOREBOARD_VERSION is used for checking for scoreboard compatibility
*/
#define PR_SCOREBOARD_VERSION 0x01040003
/* Structure used as a header for scoreboard files.
*/
#define PR_SCOREBOARD_MAGIC 0xdeadbeef
typedef struct {
/* Always 0xDEADBEEF */
unsigned long sch_magic;
/* Version of proftpd that created the scoreboard file */
unsigned long sch_version;
/* PID of the process to which this scoreboard belongs, or zero if inetd */
pid_t sch_pid;
/* Time when the daemon wrote this header */
time_t sch_uptime;
} pr_scoreboard_header_t;
/* Structure used for writing scoreboard file entries.
*/
typedef struct {
pid_t sce_pid;
uid_t sce_uid;
gid_t sce_gid;
char sce_user[32];
int sce_server_port;
char sce_server_addr[80], sce_server_label[32];
#ifdef PR_USE_IPV6
char sce_client_addr[INET6_ADDRSTRLEN];
#else
char sce_client_addr[INET_ADDRSTRLEN];
#endif /* PR_USE_IPV6 */
char sce_client_name[PR_TUNABLE_SCOREBOARD_BUFFER_SIZE];
char sce_class[32];
char sce_protocol[32];
char sce_cwd[PR_TUNABLE_SCOREBOARD_BUFFER_SIZE];
char sce_cmd[65];
char sce_cmd_arg[PR_TUNABLE_SCOREBOARD_BUFFER_SIZE];
time_t sce_begin_idle, sce_begin_session;
/* Records the number of bytes to be transferred, and the number of bytes
* transferred so far. These two numbers are used to calculate the
* percentage of data transferred in the ftptop/ftpwho utilities.
*
* Note that for uploads, we do not know the full size of the data being
* uploaded, hence we cannot show a percentage; we can only display/record
* how many bytes have been transferred so far.
*/
off_t sce_xfer_size;
off_t sce_xfer_done;
/* Records the number of bytes transferred, and the elapsed time. These
* two fields are used to calculate the transfer rate as displayed by
* the ftptop/ftpwho utilities.
*/
off_t sce_xfer_len;
unsigned long sce_xfer_elapsed;
} pr_scoreboard_entry_t;
/* Scoreboard mode */
#define PR_SCOREBOARD_MODE 0644
/* Scoreboard update tags */
#define PR_SCORE_USER 1
#define PR_SCORE_CLIENT_ADDR 2
#define PR_SCORE_CLIENT_NAME 3
#define PR_SCORE_CLASS 4
#define PR_SCORE_CWD 5
#define PR_SCORE_CMD 6
#define PR_SCORE_CMD_ARG 7
#define PR_SCORE_SERVER_PORT 8
#define PR_SCORE_SERVER_ADDR 9
#define PR_SCORE_SERVER_LABEL 10
#define PR_SCORE_XFER_DONE 11
#define PR_SCORE_XFER_SIZE 12
#define PR_SCORE_BEGIN_IDLE 13
#define PR_SCORE_BEGIN_SESSION 14
#define PR_SCORE_XFER_LEN 15
#define PR_SCORE_XFER_ELAPSED 16
#define PR_SCORE_PROTOCOL 17
/* Scoreboard error values */
#define PR_SCORE_ERR_BAD_MAGIC -2
#define PR_SCORE_ERR_OLDER_VERSION -3
#define PR_SCORE_ERR_NEWER_VERSION -4
const char *pr_get_scoreboard(void);
const char *pr_get_scoreboard_mutex(void);
int pr_lock_scoreboard(int, int);
int pr_set_scoreboard(const char *);
int pr_set_scoreboard_mutex(const char *);
int pr_close_scoreboard(int keep_mutex);
void pr_delete_scoreboard(void);
int pr_open_scoreboard(int);
int pr_restore_scoreboard(void);
int pr_rewind_scoreboard(void);
pid_t pr_scoreboard_get_daemon_pid(void);
time_t pr_scoreboard_get_daemon_uptime(void);
int pr_scoreboard_scrub(void);
int pr_scoreboard_entry_add(void);
int pr_scoreboard_entry_del(unsigned char);
pr_scoreboard_entry_t *pr_scoreboard_entry_read(void);
const char *pr_scoreboard_entry_get(int);
int pr_scoreboard_entry_kill(pr_scoreboard_entry_t *, int);
int pr_scoreboard_entry_update(pid_t, ...);
int pr_scoreboard_entry_lock(int, int);
#endif /* PR_SCOREBOARD_H */
|
