1 /*****************************************************************************
2 * stats.c: Statistics handling
3 *****************************************************************************
4 * Copyright (C) 2006 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <stdio.h> /* required */
30 #include <vlc/input.h>
32 /*****************************************************************************
34 *****************************************************************************/
35 static counter_t *GetCounter( stats_handler_t *p_handler, int i_object_id,
36 unsigned int i_counter );
37 static int stats_CounterUpdate( stats_handler_t *p_handler,
39 vlc_value_t val, vlc_value_t * );
40 static stats_handler_t* stats_HandlerCreate( vlc_object_t *p_this );
41 static stats_handler_t *stats_HandlerGet( vlc_object_t *p_this );
43 static void TimerDump( vlc_object_t *p_this, counter_t *p_counter, vlc_bool_t);
45 /*****************************************************************************
47 *****************************************************************************/
50 * Cleanup statistics handler stuff
51 * \param p_stats the handler to clean
54 void stats_HandlerDestroy( stats_handler_t *p_stats )
57 for ( i = p_stats->i_counters - 1 ; i >= 0 ; i-- )
60 counter_t *p_counter = p_stats->pp_counters[i];
62 for( j = p_counter->i_samples -1; j >= 0 ; j-- )
64 counter_sample_t *p_sample = p_counter->pp_samples[j];
65 REMOVE_ELEM( p_counter->pp_samples, p_counter->i_samples, j );
68 free( p_counter->psz_name );
69 REMOVE_ELEM( p_stats->pp_counters, p_stats->i_counters, i );
75 * Create a statistics counter
76 * \param p_this the object for which to create the counter
77 * \param psz_name the name
78 * \param i_type the type of stored data. One of VLC_VAR_STRING,
79 * VLC_VAR_INTEGER, VLC_VAR_FLOAT
80 * \param i_compute_type the aggregation type. One of STATS_LAST (always
81 * keep the last value), STATS_COUNTER (increment by the passed value),
82 * STATS_MAX (keep the maximum passed value), STATS_MIN, or STATS_DERIVATIVE
83 * (keep a time derivative of the value)
85 int __stats_Create( vlc_object_t *p_this, const char *psz_name, unsigned int i_id,
86 int i_type, int i_compute_type )
89 stats_handler_t *p_handler;
91 if( !p_this->p_libvlc->b_stats ) return VLC_EGENERIC;
93 p_handler = stats_HandlerGet( p_this );
94 if( !p_handler ) return VLC_ENOMEM;
96 vlc_mutex_lock( &p_handler->object_lock );
98 p_counter = (counter_t*) malloc( sizeof( counter_t ) ) ;
100 p_counter->psz_name = strdup( psz_name );
101 p_counter->i_index = ((uint64_t)p_this->i_object_id << 32 ) + i_id;
102 p_counter->i_compute_type = i_compute_type;
103 p_counter->i_type = i_type;
104 p_counter->i_samples = 0;
105 p_counter->pp_samples = NULL;
107 p_counter->update_interval = 0;
108 p_counter->last_update = 0;
110 INSERT_ELEM( p_handler->pp_counters, p_handler->i_counters,
111 p_handler->i_counters, p_counter );
113 vlc_mutex_unlock( &p_handler->object_lock );
118 /** Update a counter element with new values
119 * \param p_this the object in which to update
120 * \param psz_name the name
121 * \param val the vlc_value union containing the new value to aggregate. For
122 * more information on how data is aggregated, \see __stats_Create
124 int __stats_Update( vlc_object_t *p_this, unsigned int i_counter,
125 vlc_value_t val, vlc_value_t *val_new )
128 counter_t *p_counter;
129 stats_handler_t *p_handler;
131 if( !p_this->p_libvlc->b_stats ) return VLC_EGENERIC;
133 /* Get stats handler singleton */
134 p_handler = stats_HandlerGet( p_this );
135 if( !p_handler ) return VLC_ENOMEM;
137 vlc_mutex_lock( &p_handler->object_lock );
138 /* Look for existing element */
139 p_counter = GetCounter( p_handler, p_this->i_object_id, i_counter );
142 vlc_mutex_unlock( &p_handler->object_lock );
143 vlc_object_release( p_handler );
147 i_ret = stats_CounterUpdate( p_handler, p_counter, val, val_new );
148 vlc_mutex_unlock( &p_handler->object_lock );
153 /** Get the aggregated value for a counter
154 * \param p_this an object
155 * \param i_object_id the object id from which we want the data
156 * \param psz_name the name of the couner
157 * \param val a pointer to an initialized vlc_value union. It will contain the
159 * \return an error code
161 int __stats_Get( vlc_object_t *p_this, int i_object_id,
162 unsigned int i_counter, vlc_value_t *val )
164 counter_t *p_counter;
165 stats_handler_t *p_handler;
167 if( !p_this->p_libvlc->b_stats ) return VLC_EGENERIC;
169 /* Get stats handler singleton */
170 p_handler = stats_HandlerGet( p_this );
171 if( !p_handler ) return VLC_ENOMEM;
172 vlc_mutex_lock( &p_handler->object_lock );
174 /* Look for existing element */
175 p_counter = GetCounter( p_handler, i_object_id, i_counter );
178 vlc_mutex_unlock( &p_handler->object_lock );
179 vlc_object_release( p_handler );
180 val->i_int = val->f_float = 0.0;
184 if( p_counter->i_samples == 0 )
186 vlc_mutex_unlock( &p_handler->object_lock );
187 val->i_int = val->f_float = 0.0;
191 switch( p_counter->i_compute_type )
197 *val = p_counter->pp_samples[0]->value;
199 case STATS_DERIVATIVE:
201 if( p_counter->i_samples < 2 )
203 vlc_mutex_unlock( &p_handler->object_lock );
204 val->i_int = 0; val->f_float = 0.0;
207 if( p_counter->i_type == VLC_VAR_INTEGER )
209 float f = ( p_counter->pp_samples[0]->value.i_int -
210 p_counter->pp_samples[1]->value.i_int ) /
211 (float)( p_counter->pp_samples[0]->date -
212 p_counter->pp_samples[1]->date );
217 float f = (float)( p_counter->pp_samples[0]->value.f_float -
218 p_counter->pp_samples[1]->value.f_float ) /
219 (float)( p_counter->pp_samples[0]->date -
220 p_counter->pp_samples[1]->date );
225 vlc_object_release( p_handler );
227 vlc_mutex_unlock( &p_handler->object_lock );
231 /** Get a statistics counter structure. This allows for low-level modifications
232 * \param p_this a parent object
233 * \param i_object_id the object from which to retrieve data
234 * \param psz_name the name
235 * \return the counter, or NULL if not found (or handler not created yet)
237 counter_t *__stats_CounterGet( vlc_object_t *p_this, int i_object_id,
238 unsigned int i_counter )
240 counter_t *p_counter;
241 stats_handler_t *p_handler;
243 if( !p_this->p_libvlc->b_stats ) return NULL;
245 p_handler = stats_HandlerGet( p_this );
246 if( !p_handler ) return NULL;
248 vlc_mutex_lock( &p_handler->object_lock );
250 /* Look for existing element */
251 p_counter = GetCounter( p_handler, i_object_id, i_counter );
252 vlc_mutex_unlock( &p_handler->object_lock );
253 vlc_object_release( p_handler );
259 void stats_ComputeInputStats( input_thread_t *p_input, input_stats_t *p_stats )
265 if( !p_input->p_libvlc->b_stats ) return;
267 vlc_mutex_lock( &p_stats->lock );
270 stats_GetInteger( p_input, p_input->i_object_id, STATS_READ_PACKETS,
271 &p_stats->i_read_packets );
272 stats_GetInteger( p_input, p_input->i_object_id, STATS_READ_BYTES,
273 &p_stats->i_read_bytes );
274 stats_GetFloat( p_input, p_input->i_object_id, STATS_INPUT_BITRATE,
275 &p_stats->f_input_bitrate );
277 stats_GetInteger( p_input, p_input->i_object_id, STATS_DEMUX_READ,
278 &p_stats->i_demux_read_bytes );
279 stats_GetFloat( p_input, p_input->i_object_id, STATS_DEMUX_BITRATE,
280 &p_stats->f_demux_bitrate );
282 stats_GetInteger( p_input, p_input->i_object_id, STATS_DECODED_VIDEO,
283 &p_stats->i_decoded_video );
284 stats_GetInteger( p_input, p_input->i_object_id, STATS_DECODED_AUDIO,
285 &p_stats->i_decoded_audio );
288 stats_GetInteger( p_input, p_input->i_object_id, STATS_SOUT_SENT_PACKETS,
289 &p_stats->i_sent_packets );
290 stats_GetInteger( p_input, p_input->i_object_id, STATS_SOUT_SENT_BYTES,
291 &p_stats->i_sent_bytes );
292 stats_GetFloat ( p_input, p_input->i_object_id, STATS_SOUT_SEND_BITRATE,
293 &p_stats->f_send_bitrate );
295 /* Aout - We store in p_input because aout is shared */
296 stats_GetInteger( p_input, p_input->i_object_id, STATS_PLAYED_ABUFFERS,
297 &p_stats->i_played_abuffers );
298 stats_GetInteger( p_input, p_input->i_object_id, STATS_LOST_ABUFFERS,
299 &p_stats->i_lost_abuffers );
301 /* Vouts - FIXME: Store all in input */
302 p_list = vlc_list_find( p_input, VLC_OBJECT_VOUT, FIND_CHILD );
305 p_stats->i_displayed_pictures = 0 ;
306 p_stats->i_lost_pictures = 0;
307 for( i_index = 0; i_index < p_list->i_count ; i_index ++ )
309 int i_displayed = 0, i_lost = 0;
310 p_obj = (vlc_object_t *)p_list->p_values[i_index].p_object;
311 stats_GetInteger( p_obj, p_obj->i_object_id,
312 STATS_DISPLAYED_PICTURES,
314 stats_GetInteger( p_obj, p_obj->i_object_id, STATS_LOST_PICTURES,
316 p_stats->i_displayed_pictures += i_displayed;
317 p_stats->i_lost_pictures += i_lost;
319 vlc_list_release( p_list );
322 vlc_mutex_unlock( &p_stats->lock );
326 void stats_ReinitInputStats( input_stats_t *p_stats )
328 p_stats->i_read_packets = p_stats->i_read_bytes =
329 p_stats->f_input_bitrate = p_stats->f_average_input_bitrate =
330 p_stats->i_demux_read_packets = p_stats->i_demux_read_bytes =
331 p_stats->f_demux_bitrate = p_stats->f_average_demux_bitrate =
332 p_stats->i_displayed_pictures = p_stats->i_lost_pictures =
333 p_stats->i_played_abuffers = p_stats->i_lost_abuffers =
334 p_stats->i_decoded_video = p_stats->i_decoded_audio =
335 p_stats->i_sent_bytes = p_stats->i_sent_packets = p_stats->f_send_bitrate
339 void stats_DumpInputStats( input_stats_t *p_stats )
341 vlc_mutex_lock( &p_stats->lock );
342 /* f_bitrate is in bytes / microsecond
343 * *1000 => bytes / millisecond => kbytes / seconds */
344 fprintf( stderr, "Input : %i (%i bytes) - %f kB/s - "
345 "Demux : %i (%i bytes) - %f kB/s\n"
346 " - Vout : %i/%i - Aout : %i/%i - Sout : %f\n",
347 p_stats->i_read_packets, p_stats->i_read_bytes,
348 p_stats->f_input_bitrate * 1000,
349 p_stats->i_demux_read_packets, p_stats->i_demux_read_bytes,
350 p_stats->f_demux_bitrate * 1000,
351 p_stats->i_displayed_pictures, p_stats->i_lost_pictures,
352 p_stats->i_played_abuffers, p_stats->i_lost_abuffers,
353 p_stats->f_send_bitrate );
354 vlc_mutex_unlock( &p_stats->lock );
357 void __stats_ComputeGlobalStats( vlc_object_t *p_obj, global_stats_t *p_stats )
362 if( !p_obj->p_libvlc->b_stats ) return;
364 vlc_mutex_lock( &p_stats->lock );
366 p_list = vlc_list_find( p_obj, VLC_OBJECT_INPUT, FIND_ANYWHERE );
369 float f_total_in = 0, f_total_out = 0,f_total_demux = 0;
370 for( i_index = 0; i_index < p_list->i_count ; i_index ++ )
372 float f_in = 0, f_out = 0, f_demux = 0;
373 p_obj = (vlc_object_t *)p_list->p_values[i_index].p_object;
374 stats_GetFloat( p_obj, p_obj->i_object_id, STATS_INPUT_BITRATE,
376 stats_GetFloat( p_obj, p_obj->i_object_id, STATS_SOUT_SEND_BITRATE,
378 stats_GetFloat( p_obj, p_obj->i_object_id, STATS_DEMUX_BITRATE,
380 f_total_in += f_in; f_total_out += f_out;f_total_demux += f_demux;
382 p_stats->f_input_bitrate = f_total_in;
383 p_stats->f_output_bitrate = f_total_out;
384 p_stats->f_demux_bitrate = f_total_demux;
385 vlc_list_release( p_list );
388 vlc_mutex_unlock( &p_stats->lock );
391 void stats_ReinitGlobalStats( global_stats_t *p_stats )
393 p_stats->f_input_bitrate = p_stats->f_output_bitrate = 0.0;
397 void __stats_TimerStart( vlc_object_t *p_obj, const char *psz_name,
400 counter_t *p_counter;
402 if( !p_obj->p_libvlc->b_stats ) return;
404 p_counter = stats_CounterGet( p_obj, p_obj->p_vlc->i_object_id, i_id );
407 counter_sample_t *p_sample;
408 stats_Create( p_obj->p_vlc, psz_name, i_id, VLC_VAR_TIME, STATS_TIMER );
409 p_counter = stats_CounterGet( p_obj, p_obj->p_vlc->i_object_id,
411 if( !p_counter ) return;
412 /* 1st sample : if started: start_date, else last_time, b_started */
413 p_sample = (counter_sample_t *)malloc( sizeof( counter_sample_t ) );
414 INSERT_ELEM( p_counter->pp_samples, p_counter->i_samples,
415 p_counter->i_samples, p_sample );
416 p_sample->date = 0; p_sample->value.b_bool = 0;
417 /* 2nd sample : global_time, i_samples */
418 p_sample = (counter_sample_t *)malloc( sizeof( counter_sample_t ) );
419 INSERT_ELEM( p_counter->pp_samples, p_counter->i_samples,
420 p_counter->i_samples, p_sample );
421 p_sample->date = 0; p_sample->value.i_int = 0;
423 if( p_counter->pp_samples[0]->value.b_bool == VLC_TRUE )
425 msg_Warn( p_obj, "timer %s was already started !", psz_name );
428 p_counter->pp_samples[0]->value.b_bool = VLC_TRUE;
429 p_counter->pp_samples[0]->date = mdate();
432 void __stats_TimerStop( vlc_object_t *p_obj, unsigned int i_id )
434 counter_t *p_counter;
436 if( !p_obj->p_libvlc->b_stats ) return;
438 p_counter = stats_CounterGet( p_obj, p_obj->p_vlc->i_object_id, i_id );
439 if( !p_counter || p_counter->i_samples != 2 )
441 msg_Err( p_obj, "Timer does not exist" );
444 p_counter->pp_samples[0]->value.b_bool = VLC_FALSE;
445 p_counter->pp_samples[1]->value.i_int += 1;
446 p_counter->pp_samples[0]->date = mdate() - p_counter->pp_samples[0]->date;
447 p_counter->pp_samples[1]->date += p_counter->pp_samples[0]->date;
450 void __stats_TimerDump( vlc_object_t *p_obj, unsigned int i_id )
452 counter_t *p_counter;
454 if( !p_obj->p_libvlc->b_stats ) return;
456 p_counter = stats_CounterGet( p_obj, p_obj->p_vlc->i_object_id, i_id );
457 TimerDump( p_obj, p_counter, VLC_TRUE );
461 void __stats_TimersDumpAll( vlc_object_t *p_obj )
464 stats_handler_t *p_handler = stats_HandlerGet( p_obj );
465 if( !p_handler ) return;
467 vlc_mutex_lock( &p_handler->object_lock );
468 for ( i = 0 ; i< p_handler->i_counters; i++ )
470 counter_t * p_counter = p_handler->pp_counters[i];
471 if( p_counter->i_compute_type == STATS_TIMER )
473 TimerDump( p_obj, p_counter, VLC_FALSE );
476 vlc_mutex_unlock( &p_handler->object_lock );
480 /********************************************************************
481 * Following functions are local
482 ********************************************************************/
485 * Update a statistics counter, according to its type
486 * If needed, perform a bit of computation (derivative, mostly)
487 * This function must be entered with stats handler lock
488 * \param p_handler stats handler singleton
489 * \param p_counter the counter to update
490 * \param val the "new" value
491 * \return an error code
493 static int stats_CounterUpdate( stats_handler_t *p_handler,
494 counter_t *p_counter,
495 vlc_value_t val, vlc_value_t *new_val )
497 switch( p_counter->i_compute_type )
502 if( p_counter->i_samples > 1)
504 msg_Err( p_handler, "LAST counter has several samples !" );
507 if( p_counter->i_type != VLC_VAR_FLOAT &&
508 p_counter->i_type != VLC_VAR_INTEGER &&
509 p_counter->i_compute_type != STATS_LAST )
511 msg_Err( p_handler, "unable to compute MIN or MAX for this type");
515 if( p_counter->i_samples == 0 )
517 counter_sample_t *p_new = (counter_sample_t*)malloc(
518 sizeof( counter_sample_t ) );
519 p_new->value.psz_string = NULL;
521 INSERT_ELEM( p_counter->pp_samples, p_counter->i_samples,
522 p_counter->i_samples, p_new );
524 if( p_counter->i_samples == 1 )
526 /* Update if : LAST or (MAX and bigger) or (MIN and bigger) */
527 if( p_counter->i_compute_type == STATS_LAST ||
528 ( p_counter->i_compute_type == STATS_MAX &&
529 ( ( p_counter->i_type == VLC_VAR_INTEGER &&
530 p_counter->pp_samples[0]->value.i_int > val.i_int ) ||
531 ( p_counter->i_type == VLC_VAR_FLOAT &&
532 p_counter->pp_samples[0]->value.f_float > val.f_float )
534 ( p_counter->i_compute_type == STATS_MIN &&
535 ( ( p_counter->i_type == VLC_VAR_INTEGER &&
536 p_counter->pp_samples[0]->value.i_int < val.i_int ) ||
537 ( p_counter->i_type == VLC_VAR_FLOAT &&
538 p_counter->pp_samples[0]->value.f_float < val.f_float )
541 if( p_counter->i_type == VLC_VAR_STRING &&
542 p_counter->pp_samples[0]->value.psz_string )
544 free( p_counter->pp_samples[0]->value.psz_string );
546 p_counter->pp_samples[0]->value = val;
547 *new_val = p_counter->pp_samples[0]->value;
551 case STATS_DERIVATIVE:
553 counter_sample_t *p_new, *p_old;
554 if( mdate() - p_counter->last_update < p_counter->update_interval )
558 p_counter->last_update = mdate();
559 if( p_counter->i_type != VLC_VAR_FLOAT &&
560 p_counter->i_type != VLC_VAR_INTEGER )
562 msg_Err( p_handler, "Unable to compute DERIVATIVE for this type");
565 /* Insert the new one at the beginning */
566 p_new = (counter_sample_t*)malloc( sizeof( counter_sample_t ) );
568 p_new->date = p_counter->last_update;
569 INSERT_ELEM( p_counter->pp_samples, p_counter->i_samples,
572 if( p_counter->i_samples == 3 )
574 p_old = p_counter->pp_samples[2];
575 REMOVE_ELEM( p_counter->pp_samples, p_counter->i_samples, 2 );
581 if( p_counter->i_samples > 1)
583 msg_Err( p_handler, "LAST counter has several samples !" );
586 if( p_counter->i_samples == 0 )
588 counter_sample_t *p_new = (counter_sample_t*)malloc(
589 sizeof( counter_sample_t ) );
590 p_new->value.psz_string = NULL;
592 INSERT_ELEM( p_counter->pp_samples, p_counter->i_samples,
593 p_counter->i_samples, p_new );
595 if( p_counter->i_samples == 1 )
597 switch( p_counter->i_type )
599 case VLC_VAR_INTEGER:
600 p_counter->pp_samples[0]->value.i_int += val.i_int;
602 new_val->i_int = p_counter->pp_samples[0]->value.i_int;
605 p_counter->pp_samples[0]->value.f_float += val.f_float;
607 new_val->f_float = p_counter->pp_samples[0]->value.f_float;
609 msg_Err( p_handler, "Trying to increment invalid variable %s",
610 p_counter->psz_name );
619 static counter_t *GetCounter( stats_handler_t *p_handler, int i_object_id,
620 unsigned int i_counter )
623 uint64_t i_index = ((uint64_t) i_object_id << 32 ) + i_counter;
624 for (i = 0 ; i < p_handler->i_counters ; i++ )
626 if( i_index == p_handler->pp_counters[i]->i_index )
627 return p_handler->pp_counters[i];
633 static stats_handler_t *stats_HandlerGet( vlc_object_t *p_this )
635 stats_handler_t *p_handler = p_this->p_libvlc->p_stats;
638 p_handler = stats_HandlerCreate( p_this );
644 vlc_object_yield( p_handler );
649 * Initialize statistics handler
651 * This function initializes the global statistics handler singleton,
652 * \param p_this the parent VLC object
654 static stats_handler_t* stats_HandlerCreate( vlc_object_t *p_this )
656 stats_handler_t *p_handler;
658 msg_Dbg( p_this, "creating statistics handler" );
660 p_handler = (stats_handler_t*) vlc_object_create( p_this,
665 msg_Err( p_this, "out of memory" );
668 p_handler->i_counters = 0;
669 p_handler->pp_counters = NULL;
671 /// \bug is it p_vlc or p_libvlc ?
672 vlc_object_attach( p_handler, p_this->p_vlc );
674 p_this->p_libvlc->p_stats = p_handler;
679 static void TimerDump( vlc_object_t *p_obj, counter_t *p_counter,
684 if( !p_counter || p_counter->i_samples != 2 )
686 msg_Err( p_obj, "Timer %s does not exist", p_counter->psz_name );
689 i_total = p_counter->pp_samples[1]->value.i_int;
690 total = p_counter->pp_samples[1]->date;
691 if( p_counter->pp_samples[0]->value.b_bool == VLC_TRUE )
693 last = mdate() - p_counter->pp_samples[0]->date;
699 last = p_counter->pp_samples[0]->date;
704 "TIMER %s : %.3f ms - Total %.3f ms / %i intvls (Avg %.3f ms)",
705 p_counter->psz_name, (float)last/1000, (float)total/1000, i_total,
706 (float)(total)/(1000*(float)i_total ) );
711 "TIMER %s : Total %.3f ms / %i intvls (Avg %.3f ms)",
712 p_counter->psz_name, (float)total/1000, i_total,
713 (float)(total)/(1000*(float)i_total ) );