srs_app_bandwidth.cpp 15.8 KB
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 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
/*
The MIT License (MIT)

Copyright (c) 2013-2014 wenjiegit

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#include <srs_app_bandwidth.hpp>

#include <arpa/inet.h>
#include <sstream>

using namespace std;

#include <srs_protocol_rtmp.hpp>
#include <srs_kernel_error.hpp>
#include <srs_protocol_amf0.hpp>
#include <srs_protocol_rtmp_stack.hpp>
#include <srs_app_config.hpp>
#include <srs_core_autofree.hpp>
#include <srs_kernel_utility.hpp>

SrsBandwidth::SrsBandwidth()
{
}

SrsBandwidth::~SrsBandwidth()
{
}

int SrsBandwidth::bandwidth_test(SrsRequest* _req, st_netfd_t stfd, SrsRtmpServer* _rtmp)
{
    int ret = ERROR_SUCCESS;
    
    rtmp = _rtmp;
    req = _req;
    
    if (!_srs_config->get_bw_check_enabled(req->vhost)) {
        return ret;
    }

    // validate the bandwidth check key
    std::string key = "key=" + _srs_config->get_bw_check_key(req->vhost);
    if (req->tcUrl.find(key) == std::string::npos) {
        ret = ERROR_SYSTEM_BANDWIDTH_KEY;
        srs_error("check the vhost=%s %s failed, tcUrl=%s, ret=%d", 
            req->vhost.c_str(), key.c_str(), req->tcUrl.c_str(), ret);
        return ret;
    }
    
    // shared global last check time,
    // to avoid attach by bandwidth check,
    // if client request check in the window(specifeid by interval),
    // directly reject the request.
    static int64_t last_check_time = 0;
    int interval_ms = _srs_config->get_bw_check_interval_ms(req->vhost);
    
    int64_t time_now = srs_get_system_time_ms();
    // reject the connection in the interval window.
    if (last_check_time > 0 && time_now - last_check_time < interval_ms) {
        ret = ERROR_SYSTEM_BANDWIDTH_DENIED;
        srs_trace("bandcheck denied, "
            "last_check=%"PRId64", now=%"PRId64", interval=%d",
            last_check_time, time_now, interval_ms);
            
        rtmp->response_connect_reject(req, "bandcheck rejected");
        return ret;
    }
    
    // accept and do bandwidth check.
    last_check_time = time_now;
    
    char* local_ip = 0;
    if ((ret = get_local_ip(stfd, local_ip)) != ERROR_SUCCESS) {
        srs_error("get local ip failed. ret = %d", ret);
        return ret;
    }

    if ((ret = rtmp->response_connect_app(req, local_ip)) != ERROR_SUCCESS) {
        srs_error("response connect app failed. ret=%d", ret);
        return ret;
    }

    return do_bandwidth_check();
}

int SrsBandwidth::get_local_ip(st_netfd_t stfd, char *&local_ip)
{
    int ret = ERROR_SUCCESS;

    int fd = st_netfd_fileno(stfd);

    // discovery client information
    sockaddr_in addr;
    socklen_t addrlen = sizeof(addr);
    if (getsockname(fd, (sockaddr*)&addr, &addrlen) == -1) {
        ret = ERROR_SOCKET_GET_LOCAL_IP;
        srs_error("discovery local ip information failed. ret=%d", ret);
        return ret;
    }
    srs_verbose("get local ip success.");

    // ip v4 or v6
    char buf[INET6_ADDRSTRLEN];
    memset(buf, 0, sizeof(buf));

    if ((inet_ntop(addr.sin_family, &addr.sin_addr, buf, sizeof(buf))) == NULL) {
        ret = ERROR_SOCKET_GET_LOCAL_IP;
        srs_error("convert local ip information failed. ret=%d", ret);
        return ret;
    }

    local_ip = new char[strlen(buf) + 1];
    strcpy(local_ip, buf);

    srs_verbose("get local ip of client ip=%s, fd=%d", buf, fd);

    return ret;
}

int SrsBandwidth::do_bandwidth_check()
{
    int ret = ERROR_SUCCESS;
    
    SrsProtocol* protocol = rtmp->get_protocol();

    int play_duration_ms        = 3000;
    int play_interval_ms        = 0;
    int play_actual_duration_ms = 0;
    int play_bytes              = 0;

    int publish_duration_ms        = 3000;
    int publish_interval_ms        = 0;
    int publish_actual_duration_ms = 0;
    int publish_bytes              = 0;
    
    int limit_kbps = _srs_config->get_bw_check_limit_kbps(req->vhost);

    int64_t start_time = srs_get_system_time_ms();
    
    ret = check_play(play_duration_ms, 
        play_interval_ms, play_actual_duration_ms, play_bytes, limit_kbps);
    if (ret != ERROR_SUCCESS) {
        srs_error("band width play check failed. ret=%d", ret);
        return ret;
    }
    
    ret = check_publish(publish_duration_ms, 
        publish_interval_ms, publish_actual_duration_ms, publish_bytes, limit_kbps);
    if (ret != ERROR_SUCCESS) {
        srs_error("band width publish check failed. ret=%d", ret);
        return ret;
    }

    int64_t end_time = srs_get_system_time_ms();
    int play_kbps = play_bytes * 8 / play_actual_duration_ms;
    int publish_kbps = publish_bytes * 8 / publish_actual_duration_ms;

    srs_trace("bandwidth check finished. start=%"PRId64"ms, end=%"PRId64"ms, "
        "duartion=%dms, play=%dkbps, publish=%dkbps, tcUrl=%s, ret=%#x", 
        start_time, end_time, (int)(end_time - start_time), play_kbps, publish_kbps, 
        req->tcUrl.c_str(), ret);

    // send finished msg
    SrsBandwidthPacket* pkt = SrsBandwidthPacket::create_finish();
    pkt->data->set("code",           SrsAmf0Any::number(ERROR_SUCCESS));
    pkt->data->set("start_time",     SrsAmf0Any::number(start_time));
    pkt->data->set("end_time",       SrsAmf0Any::number(end_time));
    pkt->data->set("play_kbps",      SrsAmf0Any::number(play_kbps));
    pkt->data->set("publish_kbps",   SrsAmf0Any::number(publish_kbps));
    pkt->data->set("play_bytes",     SrsAmf0Any::number(play_bytes));
    pkt->data->set("play_time",      SrsAmf0Any::number(play_actual_duration_ms));
    pkt->data->set("publish_bytes",  SrsAmf0Any::number(publish_bytes));
    pkt->data->set("publish_time",   SrsAmf0Any::number(publish_actual_duration_ms));

    SrsCommonMessage* msg = (new SrsCommonMessage())->set_packet(pkt, 0);
    if ((ret = rtmp->send_message(msg)) != ERROR_SUCCESS) {
        srs_error("send bandwidth check finish message failed. ret=%d", ret);
        return ret;
    }
    
    // if flash, we notice the result, and expect a final packet.
    while (true) {
        SrsCommonMessage* msg = NULL;
        SrsBandwidthPacket* pkt = NULL;
        if ((ret = srs_rtmp_expect_message<SrsBandwidthPacket>(protocol, &msg, &pkt)) != ERROR_SUCCESS) {
            // info level to ignore and return success.
            srs_info("expect final message failed. ret=%d", ret);
            return ERROR_SUCCESS;
        }
        SrsAutoFree(SrsCommonMessage, msg, false);
        srs_info("get final message success.");
        
        if (pkt->is_flash_final()) {
            srs_info("BW check recv flash final response.");
            break;
        }
    }
    
    srs_info("BW check finished.");

    return ret;
}

int SrsBandwidth::check_play(
    int duration_ms, int interval_ms, int& actual_duration_ms,
    int& play_bytes, int max_play_kbps)
{
    int ret = ERROR_SUCCESS;
    
    SrsProtocol* protocol = rtmp->get_protocol();

    if (true) {
        // send start play command to client
        SrsBandwidthPacket* pkt = SrsBandwidthPacket::create_start_play();
    
        pkt->data->set("duration_ms", SrsAmf0Any::number(duration_ms));
        pkt->data->set("interval_ms", SrsAmf0Any::number(interval_ms));
    
        SrsCommonMessage* msg = (new SrsCommonMessage())->set_packet(pkt, 0);
        if ((ret = rtmp->send_message(msg)) != ERROR_SUCCESS) {
            srs_error("send bandwidth check start play message failed. ret=%d", ret);
            return ret;
        }
        srs_info("BW check begin.");
    }

    while (true) {
        // recv client's starting play response
        SrsCommonMessage* msg = NULL;
        SrsBandwidthPacket* pkt = NULL;
        if ((ret = srs_rtmp_expect_message<SrsBandwidthPacket>(protocol, &msg, &pkt)) != ERROR_SUCCESS) {
            srs_error("expect bandwidth message failed. ret=%d", ret);
            return ret;
        }
        SrsAutoFree(SrsCommonMessage, msg, false);
        srs_info("get bandwidth message succes.");
        
        if (pkt->is_starting_play()) {
            srs_info("BW check recv play begin response.");
            break;
        }
    }

    // send play data to client
    int64_t current_time = srs_get_system_time_ms();
    int size = 1024; // TODO: FIXME: magic number
    char random_data[size];
    memset(random_data, 'A', size);

    int interval = 0;
    int data_count = 1;
    while ( (srs_get_system_time_ms() - current_time) < duration_ms ) {
        st_usleep(interval);
        
        // TODO: FIXME: use shared ptr message.
        SrsBandwidthPacket* pkt = SrsBandwidthPacket::create_playing();

        // TODO: FIXME: magic number
        for (int i = 0; i < data_count; ++i) {
            std::stringstream seq;
            seq << i;
            std::string play_data = "SrS band check data from server's playing......";
            pkt->data->set(seq.str(), SrsAmf0Any::str(play_data.c_str()));
        }
        data_count += 2;

        // TODO: FIXME: get length from the rtmp protocol stack.
        play_bytes += pkt->get_payload_length();

        SrsCommonMessage* msg = (new SrsCommonMessage())->set_packet(pkt, 0);
        if ((ret = rtmp->send_message(msg)) != ERROR_SUCCESS) {
            srs_error("send bandwidth check play messages failed. ret=%d", ret);
            return ret;
        }

        // sleep while current kbps <= max_play_kbps
        int kbps = 0;
        while (true) {
            if(srs_get_system_time_ms() - current_time != 0)
                kbps = play_bytes * 8 / (srs_get_system_time_ms() - current_time);

            if (kbps > max_play_kbps) {
                st_usleep(500);
            } else {
                break;
            }
        }
    }
    actual_duration_ms = srs_get_system_time_ms() - current_time;
    srs_info("BW check send play bytes over.");

    if (true) {
        // notify client to stop play
        SrsBandwidthPacket* pkt = SrsBandwidthPacket::create_stop_play();
        pkt->data->set("duration_ms", SrsAmf0Any::number(duration_ms));
        pkt->data->set("interval_ms", SrsAmf0Any::number(interval_ms));
        pkt->data->set("duration_delta", SrsAmf0Any::number(actual_duration_ms));
        pkt->data->set("bytes_delta", SrsAmf0Any::number(play_bytes));

        SrsCommonMessage* msg = (new SrsCommonMessage())->set_packet(pkt, 0);
        if ((ret = rtmp->send_message(msg)) != ERROR_SUCCESS) {
            srs_error("send bandwidth check stop play message failed. ret=%d", ret);
            return ret;
        }
        srs_info("BW check stop play bytes.");
    }

    while (true) {
        // recv client's stop play response.
        SrsCommonMessage* msg = NULL;
        SrsBandwidthPacket* pkt = NULL;
        if ((ret = srs_rtmp_expect_message<SrsBandwidthPacket>(protocol, &msg, &pkt)) != ERROR_SUCCESS) {
            srs_error("expect bandwidth message failed. ret=%d", ret);
            return ret;
        }
        SrsAutoFree(SrsCommonMessage, msg, false);
        srs_info("get bandwidth message succes.");
        
        if (pkt->is_stopped_play()) {
            srs_info("BW check recv stop play response.");
            break;
        }
    }

    return ret;
}

int SrsBandwidth::check_publish(
    int duration_ms, int interval_ms, int& actual_duration_ms,
    int& publish_bytes, int max_pub_kbps)
{
    int ret = ERROR_SUCCESS;
    
    SrsProtocol* protocol = rtmp->get_protocol();

    if (true) {
        // notify client to start publish
        SrsBandwidthPacket* pkt = SrsBandwidthPacket::create_start_publish();
    
        pkt->data->set("duration_ms", SrsAmf0Any::number(duration_ms));
        pkt->data->set("interval_ms", SrsAmf0Any::number(interval_ms));
    
        SrsCommonMessage* msg = (new SrsCommonMessage())->set_packet(pkt, 0);
        if ((ret = rtmp->send_message(msg)) != ERROR_SUCCESS) {
            srs_error("send bandwidth check start publish message failed. ret=%d", ret);
            return ret;
        }
        srs_info("BW check publish begin.");
    }

    while (true) {
        // read client's notification of starting publish
        SrsCommonMessage* msg = NULL;
        SrsBandwidthPacket* pkt = NULL;
        if ((ret = srs_rtmp_expect_message<SrsBandwidthPacket>(protocol, &msg, &pkt)) != ERROR_SUCCESS) {
            srs_error("expect bandwidth message failed. ret=%d", ret);
            return ret;
        }
        SrsAutoFree(SrsCommonMessage, msg, false);
        srs_info("get bandwidth message succes.");
        
        if (pkt->is_starting_publish()) {
            srs_info("BW check recv publish begin response.");
            break;
        }
    }

    // recv publish msgs until @duration_ms ms
    int64_t current_time = srs_get_system_time_ms();
    while ( (srs_get_system_time_ms() - current_time) < duration_ms ) {
        st_usleep(0);
        
        SrsCommonMessage* msg = NULL;
        if ((ret = rtmp->recv_message(&msg)) != ERROR_SUCCESS) {
            srs_error("recv message failed. ret=%d", ret);
            return ret;
        }
        SrsAutoFree(SrsCommonMessage, msg, false);

        // TODO: FIXME.
        publish_bytes += msg->header.payload_length;

        int kbps = 0;
        while (true) {
            if(srs_get_system_time_ms() - current_time != 0)
                kbps = publish_bytes * 8 / (srs_get_system_time_ms() - current_time);

            if (kbps > max_pub_kbps) {
                st_usleep(500);
            } else {
                break;
            }
        }
    }
    actual_duration_ms = srs_get_system_time_ms() -  current_time;
    srs_info("BW check recv publish data over.");

    if (true) {
        // notify client to stop publish
        SrsBandwidthPacket* pkt = SrsBandwidthPacket::create_stop_publish();
        pkt->data->set("duration_ms", SrsAmf0Any::number(duration_ms));
        pkt->data->set("interval_ms", SrsAmf0Any::number(interval_ms));
        pkt->data->set("duration_delta", SrsAmf0Any::number(actual_duration_ms));
        pkt->data->set("bytes_delta", SrsAmf0Any::number(publish_bytes));

        SrsCommonMessage* msg = (new SrsCommonMessage())->set_packet(pkt, 0);
        if ((ret = rtmp->send_message(msg)) != ERROR_SUCCESS) {
            srs_error("send bandwidth check stop publish message failed. ret=%d", ret);
            return ret;
        }
        srs_info("BW check stop publish bytes.");
    }

    // expect client to stop publish
    // if flash client, we never expect the client stop publish bytes, 
    // for the flash send call packet to test publish bandwidth,
    // there are many many packets in the queue.
    // we just ignore the packet and send the bandwidth test data.
    // TODO: FIXME: check whether flash client.
    while (false) {
        // recv client's stop publish response.
        SrsCommonMessage* msg = NULL;
        SrsBandwidthPacket* pkt = NULL;
        if ((ret = srs_rtmp_expect_message<SrsBandwidthPacket>(protocol, &msg, &pkt)) != ERROR_SUCCESS) {
            srs_error("expect bandwidth message failed. ret=%d", ret);
            return ret;
        }
        SrsAutoFree(SrsCommonMessage, msg, false);
        srs_info("get bandwidth message succes.");
        
        if (pkt->is_stopped_publish()) {
            srs_info("BW check recv stop publish response.");
            break;
        }
    }

    return ret;
}