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 );
114 vlc_object_release( p_handler );
119 /** Update a counter element with new values
120 * \param p_this the object in which to update
121 * \param psz_name the name
122 * \param val the vlc_value union containing the new value to aggregate. For
123 * more information on how data is aggregated, \see __stats_Create
125 int __stats_Update( vlc_object_t *p_this, unsigned int i_counter,
126 vlc_value_t val, vlc_value_t *val_new )
129 counter_t *p_counter;
130 stats_handler_t *p_handler;
132 if( !p_this->p_libvlc->b_stats ) return VLC_EGENERIC;
134 /* Get stats handler singleton */
135 p_handler = stats_HandlerGet( p_this );
136 if( !p_handler ) return VLC_ENOMEM;
138 vlc_mutex_lock( &p_handler->object_lock );
139 /* Look for existing element */
140 p_counter = GetCounter( p_handler, p_this->i_object_id, i_counter );
143 vlc_mutex_unlock( &p_handler->object_lock );
144 vlc_object_release( p_handler );
148 i_ret = stats_CounterUpdate( p_handler, p_counter, val, val_new );
149 vlc_mutex_unlock( &p_handler->object_lock );
150 vlc_object_release( p_handler );
155 /** Get the aggregated value for a counter
156 * \param p_this an object
157 * \param i_object_id the object id from which we want the data
158 * \param psz_name the name of the couner
159 * \param val a pointer to an initialized vlc_value union. It will contain the
161 * \return an error code
163 int __stats_Get( vlc_object_t *p_this, int i_object_id,
164 unsigned int i_counter, vlc_value_t *val )
166 counter_t *p_counter;
167 stats_handler_t *p_handler;
169 if( !p_this->p_libvlc->b_stats ) return VLC_EGENERIC;
171 /* Get stats handler singleton */
172 p_handler = stats_HandlerGet( p_this );
173 if( !p_handler ) return VLC_ENOMEM;
174 vlc_mutex_lock( &p_handler->object_lock );
176 /* Look for existing element */
177 p_counter = GetCounter( p_handler, i_object_id, i_counter );
180 vlc_mutex_unlock( &p_handler->object_lock );
181 vlc_object_release( p_handler );
182 val->i_int = val->f_float = 0.0;
186 if( p_counter->i_samples == 0 )
188 vlc_mutex_unlock( &p_handler->object_lock );
189 vlc_object_release( p_handler );
190 val->i_int = val->f_float = 0.0;
194 switch( p_counter->i_compute_type )
200 *val = p_counter->pp_samples[0]->value;
202 case STATS_DERIVATIVE:
204 if( p_counter->i_samples < 2 )
206 vlc_mutex_unlock( &p_handler->object_lock );
207 vlc_object_release( p_handler );
208 val->i_int = 0; val->f_float = 0.0;
211 if( p_counter->i_type == VLC_VAR_INTEGER )
213 float f = ( p_counter->pp_samples[0]->value.i_int -
214 p_counter->pp_samples[1]->value.i_int ) /
215 (float)( p_counter->pp_samples[0]->date -
216 p_counter->pp_samples[1]->date );
221 float f = (float)( p_counter->pp_samples[0]->value.f_float -
222 p_counter->pp_samples[1]->value.f_float ) /
223 (float)( p_counter->pp_samples[0]->date -
224 p_counter->pp_samples[1]->date );
229 vlc_object_release( p_handler );
231 vlc_mutex_unlock( &p_handler->object_lock );
235 /** Get a statistics counter structure. This allows for low-level modifications
236 * \param p_this a parent object
237 * \param i_object_id the object from which to retrieve data
238 * \param psz_name the name
239 * \return the counter, or NULL if not found (or handler not created yet)
241 counter_t *__stats_CounterGet( vlc_object_t *p_this, int i_object_id,
242 unsigned int i_counter )
244 counter_t *p_counter;
245 stats_handler_t *p_handler;
247 if( !p_this->p_libvlc->b_stats ) return NULL;
249 p_handler = stats_HandlerGet( p_this );
250 if( !p_handler ) return NULL;
252 vlc_mutex_lock( &p_handler->object_lock );
254 /* Look for existing element */
255 p_counter = GetCounter( p_handler, i_object_id, i_counter );
256 vlc_mutex_unlock( &p_handler->object_lock );
257 vlc_object_release( p_handler );
263 void stats_ComputeInputStats( input_thread_t *p_input, input_stats_t *p_stats )
269 if( !p_input->p_libvlc->b_stats ) return;
271 vlc_mutex_lock( &p_stats->lock );
274 stats_GetInteger( p_input, p_input->i_object_id, STATS_READ_PACKETS,
275 &p_stats->i_read_packets );
276 stats_GetInteger( p_input, p_input->i_object_id, STATS_READ_BYTES,
277 &p_stats->i_read_bytes );
278 stats_GetFloat( p_input, p_input->i_object_id, STATS_INPUT_BITRATE,
279 &p_stats->f_input_bitrate );
281 stats_GetInteger( p_input, p_input->i_object_id, STATS_DEMUX_READ,
282 &p_stats->i_demux_read_bytes );
283 stats_GetFloat( p_input, p_input->i_object_id, STATS_DEMUX_BITRATE,
284 &p_stats->f_demux_bitrate );
286 stats_GetInteger( p_input, p_input->i_object_id, STATS_DECODED_VIDEO,
287 &p_stats->i_decoded_video );
288 stats_GetInteger( p_input, p_input->i_object_id, STATS_DECODED_AUDIO,
289 &p_stats->i_decoded_audio );
292 stats_GetInteger( p_input, p_input->i_object_id, STATS_SOUT_SENT_PACKETS,
293 &p_stats->i_sent_packets );
294 stats_GetInteger( p_input, p_input->i_object_id, STATS_SOUT_SENT_BYTES,
295 &p_stats->i_sent_bytes );
296 stats_GetFloat ( p_input, p_input->i_object_id, STATS_SOUT_SEND_BITRATE,
297 &p_stats->f_send_bitrate );
299 /* Aout - We store in p_input because aout is shared */
300 stats_GetInteger( p_input, p_input->i_object_id, STATS_PLAYED_ABUFFERS,
301 &p_stats->i_played_abuffers );
302 stats_GetInteger( p_input, p_input->i_object_id, STATS_LOST_ABUFFERS,
303 &p_stats->i_lost_abuffers );
305 /* Vouts - FIXME: Store all in input */
306 p_list = vlc_list_find( p_input, VLC_OBJECT_VOUT, FIND_CHILD );
309 p_stats->i_displayed_pictures = 0 ;
310 p_stats->i_lost_pictures = 0;
311 for( i_index = 0; i_index < p_list->i_count ; i_index ++ )
313 int i_displayed = 0, i_lost = 0;
314 p_obj = (vlc_object_t *)p_list->p_values[i_index].p_object;
315 stats_GetInteger( p_obj, p_obj->i_object_id,
316 STATS_DISPLAYED_PICTURES,
318 stats_GetInteger( p_obj, p_obj->i_object_id, STATS_LOST_PICTURES,
320 p_stats->i_displayed_pictures += i_displayed;
321 p_stats->i_lost_pictures += i_lost;
323 vlc_list_release( p_list );
326 vlc_mutex_unlock( &p_stats->lock );
330 void stats_ReinitInputStats( input_stats_t *p_stats )
332 p_stats->i_read_packets = p_stats->i_read_bytes =
333 p_stats->f_input_bitrate = p_stats->f_average_input_bitrate =
334 p_stats->i_demux_read_packets = p_stats->i_demux_read_bytes =
335 p_stats->f_demux_bitrate = p_stats->f_average_demux_bitrate =
336 p_stats->i_displayed_pictures = p_stats->i_lost_pictures =
337 p_stats->i_played_abuffers = p_stats->i_lost_abuffers =
338 p_stats->i_decoded_video = p_stats->i_decoded_audio =
339 p_stats->i_sent_bytes = p_stats->i_sent_packets = p_stats->f_send_bitrate
343 void stats_DumpInputStats( input_stats_t *p_stats )
345 vlc_mutex_lock( &p_stats->lock );
346 /* f_bitrate is in bytes / microsecond
347 * *1000 => bytes / millisecond => kbytes / seconds */
348 fprintf( stderr, "Input : %i (%i bytes) - %f kB/s - "
349 "Demux : %i (%i bytes) - %f kB/s\n"
350 " - Vout : %i/%i - Aout : %i/%i - Sout : %f\n",
351 p_stats->i_read_packets, p_stats->i_read_bytes,
352 p_stats->f_input_bitrate * 1000,
353 p_stats->i_demux_read_packets, p_stats->i_demux_read_bytes,
354 p_stats->f_demux_bitrate * 1000,
355 p_stats->i_displayed_pictures, p_stats->i_lost_pictures,
356 p_stats->i_played_abuffers, p_stats->i_lost_abuffers,
357 p_stats->f_send_bitrate );
358 vlc_mutex_unlock( &p_stats->lock );
361 void __stats_ComputeGlobalStats( vlc_object_t *p_obj, global_stats_t *p_stats )
366 if( !p_obj->p_libvlc->b_stats ) return;
368 vlc_mutex_lock( &p_stats->lock );
370 p_list = vlc_list_find( p_obj, VLC_OBJECT_INPUT, FIND_ANYWHERE );
373 float f_total_in = 0, f_total_out = 0,f_total_demux = 0;
374 for( i_index = 0; i_index < p_list->i_count ; i_index ++ )
376 float f_in = 0, f_out = 0, f_demux = 0;
377 p_obj = (vlc_object_t *)p_list->p_values[i_index].p_object;
378 stats_GetFloat( p_obj, p_obj->i_object_id, STATS_INPUT_BITRATE,
380 stats_GetFloat( p_obj, p_obj->i_object_id, STATS_SOUT_SEND_BITRATE,
382 stats_GetFloat( p_obj, p_obj->i_object_id, STATS_DEMUX_BITRATE,
384 f_total_in += f_in; f_total_out += f_out;f_total_demux += f_demux;
386 p_stats->f_input_bitrate = f_total_in;
387 p_stats->f_output_bitrate = f_total_out;
388 p_stats->f_demux_bitrate = f_total_demux;
389 vlc_list_release( p_list );
392 vlc_mutex_unlock( &p_stats->lock );
395 void stats_ReinitGlobalStats( global_stats_t *p_stats )
397 p_stats->f_input_bitrate = p_stats->f_output_bitrate = 0.0;
401 void __stats_TimerStart( vlc_object_t *p_obj, const char *psz_name,
404 counter_t *p_counter;
406 if( !p_obj->p_libvlc->b_stats ) return;
408 p_counter = stats_CounterGet( p_obj, p_obj->p_vlc->i_object_id, i_id );
411 counter_sample_t *p_sample;
412 stats_Create( p_obj->p_vlc, psz_name, i_id, VLC_VAR_TIME, STATS_TIMER );
413 p_counter = stats_CounterGet( p_obj, p_obj->p_vlc->i_object_id,
415 if( !p_counter ) return;
416 /* 1st sample : if started: start_date, else last_time, b_started */
417 p_sample = (counter_sample_t *)malloc( sizeof( counter_sample_t ) );
418 INSERT_ELEM( p_counter->pp_samples, p_counter->i_samples,
419 p_counter->i_samples, p_sample );
420 p_sample->date = 0; p_sample->value.b_bool = 0;
421 /* 2nd sample : global_time, i_samples */
422 p_sample = (counter_sample_t *)malloc( sizeof( counter_sample_t ) );
423 INSERT_ELEM( p_counter->pp_samples, p_counter->i_samples,
424 p_counter->i_samples, p_sample );
425 p_sample->date = 0; p_sample->value.i_int = 0;
427 if( p_counter->pp_samples[0]->value.b_bool == VLC_TRUE )
429 msg_Warn( p_obj, "timer %s was already started !", psz_name );
432 p_counter->pp_samples[0]->value.b_bool = VLC_TRUE;
433 p_counter->pp_samples[0]->date = mdate();
436 void __stats_TimerStop( vlc_object_t *p_obj, unsigned int i_id )
438 counter_t *p_counter;
440 if( !p_obj->p_libvlc->b_stats ) return;
442 p_counter = stats_CounterGet( p_obj, p_obj->p_vlc->i_object_id, i_id );
443 if( !p_counter || p_counter->i_samples != 2 )
445 msg_Err( p_obj, "Timer does not exist" );
448 p_counter->pp_samples[0]->value.b_bool = VLC_FALSE;
449 p_counter->pp_samples[1]->value.i_int += 1;
450 p_counter->pp_samples[0]->date = mdate() - p_counter->pp_samples[0]->date;
451 p_counter->pp_samples[1]->date += p_counter->pp_samples[0]->date;
454 void __stats_TimerDump( vlc_object_t *p_obj, unsigned int i_id )
456 counter_t *p_counter;
458 if( !p_obj->p_libvlc->b_stats ) return;
460 p_counter = stats_CounterGet( p_obj, p_obj->p_vlc->i_object_id, i_id );
461 TimerDump( p_obj, p_counter, VLC_TRUE );
465 void __stats_TimersDumpAll( vlc_object_t *p_obj )
468 stats_handler_t *p_handler = stats_HandlerGet( p_obj );
469 if( !p_handler ) return;
471 vlc_mutex_lock( &p_handler->object_lock );
472 for ( i = 0 ; i< p_handler->i_counters; i++ )
474 counter_t * p_counter = p_handler->pp_counters[i];
475 if( p_counter->i_compute_type == STATS_TIMER )
477 TimerDump( p_obj, p_counter, VLC_FALSE );
480 vlc_mutex_unlock( &p_handler->object_lock );
481 vlc_object_release( p_handler );
485 /********************************************************************
486 * Following functions are local
487 ********************************************************************/
490 * Update a statistics counter, according to its type
491 * If needed, perform a bit of computation (derivative, mostly)
492 * This function must be entered with stats handler lock
493 * \param p_handler stats handler singleton
494 * \param p_counter the counter to update
495 * \param val the "new" value
496 * \return an error code
498 static int stats_CounterUpdate( stats_handler_t *p_handler,
499 counter_t *p_counter,
500 vlc_value_t val, vlc_value_t *new_val )
502 switch( p_counter->i_compute_type )
507 if( p_counter->i_samples > 1)
509 msg_Err( p_handler, "LAST counter has several samples !" );
512 if( p_counter->i_type != VLC_VAR_FLOAT &&
513 p_counter->i_type != VLC_VAR_INTEGER &&
514 p_counter->i_compute_type != STATS_LAST )
516 msg_Err( p_handler, "unable to compute MIN or MAX for this type");
520 if( p_counter->i_samples == 0 )
522 counter_sample_t *p_new = (counter_sample_t*)malloc(
523 sizeof( counter_sample_t ) );
524 p_new->value.psz_string = NULL;
526 INSERT_ELEM( p_counter->pp_samples, p_counter->i_samples,
527 p_counter->i_samples, p_new );
529 if( p_counter->i_samples == 1 )
531 /* Update if : LAST or (MAX and bigger) or (MIN and bigger) */
532 if( p_counter->i_compute_type == STATS_LAST ||
533 ( p_counter->i_compute_type == STATS_MAX &&
534 ( ( p_counter->i_type == VLC_VAR_INTEGER &&
535 p_counter->pp_samples[0]->value.i_int > val.i_int ) ||
536 ( p_counter->i_type == VLC_VAR_FLOAT &&
537 p_counter->pp_samples[0]->value.f_float > val.f_float )
539 ( p_counter->i_compute_type == STATS_MIN &&
540 ( ( p_counter->i_type == VLC_VAR_INTEGER &&
541 p_counter->pp_samples[0]->value.i_int < val.i_int ) ||
542 ( p_counter->i_type == VLC_VAR_FLOAT &&
543 p_counter->pp_samples[0]->value.f_float < val.f_float )
546 if( p_counter->i_type == VLC_VAR_STRING &&
547 p_counter->pp_samples[0]->value.psz_string )
549 free( p_counter->pp_samples[0]->value.psz_string );
551 p_counter->pp_samples[0]->value = val;
552 *new_val = p_counter->pp_samples[0]->value;
556 case STATS_DERIVATIVE:
558 counter_sample_t *p_new, *p_old;
559 if( mdate() - p_counter->last_update < p_counter->update_interval )
563 p_counter->last_update = mdate();
564 if( p_counter->i_type != VLC_VAR_FLOAT &&
565 p_counter->i_type != VLC_VAR_INTEGER )
567 msg_Err( p_handler, "Unable to compute DERIVATIVE for this type");
570 /* Insert the new one at the beginning */
571 p_new = (counter_sample_t*)malloc( sizeof( counter_sample_t ) );
573 p_new->date = p_counter->last_update;
574 INSERT_ELEM( p_counter->pp_samples, p_counter->i_samples,
577 if( p_counter->i_samples == 3 )
579 p_old = p_counter->pp_samples[2];
580 REMOVE_ELEM( p_counter->pp_samples, p_counter->i_samples, 2 );
586 if( p_counter->i_samples > 1)
588 msg_Err( p_handler, "LAST counter has several samples !" );
591 if( p_counter->i_samples == 0 )
593 counter_sample_t *p_new = (counter_sample_t*)malloc(
594 sizeof( counter_sample_t ) );
595 p_new->value.psz_string = NULL;
597 INSERT_ELEM( p_counter->pp_samples, p_counter->i_samples,
598 p_counter->i_samples, p_new );
600 if( p_counter->i_samples == 1 )
602 switch( p_counter->i_type )
604 case VLC_VAR_INTEGER:
605 p_counter->pp_samples[0]->value.i_int += val.i_int;
607 new_val->i_int = p_counter->pp_samples[0]->value.i_int;
610 p_counter->pp_samples[0]->value.f_float += val.f_float;
612 new_val->f_float = p_counter->pp_samples[0]->value.f_float;
614 msg_Err( p_handler, "Trying to increment invalid variable %s",
615 p_counter->psz_name );
624 static counter_t *GetCounter( stats_handler_t *p_handler, int i_object_id,
625 unsigned int i_counter )
628 uint64_t i_index = ((uint64_t) i_object_id << 32 ) + i_counter;
629 for (i = 0 ; i < p_handler->i_counters ; i++ )
631 if( i_index == p_handler->pp_counters[i]->i_index )
632 return p_handler->pp_counters[i];
638 static stats_handler_t *stats_HandlerGet( vlc_object_t *p_this )
640 stats_handler_t *p_handler = p_this->p_libvlc->p_stats;
643 p_handler = stats_HandlerCreate( p_this );
649 vlc_object_yield( p_handler );
654 * Initialize statistics handler
656 * This function initializes the global statistics handler singleton,
657 * \param p_this the parent VLC object
659 static stats_handler_t* stats_HandlerCreate( vlc_object_t *p_this )
661 stats_handler_t *p_handler;
663 msg_Dbg( p_this, "creating statistics handler" );
665 p_handler = (stats_handler_t*) vlc_object_create( p_this,
670 msg_Err( p_this, "out of memory" );
673 p_handler->i_counters = 0;
674 p_handler->pp_counters = NULL;
676 /// \bug is it p_vlc or p_libvlc ?
677 vlc_object_attach( p_handler, p_this->p_vlc );
679 p_this->p_libvlc->p_stats = p_handler;
684 static void TimerDump( vlc_object_t *p_obj, counter_t *p_counter,
689 if( !p_counter || p_counter->i_samples != 2 )
691 msg_Err( p_obj, "Timer %s does not exist", p_counter->psz_name );
694 i_total = p_counter->pp_samples[1]->value.i_int;
695 total = p_counter->pp_samples[1]->date;
696 if( p_counter->pp_samples[0]->value.b_bool == VLC_TRUE )
698 last = mdate() - p_counter->pp_samples[0]->date;
704 last = p_counter->pp_samples[0]->date;
709 "TIMER %s : %.3f ms - Total %.3f ms / %i intvls (Avg %.3f ms)",
710 p_counter->psz_name, (float)last/1000, (float)total/1000, i_total,
711 (float)(total)/(1000*(float)i_total ) );
716 "TIMER %s : Total %.3f ms / %i intvls (Avg %.3f ms)",
717 p_counter->psz_name, (float)total/1000, i_total,
718 (float)(total)/(1000*(float)i_total ) );