# &MCOP;: objektmodell och strömmar

## Översikt

&MCOP; är standarden som &arts; använder för:

- Kommunikation mellan objekt.

- Nätverkstransparens.

- Beskriva objektgränssnitt.

- Språkoberoende.

En viktig del av &MCOP; är gränssnittsbeskrivningsspråket, &IDL;, som används för att definiera många av &arts; programmeringsgränssnitt och andra gränssnitt på ett språkoberoende sätt.

För att använda ett &IDL;-gränssnitt från C++, kompileras det med &IDL; kompilatorn till C++ kod. När du implementerar ett gränssnitt, härleder du från stomklassen som &IDL; kompilatorn har skapat. När man använder ett gränssnitt gör man det med ett omgärdande skal. På det här sättet kan &MCOP; använda ett protokoll om objektet du pratar med inte är lokalt - man får nätverkstransparens.

Det här kapitlet är ämnat att beskriva de grundläggande funktionerna i objektmodellen som är resultatet av att använda &MCOP;, protokollet, hur &MCOP; används med C++ (språkbindning), och så vidare.

## Gränssnitt och &IDL;

Mycket av den service som tillhandahålls av &arts;, som modulerna och ljudservern definieras i form av gränssnitt. Gränssnitt specificeras i ett programspråksoberoende format: &IDL;.

Det här tillåter att många av implementeringsdetaljerna som formatet på multimediadataflöden, nätverkstransparens och programspråksoberoende döljs för specifikationen av gränssnittet. Ett verktyg, &mcopidl;, översätter gränssnittsdefinitionen till ett specifikt programspråk (för närvarande stöds enbart C++).

Verktyget skapar en stomklass med all standardkod och grundläggande funktionalitet. Man härleder från den här klassen för att implementera de funktioner man vill ha.

Det &IDL; som används av &arts; liknar det som används av CORBA och DCOM.

&IDL;-filer kan innehålla:

- C-stil #include-direktiv för andra &IDL;-filer.

- Definitioner av uppräkningstyper och struct-typer, som i C/C++.

- Definitioner av gränssnitt.

I &IDL; definieras gränssnitt på ett sätt som påminner mycket om en C++ klass eller C-struct, dock med vissa begränsningar. Som i C++, så kan gränssnitt vara underklasser till andra gränssnitt med arv. Gränssnittsdefinitioner kan innehålla tre saker: Strömmar, egenskaper och metoder.

### Strömmar

Strömmar definierar multimediadata, en av de viktigaste komponenterna i en modul. Strömmar definieras med följande format:

[ async ] in|out [ multi ] typ stream namn [ , namn ] ;

Strömmar har en definierad riktning i förhållande till modulen, som anges av de nödvändiga bestämningarna in eller out. Typargumentet definierar datatypen, som kan vara vilken som helst av typerna för egenskaper som beskrivs senare (alla stöds inte än). Många moduler använder strömtypen audio, som är ett alias för float eftersom det är det interna dataformatet för ljudströmmar. Flera strömmar av samma typ kan ingå i samma definition med namn separerade med kommatecken.

Strömmar är normalt synkrona, vilket betyder att de är kontinuerliga dataflöden med en konstant hastighet, som PCM-ljud. Bestämningen async anger en asynkron ström, som används för icke-kontinuerliga dataflöden. Det vanligaste exemplet på en asynkron ström är &MIDI;-meddelanden.

Nyckelordet multi, som bara är giltigt för indataströmmar, anger att gränssnittet stöder ett variabelt antal ingångar. Det här är användbart för att implementera enheter som en mixer som kan ta emot vilket antal indataströmmar som helst.

### Egenskaper

Egenskaper är data som hör ihop med en instans av ett gränssnitt. De deklareras som medlemsvariabler i C++, och kan använda vilken som helst av de primitiva typerna boolean, byte, long, string, eller float. Du kan också använda egendefinierade struct- eller uppräkningstyper samt sekvenser av variabel storlek med syntaxen sekvens<typ>. Egenskaper kan valfritt markeras som skrivskyddade.

### Metoder

Som i C++, kan metoder definieras i gränssnitt. Metodparametrarna är begränsade till samma typer som egenskaperna. Nyckelordet oneway anger en metod som returnerar omedelbart och körs asynkront.

### Standardgränssnitt

Flera gränssnitt för standardmoduler är redan definierade åt dig i &arts;, som StereoEffect, och SimpleSoundServer.

### Exempel

Ett enkelt exempel på en modul taget från &arts; är modulen med konstant fördröjning, som finns i filen `kdemultimedia/arts/modules/artsmodules.idl`. Gränssnittsdefinitionen anges nedan:

    interface Synth_CDELAY : SynthModule {
            attribute float time;
            in audio stream invalue;
            out audio stream outvalue;
    };

Modulen ärver SynthModule. Det gränssnittet, som finns i `artsflow.idl`, definierar alla standardmetoder som implementeras i alla syntesmoduler.

CDELAY-effekten fördröjer ett stereoljudflöde med tidsvärdet som anges som en flyttalsparameter. Gränssnittsdefinitionen har ett attribut av typen float för att lagra fördröjningsvärdet. Det definierar två indata- och två utdataströmmar (typiskt för stereoeffekter). Inga metoder krävs förutom de ärvda.

## Mer om strömmar

Det här avsnittet täcker en del ytterligare ämnesområden som hör ihop med strömmar.

### Strömtyper

Det finns olika krav för hur en modul kan hantera flöden. För att illustrera detta, betrakta följande exempel:

- Skala en signal med en faktor två.

- Utför frekvenskonvertering av samplingar.

- Packa upp en runlength-kodad signal.

- Läs &MIDI;-händelser från `/dev/midi00` och infoga dem i en ström.

Det första fallet är det enklaste: när modulen tar emot 200 indatasamplingar producerar den 200 utdatasamplingar. Den producerar bara utdata när den får indata.

Det andra fallet producerar olika antal utdatasamplingar när den får 200 indatasamplingar. Det beror på vilken konvertering som utförs, men antalet är känt i förväg.

Det tredje fallet är ännu värre. Från utdata kan man inte ens gissa hur mycket data som skapas av 200 indatabyte (förmodligen mycket mer än 200 byte, men...).

Det sista fallet är en modul som aktiveras av sig själv, och ibland skapar data.

I &arts;s-0.3.4, hanterades bara strömmar av den första typen, och de flesta saker fungerade bra. Det här är troligen vad du behöver mest när du skriver moduler som behandlar ljud. Problemen med de andra, mer komplexa sorternas flöden, är att de är svåra att programmera, och att man inte behöver funktionerna för det mesta. Det här är orsaken vi gör detta med två olika sorters strömtyper: synkrona och asynkrona.

Synkrona strömmar har följande egenskaper:

- Moduler måste kunna beräkna data av vilken längd som helst, med tillräckligt mycket indata.

- Alla strömmar har samma samplingsfrekvens.

- Funktionen `calculateBlock()` anropas när tillräckligt med data är tillgängligt, och modulen kan lita på att pekarna anger data.

- Det finns ingen allokering eller avallokering att göra.

Asynkrona strömmar, å andra sidan, beter sig så här:

- Moduler kan producera data ibland, eller med olika samplingsfrekvens, eller bara om de får indata från någon fil. De måste inte följa regeln måste kunna hantera begäran av vilken storlek som helst.

- Asynkrona strömmar för en modul kan ha helt skilda samplingsfrekvenser.

- Utgående strömmar: det finns särskilda funktioner för att allokera paket, att skicka paket och en valfri mekanism för att fråga efter data som talar om när mer data ska skapas.

- Inkommande strömmar: ett anrop skickas när ett nytt paket tas emot. Man måste tala om när man är färdig med att behandla all data i det paketet, och detta får inte ske omedelbart (man kan tala om det när som helst senare, och om alla har behandlat ett paket, kommer det att frigöras/återanvändas).

När strömmar deklareras, används nyckelordet async för att ange att strömmen ska vara asynkron. Så anta till exempel att du vill konvertera en asynkron ström av byte till en synkron ström av samplingar. Gränssnittet skulle då kunna se ut så här:

    interface ByteStreamToAudio : SynthModule {
        async in byte stream indata;   // den asynkrona indatasamplingen

        out audio stream left,right;   // de synkrona utdatasamplingarna
    };

### Att använda asynkrona strömmar

Antag att du har bestämt dig för att skriva en modul som skapar asynkront ljud. Dess gränssnitt kan se ut så här:

    interface SomeModule : SynthModule
    {
        async out byte stream outdata;
    };

Hur skickar man data? Den första metoden kallas tryckleverans. Med asynkrona strömmar skickar man data som paket. Det betyder att individuella paket skickas som i exemplet ovan. Den verkliga processen är: allokera ett paket, fyll det, skicka det.

Här följer det i form av kod. Först allokerar vi ett paket:

    DataPacket<mcopbyte> *packet = outdata.allocPacket(100);

Vi fyller det:

    // typkonvertera så att fgets får en (char *) pekare
    char *data = (char *)packet->contents;

    // som du ser, kan du krympa paketstorleken efter allokeringen
    // om du vill
    if(fgets(data,100,stdin))
        packet->size = strlen(data);
    else
        packet->size = 0;

Nu skickar vi det:

    packet->send();

Det här är mycket enkelt, men om vi vill skicka paket precis så snabbt som mottagaren kan hantera dem, behövs ett annat sätt, metoden med dragleverans. Man begär att skicka paket så snabbt som mottagaren är klar att behandla dem. Man börjar med en viss mängd paket som skickas. Medan mottagaren behandlar paket efter paket, börjar man fylla i dem med färsk data, och skickar dem igen.

Du startar det genom att anropa setPull. Till exempel:

    outdata.setPull(8, 1024);

Det här betyder att du vill skicka paket via outdata. Du vill börja med att skicka 8 paket på en gång, och när mottagaren behandlar några av dem, vill du fylla dem igen.

Därefter behöver du implementera en metod som fyller paketen, som skulle kunna se ut så här:

    void request_outdata(DataPacket<mcopbyte> *packet)
    {
        packet->size = 1024;  // ska inte vara mer än 1024
        for(int i = 0;i < 1024; i++)
            packet->contents[i] = (mcopbyte)'A';
        packet->send();
    }

Det är allt. När du inte har mer data, kan du börja skicka paket med storleken noll, som stoppar dragleveranserna.

Observera att det är väsentligt att ge metoden exakt namnet request_strömnamn.

Vi beskrev just att skicka data. Att ta emot data är mycket enklare. Antag att du har ett enkelt filter, ToLower, som helt enkelt konverterar alla bokstäver till små:

    interface ToLower {
        async in byte stream indata;
        async out byte stream utdata;
    };

Det här är verkligt enkelt att implementera. Här är hela implementationen:

    class ToLower_impl : public ToLower_skel {
    public:
        void process_indata(DataPacket<mcopbyte> *inpacket)
        {
            DataPacket<mcopbyte> *outpacket = outdata.allocPacket(inpacket->size);

            // omvandla till små bokstäver
            char *instring = (char *)inpacket->contents;
            char *outstring = (char *)outpacket->contents;

            for(int i=0;i<inpacket->size;i++)
                outstring[i] = tolower(instring[i]);

            inpacket->processed();
            outpacket->send();
        }
    };

    REGISTER_IMPLEMENTATION(ToLower_impl);

Återigen är det väsentligt att ge metoden namnet process_strömnamn.

Som du kan se, så får du ett anrop till en funktion för varje paket som anländer (`process_indata` i vårt fall). Du måste anropa metoden processed() för ett paket för att ange att du har behandlat det.

Här är ett implementeringstips: Om det tar lång tid att behandla data (dvs. om du måste vänta på utmatning till ljudkortet eller något sådant), anropa inte processed omedelbart, utan lagra hela datapaketet och anropa processed bara när du verkligen har behandlat paketet. På detta sätt, har avsändarna en chans att veta hur lång tid det verkligen tar att utföra arbetet.

Eftersom synkronisering inte är så trevlig med asynkrona strömmar, ska man använda synkrona strömmar så ofta det är möjligt, och asynkrona bara om det är nödvändigt.

### Förvalda strömmar

Antag att du har två objekt, till exempel en AudioProducer och en AudioConsumer. AudioProducer har en utdataström och AudioConsumer har en indataström. Varje gång du vill förbinda dem, använder du de här två strömmarna. Den första användningen av förval är att låta dig upprätta förbindelsen utan att ange portarna i det här fallet.

Antag nu att de två objekten ovan kan hantera stereo, och båda har en vänster och höger port. Du skulle fortfarande vilja kunna koppla ihop dem lika lätt som tidigare. Men hur kan förbindelsesystemet veta vilken utgång som ska kopplas till vilken ingång? Det har inget sätt att koppla ihop strömmarna korrekt. Förval används då för att ange flera strömmar med en viss ordning. På så sätt, om du ansluter ett objekt med två förvalda utdataströmmar till ett annat med två förvalda indataströmmar, behöver du inte ange portarna, och förbindelserna görs på ett riktigt sätt.

Det här är förstås inte begränsat till stereo. Vilket antal strömmar som helst kan göras förvalda om det behövs, och anslutningsfunktionen kontrollerar att antalet förval för två objekt passar ihop (med de angivna riktningarna) om du inte anger portarna som ska användas.

Syntaxen är den följande: I &IDL; kan du använda nyckelordet default i strömdeklarationen, eller på en ensam rad. Till exempel:

    interface TwoToOneMixer {
        default in audio stream input1, input2;
        out audio stream output;
    };

I det här exemplet kommer objektet att förvänta sig att dess två indataportar ska anslutas med förval. Ordningen är den som anges på raden, så ett objekt som det här:

    interface DualNoiseGenerator {
        out audio stream bzzt, couic;
        default couic, bzzt;
    };

skapar automatiskt en förbindelse från couic till input1, och bzzt till input2 Observera att eftersom det bara finns en utgång för mixern, kommer den att vara förvald i det här fallet (se nedan). Syntaxen som används i brusgeneratorn är användbar för att ange en annan ordning än i deklarationen, eller för att välja bara några få portar som förval. Riktningen på portarna på den här raden slås upp av &mcopidl;, så ange dem inte. Du kan till och med blanda in- och utportar på en sådan här rad, bara ordningen spelar roll.

Det finns några regler som följs när arv används:

- Om en förvalslista anges i &IDL; så måste den användas. En förälders portar kan också ingå i listan, vare sig de var förval i föräldern eller inte.

- Annars ärvs förälderns förval. Ordningen är förälder1 förval1, förälder1 förval2..., förälder2 förval1... Om det finns en gemensam förfader som använder två föräldragrenar, görs en hopslagning som liknar virtual public vid förvalets första plats i listan.

- Om det fortfarande inte finns något förval och en enda ström i en viss riktning, så används den som förval för den riktningen.

## Ändringsmeddelanden för egenskaper

Ändringsmeddelanden för egenskaper är ett sätt att veta när en egenskap ändras. De kan i viss utsträckning jämföras med en &Qt;- eller Gtk-signal eller slot. Om du till exempel har ett grafiskt element, ett skjutreglage, som ställer in ett tal mellan 0 och 100, har du oftast ett objekt som gör något med talet (det kan till exempel kontrollera volymen på någon ljudsignal). Så du skulle vilja att så fort skjutreglaget flyttas ska objektet som ställer in volymen bli underrättat. En förbindelse mellan en sändare och mottagare.

&MCOP; hanterar detta genom att kunna ge meddelanden när egenskaper ändras. Allt som deklareras som attribute i &IDL; kan avge sådana ändringsmeddelanden, och ska göra det, när de än ändras. Allt som deklareras som attribute kan också ta emot sådana ändringsmeddelanden. Så om du till exempel har två &IDL;-gränssnitt som de här

    interface Slider {
             attribute long min,max;
             attribute long position;
     };
     interface VolumeControl : Arts::StereoEffect {
         attribute long volume; // 0..100
     };

kan du förbinda dem med ändringsmeddelanden. Det fungerar med det normala flödessystemets anslutningsoperation. I det här fallet, ser C++ koden som ansluter två objekt ut så här:

    #include <connect.h>
    using namespace Arts;
    [...]
    connect(slider,"position_changed",volumeControl,"volume");

Som du kan se, erbjuder varje egenskap två olika strömmar, en för att skicka ändringsmeddelanden, som heter `egenskapsnamn_changed`, och en för att ta emot ändringsmeddelanden, som heter `egenskapsnamn`.

Det är viktigt att veta att ändringsmeddelanden och asynkrona strömmar passar ihop. De är också nätverkstransparenta. Så du kan ansluta en flyttalsegenskaps ändringsmeddelande för en grafisk komponent till en asynkron ström för en syntesmodul som kör på en annan dator. Det här betyder förstås också att ändringsmeddelanden inte är synkrona, vilket betyder att det kan ta tid innan de verkligen tas emot efter du har skickat dem.

### Att skicka ändringsmeddelanden

När du implementerar objekt som har egenskaper, måste du skicka ändringsmeddelanden så snart en egenskap ändras. Koden för att göra detta ser ut så här:

    void KPoti_impl::value(float newValue)
     {
         if(newValue != _value)
         {
             _value = newValue;
             value_changed(newValue); // <- skicka ändringsmeddelande
         }
     }

Det rekommenderas varmt att använda kod som den här för alla objekt som du implementerar, så att ändringsmeddelanden kan användas av andra. Du bör dock undvika att skicka meddelanden för ofta, så om du gör signalbehandling är det troligen bäst att hålla reda på när du skickade ditt senaste meddelande, så att du inte skickar ett för varje sampling.

### Tillämpningar för ändringsmeddelanden

Det kommer att vara särskilt användbart att använda ändringsmeddelanden tillsammans med mätare (objekt som till exempel visualiserar ljuddata), grafiska gränssnitt, styrelement och monitorer. Kod som använder det här finns i `kdelibs/arts/tests`, och i den experimentella artsgui-implementeringen, som du hittar i `kdemultimedia/arts/gui`.

## Filen `.mcoprc`

Filen `.mcoprc` (i varje användares hemkatalog) kan användas för att anpassa &MCOP; i viss mån. För närvarande är följande möjligt:

GlobalComm

  Namnet på ett gränssnitt som ska användas för global kommunikation. Global kommunikation används för att hitta andra objekt och hämta den hemliga kakan. Alla &MCOP; klienter/servrar som ska kunna kommunicera med varandra måste ha ett GlobalComm-objekt för att kunna dela information. För närvarande är de möjliga värdena Arts::TmpGlobalComm för att kommunicera via katalogen `/tmp/mcop-användarnamn` (som bara fungerar på den lokala datorn) och Arts::X11GlobalComm för att kommunicera via rotfönsteregenskaperna på X11-servern.

TraderPath

  Anger var handlarinformation ska hittas. Du kan ange mer än en katalog här, och separera dem med kommatecken.

ExtensionPath

  Anger från vilka kataloger utökningar (i form av delade bibliotek) laddas. Flera värden kan separeras med kommatecken.

Ett exempel som använder allt det ovanstående är:

    # $HOME/.mcoprc file
    GlobalComm=Arts::X11GlobalComm

    # om du är en utvecklare kan det vara bekvämt att lägga till en katalog i din
    # hemkatalog till TraderPath/ExtensionPath sökvägarna för att kunna lägga
    # till komponenter utan att installera dem
    TraderPath="/opt/kde2/lib/mcop","/home/joe/mcopdevel/mcop"
    ExtensionPath="/opt/kde2/lib","/home/joe/mcopdevel/lib"

## &MCOP; för CORBA-användare

Om du har använt CORBA tidigare, kommer du att märka att &MCOP; är mycket likt. I själva verket så använde &arts; CORBA innan version 0.4.

Den grundläggande idén med CORBA är likadan: man implementerar objekt (komponenter). Genom att använda funktionerna i &MCOP; är objekt inte bara tillgängliga som normala klasser från samma process (via standardmässiga C++ tekniker), utan de är också transparent tillgängliga för en fjärrserver. För att detta ska fungera, är det första du måste göra att specificera gränssnittet för dina objekt i en &IDL;-fil, precis som för CORBA-&IDL;. Det finns bara ett fåtal skillnader.

### CORBA-funktioner som saknas i &MCOP;

I &MCOP; finns det inga in och out parametrar för metodanrop. Parametrar är alltid ingående, och returvärdet är alltid utgående, vilket betyder att gränssnittet:

    // CORBA idl
    interface Account {
      void deposit( in long amount );
      void withdraw( in long amount );
      long balance();
    };

skrivs som

    // MCOP idl
    interface Account {
      void deposit( long amount );
      void withdraw( long amount );
      long balance();
    };

i &MCOP;.

Det finns inget stöd för undantag. &MCOP; har inte undantag, det använder något annat för felhantering.

Det finns inga union-typer och inga typdefinitioner. Jag vet inte om det är en verklig svaghet, något man desperat behöver för att överleva.

Det finns inget stöd för att skicka gränssnitt eller objektreferenser

### CORBA-funktioner som är annorlunda i &MCOP;

Du deklarerar sekvenser som sequencetyp i &MCOP;. Det finns inget behov av en typdefinition. Till exempel, istället för:

    // CORBA idl
    struct Line {
        long x1,y1,x2,y2;
    };
    typedef sequence<Line> LineSeq;
    interface Plotter {
        void draw(in LineSeq lines);
    };

skulle du skriva

    // MCOP idl
    struct Line {
        long x1,y1,x2,y2;
    };
    interface Plotter {
        void draw(sequence<Line> lines);
    };

### &MCOP;-funktioner som inte finns i CORBA

Du kan deklarera strömmar, som sedan behandlas av &arts; grundstomme. Strömmar deklareras på ett sätt som liknar egenskaper. Till exempel:

    // MCOP idl
    interface Synth_ADD : SynthModule {
        in audio stream signal1,signal2;
        out audio stream outvalue;
    };

Det här betyder att ditt objekt kommer att acceptera två inkommande synkrona ljudströmmar som kallas signal1 och signal2. Synkron betyder att de är strömmar som levererar x samplingar per sekund (eller annan tid), så att schemaläggaren alltid garanterar att du får en balanserad mängd indata (t.ex. 200 samplingar av signal1 finns och 200 samplingar av signal2 finns). Du garanterar att om ditt objekt anropas med de här 200 samplingarna av signal1 + signal2, så kan det skapa precis 200 samplingar utdata.

### &MCOP;-bindningen till C++ språket

Det här skiljer sig från CORBA i huvudsak angående:

- Strängar använder C++ STL-klassen string. När de lagras i sekvenser, lagras de enkelt, vilket betyder att de anses vara en primitiv typ. Därför behöver de kopieras.

- long är enkla long (förväntas vara 32 bitar).

- Sekvenser använder C++ STL-klassen vector.

- Strukturer härleds alla från &MCOP; klassen Type, och skapas av &MCOP; &IDL;-kompilatorn. När de lagras i sekvenser, lagras de inte enkelt, utan som pekare, eftersom annars skulle för mycket kopiering uppstå.

### Att implementera &MCOP;-objekt

Efter att ha skickat dem genom &IDL;-kompilatorn, måste du härleda från klassen _skel. Antag till exempel att du har definierat gränssnittet så här:

    // MCOP idl: hello.idl
    interface Hello {
        void hello(string s);
        string concat(string s1, string s2);
        long sum2(long a, long b);
    };

Du skickar det genom &IDL;-kompilatorn genom att anropa ``mcopidl` hello.idl`, som i sin tur skapar `hello.cc` och `hello.h`. För att implementera det, behöver du en C++ klass som ärver stommen:

    // C++ deklarationsfil - infoga hello.h någonstans
    class Hello_impl : virtual public Hello_skel {
    public:
        void hello(const string& s);
        string concat(const string& s1, const string& s2);
        long sum2(long a, long b);
    };

Till sist måste du implementera metoderna som vanlig C++.

    // C++ implementeringsfil

    // som du ser skickas strängar som konstanta strängreferenser
    void Hello_impl::hello(const string& s)
    {
        printf("Hello '%s'!\n",s.c_str());
    }

    // när de är ett returvärde skickas de som "normala" strängar
    string Hello_impl::concat(const string& s1, const string& s2)
    {
        return s1+s2;
    }

    long Hello_impl::sum2(long a, long b)
    {
        return a+b;
    }

När du väl har gjort detta, har du ett objekt som kan kommunicera med &MCOP;. Skapa bara ett (med de normala C++ faciliteterna för att skapa ett objekt):

    Hello_impl server;

Och så fort du ger någon referensen

    string reference = server._toString();
        printf("%s\n",reference.c_str());

och går till &MCOP;:s väntesnurra

    Dispatcher::the()->run();

kan alla komma åt objektet med

    // den här koden kan köra var som helst - inte nödvändigtvis i samma process
    // (den kan också köra på en annan dator/arkitektur)

        Hello *h = Hello::_fromString([objektreferensen som skrevs ut ovan]);

och anropa metoder:

    if(h)
            h->hello("test");
        else
            printf("Åtkomst misslyckades?\n");

## Säkerhetshänsyn för &MCOP;

Eftersom en &MCOP;-server lyssnar på en TCP-port, kan potentiellt sett alla (om du är ansluten till Internet) försöka att ansluta till en &MCOP;-service. Därför är det viktigt att identifiera klienter. &MCOP; använder md5-auth protokollet.

Protokollet md5-auth gör följande för att försäkra att bara utvalda (pålitliga) klienter kan ansluta till en server:

- Det antar att du kan ge varje klient en hemlig kaka.

- Varje gång en klient ansluter, verifierar den att den här klienten känner till den hemliga kakan, utan att verkligen skicka den (inte ens på en form som någon som lyssnar på nätverkstrafik kan ta reda på).

För att ge varje klient den hemliga kakan, lägger &MCOP; (normalt) den i `mcop` katalogen (i `/tmp/mcop-`USER`/secret-cookie`). Du kan förstås kopiera den till andra datorer. Men om du gör det, använd då en säker överföringsmekanism, som `scp` (från ssh).

Identifieringen av klienter använder följande steg:

- [SERVER] skapa en ny (slumpmässig) kaka R

- [SERVER] skicka den till klienten

- [KLIENT] läs den "hemliga kakan" S från en fil

- [KLIENT] behandla kakorna R och S för att skapa kakan M med MD5-algoritmen

- [KLIENT] skicka M till servern

- [SERVER] verifiera att behandling av R och S ger precis samma sak som kakan M som togs emot från klienten. Om detta stämmer har identifieringen lyckats.

Den här algoritmen bör vara säker, under förutsättning att

1. De hemliga och slumpmässiga kakorna är slumpmässiga nog och

2. MD5-algoritmen inte tillåter att originaltexten kan avgöras, det vill säga den hemliga kakan S och den slumpmässiga kakan R (som är känd ändå), från den behandlade kakan M.

&MCOP;-protokollet startar varje ny förbindelse med en identifieringsprocess. Översiktligt ser den ut så här:

- Servern skickar meddelandet ServerHello, som beskriver de kända indentifieringsprotokollen.

- Klienten skickar meddelandet ClientHello, som innehåller identifieringsinformation.

- Servern skickar meddelandet AuthAccept.

För att se att säkerheten verkligen fungerar, bör vi titta på hur meddelanden behandlas för oidentifierade förbindelser:

- Innan identifieringen lyckas, tar inte servern emot andra meddelanden från anslutningen. Istället, om servern till exempel förväntar sig meddelandet ClientHello, och får meddelandet mcopInvocation, så kopplar den ner förbindelsen.

- Om klienten inte skickar ett giltigt &MCOP;-meddelande alls (inget magiskt värde &MCOP; i meddelandehuvudet) i identifieringsfasen, utan något annat, så kopplas förbindelsen ner.

- Om klienten försöker skicka ett mycket mycket stort meddelande (> 4096 byte) under identifieringsfasen, kapas meddelandestorleken till 0 byte, vilket gör att det inte accepteras som identifiering. Det här är till för att förhindra att oidentifierade klienter skickar t.ex. ett 100 Mibyte meddelande, som skulle tas emot och kunna orsaka att servern får slut på minne.

- Om klienten skickar ett felaktigt ClientHello meddelande (ett där avkodningen misslyckas), så kopplas förbindelsen ner.

- Om klienten inte skickar något alls, ska en tidsgräns överskridas (ännu inte implementerat).

## &MCOP; protokollspecifikation

### Inledning

Den har begreppsmässiga likheter med CORBA, men är avsett för att kunna utökas på alla sätt som krävs för multimediaoperationer i realtid.

Den tillhandahåller en multimediaobjektmodell, som både kan användas för kommunikation mellan komponenter i ett adressrum (en process), och mellan komponenter som finns i olika trådar, processer eller på olika värddatorer.

Totalt sett, kommer den att konstrueras för extremt hög prestanda (så att allt ska optimeras för att vara våldsamt snabbt), lämpligt för mycket kommunikationsintensiva multimediaprogram. Att till exempel skicka runt video är en av tillämpningarna för &MCOP;, där de flesta CORBA-implementeringar skulle gå på knäna.

Gränssnittsdefinitionerna kan hantera följande själv:

- Kontinuerliga dataflöden (som ljuddata).

- Händelseflöden av data (som &MIDI;-händelser).

- Riktig referensräkning.

och de viktigaste CORBA-knepen, som

- Synkrona metodanrop.

- Asynkrona metodanrop.

- Konstruera användardefinierade datatyper.

- Multipla arv.

- Skicka objektreferenser.

### &MCOP;:s meddelandekodning

Konstruktionsmål/idéer:

- Kodning ska vara enkelt att implementera.

- Avkodning kräver att mottagaren vet vilken typ som ska avkodas.

- Mottagaren förväntas använda all information, så möjlighet att hoppa över data finns bara i protokollet såtillvida att:

  - Om man vet att ett block av data kommer att tas emot, behöver man inte titta på varje del efter en slutmarkör.

  - Om man vet att en sträng kommer att tas emot, behöver man inte läsa till en noll-byte för att ta reda på dess längd vid avkodning, men,

  - Om man vet att en sekvens av strängar kommer att tas emot måste man titta på längden för var och en av dem för att ta reda på slutet för sekvensen, eftersom strängar har variabel längd. Men om strängarna används för någonting nyttigt, måste det göras i alla fall, så det här är ingen förlust.

- Så lite extra kostnad som möjligt.

Kodningen av de olika typerna visas i tabellen nedan:

Typ | Kodningsprocess | Resultat
--- | --- | ---
void | typen void kodas genom att utelämna den, så ingenting skrivs till strömmen för den. |
long | kodas som fyra byte, med den mest signifikanta först, så att talet 10001025 (som är 0x989a81) skulle kodas som: | `0x00 0x98 0x9a 0x81`
uppräkningstyper | kodas som long |
byte | kodas som en enda byte, så 0x42 skulle kodas som: | `0x42`
sträng | kodas som en long, som innehåller längden på den efterföljande strängen, och sedan sekvensen av tecken. Strängar måste sluta med en noll-byte (som ingår i längdberäkningen). inklusive den sista 0 byten i längdräkningen! hello skulle kodas som: | `0x00 0x00 0x00 0x06 0x68 0x65 0x6c 0x6c 0x6f 0x00`
boolean | kodas som en byte, som innehåller 0 om false eller 1 om true, så att det booleska värdet true kodas som: | `0x01`
flyttal | kodas med fyra-byte IEEE754 representationen, detaljerad dokumentation om hur IEEE fungerar finns här: http://twister.ou.edu/workshop.docs/ common-tools/ numerical_comp_guide/ ncg_math.doc.html och här: http://java.sun.com/docs/books/ vmspec/ 2nd-edition/ html/ Overview.doc.html. Så värdet 2,15 skulle kodas som: | `0x9a 0x99 0x09 0x40`
struct | En struktur kodas genom att koda dess innehåll. Det krävs inga ytterligare prefix eller suffix, så att strukturen
    struct test {
        string name;        // som är "hello"
        long value;         // som är 10001025  (0x989a81)
    };
skulle kodas som: |
    0x00 0x00 0x00 0x06   0x68 0x65 0x6c 0x6c
    0x6f 0x00 0x00 0x98   0x9a 0x81
sekvens | En sekvens kodas genom att lista antalet element som följer, och sedan koda elementen ett efter ett. Så en sekvens med tre "long a", med a[0] = 0x12345678, a[1] = 0x01 och a[2] = 0x42 skulle kodas som |
    0x00 0x00 0x00 0x03   0x12 0x34 0x56 0x78
    0x00 0x00 0x00 0x01   0x00 0x00 0x00 0x42

Om du behöver hänvisa till en typ, anges alla primitiva typer med namnen som finns ovan. Strukturer och uppräkningstyper får sina egna namn (som Header). Sekvenser benämns som *normal typ, så att en sekvens av long är *long och en sekvens av Header struct:ar är *Header.

### Meddelanden

Formatet på &MCOP;:s meddelandehuvud definieras av den här strukturen:

    struct Header {
        long magic;          // värdet 0x4d434f50, som kodas som MCOP
        long messageLength;
        long messageType;
    };

De möjliga meddelandetyperna är för närvarande

    mcopServerHello                = 1
     mcopClientHello                = 2
     mcopAuthAccept                        = 3
     mcopInvocation                        = 4
     mcopReturn                                = 5
     mcopOnewayInvocation   = 6

Lite information om &MCOP;:s meddelandehantering:

- Varje meddelande börjar med ett huvud.

- Vissa meddelandetyper ska ignoreras av servern, innan identifiering är färdig.

- Efter att huvudet tagits emot, kan protokollhanteringen (anslutningen) ta emot meddelandet i sin helhet, utan att titta på innehållet.

Meddelandelängden i huvudet är förstås redundant i vissa fall, vilket gör att metoden inte alltid är minimal med avseende på antal byte.

Detta ger dock en enkel (och snabb) implementering för behandling av meddelanden som inte blockerar. Med hjälp av huvudet kan meddelanden tas emot av protokollhanteringsklasser i bakgrunden (utan blockering), om det finns många anslutningar till servern kan alla behandlas parallellt. Man behöver inte titta på meddelandets innehåll för att ta emot ett meddelande (och avgöra när man är klar), bara på huvudet, så koden för detta är ganska enkel.

När ett meddelande väl finns på plats, kan det avkodas och behandlas i ett enda steg, utan att bry sig om fall där all data kanske inte tagits emot (eftersom meddelandelängden garanterar att allt är på plats).

### Anrop

För att anropa en fjärrmetod, måste man skicka följande struktur i ett &MCOP;-meddelande med messageType = 1 (mcopInvocation):

    struct Invocation {
        long objectID;
        long methodID;
        long requestID;
    };

därefter skickas parametrarna som en struktur, t.ex. om man anropar metoden "string concat(string s1, string s2)", skickas strukturen

    struct InvocationBody {
        string s1;
        string s2;
    };

om metoden deklarerades som envägs, vilket betyder asynkront utan returvärde, är det allt. Annars får man ett meddelande som svar med messageType = 2 (mcopReturn).

    struct ReturnCode {
        long requestID;
        <resulttype> result;
    };

där <resulttype> är typen för resultatet. Eftersom void-typer utelämnas vid kodning, kan man också bara ange requestID om man returnerar från en void-metod.

Så vår "string concat(string s1, string s2)" skulle ge en returkod som

    struct ReturnCode {
        long   requestID;
        string result;
    };

### Inspektera gränssnitt

För att göra anrop, måste man känna till metoderna som ett objekt stöder. För att göra detta, är methodID 0, 1, 2 och 3 hårdkodade för vissa funktioner. Det vill säga

    long _lookupMethod(MethodDef methodDef);                                // metod-id alltid 0
    string _interfaceName();                                                                // metod-id alltid 1
    InterfaceDef _queryInterface(string name);                                // metod-id alltid 2
    TypeDef _queryType(string name);                                                // metod-id alltid 3

för att läsa detta, behövs förstås också

    struct MethodDef {
            string  methodName;
            string  type;
            long    flags;        // nu satt till 0 (krävs för strömmar)
            sequence<ParamDef> signature;
    };

    struct ParamDef {
            string name;
            long   typeCode;
    };

parameterfältet innehåller typkomponenter som anger typerna för parametrar. Typen för returkoden anges i typfältet för MethodDef.

För att vara strikt, är det bara metoderna _lookupMethod() och _interfaceName() som varierar från objekt till objekt, medan _queryInterface() och _queryType() alltid är likadana.

Vad är ett sådant här methodID? Om man gör ett &MCOP;-anrop, förväntas man skicka numret för metoden som anropas. Orsaken till detta är att nummer kan behandlas mycket snabbare än strängar när en &MCOP;-begäran körs.

Så hur skaffar man sig ett sådant här nummer? Om man känner till signaturen för metoden, dvs. en MethodDef som beskriver den (som innehåller namn, typ, parameternamn, parametertyper och liknande), så kan man skicka den till _lookupMethod för objektet där man vill anropa en metod. Eftersom _lookupMethod är hårdkodad till methodID 0, ska det inte vara några problem att göra detta.

Om man å andra sidan inte känner till metodens signatur, kan man ta reda på vilka metoder som stöds genom att använda _interfaceName, _queryInterface och _queryType.

### Typdefinitioner

Användardefinierade datatyper beskrivs med strukturen TypeDef:

    struct TypeComponent {
            string type;
            string name;
    };

    struct TypeDef {
            string name;

            sequence<TypeComponent> contents;
    };

## Varför &arts; inte använder &DCOP;

Eftersom &kde; släppt CORBA helt och hållet, och istället använder &DCOP; överallt, uppstår förstås frågan varför inte &arts; också gör det. Trots allt finns &DCOP;-stöd i KApplication, underhålls väl, förväntas integreras utmärkt med libICE, och allt möjligt annat.

Eftersom det (möjligtvis) kommer att finnas många som frågar om det verkligen är nödvändigt att ha &MCOP; förutom &DCOP;, så finns svaret här. Missförstå mig inte, jag försöker inte säga att &DCOP; är dåligt. Jag försöker bara säga &DCOP; är inte rätt lösning för &arts; (medan det är en bra lösning för andra saker).

Först måste man förstå exakt vad &DCOP; skrevs för. Skapat på två dar under mötet &kde;-TWO, var det avsett att vara så enkelt som möjligt, ett verkligt lättviktigt kommunikationsprotokoll. I synnerhet utelämnade implementeringen allt som kunde innebära komplexitet, till exempel ett fullständigt koncept angående hur datatyper ska kodas.

Fastän &DCOP; inte bryr sig om vissa saker (som hur man skickar en sträng på ett nätverkstransparent sätt), måste detta göras. Så allt som inte &DCOP; gör överlämnas till &Qt; i &kde;-programmen som använder &DCOP; idag. Det här är i huvudsak typhantering (som använder &Qt;:s serialiseringsoperator).

Så &DCOP; är ett minimalt protokoll som gör det helt möjlig för &kde;-program att skicka enkla meddelanden som öppna ett fönster som pekar på http://www.kde.org eller dina inställningar har ändrats. Inne i &arts; fokuseras dock på andra saker.

Idén är att små insticksmoduler i &arts; ska kommunicera med sådana datastrukturer som midi-händelser och sångpositionspekare och flödesgrafer.

Detta är komplexa datatyper, som måste skickas mellan olika objekt, och hanteras som strömmar, eller parametrar. &MCOP; tillhandahåller ett typkoncept för att definiera komplexa datatyper från enklare (liknande struct:ar och fält i C++). &DCOP; bryr sig inte om typer alls, så det här problemet skulle lämnas till programmeraren, som att skriva C++ klasser för typerna, och försäkra sig om att de går att serialisera på ett riktigt sätt (till exempel stöd för &Qt;:s serialiseringsoperator).

Men på det sättet skulle de inte vara tillgängliga för något annat än direkt kodning i C++. I synnerhet skulle man inte kunna skapa ett skriptspråk som skulle kunna känna till alla typer som en insticksmodul kan göra tillgängliga, eftersom de inte skulle vara självbeskrivande.

Samma argument gäller också gränssnitt i stor utsträckning. &DCOP;-objekt gör inte sina förhållanden, arvhierarkier, etc. tillgängliga. Om man skulle skriva en objektbläddrare som skulle visa vilka egenskaper har det här objektet, skulle man misslyckas.

Även om Matthias talade om för mig att man har en speciell funktion functions för varje objekt som informerar om vilka metoder som objektet stöder, utelämnar detta saker som egenskaper, strömmar och arvrelationer.

Det här gör att program som aRts-byggaren inte skulle fungera alls. Men kom ihåg, det var inte meningen att &DCOP; skulle vara en objektmodell (eftersom &Qt; redan har en med moc och liknande), inte heller vara något som CORBA, utan tillhandahålla kommunikation mellan program.

Orsaken att &MCOP; överhuvudtaget finns är att det måste fungera bra med strömmar mellan objekt. &arts; använder många små insticksmoduler, som förbinds med strömmar. CORBA-versionen av &arts; var tvungen att introducera en besvärande uppdelning mellan SynthModule-objekt, som var de interna arbetsmodulerna som skapade strömmar, och CORBA-gränssnitt, som var något externt.

Mycket kod bekymrade sig om att åstadkomma att växelverkan mellan SynthModule-objekt och CORBA-gränssnittet såg naturlig ut, men den gjorde aldrig det, eftersom CORBA inte kände till något alls om strömmar. &MCOP; gör det. Titta på koden (någonting i stil med `simplesoundserver_impl.cc`). Åtskilligt bättre! Strömmar kan deklareras i modulernas gränssnitt, och implementeras på ett sätt som ser naturligt ut.

Man kan inte förneka det. En av orsakerna att jag skrev &MCOP; var snabbhet. Här är några argument varför &MCOP; definitivt kommer att vara snabbare än &DCOP; (även utan att ange siffror).

Ett anrop i &MCOP; kommer att ha ett huvud med sex long. Det vill säga:

- magiskt värde MCOP

- meddelandetyp (anrop)

- storlek på begäran i byte

- ID för begäran

- ID för målobjektet

- ID för målmetoden

Efter detta följer parametrarna. Observera att avkoda det här går extremt fort. Man kan använda tabelluppslagningar för att hitta avkodningsfunktionen för objektet och metoden, vilket betyder att komplexiteten är O(1) [det tar lika lång tid oberoende av hur många objekt som finns, och hur många funktioner som finns].

Om det här jämförs med &DCOP;, ser du att det finns åtminstone

- en sträng för målobjektet - någonting i stil med myCalculator

- en sträng som liknar addNumber(int,int) för att ange metoden

- ytterligare protokollinformation tillagd av libICE, och andra DCOP-specifika saker som jag inte känner till

De här är mycket svårare att avkoda, eftersom man måste tolka strängen, leta efter funktionen, etc.

Med &DCOP; skickas alla anrop genom en server (DCOPServer). Det betyder att hanteringen av ett synkront anrop ser ut så här:

- Klientprocessen skickar anrop.

- DCOPserver (mannen i mitten) tar emot anropet och ser efter vart det ska ta vägen, och skickar det till den riktiga servern.

- Serverprocessen tar emot anropet, utför begäran och skickar resultatet.

- DCOPserver (mannen i mitten) tar emot resultatet och ... skickar det till klienten.

- Klienten avkodar svaret.

I &MCOP; ser samma anrop ut så här:

- Klientprocessen skickar anrop.

- Serverprocessen tar emot anropet, utför begäran och skickar resultatet.

- Klienten avkodar svaret.

Antag att båda är riktigt implementerade. &MCOP;:s icke-hierarkiska strategi bör vara snabbare med en faktor två, än &DCOP;:s man i mitten-strategi. Observera dock att det förstås fanns orsaker att välja &DCOP;-strategin, som är att om du har 20 program som kör, och varje program pratar med varje annat program, så behöver man 20 anslutningar med &DCOP;, och 200 med &MCOP;. I fallet med multimedia är det dock inte meningen att detta ska vara ett vanligt scenario.

Jag försökte jämföra &MCOP; och &DCOP;, med att göra ett anrop som adderar två tal. Jag ändrade testdcop för att åstadkomma detta. Testen var dock kanske inte precis på &DCOP;-sidan. Jag anropade metoden i samma process som gjorde anropet till &DCOP;, och jag visste inte hur man blev av med ett avlusningsmeddelande, så jag använde omdirigering av utmatningen.

Testen använde bara ett objekt och en funktion, så resultaten för &DCOP; förväntas minska med fler objekt och funktioner, medan resultaten för &MCOP; bör förbli likadana. Dessutom var inte dcopserver-processen ansluten till andra program, och det kanske är så att om många program är anslutna så minskar överföringsprestanda.

Resultatet jag fick var att medan &DCOP; fick lite mer än 2000 anrop per sekund, fick &MCOP; något mer än 8000 anrop per sekund. Det betyder en faktor 4. Jag vet att &MCOP; inte är avstämd för den maximalt möjliga hastigheten än. (Som jämförelse: CORBA, med mico-implementeringen, klarar något mellan 1000 och 1500 anrop per sekund).

Om du vill ha riktigare data, fundera på att skriva något litet mätprogram för &DCOP; och skicka det till mig.

CORBA hade den trevliga funktionen att man kunde använda objekt som man implementerat, som separat serverprocess, eller som bibliotek. Man kunde använda samma kod för att göra det, och CORBA bestämde transparent vad som skulle göras. Med &DCOP;, är det inte riktigt meningen, och så vitt jag vet inte egentligen möjligt.

&MCOP; å andra sidan ska stöda detta från början. Så man kan köra en effekt inne i &artsd;. Men för en vågformseditor kan man välja att köra samma effekt inne i processen också.

Där &DCOP; i huvudsak är ett sätt att kommunicera mellan program, är &MCOP; också ett sätt att kommunicera inne i program. Särskilt för multimediaflöden är detta viktigt (eftersom man kan köra flera &MCOP;-objekt i parallell, för att lösa en multimediauppgift i ett program).

Fastän &MCOP; inte gör det för närvarande, är möjligheterna öppna att implementera servicekvalitetsfunktioner. Någonting i stil med att den där &MIDI;-händelsen är verkligen riktigt viktig, jämfört med det här anropet. Eller någonting som måste vara där i tid.

Å andra sidan kan strömöverföringar integreras i &MCOP;-protokollet på ett trevligt sätt, och kombineras med QoS-grejor. Under förutsättning att protokollet kan ändras, bör inte &MCOP; strömöverföringar verkligen bli långsammare än en konventionell TCP-ström, men de kommer att vara enklare och mer konsekventa att använda.

Det finns ingen anledning att basera mellanprogram för multimedia på &Qt;. Genom att bestämma sig för det, och använda allt de där trevliga &Qt;-strömmarna och andra saker, kan det lätt leda till att mellanprogram bara blir en sak för &Qt;-(eller i själva verket bara &kde;). Jag menar att om jag någonsin ser att GNOME också använder &DCOP;, eller någonting liknande, är det förstås bevisat att jag har fel.

Fastän jag vet att &DCOP; i grunden inte känner till de datatyper som det skickar, så att man skulle kunna använda &DCOP; utan &Qt;, se hur det används i daglig &kde;-användning: man skickar runt typer som QString, QRect, QPixmap, QCString, .... De här använder &Qt;:s-serialisering. Så om någon väljer att stöda &DCOP; i ett GNOME-program, måste han antingen ange att han använder QString,... typer (även om han inte gör det), och emulera sättet som &Qt; använder för strömmar, eller så skulle han skicka runt andra sträng-, pixmap- och rect-typer, och på så sätt ändå inte kunna fungera ihop med &kde;-program.

Nå, hur som helst var alltid &arts; avsett att fungera med eller utan &kde;, med eller utan &Qt;, med eller utan X11, och kanske till och med med eller utan &Linux; (och jag har inte ens några invändningar mot personer som anpassar det till operativsystem som inte är fria).

Min inställning är att komponenter som inte ingår i ett grafiskt gränssnitt ska skrivas oberoende av detta, för att möjliggöra att de delas mellan ett större antal utvecklare (och användare).

Jag inser att använda två IPC-protokoll kan vara obekvämt. Dessutom är båda två inte standardiserade. Av orsakerna som angivits ovan är det inte möjligt att byta till &DCOP;. Om det finns ett betydligt intresse av att hitta ett sätt att förena de två, så kan vi försöka. Vi skulle till och med kunna försöka få &MCOP; att prata IIOP, då skulle vi ha en CORBA ORB ;).

Jag pratade en del med Matthias Ettrich om framtiden med de två protokollen, och vi fann många sätt som saker kunde gå vidare. &MCOP; skulle till exempel kunna hantera meddelandekommunikationen i &DCOP;, och på så sätt föra protokollen närmare varandra.

Några möjliga lösningar skulle vara:

- Skriva en portal mellan &MCOP; och &DCOP; (vilket bör vara möjligt, och skulle möjliggöra samkörning). Observera att det finns en experimentell prototyp, om du skulle vilja arbeta med det.

- Integrera allt &DCOP;-användare förväntar sig i &MCOP;, och försöka bara använda &MCOP; - man skulle kunna lägga till en man i mitten möjlighet i &MCOP; också ;)

- Basera &DCOP; på &MCOP; istället för libICE, och långsamt börja integrera saker tätare tillsammans.

Den sämsta möjligheten är kanske inte att använda varje protokoll för allt det som det var avsett för (det finns några stora skillnader i målen med deras konstruktion), och inte försöka slå ihop dem till ett.