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 const char *psz_name );
37 static int stats_CounterUpdate( stats_handler_t *p_handler,
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 hashtable_entry_t p_entry = p_stats->p_counters[i];
61 counter_t * p_counter = p_entry.p_data;
63 for( j = p_counter->i_samples -1; j >= 0 ; j-- )
65 counter_sample_t *p_sample = p_counter->pp_samples[j];
66 REMOVE_ELEM( p_counter->pp_samples, p_counter->i_samples, j );
69 free( p_counter->psz_name );
70 free( p_entry.psz_name );
71 REMOVE_ELEM( p_stats->p_counters, p_stats->i_counters, i );
77 * Create a statistics counter
78 * \param p_this the object for which to create the counter
79 * \param psz_name the name
80 * \param i_type the type of stored data. One of VLC_VAR_STRING,
81 * VLC_VAR_INTEGER, VLC_VAR_FLOAT
82 * \param i_compute_type the aggregation type. One of STATS_LAST (always
83 * keep the last value), STATS_COUNTER (increment by the passed value),
84 * STATS_MAX (keep the maximum passed value), STATS_MIN, or STATS_DERIVATIVE
85 * (keep a time derivative of the value)
87 int __stats_Create( vlc_object_t *p_this, const char *psz_name, int i_type,
91 stats_handler_t *p_handler;
93 if( p_this->p_libvlc->b_stats == VLC_FALSE )
97 p_handler = stats_HandlerGet( p_this );
98 if( !p_handler ) return VLC_ENOMEM;
100 vlc_mutex_lock( &p_handler->object_lock );
102 p_counter = (counter_t*) malloc( sizeof( counter_t ) ) ;
104 p_counter->psz_name = strdup( psz_name );
105 p_counter->i_source_object = p_this->i_object_id;
106 p_counter->i_compute_type = i_compute_type;
107 p_counter->i_type = i_type;
108 p_counter->i_samples = 0;
109 p_counter->pp_samples = NULL;
111 p_counter->update_interval = 0;
112 p_counter->last_update = 0;
114 vlc_HashInsert( &p_handler->p_counters, &p_handler->i_counters, p_this->i_object_id,
115 psz_name, p_counter );
117 vlc_mutex_unlock( &p_handler->object_lock );
122 /** Update a counter element with new values
123 * \param p_this the object in which to update
124 * \param psz_name the name
125 * \param val the vlc_value union containing the new value to aggregate. For
126 * more information on how data is aggregated, \see __stats_Create
128 int __stats_Update( vlc_object_t *p_this, const char *psz_name,
132 counter_t *p_counter;
134 /* Get stats handler singleton */
135 stats_handler_t *p_handler;
136 if( p_this->p_libvlc->b_stats == VLC_FALSE )
140 p_handler = stats_HandlerGet( p_this );
141 if( !p_handler ) return VLC_ENOMEM;
143 vlc_mutex_lock( &p_handler->object_lock );
144 /* Look for existing element */
145 p_counter = GetCounter( p_handler, p_this->i_object_id,
149 vlc_mutex_unlock( &p_handler->object_lock );
150 vlc_object_release( p_handler );
154 i_ret = stats_CounterUpdate( p_handler, p_counter, val );
155 vlc_mutex_unlock( &p_handler->object_lock );
160 /** Get the aggregated value for a counter
161 * \param p_this an object
162 * \param i_object_id the object id from which we want the data
163 * \param psz_name the name of the couner
164 * \param val a pointer to an initialized vlc_value union. It will contain the
166 * \return an error code
168 int __stats_Get( vlc_object_t *p_this, int i_object_id,
169 const char *psz_name, vlc_value_t *val )
171 counter_t *p_counter;
173 /* Get stats handler singleton */
174 stats_handler_t *p_handler;
175 if( p_this->p_libvlc->b_stats == VLC_FALSE )
179 p_handler = stats_HandlerGet( p_this );
180 if( !p_handler ) return VLC_ENOMEM;
181 vlc_mutex_lock( &p_handler->object_lock );
183 /* Look for existing element */
184 p_counter = GetCounter( p_handler, i_object_id,
188 vlc_mutex_unlock( &p_handler->object_lock );
189 vlc_object_release( p_handler );
190 val->i_int = val->f_float = 0.0;
194 if( p_counter->i_samples == 0 )
196 vlc_mutex_unlock( &p_handler->object_lock );
197 val->i_int = val->f_float = 0.0;
201 switch( p_counter->i_compute_type )
207 *val = p_counter->pp_samples[0]->value;
209 case STATS_DERIVATIVE:
211 if( p_counter->i_samples < 2 )
213 vlc_mutex_unlock( &p_handler->object_lock );
214 val->i_int = 0; val->f_float = 0.0;
217 if( p_counter->i_type == VLC_VAR_INTEGER )
219 float f = ( p_counter->pp_samples[0]->value.i_int -
220 p_counter->pp_samples[1]->value.i_int ) /
221 (float)( p_counter->pp_samples[0]->date -
222 p_counter->pp_samples[1]->date );
227 float f = (float)( p_counter->pp_samples[0]->value.f_float -
228 p_counter->pp_samples[1]->value.f_float ) /
229 (float)( p_counter->pp_samples[0]->date -
230 p_counter->pp_samples[1]->date );
235 vlc_object_release( p_handler );
237 vlc_mutex_unlock( &p_handler->object_lock );
241 /** Get a statistics counter structure. This allows for low-level modifications
242 * \param p_this a parent object
243 * \param i_object_id the object from which to retrieve data
244 * \param psz_name the name
245 * \return the counter, or NULL if not found (or handler not created yet)
247 counter_t *__stats_CounterGet( vlc_object_t *p_this, int i_object_id,
248 const char *psz_name )
250 counter_t *p_counter;
252 stats_handler_t *p_handler;
253 if( p_this->p_libvlc->b_stats == VLC_FALSE )
257 p_handler = stats_HandlerGet( p_this );
258 if( !p_handler ) return NULL;
260 vlc_mutex_lock( &p_handler->object_lock );
262 /* Look for existing element */
263 p_counter = GetCounter( p_handler, i_object_id,
265 vlc_mutex_unlock( &p_handler->object_lock );
266 vlc_object_release( p_handler );
272 void stats_ComputeInputStats( input_thread_t *p_input,
273 input_stats_t *p_stats )
278 vlc_mutex_lock( &p_stats->lock );
281 stats_GetInteger( p_input, p_input->i_object_id, "read_packets",
282 &p_stats->i_read_packets );
283 stats_GetInteger( p_input, p_input->i_object_id, "read_bytes",
284 &p_stats->i_read_bytes );
285 stats_GetFloat( p_input, p_input->i_object_id, "input_bitrate",
286 &p_stats->f_input_bitrate );
288 stats_GetInteger( p_input, p_input->i_object_id, "demux_read",
289 &p_stats->i_demux_read_bytes );
290 stats_GetFloat( p_input, p_input->i_object_id, "demux_bitrate",
291 &p_stats->f_demux_bitrate );
293 stats_GetInteger( p_input, p_input->i_object_id, "decoded_video",
294 &p_stats->i_decoded_video );
295 stats_GetInteger( p_input, p_input->i_object_id, "decoded_audio",
296 &p_stats->i_decoded_audio );
299 stats_GetInteger( p_input, p_input->i_object_id, "sout_sent_packets",
300 &p_stats->i_sent_packets );
301 stats_GetInteger( p_input, p_input->i_object_id, "sout_sent_bytes",
302 &p_stats->i_sent_bytes );
303 stats_GetFloat ( p_input, p_input->i_object_id, "sout_send_bitrate",
304 &p_stats->f_send_bitrate );
306 /* Aout - We store in p_input because aout is shared */
307 stats_GetInteger( p_input, p_input->i_object_id, "played_abuffers",
308 &p_stats->i_played_abuffers );
309 stats_GetInteger( p_input, p_input->i_object_id, "lost_abuffers",
310 &p_stats->i_lost_abuffers );
312 /* Vouts - FIXME: Store all in input */
313 p_list = vlc_list_find( p_input, VLC_OBJECT_VOUT, FIND_CHILD );
316 p_stats->i_displayed_pictures = 0 ;
317 p_stats->i_lost_pictures = 0;
318 for( i_index = 0; i_index < p_list->i_count ; i_index ++ )
320 int i_displayed = 0, i_lost = 0;
321 p_obj = (vlc_object_t *)p_list->p_values[i_index].p_object;
322 stats_GetInteger( p_obj, p_obj->i_object_id, "displayed_pictures",
324 stats_GetInteger( p_obj, p_obj->i_object_id, "lost_pictures",
326 p_stats->i_displayed_pictures += i_displayed;
327 p_stats->i_lost_pictures += i_lost;
329 vlc_list_release( p_list );
332 vlc_mutex_unlock( &p_stats->lock );
336 void stats_ReinitInputStats( input_stats_t *p_stats )
338 p_stats->i_read_packets = p_stats->i_read_bytes =
339 p_stats->f_input_bitrate = p_stats->f_average_input_bitrate =
340 p_stats->i_demux_read_packets = p_stats->i_demux_read_bytes =
341 p_stats->f_demux_bitrate = p_stats->f_average_demux_bitrate =
342 p_stats->i_displayed_pictures = p_stats->i_lost_pictures =
343 p_stats->i_played_abuffers = p_stats->i_lost_abuffers =
344 p_stats->i_decoded_video = p_stats->i_decoded_audio =
345 p_stats->i_sent_bytes = p_stats->i_sent_packets = p_stats->f_send_bitrate
349 void stats_DumpInputStats( input_stats_t *p_stats )
351 vlc_mutex_lock( &p_stats->lock );
352 /* f_bitrate is in bytes / microsecond
353 * *1000 => bytes / millisecond => kbytes / seconds */
354 fprintf( stderr, "Input : %i (%i bytes) - %f kB/s - Demux : %i (%i bytes) - %f kB/s\n"
355 " - Vout : %i/%i - Aout : %i/%i - Vout : %f\n",
356 p_stats->i_read_packets, p_stats->i_read_bytes,
357 p_stats->f_input_bitrate * 1000,
358 p_stats->i_demux_read_packets, p_stats->i_demux_read_bytes,
359 p_stats->f_demux_bitrate * 1000,
360 p_stats->i_displayed_pictures, p_stats->i_lost_pictures,
361 p_stats->i_played_abuffers, p_stats->i_lost_abuffers,
362 p_stats->f_send_bitrate );
363 vlc_mutex_unlock( &p_stats->lock );
366 void __stats_ComputeGlobalStats( vlc_object_t *p_obj,
367 global_stats_t *p_stats )
371 vlc_mutex_lock( &p_stats->lock );
373 p_list = vlc_list_find( p_obj, VLC_OBJECT_INPUT, FIND_ANYWHERE );
376 float f_total_in = 0, f_total_out = 0,f_total_demux = 0;
377 for( i_index = 0; i_index < p_list->i_count ; i_index ++ )
379 float f_in = 0, f_out = 0, f_demux = 0;
380 p_obj = (vlc_object_t *)p_list->p_values[i_index].p_object;
381 stats_GetFloat( p_obj, p_obj->i_object_id, "input_bitrate",
383 stats_GetFloat( p_obj, p_obj->i_object_id, "sout_send_bitrate",
385 stats_GetFloat( p_obj, p_obj->i_object_id, "demux_bitrate",
387 f_total_in += f_in; f_total_out += f_out;f_total_demux += f_demux;
389 p_stats->f_input_bitrate = f_total_in;
390 p_stats->f_output_bitrate = f_total_out;
391 p_stats->f_demux_bitrate = f_total_demux;
392 vlc_list_release( p_list );
395 vlc_mutex_unlock( &p_stats->lock );
398 void stats_ReinitGlobalStats( global_stats_t *p_stats )
400 p_stats->f_input_bitrate = p_stats->f_output_bitrate = 0.0;
404 void __stats_TimerStart( vlc_object_t *p_obj, const char *psz_name )
406 counter_t *p_counter = stats_CounterGet( p_obj,
407 p_obj->p_vlc->i_object_id,
411 counter_sample_t *p_sample;
412 stats_Create( p_obj->p_vlc, psz_name, 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, const char *psz_name )
438 counter_t *p_counter = stats_CounterGet( p_obj,
439 p_obj->p_vlc->i_object_id,
441 if( !p_counter || p_counter->i_samples != 2 )
443 msg_Err( p_obj, "timer %s does not exist", psz_name );
446 p_counter->pp_samples[0]->value.b_bool = VLC_FALSE;
447 p_counter->pp_samples[1]->value.i_int += 1;
448 p_counter->pp_samples[0]->date = mdate() - p_counter->pp_samples[0]->date;
449 p_counter->pp_samples[1]->date += p_counter->pp_samples[0]->date;
452 void __stats_TimerDump( vlc_object_t *p_obj, const char *psz_name )
454 counter_t *p_counter = stats_CounterGet( p_obj,
455 p_obj->p_vlc->i_object_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 = (counter_t *)(p_handler->p_counters[i].p_data);
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,
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;
550 case STATS_DERIVATIVE:
552 counter_sample_t *p_new, *p_old;
553 if( mdate() - p_counter->last_update < p_counter->update_interval )
557 p_counter->last_update = mdate();
558 if( p_counter->i_type != VLC_VAR_FLOAT &&
559 p_counter->i_type != VLC_VAR_INTEGER )
561 msg_Err( p_handler, "Unable to compute DERIVATIVE for this type");
564 /* Insert the new one at the beginning */
565 p_new = (counter_sample_t*)malloc( sizeof( counter_sample_t ) );
567 p_new->date = p_counter->last_update;
568 INSERT_ELEM( p_counter->pp_samples, p_counter->i_samples,
571 if( p_counter->i_samples == 3 )
573 p_old = p_counter->pp_samples[2];
574 REMOVE_ELEM( p_counter->pp_samples, p_counter->i_samples, 2 );
580 if( p_counter->i_samples > 1)
582 msg_Err( p_handler, "LAST counter has several samples !" );
585 if( p_counter->i_samples == 0 )
587 counter_sample_t *p_new = (counter_sample_t*)malloc(
588 sizeof( counter_sample_t ) );
589 p_new->value.psz_string = NULL;
591 INSERT_ELEM( p_counter->pp_samples, p_counter->i_samples,
592 p_counter->i_samples, p_new );
594 if( p_counter->i_samples == 1 )
596 switch( p_counter->i_type )
598 case VLC_VAR_INTEGER:
600 p_counter->pp_samples[0]->value.i_int += val.i_int;
603 msg_Err( p_handler, "Trying to increment invalid variable %s",
604 p_counter->psz_name );
613 static counter_t *GetCounter( stats_handler_t *p_handler, int i_object_id,
614 const char *psz_name )
617 return (counter_t *)vlc_HashRetrieve( p_handler->p_counters, p_handler->i_counters,
618 i_object_id, psz_name );
622 static stats_handler_t *stats_HandlerGet( vlc_object_t *p_this )
624 stats_handler_t *p_handler = (stats_handler_t*)
625 vlc_object_find( p_this->p_vlc, VLC_OBJECT_STATS,
629 p_handler = stats_HandlerCreate( p_this );
634 vlc_object_yield( p_handler );
640 * Initialize statistics handler
642 * This function initializes the global statistics handler singleton,
643 * \param p_this the parent VLC object
645 static stats_handler_t* stats_HandlerCreate( vlc_object_t *p_this )
647 stats_handler_t *p_handler;
649 msg_Dbg( p_this, "creating statistics handler" );
651 p_handler = (stats_handler_t*) vlc_object_create( p_this,
656 msg_Err( p_this, "out of memory" );
659 p_handler->i_counters = 0;
660 p_handler->p_counters = (hashtable_entry_t *) malloc( 5 * sizeof( variable_t ) );
662 /// \bug is it p_vlc or p_libvlc ?
663 vlc_object_attach( p_handler, p_this->p_vlc );
668 static void TimerDump( vlc_object_t *p_obj, counter_t *p_counter,
673 if( !p_counter || p_counter->i_samples != 2 )
675 msg_Err( p_obj, "timer %s does not exist", p_counter->psz_name );
678 i_total = p_counter->pp_samples[1]->value.i_int;
679 total = p_counter->pp_samples[1]->date;
680 if( p_counter->pp_samples[0]->value.b_bool == VLC_TRUE )
682 last = mdate() - p_counter->pp_samples[0]->date;
688 last = p_counter->pp_samples[0]->date;
693 "TIMER %s : %.3f ms - Total %.3f ms / %i intvls (Avg %.3f ms)",
694 p_counter->psz_name, (float)last/1000, (float)total/1000, i_total,
695 (float)(total)/(1000*(float)i_total ) );
700 "TIMER %s : Total %.3f ms / %i intvls (Avg %.3f ms)",
701 p_counter->psz_name, (float)total/1000, i_total,
702 (float)(total)/(1000*(float)i_total ) );