Questa pagina descrive il IV Progetto di LPR 2009/10.

Si vuole realizzare un juke-box condiviso adatto al XXI secolo. Il sistema dovrà consentire a un insieme di utenti di condividere la propria musica; il sistema seleziona casualmente un brano da questo insieme, e provvede ad inviarlo in streaming a tutti gli utenti collegati. Una caratteristica fondamentale del juke-box condiviso è la sua natura sociale: è importante che tutti gli utenti ascoltino la stessa musica (ciascuno dal proprio computer, magari con una cuffia), in modo da incoraggiare i commenti e gli scambi di opinioni sulla musica che viene trasmessa, in presenza o tramite una chat (che non è parte del presente progetto).

Complessivamente, il sistema si comporta quindi come una web radio, limitata però a un piccolo gruppo di utenti, e il cui palinsenso è costruito in base ai contributi musicali degli utenti stessi.

Ogni utente del juke-bok è dotato di un programma, che normalmente funge da client, ma occasionalmente può fungere anche da server. Al programma viene fornito, come parametro di riga di comando, l'indirizzo IP di un gruppo multicast; ogni gruppo avrà un server e un numero qualunque di client. All'avvio, il programma invia sul gruppo una richiesta di join. Se non viene ricevuta risposta entro 10 secondi, il programma si auto-nomina server per il gruppo multicast, e prosegue normalmente (dovrà svolgere da ora in poi i compiti di client e server). Se invece riceve una accettazione da parte di un server, si predispone a fungere da client per quel server. Una volta stabilito il contatto con il server, il client invia la lista della musica che ha a disposizione, attraverso una serie di messaggi disponibile. Dopo aver trasmesso la lista al server, il client si pone in attesa di ricevere dal server un comando play, che contiene l'indicazione di quale brano (fra quelli disponibili al client) eseguire. L'esecuzione consiste nell'invio dei dati audio sul gruppo multicast, per la riproduzione da parte di tutti i client (incluso quello che li sta inviando), come meglio specificato sotto.

Il ciclo di funzionamento del client è dunque duplice:

1. individua il server
2. invia la lista dei tuoi brani al server
3. attendi comando play
4. esegui lo streaming del brano
5. goto 3

e

1. attendi che inizi lo streaming di un brano
2. riproducilo sul dispositivo audio
3. goto 1

Il ciclo di funzionamento del server è anch'esso duplice:

1. attendi richieste di join
2. servile, ricevendo la lista dei brani
3. goto 1

e

1. scegli un brano a caso fra quelli disponibili
2. invia il comando play al client relativo
3. attendi che sia terminato lo streaming
4. goto 1

Per semplicità, il progetto non richiede comportamenti specifici in caso di terminazione o blocco del server o di alcuni client, o di auto-proclamazione di più server dovuta a “race condition” (in pratica, non è richiesta l'implementazione di un vero protocollo distribuito di leader election); gli studenti sono comunque invitati a gestire in maniera ragionevole questi casi.

Il juke-box distribuito deve essere implementato in modo che client e server diversi possano interoperare. Per questo motivo, tutte le comunicazioni devono rispettare scrupolosamente un protocollo ben definito.

Il sistema prevede tre flussi distinti di comunicazione:

• fra client e server (via UDP in broadcast) per la registrazione iniziale;
• fra client e server (via TCP) per i dati di controllo;
• fra client e client+server (via UDP in broadcast) per l'audio in streaming.

La richiesta di join ha il seguente formato:

ovvero, un pacchetto di 32 bit contenente i codici ASCII delle lettere che formano la parola “JOIN”. A questa richiesta il server, se presente, risponde con un messaggio di accettazione così composto:

con cui il server invita il nuovo client a contattarlo (via TCP) all'indirizzo IP e porta indicati per la prossima fase della conversazione.

L'invio dell'elenco dei brani disponibili di un cliente avviene tramite l'invio di 0 o più messaggi che elencano la musica disponibile. Ogni pacchetto ha il seguente formato:

in cui l'id è un intero a 16 bit assegnato a discrezione del client (che però deve essere unico, per ogni brano, all'interno del client), mentre il titolo è una stringa ASCII di lunghezza qualunque, terminata dal codice NUL (ovvero, un byte di valore 0). Per semplicità, non sono previsti messaggi per rimuovere un brano una volta aggiunto.

Il server può richiedere al client di iniziare lo streaming di un brano con il comando play, che ha il seguente formato:

in cui l'id è il valore a suo tempo comunicato dal client che identifica il brano da eseguire. In risposta a un comando play, il client inizia a inviare in streaming i dati audio come indicato sotto.

L'invio in streaming di un brano avviene in tre parti: dapprima si invia una intestazione per il file, quindi si inviano, in maniera cadenzata, i frame che compongono l'audio vero e proprio; per finire, si invia un indicatore di terminazione. Per quanto riguarda in particolare i frame contenenti i dati audio, è importante che questi siano inviati alla giusta frequenza, in base anche al formato audio impiegato, in modo da non sovraccaricare i buffer di ricezione degli altri clienti. Sia il client che invia l'audio, sia quelli che lo ricevono, devono lavorare in streaming: _non è accettabile_ trasferire l'intero file prima di riprodurlo. In particolare, il sistema deve essere in grado di gestire brani di lunghezza qualunque, e i client che ricevono l'audio non possono scrivere su disco (e ci sono ovvi limiti a quanti dati audio possono essere tenuti in memoria in attesa di essere riprodotti).

I pacchetti per l'invio dei dati audio sono come segue:

All'inizio della trasmissione, il client originatore invia un pacchetto BEGI indicando un proprio id (preferibilmente, un numero casuale) che serve a identificare lo stream (e distinguere i dati di questo stream da quelli di altri eventuali stream che altri client potrebbero inviare, erronamente, in contemporanea sul gruppo multicast); viene anche inviato il titolo del brano, che gli altri client possono visualizzare all'utente.

I pacchetti DATA contengono, oltre all'id dello stream, l'indicazione della lunghezza dei dati, seguita dai dati veri e propri.

Al termine della trasmissione dei dati audio, il client originatore invia un pacchetto ENDF, che indica il completamento dello stream.

File f = new File("/usr/share/sounds/warning.wav");
AudioInputStream ais=AudioSystem.getAudioInputStream(f);
AudioFormat af=ais.getFormat();
SourceDataLine sdl=AudioSystem.getSourceDataLine(af);
int bufsize=(int) (af.getSampleRate()*af.getFrameSize());
byte[] buffer = new byte[bufsize];
sdl.open(af);
if( sdl.isControlSupported( FloatControl.Type.MASTER_GAIN ) ) {
   FloatControl volume = (FloatControl) sdl.getControl( FloatControl.Type.MASTER_GAIN );
   volume.setValue( volume.getMaximum() );
}
 
sdl.start();
int l=1;
while (l>=0) {
   l=ais.read(buffer);
   if (l>=0) sdl.write(buffer, 0,l);
}
sdl.drain();
sdl.stop();
sdl.close();

VECCHIO PROGETTO:

Client e server comunicano tramite un unico canale tramite TCP. Tutte le comunicazioni sono iniziate dal client.

Il protocollo di comunicazione è basato sullo scambio di comandi e risposte di un singolo byte; alcuni comandi considerano il byte suddiviso in campi di bit, a cui sono assegnati specifici significati; in altri casi, i byte vengono interpretati come valori numerici a 8 bit.

Ciascun cliente deve inviare almeno un messaggio ogni 5 secondi (altrimenti viene dichiarato morto di sonno e chiuso). Per prevenire lo spamming, il server ignora ogni messaggio che sia ricevuto dopo meno di 50ms dal messaggio precedente dello stesso client. È comunque possibile inviare poi in seguito altri messaggi, sempre rispettando i vincoli temporali di cui sopra. Si noti che se un messaggio ignorato prevedeva una risposta, la risposta non verrà inviata: è quindi opportuno assicurarsi di non inviare messaggi troppo ravvicinati, oppure prendere le dovute cautele per rilevare, con un timeout, il caso in cui una risposta attesa non arrivi in tempo. In condizioni normali, le risposte ai comandi vengono inviate immediatamente dopo la ricezione ed elaborazione del comando da parte del server.

Tentativi di sabotare il server o il protocollo sono lodevoli, ma considerati illegali ai fini dell'esame. È possibile contattare il docente per verificare la “legalità” di una tecnica non ortodossa che si intende usare. È altresì considerato illegale usare nella propria implementazione classi del server o del client di esempio, estratte dal codice fornito.

I comandi hanno la seguente struttura:

• bit 7-6: riservati per future espansioni
• bit 5-2: opcode di comando
• bit 1-0: codice di direzione

Per il comando GPS, il sistema di coordinate utilizzato è quello consueto (in Informatica), con (0,0) nell'angolo in alto a sinistra, e coordinate crescenti verso destra e verso il basso.

Se il robot non dispone di energia sufficiente a eseguire un comando, l'azione corrispondente non viene eseguita (ma, se prevista, viene inviata una risposta come di consueto). La batteria viene ricaricata dalle celle fotovoltaiche al ritmo di 2 unità ogni secondo. La carica massima della batteria è di 255 unità, e i robot entrano in gioco con la batteria carica al massimo.

Il protocollo, i formati, e il tipo di comunicazione (tipicamente: TCP, UDP, Multicast o RMI) fra client sono interamente a discrezione dello studente, che dovrà darne documentazione nella relazione. In ogni caso, i vari clienti devono essere istanze dello stesso eseguibile, eseguite su JVM distinte e potenzialmente su macchine diverse. Non è ammessa la comunicazione fra client che utilizzi tecniche diverse dalla comunicazione via rete.

Se il server riconosce un errore nel comportamento del client, la comunicazione viene interrotta (il giocatore rimane registrato ma viene “espulso” dal gioco). Il server segnala tali errori emettendo una eccezione (con l'indicazione del giocatore che ha causato l'errore e del tipo di errore). Il timeout di una comunicazione è considerato un errore, così come l'invio di comando invalidi. Lo “spamming” non è invece considerato un errore, ma i comandi in eccesso vengono scartati. Quando un robot viene distrutto, il client relativo viene sconnesso; questo caso non è considerato un errore (ma essere distrutti non fa piacere a nessuno). Il gioco non prevede la possibilità di de-registrare un giocatore, né un esplicito “fine partita”; ogni esecuzione del server corrisponde a una partita, che può essere interrotta in qualunque momento interrompendo il server (da tastiera con Ctrl-C o chiudendo la sua finestra).

Ogni studente che vuole sostenere l'esame di LPR deve consegnare il progetto svolto al docente del corso di appartenenza (Prof. Gervasi per il Corso A, Prof. Corradini per il Corso B). Il progetto deve essere sottomesso individualmente, ma può essere svolto da un gruppo di due studenti al massimo: in questo caso nel progetto va indicato esplicitamente il collega con cui si è collaborato. L'esame orale del corso, che comprende la discussione del progetto, sarà individuale: ciascuno studente è responsabile dell'intero progetto consegnato.

Per poter essere valutato, il codice del client sviluppato nel progetto deve essere in grado di interagire senza errori con il server pubblicato in questa pagina, in una o più istanze (l'esatto numero verrà comunicato dopo l'iscrizione degli studenti alla gara finale) eseguite su host diversi o anche sullo stesso host. Il progetto deve funzionare correttamente sulle macchine del CLI, dove verrà testato.

Il codice del progetto deve essere ben commentato e deve essere accompagnato da una relazione di 3-5 pagine che descrive l'organizzazione del codice, le strategie realizzate per il funzionamento del singolo client e per la collaborazione tra più client, e le politiche di sincronizzazione tra thread utilizzate. Inoltre occorre produrre un breve manuale d'uso che descrive i comandi necessari per avviare le varie istanze del client, sia su uno stesso host che su host diversi.

Codice, relazione e manuale d'uso devono essere inviati per posta elettronica al docente del corso entro le ore 24 di lunedì 21 Giugno 2010. Progetti inviati dopo tale scadenza non verranno ammessi, e lo studente dovrà svolgere un nuovo progetto che verrà pubblicato successivamente.

I progetti sottomessi verranno testati durante un evento pubblico; i dettagli verranno forniti in seguito.

L'implementazione del cliente di esempio (che sarebbe già sufficiente ai fini dell'esame, tranne che per la mancanza di coordinamento) consta di circa 100 righe di codice Java (di cui circa 60 significative); si consiglia agli studenti di iniziare con un'implementazione semplice, e poi eventualmente dedicarsi al miglioramento dell'efficienza e delle strategie. Si noti che ai fini della valutazione verranno considerati primariamente:

• la correttezza dell'uso delle tecniche di multithreading e di comunicazione di rete;
• il design e l'implementazione del protocollo inter-client;
• l'efficienza della soluzione (sia in termini di uso delle risorse che di efficacia della strategia complessiva della squadra);
• la qualità complessiva di scrittura del codice e della relazione.

Nella parte orale verranno invece verificate le conoscenze teoriche su tutti gli argomenti trattati nel corso.

Si raccomanda di verificare in anticipo il funzionamento dei client sulle macchine del Centro di Calcolo (Laboratori H-Lab e M-Lab), su cui verrà svolto il “torneo” finale dopo la data di consegna. Si raccomanda altresì di contattare i docenti, a ricevimento o per email, prima della consegna in caso di dubbi sull'interpretazione del testo.

Per lanciare più istanze del client in maniera rapida, si può usare un comando di shell di questo tipo:

for i in 1 2 3; do java -jar Laprore-Client2.jar Test-$i & done

o un suo equivalente su altri sistemi operativi.

Come è definita una “squadra”?
Non esiste sul server il concetto di squadra; dal punto di vista del server, si tratta di robot singoli. Ai fini dell'esame, una “squadra” è l'insieme delle istanze di un client lanciate dallo stesso studente (sulla stessa macchina o anche, potenzialmente, su macchine diverse). Sta allo studente implementare una qualche strategia di comunicazione per consentire il loro coordinamento (per esempio, per riconoscersi l'un l'altro ed evitare di distruggersi a vicenda).

Il server mi restituisce a volte -1 in risposta al comando BATTERY, è un errore del server?
No, il valore restituito è del tutto corretto. Si raccomanda di verificare la propria interpretazione del valore, perché… En este mundo traidor, nada es verdad, ni mentira: todo es según el color del cristal con que se mira.