]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - protocol.c
changed some prints to dprints
[xonotic/darkplaces.git] / protocol.c
index 3be8a6b281f6c81cd6e74d5869064e37ad402b04..7889e23b1b93f3629d42cc8923620e8810532ef8 100644 (file)
@@ -8,6 +8,7 @@ entity_state_t defaultstate =
 {
        // ! means this is not sent to client
        0,//double time; // ! time this state was built (used on client for interpolation)
+       {0,0,0},//float netcenter[3]; // ! for network prioritization, this is the center of the bounding box (which may differ from the origin)
        {0,0,0},//float origin[3];
        {0,0,0},//float angles[3];
        0,//int number; // entity number this state is for
@@ -35,7 +36,7 @@ entity_state_t defaultstate =
        0,//unsigned char tagindex;
        {32, 32, 32},//unsigned char colormod[3];
        // padding to a multiple of 8 bytes (to align the double time)
-       {0,0,0,0,0,0}//unsigned char unused[6]; // !
+       {0,0}//unsigned char unused[2]; // !
 };
 
 // LordHavoc: I own protocol ranges 96, 97, 3500-3599
@@ -63,7 +64,7 @@ protocolversioninfo[] =
 };
 
 static mempool_t *sv2csqc = NULL;
-int csqc_clent = 0;
+int csqc_clientnum = 0;
 sizebuf_t *sv2csqcbuf = NULL;
 static unsigned char *sv2csqcents_version[MAX_SCOREBOARD];
 
@@ -272,107 +273,150 @@ void EntityFrameCSQC_InitClientVersions (int client, qboolean clear)
        memset(sv2csqcents_version[client], 0, MAX_EDICTS);
 }
 
-//[515]: we use only one array per-client for SendEntity feature
-void EntityFrameCSQC_WriteFrame (sizebuf_t *msg, int numstates, const entity_state_t *states)
-{
-       sizebuf_t                               buf;
-       unsigned char                                   data[2048];
-       const entity_state_t    *s;
-       unsigned short                  i, t, t2, t0;
-       prvm_eval_t                             *val, *val2;
-       int                                             csqcents = 0;
-
-       if(!eval_SendEntity || !eval_Version)
-               return;
-       --csqc_clent;
-       if(!sv2csqcents_version[csqc_clent])
-               EntityFrameCSQC_InitClientVersions(csqc_clent, false);
+// FIXME FIXME FIXME: at this time the CSQC entity writing does not store
+// packet logs and thus if an update is lost it is never repeated, this makes
+// csqc entities useless at the moment.
 
-       for (csqcents = i = 0, s = states;i < numstates;i++, s++)
+void EntityFrameCSQC_WriteState (sizebuf_t *msg, int number, qboolean doupdate, qboolean *sectionstarted)
+{
+       int version;
+       prvm_eval_t *val, *val2;
+       version = 0;
+       if (doupdate)
        {
-               //[515]: entities remove
-               if(i+1 >= numstates)
-                       t2 = prog->num_edicts;
-               else
-                       t2 = states[i+1].number;
-               if(!i)
-               {
-                       t0 = 1;
-                       t2 = s->number;
-               }
-               else
-                       t0 = s->number+1;
-               for(t=t0; t<t2 ;t++)
-                       if(sv2csqcents_version[csqc_clent][t])
-                       {
-                               if(!csqcents)
-                               {
-                                       csqcents = 1;
-                                       memset(&buf, 0, sizeof(buf));
-                                       buf.data = data;
-                                       buf.maxsize = sizeof(data);
-                                       sv2csqcbuf = &buf;
-                                       SZ_Clear(&buf);
-                                       MSG_WriteByte(&buf, svc_csqcentities);
-                               }
-                               sv2csqcents_version[csqc_clent][t] = 0;
-                               MSG_WriteShort(&buf, (unsigned short)t | 0x8000);
-                               csqcents++;
-                       }
-               //[515]: entities remove
-
-//             if(!s->active)
-//                     continue;
-               val = PRVM_GETEDICTFIELDVALUE((&prog->edicts[s->number]), eval_SendEntity);
-               if(val->function)
-               {
-                       val2 = PRVM_GETEDICTFIELDVALUE((&prog->edicts[s->number]), eval_Version);
-                       if(sv2csqcents_version[csqc_clent][s->number] == (unsigned char)val2->_float)
-                               continue;
-                       if(!csqcents)
-                       {
-                               csqcents = 1;
-                               memset(&buf, 0, sizeof(buf));
-                               buf.data = data;
-                               buf.maxsize = sizeof(data);
-                               sv2csqcbuf = &buf;
-                               SZ_Clear(&buf);
-                               MSG_WriteByte(&buf, svc_csqcentities);
-                       }
-                       if((unsigned char)val2->_float == 0)
-                               val2->_float = 1;
-                       MSG_WriteShort(&buf, s->number);
-                       ((int *)prog->globals.generic)[OFS_PARM0] = csqc_clent+1;
-                       prog->globals.server->self = s->number;
+               if (msg->cursize + !*sectionstarted + 2 + 1 + 2 > msg->maxsize)
+                       return;
+               val2 = PRVM_EDICTFIELDVALUE((&prog->edicts[number]), prog->fieldoffsets.Version);
+               version = (int)val2->_float;
+               // LordHavoc: do some validity checks on self.Version
+               // if Version reaches 8388608, it has already exhausted half of the
+               // reliable integer space in a 32bit float, and should be reset to 1
+               // FIXME: we should set all client versions of this entity to -1
+               // so that it will not be skipped accidentally in some cases after
+               // the reset
+               if (version < 0)
+                       val2->_float = 0;
+               if (version >= 8388608)
+               {
+                       int i;
+                       val2->_float = 1;
+                       // since we just reset the Version field to 1, it may accidentally
+                       // end up being equal to an existing client version now or in the
+                       // future, so to fix this situation we have to loop over all
+                       // clients and change their versions for this entity to be -1
+                       // which never matches, thus causing them to receive the update
+                       // soon, as they should
+                       for (i = 0;i < svs.maxclients;i++)
+                               if (sv2csqcents_version[i] && sv2csqcents_version[i][number])
+                                       sv2csqcents_version[i][number] = -1;
+               }
+       }
+       // if the version already matches, we don't need to do anything as the
+       // latest version has already been sent.
+       if (sv2csqcents_version[csqc_clientnum][number] == version)
+               return;
+       if (version)
+       {
+               // if there's no SendEntity function, treat it as a remove
+               val = PRVM_EDICTFIELDVALUE((&prog->edicts[number]), prog->fieldoffsets.SendEntity);
+               if (val->function)
+               {
+                       // there is a function to call, save the cursize value incase we
+                       // have to do a rollback due to overflow
+                       int oldcursize = msg->cursize;
+                       if(!*sectionstarted)
+                               MSG_WriteByte(msg, svc_csqcentities);
+                       MSG_WriteShort(msg, number);
+                       ((int *)prog->globals.generic)[OFS_PARM0] = csqc_clientnum+1;
+                       prog->globals.server->self = number;
                        PRVM_ExecuteProgram(val->function, "Null SendEntity\n");
-                       if(!prog->globals.generic[OFS_RETURN])
+                       if(prog->globals.generic[OFS_RETURN])
                        {
-                               buf.cursize -= 2;
-                               if(sv2csqcents_version[csqc_clent][s->number])
+                               if (msg->cursize + 2 > msg->maxsize)
                                {
-                                       sv2csqcents_version[csqc_clent][s->number] = 0;
-                                       MSG_WriteShort(&buf, (unsigned short)s->number | 0x8000);
-                                       csqcents++;
+                                       // if the packet no longer has enough room to write the
+                                       // final index code that ends the message, rollback to the
+                                       // state before we tried to write anything and then return
+                                       msg->cursize = oldcursize;
+                                       msg->overflowed = false;
+                                       return;
                                }
+                               // an update has been successfully written, update the version
+                               sv2csqcents_version[csqc_clientnum][number] = version;
+                               // and take note that we have begun the svc_csqcentities
+                               // section of the packet
+                               *sectionstarted = 1;
+                               return;
                        }
                        else
                        {
-                               sv2csqcents_version[csqc_clent][s->number] = (unsigned char)val2->_float;
-                               csqcents++;
+                               // rollback the buffer to its state before the writes
+                               msg->cursize = oldcursize;
+                               // if the function returned FALSE, simply write a remove
+                               // this is done by falling through to the remove code below
+                               version = 0;
                        }
-                       if (msg->cursize + buf.cursize > msg->maxsize)
-                               break;
                }
        }
-       if(csqcents)
+       // write a remove message if needed
+       // if already removed, do nothing
+       if (!sv2csqcents_version[csqc_clientnum][number])
+               return;
+       // if there isn't enough room to write the remove message, just return, as
+       // it will be handled in a later packet
+       if (msg->cursize + !*sectionstarted + 2 + 2 > msg->maxsize)
+               return;
+       // first write the message identifier if needed
+       if(!*sectionstarted)
        {
-               if(csqcents > 1)
-               {
-                       MSG_WriteShort(&buf, 0);
-                       SZ_Write(msg, buf.data, buf.cursize);
-               }
-               sv2csqcbuf = NULL;
+               *sectionstarted = 1;
+               MSG_WriteByte(msg, svc_csqcentities);
+       }
+       // write the remove message
+       MSG_WriteShort(msg, (unsigned short)number | 0x8000);
+       sv2csqcents_version[csqc_clientnum][number] = 0;
+}
+
+//[515]: we use only one array per-client for SendEntity feature
+void EntityFrameCSQC_WriteFrame (sizebuf_t *msg, int numstates, const entity_state_t *states)
+{
+       int i, num;
+       qboolean sectionstarted = false;
+       const entity_state_t *n;
+
+       // if this server progs is not CSQC-aware, return early
+       if(prog->fieldoffsets.SendEntity < 0 || prog->fieldoffsets.Version < 0)
+               return;
+       // make sure there is enough room to store the svc_csqcentities byte,
+       // the terminator (0x0000) and at least one entity update
+       if (msg->cursize + 32 >= msg->maxsize)
+               return;
+       if(!sv2csqcents_version[csqc_clientnum])
+               EntityFrameCSQC_InitClientVersions(csqc_clientnum, false);
+
+       sv2csqcbuf = msg;
+       num = 1;
+       for (i = 0, n = states;i < numstates;i++, n++)
+       {
+               // all entities between the previous entity state and this one are dead
+               for (;num < n->number;num++)
+                       if(sv2csqcents_version[csqc_clientnum][num])
+                               EntityFrameCSQC_WriteState(msg, num, false, &sectionstarted);
+               // update this entity
+               EntityFrameCSQC_WriteState(msg, num, true, &sectionstarted);
+               // advance to next entity so the next iteration doesn't immediately remove it
+               num++;
+       }
+       // all remaining entities are dead
+       for (;num < prog->num_edicts;num++)
+               if(sv2csqcents_version[csqc_clientnum][num])
+                       EntityFrameCSQC_WriteState(msg, num, false, &sectionstarted);
+       if (sectionstarted)
+       {
+               // write index 0 to end the update (0 is never used by real entities)
+               MSG_WriteShort(msg, 0);
        }
+       sv2csqcbuf = NULL;
 }
 
 void EntityFrameQuake_WriteFrame(sizebuf_t *msg, int numstates, const entity_state_t *states)
@@ -391,7 +435,7 @@ void EntityFrameQuake_WriteFrame(sizebuf_t *msg, int numstates, const entity_sta
 
        for (i = 0, s = states;i < numstates;i++, s++)
        {
-               val = PRVM_GETEDICTFIELDVALUE((&prog->edicts[s->number]), eval_SendEntity);
+               val = PRVM_EDICTFIELDVALUE((&prog->edicts[s->number]), prog->fieldoffsets.SendEntity);
                if(val && val->function)
                        continue;
 
@@ -1048,7 +1092,7 @@ void EntityFrame_WriteFrame(sizebuf_t *msg, entityframe_database_t *d, int numst
                ent = states + i;
                number = ent->number;
 
-               val = PRVM_GETEDICTFIELDVALUE((&prog->edicts[number]), eval_SendEntity);
+               val = PRVM_EDICTFIELDVALUE((&prog->edicts[number]), prog->fieldoffsets.SendEntity);
                if(val && val->function)
                                continue;
                for (;onum < o->numentities && o->entitydata[onum].number < number;onum++)
@@ -1537,7 +1581,7 @@ void EntityFrame4_WriteFrame(sizebuf_t *msg, entityframe4_database_t *d, int num
        d->currententitynumber = 1;
        for (i = 0, n = startnumber;n < prog->max_edicts;n++)
        {
-               val = PRVM_GETEDICTFIELDVALUE((&prog->edicts[n]), eval_SendEntity);
+               val = PRVM_EDICTFIELDVALUE((&prog->edicts[n]), prog->fieldoffsets.SendEntity);
                if(val && val->function)
                        continue;
                // find the old state to delta from
@@ -1645,54 +1689,45 @@ void EntityFrame5_ExpandEdicts(entityframe5_database_t *d, int newmax)
 
 int EntityState5_Priority(entityframe5_database_t *d, int stateindex)
 {
-       int lowprecision, limit, priority;
-       double distance;
-       int changedbits;
-       int age;
-       entity_state_t *view, *s;
-       changedbits = d->deltabits[stateindex];
-       if (!changedbits)
-               return 0;
-       if (!d->states[stateindex].active/* && changedbits & E5_FULLUPDATE*/)
+       int limit, priority;
+       entity_state_t *s;
+       // if it is the player, update urgently
+       if (stateindex == d->viewentnum)
                return E5_PROTOCOL_PRIORITYLEVELS - 1;
-       // check whole attachment chain to judge relevance to player
-       view = d->states + d->viewentnum;
-       lowprecision = false;
+       // priority increases each frame no matter what happens
+       priority = d->priorities[stateindex] + 1;
+       // players get an extra priority boost
+       if (stateindex <= svs.maxclients)
+               priority++;
+       // remove dead entities very quickly because they are just 2 bytes
+       if (!d->states[stateindex].active)
+       {
+               priority++;
+               return bound(1, priority, E5_PROTOCOL_PRIORITYLEVELS - 1);
+       }
+       // certain changes are more noticable than others
+       if (d->deltabits[stateindex] & (E5_FULLUPDATE | E5_ATTACHMENT | E5_MODEL | E5_FLAGS | E5_COLORMAP))
+               priority++;
+       // find the root entity this one is attached to, and judge relevance by it
        for (limit = 0;limit < 256;limit++)
        {
-               if (d->maxedicts < stateindex)
-                       EntityFrame5_ExpandEdicts(d, (stateindex+256)&~255);
                s = d->states + stateindex;
-               if (s == view)
-                       return E5_PROTOCOL_PRIORITYLEVELS - 1;
                if (s->flags & RENDER_VIEWMODEL)
-                       return E5_PROTOCOL_PRIORITYLEVELS - 1;
-               if (s->flags & RENDER_LOWPRECISION)
-                       lowprecision = true;
-               if (!s->tagentity)
-               {
-                       if (VectorCompare(s->origin, view->origin))
-                               return E5_PROTOCOL_PRIORITYLEVELS - 1;
+                       stateindex = d->viewentnum;
+               else if (s->tagentity)
+                       stateindex = s->tagentity;
+               else
                        break;
-               }
-               stateindex = s->tagentity;
+               if (d->maxedicts < stateindex)
+                       EntityFrame5_ExpandEdicts(d, (stateindex+256)&~255);
        }
        if (limit >= 256)
-       {
-               Con_Printf("Protocol: Runaway loop recursing tagentity links on entity %i\n", stateindex);
-               return 0;
-       }
-       // it's not a viewmodel for this client
-       distance = VectorDistance(view->origin, s->origin);
-       age = d->latestframenum - d->updateframenum[stateindex];
-       priority = (E5_PROTOCOL_PRIORITYLEVELS / 2) + age - (int)(distance * (E5_PROTOCOL_PRIORITYLEVELS / 16384.0f));
-       if (lowprecision)
-               priority -= (E5_PROTOCOL_PRIORITYLEVELS / 4);
-       //if (changedbits & E5_FULLUPDATE)
-       //      priority += 4;
-       //if (changedbits & (E5_ATTACHMENT | E5_MODEL | E5_FLAGS | E5_COLORMAP))
-       //      priority += 4;
-       return (int) bound(1, priority, E5_PROTOCOL_PRIORITYLEVELS - 1);
+               Con_DPrintf("Protocol: Runaway loop recursing tagentity links on entity %i\n", stateindex);
+       // now that we have the parent entity we can make some decisions based on
+       // distance from the player
+       if (VectorDistance(d->states[d->viewentnum].netcenter, s->netcenter) < 1024.0f)
+               priority++;
+       return bound(1, priority, E5_PROTOCOL_PRIORITYLEVELS - 1);
 }
 
 void EntityState5_WriteUpdate(int number, const entity_state_t *s, int changedbits, sizebuf_t *msg)
@@ -1700,7 +1735,7 @@ void EntityState5_WriteUpdate(int number, const entity_state_t *s, int changedbi
        unsigned int bits = 0;
 
        prvm_eval_t *val;
-       val = PRVM_GETEDICTFIELDVALUE((&prog->edicts[s->number]), eval_SendEntity);
+       val = PRVM_EDICTFIELDVALUE((&prog->edicts[s->number]), prog->fieldoffsets.SendEntity);
        if(val && val->function)
                return;
 
@@ -2047,7 +2082,7 @@ void EntityFrame5_CL_ReadFrame(void)
        if (developer_networkentities.integer)
                Con_Printf("recv: svc_entities %i\n", cl.latestframenums[LATESTFRAMENUMS-1]);
        if (cls.protocol != PROTOCOL_QUAKE && cls.protocol != PROTOCOL_QUAKEDP && cls.protocol != PROTOCOL_NEHAHRAMOVIE && cls.protocol != PROTOCOL_DARKPLACES1 && cls.protocol != PROTOCOL_DARKPLACES2 && cls.protocol != PROTOCOL_DARKPLACES3 && cls.protocol != PROTOCOL_DARKPLACES4 && cls.protocol != PROTOCOL_DARKPLACES5 && cls.protocol != PROTOCOL_DARKPLACES6)
-               cl.servermovesequence = MSG_ReadLong();
+               cls.servermovesequence = MSG_ReadLong();
        // read entity numbers until we find a 0x8000
        // (which would be remove world entity, but is actually a terminator)
        while ((n = (unsigned short)MSG_ReadShort()) != 0x8000 && !msg_badread)
@@ -2136,7 +2171,11 @@ void EntityFrame5_LostFrame(entityframe5_database_t *d, int framenum)
                                if (bits)
                                {
                                        d->deltabits[s->number] |= bits;
-                                       d->priorities[s->number] = EntityState5_Priority(d, s->number);
+                                       // if it was a very important update, set priority higher
+                                       if (bits & (E5_FULLUPDATE | E5_ATTACHMENT | E5_MODEL || E5_COLORMAP))
+                                               d->priorities[s->number] = max(d->priorities[s->number], 4);
+                                       else
+                                               d->priorities[s->number] = max(d->priorities[s->number], 1);
                                }
                        }
                        // mark lost stats
@@ -2208,7 +2247,7 @@ void EntityFrame5_WriteFrame(sizebuf_t *msg, entityframe5_database_t *d, int num
        }
 
        // detect changes in states
-       num = 0;
+       num = 1;
        for (i = 0, n = states;i < numstates;i++, n++)
        {
                // mark gaps in entity numbering as removed entities
@@ -2219,7 +2258,7 @@ void EntityFrame5_WriteFrame(sizebuf_t *msg, entityframe5_database_t *d, int num
                        {
                                CLEARPVSBIT(d->visiblebits, num);
                                d->deltabits[num] = E5_FULLUPDATE;
-                               d->priorities[num] = EntityState5_Priority(d, num);
+                               d->priorities[num] = max(d->priorities[num], 8); // removal is cheap
                                d->states[num] = defaultstate;
                                d->states[num].number = num;
                        }
@@ -2230,10 +2269,13 @@ void EntityFrame5_WriteFrame(sizebuf_t *msg, entityframe5_database_t *d, int num
                        // entity just spawned in, don't let it completely hog priority
                        // because of being ancient on the first frame
                        d->updateframenum[num] = framenum;
+                       // initial priority is a bit high to make projectiles send on the
+                       // first frame, among other things
+                       d->priorities[num] = max(d->priorities[num], 4);
                }
                SETPVSBIT(d->visiblebits, num);
                d->deltabits[num] |= EntityState5_DeltaBits(d->states + num, n);
-               d->priorities[num] = EntityState5_Priority(d, num);
+               d->priorities[num] = max(d->priorities[num], 1);
                d->states[num] = *n;
                d->states[num].number = num;
                // advance to next entity so the next iteration doesn't immediately remove it
@@ -2246,7 +2288,7 @@ void EntityFrame5_WriteFrame(sizebuf_t *msg, entityframe5_database_t *d, int num
                {
                        CLEARPVSBIT(d->visiblebits, num);
                        d->deltabits[num] = E5_FULLUPDATE;
-                       d->priorities[num] = EntityState5_Priority(d, num);
+                       d->priorities[num] = max(d->priorities[num], 8); // removal is cheap
                        d->states[num] = defaultstate;
                        d->states[num].number = num;
                }
@@ -2264,6 +2306,8 @@ void EntityFrame5_WriteFrame(sizebuf_t *msg, entityframe5_database_t *d, int num
        {
                if (d->priorities[num])
                {
+                       if (d->priorities[num] < (E5_PROTOCOL_PRIORITYLEVELS - 1))
+                               d->priorities[num] = EntityState5_Priority(d, num);
                        l = num;
                        priority = d->priorities[num];
                        if (entityframe5_prioritychaincounts[priority] < ENTITYFRAME5_MAXSTATES)
@@ -2597,7 +2641,13 @@ void EntityFrameQW_CL_ReadFrame(qboolean delta)
                cl.entitydatabaseqw = EntityFrameQW_AllocDatabase(cls.levelmempool);
        d = cl.entitydatabaseqw;
 
-       newsnapindex = cls.netcon->qw.incoming_sequence & QW_UPDATE_MASK;
+       // there is no cls.netcon in demos, so this reading code can't access
+       // cls.netcon-> at all...  so cls.qw_incoming_sequence and
+       // cls.qw_outgoing_sequence are updated every time the corresponding
+       // cls.netcon->qw. variables are updated
+       // read the number of this frame to echo back in next input packet
+       cl.qw_validsequence = cls.qw_incoming_sequence;
+       newsnapindex = cl.qw_validsequence & QW_UPDATE_MASK;
        newsnap = d->snapshot + newsnapindex;
        memset(newsnap, 0, sizeof(*newsnap));
        oldsnapindex = -1;
@@ -2610,7 +2660,7 @@ void EntityFrameQW_CL_ReadFrame(qboolean delta)
                        Con_DPrintf("WARNING: from mismatch\n");
                if (oldsnapindex != -1)
                {
-                       if (cls.netcon->qw.outgoing_sequence - oldsnapindex >= QW_UPDATE_BACKUP-1)
+                       if (cls.qw_outgoing_sequence - oldsnapindex >= QW_UPDATE_BACKUP-1)
                        {
                                Con_DPrintf("delta update too old\n");
                                newsnap->invalid = invalid = true; // too old
@@ -2622,8 +2672,7 @@ void EntityFrameQW_CL_ReadFrame(qboolean delta)
                        delta = false;
        }
 
-       // read the number of this frame to echo back in next input packet
-       cl.qw_validsequence = cls.netcon->qw.incoming_sequence;
+       // if we can't decode this frame properly, report that to the server
        if (invalid)
                cl.qw_validsequence = 0;