summaryrefslogtreecommitdiff
path: root/src/common/netbuffer.c
blob: 9ce13ffc31150e0c2568cf27fec54b77158cba04 (plain) (blame)
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
//
// Network Buffer Subsystem (iobuffer)
//
//
// Author: Florian Wilkemeyer <fw@f-ws.de>
//
// Copyright (c) rAthena Project (www.rathena.org) - Licensed under GNU GPL
// For more information, see LICENCE in the main folder
//
//

#include <stdlib.h>
#include <string.h>
#include <stdio.h>

#include "../common/cbasetypes.h"
#include "../common/atomic.h"
#include "../common/mempool.h"
#include "../common/showmsg.h"
#include "../common/raconf.h"
#include "../common/thread.h"
#include "../common/malloc.h"
#include "../common/core.h"

#include "../common/netbuffer.h"


//
// Buffers are available in the following sizes:
//  48,     192,    2048,       8192
//  65536 (inter server connects may use it for charstatus struct..)
//


///
// Implementation:
//
static volatile int32 l_nEmergencyAllocations = 0; // stats.
static sysint l_nPools = 0;
static sysint *l_poolElemSize = NULL;
static mempool *l_pool = NULL;


void netbuffer_init()
{
    char localsection[32];
    raconf conf;
    sysint i;

    // Initialize Statistic counters:
    l_nEmergencyAllocations = 0;

    // Set localsection name according to running serverype.
    switch (SERVER_TYPE) {
        case ATHENA_SERVER_LOGIN:
            strcpy(localsection, "login-netbuffer");
            break;
        case ATHENA_SERVER_CHAR:
            strcpy(localsection, "char-netbuffer");
            break;
        case ATHENA_SERVER_INTER:
            strcpy(localsection, "inter-netbuffer");
            break;
        case ATHENA_SERVER_MAP:
            strcpy(localsection, "map-netbuffer");
            break;
        default:
            strcpy(localsection, "unsupported_type");
            break;
    }


    conf = raconf_parse("conf/network.conf");
    if (conf == NULL) {
        ShowFatalError("Failed to Parse required Configuration (conf/network.conf)");
        exit(EXIT_FAILURE);
    }

    // Get Values from config file
    l_nPools = (sysint)raconf_getintEx(conf,  localsection,  "netbuffer", "num", 0);
    if (l_nPools == 0) {
        ShowFatalError("Netbuffer (network.conf) failure - requires at least 1 Pool.\n");
        exit(EXIT_FAILURE);
    }

    // Allocate arrays.
    l_poolElemSize = (sysint *)aCalloc(l_nPools, sizeof(sysint));
    l_pool = (mempool *)aCalloc(l_nPools, sizeof(mempool));


    for (i = 0; i < l_nPools; i++) {
        int64 num_prealloc, num_realloc;
        char key[32];

        sprintf(key, "pool_%u_size", (uint32)i+1);
        l_poolElemSize[i] = (sysint)raconf_getintEx(conf, localsection, "netbuffer", key, 4096);
        if (l_poolElemSize[i] < 32) {
            ShowWarning("Netbuffer (network.conf) failure - minimum allowed buffer size is 32 byte) - fixed.\n");
            l_poolElemSize[i] = 32;
        }

        sprintf(key, "pool_%u_prealloc", (uint32)i+1);
        num_prealloc = raconf_getintEx(conf, localsection, "netbuffer", key, 150);

        sprintf(key, "pool_%u_realloc_step", (uint32)i+1);
        num_realloc = raconf_getintEx(conf, localsection, "netbuffer", key, 100);

        // Create Pool!
        sprintf(key, "Netbuffer %u", (uint32)l_poolElemSize[i]); // name.

        // Info
        ShowInfo("NetBuffer: Creating Pool %u (Prealloc: %u, Realloc Step: %u) - %0.2f MiB\n", l_poolElemSize[i], num_prealloc, num_realloc, (float)((sizeof(struct netbuf) + l_poolElemSize[i] - 32)* num_prealloc)/1024.0f/1024.0f);

        //
        // Size Calculation:
        //  struct netbuf  +  requested buffer size - 32 (because the struct already contains 32 byte buffer space at the end of struct)
        l_pool[i] = mempool_create(key, (sizeof(struct netbuf) + l_poolElemSize[i] - 32),  num_prealloc,  num_realloc, NULL, NULL);
        if (l_pool[i] == NULL) {
            ShowFatalError("Netbuffer: cannot create Pool for %u byte buffers.\n", l_poolElemSize[i]);
            // @leak: clean everything :D
            exit(EXIT_FAILURE);
        }

    }//


    raconf_destroy(conf);

}//end: netbuffer_init()


void netbuffer_final()
{
    sysint i;

    if (l_nPools > 0) {
        /// .. finalize mempools
        for (i = 0; i < l_nPools; i++) {
            mempool_stats stats = mempool_get_stats(l_pool[i]);

            ShowInfo("Netbuffer: Freeing Pool %u (Peak Usage: %u, Realloc Events: %u)\n", l_poolElemSize[i], stats.peak_nodes_used, stats.num_realloc_events);

            mempool_destroy(l_pool[i]);
        }

        if (l_nEmergencyAllocations > 0) {
            ShowWarning("Netbuffer: did %u Emergency Allocations, please tune your network.conf!\n", l_nEmergencyAllocations);
            l_nEmergencyAllocations = 0;
        }

        aFree(l_poolElemSize);
        l_poolElemSize = NULL;
        aFree(l_pool);
        l_pool = NULL;
        l_nPools = 0;
    }


}//end: netbuffer_final()


netbuf netbuffer_get(sysint sz)
{
    sysint i;
    netbuf nb = NULL;

    // Search an appropriate pool
    for (i = 0; i < l_nPools; i++) {
        if (sz <= l_poolElemSize[i]) {
            // match

            nb = (netbuf)mempool_node_get(l_pool[i]);
            nb->pool = i;

            break;
        }
    }

    // No Bufferpool found that mets there quirements?.. (thats bad..)
    if (nb == NULL) {
        ShowWarning("Netbuffer: get(%u): => no appropriate pool found - emergency allocation required.\n", sz);
        ShowWarning("Please reconfigure your network.conf!");

        InterlockedIncrement(&l_nEmergencyAllocations);

        // .. better to check (netbuf struct provides 32 byte bufferspace itself.
        if (sz < 32) sz = 32;

        // allocate memory using malloc ..
        while (1) {
            nb = (netbuf) aMalloc((sizeof(struct netbuf) + sz - 32));
            if (nb != NULL) {
                memset(nb, 0x00, (sizeof(struct netbuf) + sz - 32));  // zero memory! (to enforce commit @ os.)
                nb->pool = -1; // emergency alloc.
                break;
            }

            rathread_yield();
        }// spin allocation.

    }


    nb->refcnt = 1;  // Initial refcount is 1

    return nb;
}//end: netbuffer_get()


void netbuffer_put(netbuf nb)
{

    // Decrement reference counter, if > 0 do nothing :)
    if (InterlockedDecrement(&nb->refcnt) > 0)
        return;

    // Is this buffer an emergency allocated buffer?
    if (nb->pool == -1) {
        aFree(nb);
        return;
    }


    // Otherwise its a normal mempool based buffer
    // return it to the according mempool:
    mempool_node_put(l_pool[nb->pool], nb);


}//end: netbuffer_put()


void netbuffer_incref(netbuf nb)
{

    InterlockedIncrement(&nb->refcnt);

}//end: netbuf_incref()